1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic Generic NCR5380 driver
5 * Copyright 1993, Drew Eckhardt
7 * (Unix and Linux consulting and custom programming)
11 * NCR53C400 extensions (c) 1994,1995,1996, Kevin Lentin
12 * K.Lentin@cs.monash.edu.au
14 * NCR53C400A extensions (c) 1996, Ingmar Baumgart
15 * ingmar@gonzo.schwaben.de
17 * DTC3181E extensions (c) 1997, Ronald van Cuijlenborg
18 * ronald.van.cuijlenborg@tip.nl or nutty@dds.nl
20 * Added ISAPNP support for DTC436 adapters,
21 * Thomas Sailer, sailer@ife.ee.ethz.ch
23 * See Documentation/scsi/g_NCR5380.rst for more info.
27 #include <linux/blkdev.h>
28 #include <linux/module.h>
29 #include <scsi/scsi_host.h>
30 #include <linux/init.h>
31 #include <linux/ioport.h>
32 #include <linux/isa.h>
33 #include <linux/pnp.h>
34 #include <linux/interrupt.h>
36 /* Definitions for the core NCR5380 driver. */
38 #define NCR5380_read(reg) \
39 ioread8(hostdata->io + hostdata->offset + (reg))
40 #define NCR5380_write(reg, value) \
41 iowrite8(value, hostdata->io + hostdata->offset + (reg))
43 #define NCR5380_implementation_fields \
45 int c400_ctl_status; \
52 #define NCR5380_dma_xfer_len generic_NCR5380_dma_xfer_len
53 #define NCR5380_dma_recv_setup generic_NCR5380_precv
54 #define NCR5380_dma_send_setup generic_NCR5380_psend
55 #define NCR5380_dma_residual generic_NCR5380_dma_residual
57 #define NCR5380_intr generic_NCR5380_intr
58 #define NCR5380_queue_command generic_NCR5380_queue_command
59 #define NCR5380_abort generic_NCR5380_abort
60 #define NCR5380_host_reset generic_NCR5380_host_reset
61 #define NCR5380_info generic_NCR5380_info
63 #define NCR5380_io_delay(x) udelay(x)
67 #define DRV_MODULE_NAME "g_NCR5380"
69 #define NCR53C400_mem_base 0x3880
70 #define NCR53C400_host_buffer 0x3900
71 #define NCR53C400_region_size 0x3a00
73 #define BOARD_NCR5380 0
74 #define BOARD_NCR53C400 1
75 #define BOARD_NCR53C400A 2
76 #define BOARD_DTC3181E 3
77 #define BOARD_HP_C2502 4
82 #define DMA_MAX_SIZE 32768
84 /* old-style parameters for compatibility */
85 static int ncr_irq = -1;
88 static int ncr_53c400;
89 static int ncr_53c400a;
92 module_param_hw(ncr_irq, int, irq, 0);
93 module_param_hw(ncr_addr, int, ioport, 0);
94 module_param(ncr_5380, int, 0);
95 module_param(ncr_53c400, int, 0);
96 module_param(ncr_53c400a, int, 0);
97 module_param(dtc_3181e, int, 0);
98 module_param(hp_c2502, int, 0);
100 static int irq[] = { -1, -1, -1, -1, -1, -1, -1, -1 };
101 module_param_hw_array(irq, int, irq, NULL, 0);
102 MODULE_PARM_DESC(irq, "IRQ number(s) (0=none, 254=auto [default])");
104 static int base[] = { 0, 0, 0, 0, 0, 0, 0, 0 };
105 module_param_hw_array(base, int, ioport, NULL, 0);
106 MODULE_PARM_DESC(base, "base address(es)");
108 static int card[] = { -1, -1, -1, -1, -1, -1, -1, -1 };
109 module_param_array(card, int, NULL, 0);
110 MODULE_PARM_DESC(card, "card type (0=NCR5380, 1=NCR53C400, 2=NCR53C400A, 3=DTC3181E, 4=HP C2502)");
112 MODULE_ALIAS("g_NCR5380_mmio");
113 MODULE_LICENSE("GPL");
115 static void g_NCR5380_trigger_irq(struct Scsi_Host *instance)
117 struct NCR5380_hostdata *hostdata = shost_priv(instance);
120 * An interrupt is triggered whenever BSY = false, SEL = true
121 * and a bit set in the SELECT_ENABLE_REG is asserted on the
124 * Note that the bus is only driven when the phase control signals
125 * (I/O, C/D, and MSG) match those in the TCR.
127 NCR5380_write(TARGET_COMMAND_REG,
128 PHASE_SR_TO_TCR(NCR5380_read(STATUS_REG) & PHASE_MASK));
129 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
130 NCR5380_write(OUTPUT_DATA_REG, hostdata->id_mask);
131 NCR5380_write(INITIATOR_COMMAND_REG,
132 ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_SEL);
136 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
137 NCR5380_write(SELECT_ENABLE_REG, 0);
138 NCR5380_write(TARGET_COMMAND_REG, 0);
142 * g_NCR5380_probe_irq - find the IRQ of a NCR5380 or equivalent
143 * @instance: SCSI host instance
145 * Autoprobe for the IRQ line used by the card by triggering an IRQ
146 * and then looking to see what interrupt actually turned up.
149 static int g_NCR5380_probe_irq(struct Scsi_Host *instance)
151 struct NCR5380_hostdata *hostdata = shost_priv(instance);
154 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
155 irq_mask = probe_irq_on();
156 g_NCR5380_trigger_irq(instance);
157 irq = probe_irq_off(irq_mask);
158 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
166 * Configure I/O address of 53C400A or DTC436 by writing magic numbers
167 * to ports 0x779 and 0x379.
169 static void magic_configure(int idx, u8 irq, u8 magic[])
173 outb(magic[0], 0x779);
174 outb(magic[1], 0x379);
175 outb(magic[2], 0x379);
176 outb(magic[3], 0x379);
177 outb(magic[4], 0x379);
182 if (idx >= 0 && idx <= 7)
183 cfg = 0x80 | idx | (irq << 4);
187 static irqreturn_t legacy_empty_irq_handler(int irq, void *dev_id)
192 static int legacy_find_free_irq(int *irq_table)
194 while (*irq_table != -1) {
195 if (!request_irq(*irq_table, legacy_empty_irq_handler,
196 IRQF_PROBE_SHARED, "Test IRQ",
197 (void *)irq_table)) {
198 free_irq(*irq_table, (void *) irq_table);
206 static unsigned int ncr_53c400a_ports[] = {
207 0x280, 0x290, 0x300, 0x310, 0x330, 0x340, 0x348, 0x350, 0
209 static unsigned int dtc_3181e_ports[] = {
210 0x220, 0x240, 0x280, 0x2a0, 0x2c0, 0x300, 0x320, 0x340, 0
212 static u8 ncr_53c400a_magic[] = { /* 53C400A & DTC436 */
213 0x59, 0xb9, 0xc5, 0xae, 0xa6
215 static u8 hp_c2502_magic[] = { /* HP C2502 */
216 0x0f, 0x22, 0xf0, 0x20, 0x80
218 static int hp_c2502_irqs[] = {
222 static int generic_NCR5380_init_one(struct scsi_host_template *tpnt,
223 struct device *pdev, int base, int irq, int board)
225 bool is_pmio = base <= 0xffff;
228 unsigned int *ports = NULL;
232 unsigned long region_size;
233 struct Scsi_Host *instance;
234 struct NCR5380_hostdata *hostdata;
239 flags = FLAG_NO_PSEUDO_DMA | FLAG_DMA_FIXUP;
241 case BOARD_NCR53C400A:
242 ports = ncr_53c400a_ports;
243 magic = ncr_53c400a_magic;
246 ports = ncr_53c400a_ports;
247 magic = hp_c2502_magic;
250 ports = dtc_3181e_ports;
251 magic = ncr_53c400a_magic;
255 if (is_pmio && ports && magic) {
256 /* wakeup sequence for the NCR53C400A and DTC3181E */
258 /* Disable the adapter and look for a free io port */
259 magic_configure(-1, 0, magic);
263 for (i = 0; ports[i]; i++) {
264 if (base == ports[i]) { /* index found */
265 if (!request_region(ports[i],
273 for (i = 0; ports[i]; i++) {
274 if (!request_region(ports[i], region_size,
277 if (inb(ports[i]) == 0xff)
279 release_region(ports[i], region_size);
282 /* At this point we have our region reserved */
283 magic_configure(i, 0, magic); /* no IRQ yet */
285 outb(0xc0, base + 9);
286 if (inb(base + 9) != 0x80) {
293 } else if (is_pmio) {
294 /* NCR5380 - no configuration, just grab */
296 if (!base || !request_region(base, region_size, "ncr5380"))
299 region_size = NCR53C400_region_size;
300 if (!request_mem_region(base, region_size, "ncr5380"))
305 iomem = ioport_map(base, region_size);
307 iomem = ioremap(base, region_size);
314 instance = scsi_host_alloc(tpnt, sizeof(struct NCR5380_hostdata));
315 if (instance == NULL) {
319 hostdata = shost_priv(instance);
321 hostdata->board = board;
322 hostdata->io = iomem;
323 hostdata->region_size = region_size;
326 hostdata->io_port = base;
327 hostdata->io_width = 1; /* 8-bit PDMA by default */
328 hostdata->offset = 0;
331 * On NCR53C400 boards, NCR5380 registers are mapped 8 past
335 case BOARD_NCR53C400:
336 hostdata->io_port += 8;
337 hostdata->c400_ctl_status = 0;
338 hostdata->c400_blk_cnt = 1;
339 hostdata->c400_host_buf = 4;
342 hostdata->io_width = 2; /* 16-bit PDMA */
344 case BOARD_NCR53C400A:
346 hostdata->c400_ctl_status = 9;
347 hostdata->c400_blk_cnt = 10;
348 hostdata->c400_host_buf = 8;
352 hostdata->base = base;
353 hostdata->offset = NCR53C400_mem_base;
355 case BOARD_NCR53C400:
356 hostdata->c400_ctl_status = 0x100;
357 hostdata->c400_blk_cnt = 0x101;
358 hostdata->c400_host_buf = 0x104;
361 case BOARD_NCR53C400A:
363 pr_err(DRV_MODULE_NAME ": unknown register offsets\n");
369 /* Check for vacant slot */
370 NCR5380_write(MODE_REG, 0);
371 if (NCR5380_read(MODE_REG) != 0) {
376 ret = NCR5380_init(instance, flags | FLAG_LATE_DMA_SETUP);
381 case BOARD_NCR53C400:
383 case BOARD_NCR53C400A:
385 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
388 NCR5380_maybe_reset_bus(instance);
390 /* Compatibility with documented NCR5380 kernel parameters */
391 if (irq == 255 || irq == 0)
396 if (board == BOARD_HP_C2502) {
397 int *irq_table = hp_c2502_irqs;
405 board_irq = legacy_find_free_irq(irq_table);
408 while (*irq_table != -1)
409 if (*irq_table++ == irq)
413 if (board_irq <= 0) {
418 magic_configure(port_idx, board_irq, magic);
421 if (irq == IRQ_AUTO) {
422 instance->irq = g_NCR5380_probe_irq(instance);
423 if (instance->irq == NO_IRQ)
424 shost_printk(KERN_INFO, instance, "no irq detected\n");
427 if (instance->irq == NO_IRQ)
428 shost_printk(KERN_INFO, instance, "no irq provided\n");
431 if (instance->irq != NO_IRQ) {
432 if (request_irq(instance->irq, generic_NCR5380_intr,
433 0, "NCR5380", instance)) {
434 instance->irq = NO_IRQ;
435 shost_printk(KERN_INFO, instance,
436 "irq %d denied\n", instance->irq);
438 shost_printk(KERN_INFO, instance,
439 "irq %d acquired\n", instance->irq);
443 ret = scsi_add_host(instance, pdev);
446 scsi_scan_host(instance);
447 dev_set_drvdata(pdev, instance);
451 if (instance->irq != NO_IRQ)
452 free_irq(instance->irq, instance);
453 NCR5380_exit(instance);
455 scsi_host_put(instance);
460 release_region(base, region_size);
462 release_mem_region(base, region_size);
466 static void generic_NCR5380_release_resources(struct Scsi_Host *instance)
468 struct NCR5380_hostdata *hostdata = shost_priv(instance);
469 void __iomem *iomem = hostdata->io;
470 unsigned long io_port = hostdata->io_port;
471 unsigned long base = hostdata->base;
472 unsigned long region_size = hostdata->region_size;
474 scsi_remove_host(instance);
475 if (instance->irq != NO_IRQ)
476 free_irq(instance->irq, instance);
477 NCR5380_exit(instance);
478 scsi_host_put(instance);
481 release_region(io_port, region_size);
483 release_mem_region(base, region_size);
486 /* wait_for_53c80_access - wait for 53C80 registers to become accessible
487 * @hostdata: scsi host private data
489 * The registers within the 53C80 logic block are inaccessible until
490 * bit 7 in the 53C400 control status register gets asserted.
493 static void wait_for_53c80_access(struct NCR5380_hostdata *hostdata)
498 if (hostdata->board == BOARD_DTC3181E)
499 udelay(4); /* DTC436 chip hangs without this */
500 if (NCR5380_read(hostdata->c400_ctl_status) & CSR_53C80_REG)
502 } while (--count > 0);
504 scmd_printk(KERN_ERR, hostdata->connected,
505 "53c80 registers not accessible, device will be reset\n");
506 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
507 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
511 * generic_NCR5380_precv - pseudo DMA receive
512 * @hostdata: scsi host private data
513 * @dst: buffer to write into
514 * @len: transfer size
516 * Perform a pseudo DMA mode receive from a 53C400 or equivalent device.
519 static inline int generic_NCR5380_precv(struct NCR5380_hostdata *hostdata,
520 unsigned char *dst, int len)
525 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE | CSR_TRANS_DIR);
526 NCR5380_write(hostdata->c400_blk_cnt, len / 128);
529 if (start == len - 128) {
530 /* Ignore End of DMA interrupt for the final buffer */
531 if (NCR5380_poll_politely(hostdata, hostdata->c400_ctl_status,
532 CSR_HOST_BUF_NOT_RDY, 0, HZ / 64) < 0)
535 if (NCR5380_poll_politely2(hostdata, hostdata->c400_ctl_status,
536 CSR_HOST_BUF_NOT_RDY, 0,
537 hostdata->c400_ctl_status,
539 CSR_GATED_53C80_IRQ, HZ / 64) < 0 ||
540 NCR5380_read(hostdata->c400_ctl_status) & CSR_HOST_BUF_NOT_RDY)
544 if (hostdata->io_port && hostdata->io_width == 2)
545 insw(hostdata->io_port + hostdata->c400_host_buf,
547 else if (hostdata->io_port)
548 insb(hostdata->io_port + hostdata->c400_host_buf,
551 memcpy_fromio(dst + start,
552 hostdata->io + NCR53C400_host_buffer, 128);
554 } while (start < len);
556 residual = len - start;
559 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
560 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
561 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
563 wait_for_53c80_access(hostdata);
565 if (residual == 0 && NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
566 BASR_END_DMA_TRANSFER,
567 BASR_END_DMA_TRANSFER,
569 scmd_printk(KERN_ERR, hostdata->connected, "%s: End of DMA timeout\n",
572 hostdata->pdma_residual = residual;
578 * generic_NCR5380_psend - pseudo DMA send
579 * @hostdata: scsi host private data
580 * @src: buffer to read from
581 * @len: transfer size
583 * Perform a pseudo DMA mode send to a 53C400 or equivalent device.
586 static inline int generic_NCR5380_psend(struct NCR5380_hostdata *hostdata,
587 unsigned char *src, int len)
592 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
593 NCR5380_write(hostdata->c400_blk_cnt, len / 128);
596 if (NCR5380_poll_politely2(hostdata, hostdata->c400_ctl_status,
597 CSR_HOST_BUF_NOT_RDY, 0,
598 hostdata->c400_ctl_status,
600 CSR_GATED_53C80_IRQ, HZ / 64) < 0 ||
601 NCR5380_read(hostdata->c400_ctl_status) & CSR_HOST_BUF_NOT_RDY) {
602 /* Both 128 B buffers are in use */
610 if (start >= len && NCR5380_read(hostdata->c400_blk_cnt) == 0)
613 if (NCR5380_read(hostdata->c400_ctl_status) & CSR_GATED_53C80_IRQ) {
614 /* Host buffer is empty, other one is in use */
623 if (hostdata->io_port && hostdata->io_width == 2)
624 outsw(hostdata->io_port + hostdata->c400_host_buf,
626 else if (hostdata->io_port)
627 outsb(hostdata->io_port + hostdata->c400_host_buf,
630 memcpy_toio(hostdata->io + NCR53C400_host_buffer,
635 residual = len - start;
638 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
639 NCR5380_write(hostdata->c400_ctl_status, CSR_RESET);
640 NCR5380_write(hostdata->c400_ctl_status, CSR_BASE);
642 wait_for_53c80_access(hostdata);
645 if (NCR5380_poll_politely(hostdata, TARGET_COMMAND_REG,
646 TCR_LAST_BYTE_SENT, TCR_LAST_BYTE_SENT,
648 scmd_printk(KERN_ERR, hostdata->connected,
649 "%s: Last Byte Sent timeout\n", __func__);
651 if (NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
652 BASR_END_DMA_TRANSFER, BASR_END_DMA_TRANSFER,
654 scmd_printk(KERN_ERR, hostdata->connected, "%s: End of DMA timeout\n",
658 hostdata->pdma_residual = residual;
663 static int generic_NCR5380_dma_xfer_len(struct NCR5380_hostdata *hostdata,
664 struct scsi_cmnd *cmd)
666 int transfersize = cmd->SCp.this_residual;
668 if (hostdata->flags & FLAG_NO_PSEUDO_DMA)
671 /* 53C400 datasheet: non-modulo-128-byte transfers should use PIO */
672 if (transfersize % 128)
675 /* Limit PDMA send to 512 B to avoid random corruption on DTC3181E */
676 if (hostdata->board == BOARD_DTC3181E &&
677 cmd->sc_data_direction == DMA_TO_DEVICE)
678 transfersize = min(cmd->SCp.this_residual, 512);
680 return min(transfersize, DMA_MAX_SIZE);
683 static int generic_NCR5380_dma_residual(struct NCR5380_hostdata *hostdata)
685 return hostdata->pdma_residual;
688 /* Include the core driver code. */
692 static struct scsi_host_template driver_template = {
693 .module = THIS_MODULE,
694 .proc_name = DRV_MODULE_NAME,
695 .name = "Generic NCR5380/NCR53C400 SCSI",
696 .info = generic_NCR5380_info,
697 .queuecommand = generic_NCR5380_queue_command,
698 .eh_abort_handler = generic_NCR5380_abort,
699 .eh_host_reset_handler = generic_NCR5380_host_reset,
702 .sg_tablesize = SG_ALL,
704 .dma_boundary = PAGE_SIZE - 1,
705 .cmd_size = NCR5380_CMD_SIZE,
709 static int generic_NCR5380_isa_match(struct device *pdev, unsigned int ndev)
711 int ret = generic_NCR5380_init_one(&driver_template, pdev, base[ndev],
712 irq[ndev], card[ndev]);
715 printk(KERN_WARNING "Card not found at address 0x%03x\n",
723 static int generic_NCR5380_isa_remove(struct device *pdev,
726 generic_NCR5380_release_resources(dev_get_drvdata(pdev));
727 dev_set_drvdata(pdev, NULL);
731 static struct isa_driver generic_NCR5380_isa_driver = {
732 .match = generic_NCR5380_isa_match,
733 .remove = generic_NCR5380_isa_remove,
735 .name = DRV_MODULE_NAME
740 static const struct pnp_device_id generic_NCR5380_pnp_ids[] = {
741 { .id = "DTC436e", .driver_data = BOARD_DTC3181E },
744 MODULE_DEVICE_TABLE(pnp, generic_NCR5380_pnp_ids);
746 static int generic_NCR5380_pnp_probe(struct pnp_dev *pdev,
747 const struct pnp_device_id *id)
751 if (pnp_activate_dev(pdev) < 0)
754 base = pnp_port_start(pdev, 0);
755 irq = pnp_irq(pdev, 0);
757 return generic_NCR5380_init_one(&driver_template, &pdev->dev, base, irq,
761 static void generic_NCR5380_pnp_remove(struct pnp_dev *pdev)
763 generic_NCR5380_release_resources(pnp_get_drvdata(pdev));
764 pnp_set_drvdata(pdev, NULL);
767 static struct pnp_driver generic_NCR5380_pnp_driver = {
768 .name = DRV_MODULE_NAME,
769 .id_table = generic_NCR5380_pnp_ids,
770 .probe = generic_NCR5380_pnp_probe,
771 .remove = generic_NCR5380_pnp_remove,
773 #endif /* defined(CONFIG_PNP) */
775 static int pnp_registered, isa_registered;
777 static int __init generic_NCR5380_init(void)
781 /* compatibility with old-style parameters */
782 if (irq[0] == -1 && base[0] == 0 && card[0] == -1) {
786 card[0] = BOARD_NCR5380;
788 card[0] = BOARD_NCR53C400;
790 card[0] = BOARD_NCR53C400A;
792 card[0] = BOARD_DTC3181E;
794 card[0] = BOARD_HP_C2502;
798 if (!pnp_register_driver(&generic_NCR5380_pnp_driver))
801 ret = isa_register_driver(&generic_NCR5380_isa_driver, MAX_CARDS);
805 return (pnp_registered || isa_registered) ? 0 : ret;
808 static void __exit generic_NCR5380_exit(void)
812 pnp_unregister_driver(&generic_NCR5380_pnp_driver);
815 isa_unregister_driver(&generic_NCR5380_isa_driver);
818 module_init(generic_NCR5380_init);
819 module_exit(generic_NCR5380_exit);