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