2 * Engenio/LSI RDAC SCSI Device Handler
4 * Copyright (C) 2005 Mike Christie. All rights reserved.
5 * Copyright (C) Chandra Seetharaman, IBM Corp. 2007
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include <scsi/scsi.h>
23 #include <scsi/scsi_eh.h>
24 #include <scsi/scsi_dh.h>
26 #define RDAC_NAME "rdac"
31 * These struct definitions and the forming of the
32 * mode page were taken from the LSI RDAC 2.4 GPL'd
33 * driver, and then converted to Linux conventions.
35 #define RDAC_QUIESCENCE_TIME 20;
39 #define RDAC_PAGE_CODE_REDUNDANT_CONTROLLER 0x2c
42 * Controller modes definitions
44 #define RDAC_MODE_TRANSFER_SPECIFIED_LUNS 0x02
49 #define RDAC_FORCED_QUIESENCE 0x02
51 #define RDAC_TIMEOUT (60 * HZ)
52 #define RDAC_RETRIES 3
54 struct rdac_mode_6_hdr {
61 struct rdac_mode_10_hdr {
69 struct rdac_mode_common {
70 u8 controller_serial[16];
71 u8 alt_controller_serial[16];
74 u8 quiescence_timeout;
78 struct rdac_pg_legacy {
79 struct rdac_mode_6_hdr hdr;
82 struct rdac_mode_common common;
83 #define MODE6_MAX_LUN 32
84 u8 lun_table[MODE6_MAX_LUN];
90 struct rdac_pg_expanded {
91 struct rdac_mode_10_hdr hdr;
95 struct rdac_mode_common common;
103 u8 page_code; /* 0xC9 */
106 u8 page_id[4]; /* "vace" */
112 #define SUBSYS_ID_LEN 16
113 #define SLOT_ID_LEN 2
117 u8 page_code; /* 0xC4 */
120 u8 page_id[4]; /* "subs" */
121 u8 subsys_id[SUBSYS_ID_LEN];
123 u8 slot_id[SLOT_ID_LEN];
127 struct rdac_controller {
128 u8 subsys_id[SUBSYS_ID_LEN];
129 u8 slot_id[SLOT_ID_LEN];
132 struct list_head node; /* list of all controllers */
134 struct rdac_pg_legacy legacy;
135 struct rdac_pg_expanded expanded;
140 u8 page_code; /* 0xC8 */
143 u8 page_id[4]; /* "edid" */
147 u8 vol_user_label_len;
148 u8 vol_user_label[60];
149 u8 array_uniq_id_len;
150 u8 array_unique_id[16];
151 u8 array_user_label_len;
152 u8 array_user_label[60];
158 u8 page_code; /* 0xC2 */
161 u8 page_id[4]; /* "swr4" */
165 u8 max_lun_supported;
166 u8 partitions[239]; /* Total allocation length should be 0xFF */
169 struct rdac_dh_data {
170 struct rdac_controller *ctlr;
171 #define UNINITIALIZED_LUN (1 << 8)
173 #define RDAC_STATE_ACTIVE 0
174 #define RDAC_STATE_PASSIVE 1
177 #define RDAC_LUN_UNOWNED 0
178 #define RDAC_LUN_OWNED 1
179 #define RDAC_LUN_AVT 2
181 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
183 struct c2_inquiry c2;
184 struct c4_inquiry c4;
185 struct c8_inquiry c8;
186 struct c9_inquiry c9;
190 static const char *lun_state[] =
197 static LIST_HEAD(ctlr_list);
198 static DEFINE_SPINLOCK(list_lock);
200 static inline struct rdac_dh_data *get_rdac_data(struct scsi_device *sdev)
202 struct scsi_dh_data *scsi_dh_data = sdev->scsi_dh_data;
203 BUG_ON(scsi_dh_data == NULL);
204 return ((struct rdac_dh_data *) scsi_dh_data->buf);
207 static struct request *get_rdac_req(struct scsi_device *sdev,
208 void *buffer, unsigned buflen, int rw)
211 struct request_queue *q = sdev->request_queue;
213 rq = blk_get_request(q, rw, GFP_NOIO);
216 sdev_printk(KERN_INFO, sdev,
217 "get_rdac_req: blk_get_request failed.\n");
221 if (buflen && blk_rq_map_kern(q, rq, buffer, buflen, GFP_NOIO)) {
223 sdev_printk(KERN_INFO, sdev,
224 "get_rdac_req: blk_rq_map_kern failed.\n");
228 rq->cmd_type = REQ_TYPE_BLOCK_PC;
229 rq->cmd_flags |= REQ_FAILFAST | REQ_NOMERGE;
230 rq->retries = RDAC_RETRIES;
231 rq->timeout = RDAC_TIMEOUT;
236 static struct request *rdac_failover_get(struct scsi_device *sdev,
237 struct rdac_dh_data *h)
240 struct rdac_mode_common *common;
243 if (h->ctlr->use_ms10) {
244 struct rdac_pg_expanded *rdac_pg;
246 data_size = sizeof(struct rdac_pg_expanded);
247 rdac_pg = &h->ctlr->mode_select.expanded;
248 memset(rdac_pg, 0, data_size);
249 common = &rdac_pg->common;
250 rdac_pg->page_code = RDAC_PAGE_CODE_REDUNDANT_CONTROLLER + 0x40;
251 rdac_pg->subpage_code = 0x1;
252 rdac_pg->page_len[0] = 0x01;
253 rdac_pg->page_len[1] = 0x28;
254 rdac_pg->lun_table[h->lun] = 0x81;
256 struct rdac_pg_legacy *rdac_pg;
258 data_size = sizeof(struct rdac_pg_legacy);
259 rdac_pg = &h->ctlr->mode_select.legacy;
260 memset(rdac_pg, 0, data_size);
261 common = &rdac_pg->common;
262 rdac_pg->page_code = RDAC_PAGE_CODE_REDUNDANT_CONTROLLER;
263 rdac_pg->page_len = 0x68;
264 rdac_pg->lun_table[h->lun] = 0x81;
266 common->rdac_mode[1] = RDAC_MODE_TRANSFER_SPECIFIED_LUNS;
267 common->quiescence_timeout = RDAC_QUIESCENCE_TIME;
268 common->rdac_options = RDAC_FORCED_QUIESENCE;
270 /* get request for block layer packet command */
271 rq = get_rdac_req(sdev, &h->ctlr->mode_select, data_size, WRITE);
275 /* Prepare the command. */
276 if (h->ctlr->use_ms10) {
277 rq->cmd[0] = MODE_SELECT_10;
278 rq->cmd[7] = data_size >> 8;
279 rq->cmd[8] = data_size & 0xff;
281 rq->cmd[0] = MODE_SELECT;
282 rq->cmd[4] = data_size;
284 rq->cmd_len = COMMAND_SIZE(rq->cmd[0]);
286 rq->sense = h->sense;
287 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
293 static void release_controller(struct kref *kref)
295 struct rdac_controller *ctlr;
296 ctlr = container_of(kref, struct rdac_controller, kref);
298 spin_lock(&list_lock);
299 list_del(&ctlr->node);
300 spin_unlock(&list_lock);
304 static struct rdac_controller *get_controller(u8 *subsys_id, u8 *slot_id)
306 struct rdac_controller *ctlr, *tmp;
308 spin_lock(&list_lock);
310 list_for_each_entry(tmp, &ctlr_list, node) {
311 if ((memcmp(tmp->subsys_id, subsys_id, SUBSYS_ID_LEN) == 0) &&
312 (memcmp(tmp->slot_id, slot_id, SLOT_ID_LEN) == 0)) {
313 kref_get(&tmp->kref);
314 spin_unlock(&list_lock);
318 ctlr = kmalloc(sizeof(*ctlr), GFP_ATOMIC);
322 /* initialize fields of controller */
323 memcpy(ctlr->subsys_id, subsys_id, SUBSYS_ID_LEN);
324 memcpy(ctlr->slot_id, slot_id, SLOT_ID_LEN);
325 kref_init(&ctlr->kref);
327 list_add(&ctlr->node, &ctlr_list);
329 spin_unlock(&list_lock);
333 static int submit_inquiry(struct scsi_device *sdev, int page_code,
334 unsigned int len, struct rdac_dh_data *h)
337 struct request_queue *q = sdev->request_queue;
338 int err = SCSI_DH_RES_TEMP_UNAVAIL;
340 rq = get_rdac_req(sdev, &h->inq, len, READ);
344 /* Prepare the command. */
345 rq->cmd[0] = INQUIRY;
347 rq->cmd[2] = page_code;
349 rq->cmd_len = COMMAND_SIZE(INQUIRY);
351 rq->sense = h->sense;
352 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
355 err = blk_execute_rq(q, NULL, rq, 1);
364 static int get_lun(struct scsi_device *sdev, struct rdac_dh_data *h)
367 struct c8_inquiry *inqp;
369 err = submit_inquiry(sdev, 0xC8, sizeof(struct c8_inquiry), h);
370 if (err == SCSI_DH_OK) {
372 if (inqp->page_code != 0xc8)
373 return SCSI_DH_NOSYS;
374 if (inqp->page_id[0] != 'e' || inqp->page_id[1] != 'd' ||
375 inqp->page_id[2] != 'i' || inqp->page_id[3] != 'd')
376 return SCSI_DH_NOSYS;
377 h->lun = inqp->lun[7]; /* Uses only the last byte */
382 static int check_ownership(struct scsi_device *sdev, struct rdac_dh_data *h)
385 struct c9_inquiry *inqp;
387 h->lun_state = RDAC_LUN_UNOWNED;
388 err = submit_inquiry(sdev, 0xC9, sizeof(struct c9_inquiry), h);
389 if (err == SCSI_DH_OK) {
391 if ((inqp->avte_cvp >> 7) == 0x1) {
392 /* LUN in AVT mode */
393 sdev_printk(KERN_NOTICE, sdev,
394 "%s: AVT mode detected\n",
396 h->lun_state = RDAC_LUN_AVT;
397 } else if ((inqp->avte_cvp & 0x1) != 0) {
398 /* LUN was owned by the controller */
399 h->lun_state = RDAC_LUN_OWNED;
406 static int initialize_controller(struct scsi_device *sdev,
407 struct rdac_dh_data *h)
410 struct c4_inquiry *inqp;
412 err = submit_inquiry(sdev, 0xC4, sizeof(struct c4_inquiry), h);
413 if (err == SCSI_DH_OK) {
415 h->ctlr = get_controller(inqp->subsys_id, inqp->slot_id);
417 err = SCSI_DH_RES_TEMP_UNAVAIL;
422 static int set_mode_select(struct scsi_device *sdev, struct rdac_dh_data *h)
425 struct c2_inquiry *inqp;
427 err = submit_inquiry(sdev, 0xC2, sizeof(struct c2_inquiry), h);
428 if (err == SCSI_DH_OK) {
431 * If more than MODE6_MAX_LUN luns are supported, use
434 if (inqp->max_lun_supported >= MODE6_MAX_LUN)
435 h->ctlr->use_ms10 = 1;
437 h->ctlr->use_ms10 = 0;
442 static int mode_select_handle_sense(struct scsi_device *sdev,
443 unsigned char *sensebuf)
445 struct scsi_sense_hdr sense_hdr;
446 int sense, err = SCSI_DH_IO, ret;
448 ret = scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE, &sense_hdr);
453 sense = (sense_hdr.sense_key << 16) | (sense_hdr.asc << 8) |
455 /* If it is retryable failure, submit the c9 inquiry again */
456 if (sense == 0x59136 || sense == 0x68b02 || sense == 0xb8b02 ||
458 /* 0x59136 - Command lock contention
459 * 0x[6b]8b02 - Quiesense in progress or achieved
460 * 0x62900 - Power On, Reset, or Bus Device Reset
466 sdev_printk(KERN_INFO, sdev,
467 "MODE_SELECT failed with sense 0x%x.\n", sense);
472 static int send_mode_select(struct scsi_device *sdev, struct rdac_dh_data *h)
475 struct request_queue *q = sdev->request_queue;
476 int err = SCSI_DH_RES_TEMP_UNAVAIL;
478 rq = rdac_failover_get(sdev, h);
482 sdev_printk(KERN_INFO, sdev, "queueing MODE_SELECT command.\n");
484 err = blk_execute_rq(q, NULL, rq, 1);
485 if (err != SCSI_DH_OK)
486 err = mode_select_handle_sense(sdev, h->sense);
487 if (err == SCSI_DH_OK)
488 h->state = RDAC_STATE_ACTIVE;
495 static int rdac_activate(struct scsi_device *sdev)
497 struct rdac_dh_data *h = get_rdac_data(sdev);
498 int err = SCSI_DH_OK;
500 err = check_ownership(sdev, h);
501 if (err != SCSI_DH_OK)
505 err = initialize_controller(sdev, h);
506 if (err != SCSI_DH_OK)
510 if (h->ctlr->use_ms10 == -1) {
511 err = set_mode_select(sdev, h);
512 if (err != SCSI_DH_OK)
515 if (h->lun_state == RDAC_LUN_UNOWNED)
516 err = send_mode_select(sdev, h);
521 static int rdac_prep_fn(struct scsi_device *sdev, struct request *req)
523 struct rdac_dh_data *h = get_rdac_data(sdev);
524 int ret = BLKPREP_OK;
526 if (h->state != RDAC_STATE_ACTIVE) {
528 req->cmd_flags |= REQ_QUIET;
534 static int rdac_check_sense(struct scsi_device *sdev,
535 struct scsi_sense_hdr *sense_hdr)
537 struct rdac_dh_data *h = get_rdac_data(sdev);
538 switch (sense_hdr->sense_key) {
540 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x81)
541 /* LUN Not Ready - Storage firmware incompatible
542 * Manual code synchonisation required.
544 * Nothing we can do here. Try to bypass the path.
547 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0xA1)
548 /* LUN Not Ready - Quiescense in progress
550 * Just retry and wait.
552 return ADD_TO_MLQUEUE;
554 case ILLEGAL_REQUEST:
555 if (sense_hdr->asc == 0x94 && sense_hdr->ascq == 0x01) {
556 /* Invalid Request - Current Logical Unit Ownership.
557 * Controller is not the current owner of the LUN,
558 * Fail the path, so that the other path be used.
560 h->state = RDAC_STATE_PASSIVE;
565 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
567 * Power On, Reset, or Bus Device Reset, just retry.
569 return ADD_TO_MLQUEUE;
572 /* success just means we do not care what scsi-ml does */
573 return SCSI_RETURN_NOT_HANDLED;
576 static const struct scsi_dh_devlist rdac_dev_list[] = {
588 {"STK", "OPENstorage D280"},
590 {"SUN", "LCSM100_F"},
596 static int rdac_bus_attach(struct scsi_device *sdev);
597 static void rdac_bus_detach(struct scsi_device *sdev);
599 static struct scsi_device_handler rdac_dh = {
601 .module = THIS_MODULE,
602 .devlist = rdac_dev_list,
603 .prep_fn = rdac_prep_fn,
604 .check_sense = rdac_check_sense,
605 .attach = rdac_bus_attach,
606 .detach = rdac_bus_detach,
607 .activate = rdac_activate,
610 static int rdac_bus_attach(struct scsi_device *sdev)
612 struct scsi_dh_data *scsi_dh_data;
613 struct rdac_dh_data *h;
617 scsi_dh_data = kzalloc(sizeof(struct scsi_device_handler *)
618 + sizeof(*h) , GFP_KERNEL);
620 sdev_printk(KERN_ERR, sdev, "%s: Attach failed\n",
625 scsi_dh_data->scsi_dh = &rdac_dh;
626 h = (struct rdac_dh_data *) scsi_dh_data->buf;
627 h->lun = UNINITIALIZED_LUN;
628 h->state = RDAC_STATE_ACTIVE;
630 err = get_lun(sdev, h);
631 if (err != SCSI_DH_OK)
634 err = check_ownership(sdev, h);
635 if (err != SCSI_DH_OK)
638 if (!try_module_get(THIS_MODULE))
641 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
642 sdev->scsi_dh_data = scsi_dh_data;
643 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
645 sdev_printk(KERN_NOTICE, sdev,
647 RDAC_NAME, h->lun, lun_state[(int)h->lun_state]);
653 sdev_printk(KERN_ERR, sdev, "%s: not attached\n",
658 static void rdac_bus_detach( struct scsi_device *sdev )
660 struct scsi_dh_data *scsi_dh_data;
661 struct rdac_dh_data *h;
664 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
665 scsi_dh_data = sdev->scsi_dh_data;
666 sdev->scsi_dh_data = NULL;
667 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
669 h = (struct rdac_dh_data *) scsi_dh_data->buf;
671 kref_put(&h->ctlr->kref, release_controller);
673 module_put(THIS_MODULE);
674 sdev_printk(KERN_NOTICE, sdev, "%s: Detached\n", RDAC_NAME);
679 static int __init rdac_init(void)
683 r = scsi_register_device_handler(&rdac_dh);
685 printk(KERN_ERR "Failed to register scsi device handler.");
689 static void __exit rdac_exit(void)
691 scsi_unregister_device_handler(&rdac_dh);
694 module_init(rdac_init);
695 module_exit(rdac_exit);
697 MODULE_DESCRIPTION("Multipath LSI/Engenio RDAC driver");
698 MODULE_AUTHOR("Mike Christie, Chandra Seetharaman");
699 MODULE_LICENSE("GPL");