Loading...
1/*
2 * SCSI Enclosure Services
3 *
4 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
5 *
6**-----------------------------------------------------------------------------
7**
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.
11**
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.
16**
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.
20**
21**-----------------------------------------------------------------------------
22*/
23
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>
29
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>
36
37struct ses_device {
38 unsigned char *page1;
39 unsigned char *page1_types;
40 unsigned char *page2;
41 unsigned char *page10;
42 short page1_len;
43 short page1_num_types;
44 short page2_len;
45 short page10_len;
46};
47
48struct ses_component {
49 u64 addr;
50 unsigned char *desc;
51};
52
53static int ses_probe(struct device *dev)
54{
55 struct scsi_device *sdev = to_scsi_device(dev);
56 int err = -ENODEV;
57
58 if (sdev->type != TYPE_ENCLOSURE)
59 goto out;
60
61 err = 0;
62 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
63
64 out:
65 return err;
66}
67
68#define SES_TIMEOUT (30 * HZ)
69#define SES_RETRIES 3
70
71static int ses_recv_diag(struct scsi_device *sdev, int page_code,
72 void *buf, int bufflen)
73{
74 unsigned char cmd[] = {
75 RECEIVE_DIAGNOSTIC,
76 1, /* Set PCV bit */
77 page_code,
78 bufflen >> 8,
79 bufflen & 0xff,
80 0
81 };
82
83 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
84 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
85}
86
87static int ses_send_diag(struct scsi_device *sdev, int page_code,
88 void *buf, int bufflen)
89{
90 u32 result;
91
92 unsigned char cmd[] = {
93 SEND_DIAGNOSTIC,
94 0x10, /* Set PF bit */
95 0,
96 bufflen >> 8,
97 bufflen & 0xff,
98 0
99 };
100
101 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
102 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
103 if (result)
104 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
105 result);
106 return result;
107}
108
109static int ses_set_page2_descriptor(struct enclosure_device *edev,
110 struct enclosure_component *ecomp,
111 unsigned char *desc)
112{
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;
118
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++) {
123 desc_ptr += 4;
124 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
125 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
126 continue;
127 if (count++ == descriptor) {
128 memcpy(desc_ptr, desc, 4);
129 /* set select */
130 desc_ptr[0] |= 0x80;
131 /* clear reserved, just in case */
132 desc_ptr[0] &= 0xf0;
133 }
134 }
135 }
136
137 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
138}
139
140static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
141 struct enclosure_component *ecomp)
142{
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;
148
149 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
150
151 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
152 for (j = 0; j < type_ptr[1]; j++) {
153 desc_ptr += 4;
154 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
155 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
156 continue;
157 if (count++ == descriptor)
158 return desc_ptr;
159 }
160 }
161 return NULL;
162}
163
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. */
168static void ses_get_fault(struct enclosure_device *edev,
169 struct enclosure_component *ecomp)
170{
171 unsigned char *desc;
172
173 desc = ses_get_page2_descriptor(edev, ecomp);
174 if (desc)
175 ecomp->fault = (desc[3] & 0x60) >> 4;
176}
177
178static int ses_set_fault(struct enclosure_device *edev,
179 struct enclosure_component *ecomp,
180 enum enclosure_component_setting val)
181{
182 unsigned char desc[4] = {0 };
183
184 switch (val) {
185 case ENCLOSURE_SETTING_DISABLED:
186 /* zero is disabled */
187 break;
188 case ENCLOSURE_SETTING_ENABLED:
189 desc[3] = 0x20;
190 break;
191 default:
192 /* SES doesn't do the SGPIO blink settings */
193 return -EINVAL;
194 }
195
196 return ses_set_page2_descriptor(edev, ecomp, desc);
197}
198
199static void ses_get_status(struct enclosure_device *edev,
200 struct enclosure_component *ecomp)
201{
202 unsigned char *desc;
203
204 desc = ses_get_page2_descriptor(edev, ecomp);
205 if (desc)
206 ecomp->status = (desc[0] & 0x0f);
207}
208
209static void ses_get_locate(struct enclosure_device *edev,
210 struct enclosure_component *ecomp)
211{
212 unsigned char *desc;
213
214 desc = ses_get_page2_descriptor(edev, ecomp);
215 if (desc)
216 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
217}
218
219static int ses_set_locate(struct enclosure_device *edev,
220 struct enclosure_component *ecomp,
221 enum enclosure_component_setting val)
222{
223 unsigned char desc[4] = {0 };
224
225 switch (val) {
226 case ENCLOSURE_SETTING_DISABLED:
227 /* zero is disabled */
228 break;
229 case ENCLOSURE_SETTING_ENABLED:
230 desc[2] = 0x02;
231 break;
232 default:
233 /* SES doesn't do the SGPIO blink settings */
234 return -EINVAL;
235 }
236 return ses_set_page2_descriptor(edev, ecomp, desc);
237}
238
239static int ses_set_active(struct enclosure_device *edev,
240 struct enclosure_component *ecomp,
241 enum enclosure_component_setting val)
242{
243 unsigned char desc[4] = {0 };
244
245 switch (val) {
246 case ENCLOSURE_SETTING_DISABLED:
247 /* zero is disabled */
248 ecomp->active = 0;
249 break;
250 case ENCLOSURE_SETTING_ENABLED:
251 desc[2] = 0x80;
252 ecomp->active = 1;
253 break;
254 default:
255 /* SES doesn't do the SGPIO blink settings */
256 return -EINVAL;
257 }
258 return ses_set_page2_descriptor(edev, ecomp, desc);
259}
260
261static struct enclosure_component_callbacks ses_enclosure_callbacks = {
262 .get_fault = ses_get_fault,
263 .set_fault = ses_set_fault,
264 .get_status = ses_get_status,
265 .get_locate = ses_get_locate,
266 .set_locate = ses_set_locate,
267 .set_active = ses_set_active,
268};
269
270struct ses_host_edev {
271 struct Scsi_Host *shost;
272 struct enclosure_device *edev;
273};
274
275#if 0
276int ses_match_host(struct enclosure_device *edev, void *data)
277{
278 struct ses_host_edev *sed = data;
279 struct scsi_device *sdev;
280
281 if (!scsi_is_sdev_device(edev->edev.parent))
282 return 0;
283
284 sdev = to_scsi_device(edev->edev.parent);
285
286 if (sdev->host != sed->shost)
287 return 0;
288
289 sed->edev = edev;
290 return 1;
291}
292#endif /* 0 */
293
294static void ses_process_descriptor(struct enclosure_component *ecomp,
295 unsigned char *desc)
296{
297 int eip = desc[0] & 0x10;
298 int invalid = desc[0] & 0x80;
299 enum scsi_protocol proto = desc[0] & 0x0f;
300 u64 addr = 0;
301 struct ses_component *scomp = ecomp->scratch;
302 unsigned char *d;
303
304 scomp->desc = desc;
305
306 if (invalid)
307 return;
308
309 switch (proto) {
310 case SCSI_PROTOCOL_SAS:
311 if (eip)
312 d = desc + 8;
313 else
314 d = desc + 4;
315 /* only take the phy0 addr */
316 addr = (u64)d[12] << 56 |
317 (u64)d[13] << 48 |
318 (u64)d[14] << 40 |
319 (u64)d[15] << 32 |
320 (u64)d[16] << 24 |
321 (u64)d[17] << 16 |
322 (u64)d[18] << 8 |
323 (u64)d[19];
324 break;
325 default:
326 /* FIXME: Need to add more protocols than just SAS */
327 break;
328 }
329 scomp->addr = addr;
330}
331
332struct efd {
333 u64 addr;
334 struct device *dev;
335};
336
337static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
338 void *data)
339{
340 struct efd *efd = data;
341 int i;
342 struct ses_component *scomp;
343
344 if (!edev->component[0].scratch)
345 return 0;
346
347 for (i = 0; i < edev->components; i++) {
348 scomp = edev->component[i].scratch;
349 if (scomp->addr != efd->addr)
350 continue;
351
352 enclosure_add_device(edev, i, efd->dev);
353 return 1;
354 }
355 return 0;
356}
357
358#define INIT_ALLOC_SIZE 32
359
360static void ses_enclosure_data_process(struct enclosure_device *edev,
361 struct scsi_device *sdev,
362 int create)
363{
364 u32 result;
365 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
366 int i, j, page7_len, len, components;
367 struct ses_device *ses_dev = edev->scratch;
368 int types = ses_dev->page1_num_types;
369 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
370
371 if (!hdr_buf)
372 goto simple_populate;
373
374 /* re-read page 10 */
375 if (ses_dev->page10)
376 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
377 /* Page 7 for the descriptors is optional */
378 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
379 if (result)
380 goto simple_populate;
381
382 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
383 /* add 1 for trailing '\0' we'll use */
384 buf = kzalloc(len + 1, GFP_KERNEL);
385 if (!buf)
386 goto simple_populate;
387 result = ses_recv_diag(sdev, 7, buf, len);
388 if (result) {
389 simple_populate:
390 kfree(buf);
391 buf = NULL;
392 desc_ptr = NULL;
393 len = 0;
394 page7_len = 0;
395 } else {
396 desc_ptr = buf + 8;
397 len = (desc_ptr[2] << 8) + desc_ptr[3];
398 /* skip past overall descriptor */
399 desc_ptr += len + 4;
400 }
401 if (ses_dev->page10)
402 addl_desc_ptr = ses_dev->page10 + 8;
403 type_ptr = ses_dev->page1_types;
404 components = 0;
405 for (i = 0; i < types; i++, type_ptr += 4) {
406 for (j = 0; j < type_ptr[1]; j++) {
407 char *name = NULL;
408 struct enclosure_component *ecomp;
409
410 if (desc_ptr) {
411 if (desc_ptr >= buf + page7_len) {
412 desc_ptr = NULL;
413 } else {
414 len = (desc_ptr[2] << 8) + desc_ptr[3];
415 desc_ptr += 4;
416 /* Add trailing zero - pushes into
417 * reserved space */
418 desc_ptr[len] = '\0';
419 name = desc_ptr;
420 }
421 }
422 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
423 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
424
425 if (create)
426 ecomp = enclosure_component_register(edev,
427 components++,
428 type_ptr[0],
429 name);
430 else
431 ecomp = &edev->component[components++];
432
433 if (!IS_ERR(ecomp) && addl_desc_ptr)
434 ses_process_descriptor(ecomp,
435 addl_desc_ptr);
436 }
437 if (desc_ptr)
438 desc_ptr += len;
439
440 if (addl_desc_ptr)
441 addl_desc_ptr += addl_desc_ptr[1] + 2;
442
443 }
444 }
445 kfree(buf);
446 kfree(hdr_buf);
447}
448
449static void ses_match_to_enclosure(struct enclosure_device *edev,
450 struct scsi_device *sdev)
451{
452 unsigned char *desc;
453 struct efd efd = {
454 .addr = 0,
455 };
456
457 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
458
459 if (!sdev->vpd_pg83_len)
460 return;
461
462 desc = sdev->vpd_pg83 + 4;
463 while (desc < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
464 enum scsi_protocol proto = desc[0] >> 4;
465 u8 code_set = desc[0] & 0x0f;
466 u8 piv = desc[1] & 0x80;
467 u8 assoc = (desc[1] & 0x30) >> 4;
468 u8 type = desc[1] & 0x0f;
469 u8 len = desc[3];
470
471 if (piv && code_set == 1 && assoc == 1
472 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
473 efd.addr = get_unaligned_be64(&desc[4]);
474
475 desc += len + 4;
476 }
477 if (efd.addr) {
478 efd.dev = &sdev->sdev_gendev;
479
480 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
481 }
482}
483
484static int ses_intf_add(struct device *cdev,
485 struct class_interface *intf)
486{
487 struct scsi_device *sdev = to_scsi_device(cdev->parent);
488 struct scsi_device *tmp_sdev;
489 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
490 struct ses_device *ses_dev;
491 u32 result;
492 int i, types, len, components = 0;
493 int err = -ENOMEM;
494 int num_enclosures;
495 struct enclosure_device *edev;
496 struct ses_component *scomp = NULL;
497
498 if (!scsi_device_enclosure(sdev)) {
499 /* not an enclosure, but might be in one */
500 struct enclosure_device *prev = NULL;
501
502 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
503 ses_match_to_enclosure(edev, sdev);
504 prev = edev;
505 }
506 return -ENODEV;
507 }
508
509 /* TYPE_ENCLOSURE prints a message in probe */
510 if (sdev->type != TYPE_ENCLOSURE)
511 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
512
513 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
514 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
515 if (!hdr_buf || !ses_dev)
516 goto err_init_free;
517
518 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
519 if (result)
520 goto recv_failed;
521
522 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
523 buf = kzalloc(len, GFP_KERNEL);
524 if (!buf)
525 goto err_free;
526
527 result = ses_recv_diag(sdev, 1, buf, len);
528 if (result)
529 goto recv_failed;
530
531 types = 0;
532
533 /* we always have one main enclosure and the rest are referred
534 * to as secondary subenclosures */
535 num_enclosures = buf[1] + 1;
536
537 /* begin at the enclosure descriptor */
538 type_ptr = buf + 8;
539 /* skip all the enclosure descriptors */
540 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
541 types += type_ptr[2];
542 type_ptr += type_ptr[3] + 4;
543 }
544
545 ses_dev->page1_types = type_ptr;
546 ses_dev->page1_num_types = types;
547
548 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
549 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
550 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
551 components += type_ptr[1];
552 }
553 ses_dev->page1 = buf;
554 ses_dev->page1_len = len;
555 buf = NULL;
556
557 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
558 if (result)
559 goto recv_failed;
560
561 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
562 buf = kzalloc(len, GFP_KERNEL);
563 if (!buf)
564 goto err_free;
565
566 /* make sure getting page 2 actually works */
567 result = ses_recv_diag(sdev, 2, buf, len);
568 if (result)
569 goto recv_failed;
570 ses_dev->page2 = buf;
571 ses_dev->page2_len = len;
572 buf = NULL;
573
574 /* The additional information page --- allows us
575 * to match up the devices */
576 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
577 if (!result) {
578
579 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
580 buf = kzalloc(len, GFP_KERNEL);
581 if (!buf)
582 goto err_free;
583
584 result = ses_recv_diag(sdev, 10, buf, len);
585 if (result)
586 goto recv_failed;
587 ses_dev->page10 = buf;
588 ses_dev->page10_len = len;
589 buf = NULL;
590 }
591 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
592 if (!scomp)
593 goto err_free;
594
595 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
596 components, &ses_enclosure_callbacks);
597 if (IS_ERR(edev)) {
598 err = PTR_ERR(edev);
599 goto err_free;
600 }
601
602 kfree(hdr_buf);
603
604 edev->scratch = ses_dev;
605 for (i = 0; i < components; i++)
606 edev->component[i].scratch = scomp + i;
607
608 ses_enclosure_data_process(edev, sdev, 1);
609
610 /* see if there are any devices matching before
611 * we found the enclosure */
612 shost_for_each_device(tmp_sdev, sdev->host) {
613 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
614 continue;
615 ses_match_to_enclosure(edev, tmp_sdev);
616 }
617
618 return 0;
619
620 recv_failed:
621 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
622 result);
623 err = -ENODEV;
624 err_free:
625 kfree(buf);
626 kfree(scomp);
627 kfree(ses_dev->page10);
628 kfree(ses_dev->page2);
629 kfree(ses_dev->page1);
630 err_init_free:
631 kfree(ses_dev);
632 kfree(hdr_buf);
633 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
634 return err;
635}
636
637static int ses_remove(struct device *dev)
638{
639 return 0;
640}
641
642static void ses_intf_remove_component(struct scsi_device *sdev)
643{
644 struct enclosure_device *edev, *prev = NULL;
645
646 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
647 prev = edev;
648 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
649 break;
650 }
651 if (edev)
652 put_device(&edev->edev);
653}
654
655static void ses_intf_remove_enclosure(struct scsi_device *sdev)
656{
657 struct enclosure_device *edev;
658 struct ses_device *ses_dev;
659
660 /* exact match to this enclosure */
661 edev = enclosure_find(&sdev->sdev_gendev, NULL);
662 if (!edev)
663 return;
664
665 ses_dev = edev->scratch;
666 edev->scratch = NULL;
667
668 kfree(ses_dev->page10);
669 kfree(ses_dev->page1);
670 kfree(ses_dev->page2);
671 kfree(ses_dev);
672
673 kfree(edev->component[0].scratch);
674
675 put_device(&edev->edev);
676 enclosure_unregister(edev);
677}
678
679static void ses_intf_remove(struct device *cdev,
680 struct class_interface *intf)
681{
682 struct scsi_device *sdev = to_scsi_device(cdev->parent);
683
684 if (!scsi_device_enclosure(sdev))
685 ses_intf_remove_component(sdev);
686 else
687 ses_intf_remove_enclosure(sdev);
688}
689
690static struct class_interface ses_interface = {
691 .add_dev = ses_intf_add,
692 .remove_dev = ses_intf_remove,
693};
694
695static struct scsi_driver ses_template = {
696 .owner = THIS_MODULE,
697 .gendrv = {
698 .name = "ses",
699 .probe = ses_probe,
700 .remove = ses_remove,
701 },
702};
703
704static int __init ses_init(void)
705{
706 int err;
707
708 err = scsi_register_interface(&ses_interface);
709 if (err)
710 return err;
711
712 err = scsi_register_driver(&ses_template.gendrv);
713 if (err)
714 goto out_unreg;
715
716 return 0;
717
718 out_unreg:
719 scsi_unregister_interface(&ses_interface);
720 return err;
721}
722
723static void __exit ses_exit(void)
724{
725 scsi_unregister_driver(&ses_template.gendrv);
726 scsi_unregister_interface(&ses_interface);
727}
728
729module_init(ses_init);
730module_exit(ses_exit);
731
732MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
733
734MODULE_AUTHOR("James Bottomley");
735MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
736MODULE_LICENSE("GPL v2");
1/*
2 * SCSI Enclosure Services
3 *
4 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
5 *
6**-----------------------------------------------------------------------------
7**
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.
11**
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.
16**
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.
20**
21**-----------------------------------------------------------------------------
22*/
23
24#include <linux/slab.h>
25#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/enclosure.h>
28
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>
35
36struct ses_device {
37 unsigned char *page1;
38 unsigned char *page1_types;
39 unsigned char *page2;
40 unsigned char *page10;
41 short page1_len;
42 short page1_num_types;
43 short page2_len;
44 short page10_len;
45};
46
47struct ses_component {
48 u64 addr;
49 unsigned char *desc;
50};
51
52static int ses_probe(struct device *dev)
53{
54 struct scsi_device *sdev = to_scsi_device(dev);
55 int err = -ENODEV;
56
57 if (sdev->type != TYPE_ENCLOSURE)
58 goto out;
59
60 err = 0;
61 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
62
63 out:
64 return err;
65}
66
67#define SES_TIMEOUT (30 * HZ)
68#define SES_RETRIES 3
69
70static int ses_recv_diag(struct scsi_device *sdev, int page_code,
71 void *buf, int bufflen)
72{
73 unsigned char cmd[] = {
74 RECEIVE_DIAGNOSTIC,
75 1, /* Set PCV bit */
76 page_code,
77 bufflen >> 8,
78 bufflen & 0xff,
79 0
80 };
81
82 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
83 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
84}
85
86static int ses_send_diag(struct scsi_device *sdev, int page_code,
87 void *buf, int bufflen)
88{
89 u32 result;
90
91 unsigned char cmd[] = {
92 SEND_DIAGNOSTIC,
93 0x10, /* Set PF bit */
94 0,
95 bufflen >> 8,
96 bufflen & 0xff,
97 0
98 };
99
100 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
101 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
102 if (result)
103 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
104 result);
105 return result;
106}
107
108static int ses_set_page2_descriptor(struct enclosure_device *edev,
109 struct enclosure_component *ecomp,
110 unsigned char *desc)
111{
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;
117
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++) {
122 desc_ptr += 4;
123 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
124 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
125 continue;
126 if (count++ == descriptor) {
127 memcpy(desc_ptr, desc, 4);
128 /* set select */
129 desc_ptr[0] |= 0x80;
130 /* clear reserved, just in case */
131 desc_ptr[0] &= 0xf0;
132 }
133 }
134 }
135
136 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
137}
138
139static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
140 struct enclosure_component *ecomp)
141{
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;
147
148 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
149
150 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
151 for (j = 0; j < type_ptr[1]; j++) {
152 desc_ptr += 4;
153 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
154 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
155 continue;
156 if (count++ == descriptor)
157 return desc_ptr;
158 }
159 }
160 return NULL;
161}
162
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. */
167static void ses_get_fault(struct enclosure_device *edev,
168 struct enclosure_component *ecomp)
169{
170 unsigned char *desc;
171
172 desc = ses_get_page2_descriptor(edev, ecomp);
173 if (desc)
174 ecomp->fault = (desc[3] & 0x60) >> 4;
175}
176
177static int ses_set_fault(struct enclosure_device *edev,
178 struct enclosure_component *ecomp,
179 enum enclosure_component_setting val)
180{
181 unsigned char desc[4] = {0 };
182
183 switch (val) {
184 case ENCLOSURE_SETTING_DISABLED:
185 /* zero is disabled */
186 break;
187 case ENCLOSURE_SETTING_ENABLED:
188 desc[3] = 0x20;
189 break;
190 default:
191 /* SES doesn't do the SGPIO blink settings */
192 return -EINVAL;
193 }
194
195 return ses_set_page2_descriptor(edev, ecomp, desc);
196}
197
198static void ses_get_status(struct enclosure_device *edev,
199 struct enclosure_component *ecomp)
200{
201 unsigned char *desc;
202
203 desc = ses_get_page2_descriptor(edev, ecomp);
204 if (desc)
205 ecomp->status = (desc[0] & 0x0f);
206}
207
208static void ses_get_locate(struct enclosure_device *edev,
209 struct enclosure_component *ecomp)
210{
211 unsigned char *desc;
212
213 desc = ses_get_page2_descriptor(edev, ecomp);
214 if (desc)
215 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
216}
217
218static int ses_set_locate(struct enclosure_device *edev,
219 struct enclosure_component *ecomp,
220 enum enclosure_component_setting val)
221{
222 unsigned char desc[4] = {0 };
223
224 switch (val) {
225 case ENCLOSURE_SETTING_DISABLED:
226 /* zero is disabled */
227 break;
228 case ENCLOSURE_SETTING_ENABLED:
229 desc[2] = 0x02;
230 break;
231 default:
232 /* SES doesn't do the SGPIO blink settings */
233 return -EINVAL;
234 }
235 return ses_set_page2_descriptor(edev, ecomp, desc);
236}
237
238static int ses_set_active(struct enclosure_device *edev,
239 struct enclosure_component *ecomp,
240 enum enclosure_component_setting val)
241{
242 unsigned char desc[4] = {0 };
243
244 switch (val) {
245 case ENCLOSURE_SETTING_DISABLED:
246 /* zero is disabled */
247 ecomp->active = 0;
248 break;
249 case ENCLOSURE_SETTING_ENABLED:
250 desc[2] = 0x80;
251 ecomp->active = 1;
252 break;
253 default:
254 /* SES doesn't do the SGPIO blink settings */
255 return -EINVAL;
256 }
257 return ses_set_page2_descriptor(edev, ecomp, desc);
258}
259
260static 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,
267};
268
269struct ses_host_edev {
270 struct Scsi_Host *shost;
271 struct enclosure_device *edev;
272};
273
274#if 0
275int ses_match_host(struct enclosure_device *edev, void *data)
276{
277 struct ses_host_edev *sed = data;
278 struct scsi_device *sdev;
279
280 if (!scsi_is_sdev_device(edev->edev.parent))
281 return 0;
282
283 sdev = to_scsi_device(edev->edev.parent);
284
285 if (sdev->host != sed->shost)
286 return 0;
287
288 sed->edev = edev;
289 return 1;
290}
291#endif /* 0 */
292
293static void ses_process_descriptor(struct enclosure_component *ecomp,
294 unsigned char *desc)
295{
296 int eip = desc[0] & 0x10;
297 int invalid = desc[0] & 0x80;
298 enum scsi_protocol proto = desc[0] & 0x0f;
299 u64 addr = 0;
300 struct ses_component *scomp = ecomp->scratch;
301 unsigned char *d;
302
303 scomp->desc = desc;
304
305 if (invalid)
306 return;
307
308 switch (proto) {
309 case SCSI_PROTOCOL_SAS:
310 if (eip)
311 d = desc + 8;
312 else
313 d = desc + 4;
314 /* only take the phy0 addr */
315 addr = (u64)d[12] << 56 |
316 (u64)d[13] << 48 |
317 (u64)d[14] << 40 |
318 (u64)d[15] << 32 |
319 (u64)d[16] << 24 |
320 (u64)d[17] << 16 |
321 (u64)d[18] << 8 |
322 (u64)d[19];
323 break;
324 default:
325 /* FIXME: Need to add more protocols than just SAS */
326 break;
327 }
328 scomp->addr = addr;
329}
330
331struct efd {
332 u64 addr;
333 struct device *dev;
334};
335
336static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
337 void *data)
338{
339 struct efd *efd = data;
340 int i;
341 struct ses_component *scomp;
342
343 if (!edev->component[0].scratch)
344 return 0;
345
346 for (i = 0; i < edev->components; i++) {
347 scomp = edev->component[i].scratch;
348 if (scomp->addr != efd->addr)
349 continue;
350
351 enclosure_add_device(edev, i, efd->dev);
352 return 1;
353 }
354 return 0;
355}
356
357#define INIT_ALLOC_SIZE 32
358
359static void ses_enclosure_data_process(struct enclosure_device *edev,
360 struct scsi_device *sdev,
361 int create)
362{
363 u32 result;
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);
369
370 if (!hdr_buf)
371 goto simple_populate;
372
373 /* re-read page 10 */
374 if (ses_dev->page10)
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);
378 if (result)
379 goto simple_populate;
380
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);
384 if (!buf)
385 goto simple_populate;
386 result = ses_recv_diag(sdev, 7, buf, len);
387 if (result) {
388 simple_populate:
389 kfree(buf);
390 buf = NULL;
391 desc_ptr = NULL;
392 len = 0;
393 page7_len = 0;
394 } else {
395 desc_ptr = buf + 8;
396 len = (desc_ptr[2] << 8) + desc_ptr[3];
397 /* skip past overall descriptor */
398 desc_ptr += len + 4;
399 }
400 if (ses_dev->page10)
401 addl_desc_ptr = ses_dev->page10 + 8;
402 type_ptr = ses_dev->page1_types;
403 components = 0;
404 for (i = 0; i < types; i++, type_ptr += 4) {
405 for (j = 0; j < type_ptr[1]; j++) {
406 char *name = NULL;
407 struct enclosure_component *ecomp;
408
409 if (desc_ptr) {
410 if (desc_ptr >= buf + page7_len) {
411 desc_ptr = NULL;
412 } else {
413 len = (desc_ptr[2] << 8) + desc_ptr[3];
414 desc_ptr += 4;
415 /* Add trailing zero - pushes into
416 * reserved space */
417 desc_ptr[len] = '\0';
418 name = desc_ptr;
419 }
420 }
421 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
422 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
423
424 if (create)
425 ecomp = enclosure_component_register(edev,
426 components++,
427 type_ptr[0],
428 name);
429 else
430 ecomp = &edev->component[components++];
431
432 if (!IS_ERR(ecomp) && addl_desc_ptr)
433 ses_process_descriptor(ecomp,
434 addl_desc_ptr);
435 }
436 if (desc_ptr)
437 desc_ptr += len;
438
439 if (addl_desc_ptr)
440 addl_desc_ptr += addl_desc_ptr[1] + 2;
441
442 }
443 }
444 kfree(buf);
445 kfree(hdr_buf);
446}
447
448static void ses_match_to_enclosure(struct enclosure_device *edev,
449 struct scsi_device *sdev)
450{
451 unsigned char *buf;
452 unsigned char *desc;
453 unsigned int vpd_len;
454 struct efd efd = {
455 .addr = 0,
456 };
457
458 buf = kmalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
459 if (!buf || scsi_get_vpd_page(sdev, 0x83, buf, INIT_ALLOC_SIZE))
460 goto free;
461
462 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
463
464 vpd_len = ((buf[2] << 8) | buf[3]) + 4;
465 kfree(buf);
466 buf = kmalloc(vpd_len, GFP_KERNEL);
467 if (!buf ||scsi_get_vpd_page(sdev, 0x83, buf, vpd_len))
468 goto free;
469
470 desc = buf + 4;
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;
477 u8 len = desc[3];
478
479 if (piv && code_set == 1 && assoc == 1
480 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
481 efd.addr = (u64)desc[4] << 56 |
482 (u64)desc[5] << 48 |
483 (u64)desc[6] << 40 |
484 (u64)desc[7] << 32 |
485 (u64)desc[8] << 24 |
486 (u64)desc[9] << 16 |
487 (u64)desc[10] << 8 |
488 (u64)desc[11];
489
490 desc += len + 4;
491 }
492 if (!efd.addr)
493 goto free;
494
495 efd.dev = &sdev->sdev_gendev;
496
497 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
498 free:
499 kfree(buf);
500}
501
502static int ses_intf_add(struct device *cdev,
503 struct class_interface *intf)
504{
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;
509 u32 result;
510 int i, types, len, components = 0;
511 int err = -ENOMEM;
512 int num_enclosures;
513 struct enclosure_device *edev;
514 struct ses_component *scomp = NULL;
515
516 if (!scsi_device_enclosure(sdev)) {
517 /* not an enclosure, but might be in one */
518 struct enclosure_device *prev = NULL;
519
520 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
521 ses_match_to_enclosure(edev, sdev);
522 prev = edev;
523 }
524 return -ENODEV;
525 }
526
527 /* TYPE_ENCLOSURE prints a message in probe */
528 if (sdev->type != TYPE_ENCLOSURE)
529 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
530
531 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
532 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
533 if (!hdr_buf || !ses_dev)
534 goto err_init_free;
535
536 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
537 if (result)
538 goto recv_failed;
539
540 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
541 buf = kzalloc(len, GFP_KERNEL);
542 if (!buf)
543 goto err_free;
544
545 result = ses_recv_diag(sdev, 1, buf, len);
546 if (result)
547 goto recv_failed;
548
549 types = 0;
550
551 /* we always have one main enclosure and the rest are referred
552 * to as secondary subenclosures */
553 num_enclosures = buf[1] + 1;
554
555 /* begin at the enclosure descriptor */
556 type_ptr = buf + 8;
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;
561 }
562
563 ses_dev->page1_types = type_ptr;
564 ses_dev->page1_num_types = types;
565
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];
570 }
571 ses_dev->page1 = buf;
572 ses_dev->page1_len = len;
573 buf = NULL;
574
575 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
576 if (result)
577 goto recv_failed;
578
579 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
580 buf = kzalloc(len, GFP_KERNEL);
581 if (!buf)
582 goto err_free;
583
584 /* make sure getting page 2 actually works */
585 result = ses_recv_diag(sdev, 2, buf, len);
586 if (result)
587 goto recv_failed;
588 ses_dev->page2 = buf;
589 ses_dev->page2_len = len;
590 buf = NULL;
591
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);
595 if (!result) {
596
597 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
598 buf = kzalloc(len, GFP_KERNEL);
599 if (!buf)
600 goto err_free;
601
602 result = ses_recv_diag(sdev, 10, buf, len);
603 if (result)
604 goto recv_failed;
605 ses_dev->page10 = buf;
606 ses_dev->page10_len = len;
607 buf = NULL;
608 }
609 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
610 if (!scomp)
611 goto err_free;
612
613 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
614 components, &ses_enclosure_callbacks);
615 if (IS_ERR(edev)) {
616 err = PTR_ERR(edev);
617 goto err_free;
618 }
619
620 kfree(hdr_buf);
621
622 edev->scratch = ses_dev;
623 for (i = 0; i < components; i++)
624 edev->component[i].scratch = scomp + i;
625
626 ses_enclosure_data_process(edev, sdev, 1);
627
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))
632 continue;
633 ses_match_to_enclosure(edev, tmp_sdev);
634 }
635
636 return 0;
637
638 recv_failed:
639 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
640 result);
641 err = -ENODEV;
642 err_free:
643 kfree(buf);
644 kfree(scomp);
645 kfree(ses_dev->page10);
646 kfree(ses_dev->page2);
647 kfree(ses_dev->page1);
648 err_init_free:
649 kfree(ses_dev);
650 kfree(hdr_buf);
651 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
652 return err;
653}
654
655static int ses_remove(struct device *dev)
656{
657 return 0;
658}
659
660static void ses_intf_remove_component(struct scsi_device *sdev)
661{
662 struct enclosure_device *edev, *prev = NULL;
663
664 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
665 prev = edev;
666 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
667 break;
668 }
669 if (edev)
670 put_device(&edev->edev);
671}
672
673static void ses_intf_remove_enclosure(struct scsi_device *sdev)
674{
675 struct enclosure_device *edev;
676 struct ses_device *ses_dev;
677
678 /* exact match to this enclosure */
679 edev = enclosure_find(&sdev->sdev_gendev, NULL);
680 if (!edev)
681 return;
682
683 ses_dev = edev->scratch;
684 edev->scratch = NULL;
685
686 kfree(ses_dev->page10);
687 kfree(ses_dev->page1);
688 kfree(ses_dev->page2);
689 kfree(ses_dev);
690
691 kfree(edev->component[0].scratch);
692
693 put_device(&edev->edev);
694 enclosure_unregister(edev);
695}
696
697static void ses_intf_remove(struct device *cdev,
698 struct class_interface *intf)
699{
700 struct scsi_device *sdev = to_scsi_device(cdev->parent);
701
702 if (!scsi_device_enclosure(sdev))
703 ses_intf_remove_component(sdev);
704 else
705 ses_intf_remove_enclosure(sdev);
706}
707
708static struct class_interface ses_interface = {
709 .add_dev = ses_intf_add,
710 .remove_dev = ses_intf_remove,
711};
712
713static struct scsi_driver ses_template = {
714 .owner = THIS_MODULE,
715 .gendrv = {
716 .name = "ses",
717 .probe = ses_probe,
718 .remove = ses_remove,
719 },
720};
721
722static int __init ses_init(void)
723{
724 int err;
725
726 err = scsi_register_interface(&ses_interface);
727 if (err)
728 return err;
729
730 err = scsi_register_driver(&ses_template.gendrv);
731 if (err)
732 goto out_unreg;
733
734 return 0;
735
736 out_unreg:
737 scsi_unregister_interface(&ses_interface);
738 return err;
739}
740
741static void __exit ses_exit(void)
742{
743 scsi_unregister_driver(&ses_template.gendrv);
744 scsi_unregister_interface(&ses_interface);
745}
746
747module_init(ses_init);
748module_exit(ses_exit);
749
750MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
751
752MODULE_AUTHOR("James Bottomley");
753MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
754MODULE_LICENSE("GPL v2");