1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic Macintosh NCR5380 driver
5 * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
7 * derived in part from:
10 * Generic Generic NCR5380 driver
12 * Copyright 1995, Russell King
15 #include <linux/types.h>
16 #include <linux/module.h>
17 #include <linux/ioport.h>
18 #include <linux/init.h>
19 #include <linux/blkdev.h>
20 #include <linux/interrupt.h>
21 #include <linux/platform_device.h>
23 #include <asm/hwtest.h>
25 #include <asm/macints.h>
26 #include <asm/setup.h>
28 #include <scsi/scsi_host.h>
30 /* Definitions for the core NCR5380 driver. */
32 #define NCR5380_implementation_fields int pdma_residual
34 #define NCR5380_read(reg) in_8(hostdata->io + ((reg) << 4))
35 #define NCR5380_write(reg, value) out_8(hostdata->io + ((reg) << 4), value)
37 #define NCR5380_dma_xfer_len macscsi_dma_xfer_len
38 #define NCR5380_dma_recv_setup macscsi_pread
39 #define NCR5380_dma_send_setup macscsi_pwrite
40 #define NCR5380_dma_residual macscsi_dma_residual
42 #define NCR5380_intr macscsi_intr
43 #define NCR5380_queue_command macscsi_queue_command
44 #define NCR5380_abort macscsi_abort
45 #define NCR5380_host_reset macscsi_host_reset
46 #define NCR5380_info macscsi_info
50 static int setup_can_queue = -1;
51 module_param(setup_can_queue, int, 0);
52 static int setup_cmd_per_lun = -1;
53 module_param(setup_cmd_per_lun, int, 0);
54 static int setup_sg_tablesize = -1;
55 module_param(setup_sg_tablesize, int, 0);
56 static int setup_use_pdma = -1;
57 module_param(setup_use_pdma, int, 0);
58 static int setup_hostid = -1;
59 module_param(setup_hostid, int, 0);
60 static int setup_toshiba_delay = -1;
61 module_param(setup_toshiba_delay, int, 0);
64 static int __init mac_scsi_setup(char *str)
68 (void)get_options(str, ARRAY_SIZE(ints), ints);
71 pr_err("Usage: mac5380=<can_queue>[,<cmd_per_lun>[,<sg_tablesize>[,<hostid>[,<use_tags>[,<use_pdma>[,<toshiba_delay>]]]]]]\n");
75 setup_can_queue = ints[1];
77 setup_cmd_per_lun = ints[2];
79 setup_sg_tablesize = ints[3];
81 setup_hostid = ints[4];
82 /* ints[5] (use_tagged_queuing) is ignored */
84 setup_use_pdma = ints[6];
86 setup_toshiba_delay = ints[7];
90 __setup("mac5380=", mac_scsi_setup);
93 /* Pseudo DMA asm originally by Ove Edlund */
95 #define CP_IO_TO_MEM(s,d,n) \
96 __asm__ __volatile__ \
104 " 1: move.b (%0),(%1)+\n" \
105 " 2: dbf %%d0,1b\n" \
106 " move.w %2,%%d0\n" \
109 " 3: move.l (%0),(%1)+\n" \
110 "31: move.l (%0),(%1)+\n" \
111 "32: move.l (%0),(%1)+\n" \
112 "33: move.l (%0),(%1)+\n" \
113 "34: move.l (%0),(%1)+\n" \
114 "35: move.l (%0),(%1)+\n" \
115 "36: move.l (%0),(%1)+\n" \
116 "37: move.l (%0),(%1)+\n" \
117 " 4: dbf %%d0,3b\n" \
118 " move.w %2,%%d0\n" \
122 " 5: move.l (%0),(%1)+\n" \
123 " 6: dbf %%d0,5b\n" \
126 " 7: move.b (%0),(%1)+\n" \
128 " moveq.l #0, %2\n" \
130 ".section .fixup,\"ax\"\n" \
132 "91: moveq.l #1, %2\n" \
134 "94: moveq.l #4, %2\n" \
137 ".section __ex_table,\"a\"\n" \
151 : "=a"(s), "=a"(d), "=d"(n) \
152 : "0"(s), "1"(d), "2"(n) \
155 static inline int macscsi_pread(struct NCR5380_hostdata *hostdata,
156 unsigned char *dst, int len)
158 u8 __iomem *s = hostdata->pdma_io + (INPUT_DATA_REG << 4);
159 unsigned char *d = dst;
163 while (!NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
164 BASR_DRQ | BASR_PHASE_MATCH,
165 BASR_DRQ | BASR_PHASE_MATCH, HZ / 64)) {
166 CP_IO_TO_MEM(s, d, n);
168 transferred = d - dst - n;
169 hostdata->pdma_residual = len - transferred;
175 /* Target changed phase early? */
176 if (NCR5380_poll_politely2(hostdata, STATUS_REG, SR_REQ, SR_REQ,
177 BUS_AND_STATUS_REG, BASR_ACK, BASR_ACK, HZ / 64) < 0)
178 scmd_printk(KERN_ERR, hostdata->connected,
179 "%s: !REQ and !ACK\n", __func__);
180 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
183 dsprintk(NDEBUG_PSEUDO_DMA, hostdata->host,
184 "%s: bus error (%d/%d)\n", __func__, transferred, len);
185 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
186 d = dst + transferred;
187 n = len - transferred;
190 scmd_printk(KERN_ERR, hostdata->connected,
191 "%s: phase mismatch or !DRQ\n", __func__);
192 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
197 #define CP_MEM_TO_IO(s,d,n) \
198 __asm__ __volatile__ \
201 " move.w %0,%%d0\n" \
206 " 1: move.b (%0)+,(%1)\n" \
207 " 2: dbf %%d0,1b\n" \
208 " move.w %2,%%d0\n" \
211 " 3: move.l (%0)+,(%1)\n" \
212 "31: move.l (%0)+,(%1)\n" \
213 "32: move.l (%0)+,(%1)\n" \
214 "33: move.l (%0)+,(%1)\n" \
215 "34: move.l (%0)+,(%1)\n" \
216 "35: move.l (%0)+,(%1)\n" \
217 "36: move.l (%0)+,(%1)\n" \
218 "37: move.l (%0)+,(%1)\n" \
219 " 4: dbf %%d0,3b\n" \
220 " move.w %2,%%d0\n" \
224 " 5: move.l (%0)+,(%1)\n" \
225 " 6: dbf %%d0,5b\n" \
228 " 7: move.b (%0)+,(%1)\n" \
230 " moveq.l #0, %2\n" \
232 ".section .fixup,\"ax\"\n" \
234 "91: moveq.l #1, %2\n" \
236 "94: moveq.l #4, %2\n" \
239 ".section __ex_table,\"a\"\n" \
253 : "=a"(s), "=a"(d), "=d"(n) \
254 : "0"(s), "1"(d), "2"(n) \
257 static inline int macscsi_pwrite(struct NCR5380_hostdata *hostdata,
258 unsigned char *src, int len)
260 unsigned char *s = src;
261 u8 __iomem *d = hostdata->pdma_io + (OUTPUT_DATA_REG << 4);
265 while (!NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
266 BASR_DRQ | BASR_PHASE_MATCH,
267 BASR_DRQ | BASR_PHASE_MATCH, HZ / 64)) {
268 CP_MEM_TO_IO(s, d, n);
270 transferred = s - src - n;
271 hostdata->pdma_residual = len - transferred;
273 /* Target changed phase early? */
274 if (NCR5380_poll_politely2(hostdata, STATUS_REG, SR_REQ, SR_REQ,
275 BUS_AND_STATUS_REG, BASR_ACK, BASR_ACK, HZ / 64) < 0)
276 scmd_printk(KERN_ERR, hostdata->connected,
277 "%s: !REQ and !ACK\n", __func__);
278 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
283 if (NCR5380_poll_politely(hostdata, TARGET_COMMAND_REG,
285 TCR_LAST_BYTE_SENT, HZ / 64) < 0)
286 scmd_printk(KERN_ERR, hostdata->connected,
287 "%s: Last Byte Sent timeout\n", __func__);
291 dsprintk(NDEBUG_PSEUDO_DMA, hostdata->host,
292 "%s: bus error (%d/%d)\n", __func__, transferred, len);
293 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
294 s = src + transferred;
295 n = len - transferred;
298 scmd_printk(KERN_ERR, hostdata->connected,
299 "%s: phase mismatch or !DRQ\n", __func__);
300 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
305 static int macscsi_dma_xfer_len(struct NCR5380_hostdata *hostdata,
306 struct scsi_cmnd *cmd)
308 if (hostdata->flags & FLAG_NO_PSEUDO_DMA ||
309 cmd->SCp.this_residual < 16)
312 return cmd->SCp.this_residual;
315 static int macscsi_dma_residual(struct NCR5380_hostdata *hostdata)
317 return hostdata->pdma_residual;
322 #define DRV_MODULE_NAME "mac_scsi"
323 #define PFX DRV_MODULE_NAME ": "
325 static struct scsi_host_template mac_scsi_template = {
326 .module = THIS_MODULE,
327 .proc_name = DRV_MODULE_NAME,
328 .name = "Macintosh NCR5380 SCSI",
329 .info = macscsi_info,
330 .queuecommand = macscsi_queue_command,
331 .eh_abort_handler = macscsi_abort,
332 .eh_host_reset_handler = macscsi_host_reset,
337 .dma_boundary = PAGE_SIZE - 1,
338 .cmd_size = NCR5380_CMD_SIZE,
342 static int __init mac_scsi_probe(struct platform_device *pdev)
344 struct Scsi_Host *instance;
345 struct NCR5380_hostdata *hostdata;
348 struct resource *irq, *pio_mem, *pdma_mem = NULL;
350 pio_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
354 pdma_mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
356 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
358 if (!hwreg_present((unsigned char *)pio_mem->start +
359 (STATUS_REG << 4))) {
360 pr_info(PFX "no device detected at %pap\n", &pio_mem->start);
364 if (setup_can_queue > 0)
365 mac_scsi_template.can_queue = setup_can_queue;
366 if (setup_cmd_per_lun > 0)
367 mac_scsi_template.cmd_per_lun = setup_cmd_per_lun;
368 if (setup_sg_tablesize >= 0)
369 mac_scsi_template.sg_tablesize = setup_sg_tablesize;
370 if (setup_hostid >= 0)
371 mac_scsi_template.this_id = setup_hostid & 7;
373 instance = scsi_host_alloc(&mac_scsi_template,
374 sizeof(struct NCR5380_hostdata));
379 instance->irq = irq->start;
381 instance->irq = NO_IRQ;
383 hostdata = shost_priv(instance);
384 hostdata->base = pio_mem->start;
385 hostdata->io = (u8 __iomem *)pio_mem->start;
387 if (pdma_mem && setup_use_pdma)
388 hostdata->pdma_io = (u8 __iomem *)pdma_mem->start;
390 host_flags |= FLAG_NO_PSEUDO_DMA;
392 host_flags |= setup_toshiba_delay > 0 ? FLAG_TOSHIBA_DELAY : 0;
394 error = NCR5380_init(instance, host_flags | FLAG_LATE_DMA_SETUP);
398 if (instance->irq != NO_IRQ) {
399 error = request_irq(instance->irq, macscsi_intr, IRQF_SHARED,
400 "NCR5380", instance);
405 NCR5380_maybe_reset_bus(instance);
407 error = scsi_add_host(instance, NULL);
411 platform_set_drvdata(pdev, instance);
413 scsi_scan_host(instance);
417 if (instance->irq != NO_IRQ)
418 free_irq(instance->irq, instance);
420 NCR5380_exit(instance);
422 scsi_host_put(instance);
426 static int __exit mac_scsi_remove(struct platform_device *pdev)
428 struct Scsi_Host *instance = platform_get_drvdata(pdev);
430 scsi_remove_host(instance);
431 if (instance->irq != NO_IRQ)
432 free_irq(instance->irq, instance);
433 NCR5380_exit(instance);
434 scsi_host_put(instance);
438 static struct platform_driver mac_scsi_driver = {
439 .remove = __exit_p(mac_scsi_remove),
441 .name = DRV_MODULE_NAME,
445 module_platform_driver_probe(mac_scsi_driver, mac_scsi_probe);
447 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
448 MODULE_LICENSE("GPL");