blob: ea7066cbf0d57379a21f9b2034dacbf83af1edd5 [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
Hannes Reineckedc56ce12017-08-15 10:21:43 +020054static bool ses_page2_supported(struct enclosure_device *edev)
55{
56 struct ses_device *ses_dev = edev->scratch;
57
58 return (ses_dev->page2 != NULL);
59}
60
James Bottomley9927c682008-02-03 15:48:56 -060061static int ses_probe(struct device *dev)
62{
63 struct scsi_device *sdev = to_scsi_device(dev);
64 int err = -ENODEV;
65
66 if (sdev->type != TYPE_ENCLOSURE)
67 goto out;
68
69 err = 0;
70 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
71
72 out:
73 return err;
74}
75
Matthew Wilcoxc95e62c2008-06-23 09:14:31 -060076#define SES_TIMEOUT (30 * HZ)
James Bottomley9927c682008-02-03 15:48:56 -060077#define SES_RETRIES 3
78
Song Liu08024882014-12-30 14:46:18 -080079static void init_device_slot_control(unsigned char *dest_desc,
80 struct enclosure_component *ecomp,
81 unsigned char *status)
82{
83 memcpy(dest_desc, status, 4);
84 dest_desc[0] = 0;
85 /* only clear byte 1 for ENCLOSURE_COMPONENT_DEVICE */
86 if (ecomp->type == ENCLOSURE_COMPONENT_DEVICE)
87 dest_desc[1] = 0;
88 dest_desc[2] &= 0xde;
89 dest_desc[3] &= 0x3c;
90}
91
92
James Bottomley9927c682008-02-03 15:48:56 -060093static int ses_recv_diag(struct scsi_device *sdev, int page_code,
94 void *buf, int bufflen)
95{
James Bottomley3417c1b2015-12-08 09:00:31 -080096 int ret;
Yinghai Lu691b4772008-02-13 16:25:16 -080097 unsigned char cmd[] = {
James Bottomley9927c682008-02-03 15:48:56 -060098 RECEIVE_DIAGNOSTIC,
99 1, /* Set PCV bit */
100 page_code,
101 bufflen >> 8,
102 bufflen & 0xff,
103 0
104 };
James Bottomley3417c1b2015-12-08 09:00:31 -0800105 unsigned char recv_page_code;
James Bottomley9927c682008-02-03 15:48:56 -0600106
James Bottomley3417c1b2015-12-08 09:00:31 -0800107 ret = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900108 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
James Bottomley3417c1b2015-12-08 09:00:31 -0800109 if (unlikely(!ret))
110 return ret;
111
112 recv_page_code = ((unsigned char *)buf)[0];
113
114 if (likely(recv_page_code == page_code))
115 return ret;
116
117 /* successful diagnostic but wrong page code. This happens to some
118 * USB devices, just print a message and pretend there was an error */
119
120 sdev_printk(KERN_ERR, sdev,
121 "Wrong diagnostic page; asked for %d got %u\n",
122 page_code, recv_page_code);
123
124 return -EINVAL;
James Bottomley9927c682008-02-03 15:48:56 -0600125}
126
127static int ses_send_diag(struct scsi_device *sdev, int page_code,
128 void *buf, int bufflen)
129{
130 u32 result;
131
Yinghai Lu691b4772008-02-13 16:25:16 -0800132 unsigned char cmd[] = {
James Bottomley9927c682008-02-03 15:48:56 -0600133 SEND_DIAGNOSTIC,
134 0x10, /* Set PF bit */
135 0,
136 bufflen >> 8,
137 bufflen & 0xff,
138 0
139 };
140
141 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900142 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
James Bottomley9927c682008-02-03 15:48:56 -0600143 if (result)
144 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
145 result);
146 return result;
147}
148
149static int ses_set_page2_descriptor(struct enclosure_device *edev,
150 struct enclosure_component *ecomp,
Yinghai Lu691b4772008-02-13 16:25:16 -0800151 unsigned char *desc)
James Bottomley9927c682008-02-03 15:48:56 -0600152{
153 int i, j, count = 0, descriptor = ecomp->number;
Tony Jonesee959b02008-02-22 00:13:36 +0100154 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600155 struct ses_device *ses_dev = edev->scratch;
James Bottomley8c3adc72011-03-18 11:24:23 -0400156 unsigned char *type_ptr = ses_dev->page1_types;
Yinghai Lu691b4772008-02-13 16:25:16 -0800157 unsigned char *desc_ptr = ses_dev->page2 + 8;
James Bottomley9927c682008-02-03 15:48:56 -0600158
159 /* Clear everything */
160 memset(desc_ptr, 0, ses_dev->page2_len - 8);
James Bottomley8c3adc72011-03-18 11:24:23 -0400161 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600162 for (j = 0; j < type_ptr[1]; j++) {
163 desc_ptr += 4;
164 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
165 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
166 continue;
167 if (count++ == descriptor) {
168 memcpy(desc_ptr, desc, 4);
169 /* set select */
170 desc_ptr[0] |= 0x80;
171 /* clear reserved, just in case */
172 desc_ptr[0] &= 0xf0;
173 }
174 }
175 }
176
177 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
178}
179
Yinghai Lu691b4772008-02-13 16:25:16 -0800180static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
James Bottomley9927c682008-02-03 15:48:56 -0600181 struct enclosure_component *ecomp)
182{
183 int i, j, count = 0, descriptor = ecomp->number;
Tony Jonesee959b02008-02-22 00:13:36 +0100184 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600185 struct ses_device *ses_dev = edev->scratch;
James Bottomley8c3adc72011-03-18 11:24:23 -0400186 unsigned char *type_ptr = ses_dev->page1_types;
Yinghai Lu691b4772008-02-13 16:25:16 -0800187 unsigned char *desc_ptr = ses_dev->page2 + 8;
James Bottomley9927c682008-02-03 15:48:56 -0600188
Hannes Reineckeacf8ab92017-08-15 10:21:41 +0200189 if (ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len) < 0)
190 return NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600191
James Bottomley8c3adc72011-03-18 11:24:23 -0400192 for (i = 0; i < ses_dev->page1_num_types; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600193 for (j = 0; j < type_ptr[1]; j++) {
194 desc_ptr += 4;
195 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
196 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
197 continue;
198 if (count++ == descriptor)
199 return desc_ptr;
200 }
201 }
202 return NULL;
203}
204
Douglas Gilbert2a350ca2011-06-09 00:27:07 -0400205/* For device slot and array device slot elements, byte 3 bit 6
206 * is "fault sensed" while byte 3 bit 5 is "fault reqstd". As this
207 * code stands these bits are shifted 4 positions right so in
208 * sysfs they will appear as bits 2 and 1 respectively. Strange. */
James Bottomley9927c682008-02-03 15:48:56 -0600209static void ses_get_fault(struct enclosure_device *edev,
210 struct enclosure_component *ecomp)
211{
Yinghai Lu691b4772008-02-13 16:25:16 -0800212 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600213
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200214 if (!ses_page2_supported(edev)) {
215 ecomp->fault = 0;
216 return;
217 }
James Bottomley9927c682008-02-03 15:48:56 -0600218 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800219 if (desc)
220 ecomp->fault = (desc[3] & 0x60) >> 4;
James Bottomley9927c682008-02-03 15:48:56 -0600221}
222
223static int ses_set_fault(struct enclosure_device *edev,
224 struct enclosure_component *ecomp,
225 enum enclosure_component_setting val)
226{
Song Liu08024882014-12-30 14:46:18 -0800227 unsigned char desc[4];
228 unsigned char *desc_ptr;
229
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200230 if (!ses_page2_supported(edev))
231 return -EINVAL;
232
Song Liu08024882014-12-30 14:46:18 -0800233 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
234
235 if (!desc_ptr)
236 return -EIO;
237
238 init_device_slot_control(desc, ecomp, desc_ptr);
James Bottomley9927c682008-02-03 15:48:56 -0600239
240 switch (val) {
241 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800242 desc[3] &= 0xdf;
James Bottomley9927c682008-02-03 15:48:56 -0600243 break;
244 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800245 desc[3] |= 0x20;
James Bottomley9927c682008-02-03 15:48:56 -0600246 break;
247 default:
248 /* SES doesn't do the SGPIO blink settings */
249 return -EINVAL;
250 }
251
252 return ses_set_page2_descriptor(edev, ecomp, desc);
253}
254
255static void ses_get_status(struct enclosure_device *edev,
256 struct enclosure_component *ecomp)
257{
Yinghai Lu691b4772008-02-13 16:25:16 -0800258 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600259
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200260 if (!ses_page2_supported(edev)) {
261 ecomp->status = 0;
262 return;
263 }
James Bottomley9927c682008-02-03 15:48:56 -0600264 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800265 if (desc)
266 ecomp->status = (desc[0] & 0x0f);
James Bottomley9927c682008-02-03 15:48:56 -0600267}
268
269static void ses_get_locate(struct enclosure_device *edev,
270 struct enclosure_component *ecomp)
271{
Yinghai Lu691b4772008-02-13 16:25:16 -0800272 unsigned char *desc;
James Bottomley9927c682008-02-03 15:48:56 -0600273
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200274 if (!ses_page2_supported(edev)) {
275 ecomp->locate = 0;
276 return;
277 }
James Bottomley9927c682008-02-03 15:48:56 -0600278 desc = ses_get_page2_descriptor(edev, ecomp);
Yinghai Lu691b4772008-02-13 16:25:16 -0800279 if (desc)
280 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
James Bottomley9927c682008-02-03 15:48:56 -0600281}
282
283static int ses_set_locate(struct enclosure_device *edev,
284 struct enclosure_component *ecomp,
285 enum enclosure_component_setting val)
286{
Song Liu08024882014-12-30 14:46:18 -0800287 unsigned char desc[4];
288 unsigned char *desc_ptr;
289
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200290 if (!ses_page2_supported(edev))
291 return -EINVAL;
292
Song Liu08024882014-12-30 14:46:18 -0800293 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
294
295 if (!desc_ptr)
296 return -EIO;
297
298 init_device_slot_control(desc, ecomp, desc_ptr);
James Bottomley9927c682008-02-03 15:48:56 -0600299
300 switch (val) {
301 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800302 desc[2] &= 0xfd;
James Bottomley9927c682008-02-03 15:48:56 -0600303 break;
304 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800305 desc[2] |= 0x02;
James Bottomley9927c682008-02-03 15:48:56 -0600306 break;
307 default:
308 /* SES doesn't do the SGPIO blink settings */
309 return -EINVAL;
310 }
311 return ses_set_page2_descriptor(edev, ecomp, desc);
312}
313
314static int ses_set_active(struct enclosure_device *edev,
315 struct enclosure_component *ecomp,
316 enum enclosure_component_setting val)
317{
Song Liu08024882014-12-30 14:46:18 -0800318 unsigned char desc[4];
319 unsigned char *desc_ptr;
320
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200321 if (!ses_page2_supported(edev))
322 return -EINVAL;
323
Song Liu08024882014-12-30 14:46:18 -0800324 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
325
326 if (!desc_ptr)
327 return -EIO;
328
329 init_device_slot_control(desc, ecomp, desc_ptr);
James Bottomley9927c682008-02-03 15:48:56 -0600330
331 switch (val) {
332 case ENCLOSURE_SETTING_DISABLED:
Song Liu08024882014-12-30 14:46:18 -0800333 desc[2] &= 0x7f;
James Bottomley9927c682008-02-03 15:48:56 -0600334 ecomp->active = 0;
335 break;
336 case ENCLOSURE_SETTING_ENABLED:
Song Liu08024882014-12-30 14:46:18 -0800337 desc[2] |= 0x80;
James Bottomley9927c682008-02-03 15:48:56 -0600338 ecomp->active = 1;
339 break;
340 default:
341 /* SES doesn't do the SGPIO blink settings */
342 return -EINVAL;
343 }
344 return ses_set_page2_descriptor(edev, ecomp, desc);
345}
346
Dan Williams967f7ba2014-12-30 14:46:16 -0800347static int ses_show_id(struct enclosure_device *edev, char *buf)
348{
349 struct ses_device *ses_dev = edev->scratch;
350 unsigned long long id = get_unaligned_be64(ses_dev->page1+8+4);
351
352 return sprintf(buf, "%#llx\n", id);
353}
354
Song Liu08024882014-12-30 14:46:18 -0800355static void ses_get_power_status(struct enclosure_device *edev,
356 struct enclosure_component *ecomp)
357{
358 unsigned char *desc;
359
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200360 if (!ses_page2_supported(edev)) {
361 ecomp->power_status = 0;
362 return;
363 }
364
Song Liu08024882014-12-30 14:46:18 -0800365 desc = ses_get_page2_descriptor(edev, ecomp);
366 if (desc)
367 ecomp->power_status = (desc[3] & 0x10) ? 0 : 1;
368}
369
370static int ses_set_power_status(struct enclosure_device *edev,
371 struct enclosure_component *ecomp,
372 int val)
373{
374 unsigned char desc[4];
375 unsigned char *desc_ptr;
376
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200377 if (!ses_page2_supported(edev))
378 return -EINVAL;
379
Song Liu08024882014-12-30 14:46:18 -0800380 desc_ptr = ses_get_page2_descriptor(edev, ecomp);
381
382 if (!desc_ptr)
383 return -EIO;
384
385 init_device_slot_control(desc, ecomp, desc_ptr);
386
387 switch (val) {
388 /* power = 1 is device_off = 0 and vice versa */
389 case 0:
390 desc[3] |= 0x10;
391 break;
392 case 1:
393 desc[3] &= 0xef;
394 break;
395 default:
396 return -EINVAL;
397 }
398 ecomp->power_status = val;
399 return ses_set_page2_descriptor(edev, ecomp, desc);
400}
401
James Bottomley9927c682008-02-03 15:48:56 -0600402static struct enclosure_component_callbacks ses_enclosure_callbacks = {
403 .get_fault = ses_get_fault,
404 .set_fault = ses_set_fault,
405 .get_status = ses_get_status,
406 .get_locate = ses_get_locate,
407 .set_locate = ses_set_locate,
Song Liu08024882014-12-30 14:46:18 -0800408 .get_power_status = ses_get_power_status,
409 .set_power_status = ses_set_power_status,
James Bottomley9927c682008-02-03 15:48:56 -0600410 .set_active = ses_set_active,
Dan Williams967f7ba2014-12-30 14:46:16 -0800411 .show_id = ses_show_id,
James Bottomley9927c682008-02-03 15:48:56 -0600412};
413
414struct ses_host_edev {
415 struct Scsi_Host *shost;
416 struct enclosure_device *edev;
417};
418
Adrian Bunke0aae1a2009-03-04 12:06:05 -0800419#if 0
James Bottomley9927c682008-02-03 15:48:56 -0600420int ses_match_host(struct enclosure_device *edev, void *data)
421{
422 struct ses_host_edev *sed = data;
423 struct scsi_device *sdev;
424
Tony Jonesee959b02008-02-22 00:13:36 +0100425 if (!scsi_is_sdev_device(edev->edev.parent))
James Bottomley9927c682008-02-03 15:48:56 -0600426 return 0;
427
Tony Jonesee959b02008-02-22 00:13:36 +0100428 sdev = to_scsi_device(edev->edev.parent);
James Bottomley9927c682008-02-03 15:48:56 -0600429
430 if (sdev->host != sed->shost)
431 return 0;
432
433 sed->edev = edev;
434 return 1;
435}
Adrian Bunke0aae1a2009-03-04 12:06:05 -0800436#endif /* 0 */
James Bottomley9927c682008-02-03 15:48:56 -0600437
438static void ses_process_descriptor(struct enclosure_component *ecomp,
439 unsigned char *desc)
440{
441 int eip = desc[0] & 0x10;
442 int invalid = desc[0] & 0x80;
443 enum scsi_protocol proto = desc[0] & 0x0f;
444 u64 addr = 0;
Dan Williams921ce7f2014-12-30 14:46:17 -0800445 int slot = -1;
James Bottomley9927c682008-02-03 15:48:56 -0600446 struct ses_component *scomp = ecomp->scratch;
447 unsigned char *d;
448
James Bottomley9927c682008-02-03 15:48:56 -0600449 if (invalid)
450 return;
451
452 switch (proto) {
Dan Williams921ce7f2014-12-30 14:46:17 -0800453 case SCSI_PROTOCOL_FCP:
454 if (eip) {
455 d = desc + 4;
456 slot = d[3];
457 }
458 break;
James Bottomley9927c682008-02-03 15:48:56 -0600459 case SCSI_PROTOCOL_SAS:
Dan Williams921ce7f2014-12-30 14:46:17 -0800460 if (eip) {
461 d = desc + 4;
462 slot = d[3];
James Bottomley9927c682008-02-03 15:48:56 -0600463 d = desc + 8;
Dan Williams921ce7f2014-12-30 14:46:17 -0800464 } else
James Bottomley9927c682008-02-03 15:48:56 -0600465 d = desc + 4;
466 /* only take the phy0 addr */
467 addr = (u64)d[12] << 56 |
468 (u64)d[13] << 48 |
469 (u64)d[14] << 40 |
470 (u64)d[15] << 32 |
471 (u64)d[16] << 24 |
472 (u64)d[17] << 16 |
473 (u64)d[18] << 8 |
474 (u64)d[19];
475 break;
476 default:
477 /* FIXME: Need to add more protocols than just SAS */
478 break;
479 }
Dan Williams921ce7f2014-12-30 14:46:17 -0800480 ecomp->slot = slot;
James Bottomley9927c682008-02-03 15:48:56 -0600481 scomp->addr = addr;
482}
483
484struct efd {
485 u64 addr;
486 struct device *dev;
487};
488
489static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
490 void *data)
491{
492 struct efd *efd = data;
493 int i;
494 struct ses_component *scomp;
495
496 if (!edev->component[0].scratch)
497 return 0;
498
499 for (i = 0; i < edev->components; i++) {
500 scomp = edev->component[i].scratch;
501 if (scomp->addr != efd->addr)
502 continue;
503
Dan Williams15a0fbb2014-12-30 14:46:15 -0800504 if (enclosure_add_device(edev, i, efd->dev) == 0)
505 kobject_uevent(&efd->dev->kobj, KOBJ_CHANGE);
James Bottomley9927c682008-02-03 15:48:56 -0600506 return 1;
507 }
508 return 0;
509}
510
James Bottomley21fab1d2009-08-01 00:43:59 +0000511#define INIT_ALLOC_SIZE 32
512
513static void ses_enclosure_data_process(struct enclosure_device *edev,
514 struct scsi_device *sdev,
515 int create)
516{
517 u32 result;
518 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
519 int i, j, page7_len, len, components;
520 struct ses_device *ses_dev = edev->scratch;
James Bottomley8c3adc72011-03-18 11:24:23 -0400521 int types = ses_dev->page1_num_types;
James Bottomley21fab1d2009-08-01 00:43:59 +0000522 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
523
524 if (!hdr_buf)
525 goto simple_populate;
526
527 /* re-read page 10 */
528 if (ses_dev->page10)
529 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
530 /* Page 7 for the descriptors is optional */
531 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
532 if (result)
533 goto simple_populate;
534
535 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
536 /* add 1 for trailing '\0' we'll use */
537 buf = kzalloc(len + 1, GFP_KERNEL);
538 if (!buf)
539 goto simple_populate;
540 result = ses_recv_diag(sdev, 7, buf, len);
541 if (result) {
542 simple_populate:
543 kfree(buf);
544 buf = NULL;
545 desc_ptr = NULL;
546 len = 0;
547 page7_len = 0;
548 } else {
549 desc_ptr = buf + 8;
550 len = (desc_ptr[2] << 8) + desc_ptr[3];
551 /* skip past overall descriptor */
552 desc_ptr += len + 4;
James Bottomley21fab1d2009-08-01 00:43:59 +0000553 }
John Hughes877a5592009-11-04 19:01:22 +0100554 if (ses_dev->page10)
555 addl_desc_ptr = ses_dev->page10 + 8;
James Bottomley8c3adc72011-03-18 11:24:23 -0400556 type_ptr = ses_dev->page1_types;
James Bottomley21fab1d2009-08-01 00:43:59 +0000557 components = 0;
558 for (i = 0; i < types; i++, type_ptr += 4) {
559 for (j = 0; j < type_ptr[1]; j++) {
560 char *name = NULL;
561 struct enclosure_component *ecomp;
562
563 if (desc_ptr) {
564 if (desc_ptr >= buf + page7_len) {
565 desc_ptr = NULL;
566 } else {
567 len = (desc_ptr[2] << 8) + desc_ptr[3];
568 desc_ptr += 4;
569 /* Add trailing zero - pushes into
570 * reserved space */
571 desc_ptr[len] = '\0';
572 name = desc_ptr;
573 }
574 }
575 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
576 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
577
578 if (create)
Dan Williamsed09dcc2014-12-30 14:46:14 -0800579 ecomp = enclosure_component_alloc(
580 edev,
581 components++,
582 type_ptr[0],
583 name);
James Bottomley21fab1d2009-08-01 00:43:59 +0000584 else
585 ecomp = &edev->component[components++];
586
Dan Williamsed09dcc2014-12-30 14:46:14 -0800587 if (!IS_ERR(ecomp)) {
588 if (addl_desc_ptr)
589 ses_process_descriptor(
590 ecomp,
591 addl_desc_ptr);
592 if (create)
593 enclosure_component_register(
594 ecomp);
595 }
James Bottomley21fab1d2009-08-01 00:43:59 +0000596 }
597 if (desc_ptr)
598 desc_ptr += len;
599
James Bottomley5e103352015-12-11 09:16:38 -0800600 if (addl_desc_ptr &&
601 /* only find additional descriptions for specific devices */
602 (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
603 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE ||
604 type_ptr[0] == ENCLOSURE_COMPONENT_SAS_EXPANDER ||
605 /* these elements are optional */
606 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_TARGET_PORT ||
607 type_ptr[0] == ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT ||
608 type_ptr[0] == ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS))
James Bottomley21fab1d2009-08-01 00:43:59 +0000609 addl_desc_ptr += addl_desc_ptr[1] + 2;
610
611 }
612 }
613 kfree(buf);
614 kfree(hdr_buf);
615}
616
James Bottomley9927c682008-02-03 15:48:56 -0600617static void ses_match_to_enclosure(struct enclosure_device *edev,
618 struct scsi_device *sdev)
619{
James Bottomley9927c682008-02-03 15:48:56 -0600620 struct efd efd = {
621 .addr = 0,
622 };
James Bottomley9927c682008-02-03 15:48:56 -0600623
James Bottomley21fab1d2009-08-01 00:43:59 +0000624 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
625
Ewan D. Milne9373eba2017-01-09 16:33:36 -0500626 if (scsi_is_sas_rphy(sdev->sdev_target->dev.parent))
James Bottomley3f8d6f22015-12-09 12:56:07 -0800627 efd.addr = sas_get_address(sdev);
James Bottomley671a99c2008-07-29 11:38:25 -0500628
Hannes Reineckec38c0072014-03-15 09:51:51 +0100629 if (efd.addr) {
630 efd.dev = &sdev->sdev_gendev;
James Bottomley9927c682008-02-03 15:48:56 -0600631
Hannes Reineckec38c0072014-03-15 09:51:51 +0100632 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
633 }
James Bottomley9927c682008-02-03 15:48:56 -0600634}
635
Tony Jonesee959b02008-02-22 00:13:36 +0100636static int ses_intf_add(struct device *cdev,
James Bottomley9927c682008-02-03 15:48:56 -0600637 struct class_interface *intf)
638{
Tony Jonesee959b02008-02-22 00:13:36 +0100639 struct scsi_device *sdev = to_scsi_device(cdev->parent);
James Bottomley9927c682008-02-03 15:48:56 -0600640 struct scsi_device *tmp_sdev;
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200641 unsigned char *buf = NULL, *hdr_buf, *type_ptr, page;
James Bottomley9927c682008-02-03 15:48:56 -0600642 struct ses_device *ses_dev;
643 u32 result;
James Bottomley21fab1d2009-08-01 00:43:59 +0000644 int i, types, len, components = 0;
James Bottomley9927c682008-02-03 15:48:56 -0600645 int err = -ENOMEM;
James Bottomley8c3adc72011-03-18 11:24:23 -0400646 int num_enclosures;
James Bottomley9927c682008-02-03 15:48:56 -0600647 struct enclosure_device *edev;
Yinghai Lu7c46c202008-02-10 23:25:25 -0800648 struct ses_component *scomp = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600649
650 if (!scsi_device_enclosure(sdev)) {
651 /* not an enclosure, but might be in one */
James Bottomley163f52b2009-08-01 00:39:36 +0000652 struct enclosure_device *prev = NULL;
653
654 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
James Bottomley9927c682008-02-03 15:48:56 -0600655 ses_match_to_enclosure(edev, sdev);
James Bottomley163f52b2009-08-01 00:39:36 +0000656 prev = edev;
James Bottomley9927c682008-02-03 15:48:56 -0600657 }
658 return -ENODEV;
659 }
660
661 /* TYPE_ENCLOSURE prints a message in probe */
662 if (sdev->type != TYPE_ENCLOSURE)
663 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
664
665 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
666 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
667 if (!hdr_buf || !ses_dev)
668 goto err_init_free;
669
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200670 page = 1;
671 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
James Bottomley9927c682008-02-03 15:48:56 -0600672 if (result)
673 goto recv_failed;
674
James Bottomley9927c682008-02-03 15:48:56 -0600675 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
676 buf = kzalloc(len, GFP_KERNEL);
677 if (!buf)
678 goto err_free;
679
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200680 result = ses_recv_diag(sdev, page, buf, len);
James Bottomley9927c682008-02-03 15:48:56 -0600681 if (result)
682 goto recv_failed;
683
James Bottomley8c3adc72011-03-18 11:24:23 -0400684 types = 0;
James Bottomley9927c682008-02-03 15:48:56 -0600685
James Bottomley8c3adc72011-03-18 11:24:23 -0400686 /* we always have one main enclosure and the rest are referred
687 * to as secondary subenclosures */
688 num_enclosures = buf[1] + 1;
James Bottomley9927c682008-02-03 15:48:56 -0600689
James Bottomley8c3adc72011-03-18 11:24:23 -0400690 /* begin at the enclosure descriptor */
691 type_ptr = buf + 8;
692 /* skip all the enclosure descriptors */
693 for (i = 0; i < num_enclosures && type_ptr < buf + len; i++) {
694 types += type_ptr[2];
695 type_ptr += type_ptr[3] + 4;
696 }
697
698 ses_dev->page1_types = type_ptr;
699 ses_dev->page1_num_types = types;
700
701 for (i = 0; i < types && type_ptr < buf + len; i++, type_ptr += 4) {
James Bottomley9927c682008-02-03 15:48:56 -0600702 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
703 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
704 components += type_ptr[1];
705 }
Yinghai Lu7c46c202008-02-10 23:25:25 -0800706 ses_dev->page1 = buf;
707 ses_dev->page1_len = len;
708 buf = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600709
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200710 page = 2;
711 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
James Bottomley9927c682008-02-03 15:48:56 -0600712 if (result)
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200713 goto page2_not_supported;
James Bottomley9927c682008-02-03 15:48:56 -0600714
715 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
716 buf = kzalloc(len, GFP_KERNEL);
717 if (!buf)
718 goto err_free;
719
720 /* make sure getting page 2 actually works */
721 result = ses_recv_diag(sdev, 2, buf, len);
722 if (result)
723 goto recv_failed;
724 ses_dev->page2 = buf;
725 ses_dev->page2_len = len;
Yinghai Lu7c46c202008-02-10 23:25:25 -0800726 buf = NULL;
James Bottomley9927c682008-02-03 15:48:56 -0600727
728 /* The additional information page --- allows us
729 * to match up the devices */
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200730 page = 10;
731 result = ses_recv_diag(sdev, page, hdr_buf, INIT_ALLOC_SIZE);
Yinghai Lu691b4772008-02-13 16:25:16 -0800732 if (!result) {
James Bottomley9927c682008-02-03 15:48:56 -0600733
Yinghai Lu691b4772008-02-13 16:25:16 -0800734 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
735 buf = kzalloc(len, GFP_KERNEL);
736 if (!buf)
737 goto err_free;
James Bottomley9927c682008-02-03 15:48:56 -0600738
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200739 result = ses_recv_diag(sdev, page, buf, len);
Yinghai Lu691b4772008-02-13 16:25:16 -0800740 if (result)
741 goto recv_failed;
742 ses_dev->page10 = buf;
743 ses_dev->page10_len = len;
744 buf = NULL;
745 }
Hannes Reineckedc56ce12017-08-15 10:21:43 +0200746page2_not_supported:
Yinghai Lu7c46c202008-02-10 23:25:25 -0800747 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
James Bottomley9927c682008-02-03 15:48:56 -0600748 if (!scomp)
Yinghai Lu7c46c202008-02-10 23:25:25 -0800749 goto err_free;
James Bottomley9927c682008-02-03 15:48:56 -0600750
Kay Sievers71610f52008-12-03 22:41:36 +0100751 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
James Bottomley9927c682008-02-03 15:48:56 -0600752 components, &ses_enclosure_callbacks);
753 if (IS_ERR(edev)) {
754 err = PTR_ERR(edev);
755 goto err_free;
756 }
757
Julia Lawall9b3a6542010-03-10 15:20:42 -0800758 kfree(hdr_buf);
759
James Bottomley9927c682008-02-03 15:48:56 -0600760 edev->scratch = ses_dev;
761 for (i = 0; i < components; i++)
Yinghai Lu7c46c202008-02-10 23:25:25 -0800762 edev->component[i].scratch = scomp + i;
James Bottomley9927c682008-02-03 15:48:56 -0600763
James Bottomley21fab1d2009-08-01 00:43:59 +0000764 ses_enclosure_data_process(edev, sdev, 1);
James Bottomley9927c682008-02-03 15:48:56 -0600765
766 /* see if there are any devices matching before
767 * we found the enclosure */
768 shost_for_each_device(tmp_sdev, sdev->host) {
769 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
770 continue;
771 ses_match_to_enclosure(edev, tmp_sdev);
772 }
773
774 return 0;
775
776 recv_failed:
777 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
Hannes Reinecke81b59d72017-08-15 10:21:42 +0200778 page);
James Bottomley9927c682008-02-03 15:48:56 -0600779 err = -ENODEV;
780 err_free:
781 kfree(buf);
Yinghai Lu7c46c202008-02-10 23:25:25 -0800782 kfree(scomp);
James Bottomley9927c682008-02-03 15:48:56 -0600783 kfree(ses_dev->page10);
784 kfree(ses_dev->page2);
785 kfree(ses_dev->page1);
786 err_init_free:
787 kfree(ses_dev);
788 kfree(hdr_buf);
789 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
790 return err;
791}
792
793static int ses_remove(struct device *dev)
794{
795 return 0;
796}
797
James Bottomley43d8eb92009-08-01 00:41:22 +0000798static void ses_intf_remove_component(struct scsi_device *sdev)
James Bottomley9927c682008-02-03 15:48:56 -0600799{
James Bottomley43d8eb92009-08-01 00:41:22 +0000800 struct enclosure_device *edev, *prev = NULL;
801
802 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
803 prev = edev;
804 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
805 break;
806 }
807 if (edev)
808 put_device(&edev->edev);
809}
810
811static void ses_intf_remove_enclosure(struct scsi_device *sdev)
812{
James Bottomley9927c682008-02-03 15:48:56 -0600813 struct enclosure_device *edev;
814 struct ses_device *ses_dev;
815
James Bottomley163f52b2009-08-01 00:39:36 +0000816 /* exact match to this enclosure */
James Bottomley43d8eb92009-08-01 00:41:22 +0000817 edev = enclosure_find(&sdev->sdev_gendev, NULL);
James Bottomley9927c682008-02-03 15:48:56 -0600818 if (!edev)
819 return;
820
821 ses_dev = edev->scratch;
822 edev->scratch = NULL;
823
Yinghai Lu7c46c202008-02-10 23:25:25 -0800824 kfree(ses_dev->page10);
James Bottomley9927c682008-02-03 15:48:56 -0600825 kfree(ses_dev->page1);
826 kfree(ses_dev->page2);
827 kfree(ses_dev);
828
829 kfree(edev->component[0].scratch);
830
Tony Jonesee959b02008-02-22 00:13:36 +0100831 put_device(&edev->edev);
Calvin Owensa5a039b2017-08-24 15:13:52 +0200832 enclosure_unregister(edev);
James Bottomley9927c682008-02-03 15:48:56 -0600833}
834
James Bottomley43d8eb92009-08-01 00:41:22 +0000835static void ses_intf_remove(struct device *cdev,
836 struct class_interface *intf)
837{
838 struct scsi_device *sdev = to_scsi_device(cdev->parent);
839
840 if (!scsi_device_enclosure(sdev))
841 ses_intf_remove_component(sdev);
842 else
843 ses_intf_remove_enclosure(sdev);
844}
845
James Bottomley9927c682008-02-03 15:48:56 -0600846static struct class_interface ses_interface = {
Tony Jonesee959b02008-02-22 00:13:36 +0100847 .add_dev = ses_intf_add,
848 .remove_dev = ses_intf_remove,
James Bottomley9927c682008-02-03 15:48:56 -0600849};
850
851static struct scsi_driver ses_template = {
James Bottomley9927c682008-02-03 15:48:56 -0600852 .gendrv = {
853 .name = "ses",
Christoph Hellwig3af6b352014-11-12 18:34:51 +0100854 .owner = THIS_MODULE,
James Bottomley9927c682008-02-03 15:48:56 -0600855 .probe = ses_probe,
856 .remove = ses_remove,
857 },
858};
859
860static int __init ses_init(void)
861{
862 int err;
863
864 err = scsi_register_interface(&ses_interface);
865 if (err)
866 return err;
867
868 err = scsi_register_driver(&ses_template.gendrv);
869 if (err)
870 goto out_unreg;
871
872 return 0;
873
874 out_unreg:
875 scsi_unregister_interface(&ses_interface);
876 return err;
877}
878
879static void __exit ses_exit(void)
880{
881 scsi_unregister_driver(&ses_template.gendrv);
882 scsi_unregister_interface(&ses_interface);
883}
884
885module_init(ses_init);
886module_exit(ses_exit);
887
888MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
889
890MODULE_AUTHOR("James Bottomley");
891MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
892MODULE_LICENSE("GPL v2");