1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Target driver for EMC CLARiiON AX/CX-series hardware.
4 * Based on code from Lars Marowsky-Bree <lmb@suse.de>
5 * and Ed Goggin <egoggin@emc.com>.
7 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
8 * Copyright (C) 2006 Mike Christie
10 #include <linux/slab.h>
11 #include <linux/module.h>
12 #include <scsi/scsi.h>
13 #include <scsi/scsi_eh.h>
14 #include <scsi/scsi_dh.h>
15 #include <scsi/scsi_device.h>
17 #define CLARIION_NAME "emc"
19 #define CLARIION_TRESPASS_PAGE 0x22
20 #define CLARIION_BUFFER_SIZE 0xFC
21 #define CLARIION_TIMEOUT (60 * HZ)
22 #define CLARIION_RETRIES 3
23 #define CLARIION_UNBOUND_LU -1
24 #define CLARIION_SP_A 0
25 #define CLARIION_SP_B 1
28 #define CLARIION_SHORT_TRESPASS 1
29 #define CLARIION_HONOR_RESERVATIONS 2
32 #define CLARIION_LUN_UNINITIALIZED -1
33 #define CLARIION_LUN_UNBOUND 0
34 #define CLARIION_LUN_BOUND 1
35 #define CLARIION_LUN_OWNED 2
37 static unsigned char long_trespass[] = {
38 0, 0, 0, 0, 0, 0, 0, 0,
39 CLARIION_TRESPASS_PAGE, /* Page code */
40 0x09, /* Page length - 2 */
41 0x01, /* Trespass code */
42 0xff, 0xff, /* Trespass target */
43 0, 0, 0, 0, 0, 0 /* Reserved bytes / unknown */
46 static unsigned char short_trespass[] = {
48 CLARIION_TRESPASS_PAGE, /* Page code */
49 0x02, /* Page length - 2 */
50 0x01, /* Trespass code */
51 0xff, /* Trespass target */
54 static const char * lun_state[] =
61 struct clariion_dh_data {
64 * CLARIION_SHORT_TRESPASS
65 * Use short trespass command (FC-series) or the long version
66 * (default for AX/CX CLARiiON arrays).
68 * CLARIION_HONOR_RESERVATIONS
69 * Whether or not (default) to honor SCSI reservations when
70 * initiating a switch-over.
74 * I/O buffer for both MODE_SELECT and INQUIRY commands.
76 unsigned char buffer[CLARIION_BUFFER_SIZE];
86 * which SP (A=0,B=1,UNBOUND=-1) is the default SP for this
91 * which SP (A=0,B=1,UNBOUND=-1) is the active SP for this
98 * Parse MODE_SELECT cmd reply.
100 static int trespass_endio(struct scsi_device *sdev,
101 struct scsi_sense_hdr *sshdr)
103 int err = SCSI_DH_IO;
105 sdev_printk(KERN_ERR, sdev, "%s: Found valid sense data 0x%2x, "
106 "0x%2x, 0x%2x while sending CLARiiON trespass "
107 "command.\n", CLARIION_NAME, sshdr->sense_key,
108 sshdr->asc, sshdr->ascq);
110 if (sshdr->sense_key == 0x05 && sshdr->asc == 0x04 &&
111 sshdr->ascq == 0x00) {
113 * Array based copy in progress -- do not send
114 * mode_select or copy will be aborted mid-stream.
116 sdev_printk(KERN_INFO, sdev, "%s: Array Based Copy in "
117 "progress while sending CLARiiON trespass "
118 "command.\n", CLARIION_NAME);
119 err = SCSI_DH_DEV_TEMP_BUSY;
120 } else if (sshdr->sense_key == 0x02 && sshdr->asc == 0x04 &&
121 sshdr->ascq == 0x03) {
123 * LUN Not Ready - Manual Intervention Required
124 * indicates in-progress ucode upgrade (NDU).
126 sdev_printk(KERN_INFO, sdev, "%s: Detected in-progress "
127 "ucode upgrade NDU operation while sending "
128 "CLARiiON trespass command.\n", CLARIION_NAME);
129 err = SCSI_DH_DEV_TEMP_BUSY;
131 err = SCSI_DH_DEV_FAILED;
135 static int parse_sp_info_reply(struct scsi_device *sdev,
136 struct clariion_dh_data *csdev)
138 int err = SCSI_DH_OK;
140 /* check for in-progress ucode upgrade (NDU) */
141 if (csdev->buffer[48] != 0) {
142 sdev_printk(KERN_NOTICE, sdev, "%s: Detected in-progress "
143 "ucode upgrade NDU operation while finding "
144 "current active SP.", CLARIION_NAME);
145 err = SCSI_DH_DEV_TEMP_BUSY;
148 if (csdev->buffer[4] > 2) {
149 /* Invalid buffer format */
150 sdev_printk(KERN_NOTICE, sdev,
151 "%s: invalid VPD page 0xC0 format\n",
156 switch (csdev->buffer[28] & 0x0f) {
158 sdev_printk(KERN_NOTICE, sdev,
159 "%s: ALUA failover mode detected\n",
166 sdev_printk(KERN_WARNING, sdev,
167 "%s: Invalid failover mode %d\n",
168 CLARIION_NAME, csdev->buffer[28] & 0x0f);
173 csdev->default_sp = csdev->buffer[5];
174 csdev->lun_state = csdev->buffer[4];
175 csdev->current_sp = csdev->buffer[8];
176 csdev->port = csdev->buffer[7];
177 if (csdev->lun_state == CLARIION_LUN_OWNED)
178 sdev->access_state = SCSI_ACCESS_STATE_OPTIMAL;
180 sdev->access_state = SCSI_ACCESS_STATE_STANDBY;
181 if (csdev->default_sp == csdev->current_sp)
182 sdev->access_state |= SCSI_ACCESS_STATE_PREFERRED;
187 #define emc_default_str "FC (Legacy)"
189 static char * parse_sp_model(struct scsi_device *sdev, unsigned char *buffer)
191 unsigned char len = buffer[4] + 5;
192 char *sp_model = NULL;
193 unsigned char sp_len, serial_len;
196 sdev_printk(KERN_WARNING, sdev,
197 "%s: Invalid information section length %d\n",
199 /* Check for old FC arrays */
200 if (!strncmp(buffer + 8, "DGC", 3)) {
201 /* Old FC array, not supporting extended information */
202 sp_model = emc_default_str;
208 * Parse extended information for SP model number
210 serial_len = buffer[160];
211 if (serial_len == 0 || serial_len + 161 > len) {
212 sdev_printk(KERN_WARNING, sdev,
213 "%s: Invalid array serial number length %d\n",
214 CLARIION_NAME, serial_len);
218 if (sp_len == 0 || serial_len + sp_len + 161 > len) {
219 sdev_printk(KERN_WARNING, sdev,
220 "%s: Invalid model number length %d\n",
221 CLARIION_NAME, sp_len);
224 sp_model = &buffer[serial_len + 161];
225 /* Strip whitespace at the end */
226 while (sp_len > 1 && sp_model[sp_len - 1] == ' ')
229 sp_model[sp_len] = '\0';
235 static int send_trespass_cmd(struct scsi_device *sdev,
236 struct clariion_dh_data *csdev)
238 unsigned char *page22;
239 unsigned char cdb[MAX_COMMAND_SIZE];
240 int err, res = SCSI_DH_OK, len;
241 struct scsi_sense_hdr sshdr;
242 blk_opf_t opf = REQ_OP_DRV_OUT | REQ_FAILFAST_DEV |
243 REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER;
244 const struct scsi_exec_args exec_args = {
248 if (csdev->flags & CLARIION_SHORT_TRESPASS) {
249 page22 = short_trespass;
250 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
251 /* Set Honor Reservations bit */
253 len = sizeof(short_trespass);
254 cdb[0] = MODE_SELECT;
258 page22 = long_trespass;
259 if (!(csdev->flags & CLARIION_HONOR_RESERVATIONS))
260 /* Set Honor Reservations bit */
262 len = sizeof(long_trespass);
263 cdb[0] = MODE_SELECT_10;
266 BUG_ON((len > CLARIION_BUFFER_SIZE));
267 memcpy(csdev->buffer, page22, len);
269 err = scsi_execute_cmd(sdev, cdb, opf, csdev->buffer, len,
270 CLARIION_TIMEOUT * HZ, CLARIION_RETRIES,
273 if (scsi_sense_valid(&sshdr))
274 res = trespass_endio(sdev, &sshdr);
276 sdev_printk(KERN_INFO, sdev,
277 "%s: failed to send MODE SELECT: %x\n",
286 static enum scsi_disposition clariion_check_sense(struct scsi_device *sdev,
287 struct scsi_sense_hdr *sense_hdr)
289 switch (sense_hdr->sense_key) {
291 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x03)
293 * LUN Not Ready - Manual Intervention Required
294 * indicates this is a passive path.
296 * FIXME: However, if this is seen and EVPD C0
297 * indicates that this is due to a NDU in
298 * progress, we should set FAIL_PATH too.
299 * This indicates we might have to do a SCSI
300 * inquiry in the end_io path. Ugh.
302 * Can return FAILED only when we want the error
303 * recovery process to kick in.
307 case ILLEGAL_REQUEST:
308 if (sense_hdr->asc == 0x25 && sense_hdr->ascq == 0x01)
310 * An array based copy is in progress. Do not
311 * fail the path, do not bypass to another PG,
312 * do not retry. Fail the IO immediately.
313 * (Actually this is the same conclusion as in
314 * the default handler, but lets make sure.)
316 * Can return FAILED only when we want the error
317 * recovery process to kick in.
322 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
324 * Unit Attention Code. This is the first IO
325 * to the new path, so just retry.
327 return ADD_TO_MLQUEUE;
331 return SCSI_RETURN_NOT_HANDLED;
334 static blk_status_t clariion_prep_fn(struct scsi_device *sdev,
337 struct clariion_dh_data *h = sdev->handler_data;
339 if (h->lun_state != CLARIION_LUN_OWNED) {
340 req->rq_flags |= RQF_QUIET;
341 return BLK_STS_IOERR;
347 static int clariion_std_inquiry(struct scsi_device *sdev,
348 struct clariion_dh_data *csdev)
350 int err = SCSI_DH_OK;
353 sp_model = parse_sp_model(sdev, sdev->inquiry);
355 err = SCSI_DH_DEV_UNSUPP;
360 * FC Series arrays do not support long trespass
362 if (!strlen(sp_model) || !strncmp(sp_model, "FC",2))
363 csdev->flags |= CLARIION_SHORT_TRESPASS;
365 sdev_printk(KERN_INFO, sdev,
366 "%s: detected Clariion %s, flags %x\n",
367 CLARIION_NAME, sp_model, csdev->flags);
372 static int clariion_send_inquiry(struct scsi_device *sdev,
373 struct clariion_dh_data *csdev)
375 int err = SCSI_DH_IO;
377 if (!scsi_get_vpd_page(sdev, 0xC0, csdev->buffer,
378 CLARIION_BUFFER_SIZE))
379 err = parse_sp_info_reply(sdev, csdev);
384 static int clariion_activate(struct scsi_device *sdev,
385 activate_complete fn, void *data)
387 struct clariion_dh_data *csdev = sdev->handler_data;
390 result = clariion_send_inquiry(sdev, csdev);
391 if (result != SCSI_DH_OK)
394 if (csdev->lun_state == CLARIION_LUN_OWNED)
397 result = send_trespass_cmd(sdev, csdev);
398 if (result != SCSI_DH_OK)
400 sdev_printk(KERN_INFO, sdev,"%s: %s trespass command sent\n",
402 csdev->flags&CLARIION_SHORT_TRESPASS?"short":"long" );
405 result = clariion_send_inquiry(sdev, csdev);
406 if (result != SCSI_DH_OK)
410 sdev_printk(KERN_INFO, sdev,
411 "%s: at SP %c Port %d (%s, default SP %c)\n",
412 CLARIION_NAME, csdev->current_sp + 'A',
413 csdev->port, lun_state[csdev->lun_state],
414 csdev->default_sp + 'A');
421 * params - parameters in the following format
422 * "no_of_params\0param1\0param2\0param3\0...\0"
423 * for example, string for 2 parameters with value 10 and 21
424 * is specified as "2\010\021\0".
426 static int clariion_set_params(struct scsi_device *sdev, const char *params)
428 struct clariion_dh_data *csdev = sdev->handler_data;
429 unsigned int hr = 0, st = 0, argc;
430 const char *p = params;
431 int result = SCSI_DH_OK;
433 if ((sscanf(params, "%u", &argc) != 1) || (argc != 2))
438 if ((sscanf(p, "%u", &st) != 1) || (st > 1))
443 if ((sscanf(p, "%u", &hr) != 1) || (hr > 1))
447 csdev->flags |= CLARIION_SHORT_TRESPASS;
449 csdev->flags &= ~CLARIION_SHORT_TRESPASS;
452 csdev->flags |= CLARIION_HONOR_RESERVATIONS;
454 csdev->flags &= ~CLARIION_HONOR_RESERVATIONS;
457 * If this path is owned, we have to send a trespass command
458 * with the new parameters. If not, simply return. Next trespass
459 * command would use the parameters.
461 if (csdev->lun_state != CLARIION_LUN_OWNED)
464 csdev->lun_state = CLARIION_LUN_UNINITIALIZED;
465 result = send_trespass_cmd(sdev, csdev);
466 if (result != SCSI_DH_OK)
470 result = clariion_send_inquiry(sdev, csdev);
476 static int clariion_bus_attach(struct scsi_device *sdev)
478 struct clariion_dh_data *h;
481 h = kzalloc(sizeof(*h) , GFP_KERNEL);
483 return SCSI_DH_NOMEM;
484 h->lun_state = CLARIION_LUN_UNINITIALIZED;
485 h->default_sp = CLARIION_UNBOUND_LU;
486 h->current_sp = CLARIION_UNBOUND_LU;
488 err = clariion_std_inquiry(sdev, h);
489 if (err != SCSI_DH_OK)
492 err = clariion_send_inquiry(sdev, h);
493 if (err != SCSI_DH_OK)
496 sdev_printk(KERN_INFO, sdev,
497 "%s: connected to SP %c Port %d (%s, default SP %c)\n",
498 CLARIION_NAME, h->current_sp + 'A',
499 h->port, lun_state[h->lun_state],
500 h->default_sp + 'A');
502 sdev->handler_data = h;
510 static void clariion_bus_detach(struct scsi_device *sdev)
512 kfree(sdev->handler_data);
513 sdev->handler_data = NULL;
516 static struct scsi_device_handler clariion_dh = {
517 .name = CLARIION_NAME,
518 .module = THIS_MODULE,
519 .attach = clariion_bus_attach,
520 .detach = clariion_bus_detach,
521 .check_sense = clariion_check_sense,
522 .activate = clariion_activate,
523 .prep_fn = clariion_prep_fn,
524 .set_params = clariion_set_params,
527 static int __init clariion_init(void)
531 r = scsi_register_device_handler(&clariion_dh);
533 printk(KERN_ERR "%s: Failed to register scsi device handler.",
538 static void __exit clariion_exit(void)
540 scsi_unregister_device_handler(&clariion_dh);
543 module_init(clariion_init);
544 module_exit(clariion_exit);
546 MODULE_DESCRIPTION("EMC CX/AX/FC-family driver");
547 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, Chandra Seetharaman <sekharan@us.ibm.com>");
548 MODULE_LICENSE("GPL");