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)
73 unsigned char cmd[] = {
82 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
83 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
86 static int ses_send_diag(struct scsi_device *sdev, int page_code,
87 void *buf, int bufflen)
91 unsigned char cmd[] = {
93 0x10, /* Set PF bit */
100 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
101 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
103 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
108 static int ses_set_page2_descriptor(struct enclosure_device *edev,
109 struct enclosure_component *ecomp,
112 int i, j, count = 0, descriptor = ecomp->number;
113 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
114 struct ses_device *ses_dev = edev->scratch;
115 unsigned char *type_ptr = ses_dev->page1_types;
116 unsigned char *desc_ptr = ses_dev->page2 + 8;
118 /* Clear everything */
119 memset(desc_ptr, 0, ses_dev->page2_len - 8);
120 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
121 for (j = 0; j < type_ptr[1]; j++) {
123 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
124 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
126 if (count++ == descriptor) {
127 memcpy(desc_ptr, desc, 4);
130 /* clear reserved, just in case */
136 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
139 static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
140 struct enclosure_component *ecomp)
142 int i, j, count = 0, descriptor = ecomp->number;
143 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
144 struct ses_device *ses_dev = edev->scratch;
145 unsigned char *type_ptr = ses_dev->page1_types;
146 unsigned char *desc_ptr = ses_dev->page2 + 8;
148 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
150 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
151 for (j = 0; j < type_ptr[1]; j++) {
153 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
154 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
156 if (count++ == descriptor)
163 /* For device slot and array device slot elements, byte 3 bit 6
164 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
165 * code stands these bits are shifted 4 positions right so in
166 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
167 static void ses_get_fault(struct enclosure_device *edev,
168 struct enclosure_component *ecomp)
172 desc = ses_get_page2_descriptor(edev, ecomp);
174 ecomp->fault = (desc[3] & 0x60) >> 4;
177 static int ses_set_fault(struct enclosure_device *edev,
178 struct enclosure_component *ecomp,
179 enum enclosure_component_setting val)
181 unsigned char desc[4] = {0 };
184 case ENCLOSURE_SETTING_DISABLED:
185 /* zero is disabled */
187 case ENCLOSURE_SETTING_ENABLED:
191 /* SES doesn't do the SGPIO blink settings */
195 return ses_set_page2_descriptor(edev, ecomp, desc);
198 static void ses_get_status(struct enclosure_device *edev,
199 struct enclosure_component *ecomp)
203 desc = ses_get_page2_descriptor(edev, ecomp);
205 ecomp->status = (desc[0] & 0x0f);
208 static void ses_get_locate(struct enclosure_device *edev,
209 struct enclosure_component *ecomp)
213 desc = ses_get_page2_descriptor(edev, ecomp);
215 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
218 static int ses_set_locate(struct enclosure_device *edev,
219 struct enclosure_component *ecomp,
220 enum enclosure_component_setting val)
222 unsigned char desc[4] = {0 };
225 case ENCLOSURE_SETTING_DISABLED:
226 /* zero is disabled */
228 case ENCLOSURE_SETTING_ENABLED:
232 /* SES doesn't do the SGPIO blink settings */
235 return ses_set_page2_descriptor(edev, ecomp, desc);
238 static int ses_set_active(struct enclosure_device *edev,
239 struct enclosure_component *ecomp,
240 enum enclosure_component_setting val)
242 unsigned char desc[4] = {0 };
245 case ENCLOSURE_SETTING_DISABLED:
246 /* zero is disabled */
249 case ENCLOSURE_SETTING_ENABLED:
254 /* SES doesn't do the SGPIO blink settings */
257 return ses_set_page2_descriptor(edev, ecomp, desc);
260 static struct enclosure_component_callbacks ses_enclosure_callbacks = {
261 .get_fault = ses_get_fault,
262 .set_fault = ses_set_fault,
263 .get_status = ses_get_status,
264 .get_locate = ses_get_locate,
265 .set_locate = ses_set_locate,
266 .set_active = ses_set_active,
269 struct ses_host_edev {
270 struct Scsi_Host *shost;
271 struct enclosure_device *edev;
275 int ses_match_host(struct enclosure_device *edev, void *data)
277 struct ses_host_edev *sed = data;
278 struct scsi_device *sdev;
280 if (!scsi_is_sdev_device(edev->edev.parent))
283 sdev = to_scsi_device(edev->edev.parent);
285 if (sdev->host != sed->shost)
293 static void ses_process_descriptor(struct enclosure_component *ecomp,
296 int eip = desc[0] & 0x10;
297 int invalid = desc[0] & 0x80;
298 enum scsi_protocol proto = desc[0] & 0x0f;
300 struct ses_component *scomp = ecomp->scratch;
309 case SCSI_PROTOCOL_SAS:
314 /* only take the phy0 addr */
315 addr = (u64)d[12] << 56 |
325 /* FIXME: Need to add more protocols than just SAS */
336 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
339 struct efd *efd = data;
341 struct ses_component *scomp;
343 if (!edev->component[0].scratch)
346 for (i = 0; i < edev->components; i++) {
347 scomp = edev->component[i].scratch;
348 if (scomp->addr != efd->addr)
351 enclosure_add_device(edev, i, efd->dev);
357 #define INIT_ALLOC_SIZE 32
359 static void ses_enclosure_data_process(struct enclosure_device *edev,
360 struct scsi_device *sdev,
364 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
365 int i, j, page7_len, len, components;
366 struct ses_device *ses_dev = edev->scratch;
367 int types = ses_dev->page1_num_types;
368 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
371 goto simple_populate;
373 /* re-read page 10 */
375 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
376 /* Page 7 for the descriptors is optional */
377 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
379 goto simple_populate;
381 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
382 /* add 1 for trailing '\0' we'll use */
383 buf = kzalloc(len + 1, GFP_KERNEL);
385 goto simple_populate;
386 result = ses_recv_diag(sdev, 7, buf, len);
396 len = (desc_ptr[2] << 8) + desc_ptr[3];
397 /* skip past overall descriptor */
401 addl_desc_ptr = ses_dev->page10 + 8;
402 type_ptr = ses_dev->page1_types;
404 for (i = 0; i < types; i++, type_ptr += 4) {
405 for (j = 0; j < type_ptr[1]; j++) {
407 struct enclosure_component *ecomp;
410 if (desc_ptr >= buf + page7_len) {
413 len = (desc_ptr[2] << 8) + desc_ptr[3];
415 /* Add trailing zero - pushes into
417 desc_ptr[len] = '\0';
421 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
422 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
425 ecomp = enclosure_component_register(edev,
430 ecomp = &edev->component[components++];
432 if (!IS_ERR(ecomp) && addl_desc_ptr)
433 ses_process_descriptor(ecomp,
440 addl_desc_ptr += addl_desc_ptr[1] + 2;
448 static void ses_match_to_enclosure(struct enclosure_device *edev,
449 struct scsi_device *sdev)
453 unsigned int vpd_len;
458 buf = kmalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
459 if (!buf || scsi_get_vpd_page(sdev, 0x83, buf, INIT_ALLOC_SIZE))
462 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
464 vpd_len = ((buf[2] << 8) | buf[3]) + 4;
466 buf = kmalloc(vpd_len, GFP_KERNEL);
467 if (!buf ||scsi_get_vpd_page(sdev, 0x83, buf, vpd_len))
471 while (desc < buf + vpd_len) {
472 enum scsi_protocol proto = desc[0] >> 4;
473 u8 code_set = desc[0] & 0x0f;
474 u8 piv = desc[1] & 0x80;
475 u8 assoc = (desc[1] & 0x30) >> 4;
476 u8 type = desc[1] & 0x0f;
479 if (piv && code_set == 1 && assoc == 1
480 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
481 efd.addr = (u64)desc[4] << 56 |
495 efd.dev = &sdev->sdev_gendev;
497 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
502 static int ses_intf_add(struct device *cdev,
503 struct class_interface *intf)
505 struct scsi_device *sdev = to_scsi_device(cdev->parent);
506 struct scsi_device *tmp_sdev;
507 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
508 struct ses_device *ses_dev;
510 int i, types, len, components = 0;
513 struct enclosure_device *edev;
514 struct ses_component *scomp = NULL;
516 if (!scsi_device_enclosure(sdev)) {
517 /* not an enclosure, but might be in one */
518 struct enclosure_device *prev = NULL;
520 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
521 ses_match_to_enclosure(edev, sdev);
527 /* TYPE_ENCLOSURE prints a message in probe */
528 if (sdev->type != TYPE_ENCLOSURE)
529 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
531 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
532 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
533 if (!hdr_buf || !ses_dev)
536 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
540 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
541 buf = kzalloc(len, GFP_KERNEL);
545 result = ses_recv_diag(sdev, 1, buf, len);
551 /* we always have one main enclosure and the rest are referred
552 * to as secondary subenclosures */
553 num_enclosures = buf[1] + 1;
555 /* begin at the enclosure descriptor */
557 /* skip all the enclosure descriptors */
558 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
559 types += type_ptr[2];
560 type_ptr += type_ptr[3] + 4;
563 ses_dev->page1_types = type_ptr;
564 ses_dev->page1_num_types = types;
566 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
567 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
568 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
569 components += type_ptr[1];
571 ses_dev->page1 = buf;
572 ses_dev->page1_len = len;
575 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
579 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
580 buf = kzalloc(len, GFP_KERNEL);
584 /* make sure getting page 2 actually works */
585 result = ses_recv_diag(sdev, 2, buf, len);
588 ses_dev->page2 = buf;
589 ses_dev->page2_len = len;
592 /* The additional information page --- allows us
593 * to match up the devices */
594 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
597 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
598 buf = kzalloc(len, GFP_KERNEL);
602 result = ses_recv_diag(sdev, 10, buf, len);
605 ses_dev->page10 = buf;
606 ses_dev->page10_len = len;
609 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
613 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
614 components, &ses_enclosure_callbacks);
622 edev->scratch = ses_dev;
623 for (i = 0; i < components; i++)
624 edev->component[i].scratch = scomp + i;
626 ses_enclosure_data_process(edev, sdev, 1);
628 /* see if there are any devices matching before
629 * we found the enclosure */
630 shost_for_each_device(tmp_sdev, sdev->host) {
631 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
633 ses_match_to_enclosure(edev, tmp_sdev);
639 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
645 kfree(ses_dev->page10);
646 kfree(ses_dev->page2);
647 kfree(ses_dev->page1);
651 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
655 static int ses_remove(struct device *dev)
660 static void ses_intf_remove_component(struct scsi_device *sdev)
662 struct enclosure_device *edev, *prev = NULL;
664 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
666 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
670 put_device(&edev->edev);
673 static void ses_intf_remove_enclosure(struct scsi_device *sdev)
675 struct enclosure_device *edev;
676 struct ses_device *ses_dev;
678 /* exact match to this enclosure */
679 edev = enclosure_find(&sdev->sdev_gendev, NULL);
683 ses_dev = edev->scratch;
684 edev->scratch = NULL;
686 kfree(ses_dev->page10);
687 kfree(ses_dev->page1);
688 kfree(ses_dev->page2);
691 kfree(edev->component[0].scratch);
693 put_device(&edev->edev);
694 enclosure_unregister(edev);
697 static void ses_intf_remove(struct device *cdev,
698 struct class_interface *intf)
700 struct scsi_device *sdev = to_scsi_device(cdev->parent);
702 if (!scsi_device_enclosure(sdev))
703 ses_intf_remove_component(sdev);
705 ses_intf_remove_enclosure(sdev);
708 static struct class_interface ses_interface = {
709 .add_dev = ses_intf_add,
710 .remove_dev = ses_intf_remove,
713 static struct scsi_driver ses_template = {
714 .owner = THIS_MODULE,
718 .remove = ses_remove,
722 static int __init ses_init(void)
726 err = scsi_register_interface(&ses_interface);
730 err = scsi_register_driver(&ses_template.gendrv);
737 scsi_unregister_interface(&ses_interface);
741 static void __exit ses_exit(void)
743 scsi_unregister_driver(&ses_template.gendrv);
744 scsi_unregister_interface(&ses_interface);
747 module_init(ses_init);
748 module_exit(ses_exit);
750 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
752 MODULE_AUTHOR("James Bottomley");
753 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
754 MODULE_LICENSE("GPL v2");