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>
28 #include <asm/unaligned.h>
30 #include <scsi/scsi.h>
31 #include <scsi/scsi_cmnd.h>
32 #include <scsi/scsi_dbg.h>
33 #include <scsi/scsi_device.h>
34 #include <scsi/scsi_driver.h>
35 #include <scsi/scsi_host.h>
39 unsigned char *page1_types;
41 unsigned char *page10;
43 short page1_num_types;
48 struct ses_component {
53 static int ses_probe(struct device *dev)
55 struct scsi_device *sdev = to_scsi_device(dev);
58 if (sdev->type != TYPE_ENCLOSURE)
62 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
68 #define SES_TIMEOUT (30 * HZ)
71 static int ses_recv_diag(struct scsi_device *sdev, int page_code,
72 void *buf, int bufflen)
74 unsigned char cmd[] = {
83 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
84 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
87 static int ses_send_diag(struct scsi_device *sdev, int page_code,
88 void *buf, int bufflen)
92 unsigned char cmd[] = {
94 0x10, /* Set PF bit */
101 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
102 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
104 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
109 static int ses_set_page2_descriptor(struct enclosure_device *edev,
110 struct enclosure_component *ecomp,
113 int i, j, count = 0, descriptor = ecomp->number;
114 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
115 struct ses_device *ses_dev = edev->scratch;
116 unsigned char *type_ptr = ses_dev->page1_types;
117 unsigned char *desc_ptr = ses_dev->page2 + 8;
119 /* Clear everything */
120 memset(desc_ptr, 0, ses_dev->page2_len - 8);
121 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
122 for (j = 0; j < type_ptr[1]; j++) {
124 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
125 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
127 if (count++ == descriptor) {
128 memcpy(desc_ptr, desc, 4);
131 /* clear reserved, just in case */
137 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
140 static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
141 struct enclosure_component *ecomp)
143 int i, j, count = 0, descriptor = ecomp->number;
144 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
145 struct ses_device *ses_dev = edev->scratch;
146 unsigned char *type_ptr = ses_dev->page1_types;
147 unsigned char *desc_ptr = ses_dev->page2 + 8;
149 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
151 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
152 for (j = 0; j < type_ptr[1]; j++) {
154 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
155 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
157 if (count++ == descriptor)
164 /* For device slot and array device slot elements, byte 3 bit 6
165 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
166 * code stands these bits are shifted 4 positions right so in
167 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
168 static void ses_get_fault(struct enclosure_device *edev,
169 struct enclosure_component *ecomp)
173 desc = ses_get_page2_descriptor(edev, ecomp);
175 ecomp->fault = (desc[3] & 0x60) >> 4;
178 static int ses_set_fault(struct enclosure_device *edev,
179 struct enclosure_component *ecomp,
180 enum enclosure_component_setting val)
182 unsigned char desc[4] = {0 };
185 case ENCLOSURE_SETTING_DISABLED:
186 /* zero is disabled */
188 case ENCLOSURE_SETTING_ENABLED:
192 /* SES doesn't do the SGPIO blink settings */
196 return ses_set_page2_descriptor(edev, ecomp, desc);
199 static void ses_get_status(struct enclosure_device *edev,
200 struct enclosure_component *ecomp)
204 desc = ses_get_page2_descriptor(edev, ecomp);
206 ecomp->status = (desc[0] & 0x0f);
209 static void ses_get_locate(struct enclosure_device *edev,
210 struct enclosure_component *ecomp)
214 desc = ses_get_page2_descriptor(edev, ecomp);
216 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
219 static int ses_set_locate(struct enclosure_device *edev,
220 struct enclosure_component *ecomp,
221 enum enclosure_component_setting val)
223 unsigned char desc[4] = {0 };
226 case ENCLOSURE_SETTING_DISABLED:
227 /* zero is disabled */
229 case ENCLOSURE_SETTING_ENABLED:
233 /* SES doesn't do the SGPIO blink settings */
236 return ses_set_page2_descriptor(edev, ecomp, desc);
239 static int ses_set_active(struct enclosure_device *edev,
240 struct enclosure_component *ecomp,
241 enum enclosure_component_setting val)
243 unsigned char desc[4] = {0 };
246 case ENCLOSURE_SETTING_DISABLED:
247 /* zero is disabled */
250 case ENCLOSURE_SETTING_ENABLED:
255 /* SES doesn't do the SGPIO blink settings */
258 return ses_set_page2_descriptor(edev, ecomp, desc);
261 static int ses_show_id(struct enclosure_device *edev, char *buf)
263 struct ses_device *ses_dev = edev->scratch;
264 unsigned long long id = get_unaligned_be64(ses_dev->page1+8+4);
266 return sprintf(buf, "%#llx\n", id);
269 static struct enclosure_component_callbacks ses_enclosure_callbacks = {
270 .get_fault = ses_get_fault,
271 .set_fault = ses_set_fault,
272 .get_status = ses_get_status,
273 .get_locate = ses_get_locate,
274 .set_locate = ses_set_locate,
275 .set_active = ses_set_active,
276 .show_id = ses_show_id,
279 struct ses_host_edev {
280 struct Scsi_Host *shost;
281 struct enclosure_device *edev;
285 int ses_match_host(struct enclosure_device *edev, void *data)
287 struct ses_host_edev *sed = data;
288 struct scsi_device *sdev;
290 if (!scsi_is_sdev_device(edev->edev.parent))
293 sdev = to_scsi_device(edev->edev.parent);
295 if (sdev->host != sed->shost)
303 static void ses_process_descriptor(struct enclosure_component *ecomp,
306 int eip = desc[0] & 0x10;
307 int invalid = desc[0] & 0x80;
308 enum scsi_protocol proto = desc[0] & 0x0f;
310 struct ses_component *scomp = ecomp->scratch;
319 case SCSI_PROTOCOL_SAS:
324 /* only take the phy0 addr */
325 addr = (u64)d[12] << 56 |
335 /* FIXME: Need to add more protocols than just SAS */
346 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
349 struct efd *efd = data;
351 struct ses_component *scomp;
353 if (!edev->component[0].scratch)
356 for (i = 0; i < edev->components; i++) {
357 scomp = edev->component[i].scratch;
358 if (scomp->addr != efd->addr)
361 if (enclosure_add_device(edev, i, efd->dev) == 0)
362 kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
368 #define INIT_ALLOC_SIZE 32
370 static void ses_enclosure_data_process(struct enclosure_device *edev,
371 struct scsi_device *sdev,
375 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
376 int i, j, page7_len, len, components;
377 struct ses_device *ses_dev = edev->scratch;
378 int types = ses_dev->page1_num_types;
379 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
382 goto simple_populate;
384 /* re-read page 10 */
386 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
387 /* Page 7 for the descriptors is optional */
388 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
390 goto simple_populate;
392 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
393 /* add 1 for trailing '\0' we'll use */
394 buf = kzalloc(len + 1, GFP_KERNEL);
396 goto simple_populate;
397 result = ses_recv_diag(sdev, 7, buf, len);
407 len = (desc_ptr[2] << 8) + desc_ptr[3];
408 /* skip past overall descriptor */
412 addl_desc_ptr = ses_dev->page10 + 8;
413 type_ptr = ses_dev->page1_types;
415 for (i = 0; i < types; i++, type_ptr += 4) {
416 for (j = 0; j < type_ptr[1]; j++) {
418 struct enclosure_component *ecomp;
421 if (desc_ptr >= buf + page7_len) {
424 len = (desc_ptr[2] << 8) + desc_ptr[3];
426 /* Add trailing zero - pushes into
428 desc_ptr[len] = '\0';
432 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
433 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
436 ecomp = enclosure_component_alloc(
442 ecomp = &edev->component[components++];
444 if (!IS_ERR(ecomp)) {
446 ses_process_descriptor(
450 enclosure_component_register(
458 addl_desc_ptr += addl_desc_ptr[1] + 2;
466 static void ses_match_to_enclosure(struct enclosure_device *edev,
467 struct scsi_device *sdev)
474 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
476 if (!sdev->vpd_pg83_len)
479 desc = sdev->vpd_pg83 + 4;
480 while (desc < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
481 enum scsi_protocol proto = desc[0] >> 4;
482 u8 code_set = desc[0] & 0x0f;
483 u8 piv = desc[1] & 0x80;
484 u8 assoc = (desc[1] & 0x30) >> 4;
485 u8 type = desc[1] & 0x0f;
488 if (piv && code_set == 1 && assoc == 1
489 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
490 efd.addr = get_unaligned_be64(&desc[4]);
495 efd.dev = &sdev->sdev_gendev;
497 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
501 static int ses_intf_add(struct device *cdev,
502 struct class_interface *intf)
504 struct scsi_device *sdev = to_scsi_device(cdev->parent);
505 struct scsi_device *tmp_sdev;
506 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
507 struct ses_device *ses_dev;
509 int i, types, len, components = 0;
512 struct enclosure_device *edev;
513 struct ses_component *scomp = NULL;
515 if (!scsi_device_enclosure(sdev)) {
516 /* not an enclosure, but might be in one */
517 struct enclosure_device *prev = NULL;
519 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
520 ses_match_to_enclosure(edev, sdev);
526 /* TYPE_ENCLOSURE prints a message in probe */
527 if (sdev->type != TYPE_ENCLOSURE)
528 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
530 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
531 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
532 if (!hdr_buf || !ses_dev)
535 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
539 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
540 buf = kzalloc(len, GFP_KERNEL);
544 result = ses_recv_diag(sdev, 1, buf, len);
550 /* we always have one main enclosure and the rest are referred
551 * to as secondary subenclosures */
552 num_enclosures = buf[1] + 1;
554 /* begin at the enclosure descriptor */
556 /* skip all the enclosure descriptors */
557 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
558 types += type_ptr[2];
559 type_ptr += type_ptr[3] + 4;
562 ses_dev->page1_types = type_ptr;
563 ses_dev->page1_num_types = types;
565 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
566 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
567 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
568 components += type_ptr[1];
570 ses_dev->page1 = buf;
571 ses_dev->page1_len = len;
574 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
578 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
579 buf = kzalloc(len, GFP_KERNEL);
583 /* make sure getting page 2 actually works */
584 result = ses_recv_diag(sdev, 2, buf, len);
587 ses_dev->page2 = buf;
588 ses_dev->page2_len = len;
591 /* The additional information page --- allows us
592 * to match up the devices */
593 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
596 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
597 buf = kzalloc(len, GFP_KERNEL);
601 result = ses_recv_diag(sdev, 10, buf, len);
604 ses_dev->page10 = buf;
605 ses_dev->page10_len = len;
608 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
612 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
613 components, &ses_enclosure_callbacks);
621 edev->scratch = ses_dev;
622 for (i = 0; i < components; i++)
623 edev->component[i].scratch = scomp + i;
625 ses_enclosure_data_process(edev, sdev, 1);
627 /* see if there are any devices matching before
628 * we found the enclosure */
629 shost_for_each_device(tmp_sdev, sdev->host) {
630 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
632 ses_match_to_enclosure(edev, tmp_sdev);
638 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
644 kfree(ses_dev->page10);
645 kfree(ses_dev->page2);
646 kfree(ses_dev->page1);
650 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
654 static int ses_remove(struct device *dev)
659 static void ses_intf_remove_component(struct scsi_device *sdev)
661 struct enclosure_device *edev, *prev = NULL;
663 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
665 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
669 put_device(&edev->edev);
672 static void ses_intf_remove_enclosure(struct scsi_device *sdev)
674 struct enclosure_device *edev;
675 struct ses_device *ses_dev;
677 /* exact match to this enclosure */
678 edev = enclosure_find(&sdev->sdev_gendev, NULL);
682 ses_dev = edev->scratch;
683 edev->scratch = NULL;
685 kfree(ses_dev->page10);
686 kfree(ses_dev->page1);
687 kfree(ses_dev->page2);
690 kfree(edev->component[0].scratch);
692 put_device(&edev->edev);
693 enclosure_unregister(edev);
696 static void ses_intf_remove(struct device *cdev,
697 struct class_interface *intf)
699 struct scsi_device *sdev = to_scsi_device(cdev->parent);
701 if (!scsi_device_enclosure(sdev))
702 ses_intf_remove_component(sdev);
704 ses_intf_remove_enclosure(sdev);
707 static struct class_interface ses_interface = {
708 .add_dev = ses_intf_add,
709 .remove_dev = ses_intf_remove,
712 static struct scsi_driver ses_template = {
715 .owner = THIS_MODULE,
717 .remove = ses_remove,
721 static int __init ses_init(void)
725 err = scsi_register_interface(&ses_interface);
729 err = scsi_register_driver(&ses_template.gendrv);
736 scsi_unregister_interface(&ses_interface);
740 static void __exit ses_exit(void)
742 scsi_unregister_driver(&ses_template.gendrv);
743 scsi_unregister_interface(&ses_interface);
746 module_init(ses_init);
747 module_exit(ses_exit);
749 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
751 MODULE_AUTHOR("James Bottomley");
752 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
753 MODULE_LICENSE("GPL v2");