2 * SuperTrak EX Series Storage Controller driver for Linux
4 * Copyright (C) 2005, 2006 Promise Technology Inc.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 * Ed Lin <promise_linux@promise.com>
16 #include <linux/init.h>
17 #include <linux/errno.h>
18 #include <linux/kernel.h>
19 #include <linux/delay.h>
20 #include <linux/time.h>
21 #include <linux/pci.h>
22 #include <linux/blkdev.h>
23 #include <linux/interrupt.h>
24 #include <linux/types.h>
25 #include <linux/module.h>
26 #include <linux/spinlock.h>
29 #include <asm/byteorder.h>
30 #include <scsi/scsi.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <scsi/scsi_host.h>
34 #include <scsi/scsi_tcq.h>
35 #include <scsi/scsi_dbg.h>
37 #define DRV_NAME "stex"
38 #define ST_DRIVER_VERSION "3.6.0000.1"
39 #define ST_VER_MAJOR 3
40 #define ST_VER_MINOR 6
42 #define ST_BUILD_VER 1
45 /* MU register offset */
46 IMR0 = 0x10, /* MU_INBOUND_MESSAGE_REG0 */
47 IMR1 = 0x14, /* MU_INBOUND_MESSAGE_REG1 */
48 OMR0 = 0x18, /* MU_OUTBOUND_MESSAGE_REG0 */
49 OMR1 = 0x1c, /* MU_OUTBOUND_MESSAGE_REG1 */
50 IDBL = 0x20, /* MU_INBOUND_DOORBELL */
51 IIS = 0x24, /* MU_INBOUND_INTERRUPT_STATUS */
52 IIM = 0x28, /* MU_INBOUND_INTERRUPT_MASK */
53 ODBL = 0x2c, /* MU_OUTBOUND_DOORBELL */
54 OIS = 0x30, /* MU_OUTBOUND_INTERRUPT_STATUS */
55 OIM = 0x3c, /* MU_OUTBOUND_INTERRUPT_MASK */
57 /* MU register value */
58 MU_INBOUND_DOORBELL_HANDSHAKE = 1,
59 MU_INBOUND_DOORBELL_REQHEADCHANGED = 2,
60 MU_INBOUND_DOORBELL_STATUSTAILCHANGED = 4,
61 MU_INBOUND_DOORBELL_HMUSTOPPED = 8,
62 MU_INBOUND_DOORBELL_RESET = 16,
64 MU_OUTBOUND_DOORBELL_HANDSHAKE = 1,
65 MU_OUTBOUND_DOORBELL_REQUESTTAILCHANGED = 2,
66 MU_OUTBOUND_DOORBELL_STATUSHEADCHANGED = 4,
67 MU_OUTBOUND_DOORBELL_BUSCHANGE = 8,
68 MU_OUTBOUND_DOORBELL_HASEVENT = 16,
71 MU_STATE_STARTING = 1,
72 MU_STATE_FMU_READY_FOR_HANDSHAKE = 2,
73 MU_STATE_SEND_HANDSHAKE_FRAME = 3,
75 MU_STATE_RESETTING = 5,
78 MU_HANDSHAKE_SIGNATURE = 0x55aaaa55,
79 MU_HANDSHAKE_SIGNATURE_HALF = 0x5a5a0000,
80 MU_HARD_RESET_WAIT = 30000,
83 /* firmware returned values */
84 SRB_STATUS_SUCCESS = 0x01,
85 SRB_STATUS_ERROR = 0x04,
86 SRB_STATUS_BUSY = 0x05,
87 SRB_STATUS_INVALID_REQUEST = 0x06,
88 SRB_STATUS_SELECTION_TIMEOUT = 0x0A,
92 TASK_ATTRIBUTE_SIMPLE = 0x0,
93 TASK_ATTRIBUTE_HEADOFQUEUE = 0x1,
94 TASK_ATTRIBUTE_ORDERED = 0x2,
95 TASK_ATTRIBUTE_ACA = 0x4,
97 /* request count, etc. */
100 /* one message wasted, use MU_MAX_REQUEST+1
101 to handle MU_MAX_REQUEST messages */
102 MU_REQ_COUNT = (MU_MAX_REQUEST + 1),
103 MU_STATUS_COUNT = (MU_MAX_REQUEST + 1),
105 STEX_CDB_LENGTH = MAX_COMMAND_SIZE,
106 REQ_VARIABLE_LEN = 1024,
107 STATUS_VAR_LEN = 128,
108 ST_CAN_QUEUE = MU_MAX_REQUEST,
109 ST_CMD_PER_LUN = MU_MAX_REQUEST,
113 SG_CF_EOT = 0x80, /* end of table */
114 SG_CF_64B = 0x40, /* 64 bit item */
115 SG_CF_HOST = 0x20, /* sg in host memory */
122 PASSTHRU_REQ_TYPE = 0x00000001,
123 PASSTHRU_REQ_NO_WAKEUP = 0x00000100,
124 ST_INTERNAL_TIMEOUT = 30,
129 /* vendor specific commands of Promise */
131 SINBAND_MGT_CMD = 0xd9,
133 CONTROLLER_CMD = 0xe1,
134 DEBUGGING_CMD = 0xe2,
137 PASSTHRU_GET_ADAPTER = 0x05,
138 PASSTHRU_GET_DRVVER = 0x10,
140 CTLR_CONFIG_CMD = 0x03,
141 CTLR_SHUTDOWN = 0x0d,
143 CTLR_POWER_STATE_CHANGE = 0x0e,
144 CTLR_POWER_SAVING = 0x01,
146 PASSTHRU_SIGNATURE = 0x4e415041,
147 MGT_CMD_SIGNATURE = 0xba,
151 ST_ADDITIONAL_MEM = 0x200000,
154 /* SCSI inquiry data */
155 typedef struct st_inq {
157 u8 DeviceTypeQualifier :3;
158 u8 DeviceTypeModifier :7;
159 u8 RemovableMedia :1;
161 u8 ResponseDataFormat :4;
171 u8 LinkedCommands :1;
175 u8 RelativeAddressing :1;
178 u8 ProductRevisionLevel[4];
179 u8 VendorSpecific[20];
184 u8 ctrl; /* SG_CF_xxx */
195 struct st_sgitem table[ST_MAX_SG];
198 struct handshake_frame {
199 __le32 rb_phy; /* request payload queue physical address */
201 __le16 req_sz; /* size of each request payload */
202 __le16 req_cnt; /* count of reqs the buffer can hold */
203 __le16 status_sz; /* size of each status payload */
204 __le16 status_cnt; /* count of status the buffer can hold */
205 __le32 hosttime; /* seconds from Jan 1, 1970 (GMT) */
207 u8 partner_type; /* who sends this frame */
209 __le32 partner_ver_major;
210 __le32 partner_ver_minor;
211 __le32 partner_ver_oem;
212 __le32 partner_ver_build;
213 __le32 extra_offset; /* NEW */
214 __le32 extra_size; /* NEW */
225 u8 payload_sz; /* payload size in 4-byte, not used */
226 u8 cdb[STEX_CDB_LENGTH];
227 u8 variable[REQ_VARIABLE_LEN];
237 u8 payload_sz; /* payload size in 4-byte */
238 u8 variable[STATUS_VAR_LEN];
253 struct ver_info drv_ver;
254 struct ver_info bios_ver;
283 #define MU_REQ_BUFFER_SIZE (MU_REQ_COUNT * sizeof(struct req_msg))
284 #define MU_STATUS_BUFFER_SIZE (MU_STATUS_COUNT * sizeof(struct status_msg))
285 #define MU_BUFFER_SIZE (MU_REQ_BUFFER_SIZE + MU_STATUS_BUFFER_SIZE)
286 #define STEX_EXTRA_SIZE max(sizeof(struct st_frame), sizeof(ST_INQ))
287 #define STEX_BUFFER_SIZE (MU_BUFFER_SIZE + STEX_EXTRA_SIZE)
291 struct scsi_cmnd *cmd;
294 unsigned int sense_bufflen;
303 void __iomem *mmio_base; /* iomapped PCI memory space */
305 dma_addr_t dma_handle;
308 struct Scsi_Host *host;
309 struct pci_dev *pdev;
316 struct status_msg *status_buffer;
317 void *copy_buffer; /* temp buffer for driver-handled commands */
318 struct st_ccb ccb[MU_MAX_REQUEST];
319 struct st_ccb *wait_ccb;
320 wait_queue_head_t waitq;
322 unsigned int mu_status;
325 unsigned int cardtype;
328 static const char console_inq_page[] =
330 0x03,0x00,0x03,0x03,0xFA,0x00,0x00,0x30,
331 0x50,0x72,0x6F,0x6D,0x69,0x73,0x65,0x20, /* "Promise " */
332 0x52,0x41,0x49,0x44,0x20,0x43,0x6F,0x6E, /* "RAID Con" */
333 0x73,0x6F,0x6C,0x65,0x20,0x20,0x20,0x20, /* "sole " */
334 0x31,0x2E,0x30,0x30,0x20,0x20,0x20,0x20, /* "1.00 " */
335 0x53,0x58,0x2F,0x52,0x53,0x41,0x46,0x2D, /* "SX/RSAF-" */
336 0x54,0x45,0x31,0x2E,0x30,0x30,0x20,0x20, /* "TE1.00 " */
337 0x0C,0x20,0x20,0x20,0x20,0x20,0x20,0x20
340 MODULE_AUTHOR("Ed Lin");
341 MODULE_DESCRIPTION("Promise Technology SuperTrak EX Controllers");
342 MODULE_LICENSE("GPL");
343 MODULE_VERSION(ST_DRIVER_VERSION);
345 static void stex_gettime(__le32 *time)
348 do_gettimeofday(&tv);
350 *time = cpu_to_le32(tv.tv_sec & 0xffffffff);
351 *(time + 1) = cpu_to_le32((tv.tv_sec >> 16) >> 16);
354 static struct status_msg *stex_get_status(struct st_hba *hba)
356 struct status_msg *status =
357 hba->status_buffer + hba->status_tail;
360 hba->status_tail %= MU_STATUS_COUNT;
365 static void stex_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
367 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
369 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
370 cmd->sense_buffer[2] = sk;
371 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
372 cmd->sense_buffer[12] = asc;
373 cmd->sense_buffer[13] = ascq;
376 static void stex_invalid_field(struct scsi_cmnd *cmd,
377 void (*done)(struct scsi_cmnd *))
379 /* "Invalid field in cbd" */
380 stex_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
384 static struct req_msg *stex_alloc_req(struct st_hba *hba)
386 struct req_msg *req = ((struct req_msg *)hba->dma_mem) +
390 hba->req_head %= MU_REQ_COUNT;
395 static int stex_map_sg(struct st_hba *hba,
396 struct req_msg *req, struct st_ccb *ccb)
398 struct scsi_cmnd *cmd;
399 struct scatterlist *sg;
400 struct st_sgtable *dst;
404 dst = (struct st_sgtable *)req->variable;
405 dst->max_sg_count = cpu_to_le16(ST_MAX_SG);
406 dst->sz_in_byte = cpu_to_le32(scsi_bufflen(cmd));
408 nseg = scsi_dma_map(cmd);
412 ccb->sg_count = nseg;
413 dst->sg_count = cpu_to_le16((u16)nseg);
415 scsi_for_each_sg(cmd, sg, nseg, i) {
416 dst->table[i].count = cpu_to_le32((u32)sg_dma_len(sg));
418 cpu_to_le32(sg_dma_address(sg) & 0xffffffff);
419 dst->table[i].addr_hi =
420 cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
421 dst->table[i].ctrl = SG_CF_64B | SG_CF_HOST;
423 dst->table[--i].ctrl |= SG_CF_EOT;
429 static void stex_internal_copy(struct scsi_cmnd *cmd,
430 const void *src, size_t *count, int sg_count, int direction)
434 void *s, *d, *base = NULL;
437 if (*count > scsi_bufflen(cmd))
438 *count = scsi_bufflen(cmd);
444 offset = *count - lcount;
446 base = scsi_kmap_atomic_sg(scsi_sglist(cmd),
447 sg_count, &offset, &len);
454 if (direction == ST_TO_CMD)
460 scsi_kunmap_atomic_sg(base);
464 static int stex_direct_copy(struct scsi_cmnd *cmd,
465 const void *src, size_t count)
467 size_t cp_len = count;
470 n_elem = scsi_dma_map(cmd);
474 stex_internal_copy(cmd, src, &cp_len, n_elem, ST_TO_CMD);
478 return cp_len == count;
481 static void stex_controller_info(struct st_hba *hba, struct st_ccb *ccb)
484 size_t count = sizeof(struct st_frame);
486 p = hba->copy_buffer;
487 stex_internal_copy(ccb->cmd, p, &count, ccb->sg_count, ST_FROM_CMD);
488 memset(p->base, 0, sizeof(u32)*6);
489 *(unsigned long *)(p->base) = pci_resource_start(hba->pdev, 0);
492 p->drv_ver.major = ST_VER_MAJOR;
493 p->drv_ver.minor = ST_VER_MINOR;
494 p->drv_ver.oem = ST_OEM;
495 p->drv_ver.build = ST_BUILD_VER;
497 p->bus = hba->pdev->bus->number;
498 p->slot = hba->pdev->devfn;
500 p->irq_vec = hba->pdev->irq;
501 p->id = hba->pdev->vendor << 16 | hba->pdev->device;
503 hba->pdev->subsystem_vendor << 16 | hba->pdev->subsystem_device;
505 stex_internal_copy(ccb->cmd, p, &count, ccb->sg_count, ST_TO_CMD);
509 stex_send_cmd(struct st_hba *hba, struct req_msg *req, u16 tag)
511 req->tag = cpu_to_le16(tag);
512 req->task_attr = TASK_ATTRIBUTE_SIMPLE;
513 req->task_manage = 0; /* not supported yet */
515 hba->ccb[tag].req = req;
518 writel(hba->req_head, hba->mmio_base + IMR0);
519 writel(MU_INBOUND_DOORBELL_REQHEADCHANGED, hba->mmio_base + IDBL);
520 readl(hba->mmio_base + IDBL); /* flush */
524 stex_slave_alloc(struct scsi_device *sdev)
526 /* Cheat: usually extracted from Inquiry data */
527 sdev->tagged_supported = 1;
529 scsi_activate_tcq(sdev, sdev->host->can_queue);
535 stex_slave_config(struct scsi_device *sdev)
537 sdev->use_10_for_rw = 1;
538 sdev->use_10_for_ms = 1;
539 sdev->timeout = 60 * HZ;
540 sdev->tagged_supported = 1;
546 stex_slave_destroy(struct scsi_device *sdev)
548 scsi_deactivate_tcq(sdev, 1);
552 stex_queuecommand(struct scsi_cmnd *cmd, void (* done)(struct scsi_cmnd *))
555 struct Scsi_Host *host;
559 host = cmd->device->host;
560 id = cmd->device->id;
561 lun = cmd->device->lun;
562 hba = (struct st_hba *) &host->hostdata[0];
564 switch (cmd->cmnd[0]) {
567 static char ms10_caching_page[12] =
568 { 0, 0x12, 0, 0, 0, 0, 0, 0, 0x8, 0xa, 0x4, 0 };
570 page = cmd->cmnd[2] & 0x3f;
571 if (page == 0x8 || page == 0x3f) {
572 stex_direct_copy(cmd, ms10_caching_page,
573 sizeof(ms10_caching_page));
574 cmd->result = DID_OK << 16 | COMMAND_COMPLETE << 8;
577 stex_invalid_field(cmd, done);
582 * The shasta firmware does not report actual luns in the
583 * target, so fail the command to force sequential lun scan.
584 * Also, the console device does not support this command.
586 if (hba->cardtype == st_shasta || id == host->max_id - 1) {
587 stex_invalid_field(cmd, done);
591 case TEST_UNIT_READY:
592 if (id == host->max_id - 1) {
593 cmd->result = DID_OK << 16 | COMMAND_COMPLETE << 8;
599 if (id != host->max_id - 1)
601 if (lun == 0 && (cmd->cmnd[1] & INQUIRY_EVPD) == 0) {
602 stex_direct_copy(cmd, console_inq_page,
603 sizeof(console_inq_page));
604 cmd->result = DID_OK << 16 | COMMAND_COMPLETE << 8;
607 stex_invalid_field(cmd, done);
610 if (cmd->cmnd[1] == PASSTHRU_GET_DRVVER) {
611 struct st_drvver ver;
612 ver.major = ST_VER_MAJOR;
613 ver.minor = ST_VER_MINOR;
615 ver.build = ST_BUILD_VER;
616 ver.signature[0] = PASSTHRU_SIGNATURE;
617 ver.console_id = host->max_id - 1;
618 ver.host_no = hba->host->host_no;
619 cmd->result = stex_direct_copy(cmd, &ver, sizeof(ver)) ?
620 DID_OK << 16 | COMMAND_COMPLETE << 8 :
621 DID_ERROR << 16 | COMMAND_COMPLETE << 8;
629 cmd->scsi_done = done;
631 tag = cmd->request->tag;
633 if (unlikely(tag >= host->can_queue))
634 return SCSI_MLQUEUE_HOST_BUSY;
636 req = stex_alloc_req(hba);
642 memcpy(req->cdb, cmd->cmnd, STEX_CDB_LENGTH);
644 hba->ccb[tag].cmd = cmd;
645 hba->ccb[tag].sense_bufflen = SCSI_SENSE_BUFFERSIZE;
646 hba->ccb[tag].sense_buffer = cmd->sense_buffer;
647 hba->ccb[tag].req_type = 0;
649 if (cmd->sc_data_direction != DMA_NONE)
650 stex_map_sg(hba, req, &hba->ccb[tag]);
652 stex_send_cmd(hba, req, tag);
656 static void stex_scsi_done(struct st_ccb *ccb)
658 struct scsi_cmnd *cmd = ccb->cmd;
661 if (ccb->srb_status == SRB_STATUS_SUCCESS || ccb->srb_status == 0) {
662 result = ccb->scsi_status;
663 switch (ccb->scsi_status) {
665 result |= DID_OK << 16 | COMMAND_COMPLETE << 8;
667 case SAM_STAT_CHECK_CONDITION:
668 result |= DRIVER_SENSE << 24;
671 result |= DID_BUS_BUSY << 16 | COMMAND_COMPLETE << 8;
674 result |= DID_ERROR << 16 | COMMAND_COMPLETE << 8;
678 else if (ccb->srb_status & SRB_SEE_SENSE)
679 result = DRIVER_SENSE << 24 | SAM_STAT_CHECK_CONDITION;
680 else switch (ccb->srb_status) {
681 case SRB_STATUS_SELECTION_TIMEOUT:
682 result = DID_NO_CONNECT << 16 | COMMAND_COMPLETE << 8;
684 case SRB_STATUS_BUSY:
685 result = DID_BUS_BUSY << 16 | COMMAND_COMPLETE << 8;
687 case SRB_STATUS_INVALID_REQUEST:
688 case SRB_STATUS_ERROR:
690 result = DID_ERROR << 16 | COMMAND_COMPLETE << 8;
694 cmd->result = result;
698 static void stex_copy_data(struct st_ccb *ccb,
699 struct status_msg *resp, unsigned int variable)
701 size_t count = variable;
702 if (resp->scsi_status != SAM_STAT_GOOD) {
703 if (ccb->sense_buffer != NULL)
704 memcpy(ccb->sense_buffer, resp->variable,
705 min(variable, ccb->sense_bufflen));
709 if (ccb->cmd == NULL)
711 stex_internal_copy(ccb->cmd,
712 resp->variable, &count, ccb->sg_count, ST_TO_CMD);
715 static void stex_ys_commands(struct st_hba *hba,
716 struct st_ccb *ccb, struct status_msg *resp)
720 if (ccb->cmd->cmnd[0] == MGT_CMD &&
721 resp->scsi_status != SAM_STAT_CHECK_CONDITION) {
722 scsi_set_resid(ccb->cmd, scsi_bufflen(ccb->cmd) -
723 le32_to_cpu(*(__le32 *)&resp->variable[0]));
727 if (resp->srb_status != 0)
730 /* determine inquiry command status by DeviceTypeQualifier */
731 if (ccb->cmd->cmnd[0] == INQUIRY &&
732 resp->scsi_status == SAM_STAT_GOOD) {
735 count = STEX_EXTRA_SIZE;
736 stex_internal_copy(ccb->cmd, hba->copy_buffer,
737 &count, ccb->sg_count, ST_FROM_CMD);
738 inq_data = (ST_INQ *)hba->copy_buffer;
739 if (inq_data->DeviceTypeQualifier != 0)
740 ccb->srb_status = SRB_STATUS_SELECTION_TIMEOUT;
742 ccb->srb_status = SRB_STATUS_SUCCESS;
746 static void stex_mu_intr(struct st_hba *hba, u32 doorbell)
748 void __iomem *base = hba->mmio_base;
749 struct status_msg *resp;
754 if (!(doorbell & MU_OUTBOUND_DOORBELL_STATUSHEADCHANGED))
757 /* status payloads */
758 hba->status_head = readl(base + OMR1);
759 if (unlikely(hba->status_head >= MU_STATUS_COUNT)) {
760 printk(KERN_WARNING DRV_NAME "(%s): invalid status head\n",
761 pci_name(hba->pdev));
766 * it's not a valid status payload if:
767 * 1. there are no pending requests(e.g. during init stage)
768 * 2. there are some pending requests, but the controller is in
769 * reset status, and its type is not st_yosemite
770 * firmware of st_yosemite in reset status will return pending requests
771 * to driver, so we allow it to pass
773 if (unlikely(hba->out_req_cnt <= 0 ||
774 (hba->mu_status == MU_STATE_RESETTING &&
775 hba->cardtype != st_yosemite))) {
776 hba->status_tail = hba->status_head;
780 while (hba->status_tail != hba->status_head) {
781 resp = stex_get_status(hba);
782 tag = le16_to_cpu(resp->tag);
783 if (unlikely(tag >= hba->host->can_queue)) {
784 printk(KERN_WARNING DRV_NAME
785 "(%s): invalid tag\n", pci_name(hba->pdev));
789 ccb = &hba->ccb[tag];
790 if (hba->wait_ccb == ccb)
791 hba->wait_ccb = NULL;
792 if (unlikely(ccb->req == NULL)) {
793 printk(KERN_WARNING DRV_NAME
794 "(%s): lagging req\n", pci_name(hba->pdev));
799 size = resp->payload_sz * sizeof(u32); /* payload size */
800 if (unlikely(size < sizeof(*resp) - STATUS_VAR_LEN ||
801 size > sizeof(*resp))) {
802 printk(KERN_WARNING DRV_NAME "(%s): bad status size\n",
803 pci_name(hba->pdev));
805 size -= sizeof(*resp) - STATUS_VAR_LEN; /* copy size */
807 stex_copy_data(ccb, resp, size);
810 ccb->srb_status = resp->srb_status;
811 ccb->scsi_status = resp->scsi_status;
813 if (likely(ccb->cmd != NULL)) {
814 if (hba->cardtype == st_yosemite)
815 stex_ys_commands(hba, ccb, resp);
817 if (unlikely(ccb->cmd->cmnd[0] == PASSTHRU_CMD &&
818 ccb->cmd->cmnd[1] == PASSTHRU_GET_ADAPTER))
819 stex_controller_info(hba, ccb);
821 scsi_dma_unmap(ccb->cmd);
824 } else if (ccb->req_type & PASSTHRU_REQ_TYPE) {
826 if (ccb->req_type & PASSTHRU_REQ_NO_WAKEUP) {
831 if (waitqueue_active(&hba->waitq))
832 wake_up(&hba->waitq);
837 writel(hba->status_head, base + IMR1);
838 readl(base + IMR1); /* flush */
841 static irqreturn_t stex_intr(int irq, void *__hba)
843 struct st_hba *hba = __hba;
844 void __iomem *base = hba->mmio_base;
849 spin_lock_irqsave(hba->host->host_lock, flags);
851 data = readl(base + ODBL);
853 if (data && data != 0xffffffff) {
854 /* clear the interrupt */
855 writel(data, base + ODBL);
856 readl(base + ODBL); /* flush */
857 stex_mu_intr(hba, data);
861 spin_unlock_irqrestore(hba->host->host_lock, flags);
863 return IRQ_RETVAL(handled);
866 static int stex_handshake(struct st_hba *hba)
868 void __iomem *base = hba->mmio_base;
869 struct handshake_frame *h;
870 dma_addr_t status_phys;
872 unsigned long before;
874 if (readl(base + OMR0) != MU_HANDSHAKE_SIGNATURE) {
875 writel(MU_INBOUND_DOORBELL_HANDSHAKE, base + IDBL);
878 while (readl(base + OMR0) != MU_HANDSHAKE_SIGNATURE) {
879 if (time_after(jiffies, before + MU_MAX_DELAY * HZ)) {
880 printk(KERN_ERR DRV_NAME
881 "(%s): no handshake signature\n",
882 pci_name(hba->pdev));
892 data = readl(base + OMR1);
893 if ((data & 0xffff0000) == MU_HANDSHAKE_SIGNATURE_HALF) {
895 if (hba->host->can_queue > data)
896 hba->host->can_queue = data;
899 h = (struct handshake_frame *)(hba->dma_mem + MU_REQ_BUFFER_SIZE);
900 h->rb_phy = cpu_to_le32(hba->dma_handle);
901 h->rb_phy_hi = cpu_to_le32((hba->dma_handle >> 16) >> 16);
902 h->req_sz = cpu_to_le16(sizeof(struct req_msg));
903 h->req_cnt = cpu_to_le16(MU_REQ_COUNT);
904 h->status_sz = cpu_to_le16(sizeof(struct status_msg));
905 h->status_cnt = cpu_to_le16(MU_STATUS_COUNT);
906 stex_gettime(&h->hosttime);
907 h->partner_type = HMU_PARTNER_TYPE;
908 if (hba->dma_size > STEX_BUFFER_SIZE) {
909 h->extra_offset = cpu_to_le32(STEX_BUFFER_SIZE);
910 h->extra_size = cpu_to_le32(ST_ADDITIONAL_MEM);
912 h->extra_offset = h->extra_size = 0;
914 status_phys = hba->dma_handle + MU_REQ_BUFFER_SIZE;
915 writel(status_phys, base + IMR0);
917 writel((status_phys >> 16) >> 16, base + IMR1);
920 writel((status_phys >> 16) >> 16, base + OMR0); /* old fw compatible */
922 writel(MU_INBOUND_DOORBELL_HANDSHAKE, base + IDBL);
923 readl(base + IDBL); /* flush */
927 while (readl(base + OMR0) != MU_HANDSHAKE_SIGNATURE) {
928 if (time_after(jiffies, before + MU_MAX_DELAY * HZ)) {
929 printk(KERN_ERR DRV_NAME
930 "(%s): no signature after handshake frame\n",
931 pci_name(hba->pdev));
938 writel(0, base + IMR0);
940 writel(0, base + OMR0);
942 writel(0, base + IMR1);
944 writel(0, base + OMR1);
945 readl(base + OMR1); /* flush */
946 hba->mu_status = MU_STATE_STARTED;
950 static int stex_abort(struct scsi_cmnd *cmd)
952 struct Scsi_Host *host = cmd->device->host;
953 struct st_hba *hba = (struct st_hba *)host->hostdata;
954 u16 tag = cmd->request->tag;
957 int result = SUCCESS;
960 printk(KERN_INFO DRV_NAME
961 "(%s): aborting command\n", pci_name(hba->pdev));
962 scsi_print_command(cmd);
964 base = hba->mmio_base;
965 spin_lock_irqsave(host->host_lock, flags);
966 if (tag < host->can_queue && hba->ccb[tag].cmd == cmd)
967 hba->wait_ccb = &hba->ccb[tag];
969 for (tag = 0; tag < host->can_queue; tag++)
970 if (hba->ccb[tag].cmd == cmd) {
971 hba->wait_ccb = &hba->ccb[tag];
974 if (tag >= host->can_queue)
978 data = readl(base + ODBL);
979 if (data == 0 || data == 0xffffffff)
982 writel(data, base + ODBL);
983 readl(base + ODBL); /* flush */
985 stex_mu_intr(hba, data);
987 if (hba->wait_ccb == NULL) {
988 printk(KERN_WARNING DRV_NAME
989 "(%s): lost interrupt\n", pci_name(hba->pdev));
995 hba->wait_ccb->req = NULL; /* nullify the req's future return */
996 hba->wait_ccb = NULL;
999 spin_unlock_irqrestore(host->host_lock, flags);
1003 static void stex_hard_reset(struct st_hba *hba)
1005 struct pci_bus *bus;
1010 for (i = 0; i < 16; i++)
1011 pci_read_config_dword(hba->pdev, i * 4,
1012 &hba->pdev->saved_config_space[i]);
1014 /* Reset secondary bus. Our controller(MU/ATU) is the only device on
1015 secondary bus. Consult Intel 80331/3 developer's manual for detail */
1016 bus = hba->pdev->bus;
1017 pci_read_config_byte(bus->self, PCI_BRIDGE_CONTROL, &pci_bctl);
1018 pci_bctl |= PCI_BRIDGE_CTL_BUS_RESET;
1019 pci_write_config_byte(bus->self, PCI_BRIDGE_CONTROL, pci_bctl);
1022 * 1 ms may be enough for 8-port controllers. But 16-port controllers
1023 * require more time to finish bus reset. Use 100 ms here for safety
1026 pci_bctl &= ~PCI_BRIDGE_CTL_BUS_RESET;
1027 pci_write_config_byte(bus->self, PCI_BRIDGE_CONTROL, pci_bctl);
1029 for (i = 0; i < MU_HARD_RESET_WAIT; i++) {
1030 pci_read_config_word(hba->pdev, PCI_COMMAND, &pci_cmd);
1031 if (pci_cmd != 0xffff && (pci_cmd & PCI_COMMAND_MASTER))
1037 for (i = 0; i < 16; i++)
1038 pci_write_config_dword(hba->pdev, i * 4,
1039 hba->pdev->saved_config_space[i]);
1042 static int stex_reset(struct scsi_cmnd *cmd)
1045 unsigned long flags;
1046 unsigned long before;
1047 hba = (struct st_hba *) &cmd->device->host->hostdata[0];
1049 printk(KERN_INFO DRV_NAME
1050 "(%s): resetting host\n", pci_name(hba->pdev));
1051 scsi_print_command(cmd);
1053 hba->mu_status = MU_STATE_RESETTING;
1055 if (hba->cardtype == st_shasta)
1056 stex_hard_reset(hba);
1058 if (hba->cardtype != st_yosemite) {
1059 if (stex_handshake(hba)) {
1060 printk(KERN_WARNING DRV_NAME
1061 "(%s): resetting: handshake failed\n",
1062 pci_name(hba->pdev));
1065 spin_lock_irqsave(hba->host->host_lock, flags);
1068 hba->status_head = 0;
1069 hba->status_tail = 0;
1070 hba->out_req_cnt = 0;
1071 spin_unlock_irqrestore(hba->host->host_lock, flags);
1076 writel(MU_INBOUND_DOORBELL_RESET, hba->mmio_base + IDBL);
1077 readl(hba->mmio_base + IDBL); /* flush */
1079 while (hba->out_req_cnt > 0) {
1080 if (time_after(jiffies, before + ST_INTERNAL_TIMEOUT * HZ)) {
1081 printk(KERN_WARNING DRV_NAME
1082 "(%s): reset timeout\n", pci_name(hba->pdev));
1088 hba->mu_status = MU_STATE_STARTED;
1092 static int stex_biosparam(struct scsi_device *sdev,
1093 struct block_device *bdev, sector_t capacity, int geom[])
1095 int heads = 255, sectors = 63;
1097 if (capacity < 0x200000) {
1102 sector_div(capacity, heads * sectors);
1111 static struct scsi_host_template driver_template = {
1112 .module = THIS_MODULE,
1114 .proc_name = DRV_NAME,
1115 .bios_param = stex_biosparam,
1116 .queuecommand = stex_queuecommand,
1117 .slave_alloc = stex_slave_alloc,
1118 .slave_configure = stex_slave_config,
1119 .slave_destroy = stex_slave_destroy,
1120 .eh_abort_handler = stex_abort,
1121 .eh_host_reset_handler = stex_reset,
1122 .can_queue = ST_CAN_QUEUE,
1124 .sg_tablesize = ST_MAX_SG,
1125 .cmd_per_lun = ST_CMD_PER_LUN,
1128 static int stex_set_dma_mask(struct pci_dev * pdev)
1131 if (!pci_set_dma_mask(pdev, DMA_64BIT_MASK)
1132 && !pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK))
1134 ret = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
1136 ret = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
1140 static int __devinit
1141 stex_probe(struct pci_dev *pdev, const struct pci_device_id *id)
1144 struct Scsi_Host *host;
1147 err = pci_enable_device(pdev);
1151 pci_set_master(pdev);
1153 host = scsi_host_alloc(&driver_template, sizeof(struct st_hba));
1156 printk(KERN_ERR DRV_NAME "(%s): scsi_host_alloc failed\n",
1162 hba = (struct st_hba *)host->hostdata;
1163 memset(hba, 0, sizeof(struct st_hba));
1165 err = pci_request_regions(pdev, DRV_NAME);
1167 printk(KERN_ERR DRV_NAME "(%s): request regions failed\n",
1169 goto out_scsi_host_put;
1172 hba->mmio_base = ioremap_nocache(pci_resource_start(pdev, 0),
1173 pci_resource_len(pdev, 0));
1174 if ( !hba->mmio_base) {
1175 printk(KERN_ERR DRV_NAME "(%s): memory map failed\n",
1178 goto out_release_regions;
1181 err = stex_set_dma_mask(pdev);
1183 printk(KERN_ERR DRV_NAME "(%s): set dma mask failed\n",
1188 hba->cardtype = (unsigned int) id->driver_data;
1189 if (hba->cardtype == st_vsc && (pdev->subsystem_device & 0xf) == 0x1)
1190 hba->cardtype = st_vsc1;
1191 hba->dma_size = (hba->cardtype == st_vsc1) ?
1192 (STEX_BUFFER_SIZE + ST_ADDITIONAL_MEM) : (STEX_BUFFER_SIZE);
1193 hba->dma_mem = dma_alloc_coherent(&pdev->dev,
1194 hba->dma_size, &hba->dma_handle, GFP_KERNEL);
1195 if (!hba->dma_mem) {
1197 printk(KERN_ERR DRV_NAME "(%s): dma mem alloc failed\n",
1202 hba->status_buffer =
1203 (struct status_msg *)(hba->dma_mem + MU_REQ_BUFFER_SIZE);
1204 hba->copy_buffer = hba->dma_mem + MU_BUFFER_SIZE;
1205 hba->mu_status = MU_STATE_STARTING;
1207 if (hba->cardtype == st_shasta) {
1209 host->max_id = 16 + 1;
1210 } else if (hba->cardtype == st_yosemite) {
1211 host->max_lun = 128;
1212 host->max_id = 1 + 1;
1214 /* st_vsc and st_vsc1 */
1216 host->max_id = 128 + 1;
1218 host->max_channel = 0;
1219 host->unique_id = host->host_no;
1220 host->max_cmd_len = STEX_CDB_LENGTH;
1224 init_waitqueue_head(&hba->waitq);
1226 err = request_irq(pdev->irq, stex_intr, IRQF_SHARED, DRV_NAME, hba);
1228 printk(KERN_ERR DRV_NAME "(%s): request irq failed\n",
1233 err = stex_handshake(hba);
1237 err = scsi_init_shared_tag_map(host, host->can_queue);
1239 printk(KERN_ERR DRV_NAME "(%s): init shared queue failed\n",
1244 pci_set_drvdata(pdev, hba);
1246 err = scsi_add_host(host, &pdev->dev);
1248 printk(KERN_ERR DRV_NAME "(%s): scsi_add_host failed\n",
1253 scsi_scan_host(host);
1258 free_irq(pdev->irq, hba);
1260 dma_free_coherent(&pdev->dev, hba->dma_size,
1261 hba->dma_mem, hba->dma_handle);
1263 iounmap(hba->mmio_base);
1264 out_release_regions:
1265 pci_release_regions(pdev);
1267 scsi_host_put(host);
1269 pci_disable_device(pdev);
1274 static void stex_hba_stop(struct st_hba *hba)
1276 struct req_msg *req;
1277 unsigned long flags;
1278 unsigned long before;
1281 spin_lock_irqsave(hba->host->host_lock, flags);
1282 req = stex_alloc_req(hba);
1283 memset(req->cdb, 0, STEX_CDB_LENGTH);
1285 if (hba->cardtype == st_yosemite) {
1286 req->cdb[0] = MGT_CMD;
1287 req->cdb[1] = MGT_CMD_SIGNATURE;
1288 req->cdb[2] = CTLR_CONFIG_CMD;
1289 req->cdb[3] = CTLR_SHUTDOWN;
1291 req->cdb[0] = CONTROLLER_CMD;
1292 req->cdb[1] = CTLR_POWER_STATE_CHANGE;
1293 req->cdb[2] = CTLR_POWER_SAVING;
1296 hba->ccb[tag].cmd = NULL;
1297 hba->ccb[tag].sg_count = 0;
1298 hba->ccb[tag].sense_bufflen = 0;
1299 hba->ccb[tag].sense_buffer = NULL;
1300 hba->ccb[tag].req_type |= PASSTHRU_REQ_TYPE;
1302 stex_send_cmd(hba, req, tag);
1303 spin_unlock_irqrestore(hba->host->host_lock, flags);
1306 while (hba->ccb[tag].req_type & PASSTHRU_REQ_TYPE) {
1307 if (time_after(jiffies, before + ST_INTERNAL_TIMEOUT * HZ))
1313 static void stex_hba_free(struct st_hba *hba)
1315 free_irq(hba->pdev->irq, hba);
1317 iounmap(hba->mmio_base);
1319 pci_release_regions(hba->pdev);
1321 dma_free_coherent(&hba->pdev->dev, hba->dma_size,
1322 hba->dma_mem, hba->dma_handle);
1325 static void stex_remove(struct pci_dev *pdev)
1327 struct st_hba *hba = pci_get_drvdata(pdev);
1329 scsi_remove_host(hba->host);
1331 pci_set_drvdata(pdev, NULL);
1337 scsi_host_put(hba->host);
1339 pci_disable_device(pdev);
1342 static void stex_shutdown(struct pci_dev *pdev)
1344 struct st_hba *hba = pci_get_drvdata(pdev);
1349 static struct pci_device_id stex_pci_tbl[] = {
1351 { 0x105a, 0x8350, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
1352 st_shasta }, /* SuperTrak EX8350/8300/16350/16300 */
1353 { 0x105a, 0xc350, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
1354 st_shasta }, /* SuperTrak EX12350 */
1355 { 0x105a, 0x4302, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
1356 st_shasta }, /* SuperTrak EX4350 */
1357 { 0x105a, 0xe350, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
1358 st_shasta }, /* SuperTrak EX24350 */
1361 { 0x105a, 0x7250, PCI_ANY_ID, PCI_ANY_ID, 0, 0, st_vsc },
1364 { 0x105a, 0x8650, PCI_ANY_ID, 0x4600, 0, 0,
1365 st_yosemite }, /* SuperTrak EX4650 */
1366 { 0x105a, 0x8650, PCI_ANY_ID, 0x4610, 0, 0,
1367 st_yosemite }, /* SuperTrak EX4650o */
1368 { 0x105a, 0x8650, PCI_ANY_ID, 0x8600, 0, 0,
1369 st_yosemite }, /* SuperTrak EX8650EL */
1370 { 0x105a, 0x8650, PCI_ANY_ID, 0x8601, 0, 0,
1371 st_yosemite }, /* SuperTrak EX8650 */
1372 { 0x105a, 0x8650, PCI_ANY_ID, 0x8602, 0, 0,
1373 st_yosemite }, /* SuperTrak EX8654 */
1374 { 0x105a, 0x8650, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
1375 st_yosemite }, /* generic st_yosemite */
1376 { } /* terminate list */
1378 MODULE_DEVICE_TABLE(pci, stex_pci_tbl);
1380 static struct pci_driver stex_pci_driver = {
1382 .id_table = stex_pci_tbl,
1383 .probe = stex_probe,
1384 .remove = __devexit_p(stex_remove),
1385 .shutdown = stex_shutdown,
1388 static int __init stex_init(void)
1390 printk(KERN_INFO DRV_NAME
1391 ": Promise SuperTrak EX Driver version: %s\n",
1394 return pci_register_driver(&stex_pci_driver);
1397 static void __exit stex_exit(void)
1399 pci_unregister_driver(&stex_pci_driver);
1402 module_init(stex_init);
1403 module_exit(stex_exit);