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
37#include <scsi/scsi_transport_sas.h>
38
39struct ses_device {
40 unsigned char *page1;
41 unsigned char *page1_types;
42 unsigned char *page2;
43 unsigned char *page10;
44 short page1_len;
45 short page1_num_types;
46 short page2_len;
47 short page10_len;
48};
49
50struct ses_component {
51 u64 addr;
52};
53
54static int ses_probe(struct device *dev)
55{
56 struct scsi_device *sdev = to_scsi_device(dev);
57 int err = -ENODEV;
58
59 if (sdev->type != TYPE_ENCLOSURE)
60 goto out;
61
62 err = 0;
63 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
64
65 out:
66 return err;
67}
68
69#define SES_TIMEOUT (30 * HZ)
70#define SES_RETRIES 3
71
72static void init_device_slot_control(unsigned char *dest_desc,
73 struct enclosure_component *ecomp,
74 unsigned char *status)
75{
76 memcpy(dest_desc, status, 4);
77 dest_desc[0] = 0;
78 /* only clear byte 1 for ENCLOSURE_COMPONENT_DEVICE */
79 if (ecomp->type == ENCLOSURE_COMPONENT_DEVICE)
80 dest_desc[1] = 0;
81 dest_desc[2] &= 0xde;
82 dest_desc[3] &= 0x3c;
83}
84
85
86static int ses_recv_diag(struct scsi_device *sdev, int page_code,
87 void *buf, int bufflen)
88{
89 int ret;
90 unsigned char cmd[] = {
91 RECEIVE_DIAGNOSTIC,
92 1, /* Set PCV bit */
93 page_code,
94 bufflen >> 8,
95 bufflen & 0xff,
96 0
97 };
98 unsigned char recv_page_code;
99
100 ret = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
101 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
102 if (unlikely(!ret))
103 return ret;
104
105 recv_page_code = ((unsigned char *)buf)[0];
106
107 if (likely(recv_page_code == page_code))
108 return ret;
109
110 /* successful diagnostic but wrong page code. This happens to some
111 * USB devices, just print a message and pretend there was an error */
112
113 sdev_printk(KERN_ERR, sdev,
114 "Wrong diagnostic page; asked for %d got %u\n",
115 page_code, recv_page_code);
116
117 return -EINVAL;
118}
119
120static int ses_send_diag(struct scsi_device *sdev, int page_code,
121 void *buf, int bufflen)
122{
123 u32 result;
124
125 unsigned char cmd[] = {
126 SEND_DIAGNOSTIC,
127 0x10, /* Set PF bit */
128 0,
129 bufflen >> 8,
130 bufflen & 0xff,
131 0
132 };
133
134 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
135 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
136 if (result)
137 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
138 result);
139 return result;
140}
141
142static int ses_set_page2_descriptor(struct enclosure_device *edev,
143 struct enclosure_component *ecomp,
144 unsigned char *desc)
145{
146 int i, j, count = 0, descriptor = ecomp->number;
147 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
148 struct ses_device *ses_dev = edev->scratch;
149 unsigned char *type_ptr = ses_dev->page1_types;
150 unsigned char *desc_ptr = ses_dev->page2 + 8;
151
152 /* Clear everything */
153 memset(desc_ptr, 0, ses_dev->page2_len - 8);
154 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
155 for (j = 0; j < type_ptr[1]; j++) {
156 desc_ptr += 4;
157 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
158 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
159 continue;
160 if (count++ == descriptor) {
161 memcpy(desc_ptr, desc, 4);
162 /* set select */
163 desc_ptr[0] |= 0x80;
164 /* clear reserved, just in case */
165 desc_ptr[0] &= 0xf0;
166 }
167 }
168 }
169
170 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
171}
172
173static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
174 struct enclosure_component *ecomp)
175{
176 int i, j, count = 0, descriptor = ecomp->number;
177 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
178 struct ses_device *ses_dev = edev->scratch;
179 unsigned char *type_ptr = ses_dev->page1_types;
180 unsigned char *desc_ptr = ses_dev->page2 + 8;
181
182 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
183
184 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
185 for (j = 0; j < type_ptr[1]; j++) {
186 desc_ptr += 4;
187 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
188 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
189 continue;
190 if (count++ == descriptor)
191 return desc_ptr;
192 }
193 }
194 return NULL;
195}
196
197/* For device slot and array device slot elements, byte 3 bit 6
198 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
199 * code stands these bits are shifted 4 positions right so in
200 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
201static void ses_get_fault(struct enclosure_device *edev,
202 struct enclosure_component *ecomp)
203{
204 unsigned char *desc;
205
206 desc = ses_get_page2_descriptor(edev, ecomp);
207 if (desc)
208 ecomp->fault = (desc[3] & 0x60) >> 4;
209}
210
211static int ses_set_fault(struct enclosure_device *edev,
212 struct enclosure_component *ecomp,
213 enum enclosure_component_setting val)
214{
215 unsigned char desc[4];
216 unsigned char *desc_ptr;
217
218 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
219
220 if (!desc_ptr)
221 return -EIO;
222
223 init_device_slot_control(desc, ecomp, desc_ptr);
224
225 switch (val) {
226 case ENCLOSURE_SETTING_DISABLED:
227 desc[3] &= 0xdf;
228 break;
229 case ENCLOSURE_SETTING_ENABLED:
230 desc[3] |= 0x20;
231 break;
232 default:
233 /* SES doesn't do the SGPIO blink settings */
234 return -EINVAL;
235 }
236
237 return ses_set_page2_descriptor(edev, ecomp, desc);
238}
239
240static void ses_get_status(struct enclosure_device *edev,
241 struct enclosure_component *ecomp)
242{
243 unsigned char *desc;
244
245 desc = ses_get_page2_descriptor(edev, ecomp);
246 if (desc)
247 ecomp->status = (desc[0] & 0x0f);
248}
249
250static void ses_get_locate(struct enclosure_device *edev,
251 struct enclosure_component *ecomp)
252{
253 unsigned char *desc;
254
255 desc = ses_get_page2_descriptor(edev, ecomp);
256 if (desc)
257 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
258}
259
260static int ses_set_locate(struct enclosure_device *edev,
261 struct enclosure_component *ecomp,
262 enum enclosure_component_setting val)
263{
264 unsigned char desc[4];
265 unsigned char *desc_ptr;
266
267 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
268
269 if (!desc_ptr)
270 return -EIO;
271
272 init_device_slot_control(desc, ecomp, desc_ptr);
273
274 switch (val) {
275 case ENCLOSURE_SETTING_DISABLED:
276 desc[2] &= 0xfd;
277 break;
278 case ENCLOSURE_SETTING_ENABLED:
279 desc[2] |= 0x02;
280 break;
281 default:
282 /* SES doesn't do the SGPIO blink settings */
283 return -EINVAL;
284 }
285 return ses_set_page2_descriptor(edev, ecomp, desc);
286}
287
288static int ses_set_active(struct enclosure_device *edev,
289 struct enclosure_component *ecomp,
290 enum enclosure_component_setting val)
291{
292 unsigned char desc[4];
293 unsigned char *desc_ptr;
294
295 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
296
297 if (!desc_ptr)
298 return -EIO;
299
300 init_device_slot_control(desc, ecomp, desc_ptr);
301
302 switch (val) {
303 case ENCLOSURE_SETTING_DISABLED:
304 desc[2] &= 0x7f;
305 ecomp->active = 0;
306 break;
307 case ENCLOSURE_SETTING_ENABLED:
308 desc[2] |= 0x80;
309 ecomp->active = 1;
310 break;
311 default:
312 /* SES doesn't do the SGPIO blink settings */
313 return -EINVAL;
314 }
315 return ses_set_page2_descriptor(edev, ecomp, desc);
316}
317
318static int ses_show_id(struct enclosure_device *edev, char *buf)
319{
320 struct ses_device *ses_dev = edev->scratch;
321 unsigned long long id = get_unaligned_be64(ses_dev->page1+8+4);
322
323 return sprintf(buf, "%#llx\n", id);
324}
325
326static void ses_get_power_status(struct enclosure_device *edev,
327 struct enclosure_component *ecomp)
328{
329 unsigned char *desc;
330
331 desc = ses_get_page2_descriptor(edev, ecomp);
332 if (desc)
333 ecomp->power_status = (desc[3] & 0x10) ? 0 : 1;
334}
335
336static int ses_set_power_status(struct enclosure_device *edev,
337 struct enclosure_component *ecomp,
338 int val)
339{
340 unsigned char desc[4];
341 unsigned char *desc_ptr;
342
343 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
344
345 if (!desc_ptr)
346 return -EIO;
347
348 init_device_slot_control(desc, ecomp, desc_ptr);
349
350 switch (val) {
351 /* power = 1 is device_off = 0 and vice versa */
352 case 0:
353 desc[3] |= 0x10;
354 break;
355 case 1:
356 desc[3] &= 0xef;
357 break;
358 default:
359 return -EINVAL;
360 }
361 ecomp->power_status = val;
362 return ses_set_page2_descriptor(edev, ecomp, desc);
363}
364
365static struct enclosure_component_callbacks ses_enclosure_callbacks = {
366 .get_fault = ses_get_fault,
367 .set_fault = ses_set_fault,
368 .get_status = ses_get_status,
369 .get_locate = ses_get_locate,
370 .set_locate = ses_set_locate,
371 .get_power_status = ses_get_power_status,
372 .set_power_status = ses_set_power_status,
373 .set_active = ses_set_active,
374 .show_id = ses_show_id,
375};
376
377struct ses_host_edev {
378 struct Scsi_Host *shost;
379 struct enclosure_device *edev;
380};
381
382#if 0
383int ses_match_host(struct enclosure_device *edev, void *data)
384{
385 struct ses_host_edev *sed = data;
386 struct scsi_device *sdev;
387
388 if (!scsi_is_sdev_device(edev->edev.parent))
389 return 0;
390
391 sdev = to_scsi_device(edev->edev.parent);
392
393 if (sdev->host != sed->shost)
394 return 0;
395
396 sed->edev = edev;
397 return 1;
398}
399#endif /* 0 */
400
401static void ses_process_descriptor(struct enclosure_component *ecomp,
402 unsigned char *desc)
403{
404 int eip = desc[0] & 0x10;
405 int invalid = desc[0] & 0x80;
406 enum scsi_protocol proto = desc[0] & 0x0f;
407 u64 addr = 0;
408 int slot = -1;
409 struct ses_component *scomp = ecomp->scratch;
410 unsigned char *d;
411
412 if (invalid)
413 return;
414
415 switch (proto) {
416 case SCSI_PROTOCOL_FCP:
417 if (eip) {
418 d = desc + 4;
419 slot = d[3];
420 }
421 break;
422 case SCSI_PROTOCOL_SAS:
423 if (eip) {
424 d = desc + 4;
425 slot = d[3];
426 d = desc + 8;
427 } else
428 d = desc + 4;
429 /* only take the phy0 addr */
430 addr = (u64)d[12] << 56 |
431 (u64)d[13] << 48 |
432 (u64)d[14] << 40 |
433 (u64)d[15] << 32 |
434 (u64)d[16] << 24 |
435 (u64)d[17] << 16 |
436 (u64)d[18] << 8 |
437 (u64)d[19];
438 break;
439 default:
440 /* FIXME: Need to add more protocols than just SAS */
441 break;
442 }
443 ecomp->slot = slot;
444 scomp->addr = addr;
445}
446
447struct efd {
448 u64 addr;
449 struct device *dev;
450};
451
452static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
453 void *data)
454{
455 struct efd *efd = data;
456 int i;
457 struct ses_component *scomp;
458
459 if (!edev->component[0].scratch)
460 return 0;
461
462 for (i = 0; i < edev->components; i++) {
463 scomp = edev->component[i].scratch;
464 if (scomp->addr != efd->addr)
465 continue;
466
467 if (enclosure_add_device(edev, i, efd->dev) == 0)
468 kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
469 return 1;
470 }
471 return 0;
472}
473
474#define INIT_ALLOC_SIZE 32
475
476static void ses_enclosure_data_process(struct enclosure_device *edev,
477 struct scsi_device *sdev,
478 int create)
479{
480 u32 result;
481 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
482 int i, j, page7_len, len, components;
483 struct ses_device *ses_dev = edev->scratch;
484 int types = ses_dev->page1_num_types;
485 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
486
487 if (!hdr_buf)
488 goto simple_populate;
489
490 /* re-read page 10 */
491 if (ses_dev->page10)
492 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
493 /* Page 7 for the descriptors is optional */
494 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
495 if (result)
496 goto simple_populate;
497
498 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
499 /* add 1 for trailing '\0' we'll use */
500 buf = kzalloc(len + 1, GFP_KERNEL);
501 if (!buf)
502 goto simple_populate;
503 result = ses_recv_diag(sdev, 7, buf, len);
504 if (result) {
505 simple_populate:
506 kfree(buf);
507 buf = NULL;
508 desc_ptr = NULL;
509 len = 0;
510 page7_len = 0;
511 } else {
512 desc_ptr = buf + 8;
513 len = (desc_ptr[2] << 8) + desc_ptr[3];
514 /* skip past overall descriptor */
515 desc_ptr += len + 4;
516 }
517 if (ses_dev->page10)
518 addl_desc_ptr = ses_dev->page10 + 8;
519 type_ptr = ses_dev->page1_types;
520 components = 0;
521 for (i = 0; i < types; i++, type_ptr += 4) {
522 for (j = 0; j < type_ptr[1]; j++) {
523 char *name = NULL;
524 struct enclosure_component *ecomp;
525
526 if (desc_ptr) {
527 if (desc_ptr >= buf + page7_len) {
528 desc_ptr = NULL;
529 } else {
530 len = (desc_ptr[2] << 8) + desc_ptr[3];
531 desc_ptr += 4;
532 /* Add trailing zero - pushes into
533 * reserved space */
534 desc_ptr[len] = '\0';
535 name = desc_ptr;
536 }
537 }
538 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
539 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
540
541 if (create)
542 ecomp = enclosure_component_alloc(
543 edev,
544 components++,
545 type_ptr[0],
546 name);
547 else
548 ecomp = &edev->component[components++];
549
550 if (!IS_ERR(ecomp)) {
551 ses_get_power_status(edev, ecomp);
552 if (addl_desc_ptr)
553 ses_process_descriptor(
554 ecomp,
555 addl_desc_ptr);
556 if (create)
557 enclosure_component_register(
558 ecomp);
559 }
560 }
561 if (desc_ptr)
562 desc_ptr += len;
563
564 if (addl_desc_ptr &&
565 /* only find additional descriptions for specific devices */
566 (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
567 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
568 type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
569 /* these elements are optional */
570 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
571 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
572 type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS))
573 addl_desc_ptr += addl_desc_ptr[1] + 2;
574
575 }
576 }
577 kfree(buf);
578 kfree(hdr_buf);
579}
580
581static void ses_match_to_enclosure(struct enclosure_device *edev,
582 struct scsi_device *sdev)
583{
584 struct efd efd = {
585 .addr = 0,
586 };
587
588 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
589
590 if (is_sas_attached(sdev))
591 efd.addr = sas_get_address(sdev);
592
593 if (efd.addr) {
594 efd.dev = &sdev->sdev_gendev;
595
596 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
597 }
598}
599
600static int ses_intf_add(struct device *cdev,
601 struct class_interface *intf)
602{
603 struct scsi_device *sdev = to_scsi_device(cdev->parent);
604 struct scsi_device *tmp_sdev;
605 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
606 struct ses_device *ses_dev;
607 u32 result;
608 int i, types, len, components = 0;
609 int err = -ENOMEM;
610 int num_enclosures;
611 struct enclosure_device *edev;
612 struct ses_component *scomp = NULL;
613
614 if (!scsi_device_enclosure(sdev)) {
615 /* not an enclosure, but might be in one */
616 struct enclosure_device *prev = NULL;
617
618 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
619 ses_match_to_enclosure(edev, sdev);
620 prev = edev;
621 }
622 return -ENODEV;
623 }
624
625 /* TYPE_ENCLOSURE prints a message in probe */
626 if (sdev->type != TYPE_ENCLOSURE)
627 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
628
629 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
630 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
631 if (!hdr_buf || !ses_dev)
632 goto err_init_free;
633
634 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
635 if (result)
636 goto recv_failed;
637
638 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
639 buf = kzalloc(len, GFP_KERNEL);
640 if (!buf)
641 goto err_free;
642
643 result = ses_recv_diag(sdev, 1, buf, len);
644 if (result)
645 goto recv_failed;
646
647 types = 0;
648
649 /* we always have one main enclosure and the rest are referred
650 * to as secondary subenclosures */
651 num_enclosures = buf[1] + 1;
652
653 /* begin at the enclosure descriptor */
654 type_ptr = buf + 8;
655 /* skip all the enclosure descriptors */
656 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
657 types += type_ptr[2];
658 type_ptr += type_ptr[3] + 4;
659 }
660
661 ses_dev->page1_types = type_ptr;
662 ses_dev->page1_num_types = types;
663
664 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
665 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
666 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
667 components += type_ptr[1];
668 }
669 ses_dev->page1 = buf;
670 ses_dev->page1_len = len;
671 buf = NULL;
672
673 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
674 if (result)
675 goto recv_failed;
676
677 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
678 buf = kzalloc(len, GFP_KERNEL);
679 if (!buf)
680 goto err_free;
681
682 /* make sure getting page 2 actually works */
683 result = ses_recv_diag(sdev, 2, buf, len);
684 if (result)
685 goto recv_failed;
686 ses_dev->page2 = buf;
687 ses_dev->page2_len = len;
688 buf = NULL;
689
690 /* The additional information page --- allows us
691 * to match up the devices */
692 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
693 if (!result) {
694
695 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
696 buf = kzalloc(len, GFP_KERNEL);
697 if (!buf)
698 goto err_free;
699
700 result = ses_recv_diag(sdev, 10, buf, len);
701 if (result)
702 goto recv_failed;
703 ses_dev->page10 = buf;
704 ses_dev->page10_len = len;
705 buf = NULL;
706 }
707 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
708 if (!scomp)
709 goto err_free;
710
711 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
712 components, &ses_enclosure_callbacks);
713 if (IS_ERR(edev)) {
714 err = PTR_ERR(edev);
715 goto err_free;
716 }
717
718 kfree(hdr_buf);
719
720 edev->scratch = ses_dev;
721 for (i = 0; i < components; i++)
722 edev->component[i].scratch = scomp + i;
723
724 ses_enclosure_data_process(edev, sdev, 1);
725
726 /* see if there are any devices matching before
727 * we found the enclosure */
728 shost_for_each_device(tmp_sdev, sdev->host) {
729 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
730 continue;
731 ses_match_to_enclosure(edev, tmp_sdev);
732 }
733
734 return 0;
735
736 recv_failed:
737 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
738 result);
739 err = -ENODEV;
740 err_free:
741 kfree(buf);
742 kfree(scomp);
743 kfree(ses_dev->page10);
744 kfree(ses_dev->page2);
745 kfree(ses_dev->page1);
746 err_init_free:
747 kfree(ses_dev);
748 kfree(hdr_buf);
749 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
750 return err;
751}
752
753static int ses_remove(struct device *dev)
754{
755 return 0;
756}
757
758static void ses_intf_remove_component(struct scsi_device *sdev)
759{
760 struct enclosure_device *edev, *prev = NULL;
761
762 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
763 prev = edev;
764 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
765 break;
766 }
767 if (edev)
768 put_device(&edev->edev);
769}
770
771static void ses_intf_remove_enclosure(struct scsi_device *sdev)
772{
773 struct enclosure_device *edev;
774 struct ses_device *ses_dev;
775
776 /* exact match to this enclosure */
777 edev = enclosure_find(&sdev->sdev_gendev, NULL);
778 if (!edev)
779 return;
780
781 ses_dev = edev->scratch;
782 edev->scratch = NULL;
783
784 kfree(ses_dev->page10);
785 kfree(ses_dev->page1);
786 kfree(ses_dev->page2);
787 kfree(ses_dev);
788
789 kfree(edev->component[0].scratch);
790
791 put_device(&edev->edev);
792 enclosure_unregister(edev);
793}
794
795static void ses_intf_remove(struct device *cdev,
796 struct class_interface *intf)
797{
798 struct scsi_device *sdev = to_scsi_device(cdev->parent);
799
800 if (!scsi_device_enclosure(sdev))
801 ses_intf_remove_component(sdev);
802 else
803 ses_intf_remove_enclosure(sdev);
804}
805
806static struct class_interface ses_interface = {
807 .add_dev = ses_intf_add,
808 .remove_dev = ses_intf_remove,
809};
810
811static struct scsi_driver ses_template = {
812 .gendrv = {
813 .name = "ses",
814 .owner = THIS_MODULE,
815 .probe = ses_probe,
816 .remove = ses_remove,
817 },
818};
819
820static int __init ses_init(void)
821{
822 int err;
823
824 err = scsi_register_interface(&ses_interface);
825 if (err)
826 return err;
827
828 err = scsi_register_driver(&ses_template.gendrv);
829 if (err)
830 goto out_unreg;
831
832 return 0;
833
834 out_unreg:
835 scsi_unregister_interface(&ses_interface);
836 return err;
837}
838
839static void __exit ses_exit(void)
840{
841 scsi_unregister_driver(&ses_template.gendrv);
842 scsi_unregister_interface(&ses_interface);
843}
844
845module_init(ses_init);
846module_exit(ses_exit);
847
848MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
849
850MODULE_AUTHOR("James Bottomley");
851MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
852MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * SCSI Enclosure Services
4 *
5 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
6 */
7
8#include <linux/slab.h>
9#include <linux/module.h>
10#include <linux/kernel.h>
11#include <linux/enclosure.h>
12#include <asm/unaligned.h>
13
14#include <scsi/scsi.h>
15#include <scsi/scsi_cmnd.h>
16#include <scsi/scsi_dbg.h>
17#include <scsi/scsi_device.h>
18#include <scsi/scsi_driver.h>
19#include <scsi/scsi_host.h>
20
21#include <scsi/scsi_transport_sas.h>
22
23struct ses_device {
24 unsigned char *page1;
25 unsigned char *page1_types;
26 unsigned char *page2;
27 unsigned char *page10;
28 short page1_len;
29 short page1_num_types;
30 short page2_len;
31 short page10_len;
32};
33
34struct ses_component {
35 u64 addr;
36};
37
38static bool ses_page2_supported(struct enclosure_device *edev)
39{
40 struct ses_device *ses_dev = edev->scratch;
41
42 return (ses_dev->page2 != NULL);
43}
44
45static int ses_probe(struct device *dev)
46{
47 struct scsi_device *sdev = to_scsi_device(dev);
48 int err = -ENODEV;
49
50 if (sdev->type != TYPE_ENCLOSURE)
51 goto out;
52
53 err = 0;
54 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
55
56 out:
57 return err;
58}
59
60#define SES_TIMEOUT (30 * HZ)
61#define SES_RETRIES 3
62
63static void init_device_slot_control(unsigned char *dest_desc,
64 struct enclosure_component *ecomp,
65 unsigned char *status)
66{
67 memcpy(dest_desc, status, 4);
68 dest_desc[0] = 0;
69 /* only clear byte 1 for ENCLOSURE_COMPONENT_DEVICE */
70 if (ecomp->type == ENCLOSURE_COMPONENT_DEVICE)
71 dest_desc[1] = 0;
72 dest_desc[2] &= 0xde;
73 dest_desc[3] &= 0x3c;
74}
75
76
77static int ses_recv_diag(struct scsi_device *sdev, int page_code,
78 void *buf, int bufflen)
79{
80 int ret;
81 unsigned char cmd[] = {
82 RECEIVE_DIAGNOSTIC,
83 1, /* Set PCV bit */
84 page_code,
85 bufflen >> 8,
86 bufflen & 0xff,
87 0
88 };
89 unsigned char recv_page_code;
90 unsigned int retries = SES_RETRIES;
91 struct scsi_sense_hdr sshdr;
92 const struct scsi_exec_args exec_args = {
93 .sshdr = &sshdr,
94 };
95
96 do {
97 ret = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buf, bufflen,
98 SES_TIMEOUT, 1, &exec_args);
99 } while (ret > 0 && --retries && scsi_sense_valid(&sshdr) &&
100 (sshdr.sense_key == NOT_READY ||
101 (sshdr.sense_key == UNIT_ATTENTION && sshdr.asc == 0x29)));
102
103 if (unlikely(ret))
104 return ret;
105
106 recv_page_code = ((unsigned char *)buf)[0];
107
108 if (likely(recv_page_code == page_code))
109 return ret;
110
111 /* successful diagnostic but wrong page code. This happens to some
112 * USB devices, just print a message and pretend there was an error */
113
114 sdev_printk(KERN_ERR, sdev,
115 "Wrong diagnostic page; asked for %d got %u\n",
116 page_code, recv_page_code);
117
118 return -EINVAL;
119}
120
121static int ses_send_diag(struct scsi_device *sdev, int page_code,
122 void *buf, int bufflen)
123{
124 int result;
125
126 unsigned char cmd[] = {
127 SEND_DIAGNOSTIC,
128 0x10, /* Set PF bit */
129 0,
130 bufflen >> 8,
131 bufflen & 0xff,
132 0
133 };
134 struct scsi_sense_hdr sshdr;
135 unsigned int retries = SES_RETRIES;
136 const struct scsi_exec_args exec_args = {
137 .sshdr = &sshdr,
138 };
139
140 do {
141 result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_OUT, buf,
142 bufflen, SES_TIMEOUT, 1, &exec_args);
143 } while (result > 0 && --retries && scsi_sense_valid(&sshdr) &&
144 (sshdr.sense_key == NOT_READY ||
145 (sshdr.sense_key == UNIT_ATTENTION && sshdr.asc == 0x29)));
146
147 if (result)
148 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
149 result);
150 return result;
151}
152
153static int ses_set_page2_descriptor(struct enclosure_device *edev,
154 struct enclosure_component *ecomp,
155 unsigned char *desc)
156{
157 int i, j, count = 0, descriptor = ecomp->number;
158 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
159 struct ses_device *ses_dev = edev->scratch;
160 unsigned char *type_ptr = ses_dev->page1_types;
161 unsigned char *desc_ptr = ses_dev->page2 + 8;
162
163 /* Clear everything */
164 memset(desc_ptr, 0, ses_dev->page2_len - 8);
165 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
166 for (j = 0; j < type_ptr[1]; j++) {
167 desc_ptr += 4;
168 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
169 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
170 continue;
171 if (count++ == descriptor) {
172 memcpy(desc_ptr, desc, 4);
173 /* set select */
174 desc_ptr[0] |= 0x80;
175 /* clear reserved, just in case */
176 desc_ptr[0] &= 0xf0;
177 }
178 }
179 }
180
181 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
182}
183
184static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
185 struct enclosure_component *ecomp)
186{
187 int i, j, count = 0, descriptor = ecomp->number;
188 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
189 struct ses_device *ses_dev = edev->scratch;
190 unsigned char *type_ptr = ses_dev->page1_types;
191 unsigned char *desc_ptr = ses_dev->page2 + 8;
192
193 if (ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len) < 0)
194 return NULL;
195
196 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
197 for (j = 0; j < type_ptr[1]; j++) {
198 desc_ptr += 4;
199 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
200 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
201 continue;
202 if (count++ == descriptor)
203 return desc_ptr;
204 }
205 }
206 return NULL;
207}
208
209/* For device slot and array device slot elements, byte 3 bit 6
210 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
211 * code stands these bits are shifted 4 positions right so in
212 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
213static void ses_get_fault(struct enclosure_device *edev,
214 struct enclosure_component *ecomp)
215{
216 unsigned char *desc;
217
218 if (!ses_page2_supported(edev)) {
219 ecomp->fault = 0;
220 return;
221 }
222 desc = ses_get_page2_descriptor(edev, ecomp);
223 if (desc)
224 ecomp->fault = (desc[3] & 0x60) >> 4;
225}
226
227static int ses_set_fault(struct enclosure_device *edev,
228 struct enclosure_component *ecomp,
229 enum enclosure_component_setting val)
230{
231 unsigned char desc[4];
232 unsigned char *desc_ptr;
233
234 if (!ses_page2_supported(edev))
235 return -EINVAL;
236
237 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
238
239 if (!desc_ptr)
240 return -EIO;
241
242 init_device_slot_control(desc, ecomp, desc_ptr);
243
244 switch (val) {
245 case ENCLOSURE_SETTING_DISABLED:
246 desc[3] &= 0xdf;
247 break;
248 case ENCLOSURE_SETTING_ENABLED:
249 desc[3] |= 0x20;
250 break;
251 default:
252 /* SES doesn't do the SGPIO blink settings */
253 return -EINVAL;
254 }
255
256 return ses_set_page2_descriptor(edev, ecomp, desc);
257}
258
259static void ses_get_status(struct enclosure_device *edev,
260 struct enclosure_component *ecomp)
261{
262 unsigned char *desc;
263
264 if (!ses_page2_supported(edev)) {
265 ecomp->status = 0;
266 return;
267 }
268 desc = ses_get_page2_descriptor(edev, ecomp);
269 if (desc)
270 ecomp->status = (desc[0] & 0x0f);
271}
272
273static void ses_get_locate(struct enclosure_device *edev,
274 struct enclosure_component *ecomp)
275{
276 unsigned char *desc;
277
278 if (!ses_page2_supported(edev)) {
279 ecomp->locate = 0;
280 return;
281 }
282 desc = ses_get_page2_descriptor(edev, ecomp);
283 if (desc)
284 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
285}
286
287static int ses_set_locate(struct enclosure_device *edev,
288 struct enclosure_component *ecomp,
289 enum enclosure_component_setting val)
290{
291 unsigned char desc[4];
292 unsigned char *desc_ptr;
293
294 if (!ses_page2_supported(edev))
295 return -EINVAL;
296
297 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
298
299 if (!desc_ptr)
300 return -EIO;
301
302 init_device_slot_control(desc, ecomp, desc_ptr);
303
304 switch (val) {
305 case ENCLOSURE_SETTING_DISABLED:
306 desc[2] &= 0xfd;
307 break;
308 case ENCLOSURE_SETTING_ENABLED:
309 desc[2] |= 0x02;
310 break;
311 default:
312 /* SES doesn't do the SGPIO blink settings */
313 return -EINVAL;
314 }
315 return ses_set_page2_descriptor(edev, ecomp, desc);
316}
317
318static int ses_set_active(struct enclosure_device *edev,
319 struct enclosure_component *ecomp,
320 enum enclosure_component_setting val)
321{
322 unsigned char desc[4];
323 unsigned char *desc_ptr;
324
325 if (!ses_page2_supported(edev))
326 return -EINVAL;
327
328 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
329
330 if (!desc_ptr)
331 return -EIO;
332
333 init_device_slot_control(desc, ecomp, desc_ptr);
334
335 switch (val) {
336 case ENCLOSURE_SETTING_DISABLED:
337 desc[2] &= 0x7f;
338 ecomp->active = 0;
339 break;
340 case ENCLOSURE_SETTING_ENABLED:
341 desc[2] |= 0x80;
342 ecomp->active = 1;
343 break;
344 default:
345 /* SES doesn't do the SGPIO blink settings */
346 return -EINVAL;
347 }
348 return ses_set_page2_descriptor(edev, ecomp, desc);
349}
350
351static int ses_show_id(struct enclosure_device *edev, char *buf)
352{
353 struct ses_device *ses_dev = edev->scratch;
354 unsigned long long id = get_unaligned_be64(ses_dev->page1+8+4);
355
356 return sprintf(buf, "%#llx\n", id);
357}
358
359static void ses_get_power_status(struct enclosure_device *edev,
360 struct enclosure_component *ecomp)
361{
362 unsigned char *desc;
363
364 if (!ses_page2_supported(edev)) {
365 ecomp->power_status = 0;
366 return;
367 }
368
369 desc = ses_get_page2_descriptor(edev, ecomp);
370 if (desc)
371 ecomp->power_status = (desc[3] & 0x10) ? 0 : 1;
372}
373
374static int ses_set_power_status(struct enclosure_device *edev,
375 struct enclosure_component *ecomp,
376 int val)
377{
378 unsigned char desc[4];
379 unsigned char *desc_ptr;
380
381 if (!ses_page2_supported(edev))
382 return -EINVAL;
383
384 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
385
386 if (!desc_ptr)
387 return -EIO;
388
389 init_device_slot_control(desc, ecomp, desc_ptr);
390
391 switch (val) {
392 /* power = 1 is device_off = 0 and vice versa */
393 case 0:
394 desc[3] |= 0x10;
395 break;
396 case 1:
397 desc[3] &= 0xef;
398 break;
399 default:
400 return -EINVAL;
401 }
402 ecomp->power_status = val;
403 return ses_set_page2_descriptor(edev, ecomp, desc);
404}
405
406static struct enclosure_component_callbacks ses_enclosure_callbacks = {
407 .get_fault = ses_get_fault,
408 .set_fault = ses_set_fault,
409 .get_status = ses_get_status,
410 .get_locate = ses_get_locate,
411 .set_locate = ses_set_locate,
412 .get_power_status = ses_get_power_status,
413 .set_power_status = ses_set_power_status,
414 .set_active = ses_set_active,
415 .show_id = ses_show_id,
416};
417
418struct ses_host_edev {
419 struct Scsi_Host *shost;
420 struct enclosure_device *edev;
421};
422
423#if 0
424int ses_match_host(struct enclosure_device *edev, void *data)
425{
426 struct ses_host_edev *sed = data;
427 struct scsi_device *sdev;
428
429 if (!scsi_is_sdev_device(edev->edev.parent))
430 return 0;
431
432 sdev = to_scsi_device(edev->edev.parent);
433
434 if (sdev->host != sed->shost)
435 return 0;
436
437 sed->edev = edev;
438 return 1;
439}
440#endif /* 0 */
441
442static int ses_process_descriptor(struct enclosure_component *ecomp,
443 unsigned char *desc, int max_desc_len)
444{
445 int eip = desc[0] & 0x10;
446 int invalid = desc[0] & 0x80;
447 enum scsi_protocol proto = desc[0] & 0x0f;
448 u64 addr = 0;
449 int slot = -1;
450 struct ses_component *scomp = ecomp->scratch;
451 unsigned char *d;
452
453 if (invalid)
454 return 0;
455
456 switch (proto) {
457 case SCSI_PROTOCOL_FCP:
458 if (eip) {
459 if (max_desc_len <= 7)
460 return 1;
461 d = desc + 4;
462 slot = d[3];
463 }
464 break;
465 case SCSI_PROTOCOL_SAS:
466
467 if (eip) {
468 if (max_desc_len <= 27)
469 return 1;
470 d = desc + 4;
471 slot = d[3];
472 d = desc + 8;
473 } else {
474 if (max_desc_len <= 23)
475 return 1;
476 d = desc + 4;
477 }
478
479
480 /* only take the phy0 addr */
481 addr = (u64)d[12] << 56 |
482 (u64)d[13] << 48 |
483 (u64)d[14] << 40 |
484 (u64)d[15] << 32 |
485 (u64)d[16] << 24 |
486 (u64)d[17] << 16 |
487 (u64)d[18] << 8 |
488 (u64)d[19];
489 break;
490 default:
491 /* FIXME: Need to add more protocols than just SAS */
492 break;
493 }
494 ecomp->slot = slot;
495 scomp->addr = addr;
496
497 return 0;
498}
499
500struct efd {
501 u64 addr;
502 struct device *dev;
503};
504
505static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
506 void *data)
507{
508 struct efd *efd = data;
509 int i;
510 struct ses_component *scomp;
511
512 for (i = 0; i < edev->components; i++) {
513 scomp = edev->component[i].scratch;
514 if (scomp->addr != efd->addr)
515 continue;
516
517 if (enclosure_add_device(edev, i, efd->dev) == 0)
518 kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
519 return 1;
520 }
521 return 0;
522}
523
524#define INIT_ALLOC_SIZE 32
525
526static void ses_enclosure_data_process(struct enclosure_device *edev,
527 struct scsi_device *sdev,
528 int create)
529{
530 u32 result;
531 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
532 int i, j, page7_len, len, components;
533 struct ses_device *ses_dev = edev->scratch;
534 int types = ses_dev->page1_num_types;
535 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
536
537 if (!hdr_buf)
538 goto simple_populate;
539
540 /* re-read page 10 */
541 if (ses_dev->page10)
542 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
543 /* Page 7 for the descriptors is optional */
544 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
545 if (result)
546 goto simple_populate;
547
548 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
549 /* add 1 for trailing '\0' we'll use */
550 buf = kzalloc(len + 1, GFP_KERNEL);
551 if (!buf)
552 goto simple_populate;
553 result = ses_recv_diag(sdev, 7, buf, len);
554 if (result) {
555 simple_populate:
556 kfree(buf);
557 buf = NULL;
558 desc_ptr = NULL;
559 len = 0;
560 page7_len = 0;
561 } else {
562 desc_ptr = buf + 8;
563 len = (desc_ptr[2] << 8) + desc_ptr[3];
564 /* skip past overall descriptor */
565 desc_ptr += len + 4;
566 }
567 if (ses_dev->page10 && ses_dev->page10_len > 9)
568 addl_desc_ptr = ses_dev->page10 + 8;
569 type_ptr = ses_dev->page1_types;
570 components = 0;
571 for (i = 0; i < types; i++, type_ptr += 4) {
572 for (j = 0; j < type_ptr[1]; j++) {
573 char *name = NULL;
574 struct enclosure_component *ecomp;
575 int max_desc_len;
576
577 if (desc_ptr) {
578 if (desc_ptr + 3 >= buf + page7_len) {
579 desc_ptr = NULL;
580 } else {
581 len = (desc_ptr[2] << 8) + desc_ptr[3];
582 desc_ptr += 4;
583 if (desc_ptr + len > buf + page7_len)
584 desc_ptr = NULL;
585 else {
586 /* Add trailing zero - pushes into
587 * reserved space */
588 desc_ptr[len] = '\0';
589 name = desc_ptr;
590 }
591 }
592 }
593 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
594 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
595
596 if (create)
597 ecomp = enclosure_component_alloc(
598 edev,
599 components++,
600 type_ptr[0],
601 name);
602 else if (components < edev->components)
603 ecomp = &edev->component[components++];
604 else
605 ecomp = ERR_PTR(-EINVAL);
606
607 if (!IS_ERR(ecomp)) {
608 if (addl_desc_ptr) {
609 max_desc_len = ses_dev->page10_len -
610 (addl_desc_ptr - ses_dev->page10);
611 if (ses_process_descriptor(ecomp,
612 addl_desc_ptr,
613 max_desc_len))
614 addl_desc_ptr = NULL;
615 }
616 if (create)
617 enclosure_component_register(
618 ecomp);
619 }
620 }
621 if (desc_ptr)
622 desc_ptr += len;
623
624 if (addl_desc_ptr &&
625 /* only find additional descriptions for specific devices */
626 (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
627 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
628 type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
629 /* these elements are optional */
630 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
631 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
632 type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS)) {
633 addl_desc_ptr += addl_desc_ptr[1] + 2;
634 if (addl_desc_ptr + 1 >= ses_dev->page10 + ses_dev->page10_len)
635 addl_desc_ptr = NULL;
636 }
637 }
638 }
639 kfree(buf);
640 kfree(hdr_buf);
641}
642
643static void ses_match_to_enclosure(struct enclosure_device *edev,
644 struct scsi_device *sdev,
645 int refresh)
646{
647 struct scsi_device *edev_sdev = to_scsi_device(edev->edev.parent);
648 struct efd efd = {
649 .addr = 0,
650 };
651
652 if (refresh)
653 ses_enclosure_data_process(edev, edev_sdev, 0);
654
655 if (scsi_is_sas_rphy(sdev->sdev_target->dev.parent))
656 efd.addr = sas_get_address(sdev);
657
658 if (efd.addr) {
659 efd.dev = &sdev->sdev_gendev;
660
661 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
662 }
663}
664
665static int ses_intf_add(struct device *cdev)
666{
667 struct scsi_device *sdev = to_scsi_device(cdev->parent);
668 struct scsi_device *tmp_sdev;
669 unsigned char *buf = NULL, *hdr_buf, *type_ptr, page;
670 struct ses_device *ses_dev;
671 u32 result;
672 int i, types, len, components = 0;
673 int err = -ENOMEM;
674 int num_enclosures;
675 struct enclosure_device *edev;
676 struct ses_component *scomp = NULL;
677
678 if (!scsi_device_enclosure(sdev)) {
679 /* not an enclosure, but might be in one */
680 struct enclosure_device *prev = NULL;
681
682 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
683 ses_match_to_enclosure(edev, sdev, 1);
684 prev = edev;
685 }
686 return -ENODEV;
687 }
688
689 /* TYPE_ENCLOSURE prints a message in probe */
690 if (sdev->type != TYPE_ENCLOSURE)
691 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
692
693 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
694 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
695 if (!hdr_buf || !ses_dev)
696 goto err_init_free;
697
698 page = 1;
699 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
700 if (result)
701 goto recv_failed;
702
703 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
704 buf = kzalloc(len, GFP_KERNEL);
705 if (!buf)
706 goto err_free;
707
708 result = ses_recv_diag(sdev, page, buf, len);
709 if (result)
710 goto recv_failed;
711
712 types = 0;
713
714 /* we always have one main enclosure and the rest are referred
715 * to as secondary subenclosures */
716 num_enclosures = buf[1] + 1;
717
718 /* begin at the enclosure descriptor */
719 type_ptr = buf + 8;
720 /* skip all the enclosure descriptors */
721 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
722 types += type_ptr[2];
723 type_ptr += type_ptr[3] + 4;
724 }
725
726 ses_dev->page1_types = type_ptr;
727 ses_dev->page1_num_types = types;
728
729 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
730 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
731 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
732 components += type_ptr[1];
733 }
734
735 ses_dev->page1 = buf;
736 ses_dev->page1_len = len;
737 buf = NULL;
738
739 page = 2;
740 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
741 if (result)
742 goto page2_not_supported;
743
744 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
745 buf = kzalloc(len, GFP_KERNEL);
746 if (!buf)
747 goto err_free;
748
749 /* make sure getting page 2 actually works */
750 result = ses_recv_diag(sdev, 2, buf, len);
751 if (result)
752 goto recv_failed;
753 ses_dev->page2 = buf;
754 ses_dev->page2_len = len;
755 buf = NULL;
756
757 /* The additional information page --- allows us
758 * to match up the devices */
759 page = 10;
760 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
761 if (!result) {
762
763 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
764 buf = kzalloc(len, GFP_KERNEL);
765 if (!buf)
766 goto err_free;
767
768 result = ses_recv_diag(sdev, page, buf, len);
769 if (result)
770 goto recv_failed;
771 ses_dev->page10 = buf;
772 ses_dev->page10_len = len;
773 buf = NULL;
774 }
775page2_not_supported:
776 if (components > 0) {
777 scomp = kcalloc(components, sizeof(struct ses_component), GFP_KERNEL);
778 if (!scomp)
779 goto err_free;
780 }
781
782 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
783 components, &ses_enclosure_callbacks);
784 if (IS_ERR(edev)) {
785 err = PTR_ERR(edev);
786 goto err_free;
787 }
788
789 kfree(hdr_buf);
790
791 edev->scratch = ses_dev;
792 for (i = 0; i < components; i++)
793 edev->component[i].scratch = scomp + i;
794
795 ses_enclosure_data_process(edev, sdev, 1);
796
797 /* see if there are any devices matching before
798 * we found the enclosure */
799 shost_for_each_device(tmp_sdev, sdev->host) {
800 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
801 continue;
802 ses_match_to_enclosure(edev, tmp_sdev, 0);
803 }
804
805 return 0;
806
807 recv_failed:
808 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
809 page);
810 err = -ENODEV;
811 err_free:
812 kfree(buf);
813 kfree(scomp);
814 kfree(ses_dev->page10);
815 kfree(ses_dev->page2);
816 kfree(ses_dev->page1);
817 err_init_free:
818 kfree(ses_dev);
819 kfree(hdr_buf);
820 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
821 return err;
822}
823
824static int ses_remove(struct device *dev)
825{
826 return 0;
827}
828
829static void ses_intf_remove_component(struct scsi_device *sdev)
830{
831 struct enclosure_device *edev, *prev = NULL;
832
833 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
834 prev = edev;
835 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
836 break;
837 }
838 if (edev)
839 put_device(&edev->edev);
840}
841
842static void ses_intf_remove_enclosure(struct scsi_device *sdev)
843{
844 struct enclosure_device *edev;
845 struct ses_device *ses_dev;
846
847 /* exact match to this enclosure */
848 edev = enclosure_find(&sdev->sdev_gendev, NULL);
849 if (!edev)
850 return;
851
852 ses_dev = edev->scratch;
853 edev->scratch = NULL;
854
855 kfree(ses_dev->page10);
856 kfree(ses_dev->page1);
857 kfree(ses_dev->page2);
858 kfree(ses_dev);
859
860 if (edev->components)
861 kfree(edev->component[0].scratch);
862
863 put_device(&edev->edev);
864 enclosure_unregister(edev);
865}
866
867static void ses_intf_remove(struct device *cdev)
868{
869 struct scsi_device *sdev = to_scsi_device(cdev->parent);
870
871 if (!scsi_device_enclosure(sdev))
872 ses_intf_remove_component(sdev);
873 else
874 ses_intf_remove_enclosure(sdev);
875}
876
877static struct class_interface ses_interface = {
878 .add_dev = ses_intf_add,
879 .remove_dev = ses_intf_remove,
880};
881
882static struct scsi_driver ses_template = {
883 .gendrv = {
884 .name = "ses",
885 .owner = THIS_MODULE,
886 .probe = ses_probe,
887 .remove = ses_remove,
888 },
889};
890
891static int __init ses_init(void)
892{
893 int err;
894
895 err = scsi_register_interface(&ses_interface);
896 if (err)
897 return err;
898
899 err = scsi_register_driver(&ses_template.gendrv);
900 if (err)
901 goto out_unreg;
902
903 return 0;
904
905 out_unreg:
906 scsi_unregister_interface(&ses_interface);
907 return err;
908}
909
910static void __exit ses_exit(void)
911{
912 scsi_unregister_driver(&ses_template.gendrv);
913 scsi_unregister_interface(&ses_interface);
914}
915
916module_init(ses_init);
917module_exit(ses_exit);
918
919MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
920
921MODULE_AUTHOR("James Bottomley");
922MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
923MODULE_LICENSE("GPL v2");