2 * Generic Generic NCR5380 driver
4 * Copyright 1993, Drew Eckhardt
6 * (Unix and Linux consulting and custom programming)
10 * NCR53C400 extensions (c) 1994,1995,1996, Kevin Lentin
13 * NCR53C400A extensions (c) 1996, Ingmar Baumgart
16 * DTC3181E extensions (c) 1997, Ronald van Cuijlenborg
19 * Added ISAPNP support for DTC436 adapters,
22 * See Documentation/scsi/g_NCR5380.txt for more info.
26 #include <linux/blkdev.h>
27 #include <linux/module.h>
28 #include <scsi/scsi_host.h>
29 #include <linux/init.h>
30 #include <linux/ioport.h>
31 #include <linux/isa.h>
32 #include <linux/pnp.h>
33 #include <linux/interrupt.h>
35 /* Definitions for the core NCR5380 driver. */
37 #define NCR5380_read(reg) \
38 ioread8(hostdata->io + hostdata->offset + (reg))
39 #define NCR5380_write(reg, value) \
40 iowrite8(value, hostdata->io + hostdata->offset + (reg))
42 #define NCR5380_implementation_fields \
44 int c400_ctl_status; \
51 #define NCR5380_dma_xfer_len generic_NCR5380_dma_xfer_len
52 #define NCR5380_dma_recv_setup generic_NCR5380_precv
53 #define NCR5380_dma_send_setup generic_NCR5380_psend
54 #define NCR5380_dma_residual generic_NCR5380_dma_residual
56 #define NCR5380_intr generic_NCR5380_intr
57 #define NCR5380_queue_command generic_NCR5380_queue_command
58 #define NCR5380_abort generic_NCR5380_abort
59 #define NCR5380_host_reset generic_NCR5380_host_reset
60 #define NCR5380_info generic_NCR5380_info
62 #define NCR5380_io_delay(x) udelay(x)
66 #define DRV_MODULE_NAME "g_NCR5380"
68 #define NCR53C400_mem_base 0x3880
69 #define NCR53C400_host_buffer 0x3900
70 #define NCR53C400_region_size 0x3a00
72 #define BOARD_NCR5380 0
73 #define BOARD_NCR53C400 1
74 #define BOARD_NCR53C400A 2
75 #define BOARD_DTC3181E 3
76 #define BOARD_HP_C2502 4
81 #define DMA_MAX_SIZE 32768
83 /* old-style parameters for compatibility */
84 static int ncr_irq = -1;
87 static int ncr_53c400;
88 static int ncr_53c400a;
91 module_param_hw(ncr_irq, int, irq, 0);
92 module_param_hw(ncr_addr, int, ioport, 0);
93 module_param(ncr_5380, int, 0);
94 module_param(ncr_53c400, int, 0);
95 module_param(ncr_53c400a, int, 0);
96 module_param(dtc_3181e, int, 0);
97 module_param(hp_c2502, int, 0);
99 static int irq[] = { -1, -1, -1, -1, -1, -1, -1, -1 };
100 module_param_hw_array(irq, int, irq, NULL, 0);
101 MODULE_PARM_DESC(irq, "IRQ number(s) (0=none, 254=auto [default])");
103 static int base[] = { 0, 0, 0, 0, 0, 0, 0, 0 };
104 module_param_hw_array(base, int, ioport, NULL, 0);
105 MODULE_PARM_DESC(base, "base address(es)");
107 static int card[] = { -1, -1, -1, -1, -1, -1, -1, -1 };
108 module_param_array(card, int, NULL, 0);
109 MODULE_PARM_DESC(card, "card type (0=NCR5380, 1=NCR53C400, 2=NCR53C400A, 3=DTC3181E, 4=HP C2502)");
111 MODULE_ALIAS("g_NCR5380_mmio");
112 MODULE_LICENSE("GPL");
114 static void g_NCR5380_trigger_irq(struct Scsi_Host *instance)
116 struct NCR5380_hostdata *hostdata = shost_priv(instance);
119 * An interrupt is triggered whenever BSY = false, SEL = true
120 * and a bit set in the SELECT_ENABLE_REG is asserted on the
123 * Note that the bus is only driven when the phase control signals
124 * (I/O, C/D, and MSG) match those in the TCR.
126 NCR5380_write(TARGET_COMMAND_REG,
127 PHASE_SR_TO_TCR(NCR5380_read(STATUS_REG) & PHASE_MASK));
128 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
129 NCR5380_write(OUTPUT_DATA_REG, hostdata->id_mask);
130 NCR5380_write(INITIATOR_COMMAND_REG,
131 ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_SEL);
135 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
136 NCR5380_write(SELECT_ENABLE_REG, 0);
137 NCR5380_write(TARGET_COMMAND_REG, 0);
141 * g_NCR5380_probe_irq - find the IRQ of a NCR5380 or equivalent
142 * @instance: SCSI host instance
144 * Autoprobe for the IRQ line used by the card by triggering an IRQ
145 * and then looking to see what interrupt actually turned up.
148 static int g_NCR5380_probe_irq(struct Scsi_Host *instance)
150 struct NCR5380_hostdata *hostdata = shost_priv(instance);
153 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
154 irq_mask = probe_irq_on();
155 g_NCR5380_trigger_irq(instance);
156 irq = probe_irq_off(irq_mask);
157 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
165 * Configure I/O address of 53C400A or DTC436 by writing magic numbers
166 * to ports 0x779 and 0x379.
168 static void magic_configure(int idx, u8 irq, u8 magic[])
172 outb(magic[0], 0x779);
173 outb(magic[1], 0x379);
174 outb(magic[2], 0x379);
175 outb(magic[3], 0x379);
176 outb(magic[4], 0x379);
181 if (idx >= 0 && idx <= 7)
182 cfg = 0x80 | idx | (irq << 4);
186 static irqreturn_t legacy_empty_irq_handler(int irq, void *dev_id)
191 static int legacy_find_free_irq(int *irq_table)
193 while (*irq_table != -1) {
194 if (!request_irq(*irq_table, legacy_empty_irq_handler,
195 IRQF_PROBE_SHARED, "Test IRQ",
196 (void *)irq_table)) {
197 free_irq(*irq_table, (void *) irq_table);
205 static unsigned int ncr_53c400a_ports[] = {
206 0x280, 0x290, 0x300, 0x310, 0x330, 0x340, 0x348, 0x350, 0
208 static unsigned int dtc_3181e_ports[] = {
209 0x220, 0x240, 0x280, 0x2a0, 0x2c0, 0x300, 0x320, 0x340, 0
211 static u8 ncr_53c400a_magic[] = { /* 53C400A & DTC436 */
212 0x59, 0xb9, 0xc5, 0xae, 0xa6
214 static u8 hp_c2502_magic[] = { /* HP C2502 */
215 0x0f, 0x22, 0xf0, 0x20, 0x80
217 static int hp_c2502_irqs[] = {
221 static int generic_NCR5380_init_one(struct scsi_host_template *tpnt,
222 struct device *pdev, int base, int irq, int board)
224 bool is_pmio = base <= 0xffff;
227 unsigned int *ports = NULL;
231 unsigned long region_size;
232 struct Scsi_Host *instance;
233 struct NCR5380_hostdata *hostdata;
238 flags = FLAG_NO_PSEUDO_DMA | FLAG_DMA_FIXUP;
240 case BOARD_NCR53C400A:
241 ports = ncr_53c400a_ports;
242 magic = ncr_53c400a_magic;
245 ports = ncr_53c400a_ports;
246 magic = hp_c2502_magic;
249 ports = dtc_3181e_ports;
250 magic = ncr_53c400a_magic;
254 if (is_pmio && ports && magic) {
255 /* wakeup sequence for the NCR53C400A and DTC3181E */
257 /* Disable the adapter and look for a free io port */
258 magic_configure(-1, 0, magic);
262 for (i = 0; ports[i]; i++) {
263 if (base == ports[i]) { /* index found */
264 if (!request_region(ports[i],
272 for (i = 0; ports[i]; i++) {
273 if (!request_region(ports[i], region_size,
276 if (inb(ports[i]) == 0xff)
278 release_region(ports[i], region_size);
281 /* At this point we have our region reserved */
282 magic_configure(i, 0, magic); /* no IRQ yet */
284 outb(0xc0, base + 9);
285 if (inb(base + 9) != 0x80) {
292 } else if (is_pmio) {
293 /* NCR5380 - no configuration, just grab */
295 if (!base || !request_region(base, region_size, "ncr5380"))
298 region_size = NCR53C400_region_size;
299 if (!request_mem_region(base, region_size, "ncr5380"))
304 iomem = ioport_map(base, region_size);
306 iomem = ioremap(base, region_size);
313 instance = scsi_host_alloc(tpnt, sizeof(struct NCR5380_hostdata));
314 if (instance == NULL) {
318 hostdata = shost_priv(instance);
320 hostdata->board = board;
321 hostdata->io = iomem;
322 hostdata->region_size = region_size;
325 hostdata->io_port = base;
326 hostdata->io_width = 1; /* 8-bit PDMA by default */
327 hostdata->offset = 0;
330 * On NCR53C400 boards, NCR5380 registers are mapped 8 past
334 case BOARD_NCR53C400:
335 hostdata->io_port += 8;
336 hostdata->c400_ctl_status = 0;
337 hostdata->c400_blk_cnt = 1;
338 hostdata->c400_host_buf = 4;
341 hostdata->io_width = 2; /* 16-bit PDMA */
343 case BOARD_NCR53C400A:
345 hostdata->c400_ctl_status = 9;
346 hostdata->c400_blk_cnt = 10;
347 hostdata->c400_host_buf = 8;
351 hostdata->base = base;
352 hostdata->offset = NCR53C400_mem_base;
354 case BOARD_NCR53C400:
355 hostdata->c400_ctl_status = 0x100;
356 hostdata->c400_blk_cnt = 0x101;
357 hostdata->c400_host_buf = 0x104;
360 case BOARD_NCR53C400A:
362 pr_err(DRV_MODULE_NAME ": unknown register offsets\n");
368 /* Check for vacant slot */
369 NCR5380_write(MODE_REG, 0);
370 if (NCR5380_read(MODE_REG) != 0) {
375 ret = NCR5380_init(instance, flags | FLAG_LATE_DMA_SETUP);
380 case BOARD_NCR53C400:
382 case BOARD_NCR53C400A:
384 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
387 NCR5380_maybe_reset_bus(instance);
389 /* Compatibility with documented NCR5380 kernel parameters */
390 if (irq == 255 || irq == 0)
395 if (board == BOARD_HP_C2502) {
396 int *irq_table = hp_c2502_irqs;
404 board_irq = legacy_find_free_irq(irq_table);
407 while (*irq_table != -1)
408 if (*irq_table++ == irq)
412 if (board_irq <= 0) {
417 magic_configure(port_idx, board_irq, magic);
420 if (irq == IRQ_AUTO) {
421 instance->irq = g_NCR5380_probe_irq(instance);
422 if (instance->irq == NO_IRQ)
423 shost_printk(KERN_INFO, instance, "no irq detected\n");
426 if (instance->irq == NO_IRQ)
427 shost_printk(KERN_INFO, instance, "no irq provided\n");
430 if (instance->irq != NO_IRQ) {
431 if (request_irq(instance->irq, generic_NCR5380_intr,
432 0, "NCR5380", instance)) {
433 instance->irq = NO_IRQ;
434 shost_printk(KERN_INFO, instance,
435 "irq %d denied\n", instance->irq);
437 shost_printk(KERN_INFO, instance,
438 "irq %d acquired\n", instance->irq);
442 ret = scsi_add_host(instance, pdev);
445 scsi_scan_host(instance);
446 dev_set_drvdata(pdev, instance);
450 if (instance->irq != NO_IRQ)
451 free_irq(instance->irq, instance);
452 NCR5380_exit(instance);
454 scsi_host_put(instance);
459 release_region(base, region_size);
461 release_mem_region(base, region_size);
465 static void generic_NCR5380_release_resources(struct Scsi_Host *instance)
467 struct NCR5380_hostdata *hostdata = shost_priv(instance);
468 void __iomem *iomem = hostdata->io;
469 unsigned long io_port = hostdata->io_port;
470 unsigned long base = hostdata->base;
471 unsigned long region_size = hostdata->region_size;
473 scsi_remove_host(instance);
474 if (instance->irq != NO_IRQ)
475 free_irq(instance->irq, instance);
476 NCR5380_exit(instance);
477 scsi_host_put(instance);
480 release_region(io_port, region_size);
482 release_mem_region(base, region_size);
485 /* wait_for_53c80_access - wait for 53C80 registers to become accessible
486 * @hostdata: scsi host private data
488 * The registers within the 53C80 logic block are inaccessible until
489 * bit 7 in the 53C400 control status register gets asserted.
492 static void wait_for_53c80_access(struct NCR5380_hostdata *hostdata)
497 if (hostdata->board == BOARD_DTC3181E)
498 udelay(4); /* DTC436 chip hangs without this */
499 if (NCR5380_read(hostdata->c400_ctl_status) & CSR_53C80_REG)
501 } while (--count > 0);
503 scmd_printk(KERN_ERR, hostdata->connected,
504 "53c80 registers not accessible, device will be reset\n");
505 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
506 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
510 * generic_NCR5380_precv - pseudo DMA receive
511 * @hostdata: scsi host private data
512 * @dst: buffer to write into
513 * @len: transfer size
515 * Perform a pseudo DMA mode receive from a 53C400 or equivalent device.
518 static inline int generic_NCR5380_precv(struct NCR5380_hostdata *hostdata,
519 unsigned char *dst, int len)
524 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE | CSR_TRANS_DIR);
525 NCR5380_write(hostdata->c400_blk_cnt, len / 128);
528 if (start == len - 128) {
529 /* Ignore End of DMA interrupt for the final buffer */
530 if (NCR5380_poll_politely(hostdata, hostdata->c400_ctl_status,
531 CSR_HOST_BUF_NOT_RDY, 0, HZ / 64) < 0)
534 if (NCR5380_poll_politely2(hostdata, hostdata->c400_ctl_status,
535 CSR_HOST_BUF_NOT_RDY, 0,
536 hostdata->c400_ctl_status,
538 CSR_GATED_53C80_IRQ, HZ / 64) < 0 ||
539 NCR5380_read(hostdata->c400_ctl_status) & CSR_HOST_BUF_NOT_RDY)
543 if (hostdata->io_port && hostdata->io_width == 2)
544 insw(hostdata->io_port + hostdata->c400_host_buf,
546 else if (hostdata->io_port)
547 insb(hostdata->io_port + hostdata->c400_host_buf,
550 memcpy_fromio(dst + start,
551 hostdata->io + NCR53C400_host_buffer, 128);
553 } while (start < len);
555 residual = len - start;
558 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
559 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
560 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
562 wait_for_53c80_access(hostdata);
564 if (residual == 0 && NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
565 BASR_END_DMA_TRANSFER,
566 BASR_END_DMA_TRANSFER,
568 scmd_printk(KERN_ERR, hostdata->connected, "%s: End of DMA timeout\n",
571 hostdata->pdma_residual = residual;
577 * generic_NCR5380_psend - pseudo DMA send
578 * @hostdata: scsi host private data
579 * @src: buffer to read from
580 * @len: transfer size
582 * Perform a pseudo DMA mode send to a 53C400 or equivalent device.
585 static inline int generic_NCR5380_psend(struct NCR5380_hostdata *hostdata,
586 unsigned char *src, int len)
591 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
592 NCR5380_write(hostdata->c400_blk_cnt, len / 128);
595 if (NCR5380_poll_politely2(hostdata, hostdata->c400_ctl_status,
596 CSR_HOST_BUF_NOT_RDY, 0,
597 hostdata->c400_ctl_status,
599 CSR_GATED_53C80_IRQ, HZ / 64) < 0 ||
600 NCR5380_read(hostdata->c400_ctl_status) & CSR_HOST_BUF_NOT_RDY) {
601 /* Both 128 B buffers are in use */
609 if (start >= len && NCR5380_read(hostdata->c400_blk_cnt) == 0)
612 if (NCR5380_read(hostdata->c400_ctl_status) & CSR_GATED_53C80_IRQ) {
613 /* Host buffer is empty, other one is in use */
622 if (hostdata->io_port && hostdata->io_width == 2)
623 outsw(hostdata->io_port + hostdata->c400_host_buf,
625 else if (hostdata->io_port)
626 outsb(hostdata->io_port + hostdata->c400_host_buf,
629 memcpy_toio(hostdata->io + NCR53C400_host_buffer,
634 residual = len - start;
637 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
638 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
639 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
641 wait_for_53c80_access(hostdata);
644 if (NCR5380_poll_politely(hostdata, TARGET_COMMAND_REG,
645 TCR_LAST_BYTE_SENT, TCR_LAST_BYTE_SENT,
647 scmd_printk(KERN_ERR, hostdata->connected,
648 "%s: Last Byte Sent timeout\n", __func__);
650 if (NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
651 BASR_END_DMA_TRANSFER, BASR_END_DMA_TRANSFER,
653 scmd_printk(KERN_ERR, hostdata->connected, "%s: End of DMA timeout\n",
657 hostdata->pdma_residual = residual;
662 static int generic_NCR5380_dma_xfer_len(struct NCR5380_hostdata *hostdata,
663 struct scsi_cmnd *cmd)
665 int transfersize = cmd->SCp.this_residual;
667 if (hostdata->flags & FLAG_NO_PSEUDO_DMA)
670 /* 53C400 datasheet: non-modulo-128-byte transfers should use PIO */
671 if (transfersize % 128)
674 /* Limit PDMA send to 512 B to avoid random corruption on DTC3181E */
675 if (hostdata->board == BOARD_DTC3181E &&
676 cmd->sc_data_direction == DMA_TO_DEVICE)
677 transfersize = min(cmd->SCp.this_residual, 512);
679 return min(transfersize, DMA_MAX_SIZE);
682 static int generic_NCR5380_dma_residual(struct NCR5380_hostdata *hostdata)
684 return hostdata->pdma_residual;
687 /* Include the core driver code. */
691 static struct scsi_host_template driver_template = {
692 .module = THIS_MODULE,
693 .proc_name = DRV_MODULE_NAME,
694 .name = "Generic NCR5380/NCR53C400 SCSI",
695 .info = generic_NCR5380_info,
696 .queuecommand = generic_NCR5380_queue_command,
697 .eh_abort_handler = generic_NCR5380_abort,
698 .eh_host_reset_handler = generic_NCR5380_host_reset,
701 .sg_tablesize = SG_ALL,
703 .use_clustering = DISABLE_CLUSTERING,
704 .cmd_size = NCR5380_CMD_SIZE,
708 static int generic_NCR5380_isa_match(struct device *pdev, unsigned int ndev)
710 int ret = generic_NCR5380_init_one(&driver_template, pdev, base[ndev],
711 irq[ndev], card[ndev]);
714 printk(KERN_WARNING "Card not found at address 0x%03x\n",
722 static int generic_NCR5380_isa_remove(struct device *pdev,
725 generic_NCR5380_release_resources(dev_get_drvdata(pdev));
726 dev_set_drvdata(pdev, NULL);
730 static struct isa_driver generic_NCR5380_isa_driver = {
731 .match = generic_NCR5380_isa_match,
732 .remove = generic_NCR5380_isa_remove,
734 .name = DRV_MODULE_NAME
739 static const struct pnp_device_id generic_NCR5380_pnp_ids[] = {
740 { .id = "DTC436e", .driver_data = BOARD_DTC3181E },
743 MODULE_DEVICE_TABLE(pnp, generic_NCR5380_pnp_ids);
745 static int generic_NCR5380_pnp_probe(struct pnp_dev *pdev,
746 const struct pnp_device_id *id)
750 if (pnp_activate_dev(pdev) < 0)
753 base = pnp_port_start(pdev, 0);
754 irq = pnp_irq(pdev, 0);
756 return generic_NCR5380_init_one(&driver_template, &pdev->dev, base, irq,
760 static void generic_NCR5380_pnp_remove(struct pnp_dev *pdev)
762 generic_NCR5380_release_resources(pnp_get_drvdata(pdev));
763 pnp_set_drvdata(pdev, NULL);
766 static struct pnp_driver generic_NCR5380_pnp_driver = {
767 .name = DRV_MODULE_NAME,
768 .id_table = generic_NCR5380_pnp_ids,
769 .probe = generic_NCR5380_pnp_probe,
770 .remove = generic_NCR5380_pnp_remove,
772 #endif /* defined(CONFIG_PNP) */
774 static int pnp_registered, isa_registered;
776 static int __init generic_NCR5380_init(void)
780 /* compatibility with old-style parameters */
781 if (irq[0] == -1 && base[0] == 0 && card[0] == -1) {
785 card[0] = BOARD_NCR5380;
787 card[0] = BOARD_NCR53C400;
789 card[0] = BOARD_NCR53C400A;
791 card[0] = BOARD_DTC3181E;
793 card[0] = BOARD_HP_C2502;
797 if (!pnp_register_driver(&generic_NCR5380_pnp_driver))
800 ret = isa_register_driver(&generic_NCR5380_isa_driver, MAX_CARDS);
804 return (pnp_registered || isa_registered) ? 0 : ret;
807 static void __exit generic_NCR5380_exit(void)
811 pnp_unregister_driver(&generic_NCR5380_pnp_driver);
814 isa_unregister_driver(&generic_NCR5380_isa_driver);
817 module_init(generic_NCR5380_init);
818 module_exit(generic_NCR5380_exit);