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"
27 #define RDAC_RETRY_COUNT 5
32 * These struct definitions and the forming of the
33 * mode page were taken from the LSI RDAC 2.4 GPL'd
34 * driver, and then converted to Linux conventions.
36 #define RDAC_QUIESCENCE_TIME 20;
40 #define RDAC_PAGE_CODE_REDUNDANT_CONTROLLER 0x2c
43 * Controller modes definitions
45 #define RDAC_MODE_TRANSFER_SPECIFIED_LUNS 0x02
50 #define RDAC_FORCED_QUIESENCE 0x02
52 #define RDAC_TIMEOUT (60 * HZ)
53 #define RDAC_RETRIES 3
55 struct rdac_mode_6_hdr {
62 struct rdac_mode_10_hdr {
70 struct rdac_mode_common {
71 u8 controller_serial[16];
72 u8 alt_controller_serial[16];
75 u8 quiescence_timeout;
79 struct rdac_pg_legacy {
80 struct rdac_mode_6_hdr hdr;
83 struct rdac_mode_common common;
84 #define MODE6_MAX_LUN 32
85 u8 lun_table[MODE6_MAX_LUN];
91 struct rdac_pg_expanded {
92 struct rdac_mode_10_hdr hdr;
96 struct rdac_mode_common common;
104 u8 page_code; /* 0xC9 */
107 u8 page_id[4]; /* "vace" */
113 #define SUBSYS_ID_LEN 16
114 #define SLOT_ID_LEN 2
115 #define ARRAY_LABEL_LEN 31
119 u8 page_code; /* 0xC4 */
122 u8 page_id[4]; /* "subs" */
123 u8 subsys_id[SUBSYS_ID_LEN];
125 u8 slot_id[SLOT_ID_LEN];
129 struct rdac_controller {
130 u8 subsys_id[SUBSYS_ID_LEN];
131 u8 slot_id[SLOT_ID_LEN];
134 struct list_head node; /* list of all controllers */
136 struct rdac_pg_legacy legacy;
137 struct rdac_pg_expanded expanded;
140 u8 array_name[ARRAY_LABEL_LEN];
144 u8 page_code; /* 0xC8 */
147 u8 page_id[4]; /* "edid" */
151 u8 vol_user_label_len;
152 u8 vol_user_label[60];
153 u8 array_uniq_id_len;
154 u8 array_unique_id[16];
155 u8 array_user_label_len;
156 u8 array_user_label[60];
162 u8 page_code; /* 0xC2 */
165 u8 page_id[4]; /* "swr4" */
169 u8 max_lun_supported;
170 u8 partitions[239]; /* Total allocation length should be 0xFF */
173 struct rdac_dh_data {
174 struct rdac_controller *ctlr;
175 #define UNINITIALIZED_LUN (1 << 8)
177 #define RDAC_STATE_ACTIVE 0
178 #define RDAC_STATE_PASSIVE 1
181 #define RDAC_LUN_UNOWNED 0
182 #define RDAC_LUN_OWNED 1
183 #define RDAC_LUN_AVT 2
185 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
187 struct c2_inquiry c2;
188 struct c4_inquiry c4;
189 struct c8_inquiry c8;
190 struct c9_inquiry c9;
194 static const char *lun_state[] =
201 static LIST_HEAD(ctlr_list);
202 static DEFINE_SPINLOCK(list_lock);
205 * module parameter to enable rdac debug logging.
206 * 2 bits for each type of logging, only two types defined for now
207 * Can be enhanced if required at later point
209 static int rdac_logging = 1;
210 module_param(rdac_logging, int, S_IRUGO|S_IWUSR);
211 MODULE_PARM_DESC(rdac_logging, "A bit mask of rdac logging levels, "
212 "Default is 1 - failover logging enabled, "
213 "set it to 0xF to enable all the logs");
215 #define RDAC_LOG_FAILOVER 0
216 #define RDAC_LOG_SENSE 2
218 #define RDAC_LOG_BITS 2
220 #define RDAC_LOG_LEVEL(SHIFT) \
221 ((rdac_logging >> (SHIFT)) & ((1 << (RDAC_LOG_BITS)) - 1))
223 #define RDAC_LOG(SHIFT, sdev, f, arg...) \
225 if (unlikely(RDAC_LOG_LEVEL(SHIFT))) \
226 sdev_printk(KERN_INFO, sdev, RDAC_NAME ": " f "\n", ## arg); \
229 static inline struct rdac_dh_data *get_rdac_data(struct scsi_device *sdev)
231 struct scsi_dh_data *scsi_dh_data = sdev->scsi_dh_data;
232 BUG_ON(scsi_dh_data == NULL);
233 return ((struct rdac_dh_data *) scsi_dh_data->buf);
236 static struct request *get_rdac_req(struct scsi_device *sdev,
237 void *buffer, unsigned buflen, int rw)
240 struct request_queue *q = sdev->request_queue;
242 rq = blk_get_request(q, rw, GFP_NOIO);
245 sdev_printk(KERN_INFO, sdev,
246 "get_rdac_req: blk_get_request failed.\n");
250 if (buflen && blk_rq_map_kern(q, rq, buffer, buflen, GFP_NOIO)) {
252 sdev_printk(KERN_INFO, sdev,
253 "get_rdac_req: blk_rq_map_kern failed.\n");
257 rq->cmd_type = REQ_TYPE_BLOCK_PC;
258 rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
260 rq->retries = RDAC_RETRIES;
261 rq->timeout = RDAC_TIMEOUT;
266 static struct request *rdac_failover_get(struct scsi_device *sdev,
267 struct rdac_dh_data *h)
270 struct rdac_mode_common *common;
273 if (h->ctlr->use_ms10) {
274 struct rdac_pg_expanded *rdac_pg;
276 data_size = sizeof(struct rdac_pg_expanded);
277 rdac_pg = &h->ctlr->mode_select.expanded;
278 memset(rdac_pg, 0, data_size);
279 common = &rdac_pg->common;
280 rdac_pg->page_code = RDAC_PAGE_CODE_REDUNDANT_CONTROLLER + 0x40;
281 rdac_pg->subpage_code = 0x1;
282 rdac_pg->page_len[0] = 0x01;
283 rdac_pg->page_len[1] = 0x28;
284 rdac_pg->lun_table[h->lun] = 0x81;
286 struct rdac_pg_legacy *rdac_pg;
288 data_size = sizeof(struct rdac_pg_legacy);
289 rdac_pg = &h->ctlr->mode_select.legacy;
290 memset(rdac_pg, 0, data_size);
291 common = &rdac_pg->common;
292 rdac_pg->page_code = RDAC_PAGE_CODE_REDUNDANT_CONTROLLER;
293 rdac_pg->page_len = 0x68;
294 rdac_pg->lun_table[h->lun] = 0x81;
296 common->rdac_mode[1] = RDAC_MODE_TRANSFER_SPECIFIED_LUNS;
297 common->quiescence_timeout = RDAC_QUIESCENCE_TIME;
298 common->rdac_options = RDAC_FORCED_QUIESENCE;
300 /* get request for block layer packet command */
301 rq = get_rdac_req(sdev, &h->ctlr->mode_select, data_size, WRITE);
305 /* Prepare the command. */
306 if (h->ctlr->use_ms10) {
307 rq->cmd[0] = MODE_SELECT_10;
308 rq->cmd[7] = data_size >> 8;
309 rq->cmd[8] = data_size & 0xff;
311 rq->cmd[0] = MODE_SELECT;
312 rq->cmd[4] = data_size;
314 rq->cmd_len = COMMAND_SIZE(rq->cmd[0]);
316 rq->sense = h->sense;
317 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
323 static void release_controller(struct kref *kref)
325 struct rdac_controller *ctlr;
326 ctlr = container_of(kref, struct rdac_controller, kref);
328 spin_lock(&list_lock);
329 list_del(&ctlr->node);
330 spin_unlock(&list_lock);
334 static struct rdac_controller *get_controller(u8 *subsys_id, u8 *slot_id,
337 struct rdac_controller *ctlr, *tmp;
339 spin_lock(&list_lock);
341 list_for_each_entry(tmp, &ctlr_list, node) {
342 if ((memcmp(tmp->subsys_id, subsys_id, SUBSYS_ID_LEN) == 0) &&
343 (memcmp(tmp->slot_id, slot_id, SLOT_ID_LEN) == 0)) {
344 kref_get(&tmp->kref);
345 spin_unlock(&list_lock);
349 ctlr = kmalloc(sizeof(*ctlr), GFP_ATOMIC);
353 /* initialize fields of controller */
354 memcpy(ctlr->subsys_id, subsys_id, SUBSYS_ID_LEN);
355 memcpy(ctlr->slot_id, slot_id, SLOT_ID_LEN);
356 memcpy(ctlr->array_name, array_name, ARRAY_LABEL_LEN);
358 /* update the controller index */
359 if (slot_id[1] == 0x31)
364 kref_init(&ctlr->kref);
366 list_add(&ctlr->node, &ctlr_list);
368 spin_unlock(&list_lock);
372 static int submit_inquiry(struct scsi_device *sdev, int page_code,
373 unsigned int len, struct rdac_dh_data *h)
376 struct request_queue *q = sdev->request_queue;
377 int err = SCSI_DH_RES_TEMP_UNAVAIL;
379 rq = get_rdac_req(sdev, &h->inq, len, READ);
383 /* Prepare the command. */
384 rq->cmd[0] = INQUIRY;
386 rq->cmd[2] = page_code;
388 rq->cmd_len = COMMAND_SIZE(INQUIRY);
390 rq->sense = h->sense;
391 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
394 err = blk_execute_rq(q, NULL, rq, 1);
403 static int get_lun_info(struct scsi_device *sdev, struct rdac_dh_data *h,
407 struct c8_inquiry *inqp;
409 err = submit_inquiry(sdev, 0xC8, sizeof(struct c8_inquiry), h);
410 if (err == SCSI_DH_OK) {
412 if (inqp->page_code != 0xc8)
413 return SCSI_DH_NOSYS;
414 if (inqp->page_id[0] != 'e' || inqp->page_id[1] != 'd' ||
415 inqp->page_id[2] != 'i' || inqp->page_id[3] != 'd')
416 return SCSI_DH_NOSYS;
417 h->lun = inqp->lun[7]; /* Uses only the last byte */
419 for(i=0; i<ARRAY_LABEL_LEN-1; ++i)
420 *(array_name+i) = inqp->array_user_label[(2*i)+1];
422 *(array_name+ARRAY_LABEL_LEN-1) = '\0';
427 static int check_ownership(struct scsi_device *sdev, struct rdac_dh_data *h)
430 struct c9_inquiry *inqp;
432 h->lun_state = RDAC_LUN_UNOWNED;
433 h->state = RDAC_STATE_ACTIVE;
434 err = submit_inquiry(sdev, 0xC9, sizeof(struct c9_inquiry), h);
435 if (err == SCSI_DH_OK) {
437 if ((inqp->avte_cvp >> 7) == 0x1) {
438 /* LUN in AVT mode */
439 sdev_printk(KERN_NOTICE, sdev,
440 "%s: AVT mode detected\n",
442 h->lun_state = RDAC_LUN_AVT;
443 } else if ((inqp->avte_cvp & 0x1) != 0) {
444 /* LUN was owned by the controller */
445 h->lun_state = RDAC_LUN_OWNED;
449 if (h->lun_state == RDAC_LUN_UNOWNED)
450 h->state = RDAC_STATE_PASSIVE;
455 static int initialize_controller(struct scsi_device *sdev,
456 struct rdac_dh_data *h, char *array_name)
459 struct c4_inquiry *inqp;
461 err = submit_inquiry(sdev, 0xC4, sizeof(struct c4_inquiry), h);
462 if (err == SCSI_DH_OK) {
464 h->ctlr = get_controller(inqp->subsys_id, inqp->slot_id,
467 err = SCSI_DH_RES_TEMP_UNAVAIL;
472 static int set_mode_select(struct scsi_device *sdev, struct rdac_dh_data *h)
475 struct c2_inquiry *inqp;
477 err = submit_inquiry(sdev, 0xC2, sizeof(struct c2_inquiry), h);
478 if (err == SCSI_DH_OK) {
481 * If more than MODE6_MAX_LUN luns are supported, use
484 if (inqp->max_lun_supported >= MODE6_MAX_LUN)
485 h->ctlr->use_ms10 = 1;
487 h->ctlr->use_ms10 = 0;
492 static int mode_select_handle_sense(struct scsi_device *sdev,
493 unsigned char *sensebuf)
495 struct scsi_sense_hdr sense_hdr;
496 int err = SCSI_DH_IO, ret;
497 struct rdac_dh_data *h = get_rdac_data(sdev);
499 ret = scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE, &sense_hdr);
503 switch (sense_hdr.sense_key) {
505 case ABORTED_COMMAND:
510 if (sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x01)
511 /* LUN Not Ready and is in the Process of Becoming
516 case ILLEGAL_REQUEST:
517 if (sense_hdr.asc == 0x91 && sense_hdr.ascq == 0x36)
519 * Command Lock contention
527 RDAC_LOG(RDAC_LOG_FAILOVER, sdev, "array %s, ctlr %d, "
528 "MODE_SELECT returned with sense %02x/%02x/%02x",
529 (char *) h->ctlr->array_name, h->ctlr->index,
530 sense_hdr.sense_key, sense_hdr.asc, sense_hdr.ascq);
536 static int send_mode_select(struct scsi_device *sdev, struct rdac_dh_data *h)
539 struct request_queue *q = sdev->request_queue;
540 int err, retry_cnt = RDAC_RETRY_COUNT;
543 err = SCSI_DH_RES_TEMP_UNAVAIL;
544 rq = rdac_failover_get(sdev, h);
548 RDAC_LOG(RDAC_LOG_FAILOVER, sdev, "array %s, ctlr %d, "
549 "%s MODE_SELECT command",
550 (char *) h->ctlr->array_name, h->ctlr->index,
551 (retry_cnt == RDAC_RETRY_COUNT) ? "queueing" : "retrying");
553 err = blk_execute_rq(q, NULL, rq, 1);
555 if (err != SCSI_DH_OK) {
556 err = mode_select_handle_sense(sdev, h->sense);
557 if (err == SCSI_DH_RETRY && retry_cnt--)
560 if (err == SCSI_DH_OK) {
561 h->state = RDAC_STATE_ACTIVE;
562 RDAC_LOG(RDAC_LOG_FAILOVER, sdev, "array %s, ctlr %d, "
563 "MODE_SELECT completed",
564 (char *) h->ctlr->array_name, h->ctlr->index);
571 static int rdac_activate(struct scsi_device *sdev)
573 struct rdac_dh_data *h = get_rdac_data(sdev);
574 int err = SCSI_DH_OK;
576 err = check_ownership(sdev, h);
577 if (err != SCSI_DH_OK)
580 if (h->lun_state == RDAC_LUN_UNOWNED)
581 err = send_mode_select(sdev, h);
586 static int rdac_prep_fn(struct scsi_device *sdev, struct request *req)
588 struct rdac_dh_data *h = get_rdac_data(sdev);
589 int ret = BLKPREP_OK;
591 if (h->state != RDAC_STATE_ACTIVE) {
593 req->cmd_flags |= REQ_QUIET;
599 static int rdac_check_sense(struct scsi_device *sdev,
600 struct scsi_sense_hdr *sense_hdr)
602 struct rdac_dh_data *h = get_rdac_data(sdev);
604 RDAC_LOG(RDAC_LOG_SENSE, sdev, "array %s, ctlr %d, "
605 "I/O returned with sense %02x/%02x/%02x",
606 (char *) h->ctlr->array_name, h->ctlr->index,
607 sense_hdr->sense_key, sense_hdr->asc, sense_hdr->ascq);
609 switch (sense_hdr->sense_key) {
611 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x01)
612 /* LUN Not Ready - Logical Unit Not Ready and is in
613 * the process of becoming ready
616 return ADD_TO_MLQUEUE;
617 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x81)
618 /* LUN Not Ready - Storage firmware incompatible
619 * Manual code synchonisation required.
621 * Nothing we can do here. Try to bypass the path.
624 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0xA1)
625 /* LUN Not Ready - Quiescense in progress
627 * Just retry and wait.
629 return ADD_TO_MLQUEUE;
630 if (sense_hdr->asc == 0xA1 && sense_hdr->ascq == 0x02)
631 /* LUN Not Ready - Quiescense in progress
632 * or has been achieved
635 return ADD_TO_MLQUEUE;
637 case ILLEGAL_REQUEST:
638 if (sense_hdr->asc == 0x94 && sense_hdr->ascq == 0x01) {
639 /* Invalid Request - Current Logical Unit Ownership.
640 * Controller is not the current owner of the LUN,
641 * Fail the path, so that the other path be used.
643 h->state = RDAC_STATE_PASSIVE;
648 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
650 * Power On, Reset, or Bus Device Reset, just retry.
652 return ADD_TO_MLQUEUE;
653 if (sense_hdr->asc == 0x8b && sense_hdr->ascq == 0x02)
655 * Quiescence in progress , just retry.
657 return ADD_TO_MLQUEUE;
660 /* success just means we do not care what scsi-ml does */
661 return SCSI_RETURN_NOT_HANDLED;
664 static const struct scsi_dh_devlist rdac_dev_list[] = {
676 {"STK", "OPENstorage D280"},
678 {"SUN", "LCSM100_I"},
679 {"SUN", "LCSM100_S"},
680 {"SUN", "LCSM100_E"},
681 {"SUN", "LCSM100_F"},
686 {"LSI", "INF-01-00"},
687 {"ENGENIO", "INF-01-00"},
688 {"STK", "FLEXLINE 380"},
689 {"SUN", "CSM100_R_FC"},
693 static int rdac_bus_attach(struct scsi_device *sdev);
694 static void rdac_bus_detach(struct scsi_device *sdev);
696 static struct scsi_device_handler rdac_dh = {
698 .module = THIS_MODULE,
699 .devlist = rdac_dev_list,
700 .prep_fn = rdac_prep_fn,
701 .check_sense = rdac_check_sense,
702 .attach = rdac_bus_attach,
703 .detach = rdac_bus_detach,
704 .activate = rdac_activate,
707 static int rdac_bus_attach(struct scsi_device *sdev)
709 struct scsi_dh_data *scsi_dh_data;
710 struct rdac_dh_data *h;
713 char array_name[ARRAY_LABEL_LEN];
715 scsi_dh_data = kzalloc(sizeof(struct scsi_device_handler *)
716 + sizeof(*h) , GFP_KERNEL);
718 sdev_printk(KERN_ERR, sdev, "%s: Attach failed\n",
723 scsi_dh_data->scsi_dh = &rdac_dh;
724 h = (struct rdac_dh_data *) scsi_dh_data->buf;
725 h->lun = UNINITIALIZED_LUN;
726 h->state = RDAC_STATE_ACTIVE;
728 err = get_lun_info(sdev, h, array_name);
729 if (err != SCSI_DH_OK)
732 err = initialize_controller(sdev, h, array_name);
733 if (err != SCSI_DH_OK)
736 err = check_ownership(sdev, h);
737 if (err != SCSI_DH_OK)
740 err = set_mode_select(sdev, h);
741 if (err != SCSI_DH_OK)
744 if (!try_module_get(THIS_MODULE))
747 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
748 sdev->scsi_dh_data = scsi_dh_data;
749 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
751 sdev_printk(KERN_NOTICE, sdev,
753 RDAC_NAME, h->lun, lun_state[(int)h->lun_state]);
758 kref_put(&h->ctlr->kref, release_controller);
762 sdev_printk(KERN_ERR, sdev, "%s: not attached\n",
767 static void rdac_bus_detach( struct scsi_device *sdev )
769 struct scsi_dh_data *scsi_dh_data;
770 struct rdac_dh_data *h;
773 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
774 scsi_dh_data = sdev->scsi_dh_data;
775 sdev->scsi_dh_data = NULL;
776 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
778 h = (struct rdac_dh_data *) scsi_dh_data->buf;
780 kref_put(&h->ctlr->kref, release_controller);
782 module_put(THIS_MODULE);
783 sdev_printk(KERN_NOTICE, sdev, "%s: Detached\n", RDAC_NAME);
788 static int __init rdac_init(void)
792 r = scsi_register_device_handler(&rdac_dh);
794 printk(KERN_ERR "Failed to register scsi device handler.");
798 static void __exit rdac_exit(void)
800 scsi_unregister_device_handler(&rdac_dh);
803 module_init(rdac_init);
804 module_exit(rdac_exit);
806 MODULE_DESCRIPTION("Multipath LSI/Engenio RDAC driver");
807 MODULE_AUTHOR("Mike Christie, Chandra Seetharaman");
808 MODULE_LICENSE("GPL");