1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23#include <scsi/scsi.h>
24#include <scsi/scsi_eh.h>
25#include <scsi/scsi_dh.h>
26#include <scsi/scsi_device.h>
27
28#define CLARIION_NAME "emc"
29
30#define CLARIION_TRESPASS_PAGE 0x22
31#define CLARIION_BUFFER_SIZE 0xFC
32#define CLARIION_TIMEOUT (60 * HZ)
33#define CLARIION_RETRIES 3
34#define CLARIION_UNBOUND_LU -1
35#define CLARIION_SP_A 0
36#define CLARIION_SP_B 1
37
38
39#define CLARIION_SHORT_TRESPASS 1
40#define CLARIION_HONOR_RESERVATIONS 2
41
42
43#define CLARIION_LUN_UNINITIALIZED -1
44#define CLARIION_LUN_UNBOUND 0
45#define CLARIION_LUN_BOUND 1
46#define CLARIION_LUN_OWNED 2
47
48static unsigned char long_trespass[] = {
49 0, 0, 0, 0, 0, 0, 0, 0,
50 CLARIION_TRESPASS_PAGE,
51 0x09,
52 0x01,
53 0xff, 0xff,
54 0, 0, 0, 0, 0, 0
55};
56
57static unsigned char short_trespass[] = {
58 0, 0, 0, 0,
59 CLARIION_TRESPASS_PAGE,
60 0x02,
61 0x01,
62 0xff,
63};
64
65static const char * lun_state[] =
66{
67 "not bound",
68 "bound",
69 "owned",
70};
71
72struct clariion_dh_data {
73
74
75
76
77
78
79
80
81
82
83 unsigned flags;
84
85
86
87 unsigned char buffer[CLARIION_BUFFER_SIZE];
88
89
90
91
92 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
93 unsigned int senselen;
94
95
96
97 int lun_state;
98
99
100
101 int port;
102
103
104
105
106 int default_sp;
107
108
109
110
111 int current_sp;
112};
113
114static inline struct clariion_dh_data
115 *get_clariion_data(struct scsi_device *sdev)
116{
117 struct scsi_dh_data *scsi_dh_data = sdev->scsi_dh_data;
118 BUG_ON(scsi_dh_data == NULL);
119 return ((struct clariion_dh_data *) scsi_dh_data->buf);
120}
121
122
123
124
125static int trespass_endio(struct scsi_device *sdev, char *sense)
126{
127 int err = SCSI_DH_IO;
128 struct scsi_sense_hdr sshdr;
129
130 if (!scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)) {
131 sdev_printk(KERN_ERR, sdev, "%s: Found valid sense data 0x%2x, "
132 "0x%2x, 0x%2x while sending CLARiiON trespass "
133 "command.\n", CLARIION_NAME, sshdr.sense_key,
134 sshdr.asc, sshdr.ascq);
135
136 if ((sshdr.sense_key == 0x05) && (sshdr.asc == 0x04) &&
137 (sshdr.ascq == 0x00)) {
138
139
140
141
142 sdev_printk(KERN_INFO, sdev, "%s: Array Based Copy in "
143 "progress while sending CLARiiON trespass "
144 "command.\n", CLARIION_NAME);
145 err = SCSI_DH_DEV_TEMP_BUSY;
146 } else if ((sshdr.sense_key == 0x02) && (sshdr.asc == 0x04) &&
147 (sshdr.ascq == 0x03)) {
148
149
150
151
152 sdev_printk(KERN_INFO, sdev, "%s: Detected in-progress "
153 "ucode upgrade NDU operation while sending "
154 "CLARiiON trespass command.\n", CLARIION_NAME);
155 err = SCSI_DH_DEV_TEMP_BUSY;
156 } else
157 err = SCSI_DH_DEV_FAILED;
158 } else {
159 sdev_printk(KERN_INFO, sdev,
160 "%s: failed to send MODE SELECT, no sense available\n",
161 CLARIION_NAME);
162 }
163 return err;
164}
165
166static int parse_sp_info_reply(struct scsi_device *sdev,
167 struct clariion_dh_data *csdev)
168{
169 int err = SCSI_DH_OK;
170
171
172 if (csdev->buffer[48] != 0) {
173 sdev_printk(KERN_NOTICE, sdev, "%s: Detected in-progress "
174 "ucode upgrade NDU operation while finding "
175 "current active SP.", CLARIION_NAME);
176 err = SCSI_DH_DEV_TEMP_BUSY;
177 goto out;
178 }
179 if (csdev->buffer[4] > 2) {
180
181 sdev_printk(KERN_NOTICE, sdev,
182 "%s: invalid VPD page 0xC0 format\n",
183 CLARIION_NAME);
184 err = SCSI_DH_NOSYS;
185 goto out;
186 }
187 switch (csdev->buffer[28] & 0x0f) {
188 case 6:
189 sdev_printk(KERN_NOTICE, sdev,
190 "%s: ALUA failover mode detected\n",
191 CLARIION_NAME);
192 break;
193 case 4:
194
195 break;
196 default:
197 sdev_printk(KERN_WARNING, sdev,
198 "%s: Invalid failover mode %d\n",
199 CLARIION_NAME, csdev->buffer[28] & 0x0f);
200 err = SCSI_DH_NOSYS;
201 goto out;
202 }
203
204 csdev->default_sp = csdev->buffer[5];
205 csdev->lun_state = csdev->buffer[4];
206 csdev->current_sp = csdev->buffer[8];
207 csdev->port = csdev->buffer[7];
208
209out:
210 return err;
211}
212
213#define emc_default_str "FC (Legacy)"
214
215static char * parse_sp_model(struct scsi_device *sdev, unsigned char *buffer)
216{
217 unsigned char len = buffer[4] + 5;
218 char *sp_model = NULL;
219 unsigned char sp_len, serial_len;
220
221 if (len < 160) {
222 sdev_printk(KERN_WARNING, sdev,
223 "%s: Invalid information section length %d\n",
224 CLARIION_NAME, len);
225
226 if (!strncmp(buffer + 8, "DGC", 3)) {
227
228 sp_model = emc_default_str;
229 }
230 goto out;
231 }
232
233
234
235
236 serial_len = buffer[160];
237 if (serial_len == 0 || serial_len + 161 > len) {
238 sdev_printk(KERN_WARNING, sdev,
239 "%s: Invalid array serial number length %d\n",
240 CLARIION_NAME, serial_len);
241 goto out;
242 }
243 sp_len = buffer[99];
244 if (sp_len == 0 || serial_len + sp_len + 161 > len) {
245 sdev_printk(KERN_WARNING, sdev,
246 "%s: Invalid model number length %d\n",
247 CLARIION_NAME, sp_len);
248 goto out;
249 }
250 sp_model = &buffer[serial_len + 161];
251
252 while (sp_len > 1 && sp_model[sp_len - 1] == ' ')
253 sp_len--;
254
255 sp_model[sp_len] = '\0';
256
257out:
258 return sp_model;
259}
260
261
262
263
264
265
266
267
268static struct request *get_req(struct scsi_device *sdev, int cmd,
269 unsigned char *buffer)
270{
271 struct request *rq;
272 int len = 0;
273
274 rq = blk_get_request(sdev->request_queue,
275 (cmd == MODE_SELECT) ? WRITE : READ, GFP_NOIO);
276 if (!rq) {
277 sdev_printk(KERN_INFO, sdev, "get_req: blk_get_request failed");
278 return NULL;
279 }
280
281 rq->cmd_len = COMMAND_SIZE(cmd);
282 rq->cmd[0] = cmd;
283
284 switch (cmd) {
285 case MODE_SELECT:
286 len = sizeof(short_trespass);
287 rq->cmd_flags |= REQ_RW;
288 rq->cmd[1] = 0x10;
289 break;
290 case MODE_SELECT_10:
291 len = sizeof(long_trespass);
292 rq->cmd_flags |= REQ_RW;
293 rq->cmd[1] = 0x10;
294 break;
295 case INQUIRY:
296 len = CLARIION_BUFFER_SIZE;
297 memset(buffer, 0, len);
298 break;
299 default:
300 BUG_ON(1);
301 break;
302 }
303
304 rq->cmd[4] = len;
305 rq->cmd_type = REQ_TYPE_BLOCK_PC;
306 rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
307 REQ_FAILFAST_DRIVER;
308 rq->timeout = CLARIION_TIMEOUT;
309 rq->retries = CLARIION_RETRIES;
310
311 if (blk_rq_map_kern(rq->q, rq, buffer, len, GFP_NOIO)) {
312 blk_put_request(rq);
313 return NULL;
314 }
315
316 return rq;
317}
318
319static int send_inquiry_cmd(struct scsi_device *sdev, int page,
320 struct clariion_dh_data *csdev)
321{
322 struct request *rq = get_req(sdev, INQUIRY, csdev->buffer);
323 int err;
324
325 if (!rq)
326 return SCSI_DH_RES_TEMP_UNAVAIL;
327
328 rq->sense = csdev->sense;
329 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
330 rq->sense_len = csdev->senselen = 0;
331
332 rq->cmd[0] = INQUIRY;
333 if (page != 0) {
334 rq->cmd[1] = 1;
335 rq->cmd[2] = page;
336 }
337 err = blk_execute_rq(sdev->request_queue, NULL, rq, 1);
338 if (err == -EIO) {
339 sdev_printk(KERN_INFO, sdev,
340 "%s: failed to send %s INQUIRY: %x\n",
341 CLARIION_NAME, page?"EVPD":"standard",
342 rq->errors);
343 csdev->senselen = rq->sense_len;
344 err = SCSI_DH_IO;
345 }
346
347 blk_put_request(rq);
348
349 return err;
350}
351
352static int send_trespass_cmd(struct scsi_device *sdev,
353 struct clariion_dh_data *csdev)
354{
355 struct request *rq;
356 unsigned char *page22;
357 int err, len, cmd;
358
359 if (csdev->flags & CLARIION_SHORT_TRESPASS) {
360 page22 = short_trespass;
361 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
362
363 page22[6] |= 0x80;
364 len = sizeof(short_trespass);
365 cmd = MODE_SELECT;
366 } else {
367 page22 = long_trespass;
368 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
369
370 page22[10] |= 0x80;
371 len = sizeof(long_trespass);
372 cmd = MODE_SELECT_10;
373 }
374 BUG_ON((len > CLARIION_BUFFER_SIZE));
375 memcpy(csdev->buffer, page22, len);
376
377 rq = get_req(sdev, cmd, csdev->buffer);
378 if (!rq)
379 return SCSI_DH_RES_TEMP_UNAVAIL;
380
381 rq->sense = csdev->sense;
382 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
383 rq->sense_len = csdev->senselen = 0;
384
385 err = blk_execute_rq(sdev->request_queue, NULL, rq, 1);
386 if (err == -EIO) {
387 if (rq->sense_len) {
388 err = trespass_endio(sdev, csdev->sense);
389 } else {
390 sdev_printk(KERN_INFO, sdev,
391 "%s: failed to send MODE SELECT: %x\n",
392 CLARIION_NAME, rq->errors);
393 }
394 }
395
396 blk_put_request(rq);
397
398 return err;
399}
400
401static int clariion_check_sense(struct scsi_device *sdev,
402 struct scsi_sense_hdr *sense_hdr)
403{
404 switch (sense_hdr->sense_key) {
405 case NOT_READY:
406 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x03)
407
408
409
410
411
412
413
414
415
416
417
418
419
420 return SUCCESS;
421 break;
422 case ILLEGAL_REQUEST:
423 if (sense_hdr->asc == 0x25 && sense_hdr->ascq == 0x01)
424
425
426
427
428
429
430
431
432
433
434 return SUCCESS;
435 break;
436 case UNIT_ATTENTION:
437 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
438
439
440
441
442 return ADD_TO_MLQUEUE;
443 break;
444 }
445
446 return SCSI_RETURN_NOT_HANDLED;
447}
448
449static int clariion_prep_fn(struct scsi_device *sdev, struct request *req)
450{
451 struct clariion_dh_data *h = get_clariion_data(sdev);
452 int ret = BLKPREP_OK;
453
454 if (h->lun_state != CLARIION_LUN_OWNED) {
455 ret = BLKPREP_KILL;
456 req->cmd_flags |= REQ_QUIET;
457 }
458 return ret;
459
460}
461
462static int clariion_std_inquiry(struct scsi_device *sdev,
463 struct clariion_dh_data *csdev)
464{
465 int err;
466 char *sp_model;
467
468 err = send_inquiry_cmd(sdev, 0, csdev);
469 if (err != SCSI_DH_OK && csdev->senselen) {
470 struct scsi_sense_hdr sshdr;
471
472 if (scsi_normalize_sense(csdev->sense, SCSI_SENSE_BUFFERSIZE,
473 &sshdr)) {
474 sdev_printk(KERN_ERR, sdev, "%s: INQUIRY sense code "
475 "%02x/%02x/%02x\n", CLARIION_NAME,
476 sshdr.sense_key, sshdr.asc, sshdr.ascq);
477 }
478 err = SCSI_DH_IO;
479 goto out;
480 }
481
482 sp_model = parse_sp_model(sdev, csdev->buffer);
483 if (!sp_model) {
484 err = SCSI_DH_DEV_UNSUPP;
485 goto out;
486 }
487
488
489
490
491 if (!strlen(sp_model) || !strncmp(sp_model, "FC",2))
492 csdev->flags |= CLARIION_SHORT_TRESPASS;
493
494 sdev_printk(KERN_INFO, sdev,
495 "%s: detected Clariion %s, flags %x\n",
496 CLARIION_NAME, sp_model, csdev->flags);
497out:
498 return err;
499}
500
501static int clariion_send_inquiry(struct scsi_device *sdev,
502 struct clariion_dh_data *csdev)
503{
504 int err, retry = CLARIION_RETRIES;
505
506retry:
507 err = send_inquiry_cmd(sdev, 0xC0, csdev);
508 if (err != SCSI_DH_OK && csdev->senselen) {
509 struct scsi_sense_hdr sshdr;
510
511 err = scsi_normalize_sense(csdev->sense, SCSI_SENSE_BUFFERSIZE,
512 &sshdr);
513 if (!err)
514 return SCSI_DH_IO;
515
516 err = clariion_check_sense(sdev, &sshdr);
517 if (retry > 0 && err == ADD_TO_MLQUEUE) {
518 retry--;
519 goto retry;
520 }
521 sdev_printk(KERN_ERR, sdev, "%s: INQUIRY sense code "
522 "%02x/%02x/%02x\n", CLARIION_NAME,
523 sshdr.sense_key, sshdr.asc, sshdr.ascq);
524 err = SCSI_DH_IO;
525 } else {
526 err = parse_sp_info_reply(sdev, csdev);
527 }
528 return err;
529}
530
531static int clariion_activate(struct scsi_device *sdev)
532{
533 struct clariion_dh_data *csdev = get_clariion_data(sdev);
534 int result;
535
536 result = clariion_send_inquiry(sdev, csdev);
537 if (result != SCSI_DH_OK)
538 goto done;
539
540 if (csdev->lun_state == CLARIION_LUN_OWNED)
541 goto done;
542
543 result = send_trespass_cmd(sdev, csdev);
544 if (result != SCSI_DH_OK)
545 goto done;
546 sdev_printk(KERN_INFO, sdev,"%s: %s trespass command sent\n",
547 CLARIION_NAME,
548 csdev->flags&CLARIION_SHORT_TRESPASS?"short":"long" );
549
550
551 result = clariion_send_inquiry(sdev, csdev);
552 if (result != SCSI_DH_OK)
553 goto done;
554
555done:
556 sdev_printk(KERN_INFO, sdev,
557 "%s: at SP %c Port %d (%s, default SP %c)\n",
558 CLARIION_NAME, csdev->current_sp + 'A',
559 csdev->port, lun_state[csdev->lun_state],
560 csdev->default_sp + 'A');
561
562 return result;
563}
564
565
566
567
568
569
570static int clariion_set_params(struct scsi_device *sdev, const char *params)
571{
572 struct clariion_dh_data *csdev = get_clariion_data(sdev);
573 unsigned int hr = 0, st = 0, argc;
574 const char *p = params;
575 int result = SCSI_DH_OK;
576
577 if ((sscanf(params, "%u", &argc) != 1) || (argc != 2))
578 return -EINVAL;
579
580 while (*p++)
581 ;
582 if ((sscanf(p, "%u", &st) != 1) || (st > 1))
583 return -EINVAL;
584
585 while (*p++)
586 ;
587 if ((sscanf(p, "%u", &hr) != 1) || (hr > 1))
588 return -EINVAL;
589
590 if (st)
591 csdev->flags |= CLARIION_SHORT_TRESPASS;
592 else
593 csdev->flags &= ~CLARIION_SHORT_TRESPASS;
594
595 if (hr)
596 csdev->flags |= CLARIION_HONOR_RESERVATIONS;
597 else
598 csdev->flags &= ~CLARIION_HONOR_RESERVATIONS;
599
600
601
602
603
604
605 if (csdev->lun_state != CLARIION_LUN_OWNED)
606 goto done;
607
608 csdev->lun_state = CLARIION_LUN_UNINITIALIZED;
609 result = send_trespass_cmd(sdev, csdev);
610 if (result != SCSI_DH_OK)
611 goto done;
612
613
614 result = clariion_send_inquiry(sdev, csdev);
615
616done:
617 return result;
618}
619
620static const struct scsi_dh_devlist clariion_dev_list[] = {
621 {"DGC", "RAID"},
622 {"DGC", "DISK"},
623 {"DGC", "VRAID"},
624 {NULL, NULL},
625};
626
627static int clariion_bus_attach(struct scsi_device *sdev);
628static void clariion_bus_detach(struct scsi_device *sdev);
629
630static struct scsi_device_handler clariion_dh = {
631 .name = CLARIION_NAME,
632 .module = THIS_MODULE,
633 .devlist = clariion_dev_list,
634 .attach = clariion_bus_attach,
635 .detach = clariion_bus_detach,
636 .check_sense = clariion_check_sense,
637 .activate = clariion_activate,
638 .prep_fn = clariion_prep_fn,
639 .set_params = clariion_set_params,
640};
641
642static int clariion_bus_attach(struct scsi_device *sdev)
643{
644 struct scsi_dh_data *scsi_dh_data;
645 struct clariion_dh_data *h;
646 unsigned long flags;
647 int err;
648
649 scsi_dh_data = kzalloc(sizeof(struct scsi_device_handler *)
650 + sizeof(*h) , GFP_KERNEL);
651 if (!scsi_dh_data) {
652 sdev_printk(KERN_ERR, sdev, "%s: Attach failed\n",
653 CLARIION_NAME);
654 return -ENOMEM;
655 }
656
657 scsi_dh_data->scsi_dh = &clariion_dh;
658 h = (struct clariion_dh_data *) scsi_dh_data->buf;
659 h->lun_state = CLARIION_LUN_UNINITIALIZED;
660 h->default_sp = CLARIION_UNBOUND_LU;
661 h->current_sp = CLARIION_UNBOUND_LU;
662
663 err = clariion_std_inquiry(sdev, h);
664 if (err != SCSI_DH_OK)
665 goto failed;
666
667 err = clariion_send_inquiry(sdev, h);
668 if (err != SCSI_DH_OK)
669 goto failed;
670
671 if (!try_module_get(THIS_MODULE))
672 goto failed;
673
674 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
675 sdev->scsi_dh_data = scsi_dh_data;
676 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
677
678 sdev_printk(KERN_INFO, sdev,
679 "%s: connected to SP %c Port %d (%s, default SP %c)\n",
680 CLARIION_NAME, h->current_sp + 'A',
681 h->port, lun_state[h->lun_state],
682 h->default_sp + 'A');
683
684 return 0;
685
686failed:
687 kfree(scsi_dh_data);
688 sdev_printk(KERN_ERR, sdev, "%s: not attached\n",
689 CLARIION_NAME);
690 return -EINVAL;
691}
692
693static void clariion_bus_detach(struct scsi_device *sdev)
694{
695 struct scsi_dh_data *scsi_dh_data;
696 unsigned long flags;
697
698 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
699 scsi_dh_data = sdev->scsi_dh_data;
700 sdev->scsi_dh_data = NULL;
701 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
702
703 sdev_printk(KERN_NOTICE, sdev, "%s: Detached\n",
704 CLARIION_NAME);
705
706 kfree(scsi_dh_data);
707 module_put(THIS_MODULE);
708}
709
710static int __init clariion_init(void)
711{
712 int r;
713
714 r = scsi_register_device_handler(&clariion_dh);
715 if (r != 0)
716 printk(KERN_ERR "%s: Failed to register scsi device handler.",
717 CLARIION_NAME);
718 return r;
719}
720
721static void __exit clariion_exit(void)
722{
723 scsi_unregister_device_handler(&clariion_dh);
724}
725
726module_init(clariion_init);
727module_exit(clariion_exit);
728
729MODULE_DESCRIPTION("EMC CX/AX/FC-family driver");
730MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, Chandra Seetharaman <sekharan@us.ibm.com>");
731MODULE_LICENSE("GPL");
732