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
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->cdev.dev);
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->cdev.dev);
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->cdev.dev))
275 sdev = to_scsi_device(edev->cdev.dev);
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 512
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 len = (buf[2] << 8) + buf[3];
377 while (desc < buf + len) {
378 enum scsi_protocol proto = desc[0] >> 4;
379 u8 code_set = desc[0] & 0x0f;
380 u8 piv = desc[1] & 0x80;
381 u8 assoc = (desc[1] & 0x30) >> 4;
382 u8 type = desc[1] & 0x0f;
385 if (piv && code_set == 1 && assoc == 1 && code_set == 1
386 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
387 efd.addr = (u64)desc[4] << 56 |
401 efd.dev = &sdev->sdev_gendev;
403 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
408 #define INIT_ALLOC_SIZE 32
410 static int ses_intf_add(struct class_device *cdev,
411 struct class_interface *intf)
413 struct scsi_device *sdev = to_scsi_device(cdev->dev);
414 struct scsi_device *tmp_sdev;
415 unsigned char *buf = NULL, *hdr_buf, *type_ptr, *desc_ptr = NULL,
416 *addl_desc_ptr = NULL;
417 struct ses_device *ses_dev;
419 int i, j, types, len, page7_len = 0, components = 0;
421 struct enclosure_device *edev;
422 struct ses_component *scomp = NULL;
424 if (!scsi_device_enclosure(sdev)) {
425 /* not an enclosure, but might be in one */
426 edev = enclosure_find(&sdev->host->shost_gendev);
428 ses_match_to_enclosure(edev, sdev);
429 class_device_put(&edev->cdev);
434 /* TYPE_ENCLOSURE prints a message in probe */
435 if (sdev->type != TYPE_ENCLOSURE)
436 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
438 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
439 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
440 if (!hdr_buf || !ses_dev)
443 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
447 if (hdr_buf[1] != 0) {
448 /* FIXME: need subenclosure support; I've just never
449 * seen a device with subenclosures and it makes the
450 * traversal routines more complex */
451 sdev_printk(KERN_ERR, sdev,
452 "FIXME driver has no support for subenclosures (%d)\n",
457 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
458 buf = kzalloc(len, GFP_KERNEL);
462 result = ses_recv_diag(sdev, 1, buf, len);
468 type_ptr = buf + 12 + buf[11];
470 for (i = 0; i < types; i++, type_ptr += 4) {
471 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
472 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
473 components += type_ptr[1];
475 ses_dev->page1 = buf;
476 ses_dev->page1_len = len;
479 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
483 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
484 buf = kzalloc(len, GFP_KERNEL);
488 /* make sure getting page 2 actually works */
489 result = ses_recv_diag(sdev, 2, buf, len);
492 ses_dev->page2 = buf;
493 ses_dev->page2_len = len;
496 /* The additional information page --- allows us
497 * to match up the devices */
498 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
501 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
502 buf = kzalloc(len, GFP_KERNEL);
506 result = ses_recv_diag(sdev, 10, buf, len);
509 ses_dev->page10 = buf;
510 ses_dev->page10_len = len;
514 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
518 edev = enclosure_register(cdev->dev, sdev->sdev_gendev.bus_id,
519 components, &ses_enclosure_callbacks);
525 edev->scratch = ses_dev;
526 for (i = 0; i < components; i++)
527 edev->component[i].scratch = scomp + i;
529 /* Page 7 for the descriptors is optional */
530 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
532 goto simple_populate;
534 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
535 /* add 1 for trailing '\0' we'll use */
536 buf = kzalloc(len + 1, GFP_KERNEL);
538 goto simple_populate;
539 result = ses_recv_diag(sdev, 7, buf, len);
545 addl_desc_ptr = NULL;
548 len = (desc_ptr[2] << 8) + desc_ptr[3];
549 /* skip past overall descriptor */
552 addl_desc_ptr = ses_dev->page10 + 8;
554 type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
556 for (i = 0; i < types; i++, type_ptr += 4) {
557 for (j = 0; j < type_ptr[1]; j++) {
559 struct enclosure_component *ecomp;
562 if (desc_ptr >= buf + page7_len) {
565 len = (desc_ptr[2] << 8) + desc_ptr[3];
567 /* Add trailing zero - pushes into
569 desc_ptr[len] = '\0';
573 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
574 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
576 ecomp = enclosure_component_register(edev,
581 if (!IS_ERR(ecomp) && addl_desc_ptr)
582 ses_process_descriptor(ecomp,
589 addl_desc_ptr += addl_desc_ptr[1] + 2;
596 /* see if there are any devices matching before
597 * we found the enclosure */
598 shost_for_each_device(tmp_sdev, sdev->host) {
599 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
601 ses_match_to_enclosure(edev, tmp_sdev);
607 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
613 kfree(ses_dev->page10);
614 kfree(ses_dev->page2);
615 kfree(ses_dev->page1);
619 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
623 static int ses_remove(struct device *dev)
628 static void ses_intf_remove(struct class_device *cdev,
629 struct class_interface *intf)
631 struct scsi_device *sdev = to_scsi_device(cdev->dev);
632 struct enclosure_device *edev;
633 struct ses_device *ses_dev;
635 if (!scsi_device_enclosure(sdev))
638 edev = enclosure_find(cdev->dev);
642 ses_dev = edev->scratch;
643 edev->scratch = NULL;
645 kfree(ses_dev->page10);
646 kfree(ses_dev->page1);
647 kfree(ses_dev->page2);
650 kfree(edev->component[0].scratch);
652 class_device_put(&edev->cdev);
653 enclosure_unregister(edev);
656 static struct class_interface ses_interface = {
658 .remove = ses_intf_remove,
661 static struct scsi_driver ses_template = {
662 .owner = THIS_MODULE,
666 .remove = ses_remove,
670 static int __init ses_init(void)
674 err = scsi_register_interface(&ses_interface);
678 err = scsi_register_driver(&ses_template.gendrv);
685 scsi_unregister_interface(&ses_interface);
689 static void __exit ses_exit(void)
691 scsi_unregister_driver(&ses_template.gendrv);
692 scsi_unregister_interface(&ses_interface);
695 module_init(ses_init);
696 module_exit(ses_exit);
698 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
700 MODULE_AUTHOR("James Bottomley");
701 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
702 MODULE_LICENSE("GPL v2");