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