2 * Target driver for EMC CLARiiON AX/CX-series hardware.
3 * Based on code from Lars Marowsky-Bree <lmb@suse.de>
4 * and Ed Goggin <egoggin@emc.com>.
6 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
7 * Copyright (C) 2006 Mike Christie
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2, or (at your option)
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; see the file COPYING. If not, write to
21 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <scsi/scsi.h>
26 #include <scsi/scsi_eh.h>
27 #include <scsi/scsi_dh.h>
28 #include <scsi/scsi_device.h>
30 #define CLARIION_NAME "emc"
32 #define CLARIION_TRESPASS_PAGE 0x22
33 #define CLARIION_BUFFER_SIZE 0xFC
34 #define CLARIION_TIMEOUT (60 * HZ)
35 #define CLARIION_RETRIES 3
36 #define CLARIION_UNBOUND_LU -1
37 #define CLARIION_SP_A 0
38 #define CLARIION_SP_B 1
41 #define CLARIION_SHORT_TRESPASS 1
42 #define CLARIION_HONOR_RESERVATIONS 2
45 #define CLARIION_LUN_UNINITIALIZED -1
46 #define CLARIION_LUN_UNBOUND 0
47 #define CLARIION_LUN_BOUND 1
48 #define CLARIION_LUN_OWNED 2
50 static unsigned char long_trespass[] = {
51 0, 0, 0, 0, 0, 0, 0, 0,
52 CLARIION_TRESPASS_PAGE, /* Page code */
53 0x09, /* Page length - 2 */
54 0x01, /* Trespass code */
55 0xff, 0xff, /* Trespass target */
56 0, 0, 0, 0, 0, 0 /* Reserved bytes / unknown */
59 static unsigned char short_trespass[] = {
61 CLARIION_TRESPASS_PAGE, /* Page code */
62 0x02, /* Page length - 2 */
63 0x01, /* Trespass code */
64 0xff, /* Trespass target */
67 static const char * lun_state[] =
74 struct clariion_dh_data {
77 * CLARIION_SHORT_TRESPASS
78 * Use short trespass command (FC-series) or the long version
79 * (default for AX/CX CLARiiON arrays).
81 * CLARIION_HONOR_RESERVATIONS
82 * Whether or not (default) to honor SCSI reservations when
83 * initiating a switch-over.
87 * I/O buffer for both MODE_SELECT and INQUIRY commands.
89 unsigned char buffer[CLARIION_BUFFER_SIZE];
91 * SCSI sense buffer for commands -- assumes serial issuance
92 * and completion sequence of all commands for same multipath.
94 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
95 unsigned int senselen;
105 * which SP (A=0,B=1,UNBOUND=-1) is the default SP for this
110 * which SP (A=0,B=1,UNBOUND=-1) is the active SP for this
117 * Parse MODE_SELECT cmd reply.
119 static int trespass_endio(struct scsi_device *sdev, char *sense)
121 int err = SCSI_DH_IO;
122 struct scsi_sense_hdr sshdr;
124 if (!scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)) {
125 sdev_printk(KERN_ERR, sdev, "%s: Found valid sense data 0x%2x, "
126 "0x%2x, 0x%2x while sending CLARiiON trespass "
127 "command.\n", CLARIION_NAME, sshdr.sense_key,
128 sshdr.asc, sshdr.ascq);
130 if ((sshdr.sense_key == 0x05) && (sshdr.asc == 0x04) &&
131 (sshdr.ascq == 0x00)) {
133 * Array based copy in progress -- do not send
134 * mode_select or copy will be aborted mid-stream.
136 sdev_printk(KERN_INFO, sdev, "%s: Array Based Copy in "
137 "progress while sending CLARiiON trespass "
138 "command.\n", CLARIION_NAME);
139 err = SCSI_DH_DEV_TEMP_BUSY;
140 } else if ((sshdr.sense_key == 0x02) && (sshdr.asc == 0x04) &&
141 (sshdr.ascq == 0x03)) {
143 * LUN Not Ready - Manual Intervention Required
144 * indicates in-progress ucode upgrade (NDU).
146 sdev_printk(KERN_INFO, sdev, "%s: Detected in-progress "
147 "ucode upgrade NDU operation while sending "
148 "CLARiiON trespass command.\n", CLARIION_NAME);
149 err = SCSI_DH_DEV_TEMP_BUSY;
151 err = SCSI_DH_DEV_FAILED;
153 sdev_printk(KERN_INFO, sdev,
154 "%s: failed to send MODE SELECT, no sense available\n",
160 static int parse_sp_info_reply(struct scsi_device *sdev,
161 struct clariion_dh_data *csdev)
163 int err = SCSI_DH_OK;
165 /* check for in-progress ucode upgrade (NDU) */
166 if (csdev->buffer[48] != 0) {
167 sdev_printk(KERN_NOTICE, sdev, "%s: Detected in-progress "
168 "ucode upgrade NDU operation while finding "
169 "current active SP.", CLARIION_NAME);
170 err = SCSI_DH_DEV_TEMP_BUSY;
173 if (csdev->buffer[4] > 2) {
174 /* Invalid buffer format */
175 sdev_printk(KERN_NOTICE, sdev,
176 "%s: invalid VPD page 0xC0 format\n",
181 switch (csdev->buffer[28] & 0x0f) {
183 sdev_printk(KERN_NOTICE, sdev,
184 "%s: ALUA failover mode detected\n",
191 sdev_printk(KERN_WARNING, sdev,
192 "%s: Invalid failover mode %d\n",
193 CLARIION_NAME, csdev->buffer[28] & 0x0f);
198 csdev->default_sp = csdev->buffer[5];
199 csdev->lun_state = csdev->buffer[4];
200 csdev->current_sp = csdev->buffer[8];
201 csdev->port = csdev->buffer[7];
202 if (csdev->lun_state == CLARIION_LUN_OWNED)
203 sdev->access_state = SCSI_ACCESS_STATE_OPTIMAL;
205 sdev->access_state = SCSI_ACCESS_STATE_STANDBY;
206 if (csdev->default_sp == csdev->current_sp)
207 sdev->access_state |= SCSI_ACCESS_STATE_PREFERRED;
212 #define emc_default_str "FC (Legacy)"
214 static char * parse_sp_model(struct scsi_device *sdev, unsigned char *buffer)
216 unsigned char len = buffer[4] + 5;
217 char *sp_model = NULL;
218 unsigned char sp_len, serial_len;
221 sdev_printk(KERN_WARNING, sdev,
222 "%s: Invalid information section length %d\n",
224 /* Check for old FC arrays */
225 if (!strncmp(buffer + 8, "DGC", 3)) {
226 /* Old FC array, not supporting extended information */
227 sp_model = emc_default_str;
233 * Parse extended information for SP model number
235 serial_len = buffer[160];
236 if (serial_len == 0 || serial_len + 161 > len) {
237 sdev_printk(KERN_WARNING, sdev,
238 "%s: Invalid array serial number length %d\n",
239 CLARIION_NAME, serial_len);
243 if (sp_len == 0 || serial_len + sp_len + 161 > len) {
244 sdev_printk(KERN_WARNING, sdev,
245 "%s: Invalid model number length %d\n",
246 CLARIION_NAME, sp_len);
249 sp_model = &buffer[serial_len + 161];
250 /* Strip whitespace at the end */
251 while (sp_len > 1 && sp_model[sp_len - 1] == ' ')
254 sp_model[sp_len] = '\0';
261 * Get block request for REQ_BLOCK_PC command issued to path. Currently
262 * limited to MODE_SELECT (trespass) and INQUIRY (VPD page 0xC0) commands.
264 * Uses data and sense buffers in hardware handler context structure and
265 * assumes serial servicing of commands, both issuance and completion.
267 static struct request *get_req(struct scsi_device *sdev, int cmd,
268 unsigned char *buffer)
273 rq = blk_get_request(sdev->request_queue,
274 (cmd != INQUIRY) ? WRITE : READ, GFP_NOIO);
276 sdev_printk(KERN_INFO, sdev, "get_req: blk_get_request failed");
280 blk_rq_set_block_pc(rq);
281 rq->cmd_len = COMMAND_SIZE(cmd);
286 len = sizeof(short_trespass);
291 len = sizeof(long_trespass);
296 len = CLARIION_BUFFER_SIZE;
298 memset(buffer, 0, len);
305 rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
307 rq->timeout = CLARIION_TIMEOUT;
308 rq->retries = CLARIION_RETRIES;
310 if (blk_rq_map_kern(rq->q, rq, buffer, len, GFP_NOIO)) {
318 static int send_inquiry_cmd(struct scsi_device *sdev, int page,
319 struct clariion_dh_data *csdev)
321 struct request *rq = get_req(sdev, INQUIRY, csdev->buffer);
325 return SCSI_DH_RES_TEMP_UNAVAIL;
327 rq->sense = csdev->sense;
328 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
329 rq->sense_len = csdev->senselen = 0;
331 rq->cmd[0] = INQUIRY;
336 err = blk_execute_rq(sdev->request_queue, NULL, rq, 1);
338 sdev_printk(KERN_INFO, sdev,
339 "%s: failed to send %s INQUIRY: %x\n",
340 CLARIION_NAME, page?"EVPD":"standard",
342 csdev->senselen = rq->sense_len;
351 static int send_trespass_cmd(struct scsi_device *sdev,
352 struct clariion_dh_data *csdev)
355 unsigned char *page22;
358 if (csdev->flags & CLARIION_SHORT_TRESPASS) {
359 page22 = short_trespass;
360 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
361 /* Set Honor Reservations bit */
363 len = sizeof(short_trespass);
366 page22 = long_trespass;
367 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
368 /* Set Honor Reservations bit */
370 len = sizeof(long_trespass);
371 cmd = MODE_SELECT_10;
373 BUG_ON((len > CLARIION_BUFFER_SIZE));
374 memcpy(csdev->buffer, page22, len);
376 rq = get_req(sdev, cmd, csdev->buffer);
378 return SCSI_DH_RES_TEMP_UNAVAIL;
380 rq->sense = csdev->sense;
381 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
382 rq->sense_len = csdev->senselen = 0;
384 err = blk_execute_rq(sdev->request_queue, NULL, rq, 1);
387 err = trespass_endio(sdev, csdev->sense);
389 sdev_printk(KERN_INFO, sdev,
390 "%s: failed to send MODE SELECT: %x\n",
391 CLARIION_NAME, rq->errors);
400 static int clariion_check_sense(struct scsi_device *sdev,
401 struct scsi_sense_hdr *sense_hdr)
403 switch (sense_hdr->sense_key) {
405 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x03)
407 * LUN Not Ready - Manual Intervention Required
408 * indicates this is a passive path.
410 * FIXME: However, if this is seen and EVPD C0
411 * indicates that this is due to a NDU in
412 * progress, we should set FAIL_PATH too.
413 * This indicates we might have to do a SCSI
414 * inquiry in the end_io path. Ugh.
416 * Can return FAILED only when we want the error
417 * recovery process to kick in.
421 case ILLEGAL_REQUEST:
422 if (sense_hdr->asc == 0x25 && sense_hdr->ascq == 0x01)
424 * An array based copy is in progress. Do not
425 * fail the path, do not bypass to another PG,
426 * do not retry. Fail the IO immediately.
427 * (Actually this is the same conclusion as in
428 * the default handler, but lets make sure.)
430 * Can return FAILED only when we want the error
431 * recovery process to kick in.
436 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
438 * Unit Attention Code. This is the first IO
439 * to the new path, so just retry.
441 return ADD_TO_MLQUEUE;
445 return SCSI_RETURN_NOT_HANDLED;
448 static int clariion_prep_fn(struct scsi_device *sdev, struct request *req)
450 struct clariion_dh_data *h = sdev->handler_data;
451 int ret = BLKPREP_OK;
453 if (h->lun_state != CLARIION_LUN_OWNED) {
455 req->cmd_flags |= REQ_QUIET;
461 static int clariion_std_inquiry(struct scsi_device *sdev,
462 struct clariion_dh_data *csdev)
464 int err = SCSI_DH_OK;
467 err = send_inquiry_cmd(sdev, 0, csdev);
468 if (err != SCSI_DH_OK && csdev->senselen) {
469 struct scsi_sense_hdr sshdr;
471 if (scsi_normalize_sense(csdev->sense, SCSI_SENSE_BUFFERSIZE,
473 sdev_printk(KERN_ERR, sdev, "%s: INQUIRY sense code "
474 "%02x/%02x/%02x\n", CLARIION_NAME,
475 sshdr.sense_key, sshdr.asc, sshdr.ascq);
481 sp_model = parse_sp_model(sdev, csdev->buffer);
483 err = SCSI_DH_DEV_UNSUPP;
488 * FC Series arrays do not support long trespass
490 if (!strlen(sp_model) || !strncmp(sp_model, "FC",2))
491 csdev->flags |= CLARIION_SHORT_TRESPASS;
493 sdev_printk(KERN_INFO, sdev,
494 "%s: detected Clariion %s, flags %x\n",
495 CLARIION_NAME, sp_model, csdev->flags);
500 static int clariion_send_inquiry(struct scsi_device *sdev,
501 struct clariion_dh_data *csdev)
503 int err, retry = CLARIION_RETRIES;
506 err = send_inquiry_cmd(sdev, 0xC0, csdev);
507 if (err != SCSI_DH_OK && csdev->senselen) {
508 struct scsi_sense_hdr sshdr;
510 err = scsi_normalize_sense(csdev->sense, SCSI_SENSE_BUFFERSIZE,
515 err = clariion_check_sense(sdev, &sshdr);
516 if (retry > 0 && err == ADD_TO_MLQUEUE) {
520 sdev_printk(KERN_ERR, sdev, "%s: INQUIRY sense code "
521 "%02x/%02x/%02x\n", CLARIION_NAME,
522 sshdr.sense_key, sshdr.asc, sshdr.ascq);
525 err = parse_sp_info_reply(sdev, csdev);
530 static int clariion_activate(struct scsi_device *sdev,
531 activate_complete fn, void *data)
533 struct clariion_dh_data *csdev = sdev->handler_data;
536 result = clariion_send_inquiry(sdev, csdev);
537 if (result != SCSI_DH_OK)
540 if (csdev->lun_state == CLARIION_LUN_OWNED)
543 result = send_trespass_cmd(sdev, csdev);
544 if (result != SCSI_DH_OK)
546 sdev_printk(KERN_INFO, sdev,"%s: %s trespass command sent\n",
548 csdev->flags&CLARIION_SHORT_TRESPASS?"short":"long" );
551 result = clariion_send_inquiry(sdev, csdev);
552 if (result != SCSI_DH_OK)
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');
567 * params - parameters in the following format
568 * "no_of_params\0param1\0param2\0param3\0...\0"
569 * for example, string for 2 parameters with value 10 and 21
570 * is specified as "2\010\021\0".
572 static int clariion_set_params(struct scsi_device *sdev, const char *params)
574 struct clariion_dh_data *csdev = sdev->handler_data;
575 unsigned int hr = 0, st = 0, argc;
576 const char *p = params;
577 int result = SCSI_DH_OK;
579 if ((sscanf(params, "%u", &argc) != 1) || (argc != 2))
584 if ((sscanf(p, "%u", &st) != 1) || (st > 1))
589 if ((sscanf(p, "%u", &hr) != 1) || (hr > 1))
593 csdev->flags |= CLARIION_SHORT_TRESPASS;
595 csdev->flags &= ~CLARIION_SHORT_TRESPASS;
598 csdev->flags |= CLARIION_HONOR_RESERVATIONS;
600 csdev->flags &= ~CLARIION_HONOR_RESERVATIONS;
603 * If this path is owned, we have to send a trespass command
604 * with the new parameters. If not, simply return. Next trespass
605 * command would use the parameters.
607 if (csdev->lun_state != CLARIION_LUN_OWNED)
610 csdev->lun_state = CLARIION_LUN_UNINITIALIZED;
611 result = send_trespass_cmd(sdev, csdev);
612 if (result != SCSI_DH_OK)
616 result = clariion_send_inquiry(sdev, csdev);
622 static int clariion_bus_attach(struct scsi_device *sdev)
624 struct clariion_dh_data *h;
627 h = kzalloc(sizeof(*h) , GFP_KERNEL);
630 h->lun_state = CLARIION_LUN_UNINITIALIZED;
631 h->default_sp = CLARIION_UNBOUND_LU;
632 h->current_sp = CLARIION_UNBOUND_LU;
634 err = clariion_std_inquiry(sdev, h);
635 if (err != SCSI_DH_OK)
638 err = clariion_send_inquiry(sdev, h);
639 if (err != SCSI_DH_OK)
642 sdev_printk(KERN_INFO, sdev,
643 "%s: connected to SP %c Port %d (%s, default SP %c)\n",
644 CLARIION_NAME, h->current_sp + 'A',
645 h->port, lun_state[h->lun_state],
646 h->default_sp + 'A');
648 sdev->handler_data = h;
656 static void clariion_bus_detach(struct scsi_device *sdev)
658 kfree(sdev->handler_data);
659 sdev->handler_data = NULL;
662 static struct scsi_device_handler clariion_dh = {
663 .name = CLARIION_NAME,
664 .module = THIS_MODULE,
665 .attach = clariion_bus_attach,
666 .detach = clariion_bus_detach,
667 .check_sense = clariion_check_sense,
668 .activate = clariion_activate,
669 .prep_fn = clariion_prep_fn,
670 .set_params = clariion_set_params,
673 static int __init clariion_init(void)
677 r = scsi_register_device_handler(&clariion_dh);
679 printk(KERN_ERR "%s: Failed to register scsi device handler.",
684 static void __exit clariion_exit(void)
686 scsi_unregister_device_handler(&clariion_dh);
689 module_init(clariion_init);
690 module_exit(clariion_exit);
692 MODULE_DESCRIPTION("EMC CX/AX/FC-family driver");
693 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, Chandra Seetharaman <sekharan@us.ibm.com>");
694 MODULE_LICENSE("GPL");