?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
GUI: Fix Tomato RAF theme for all builds. Compilation typo.
[tomato.git] / release / src-rt-6.x.4708 / linux / linux-2.6.36 / drivers / scsi / ses.c
blob7857d56da2c98b7034287b30699ff71dff3755c2
1 /*
2 * SCSI Enclosure Services
3 *
4 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
5 *
6 **-----------------------------------------------------------------------------
7 **
8 ** This program is free software; you can redistribute it and/or
9 ** modify it under the terms of the GNU General Public License
10 ** version 2 as published by the Free Software Foundation.
11 **
12 ** This program is distributed in the hope that it will be useful,
13 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ** GNU General Public License for more details.
16 **
17 ** You should have received a copy of the GNU General Public License
18 ** along with this program; if not, write to the Free Software
19 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 **
21 **-----------------------------------------------------------------------------
22 */
23
24 #include <linux/slab.h>
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/enclosure.h>
28
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_cmnd.h>
31 #include <scsi/scsi_dbg.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_driver.h>
34 #include <scsi/scsi_host.h>
35
36 struct ses_device {
37 unsigned char *page1;
38 unsigned char *page2;
39 unsigned char *page10;
40 short page1_len;
41 short page2_len;
42 short page10_len;
43 };
44
45 struct ses_component {
46 u64 addr;
47 unsigned char *desc;
48 };
49
50 static int ses_probe(struct device *dev)
51 {
52 struct scsi_device *sdev = to_scsi_device(dev);
53 int err = -ENODEV;
54
55 if (sdev->type != TYPE_ENCLOSURE)
56 goto out;
57
58 err = 0;
59 sdev_printk(KERN_NOTICE, sdev, "Attached Enclosure device\n");
60
61 out:
62 return err;
63 }
64
65 #define SES_TIMEOUT (30 * HZ)
66 #define SES_RETRIES 3
67
68 static int ses_recv_diag(struct scsi_device *sdev, int page_code,
69 void *buf, int bufflen)
70 {
71 unsigned char cmd[] = {
72 RECEIVE_DIAGNOSTIC,
73 1, /* Set PCV bit */
74 page_code,
75 bufflen >> 8,
76 bufflen & 0xff,
77 0
78 };
79
80 return scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, bufflen,
81 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
82 }
83
84 static int ses_send_diag(struct scsi_device *sdev, int page_code,
85 void *buf, int bufflen)
86 {
87 u32 result;
88
89 unsigned char cmd[] = {
90 SEND_DIAGNOSTIC,
91 0x10, /* Set PF bit */
92 0,
93 bufflen >> 8,
94 bufflen & 0xff,
95 0
96 };
97
98 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, buf, bufflen,
99 NULL, SES_TIMEOUT, SES_RETRIES, NULL);
100 if (result)
101 sdev_printk(KERN_ERR, sdev, "SEND DIAGNOSTIC result: %8x\n",
102 result);
103 return result;
104 }
105
106 static int ses_set_page2_descriptor(struct enclosure_device *edev,
107 struct enclosure_component *ecomp,
108 unsigned char *desc)
109 {
110 int i, j, count = 0, descriptor = ecomp->number;
111 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
112 struct ses_device *ses_dev = edev->scratch;
113 unsigned char *type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
114 unsigned char *desc_ptr = ses_dev->page2 + 8;
115
116 /* Clear everything */
117 memset(desc_ptr, 0, ses_dev->page2_len - 8);
118 for (i = 0; i < ses_dev->page1[10]; i++, type_ptr += 4) {
119 for (j = 0; j < type_ptr[1]; j++) {
120 desc_ptr += 4;
121 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
122 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
123 continue;
124 if (count++ == descriptor) {
125 memcpy(desc_ptr, desc, 4);
126 /* set select */
127 desc_ptr[0] |= 0x80;
128 /* clear reserved, just in case */
129 desc_ptr[0] &= 0xf0;
130 }
131 }
132 }
133
134 return ses_send_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
135 }
136
137 static unsigned char *ses_get_page2_descriptor(struct enclosure_device *edev,
138 struct enclosure_component *ecomp)
139 {
140 int i, j, count = 0, descriptor = ecomp->number;
141 struct scsi_device *sdev = to_scsi_device(edev->edev.parent);
142 struct ses_device *ses_dev = edev->scratch;
143 unsigned char *type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
144 unsigned char *desc_ptr = ses_dev->page2 + 8;
145
146 ses_recv_diag(sdev, 2, ses_dev->page2, ses_dev->page2_len);
147
148 for (i = 0; i < ses_dev->page1[10]; i++, type_ptr += 4) {
149 for (j = 0; j < type_ptr[1]; j++) {
150 desc_ptr += 4;
151 if (type_ptr[0] != ENCLOSURE_COMPONENT_DEVICE &&
152 type_ptr[0] != ENCLOSURE_COMPONENT_ARRAY_DEVICE)
153 continue;
154 if (count++ == descriptor)
155 return desc_ptr;
156 }
157 }
158 return NULL;
159 }
160
161 static void ses_get_fault(struct enclosure_device *edev,
162 struct enclosure_component *ecomp)
163 {
164 unsigned char *desc;
165
166 desc = ses_get_page2_descriptor(edev, ecomp);
167 if (desc)
168 ecomp->fault = (desc[3] & 0x60) >> 4;
169 }
170
171 static int ses_set_fault(struct enclosure_device *edev,
172 struct enclosure_component *ecomp,
173 enum enclosure_component_setting val)
174 {
175 unsigned char desc[4] = {0 };
176
177 switch (val) {
178 case ENCLOSURE_SETTING_DISABLED:
179 /* zero is disabled */
180 break;
181 case ENCLOSURE_SETTING_ENABLED:
182 desc[2] = 0x02;
183 break;
184 default:
185 /* SES doesn't do the SGPIO blink settings */
186 return -EINVAL;
187 }
188
189 return ses_set_page2_descriptor(edev, ecomp, desc);
190 }
191
192 static void ses_get_status(struct enclosure_device *edev,
193 struct enclosure_component *ecomp)
194 {
195 unsigned char *desc;
196
197 desc = ses_get_page2_descriptor(edev, ecomp);
198 if (desc)
199 ecomp->status = (desc[0] & 0x0f);
200 }
201
202 static void ses_get_locate(struct enclosure_device *edev,
203 struct enclosure_component *ecomp)
204 {
205 unsigned char *desc;
206
207 desc = ses_get_page2_descriptor(edev, ecomp);
208 if (desc)
209 ecomp->locate = (desc[2] & 0x02) ? 1 : 0;
210 }
211
212 static int ses_set_locate(struct enclosure_device *edev,
213 struct enclosure_component *ecomp,
214 enum enclosure_component_setting val)
215 {
216 unsigned char desc[4] = {0 };
217
218 switch (val) {
219 case ENCLOSURE_SETTING_DISABLED:
220 /* zero is disabled */
221 break;
222 case ENCLOSURE_SETTING_ENABLED:
223 desc[2] = 0x02;
224 break;
225 default:
226 /* SES doesn't do the SGPIO blink settings */
227 return -EINVAL;
228 }
229 return ses_set_page2_descriptor(edev, ecomp, desc);
230 }
231
232 static int ses_set_active(struct enclosure_device *edev,
233 struct enclosure_component *ecomp,
234 enum enclosure_component_setting val)
235 {
236 unsigned char desc[4] = {0 };
237
238 switch (val) {
239 case ENCLOSURE_SETTING_DISABLED:
240 /* zero is disabled */
241 ecomp->active = 0;
242 break;
243 case ENCLOSURE_SETTING_ENABLED:
244 desc[2] = 0x80;
245 ecomp->active = 1;
246 break;
247 default:
248 /* SES doesn't do the SGPIO blink settings */
249 return -EINVAL;
250 }
251 return ses_set_page2_descriptor(edev, ecomp, desc);
252 }
253
254 static struct enclosure_component_callbacks ses_enclosure_callbacks = {
255 .get_fault = ses_get_fault,
256 .set_fault = ses_set_fault,
257 .get_status = ses_get_status,
258 .get_locate = ses_get_locate,
259 .set_locate = ses_set_locate,
260 .set_active = ses_set_active,
261 };
262
263 struct ses_host_edev {
264 struct Scsi_Host *shost;
265 struct enclosure_device *edev;
266 };
267
268
269 static void ses_process_descriptor(struct enclosure_component *ecomp,
270 unsigned char *desc)
271 {
272 int eip = desc[0] & 0x10;
273 int invalid = desc[0] & 0x80;
274 enum scsi_protocol proto = desc[0] & 0x0f;
275 u64 addr = 0;
276 struct ses_component *scomp = ecomp->scratch;
277 unsigned char *d;
278
279 scomp->desc = desc;
280
281 if (invalid)
282 return;
283
284 switch (proto) {
285 case SCSI_PROTOCOL_SAS:
286 if (eip)
287 d = desc + 8;
288 else
289 d = desc + 4;
290 /* only take the phy0 addr */
291 addr = (u64)d[12] << 56 |
292 (u64)d[13] << 48 |
293 (u64)d[14] << 40 |
294 (u64)d[15] << 32 |
295 (u64)d[16] << 24 |
296 (u64)d[17] << 16 |
297 (u64)d[18] << 8 |
298 (u64)d[19];
299 break;
300 default:
301 break;
302 }
303 scomp->addr = addr;
304 }
305
306 struct efd {
307 u64 addr;
308 struct device *dev;
309 };
310
311 static int ses_enclosure_find_by_addr(struct enclosure_device *edev,
312 void *data)
313 {
314 struct efd *efd = data;
315 int i;
316 struct ses_component *scomp;
317
318 if (!edev->component[0].scratch)
319 return 0;
320
321 for (i = 0; i < edev->components; i++) {
322 scomp = edev->component[i].scratch;
323 if (scomp->addr != efd->addr)
324 continue;
325
326 enclosure_add_device(edev, i, efd->dev);
327 return 1;
328 }
329 return 0;
330 }
331
332 #define INIT_ALLOC_SIZE 32
333
334 static void ses_enclosure_data_process(struct enclosure_device *edev,
335 struct scsi_device *sdev,
336 int create)
337 {
338 u32 result;
339 unsigned char *buf = NULL, *type_ptr, *desc_ptr, *addl_desc_ptr = NULL;
340 int i, j, page7_len, len, components;
341 struct ses_device *ses_dev = edev->scratch;
342 int types = ses_dev->page1[10];
343 unsigned char *hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
344
345 if (!hdr_buf)
346 goto simple_populate;
347
348 /* re-read page 10 */
349 if (ses_dev->page10)
350 ses_recv_diag(sdev, 10, ses_dev->page10, ses_dev->page10_len);
351 /* Page 7 for the descriptors is optional */
352 result = ses_recv_diag(sdev, 7, hdr_buf, INIT_ALLOC_SIZE);
353 if (result)
354 goto simple_populate;
355
356 page7_len = len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
357 /* add 1 for trailing '\0' we'll use */
358 buf = kzalloc(len + 1, GFP_KERNEL);
359 if (!buf)
360 goto simple_populate;
361 result = ses_recv_diag(sdev, 7, buf, len);
362 if (result) {
363 simple_populate:
364 kfree(buf);
365 buf = NULL;
366 desc_ptr = NULL;
367 len = 0;
368 page7_len = 0;
369 } else {
370 desc_ptr = buf + 8;
371 len = (desc_ptr[2] << 8) + desc_ptr[3];
372 /* skip past overall descriptor */
373 desc_ptr += len + 4;
374 if (ses_dev->page10)
375 addl_desc_ptr = ses_dev->page10 + 8;
376 }
377 type_ptr = ses_dev->page1 + 12 + ses_dev->page1[11];
378 components = 0;
379 for (i = 0; i < types; i++, type_ptr += 4) {
380 for (j = 0; j < type_ptr[1]; j++) {
381 char *name = NULL;
382 struct enclosure_component *ecomp;
383
384 if (desc_ptr) {
385 if (desc_ptr >= buf + page7_len) {
386 desc_ptr = NULL;
387 } else {
388 len = (desc_ptr[2] << 8) + desc_ptr[3];
389 desc_ptr += 4;
390 /* Add trailing zero - pushes into
391 * reserved space */
392 desc_ptr[len] = '\0';
393 name = desc_ptr;
394 }
395 }
396 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
397 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE) {
398
399 if (create)
400 ecomp = enclosure_component_register(edev,
401 components++,
402 type_ptr[0],
403 name);
404 else
405 ecomp = &edev->component[components++];
406
407 if (!IS_ERR(ecomp) && addl_desc_ptr)
408 ses_process_descriptor(ecomp,
409 addl_desc_ptr);
410 }
411 if (desc_ptr)
412 desc_ptr += len;
413
414 if (addl_desc_ptr)
415 addl_desc_ptr += addl_desc_ptr[1] + 2;
416
417 }
418 }
419 kfree(buf);
420 kfree(hdr_buf);
421 }
422
423 static void ses_match_to_enclosure(struct enclosure_device *edev,
424 struct scsi_device *sdev)
425 {
426 unsigned char *buf;
427 unsigned char *desc;
428 unsigned int vpd_len;
429 struct efd efd = {
430 .addr = 0,
431 };
432
433 buf = kmalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
434 if (!buf || scsi_get_vpd_page(sdev, 0x83, buf, INIT_ALLOC_SIZE))
435 goto free;
436
437 ses_enclosure_data_process(edev, to_scsi_device(edev->edev.parent), 0);
438
439 vpd_len = ((buf[2] << 8) | buf[3]) + 4;
440 kfree(buf);
441 buf = kmalloc(vpd_len, GFP_KERNEL);
442 if (!buf ||scsi_get_vpd_page(sdev, 0x83, buf, vpd_len))
443 goto free;
444
445 desc = buf + 4;
446 while (desc < buf + vpd_len) {
447 enum scsi_protocol proto = desc[0] >> 4;
448 u8 code_set = desc[0] & 0x0f;
449 u8 piv = desc[1] & 0x80;
450 u8 assoc = (desc[1] & 0x30) >> 4;
451 u8 type = desc[1] & 0x0f;
452 u8 len = desc[3];
453
454 if (piv && code_set == 1 && assoc == 1
455 && proto == SCSI_PROTOCOL_SAS && type == 3 && len == 8)
456 efd.addr = (u64)desc[4] << 56 |
457 (u64)desc[5] << 48 |
458 (u64)desc[6] << 40 |
459 (u64)desc[7] << 32 |
460 (u64)desc[8] << 24 |
461 (u64)desc[9] << 16 |
462 (u64)desc[10] << 8 |
463 (u64)desc[11];
464
465 desc += len + 4;
466 }
467 if (!efd.addr)
468 goto free;
469
470 efd.dev = &sdev->sdev_gendev;
471
472 enclosure_for_each_device(ses_enclosure_find_by_addr, &efd);
473 free:
474 kfree(buf);
475 }
476
477 static int ses_intf_add(struct device *cdev,
478 struct class_interface *intf)
479 {
480 struct scsi_device *sdev = to_scsi_device(cdev->parent);
481 struct scsi_device *tmp_sdev;
482 unsigned char *buf = NULL, *hdr_buf, *type_ptr;
483 struct ses_device *ses_dev;
484 u32 result;
485 int i, types, len, components = 0;
486 int err = -ENOMEM;
487 struct enclosure_device *edev;
488 struct ses_component *scomp = NULL;
489
490 if (!scsi_device_enclosure(sdev)) {
491 /* not an enclosure, but might be in one */
492 struct enclosure_device *prev = NULL;
493
494 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
495 ses_match_to_enclosure(edev, sdev);
496 prev = edev;
497 }
498 return -ENODEV;
499 }
500
501 /* TYPE_ENCLOSURE prints a message in probe */
502 if (sdev->type != TYPE_ENCLOSURE)
503 sdev_printk(KERN_NOTICE, sdev, "Embedded Enclosure Device\n");
504
505 ses_dev = kzalloc(sizeof(*ses_dev), GFP_KERNEL);
506 hdr_buf = kzalloc(INIT_ALLOC_SIZE, GFP_KERNEL);
507 if (!hdr_buf || !ses_dev)
508 goto err_init_free;
509
510 result = ses_recv_diag(sdev, 1, hdr_buf, INIT_ALLOC_SIZE);
511 if (result)
512 goto recv_failed;
513
514 if (hdr_buf[1] != 0) {
515 sdev_printk(KERN_ERR, sdev,
516 "FIXME driver has no support for subenclosures (%d)\n",
517 hdr_buf[1]);
518 goto err_free;
519 }
520
521 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
522 buf = kzalloc(len, GFP_KERNEL);
523 if (!buf)
524 goto err_free;
525
526 result = ses_recv_diag(sdev, 1, buf, len);
527 if (result)
528 goto recv_failed;
529
530 types = buf[10];
531
532 type_ptr = buf + 12 + buf[11];
533
534 for (i = 0; i < types; i++, type_ptr += 4) {
535 if (type_ptr[0] == ENCLOSURE_COMPONENT_DEVICE ||
536 type_ptr[0] == ENCLOSURE_COMPONENT_ARRAY_DEVICE)
537 components += type_ptr[1];
538 }
539 ses_dev->page1 = buf;
540 ses_dev->page1_len = len;
541 buf = NULL;
542
543 result = ses_recv_diag(sdev, 2, hdr_buf, INIT_ALLOC_SIZE);
544 if (result)
545 goto recv_failed;
546
547 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
548 buf = kzalloc(len, GFP_KERNEL);
549 if (!buf)
550 goto err_free;
551
552 /* make sure getting page 2 actually works */
553 result = ses_recv_diag(sdev, 2, buf, len);
554 if (result)
555 goto recv_failed;
556 ses_dev->page2 = buf;
557 ses_dev->page2_len = len;
558 buf = NULL;
559
560 /* The additional information page --- allows us
561 * to match up the devices */
562 result = ses_recv_diag(sdev, 10, hdr_buf, INIT_ALLOC_SIZE);
563 if (!result) {
564
565 len = (hdr_buf[2] << 8) + hdr_buf[3] + 4;
566 buf = kzalloc(len, GFP_KERNEL);
567 if (!buf)
568 goto err_free;
569
570 result = ses_recv_diag(sdev, 10, buf, len);
571 if (result)
572 goto recv_failed;
573 ses_dev->page10 = buf;
574 ses_dev->page10_len = len;
575 buf = NULL;
576 }
577 scomp = kzalloc(sizeof(struct ses_component) * components, GFP_KERNEL);
578 if (!scomp)
579 goto err_free;
580
581 edev = enclosure_register(cdev->parent, dev_name(&sdev->sdev_gendev),
582 components, &ses_enclosure_callbacks);
583 if (IS_ERR(edev)) {
584 err = PTR_ERR(edev);
585 goto err_free;
586 }
587
588 kfree(hdr_buf);
589
590 edev->scratch = ses_dev;
591 for (i = 0; i < components; i++)
592 edev->component[i].scratch = scomp + i;
593
594 ses_enclosure_data_process(edev, sdev, 1);
595
596 /* see if there are any devices matching before
597 * we found the enclosure */
598 shost_for_each_device(tmp_sdev, sdev->host) {
599 if (tmp_sdev->lun != 0 || scsi_device_enclosure(tmp_sdev))
600 continue;
601 ses_match_to_enclosure(edev, tmp_sdev);
602 }
603
604 return 0;
605
606 recv_failed:
607 sdev_printk(KERN_ERR, sdev, "Failed to get diagnostic page 0x%x\n",
608 result);
609 err = -ENODEV;
610 err_free:
611 kfree(buf);
612 kfree(scomp);
613 kfree(ses_dev->page10);
614 kfree(ses_dev->page2);
615 kfree(ses_dev->page1);
616 err_init_free:
617 kfree(ses_dev);
618 kfree(hdr_buf);
619 sdev_printk(KERN_ERR, sdev, "Failed to bind enclosure %d\n", err);
620 return err;
621 }
622
623 static int ses_remove(struct device *dev)
624 {
625 return 0;
626 }
627
628 static void ses_intf_remove_component(struct scsi_device *sdev)
629 {
630 struct enclosure_device *edev, *prev = NULL;
631
632 while ((edev = enclosure_find(&sdev->host->shost_gendev, prev)) != NULL) {
633 prev = edev;
634 if (!enclosure_remove_device(edev, &sdev->sdev_gendev))
635 break;
636 }
637 if (edev)
638 put_device(&edev->edev);
639 }
640
641 static void ses_intf_remove_enclosure(struct scsi_device *sdev)
642 {
643 struct enclosure_device *edev;
644 struct ses_device *ses_dev;
645
646 /* exact match to this enclosure */
647 edev = enclosure_find(&sdev->sdev_gendev, NULL);
648 if (!edev)
649 return;
650
651 ses_dev = edev->scratch;
652 edev->scratch = NULL;
653
654 kfree(ses_dev->page10);
655 kfree(ses_dev->page1);
656 kfree(ses_dev->page2);
657 kfree(ses_dev);
658
659 kfree(edev->component[0].scratch);
660
661 put_device(&edev->edev);
662 enclosure_unregister(edev);
663 }
664
665 static void ses_intf_remove(struct device *cdev,
666 struct class_interface *intf)
667 {
668 struct scsi_device *sdev = to_scsi_device(cdev->parent);
669
670 if (!scsi_device_enclosure(sdev))
671 ses_intf_remove_component(sdev);
672 else
673 ses_intf_remove_enclosure(sdev);
674 }
675
676 static struct class_interface ses_interface = {
677 .add_dev = ses_intf_add,
678 .remove_dev = ses_intf_remove,
679 };
680
681 static struct scsi_driver ses_template = {
682 .owner = THIS_MODULE,
683 .gendrv = {
684 .name = "ses",
685 .probe = ses_probe,
686 .remove = ses_remove,
687 },
688 };
689
690 static int __init ses_init(void)
691 {
692 int err;
693
694 err = scsi_register_interface(&ses_interface);
695 if (err)
696 return err;
697
698 err = scsi_register_driver(&ses_template.gendrv);
699 if (err)
700 goto out_unreg;
701
702 return 0;
703
704 out_unreg:
705 scsi_unregister_interface(&ses_interface);
706 return err;
707 }
708
709 static void __exit ses_exit(void)
710 {
711 scsi_unregister_driver(&ses_template.gendrv);
712 scsi_unregister_interface(&ses_interface);
713 }
714
715 module_init(ses_init);
716 module_exit(ses_exit);
717
718 MODULE_ALIAS_SCSI_DEVICE(TYPE_ENCLOSURE);
719
720 MODULE_AUTHOR("James Bottomley");
721 MODULE_DESCRIPTION("SCSI Enclosure Services (ses) driver");
722 MODULE_LICENSE("GPL v2");
Tomato firmware and modifications.