2 * SCSI Enclosure Services
4 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
6 **-----------------------------------------------------------------------------
8 ** This program is free software; you can redistribute it and/or
9 ** modify it under the terms of the GNU General Public License
10 ** version 2 as published by the Free Software Foundation.
12 ** This program is distributed in the hope that it will be useful,
13 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ** GNU General Public License for more details.
17 ** You should have received a copy of the GNU General Public License
18 ** along with this program; if not, write to the Free Software
19 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 **-----------------------------------------------------------------------------
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/enclosure.h>
28 #include <scsi/scsi.h>
29 #include <scsi/scsi_cmnd.h>
30 #include <scsi/scsi_dbg.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_driver.h>
33 #include <scsi/scsi_host.h>
38 unsigned char *page10;
44 struct ses_component {
49 static int ses_probe(struct device *dev)
51 struct scsi_device *sdev = to_scsi_device(dev);
54 if (sdev->type != TYPE_ENCLOSURE)
58 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
64 #define SES_TIMEOUT (30 * HZ)
67 static int ses_recv_diag(struct scsi_device *sdev, int page_code,
68 void *buf, int bufflen)
70 unsigned char cmd[] = {
79 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
80 NULL, SES_TIMEOUT, SES_RETRIES);
83 static int ses_send_diag(struct scsi_device *sdev, int page_code,
84 void *buf, int bufflen)
88 unsigned char cmd[] = {
90 0x10, /* Set PF bit */
97 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
98 NULL, SES_TIMEOUT, SES_RETRIES);
100 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
105 static int ses_set_page2_descriptor(struct enclosure_device *edev,
106 struct enclosure_component *ecomp,
109 int i, j, count = 0, descriptor = ecomp->number;
110 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
111 struct ses_device *ses_dev = edev->scratch;
112 unsigned char *type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
113 unsigned char *desc_ptr = ses_dev->page2 + 8;
115 /* Clear everything */
116 memset(desc_ptr, 0, ses_dev->page2_len - 8);
117 for (i = 0; i < ses_dev->page1[10]; i++, type_ptr += 4) {
118 for (j = 0; j < type_ptr[1]; j++) {
120 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
121 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
123 if (count++ == descriptor) {
124 memcpy(desc_ptr, desc, 4);
127 /* clear reserved, just in case */
133 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
136 static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
137 struct enclosure_component *ecomp)
139 int i, j, count = 0, descriptor = ecomp->number;
140 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
141 struct ses_device *ses_dev = edev->scratch;
142 unsigned char *type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
143 unsigned char *desc_ptr = ses_dev->page2 + 8;
145 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
147 for (i = 0; i < ses_dev->page1[10]; i++, type_ptr += 4) {
148 for (j = 0; j < type_ptr[1]; j++) {
150 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
151 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
153 if (count++ == descriptor)
160 static void ses_get_fault(struct enclosure_device *edev,
161 struct enclosure_component *ecomp)
165 desc = ses_get_page2_descriptor(edev, ecomp);
167 ecomp->fault = (desc[3] & 0x60) >> 4;
170 static int ses_set_fault(struct enclosure_device *edev,
171 struct enclosure_component *ecomp,
172 enum enclosure_component_setting val)
174 unsigned char desc[4] = {0 };
177 case ENCLOSURE_SETTING_DISABLED:
178 /* zero is disabled */
180 case ENCLOSURE_SETTING_ENABLED:
184 /* SES doesn't do the SGPIO blink settings */
188 return ses_set_page2_descriptor(edev, ecomp, desc);
191 static void ses_get_status(struct enclosure_device *edev,
192 struct enclosure_component *ecomp)
196 desc = ses_get_page2_descriptor(edev, ecomp);
198 ecomp->status = (desc[0] & 0x0f);
201 static void ses_get_locate(struct enclosure_device *edev,
202 struct enclosure_component *ecomp)
206 desc = ses_get_page2_descriptor(edev, ecomp);
208 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
211 static int ses_set_locate(struct enclosure_device *edev,
212 struct enclosure_component *ecomp,
213 enum enclosure_component_setting val)
215 unsigned char desc[4] = {0 };
218 case ENCLOSURE_SETTING_DISABLED:
219 /* zero is disabled */
221 case ENCLOSURE_SETTING_ENABLED:
225 /* SES doesn't do the SGPIO blink settings */
228 return ses_set_page2_descriptor(edev, ecomp, desc);
231 static int ses_set_active(struct enclosure_device *edev,
232 struct enclosure_component *ecomp,
233 enum enclosure_component_setting val)
235 unsigned char desc[4] = {0 };
238 case ENCLOSURE_SETTING_DISABLED:
239 /* zero is disabled */
242 case ENCLOSURE_SETTING_ENABLED:
247 /* SES doesn't do the SGPIO blink settings */
250 return ses_set_page2_descriptor(edev, ecomp, desc);
253 static struct enclosure_component_callbacks ses_enclosure_callbacks = {
254 .get_fault = ses_get_fault,
255 .set_fault = ses_set_fault,
256 .get_status = ses_get_status,
257 .get_locate = ses_get_locate,
258 .set_locate = ses_set_locate,
259 .set_active = ses_set_active,
262 struct ses_host_edev {
263 struct Scsi_Host *shost;
264 struct enclosure_device *edev;
267 int ses_match_host(struct enclosure_device *edev, void *data)
269 struct ses_host_edev *sed = data;
270 struct scsi_device *sdev;
272 if (!scsi_is_sdev_device(edev->edev.parent))
275 sdev = to_scsi_device(edev->edev.parent);
277 if (sdev->host != sed->shost)
284 static void ses_process_descriptor(struct enclosure_component *ecomp,
287 int eip = desc[0] & 0x10;
288 int invalid = desc[0] & 0x80;
289 enum scsi_protocol proto = desc[0] & 0x0f;
291 struct ses_component *scomp = ecomp->scratch;
300 case SCSI_PROTOCOL_SAS:
305 /* only take the phy0 addr */
306 addr = (u64)d[12] << 56 |
316 /* FIXME: Need to add more protocols than just SAS */
327 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
330 struct efd *efd = data;
332 struct ses_component *scomp;
334 if (!edev->component[0].scratch)
337 for (i = 0; i < edev->components; i++) {
338 scomp = edev->component[i].scratch;
339 if (scomp->addr != efd->addr)
342 enclosure_add_device(edev, i, efd->dev);
348 #define VPD_INQUIRY_SIZE 36
350 static void ses_match_to_enclosure(struct enclosure_device *edev,
351 struct scsi_device *sdev)
353 unsigned char *buf = kmalloc(VPD_INQUIRY_SIZE, GFP_KERNEL);
359 unsigned char cmd[] = {
363 VPD_INQUIRY_SIZE >> 8,
364 VPD_INQUIRY_SIZE & 0xff,
371 if (scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf,
372 VPD_INQUIRY_SIZE, NULL, SES_TIMEOUT, SES_RETRIES))
375 vpd_len = (buf[2] << 8) + buf[3];
377 buf = kmalloc(vpd_len, GFP_KERNEL);
380 cmd[3] = vpd_len >> 8;
381 cmd[4] = vpd_len & 0xff;
382 if (scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf,
383 vpd_len, NULL, SES_TIMEOUT, SES_RETRIES))
387 while (desc < buf + vpd_len) {
388 enum scsi_protocol proto = desc[0] >> 4;
389 u8 code_set = desc[0] & 0x0f;
390 u8 piv = desc[1] & 0x80;
391 u8 assoc = (desc[1] & 0x30) >> 4;
392 u8 type = desc[1] & 0x0f;
395 if (piv && code_set == 1 && assoc == 1 && code_set == 1
396 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
397 efd.addr = (u64)desc[4] << 56 |
411 efd.dev = &sdev->sdev_gendev;
413 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
418 #define INIT_ALLOC_SIZE 32
420 static int ses_intf_add(struct device *cdev,
421 struct class_interface *intf)
423 struct scsi_device *sdev = to_scsi_device(cdev->parent);
424 struct scsi_device *tmp_sdev;
425 unsigned char *buf = NULL, *hdr_buf, *type_ptr, *desc_ptr = NULL,
426 *addl_desc_ptr = NULL;
427 struct ses_device *ses_dev;
429 int i, j, types, len, page7_len = 0, components = 0;
431 struct enclosure_device *edev;
432 struct ses_component *scomp = NULL;
434 if (!scsi_device_enclosure(sdev)) {
435 /* not an enclosure, but might be in one */
436 edev = enclosure_find(&sdev->host->shost_gendev);
438 ses_match_to_enclosure(edev, sdev);
439 put_device(&edev->edev);
444 /* TYPE_ENCLOSURE prints a message in probe */
445 if (sdev->type != TYPE_ENCLOSURE)
446 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
448 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
449 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
450 if (!hdr_buf || !ses_dev)
453 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
457 if (hdr_buf[1] != 0) {
458 /* FIXME: need subenclosure support; I've just never
459 * seen a device with subenclosures and it makes the
460 * traversal routines more complex */
461 sdev_printk(KERN_ERR, sdev,
462 "FIXME driver has no support for subenclosures (%d)\n",
467 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
468 buf = kzalloc(len, GFP_KERNEL);
472 result = ses_recv_diag(sdev, 1, buf, len);
478 type_ptr = buf + 12 + buf[11];
480 for (i = 0; i < types; i++, type_ptr += 4) {
481 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
482 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
483 components += type_ptr[1];
485 ses_dev->page1 = buf;
486 ses_dev->page1_len = len;
489 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
493 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
494 buf = kzalloc(len, GFP_KERNEL);
498 /* make sure getting page 2 actually works */
499 result = ses_recv_diag(sdev, 2, buf, len);
502 ses_dev->page2 = buf;
503 ses_dev->page2_len = len;
506 /* The additional information page --- allows us
507 * to match up the devices */
508 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
511 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
512 buf = kzalloc(len, GFP_KERNEL);
516 result = ses_recv_diag(sdev, 10, buf, len);
519 ses_dev->page10 = buf;
520 ses_dev->page10_len = len;
524 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
528 edev = enclosure_register(cdev->parent, sdev->sdev_gendev.bus_id,
529 components, &ses_enclosure_callbacks);
535 edev->scratch = ses_dev;
536 for (i = 0; i < components; i++)
537 edev->component[i].scratch = scomp + i;
539 /* Page 7 for the descriptors is optional */
540 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
542 goto simple_populate;
544 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
545 /* add 1 for trailing '\0' we'll use */
546 buf = kzalloc(len + 1, GFP_KERNEL);
548 goto simple_populate;
549 result = ses_recv_diag(sdev, 7, buf, len);
555 addl_desc_ptr = NULL;
558 len = (desc_ptr[2] << 8) + desc_ptr[3];
559 /* skip past overall descriptor */
562 addl_desc_ptr = ses_dev->page10 + 8;
564 type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
566 for (i = 0; i < types; i++, type_ptr += 4) {
567 for (j = 0; j < type_ptr[1]; j++) {
569 struct enclosure_component *ecomp;
572 if (desc_ptr >= buf + page7_len) {
575 len = (desc_ptr[2] << 8) + desc_ptr[3];
577 /* Add trailing zero - pushes into
579 desc_ptr[len] = '\0';
583 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
584 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
586 ecomp = enclosure_component_register(edev,
591 if (!IS_ERR(ecomp) && addl_desc_ptr)
592 ses_process_descriptor(ecomp,
599 addl_desc_ptr += addl_desc_ptr[1] + 2;
606 /* see if there are any devices matching before
607 * we found the enclosure */
608 shost_for_each_device(tmp_sdev, sdev->host) {
609 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
611 ses_match_to_enclosure(edev, tmp_sdev);
617 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
623 kfree(ses_dev->page10);
624 kfree(ses_dev->page2);
625 kfree(ses_dev->page1);
629 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
633 static int ses_remove(struct device *dev)
638 static void ses_intf_remove(struct device *cdev,
639 struct class_interface *intf)
641 struct scsi_device *sdev = to_scsi_device(cdev->parent);
642 struct enclosure_device *edev;
643 struct ses_device *ses_dev;
645 if (!scsi_device_enclosure(sdev))
648 edev = enclosure_find(cdev->parent);
652 ses_dev = edev->scratch;
653 edev->scratch = NULL;
655 kfree(ses_dev->page10);
656 kfree(ses_dev->page1);
657 kfree(ses_dev->page2);
660 kfree(edev->component[0].scratch);
662 put_device(&edev->edev);
663 enclosure_unregister(edev);
666 static struct class_interface ses_interface = {
667 .add_dev = ses_intf_add,
668 .remove_dev = ses_intf_remove,
671 static struct scsi_driver ses_template = {
672 .owner = THIS_MODULE,
676 .remove = ses_remove,
680 static int __init ses_init(void)
684 err = scsi_register_interface(&ses_interface);
688 err = scsi_register_driver(&ses_template.gendrv);
695 scsi_unregister_interface(&ses_interface);
699 static void __exit ses_exit(void)
701 scsi_unregister_driver(&ses_template.gendrv);
702 scsi_unregister_interface(&ses_interface);
705 module_init(ses_init);
706 module_exit(ses_exit);
708 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
710 MODULE_AUTHOR("James Bottomley");
711 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
712 MODULE_LICENSE("GPL v2");