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/slab.h>
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/enclosure.h>
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_cmnd.h>
31 #include <scsi/scsi_dbg.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_driver.h>
34 #include <scsi/scsi_host.h>
38 unsigned char *page1_types;
40 unsigned char *page10;
42 short page1_num_types;
47 struct ses_component {
52 static int ses_probe(struct device *dev)
54 struct scsi_device *sdev = to_scsi_device(dev);
57 if (sdev->type != TYPE_ENCLOSURE)
61 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
67 #define SES_TIMEOUT (30 * HZ)
70 static int ses_recv_diag(struct scsi_device *sdev, int page_code,
71 void *buf, int bufflen)
74 unsigned char cmd[] = {
82 unsigned char recv_page_code;
84 ret = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
85 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
89 recv_page_code = ((unsigned char *)buf)[0];
91 if (likely(recv_page_code == page_code))
94 /* successful diagnostic but wrong page code. This happens to some
95 * USB devices, just print a message and pretend there was an error */
97 sdev_printk(KERN_ERR, sdev,
98 "Wrong diagnostic page; asked for %d got %u\n",
99 page_code, recv_page_code);
104 static int ses_send_diag(struct scsi_device *sdev, int page_code,
105 void *buf, int bufflen)
109 unsigned char cmd[] = {
111 0x10, /* Set PF bit */
118 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
119 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
121 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
126 static int ses_set_page2_descriptor(struct enclosure_device *edev,
127 struct enclosure_component *ecomp,
130 int i, j, count = 0, descriptor = ecomp->number;
131 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
132 struct ses_device *ses_dev = edev->scratch;
133 unsigned char *type_ptr = ses_dev->page1_types;
134 unsigned char *desc_ptr = ses_dev->page2 + 8;
136 /* Clear everything */
137 memset(desc_ptr, 0, ses_dev->page2_len - 8);
138 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
139 for (j = 0; j < type_ptr[1]; j++) {
141 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
142 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
144 if (count++ == descriptor) {
145 memcpy(desc_ptr, desc, 4);
148 /* clear reserved, just in case */
154 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
157 static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
158 struct enclosure_component *ecomp)
160 int i, j, count = 0, descriptor = ecomp->number;
161 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
162 struct ses_device *ses_dev = edev->scratch;
163 unsigned char *type_ptr = ses_dev->page1_types;
164 unsigned char *desc_ptr = ses_dev->page2 + 8;
166 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
168 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
169 for (j = 0; j < type_ptr[1]; j++) {
171 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
172 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
174 if (count++ == descriptor)
181 /* For device slot and array device slot elements, byte 3 bit 6
182 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
183 * code stands these bits are shifted 4 positions right so in
184 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
185 static void ses_get_fault(struct enclosure_device *edev,
186 struct enclosure_component *ecomp)
190 desc = ses_get_page2_descriptor(edev, ecomp);
192 ecomp->fault = (desc[3] & 0x60) >> 4;
195 static int ses_set_fault(struct enclosure_device *edev,
196 struct enclosure_component *ecomp,
197 enum enclosure_component_setting val)
199 unsigned char desc[4] = {0 };
202 case ENCLOSURE_SETTING_DISABLED:
203 /* zero is disabled */
205 case ENCLOSURE_SETTING_ENABLED:
209 /* SES doesn't do the SGPIO blink settings */
213 return ses_set_page2_descriptor(edev, ecomp, desc);
216 static void ses_get_status(struct enclosure_device *edev,
217 struct enclosure_component *ecomp)
221 desc = ses_get_page2_descriptor(edev, ecomp);
223 ecomp->status = (desc[0] & 0x0f);
226 static void ses_get_locate(struct enclosure_device *edev,
227 struct enclosure_component *ecomp)
231 desc = ses_get_page2_descriptor(edev, ecomp);
233 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
236 static int ses_set_locate(struct enclosure_device *edev,
237 struct enclosure_component *ecomp,
238 enum enclosure_component_setting val)
240 unsigned char desc[4] = {0 };
243 case ENCLOSURE_SETTING_DISABLED:
244 /* zero is disabled */
246 case ENCLOSURE_SETTING_ENABLED:
250 /* SES doesn't do the SGPIO blink settings */
253 return ses_set_page2_descriptor(edev, ecomp, desc);
256 static int ses_set_active(struct enclosure_device *edev,
257 struct enclosure_component *ecomp,
258 enum enclosure_component_setting val)
260 unsigned char desc[4] = {0 };
263 case ENCLOSURE_SETTING_DISABLED:
264 /* zero is disabled */
267 case ENCLOSURE_SETTING_ENABLED:
272 /* SES doesn't do the SGPIO blink settings */
275 return ses_set_page2_descriptor(edev, ecomp, desc);
278 static struct enclosure_component_callbacks ses_enclosure_callbacks = {
279 .get_fault = ses_get_fault,
280 .set_fault = ses_set_fault,
281 .get_status = ses_get_status,
282 .get_locate = ses_get_locate,
283 .set_locate = ses_set_locate,
284 .set_active = ses_set_active,
287 struct ses_host_edev {
288 struct Scsi_Host *shost;
289 struct enclosure_device *edev;
293 int ses_match_host(struct enclosure_device *edev, void *data)
295 struct ses_host_edev *sed = data;
296 struct scsi_device *sdev;
298 if (!scsi_is_sdev_device(edev->edev.parent))
301 sdev = to_scsi_device(edev->edev.parent);
303 if (sdev->host != sed->shost)
311 static void ses_process_descriptor(struct enclosure_component *ecomp,
314 int eip = desc[0] & 0x10;
315 int invalid = desc[0] & 0x80;
316 enum scsi_protocol proto = desc[0] & 0x0f;
318 struct ses_component *scomp = ecomp->scratch;
327 case SCSI_PROTOCOL_SAS:
332 /* only take the phy0 addr */
333 addr = (u64)d[12] << 56 |
343 /* FIXME: Need to add more protocols than just SAS */
354 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
357 struct efd *efd = data;
359 struct ses_component *scomp;
361 if (!edev->component[0].scratch)
364 for (i = 0; i < edev->components; i++) {
365 scomp = edev->component[i].scratch;
366 if (scomp->addr != efd->addr)
369 enclosure_add_device(edev, i, efd->dev);
375 #define INIT_ALLOC_SIZE 32
377 static void ses_enclosure_data_process(struct enclosure_device *edev,
378 struct scsi_device *sdev,
382 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
383 int i, j, page7_len, len, components;
384 struct ses_device *ses_dev = edev->scratch;
385 int types = ses_dev->page1_num_types;
386 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
389 goto simple_populate;
391 /* re-read page 10 */
393 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
394 /* Page 7 for the descriptors is optional */
395 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
397 goto simple_populate;
399 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
400 /* add 1 for trailing '\0' we'll use */
401 buf = kzalloc(len + 1, GFP_KERNEL);
403 goto simple_populate;
404 result = ses_recv_diag(sdev, 7, buf, len);
414 len = (desc_ptr[2] << 8) + desc_ptr[3];
415 /* skip past overall descriptor */
419 addl_desc_ptr = ses_dev->page10 + 8;
420 type_ptr = ses_dev->page1_types;
422 for (i = 0; i < types; i++, type_ptr += 4) {
423 for (j = 0; j < type_ptr[1]; j++) {
425 struct enclosure_component *ecomp;
428 if (desc_ptr >= buf + page7_len) {
431 len = (desc_ptr[2] << 8) + desc_ptr[3];
433 /* Add trailing zero - pushes into
435 desc_ptr[len] = '\0';
439 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
440 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
443 ecomp = enclosure_component_register(edev,
448 ecomp = &edev->component[components++];
450 if (!IS_ERR(ecomp) && addl_desc_ptr)
451 ses_process_descriptor(ecomp,
458 /* only find additional descriptions for specific devices */
459 (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
460 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
461 type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
462 /* these elements are optional */
463 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
464 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
465 type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS))
466 addl_desc_ptr += addl_desc_ptr[1] + 2;
474 static void ses_match_to_enclosure(struct enclosure_device *edev,
475 struct scsi_device *sdev)
479 unsigned int vpd_len;
484 buf = kmalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
485 if (!buf || scsi_get_vpd_page(sdev, 0x83, buf, INIT_ALLOC_SIZE))
488 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
490 vpd_len = ((buf[2] << 8) | buf[3]) + 4;
492 buf = kmalloc(vpd_len, GFP_KERNEL);
493 if (!buf ||scsi_get_vpd_page(sdev, 0x83, buf, vpd_len))
497 while (desc < buf + vpd_len) {
498 enum scsi_protocol proto = desc[0] >> 4;
499 u8 code_set = desc[0] & 0x0f;
500 u8 piv = desc[1] & 0x80;
501 u8 assoc = (desc[1] & 0x30) >> 4;
502 u8 type = desc[1] & 0x0f;
505 if (piv && code_set == 1 && assoc == 1
506 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
507 efd.addr = (u64)desc[4] << 56 |
521 efd.dev = &sdev->sdev_gendev;
523 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
528 static int ses_intf_add(struct device *cdev,
529 struct class_interface *intf)
531 struct scsi_device *sdev = to_scsi_device(cdev->parent);
532 struct scsi_device *tmp_sdev;
533 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
534 struct ses_device *ses_dev;
536 int i, types, len, components = 0;
539 struct enclosure_device *edev;
540 struct ses_component *scomp = NULL;
542 if (!scsi_device_enclosure(sdev)) {
543 /* not an enclosure, but might be in one */
544 struct enclosure_device *prev = NULL;
546 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
547 ses_match_to_enclosure(edev, sdev);
553 /* TYPE_ENCLOSURE prints a message in probe */
554 if (sdev->type != TYPE_ENCLOSURE)
555 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
557 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
558 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
559 if (!hdr_buf || !ses_dev)
562 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
566 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
567 buf = kzalloc(len, GFP_KERNEL);
571 result = ses_recv_diag(sdev, 1, buf, len);
577 /* we always have one main enclosure and the rest are referred
578 * to as secondary subenclosures */
579 num_enclosures = buf[1] + 1;
581 /* begin at the enclosure descriptor */
583 /* skip all the enclosure descriptors */
584 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
585 types += type_ptr[2];
586 type_ptr += type_ptr[3] + 4;
589 ses_dev->page1_types = type_ptr;
590 ses_dev->page1_num_types = types;
592 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
593 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
594 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
595 components += type_ptr[1];
597 ses_dev->page1 = buf;
598 ses_dev->page1_len = len;
601 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
605 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
606 buf = kzalloc(len, GFP_KERNEL);
610 /* make sure getting page 2 actually works */
611 result = ses_recv_diag(sdev, 2, buf, len);
614 ses_dev->page2 = buf;
615 ses_dev->page2_len = len;
618 /* The additional information page --- allows us
619 * to match up the devices */
620 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
623 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
624 buf = kzalloc(len, GFP_KERNEL);
628 result = ses_recv_diag(sdev, 10, buf, len);
631 ses_dev->page10 = buf;
632 ses_dev->page10_len = len;
635 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
639 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
640 components, &ses_enclosure_callbacks);
648 edev->scratch = ses_dev;
649 for (i = 0; i < components; i++)
650 edev->component[i].scratch = scomp + i;
652 ses_enclosure_data_process(edev, sdev, 1);
654 /* see if there are any devices matching before
655 * we found the enclosure */
656 shost_for_each_device(tmp_sdev, sdev->host) {
657 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
659 ses_match_to_enclosure(edev, tmp_sdev);
665 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
671 kfree(ses_dev->page10);
672 kfree(ses_dev->page2);
673 kfree(ses_dev->page1);
677 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
681 static int ses_remove(struct device *dev)
686 static void ses_intf_remove_component(struct scsi_device *sdev)
688 struct enclosure_device *edev, *prev = NULL;
690 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
692 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
696 put_device(&edev->edev);
699 static void ses_intf_remove_enclosure(struct scsi_device *sdev)
701 struct enclosure_device *edev;
702 struct ses_device *ses_dev;
704 /* exact match to this enclosure */
705 edev = enclosure_find(&sdev->sdev_gendev, NULL);
709 ses_dev = edev->scratch;
710 edev->scratch = NULL;
712 kfree(ses_dev->page10);
713 kfree(ses_dev->page1);
714 kfree(ses_dev->page2);
717 kfree(edev->component[0].scratch);
719 put_device(&edev->edev);
720 enclosure_unregister(edev);
723 static void ses_intf_remove(struct device *cdev,
724 struct class_interface *intf)
726 struct scsi_device *sdev = to_scsi_device(cdev->parent);
728 if (!scsi_device_enclosure(sdev))
729 ses_intf_remove_component(sdev);
731 ses_intf_remove_enclosure(sdev);
734 static struct class_interface ses_interface = {
735 .add_dev = ses_intf_add,
736 .remove_dev = ses_intf_remove,
739 static struct scsi_driver ses_template = {
740 .owner = THIS_MODULE,
744 .remove = ses_remove,
748 static int __init ses_init(void)
752 err = scsi_register_interface(&ses_interface);
756 err = scsi_register_driver(&ses_template.gendrv);
763 scsi_unregister_interface(&ses_interface);
767 static void __exit ses_exit(void)
769 scsi_unregister_driver(&ses_template.gendrv);
770 scsi_unregister_interface(&ses_interface);
773 module_init(ses_init);
774 module_exit(ses_exit);
776 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
778 MODULE_AUTHOR("James Bottomley");
779 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
780 MODULE_LICENSE("GPL v2");