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, NULL);
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, NULL);
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;
268 int ses_match_host(struct enclosure_device *edev, void *data)
270 struct ses_host_edev *sed = data;
271 struct scsi_device *sdev;
273 if (!scsi_is_sdev_device(edev->edev.parent))
276 sdev = to_scsi_device(edev->edev.parent);
278 if (sdev->host != sed->shost)
286 static void ses_process_descriptor(struct enclosure_component *ecomp,
289 int eip = desc[0] & 0x10;
290 int invalid = desc[0] & 0x80;
291 enum scsi_protocol proto = desc[0] & 0x0f;
293 struct ses_component *scomp = ecomp->scratch;
302 case SCSI_PROTOCOL_SAS:
307 /* only take the phy0 addr */
308 addr = (u64)d[12] << 56 |
318 /* FIXME: Need to add more protocols than just SAS */
329 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
332 struct efd *efd = data;
334 struct ses_component *scomp;
336 if (!edev->component[0].scratch)
339 for (i = 0; i < edev->components; i++) {
340 scomp = edev->component[i].scratch;
341 if (scomp->addr != efd->addr)
344 enclosure_add_device(edev, i, efd->dev);
350 #define INIT_ALLOC_SIZE 32
352 static void ses_enclosure_data_process(struct enclosure_device *edev,
353 struct scsi_device *sdev,
357 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
358 int i, j, page7_len, len, components;
359 struct ses_device *ses_dev = edev->scratch;
360 int types = ses_dev->page1[10];
361 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
364 goto simple_populate;
366 /* re-read page 10 */
368 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
369 /* Page 7 for the descriptors is optional */
370 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
372 goto simple_populate;
374 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
375 /* add 1 for trailing '\0' we'll use */
376 buf = kzalloc(len + 1, GFP_KERNEL);
378 goto simple_populate;
379 result = ses_recv_diag(sdev, 7, buf, len);
389 len = (desc_ptr[2] << 8) + desc_ptr[3];
390 /* skip past overall descriptor */
393 addl_desc_ptr = ses_dev->page10 + 8;
395 type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
397 for (i = 0; i < types; i++, type_ptr += 4) {
398 for (j = 0; j < type_ptr[1]; j++) {
400 struct enclosure_component *ecomp;
403 if (desc_ptr >= buf + page7_len) {
406 len = (desc_ptr[2] << 8) + desc_ptr[3];
408 /* Add trailing zero - pushes into
410 desc_ptr[len] = '\0';
414 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
415 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
418 ecomp = enclosure_component_register(edev,
423 ecomp = &edev->component[components++];
425 if (!IS_ERR(ecomp) && addl_desc_ptr)
426 ses_process_descriptor(ecomp,
433 addl_desc_ptr += addl_desc_ptr[1] + 2;
441 static void ses_match_to_enclosure(struct enclosure_device *edev,
442 struct scsi_device *sdev)
446 unsigned int vpd_len;
451 buf = scsi_get_vpd_page(sdev, 0x83);
455 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
457 vpd_len = ((buf[2] << 8) | buf[3]) + 4;
460 while (desc < buf + vpd_len) {
461 enum scsi_protocol proto = desc[0] >> 4;
462 u8 code_set = desc[0] & 0x0f;
463 u8 piv = desc[1] & 0x80;
464 u8 assoc = (desc[1] & 0x30) >> 4;
465 u8 type = desc[1] & 0x0f;
468 if (piv && code_set == 1 && assoc == 1
469 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
470 efd.addr = (u64)desc[4] << 56 |
484 efd.dev = &sdev->sdev_gendev;
486 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
491 static int ses_intf_add(struct device *cdev,
492 struct class_interface *intf)
494 struct scsi_device *sdev = to_scsi_device(cdev->parent);
495 struct scsi_device *tmp_sdev;
496 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
497 struct ses_device *ses_dev;
499 int i, types, len, components = 0;
501 struct enclosure_device *edev;
502 struct ses_component *scomp = NULL;
504 if (!scsi_device_enclosure(sdev)) {
505 /* not an enclosure, but might be in one */
506 struct enclosure_device *prev = NULL;
508 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
509 ses_match_to_enclosure(edev, sdev);
515 /* TYPE_ENCLOSURE prints a message in probe */
516 if (sdev->type != TYPE_ENCLOSURE)
517 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
519 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
520 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
521 if (!hdr_buf || !ses_dev)
524 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
528 if (hdr_buf[1] != 0) {
529 /* FIXME: need subenclosure support; I've just never
530 * seen a device with subenclosures and it makes the
531 * traversal routines more complex */
532 sdev_printk(KERN_ERR, sdev,
533 "FIXME driver has no support for subenclosures (%d)\n",
538 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
539 buf = kzalloc(len, GFP_KERNEL);
543 result = ses_recv_diag(sdev, 1, buf, len);
549 type_ptr = buf + 12 + buf[11];
551 for (i = 0; i < types; i++, type_ptr += 4) {
552 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
553 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
554 components += type_ptr[1];
556 ses_dev->page1 = buf;
557 ses_dev->page1_len = len;
560 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
564 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
565 buf = kzalloc(len, GFP_KERNEL);
569 /* make sure getting page 2 actually works */
570 result = ses_recv_diag(sdev, 2, buf, len);
573 ses_dev->page2 = buf;
574 ses_dev->page2_len = len;
577 /* The additional information page --- allows us
578 * to match up the devices */
579 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
582 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
583 buf = kzalloc(len, GFP_KERNEL);
587 result = ses_recv_diag(sdev, 10, buf, len);
590 ses_dev->page10 = buf;
591 ses_dev->page10_len = len;
594 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
598 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
599 components, &ses_enclosure_callbacks);
607 edev->scratch = ses_dev;
608 for (i = 0; i < components; i++)
609 edev->component[i].scratch = scomp + i;
611 ses_enclosure_data_process(edev, sdev, 1);
613 /* see if there are any devices matching before
614 * we found the enclosure */
615 shost_for_each_device(tmp_sdev, sdev->host) {
616 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
618 ses_match_to_enclosure(edev, tmp_sdev);
624 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
630 kfree(ses_dev->page10);
631 kfree(ses_dev->page2);
632 kfree(ses_dev->page1);
636 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
640 static int ses_remove(struct device *dev)
645 static void ses_intf_remove_component(struct scsi_device *sdev)
647 struct enclosure_device *edev, *prev = NULL;
649 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
651 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
655 put_device(&edev->edev);
658 static void ses_intf_remove_enclosure(struct scsi_device *sdev)
660 struct enclosure_device *edev;
661 struct ses_device *ses_dev;
663 /* exact match to this enclosure */
664 edev = enclosure_find(&sdev->sdev_gendev, NULL);
668 ses_dev = edev->scratch;
669 edev->scratch = NULL;
671 kfree(ses_dev->page10);
672 kfree(ses_dev->page1);
673 kfree(ses_dev->page2);
676 kfree(edev->component[0].scratch);
678 put_device(&edev->edev);
679 enclosure_unregister(edev);
682 static void ses_intf_remove(struct device *cdev,
683 struct class_interface *intf)
685 struct scsi_device *sdev = to_scsi_device(cdev->parent);
687 if (!scsi_device_enclosure(sdev))
688 ses_intf_remove_component(sdev);
690 ses_intf_remove_enclosure(sdev);
693 static struct class_interface ses_interface = {
694 .add_dev = ses_intf_add,
695 .remove_dev = ses_intf_remove,
698 static struct scsi_driver ses_template = {
699 .owner = THIS_MODULE,
703 .remove = ses_remove,
707 static int __init ses_init(void)
711 err = scsi_register_interface(&ses_interface);
715 err = scsi_register_driver(&ses_template.gendrv);
722 scsi_unregister_interface(&ses_interface);
726 static void __exit ses_exit(void)
728 scsi_unregister_driver(&ses_template.gendrv);
729 scsi_unregister_interface(&ses_interface);
732 module_init(ses_init);
733 module_exit(ses_exit);
735 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
737 MODULE_AUTHOR("James Bottomley");
738 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
739 MODULE_LICENSE("GPL v2");