/*----------------------------------------------------------------*/ /* Qlogic linux driver - work in progress. No Warranty express or implied. Use at your own risk. Support Tort Reform so you won't have to read all these silly disclaimers. Copyright 1994, Tom Zerucha. tz@execpc.com Additional Code, and much appreciated help by Michael A. Griffith grif@cs.ucr.edu Thanks to Eric Youngdale and Dave Hinds for loadable module and PCMCIA help respectively, and for suffering through my foolishness during the debugging process. Reference Qlogic FAS408 Technical Manual, 53408-510-00A, May 10, 1994 (you can reference it, but it is incomplete and inaccurate in places) Version 0.46 1/30/97 - kernel 1.2.0+ Functions as standalone, loadable, and PCMCIA driver, the latter from Dave Hinds' PCMCIA package. Cleaned up 26/10/2002 by Alan Cox as part of the 2.5 SCSI driver cleanup and audit. This driver still needs work on the following - Non terminating hardware waits - Some layering violations with its pcmcia stub Redistributable under terms of the GNU General Public License For the avoidance of doubt the "preferred form" of this code is one which is in an open non patent encumbered format. Where cryptographic key signing forms part of the process of creating an executable the information including keys needed to generate an equivalently functional executable are deemed to be part of the source code. */ #include #include /* to get disk capacity */ #include #include #include #include #include #include #include #include #include #include #include #include #include "scsi.h" #include "hosts.h" #include "qlogicfas.h" /*----------------------------------------------------------------*/ int qlcfg5 = (XTALFREQ << 5); /* 15625/512 */ int qlcfg6 = SYNCXFRPD; int qlcfg7 = SYNCOFFST; int qlcfg8 = (SLOWCABLE << 7) | (QL_ENABLE_PARITY << 4); int qlcfg9 = ((XTALFREQ + 4) / 5); int qlcfgc = (FASTCLK << 3) | (FASTSCSI << 4); static char qlogicfas_name[] = "qlogicfas"; int qlogicfas_queuecommand(Scsi_Cmnd * cmd, void (*done) (Scsi_Cmnd *)); /*----------------------------------------------------------------*/ /*----------------------------------------------------------------*/ /* local functions */ /*----------------------------------------------------------------*/ /* error recovery - reset everything */ static void ql_zap(qlogicfas_priv_t priv) { int x; int qbase = priv->qbase; x = inb(qbase + 0xd); REG0; outb(3, qbase + 3); /* reset SCSI */ outb(2, qbase + 3); /* reset chip */ if (x & 0x80) REG1; } /* * Do a pseudo-dma tranfer */ static int ql_pdma(qlogicfas_priv_t priv, int phase, char *request, int reqlen) { int j; int qbase = priv->qbase; j = 0; if (phase & 1) { /* in */ #if QL_TURBO_PDMA rtrc(4) /* empty fifo in large chunks */ if (reqlen >= 128 && (inb(qbase + 8) & 2)) { /* full */ insl(qbase + 4, request, 32); reqlen -= 128; request += 128; } while (reqlen >= 84 && !(j & 0xc0)) /* 2/3 */ if ((j = inb(qbase + 8)) & 4) { insl(qbase + 4, request, 21); reqlen -= 84; request += 84; } if (reqlen >= 44 && (inb(qbase + 8) & 8)) { /* 1/3 */ insl(qbase + 4, request, 11); reqlen -= 44; request += 44; } #endif /* until both empty and int (or until reclen is 0) */ rtrc(7) j = 0; while (reqlen && !((j & 0x10) && (j & 0xc0))) { /* while bytes to receive and not empty */ j &= 0xc0; while (reqlen && !((j = inb(qbase + 8)) & 0x10)) { *request++ = inb(qbase + 4); reqlen--; } if (j & 0x10) j = inb(qbase + 8); } } else { /* out */ #if QL_TURBO_PDMA rtrc(4) if (reqlen >= 128 && inb(qbase + 8) & 0x10) { /* empty */ outsl(qbase + 4, request, 32); reqlen -= 128; request += 128; } while (reqlen >= 84 && !(j & 0xc0)) /* 1/3 */ if (!((j = inb(qbase + 8)) & 8)) { outsl(qbase + 4, request, 21); reqlen -= 84; request += 84; } if (reqlen >= 40 && !(inb(qbase + 8) & 4)) { /* 2/3 */ outsl(qbase + 4, request, 10); reqlen -= 40; request += 40; } #endif /* until full and int (or until reclen is 0) */ rtrc(7) j = 0; while (reqlen && !((j & 2) && (j & 0xc0))) { /* while bytes to send and not full */ while (reqlen && !((j = inb(qbase + 8)) & 2)) { outb(*request++, qbase + 4); reqlen--; } if (j & 2) j = inb(qbase + 8); } } /* maybe return reqlen */ return inb(qbase + 8) & 0xc0; } /* * Wait for interrupt flag (polled - not real hardware interrupt) */ static int ql_wai(qlogicfas_priv_t priv) { int k; int qbase = priv->qbase; unsigned long i; k = 0; i = jiffies + WATCHDOG; while (time_before(jiffies, i) && !priv->qabort && !((k = inb(qbase + 4)) & 0xe0)) { barrier(); cpu_relax(); } if (time_after_eq(jiffies, i)) return (DID_TIME_OUT); if (priv->qabort) return (priv->qabort == 1 ? DID_ABORT : DID_RESET); if (k & 0x60) ql_zap(priv); if (k & 0x20) return (DID_PARITY); if (k & 0x40) return (DID_ERROR); return 0; } /* * Initiate scsi command - queueing handler * caller must hold host lock */ static void ql_icmd(Scsi_Cmnd * cmd) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(cmd->device->host->hostdata[0]); int qbase = priv->qbase; unsigned int i; priv->qabort = 0; REG0; /* clearing of interrupts and the fifo is needed */ inb(qbase + 5); /* clear interrupts */ if (inb(qbase + 5)) /* if still interrupting */ outb(2, qbase + 3); /* reset chip */ else if (inb(qbase + 7) & 0x1f) outb(1, qbase + 3); /* clear fifo */ while (inb(qbase + 5)); /* clear ints */ REG1; outb(1, qbase + 8); /* set for PIO pseudo DMA */ outb(0, qbase + 0xb); /* disable ints */ inb(qbase + 8); /* clear int bits */ REG0; outb(0x40, qbase + 0xb); /* enable features */ /* configurables */ outb(qlcfgc, qbase + 0xc); /* config: no reset interrupt, (initiator) bus id */ outb(0x40 | qlcfg8 | priv->qinitid, qbase + 8); outb(qlcfg7, qbase + 7); outb(qlcfg6, qbase + 6); /**/ outb(qlcfg5, qbase + 5); /* select timer */ outb(qlcfg9 & 7, qbase + 9); /* prescaler */ /* outb(0x99, qbase + 5); */ outb(cmd->device->id, qbase + 4); for (i = 0; i < cmd->cmd_len; i++) outb(cmd->cmnd[i], qbase + 2); priv->qlcmd = cmd; outb(0x41, qbase + 3); /* select and send command */ } /* * Process scsi command - usually after interrupt */ static unsigned int ql_pcmd(Scsi_Cmnd * cmd) { unsigned int i, j; unsigned long k; unsigned int result; /* ultimate return result */ unsigned int status; /* scsi returned status */ unsigned int message; /* scsi returned message */ unsigned int phase; /* recorded scsi phase */ unsigned int reqlen; /* total length of transfer */ struct scatterlist *sglist; /* scatter-gather list pointer */ unsigned int sgcount; /* sg counter */ char *buf; qlogicfas_priv_t priv = (qlogicfas_priv_t)&(cmd->device->host->hostdata[0]); int qbase = priv->qbase; rtrc(1) j = inb(qbase + 6); i = inb(qbase + 5); if (i == 0x20) { return (DID_NO_CONNECT << 16); } i |= inb(qbase + 5); /* the 0x10 bit can be set after the 0x08 */ if (i != 0x18) { printk(KERN_ERR "Ql:Bad Interrupt status:%02x\n", i); ql_zap(priv); return (DID_BAD_INTR << 16); } j &= 7; /* j = inb( qbase + 7 ) >> 5; */ /* correct status is supposed to be step 4 */ /* it sometimes returns step 3 but with 0 bytes left to send */ /* We can try stuffing the FIFO with the max each time, but we will get a sequence of 3 if any bytes are left (but we do flush the FIFO anyway */ if (j != 3 && j != 4) { printk(KERN_ERR "Ql:Bad sequence for command %d, int %02X, cmdleft = %d\n", j, i, inb(qbase + 7) & 0x1f); ql_zap(priv); return (DID_ERROR << 16); } result = DID_OK; if (inb(qbase + 7) & 0x1f) /* if some bytes in fifo */ outb(1, qbase + 3); /* clear fifo */ /* note that request_bufflen is the total xfer size when sg is used */ reqlen = cmd->request_bufflen; /* note that it won't work if transfers > 16M are requested */ if (reqlen && !((phase = inb(qbase + 4)) & 6)) { /* data phase */ rtrc(2) outb(reqlen, qbase); /* low-mid xfer cnt */ outb(reqlen >> 8, qbase + 1); /* low-mid xfer cnt */ outb(reqlen >> 16, qbase + 0xe); /* high xfer cnt */ outb(0x90, qbase + 3); /* command do xfer */ /* PIO pseudo DMA to buffer or sglist */ REG1; if (!cmd->use_sg) ql_pdma(priv, phase, cmd->request_buffer, cmd->request_bufflen); else { sgcount = cmd->use_sg; sglist = cmd->request_buffer; while (sgcount--) { if (priv->qabort) { REG0; return ((priv->qabort == 1 ? DID_ABORT : DID_RESET) << 16); } buf = page_address(sglist->page) + sglist->offset; if (ql_pdma(priv, phase, buf, sglist->length)) break; sglist++; } } REG0; rtrc(2) /* * Wait for irq (split into second state of irq handler * if this can take time) */ if ((k = ql_wai(priv))) return (k << 16); k = inb(qbase + 5); /* should be 0x10, bus service */ } /* * Enter Status (and Message In) Phase */ k = jiffies + WATCHDOG; while (time_before(jiffies, k) && !priv->qabort && !(inb(qbase + 4) & 6)) cpu_relax(); /* wait for status phase */ if (time_after_eq(jiffies, k)) { ql_zap(priv); return (DID_TIME_OUT << 16); } /* FIXME: timeout ?? */ while (inb(qbase + 5)) cpu_relax(); /* clear pending ints */ if (priv->qabort) return ((priv->qabort == 1 ? DID_ABORT : DID_RESET) << 16); outb(0x11, qbase + 3); /* get status and message */ if ((k = ql_wai(priv))) return (k << 16); i = inb(qbase + 5); /* get chip irq stat */ j = inb(qbase + 7) & 0x1f; /* and bytes rec'd */ status = inb(qbase + 2); message = inb(qbase + 2); /* * Should get function complete int if Status and message, else * bus serv if only status */ if (!((i == 8 && j == 2) || (i == 0x10 && j == 1))) { printk(KERN_ERR "Ql:Error during status phase, int=%02X, %d bytes recd\n", i, j); result = DID_ERROR; } outb(0x12, qbase + 3); /* done, disconnect */ rtrc(1) if ((k = ql_wai(priv))) return (k << 16); /* * Should get bus service interrupt and disconnect interrupt */ i = inb(qbase + 5); /* should be bus service */ while (!priv->qabort && ((i & 0x20) != 0x20)) { barrier(); cpu_relax(); i |= inb(qbase + 5); } rtrc(0) if (priv->qabort) return ((priv->qabort == 1 ? DID_ABORT : DID_RESET) << 16); return (result << 16) | (message << 8) | (status & STATUS_MASK); } /* * Interrupt handler */ static void ql_ihandl(int irq, void *dev_id, struct pt_regs *regs) { Scsi_Cmnd *icmd; struct Scsi_Host *host = (struct Scsi_Host *)dev_id; qlogicfas_priv_t priv = (qlogicfas_priv_t)&(host->hostdata[0]); int qbase = priv->qbase; REG0; if (!(inb(qbase + 4) & 0x80)) /* false alarm? */ return; if (priv->qlcmd == NULL) { /* no command to process? */ int i; i = 16; while (i-- && inb(qbase + 5)); /* maybe also ql_zap() */ return; } icmd = priv->qlcmd; icmd->result = ql_pcmd(icmd); priv->qlcmd = NULL; /* * If result is CHECK CONDITION done calls qcommand to request * sense */ (icmd->scsi_done) (icmd); } irqreturn_t do_ql_ihandl(int irq, void *dev_id, struct pt_regs *regs) { unsigned long flags; struct Scsi_Host *host = dev_id; spin_lock_irqsave(host->host_lock, flags); ql_ihandl(irq, dev_id, regs); spin_unlock_irqrestore(host->host_lock, flags); return IRQ_HANDLED; } /* * Queued command */ int qlogicfas_queuecommand(Scsi_Cmnd * cmd, void (*done) (Scsi_Cmnd *)) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(cmd->device->host->hostdata[0]); if (cmd->device->id == priv->qinitid) { cmd->result = DID_BAD_TARGET << 16; done(cmd); return 0; } cmd->scsi_done = done; /* wait for the last command's interrupt to finish */ while (priv->qlcmd != NULL) { barrier(); cpu_relax(); } ql_icmd(cmd); return 0; } #ifndef PCMCIA /* * Look for qlogic card and init if found */ struct Scsi_Host *__qlogicfas_detect(Scsi_Host_Template *host, int qbase, int qlirq) { int i, j; /* these are only used by IRQ detect */ int qltyp; /* type of chip */ int qinitid; struct Scsi_Host *hreg; /* registered host structure */ qlogicfas_priv_t priv; /* Qlogic Cards only exist at 0x230 or 0x330 (the chip itself * decodes the address - I check 230 first since MIDI cards are * typically at 0x330 * * Theoretically, two Qlogic cards can coexist in the same system. * This should work by simply using this as a loadable module for * the second card, but I haven't tested this. */ if (!qbase) { for (qbase = 0x230; qbase < 0x430; qbase += 0x100) { if (!request_region(qbase, 0x10, qlogicfas_name)) continue; REG1; if (((inb(qbase + 0xe) ^ inb(qbase + 0xe)) == 7) && ((inb(qbase + 0xe) ^ inb(qbase + 0xe)) == 7)) break; release_region(qbase, 0x10); } if (qbase == 0x430) return NULL; } else printk(KERN_INFO "Ql: Using preset base address of %03x\n", qbase); qltyp = inb(qbase + 0xe) & 0xf8; qinitid = host->this_id; if (qinitid < 0) qinitid = 7; /* if no ID, use 7 */ outb(1, qbase + 8); /* set for PIO pseudo DMA */ REG0; outb(0x40 | qlcfg8 | qinitid, qbase + 8); /* (ini) bus id, disable scsi rst */ outb(qlcfg5, qbase + 5); /* select timer */ outb(qlcfg9, qbase + 9); /* prescaler */ #if QL_RESET_AT_START outb(3, qbase + 3); REG1; /* FIXME: timeout */ while (inb(qbase + 0xf) & 4) cpu_relax(); REG0; #endif /* * IRQ probe - toggle pin and check request pending */ if (qlirq == -1) { i = 0xffff; j = 3; outb(0x90, qbase + 3); /* illegal command - cause interrupt */ REG1; outb(10, 0x20); /* access pending interrupt map */ outb(10, 0xa0); while (j--) { outb(0xb0 | QL_INT_ACTIVE_HIGH, qbase + 0xd); /* int pin off */ i &= ~(inb(0x20) | (inb(0xa0) << 8)); /* find IRQ off */ outb(0xb4 | QL_INT_ACTIVE_HIGH, qbase + 0xd); /* int pin on */ i &= inb(0x20) | (inb(0xa0) << 8); /* find IRQ on */ } REG0; while (inb(qbase + 5)); /* purge int */ j = -1; while (i) /* find on bit */ i >>= 1, j++; /* should check for exactly 1 on */ qlirq = j; } else printk(KERN_INFO "Ql: Using preset IRQ %d\n", qlirq); hreg = scsi_host_alloc(host, sizeof(struct qlogicfas_priv)); if (!hreg) goto err_release_mem; priv = (qlogicfas_priv_t)&(hreg->hostdata[0]); hreg->io_port = qbase; hreg->n_io_port = 16; hreg->dma_channel = -1; if (qlirq != -1) hreg->irq = qlirq; priv->qbase = qbase; priv->qlirq = qlirq; priv->qinitid = qinitid; priv->shost = hreg; sprintf(priv->qinfo, "Qlogicfas Driver version 0.46, chip %02X at %03X, IRQ %d, TPdma:%d", qltyp, qbase, qlirq, QL_TURBO_PDMA); host->name = qlogicfas_name; if (request_irq(qlirq, do_ql_ihandl, 0, qlogicfas_name, hreg)) goto free_scsi_host; if (scsi_add_host(hreg, NULL)) goto free_interrupt; scsi_scan_host(hreg); return hreg; free_interrupt: free_irq(qlirq, hreg); free_scsi_host: scsi_host_put(hreg); err_release_mem: release_region(qbase, 0x10); return NULL; } #define MAX_QLOGICFAS 8 static qlogicfas_priv_t cards; static int iobase[MAX_QLOGICFAS]; static int irq[MAX_QLOGICFAS] = { [0 ... MAX_QLOGICFAS-1] = -1 }; MODULE_PARM(iobase, "1-" __MODULE_STRING(MAX_QLOGICFAS) "i"); MODULE_PARM(irq, "1-" __MODULE_STRING(MAX_QLOGICFAS) "i"); MODULE_PARM_DESC(iobase, "I/O address"); MODULE_PARM_DESC(irq, "IRQ"); int __devinit qlogicfas_detect(Scsi_Host_Template *sht) { struct Scsi_Host *shost; qlogicfas_priv_t priv; int i, num = 0; for (i = 0; i < MAX_QLOGICFAS; i++) { shost = __qlogicfas_detect(sht, iobase[num], irq[num]); if (shost == NULL) { /* no more devices */ break; } priv = (qlogicfas_priv_t)&(shost->hostdata[0]); priv->next = cards; cards = priv; num++; } return num; } static int qlogicfas_release(struct Scsi_Host *shost) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(shost->hostdata[0]); int qbase = priv->qbase; if (shost->irq) { REG1; outb(0, qbase + 0xb); /* disable ints */ free_irq(shost->irq, shost); } if (shost->dma_channel != 0xff) free_dma(shost->dma_channel); if (shost->io_port && shost->n_io_port) release_region(shost->io_port, shost->n_io_port); scsi_remove_host(shost); scsi_host_put(shost); return 0; } #endif /* ifndef PCMCIA */ /* * Return bios parameters */ int qlogicfas_biosparam(struct scsi_device * disk, struct block_device *dev, sector_t capacity, int ip[]) { /* This should mimic the DOS Qlogic driver's behavior exactly */ ip[0] = 0x40; ip[1] = 0x20; ip[2] = (unsigned long) capacity / (ip[0] * ip[1]); if (ip[2] > 1024) { ip[0] = 0xff; ip[1] = 0x3f; ip[2] = (unsigned long) capacity / (ip[0] * ip[1]); #if 0 if (ip[2] > 1023) ip[2] = 1023; #endif } return 0; } /* * Abort a command in progress */ static int qlogicfas_abort(Scsi_Cmnd * cmd) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(cmd->device->host->hostdata[0]); priv->qabort = 1; ql_zap(priv); return SUCCESS; } /* * Reset SCSI bus * FIXME: This function is invoked with cmd = NULL directly by * the PCMCIA qlogic_stub code. This wants fixing */ int qlogicfas_bus_reset(Scsi_Cmnd * cmd) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(cmd->device->host->hostdata[0]); priv->qabort = 2; ql_zap(priv); return SUCCESS; } /* * Reset SCSI host controller */ static int qlogicfas_host_reset(Scsi_Cmnd * cmd) { return FAILED; } /* * Reset SCSI device */ static int qlogicfas_device_reset(Scsi_Cmnd * cmd) { return FAILED; } /* * Return info string */ static const char *qlogicfas_info(struct Scsi_Host *host) { qlogicfas_priv_t priv = (qlogicfas_priv_t)&(host->hostdata[0]); return priv->qinfo; } /* * The driver template is also needed for PCMCIA */ Scsi_Host_Template qlogicfas_driver_template = { .module = THIS_MODULE, .name = qlogicfas_name, .proc_name = qlogicfas_name, .info = qlogicfas_info, .queuecommand = qlogicfas_queuecommand, .eh_abort_handler = qlogicfas_abort, .eh_bus_reset_handler = qlogicfas_bus_reset, .eh_device_reset_handler= qlogicfas_device_reset, .eh_host_reset_handler = qlogicfas_host_reset, .bios_param = qlogicfas_biosparam, .can_queue = 1, .this_id = -1, .sg_tablesize = SG_ALL, .cmd_per_lun = 1, .use_clustering = DISABLE_CLUSTERING, }; #ifndef PCMCIA static __init int qlogicfas_init(void) { if (!qlogicfas_detect(&qlogicfas_driver_template)) { /* no cards found */ return -ENODEV; } return 0; } static __exit void qlogicfas_exit(void) { qlogicfas_priv_t priv; for (priv = cards; priv != NULL; priv = priv->next) qlogicfas_release(priv->shost); } MODULE_AUTHOR("Tom Zerucha, Michael Griffith"); MODULE_DESCRIPTION("Driver for the Qlogic FAS SCSI controllers"); MODULE_LICENSE("GPL"); module_init(qlogicfas_init); module_exit(qlogicfas_exit); #endif /* ifndef PCMCIA */