blob: 69046d342bc5d553b8d220996a8b2da4621618fe [file] [log] [blame]
James Bottomley9927c682008-02-03 15:48:56 -06001/*
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
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
James Bottomley9927c682008-02-03 15:48:56 -060025#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/enclosure.h>
Hannes Reineckec38c0072014-03-15 09:51:51 +010028#include <asm/unaligned.h>
James Bottomley9927c682008-02-03 15:48:56 -060029
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
James Bottomley3f8d6f22015-12-09 12:56:07 -080037#include <scsi/scsi_transport_sas.h>
38
James Bottomley9927c682008-02-03 15:48:56 -060039struct ses_device {
Yinghai Lu691b4772008-02-13 16:25:16 -080040 unsigned char *page1;
James Bottomley8c3adc72011-03-18 11:24:23 -040041 unsigned char *page1_types;
Yinghai Lu691b4772008-02-13 16:25:16 -080042 unsigned char *page2;
43 unsigned char *page10;
James Bottomley9927c682008-02-03 15:48:56 -060044 short page1_len;
James Bottomley8c3adc72011-03-18 11:24:23 -040045 short page1_num_types;
James Bottomley9927c682008-02-03 15:48:56 -060046 short page2_len;
47 short page10_len;
48};
49
50struct ses_component {
51 u64 addr;
James Bottomley9927c682008-02-03 15:48:56 -060052};
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
Matthew Wilcoxc95e62c2008-06-23 09:14:31 -060069#define SES_TIMEOUT (30 * HZ)
James Bottomley9927c682008-02-03 15:48:56 -060070#define SES_RETRIES 3
71
Song Liu08024882014-12-30 14:46:18 -080072static 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
James Bottomley9927c682008-02-03 15:48:56 -060086static int ses_recv_diag(struct scsi_device *sdev, int page_code,
87 void *buf, int bufflen)
88{
James Bottomley3417c1b2015-12-08 09:00:31 -080089 int ret;
Yinghai Lu691b4772008-02-13 16:25:16 -080090 unsigned char cmd[] = {
James Bottomley9927c682008-02-03 15:48:56 -060091 RECEIVE_DIAGNOSTIC,
92 1, /* Set PCV bit */
93 page_code,
94 bufflen >> 8,
95 bufflen & 0xff,
96 0
97 };
James Bottomley3417c1b2015-12-08 09:00:31 -080098 unsigned char recv_page_code;
James Bottomley9927c682008-02-03 15:48:56 -060099
James Bottomley3417c1b2015-12-08 09:00:31 -0800100 ret = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900101 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
James Bottomley3417c1b2015-12-08 09:00:31 -0800102 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;
James Bottomley9927c682008-02-03 15:48:56 -0600118}
119
120static int ses_send_diag(struct scsi_device *sdev, int page_code,
121 void *buf, int bufflen)
122{
123 u32 result;
124
Yinghai Lu691b4772008-02-13 16:25:16 -0800125 unsigned char cmd[] = {
James Bottomley9927c682008-02-03 15:48:56 -0600126 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,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900135 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
James Bottomley9927c682008-02-03 15:48:56 -0600136 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,
Yinghai Lu691b4772008-02-13 16:25:16 -0800144 unsigned char *desc)
James Bottomley9927c682008-02-03 15:48:56 -0600145{
146 int i, j, count = 0, descriptor = ecomp->number;
Tony Jonesee959b02008-02-22 00:13:36 +0100147 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600148 struct ses_device *ses_dev = edev->scratch;
James Bottomley8c3adc72011-03-18 11:24:23 -0400149 unsigned char *type_ptr = ses_dev->page1_types;
Yinghai Lu691b4772008-02-13 16:25:16 -0800150 unsigned char *desc_ptr = ses_dev->page2 + 8;
James Bottomley9927c682008-02-03 15:48:56 -0600151
152 /* Clear everything */
153 memset(desc_ptr, 0, ses_dev->page2_len - 8);
James Bottomley8c3adc72011-03-18 11:24:23 -0400154 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600155 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
Yinghai Lu691b4772008-02-13 16:25:16 -0800173static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
James Bottomley9927c682008-02-03 15:48:56 -0600174 struct enclosure_component *ecomp)
175{
176 int i, j, count = 0, descriptor = ecomp->number;
Tony Jonesee959b02008-02-22 00:13:36 +0100177 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600178 struct ses_device *ses_dev = edev->scratch;
James Bottomley8c3adc72011-03-18 11:24:23 -0400179 unsigned char *type_ptr = ses_dev->page1_types;
Yinghai Lu691b4772008-02-13 16:25:16 -0800180 unsigned char *desc_ptr = ses_dev->page2 + 8;
James Bottomley9927c682008-02-03 15:48:56 -0600181
182 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
183
James Bottomley8c3adc72011-03-18 11:24:23 -0400184 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600185 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
Douglas Gilbert2a350ca2011-06-09 00:27:07 -0400197/* 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. */
James Bottomley9927c682008-02-03 15:48:56 -0600201static void ses_get_fault(struct enclosure_device *edev,
202 struct enclosure_component *ecomp)
203{
Yinghai Lu691b4772008-02-13 16:25:16 -0800204 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600205
206 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800207 if (desc)
208 ecomp->fault = (desc[3] & 0x60) >> 4;
James Bottomley9927c682008-02-03 15:48:56 -0600209}
210
211static int ses_set_fault(struct enclosure_device *edev,
212 struct enclosure_component *ecomp,
213 enum enclosure_component_setting val)
214{
Song Liu08024882014-12-30 14:46:18 -0800215 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);
James Bottomley9927c682008-02-03 15:48:56 -0600224
225 switch (val) {
226 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800227 desc[3] &= 0xdf;
James Bottomley9927c682008-02-03 15:48:56 -0600228 break;
229 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800230 desc[3] |= 0x20;
James Bottomley9927c682008-02-03 15:48:56 -0600231 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{
Yinghai Lu691b4772008-02-13 16:25:16 -0800243 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600244
245 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800246 if (desc)
247 ecomp->status = (desc[0] & 0x0f);
James Bottomley9927c682008-02-03 15:48:56 -0600248}
249
250static void ses_get_locate(struct enclosure_device *edev,
251 struct enclosure_component *ecomp)
252{
Yinghai Lu691b4772008-02-13 16:25:16 -0800253 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600254
255 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800256 if (desc)
257 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
James Bottomley9927c682008-02-03 15:48:56 -0600258}
259
260static int ses_set_locate(struct enclosure_device *edev,
261 struct enclosure_component *ecomp,
262 enum enclosure_component_setting val)
263{
Song Liu08024882014-12-30 14:46:18 -0800264 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);
James Bottomley9927c682008-02-03 15:48:56 -0600273
274 switch (val) {
275 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800276 desc[2] &= 0xfd;
James Bottomley9927c682008-02-03 15:48:56 -0600277 break;
278 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800279 desc[2] |= 0x02;
James Bottomley9927c682008-02-03 15:48:56 -0600280 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{
Song Liu08024882014-12-30 14:46:18 -0800292 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);
James Bottomley9927c682008-02-03 15:48:56 -0600301
302 switch (val) {
303 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800304 desc[2] &= 0x7f;
James Bottomley9927c682008-02-03 15:48:56 -0600305 ecomp->active = 0;
306 break;
307 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800308 desc[2] |= 0x80;
James Bottomley9927c682008-02-03 15:48:56 -0600309 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
Dan Williams967f7ba2014-12-30 14:46:16 -0800318static 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
Song Liu08024882014-12-30 14:46:18 -0800326static 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
James Bottomley9927c682008-02-03 15:48:56 -0600365static 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,
Song Liu08024882014-12-30 14:46:18 -0800371 .get_power_status = ses_get_power_status,
372 .set_power_status = ses_set_power_status,
James Bottomley9927c682008-02-03 15:48:56 -0600373 .set_active = ses_set_active,
Dan Williams967f7ba2014-12-30 14:46:16 -0800374 .show_id = ses_show_id,
James Bottomley9927c682008-02-03 15:48:56 -0600375};
376
377struct ses_host_edev {
378 struct Scsi_Host *shost;
379 struct enclosure_device *edev;
380};
381
Adrian Bunke0aae1a2009-03-04 12:06:05 -0800382#if 0
James Bottomley9927c682008-02-03 15:48:56 -0600383int ses_match_host(struct enclosure_device *edev, void *data)
384{
385 struct ses_host_edev *sed = data;
386 struct scsi_device *sdev;
387
Tony Jonesee959b02008-02-22 00:13:36 +0100388 if (!scsi_is_sdev_device(edev->edev.parent))
James Bottomley9927c682008-02-03 15:48:56 -0600389 return 0;
390
Tony Jonesee959b02008-02-22 00:13:36 +0100391 sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600392
393 if (sdev->host != sed->shost)
394 return 0;
395
396 sed->edev = edev;
397 return 1;
398}
Adrian Bunke0aae1a2009-03-04 12:06:05 -0800399#endif /* 0 */
James Bottomley9927c682008-02-03 15:48:56 -0600400
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;
Dan Williams921ce7f2014-12-30 14:46:17 -0800408 int slot = -1;
James Bottomley9927c682008-02-03 15:48:56 -0600409 struct ses_component *scomp = ecomp->scratch;
410 unsigned char *d;
411
James Bottomley9927c682008-02-03 15:48:56 -0600412 if (invalid)
413 return;
414
415 switch (proto) {
Dan Williams921ce7f2014-12-30 14:46:17 -0800416 case SCSI_PROTOCOL_FCP:
417 if (eip) {
418 d = desc + 4;
419 slot = d[3];
420 }
421 break;
James Bottomley9927c682008-02-03 15:48:56 -0600422 case SCSI_PROTOCOL_SAS:
Dan Williams921ce7f2014-12-30 14:46:17 -0800423 if (eip) {
424 d = desc + 4;
425 slot = d[3];
James Bottomley9927c682008-02-03 15:48:56 -0600426 d = desc + 8;
Dan Williams921ce7f2014-12-30 14:46:17 -0800427 } else
James Bottomley9927c682008-02-03 15:48:56 -0600428 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 }
Dan Williams921ce7f2014-12-30 14:46:17 -0800443 ecomp->slot = slot;
James Bottomley9927c682008-02-03 15:48:56 -0600444 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
Dan Williams15a0fbb2014-12-30 14:46:15 -0800467 if (enclosure_add_device(edev, i, efd->dev) == 0)
468 kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
James Bottomley9927c682008-02-03 15:48:56 -0600469 return 1;
470 }
471 return 0;
472}
473
James Bottomley21fab1d2009-08-01 00:43:59 +0000474#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;
James Bottomley8c3adc72011-03-18 11:24:23 -0400484 int types = ses_dev->page1_num_types;
James Bottomley21fab1d2009-08-01 00:43:59 +0000485 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;
James Bottomley21fab1d2009-08-01 00:43:59 +0000516 }
John Hughes877a5592009-11-04 19:01:22 +0100517 if (ses_dev->page10)
518 addl_desc_ptr = ses_dev->page10 + 8;
James Bottomley8c3adc72011-03-18 11:24:23 -0400519 type_ptr = ses_dev->page1_types;
James Bottomley21fab1d2009-08-01 00:43:59 +0000520 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)
Dan Williamsed09dcc2014-12-30 14:46:14 -0800542 ecomp = enclosure_component_alloc(
543 edev,
544 components++,
545 type_ptr[0],
546 name);
James Bottomley21fab1d2009-08-01 00:43:59 +0000547 else
548 ecomp = &edev->component[components++];
549
Dan Williamsed09dcc2014-12-30 14:46:14 -0800550 if (!IS_ERR(ecomp)) {
551 if (addl_desc_ptr)
552 ses_process_descriptor(
553 ecomp,
554 addl_desc_ptr);
555 if (create)
556 enclosure_component_register(
557 ecomp);
558 }
James Bottomley21fab1d2009-08-01 00:43:59 +0000559 }
560 if (desc_ptr)
561 desc_ptr += len;
562
James Bottomley5e103352015-12-11 09:16:38 -0800563 if (addl_desc_ptr &&
564 /* only find additional descriptions for specific devices */
565 (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
566 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
567 type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
568 /* these elements are optional */
569 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
570 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
571 type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS))
James Bottomley21fab1d2009-08-01 00:43:59 +0000572 addl_desc_ptr += addl_desc_ptr[1] + 2;
573
574 }
575 }
576 kfree(buf);
577 kfree(hdr_buf);
578}
579
James Bottomley9927c682008-02-03 15:48:56 -0600580static void ses_match_to_enclosure(struct enclosure_device *edev,
Li Dongyangc6656ab2017-11-14 10:48:04 +1100581 struct scsi_device *sdev,
582 int refresh)
James Bottomley9927c682008-02-03 15:48:56 -0600583{
Li Dongyangc6656ab2017-11-14 10:48:04 +1100584 struct scsi_device *edev_sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600585 struct efd efd = {
586 .addr = 0,
587 };
James Bottomley9927c682008-02-03 15:48:56 -0600588
Li Dongyangc6656ab2017-11-14 10:48:04 +1100589 if (refresh)
590 ses_enclosure_data_process(edev, edev_sdev, 0);
James Bottomley21fab1d2009-08-01 00:43:59 +0000591
Ewan D. Milnea07a1222017-01-09 16:33:36 -0500592 if (scsi_is_sas_rphy(sdev->sdev_target->dev.parent))
James Bottomley3f8d6f22015-12-09 12:56:07 -0800593 efd.addr = sas_get_address(sdev);
James Bottomley671a99c2008-07-29 11:38:25 -0500594
Hannes Reineckec38c0072014-03-15 09:51:51 +0100595 if (efd.addr) {
596 efd.dev = &sdev->sdev_gendev;
James Bottomley9927c682008-02-03 15:48:56 -0600597
Hannes Reineckec38c0072014-03-15 09:51:51 +0100598 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
599 }
James Bottomley9927c682008-02-03 15:48:56 -0600600}
601
Tony Jonesee959b02008-02-22 00:13:36 +0100602static int ses_intf_add(struct device *cdev,
James Bottomley9927c682008-02-03 15:48:56 -0600603 struct class_interface *intf)
604{
Tony Jonesee959b02008-02-22 00:13:36 +0100605 struct scsi_device *sdev = to_scsi_device(cdev->parent);
James Bottomley9927c682008-02-03 15:48:56 -0600606 struct scsi_device *tmp_sdev;
James Bottomley21fab1d2009-08-01 00:43:59 +0000607 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
James Bottomley9927c682008-02-03 15:48:56 -0600608 struct ses_device *ses_dev;
609 u32 result;
James Bottomley21fab1d2009-08-01 00:43:59 +0000610 int i, types, len, components = 0;
James Bottomley9927c682008-02-03 15:48:56 -0600611 int err = -ENOMEM;
James Bottomley8c3adc72011-03-18 11:24:23 -0400612 int num_enclosures;
James Bottomley9927c682008-02-03 15:48:56 -0600613 struct enclosure_device *edev;
Yinghai Lu7c46c202008-02-10 23:25:25 -0800614 struct ses_component *scomp = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600615
616 if (!scsi_device_enclosure(sdev)) {
617 /* not an enclosure, but might be in one */
James Bottomley163f52b2009-08-01 00:39:36 +0000618 struct enclosure_device *prev = NULL;
619
620 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
Li Dongyangc6656ab2017-11-14 10:48:04 +1100621 ses_match_to_enclosure(edev, sdev, 1);
James Bottomley163f52b2009-08-01 00:39:36 +0000622 prev = edev;
James Bottomley9927c682008-02-03 15:48:56 -0600623 }
624 return -ENODEV;
625 }
626
627 /* TYPE_ENCLOSURE prints a message in probe */
628 if (sdev->type != TYPE_ENCLOSURE)
629 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
630
631 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
632 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
633 if (!hdr_buf || !ses_dev)
634 goto err_init_free;
635
636 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
637 if (result)
638 goto recv_failed;
639
James Bottomley9927c682008-02-03 15:48:56 -0600640 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
641 buf = kzalloc(len, GFP_KERNEL);
642 if (!buf)
643 goto err_free;
644
James Bottomley9927c682008-02-03 15:48:56 -0600645 result = ses_recv_diag(sdev, 1, buf, len);
646 if (result)
647 goto recv_failed;
648
James Bottomley8c3adc72011-03-18 11:24:23 -0400649 types = 0;
James Bottomley9927c682008-02-03 15:48:56 -0600650
James Bottomley8c3adc72011-03-18 11:24:23 -0400651 /* we always have one main enclosure and the rest are referred
652 * to as secondary subenclosures */
653 num_enclosures = buf[1] + 1;
James Bottomley9927c682008-02-03 15:48:56 -0600654
James Bottomley8c3adc72011-03-18 11:24:23 -0400655 /* begin at the enclosure descriptor */
656 type_ptr = buf + 8;
657 /* skip all the enclosure descriptors */
658 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
659 types += type_ptr[2];
660 type_ptr += type_ptr[3] + 4;
661 }
662
663 ses_dev->page1_types = type_ptr;
664 ses_dev->page1_num_types = types;
665
666 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600667 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
668 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
669 components += type_ptr[1];
670 }
Yinghai Lu7c46c202008-02-10 23:25:25 -0800671 ses_dev->page1 = buf;
672 ses_dev->page1_len = len;
673 buf = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600674
675 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
676 if (result)
677 goto recv_failed;
678
679 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
680 buf = kzalloc(len, GFP_KERNEL);
681 if (!buf)
682 goto err_free;
683
684 /* make sure getting page 2 actually works */
685 result = ses_recv_diag(sdev, 2, buf, len);
686 if (result)
687 goto recv_failed;
688 ses_dev->page2 = buf;
689 ses_dev->page2_len = len;
Yinghai Lu7c46c202008-02-10 23:25:25 -0800690 buf = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600691
692 /* The additional information page --- allows us
693 * to match up the devices */
694 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
Yinghai Lu691b4772008-02-13 16:25:16 -0800695 if (!result) {
James Bottomley9927c682008-02-03 15:48:56 -0600696
Yinghai Lu691b4772008-02-13 16:25:16 -0800697 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
698 buf = kzalloc(len, GFP_KERNEL);
699 if (!buf)
700 goto err_free;
James Bottomley9927c682008-02-03 15:48:56 -0600701
Yinghai Lu691b4772008-02-13 16:25:16 -0800702 result = ses_recv_diag(sdev, 10, buf, len);
703 if (result)
704 goto recv_failed;
705 ses_dev->page10 = buf;
706 ses_dev->page10_len = len;
707 buf = NULL;
708 }
Yinghai Lu7c46c202008-02-10 23:25:25 -0800709 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
James Bottomley9927c682008-02-03 15:48:56 -0600710 if (!scomp)
Yinghai Lu7c46c202008-02-10 23:25:25 -0800711 goto err_free;
James Bottomley9927c682008-02-03 15:48:56 -0600712
Kay Sievers71610f52008-12-03 22:41:36 +0100713 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
James Bottomley9927c682008-02-03 15:48:56 -0600714 components, &ses_enclosure_callbacks);
715 if (IS_ERR(edev)) {
716 err = PTR_ERR(edev);
717 goto err_free;
718 }
719
Julia Lawall9b3a6542010-03-10 15:20:42 -0800720 kfree(hdr_buf);
721
James Bottomley9927c682008-02-03 15:48:56 -0600722 edev->scratch = ses_dev;
723 for (i = 0; i < components; i++)
Yinghai Lu7c46c202008-02-10 23:25:25 -0800724 edev->component[i].scratch = scomp + i;
James Bottomley9927c682008-02-03 15:48:56 -0600725
James Bottomley21fab1d2009-08-01 00:43:59 +0000726 ses_enclosure_data_process(edev, sdev, 1);
James Bottomley9927c682008-02-03 15:48:56 -0600727
728 /* see if there are any devices matching before
729 * we found the enclosure */
730 shost_for_each_device(tmp_sdev, sdev->host) {
731 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
732 continue;
Li Dongyangc6656ab2017-11-14 10:48:04 +1100733 ses_match_to_enclosure(edev, tmp_sdev, 0);
James Bottomley9927c682008-02-03 15:48:56 -0600734 }
735
736 return 0;
737
738 recv_failed:
739 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
740 result);
741 err = -ENODEV;
742 err_free:
743 kfree(buf);
Yinghai Lu7c46c202008-02-10 23:25:25 -0800744 kfree(scomp);
James Bottomley9927c682008-02-03 15:48:56 -0600745 kfree(ses_dev->page10);
746 kfree(ses_dev->page2);
747 kfree(ses_dev->page1);
748 err_init_free:
749 kfree(ses_dev);
750 kfree(hdr_buf);
751 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
752 return err;
753}
754
755static int ses_remove(struct device *dev)
756{
757 return 0;
758}
759
James Bottomley43d8eb92009-08-01 00:41:22 +0000760static void ses_intf_remove_component(struct scsi_device *sdev)
James Bottomley9927c682008-02-03 15:48:56 -0600761{
James Bottomley43d8eb92009-08-01 00:41:22 +0000762 struct enclosure_device *edev, *prev = NULL;
763
764 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
765 prev = edev;
766 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
767 break;
768 }
769 if (edev)
770 put_device(&edev->edev);
771}
772
773static void ses_intf_remove_enclosure(struct scsi_device *sdev)
774{
James Bottomley9927c682008-02-03 15:48:56 -0600775 struct enclosure_device *edev;
776 struct ses_device *ses_dev;
777
James Bottomley163f52b2009-08-01 00:39:36 +0000778 /* exact match to this enclosure */
James Bottomley43d8eb92009-08-01 00:41:22 +0000779 edev = enclosure_find(&sdev->sdev_gendev, NULL);
James Bottomley9927c682008-02-03 15:48:56 -0600780 if (!edev)
781 return;
782
Calvin Owense120dcb2016-05-13 13:28:21 -0700783 enclosure_unregister(edev);
784
James Bottomley9927c682008-02-03 15:48:56 -0600785 ses_dev = edev->scratch;
786 edev->scratch = NULL;
787
Yinghai Lu7c46c202008-02-10 23:25:25 -0800788 kfree(ses_dev->page10);
James Bottomley9927c682008-02-03 15:48:56 -0600789 kfree(ses_dev->page1);
790 kfree(ses_dev->page2);
791 kfree(ses_dev);
792
793 kfree(edev->component[0].scratch);
794
Tony Jonesee959b02008-02-22 00:13:36 +0100795 put_device(&edev->edev);
James Bottomley9927c682008-02-03 15:48:56 -0600796}
797
James Bottomley43d8eb92009-08-01 00:41:22 +0000798static void ses_intf_remove(struct device *cdev,
799 struct class_interface *intf)
800{
801 struct scsi_device *sdev = to_scsi_device(cdev->parent);
802
803 if (!scsi_device_enclosure(sdev))
804 ses_intf_remove_component(sdev);
805 else
806 ses_intf_remove_enclosure(sdev);
807}
808
James Bottomley9927c682008-02-03 15:48:56 -0600809static struct class_interface ses_interface = {
Tony Jonesee959b02008-02-22 00:13:36 +0100810 .add_dev = ses_intf_add,
811 .remove_dev = ses_intf_remove,
James Bottomley9927c682008-02-03 15:48:56 -0600812};
813
814static struct scsi_driver ses_template = {
James Bottomley9927c682008-02-03 15:48:56 -0600815 .gendrv = {
816 .name = "ses",
Christoph Hellwig3af6b352014-11-12 18:34:51 +0100817 .owner = THIS_MODULE,
James Bottomley9927c682008-02-03 15:48:56 -0600818 .probe = ses_probe,
819 .remove = ses_remove,
820 },
821};
822
823static int __init ses_init(void)
824{
825 int err;
826
827 err = scsi_register_interface(&ses_interface);
828 if (err)
829 return err;
830
831 err = scsi_register_driver(&ses_template.gendrv);
832 if (err)
833 goto out_unreg;
834
835 return 0;
836
837 out_unreg:
838 scsi_unregister_interface(&ses_interface);
839 return err;
840}
841
842static void __exit ses_exit(void)
843{
844 scsi_unregister_driver(&ses_template.gendrv);
845 scsi_unregister_interface(&ses_interface);
846}
847
848module_init(ses_init);
849module_exit(ses_exit);
850
851MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
852
853MODULE_AUTHOR("James Bottomley");
854MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
855MODULE_LICENSE("GPL v2");