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_DESCRIPTION("Generic NCR5380/NCR53C400 SCSI driver");
114 MODULE_LICENSE("GPL");
116 static void g_NCR5380_trigger_irq(struct Scsi_Host
*instance
)
118 struct NCR5380_hostdata
*hostdata
= shost_priv(instance
);
121 * An interrupt is triggered whenever BSY = false, SEL = true
122 * and a bit set in the SELECT_ENABLE_REG is asserted on the
125 * Note that the bus is only driven when the phase control signals
126 * (I/O, C/D, and MSG) match those in the TCR.
128 NCR5380_write(TARGET_COMMAND_REG
,
129 PHASE_SR_TO_TCR(NCR5380_read(STATUS_REG
) & PHASE_MASK
));
130 NCR5380_write(SELECT_ENABLE_REG
, hostdata
->id_mask
);
131 NCR5380_write(OUTPUT_DATA_REG
, hostdata
->id_mask
);
132 NCR5380_write(INITIATOR_COMMAND_REG
,
133 ICR_BASE
| ICR_ASSERT_DATA
| ICR_ASSERT_SEL
);
137 NCR5380_write(INITIATOR_COMMAND_REG
, ICR_BASE
);
138 NCR5380_write(SELECT_ENABLE_REG
, 0);
139 NCR5380_write(TARGET_COMMAND_REG
, 0);
143 * g_NCR5380_probe_irq - find the IRQ of a NCR5380 or equivalent
144 * @instance: SCSI host instance
146 * Autoprobe for the IRQ line used by the card by triggering an IRQ
147 * and then looking to see what interrupt actually turned up.
150 static int g_NCR5380_probe_irq(struct Scsi_Host
*instance
)
152 struct NCR5380_hostdata
*hostdata
= shost_priv(instance
);
155 NCR5380_read(RESET_PARITY_INTERRUPT_REG
);
156 irq_mask
= probe_irq_on();
157 g_NCR5380_trigger_irq(instance
);
158 irq
= probe_irq_off(irq_mask
);
159 NCR5380_read(RESET_PARITY_INTERRUPT_REG
);
167 * Configure I/O address of 53C400A or DTC436 by writing magic numbers
168 * to ports 0x779 and 0x379.
170 static void magic_configure(int idx
, u8 irq
, u8 magic
[])
174 outb(magic
[0], 0x779);
175 outb(magic
[1], 0x379);
176 outb(magic
[2], 0x379);
177 outb(magic
[3], 0x379);
178 outb(magic
[4], 0x379);
183 if (idx
>= 0 && idx
<= 7)
184 cfg
= 0x80 | idx
| (irq
<< 4);
188 static irqreturn_t
legacy_empty_irq_handler(int irq
, void *dev_id
)
193 static int legacy_find_free_irq(int *irq_table
)
195 while (*irq_table
!= -1) {
196 if (!request_irq(*irq_table
, legacy_empty_irq_handler
,
197 IRQF_PROBE_SHARED
, "Test IRQ",
198 (void *)irq_table
)) {
199 free_irq(*irq_table
, (void *) irq_table
);
207 static unsigned int ncr_53c400a_ports
[] = {
208 0x280, 0x290, 0x300, 0x310, 0x330, 0x340, 0x348, 0x350, 0
210 static unsigned int dtc_3181e_ports
[] = {
211 0x220, 0x240, 0x280, 0x2a0, 0x2c0, 0x300, 0x320, 0x340, 0
213 static u8 ncr_53c400a_magic
[] = { /* 53C400A & DTC436 */
214 0x59, 0xb9, 0xc5, 0xae, 0xa6
216 static u8 hp_c2502_magic
[] = { /* HP C2502 */
217 0x0f, 0x22, 0xf0, 0x20, 0x80
219 static int hp_c2502_irqs
[] = {
223 static int generic_NCR5380_init_one(const struct scsi_host_template
*tpnt
,
224 struct device
*pdev
, int base
, int irq
, int board
)
226 bool is_pmio
= base
<= 0xffff;
229 unsigned int *ports
= NULL
;
233 unsigned long region_size
;
234 struct Scsi_Host
*instance
;
235 struct NCR5380_hostdata
*hostdata
;
240 flags
= FLAG_NO_PSEUDO_DMA
| FLAG_DMA_FIXUP
;
242 case BOARD_NCR53C400A
:
243 ports
= ncr_53c400a_ports
;
244 magic
= ncr_53c400a_magic
;
247 ports
= ncr_53c400a_ports
;
248 magic
= hp_c2502_magic
;
251 ports
= dtc_3181e_ports
;
252 magic
= ncr_53c400a_magic
;
256 if (is_pmio
&& ports
&& magic
) {
257 /* wakeup sequence for the NCR53C400A and DTC3181E */
259 /* Disable the adapter and look for a free io port */
260 magic_configure(-1, 0, magic
);
264 for (i
= 0; ports
[i
]; i
++) {
265 if (base
== ports
[i
]) { /* index found */
266 if (!request_region(ports
[i
],
274 for (i
= 0; ports
[i
]; i
++) {
275 if (!request_region(ports
[i
], region_size
,
278 if (inb(ports
[i
]) == 0xff)
280 release_region(ports
[i
], region_size
);
283 /* At this point we have our region reserved */
284 magic_configure(i
, 0, magic
); /* no IRQ yet */
286 outb(0xc0, base
+ 9);
287 if (inb(base
+ 9) != 0x80) {
294 } else if (is_pmio
) {
295 /* NCR5380 - no configuration, just grab */
297 if (!base
|| !request_region(base
, region_size
, "ncr5380"))
300 region_size
= NCR53C400_region_size
;
301 if (!request_mem_region(base
, region_size
, "ncr5380"))
306 iomem
= ioport_map(base
, region_size
);
308 iomem
= ioremap(base
, region_size
);
315 instance
= scsi_host_alloc(tpnt
, sizeof(struct NCR5380_hostdata
));
316 if (instance
== NULL
) {
320 hostdata
= shost_priv(instance
);
322 hostdata
->board
= board
;
323 hostdata
->io
= iomem
;
324 hostdata
->region_size
= region_size
;
327 hostdata
->io_port
= base
;
328 hostdata
->io_width
= 1; /* 8-bit PDMA by default */
329 hostdata
->offset
= 0;
332 * On NCR53C400 boards, NCR5380 registers are mapped 8 past
336 case BOARD_NCR53C400
:
337 hostdata
->io_port
+= 8;
338 hostdata
->c400_ctl_status
= 0;
339 hostdata
->c400_blk_cnt
= 1;
340 hostdata
->c400_host_buf
= 4;
343 hostdata
->io_width
= 2; /* 16-bit PDMA */
345 case BOARD_NCR53C400A
:
347 hostdata
->c400_ctl_status
= 9;
348 hostdata
->c400_blk_cnt
= 10;
349 hostdata
->c400_host_buf
= 8;
353 hostdata
->base
= base
;
354 hostdata
->offset
= NCR53C400_mem_base
;
356 case BOARD_NCR53C400
:
357 hostdata
->c400_ctl_status
= 0x100;
358 hostdata
->c400_blk_cnt
= 0x101;
359 hostdata
->c400_host_buf
= 0x104;
362 case BOARD_NCR53C400A
:
364 pr_err(DRV_MODULE_NAME
": unknown register offsets\n");
370 /* Check for vacant slot */
371 NCR5380_write(MODE_REG
, 0);
372 if (NCR5380_read(MODE_REG
) != 0) {
377 ret
= NCR5380_init(instance
, flags
| FLAG_LATE_DMA_SETUP
);
382 case BOARD_NCR53C400
:
384 case BOARD_NCR53C400A
:
386 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
);
389 NCR5380_maybe_reset_bus(instance
);
391 /* Compatibility with documented NCR5380 kernel parameters */
392 if (irq
== 255 || irq
== 0)
397 if (board
== BOARD_HP_C2502
) {
398 int *irq_table
= hp_c2502_irqs
;
406 board_irq
= legacy_find_free_irq(irq_table
);
409 while (*irq_table
!= -1)
410 if (*irq_table
++ == irq
)
414 if (board_irq
<= 0) {
419 magic_configure(port_idx
, board_irq
, magic
);
422 if (irq
== IRQ_AUTO
) {
423 instance
->irq
= g_NCR5380_probe_irq(instance
);
424 if (instance
->irq
== NO_IRQ
)
425 shost_printk(KERN_INFO
, instance
, "no irq detected\n");
428 if (instance
->irq
== NO_IRQ
)
429 shost_printk(KERN_INFO
, instance
, "no irq provided\n");
432 if (instance
->irq
!= NO_IRQ
) {
433 if (request_irq(instance
->irq
, generic_NCR5380_intr
,
434 0, "NCR5380", instance
)) {
435 instance
->irq
= NO_IRQ
;
436 shost_printk(KERN_INFO
, instance
,
437 "irq %d denied\n", instance
->irq
);
439 shost_printk(KERN_INFO
, instance
,
440 "irq %d acquired\n", instance
->irq
);
444 ret
= scsi_add_host(instance
, pdev
);
447 scsi_scan_host(instance
);
448 dev_set_drvdata(pdev
, instance
);
452 if (instance
->irq
!= NO_IRQ
)
453 free_irq(instance
->irq
, instance
);
454 NCR5380_exit(instance
);
456 scsi_host_put(instance
);
461 release_region(base
, region_size
);
463 release_mem_region(base
, region_size
);
467 static void generic_NCR5380_release_resources(struct Scsi_Host
*instance
)
469 struct NCR5380_hostdata
*hostdata
= shost_priv(instance
);
470 void __iomem
*iomem
= hostdata
->io
;
471 unsigned long io_port
= hostdata
->io_port
;
472 unsigned long base
= hostdata
->base
;
473 unsigned long region_size
= hostdata
->region_size
;
475 scsi_remove_host(instance
);
476 if (instance
->irq
!= NO_IRQ
)
477 free_irq(instance
->irq
, instance
);
478 NCR5380_exit(instance
);
479 scsi_host_put(instance
);
482 release_region(io_port
, region_size
);
484 release_mem_region(base
, region_size
);
487 /* wait_for_53c80_access - wait for 53C80 registers to become accessible
488 * @hostdata: scsi host private data
490 * The registers within the 53C80 logic block are inaccessible until
491 * bit 7 in the 53C400 control status register gets asserted.
494 static void wait_for_53c80_access(struct NCR5380_hostdata
*hostdata
)
499 if (hostdata
->board
== BOARD_DTC3181E
)
500 udelay(4); /* DTC436 chip hangs without this */
501 if (NCR5380_read(hostdata
->c400_ctl_status
) & CSR_53C80_REG
)
503 } while (--count
> 0);
505 scmd_printk(KERN_ERR
, hostdata
->connected
,
506 "53c80 registers not accessible, device will be reset\n");
507 NCR5380_write(hostdata
->c400_ctl_status
, CSR_RESET
);
508 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
);
512 * generic_NCR5380_precv - pseudo DMA receive
513 * @hostdata: scsi host private data
514 * @dst: buffer to write into
515 * @len: transfer size
517 * Perform a pseudo DMA mode receive from a 53C400 or equivalent device.
520 static inline int generic_NCR5380_precv(struct NCR5380_hostdata
*hostdata
,
521 unsigned char *dst
, int len
)
526 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
| CSR_TRANS_DIR
);
527 NCR5380_write(hostdata
->c400_blk_cnt
, len
/ 128);
530 if (start
== len
- 128) {
531 /* Ignore End of DMA interrupt for the final buffer */
532 if (NCR5380_poll_politely(hostdata
, hostdata
->c400_ctl_status
,
533 CSR_HOST_BUF_NOT_RDY
, 0, 0) < 0)
536 if (NCR5380_poll_politely2(hostdata
, hostdata
->c400_ctl_status
,
537 CSR_HOST_BUF_NOT_RDY
, 0,
538 hostdata
->c400_ctl_status
,
540 CSR_GATED_53C80_IRQ
, 0) < 0 ||
541 NCR5380_read(hostdata
->c400_ctl_status
) & CSR_HOST_BUF_NOT_RDY
)
545 if (hostdata
->io_port
&& hostdata
->io_width
== 2)
546 insw(hostdata
->io_port
+ hostdata
->c400_host_buf
,
548 else if (hostdata
->io_port
)
549 insb(hostdata
->io_port
+ hostdata
->c400_host_buf
,
552 memcpy_fromio(dst
+ start
,
553 hostdata
->io
+ NCR53C400_host_buffer
, 128);
555 } while (start
< len
);
557 residual
= len
- start
;
560 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
561 NCR5380_write(hostdata
->c400_ctl_status
, CSR_RESET
);
562 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
);
564 wait_for_53c80_access(hostdata
);
566 if (residual
== 0 && NCR5380_poll_politely(hostdata
, BUS_AND_STATUS_REG
,
567 BASR_END_DMA_TRANSFER
,
568 BASR_END_DMA_TRANSFER
,
570 scmd_printk(KERN_ERR
, hostdata
->connected
, "%s: End of DMA timeout\n",
573 hostdata
->pdma_residual
= residual
;
579 * generic_NCR5380_psend - pseudo DMA send
580 * @hostdata: scsi host private data
581 * @src: buffer to read from
582 * @len: transfer size
584 * Perform a pseudo DMA mode send to a 53C400 or equivalent device.
587 static inline int generic_NCR5380_psend(struct NCR5380_hostdata
*hostdata
,
588 unsigned char *src
, int len
)
593 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
);
594 NCR5380_write(hostdata
->c400_blk_cnt
, len
/ 128);
597 if (NCR5380_poll_politely2(hostdata
, hostdata
->c400_ctl_status
,
598 CSR_HOST_BUF_NOT_RDY
, 0,
599 hostdata
->c400_ctl_status
,
601 CSR_GATED_53C80_IRQ
, 0) < 0 ||
602 NCR5380_read(hostdata
->c400_ctl_status
) & CSR_HOST_BUF_NOT_RDY
) {
603 /* Both 128 B buffers are in use */
611 if (start
>= len
&& NCR5380_read(hostdata
->c400_blk_cnt
) == 0)
614 if (NCR5380_read(hostdata
->c400_ctl_status
) & CSR_GATED_53C80_IRQ
) {
615 /* Host buffer is empty, other one is in use */
624 if (hostdata
->io_port
&& hostdata
->io_width
== 2)
625 outsw(hostdata
->io_port
+ hostdata
->c400_host_buf
,
627 else if (hostdata
->io_port
)
628 outsb(hostdata
->io_port
+ hostdata
->c400_host_buf
,
631 memcpy_toio(hostdata
->io
+ NCR53C400_host_buffer
,
636 residual
= len
- start
;
639 /* 53c80 interrupt or transfer timeout. Reset 53c400 logic. */
640 NCR5380_write(hostdata
->c400_ctl_status
, CSR_RESET
);
641 NCR5380_write(hostdata
->c400_ctl_status
, CSR_BASE
);
643 wait_for_53c80_access(hostdata
);
646 if (NCR5380_poll_politely(hostdata
, TARGET_COMMAND_REG
,
647 TCR_LAST_BYTE_SENT
, TCR_LAST_BYTE_SENT
,
649 scmd_printk(KERN_ERR
, hostdata
->connected
,
650 "%s: Last Byte Sent timeout\n", __func__
);
652 if (NCR5380_poll_politely(hostdata
, BUS_AND_STATUS_REG
,
653 BASR_END_DMA_TRANSFER
, BASR_END_DMA_TRANSFER
,
655 scmd_printk(KERN_ERR
, hostdata
->connected
, "%s: End of DMA timeout\n",
659 hostdata
->pdma_residual
= residual
;
664 static int generic_NCR5380_dma_xfer_len(struct NCR5380_hostdata
*hostdata
,
665 struct scsi_cmnd
*cmd
)
667 int transfersize
= NCR5380_to_ncmd(cmd
)->this_residual
;
669 if (hostdata
->flags
& FLAG_NO_PSEUDO_DMA
)
672 /* 53C400 datasheet: non-modulo-128-byte transfers should use PIO */
673 if (transfersize
% 128)
676 /* Limit PDMA send to 512 B to avoid random corruption on DTC3181E */
677 if (hostdata
->board
== BOARD_DTC3181E
&&
678 cmd
->sc_data_direction
== DMA_TO_DEVICE
)
679 transfersize
= min(transfersize
, 512);
681 return min(transfersize
, DMA_MAX_SIZE
);
684 static int generic_NCR5380_dma_residual(struct NCR5380_hostdata
*hostdata
)
686 return hostdata
->pdma_residual
;
689 /* Include the core driver code. */
693 static const struct scsi_host_template driver_template
= {
694 .module
= THIS_MODULE
,
695 .proc_name
= DRV_MODULE_NAME
,
696 .name
= "Generic NCR5380/NCR53C400 SCSI",
697 .info
= generic_NCR5380_info
,
698 .queuecommand
= generic_NCR5380_queue_command
,
699 .eh_abort_handler
= generic_NCR5380_abort
,
700 .eh_host_reset_handler
= generic_NCR5380_host_reset
,
703 .sg_tablesize
= SG_ALL
,
705 .dma_boundary
= PAGE_SIZE
- 1,
706 .cmd_size
= sizeof(struct NCR5380_cmd
),
710 static int generic_NCR5380_isa_match(struct device
*pdev
, unsigned int ndev
)
712 int ret
= generic_NCR5380_init_one(&driver_template
, pdev
, base
[ndev
],
713 irq
[ndev
], card
[ndev
]);
716 printk(KERN_WARNING
"Card not found at address 0x%03x\n",
724 static void generic_NCR5380_isa_remove(struct device
*pdev
,
727 generic_NCR5380_release_resources(dev_get_drvdata(pdev
));
728 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
);