1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic Macintosh NCR5380 driver
5 * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
7 * Copyright 2019 Finn Thain
9 * derived in part from:
12 * Generic Generic NCR5380 driver
14 * Copyright 1995, Russell King
17 #include <linux/delay.h>
18 #include <linux/types.h>
19 #include <linux/module.h>
20 #include <linux/ioport.h>
21 #include <linux/init.h>
22 #include <linux/blkdev.h>
23 #include <linux/interrupt.h>
24 #include <linux/platform_device.h>
26 #include <asm/hwtest.h>
28 #include <asm/macintosh.h>
29 #include <asm/macints.h>
30 #include <asm/setup.h>
32 #include <scsi/scsi_host.h>
34 /* Definitions for the core NCR5380 driver. */
36 #define NCR5380_implementation_fields int pdma_residual
38 #define NCR5380_read(reg) in_8(hostdata->io + ((reg) << 4))
39 #define NCR5380_write(reg, value) out_8(hostdata->io + ((reg) << 4), value)
41 #define NCR5380_dma_xfer_len macscsi_dma_xfer_len
42 #define NCR5380_dma_recv_setup macscsi_pread
43 #define NCR5380_dma_send_setup macscsi_pwrite
44 #define NCR5380_dma_residual macscsi_dma_residual
46 #define NCR5380_intr macscsi_intr
47 #define NCR5380_queue_command macscsi_queue_command
48 #define NCR5380_abort macscsi_abort
49 #define NCR5380_host_reset macscsi_host_reset
50 #define NCR5380_info macscsi_info
54 static int setup_can_queue = -1;
55 module_param(setup_can_queue, int, 0);
56 static int setup_cmd_per_lun = -1;
57 module_param(setup_cmd_per_lun, int, 0);
58 static int setup_sg_tablesize = -1;
59 module_param(setup_sg_tablesize, int, 0);
60 static int setup_use_pdma = 512;
61 module_param(setup_use_pdma, int, 0);
62 static int setup_hostid = -1;
63 module_param(setup_hostid, int, 0);
64 static int setup_toshiba_delay = -1;
65 module_param(setup_toshiba_delay, int, 0);
68 static int __init mac_scsi_setup(char *str)
72 (void)get_options(str, ARRAY_SIZE(ints), ints);
75 pr_err("Usage: mac5380=<can_queue>[,<cmd_per_lun>[,<sg_tablesize>[,<hostid>[,<use_tags>[,<use_pdma>[,<toshiba_delay>]]]]]]\n");
79 setup_can_queue = ints[1];
81 setup_cmd_per_lun = ints[2];
83 setup_sg_tablesize = ints[3];
85 setup_hostid = ints[4];
86 /* ints[5] (use_tagged_queuing) is ignored */
88 setup_use_pdma = ints[6];
90 setup_toshiba_delay = ints[7];
94 __setup("mac5380=", mac_scsi_setup);
98 * According to "Inside Macintosh: Devices", Mac OS requires disk drivers to
99 * specify the number of bytes between the delays expected from a SCSI target.
100 * This allows the operating system to "prevent bus errors when a target fails
101 * to deliver the next byte within the processor bus error timeout period."
102 * Linux SCSI drivers lack knowledge of the timing behaviour of SCSI targets
103 * so bus errors are unavoidable.
105 * If a MOVE.B instruction faults, we assume that zero bytes were transferred
106 * and simply retry. That assumption probably depends on target behaviour but
107 * seems to hold up okay. The NOP provides synchronization: without it the
108 * fault can sometimes occur after the program counter has moved past the
109 * offending instruction. Post-increment addressing can't be used.
112 #define MOVE_BYTE(operands) \
114 "1: moveb " operands " \n" \
120 ".section .fixup,\"ax\" \n" \
122 "90: movel #1, %2 \n" \
126 ".section __ex_table,\"a\" \n" \
131 : "+a" (addr), "+r" (n), "+r" (result) : "a" (io))
134 * If a MOVE.W (or MOVE.L) instruction faults, it cannot be retried because
135 * the residual byte count would be uncertain. In that situation the MOVE_WORD
136 * macro clears n in the fixup section to abort the transfer.
139 #define MOVE_WORD(operands) \
141 "1: movew " operands " \n" \
146 ".section .fixup,\"ax\" \n" \
148 "90: movel #0, %1 \n" \
153 ".section __ex_table,\"a\" \n" \
158 : "+a" (addr), "+r" (n), "+r" (result) : "a" (io))
160 #define MOVE_16_WORDS(operands) \
162 "1: movew " operands " \n" \
163 "2: movew " operands " \n" \
164 "3: movew " operands " \n" \
165 "4: movew " operands " \n" \
166 "5: movew " operands " \n" \
167 "6: movew " operands " \n" \
168 "7: movew " operands " \n" \
169 "8: movew " operands " \n" \
170 "9: movew " operands " \n" \
171 "10: movew " operands " \n" \
172 "11: movew " operands " \n" \
173 "12: movew " operands " \n" \
174 "13: movew " operands " \n" \
175 "14: movew " operands " \n" \
176 "15: movew " operands " \n" \
177 "16: movew " operands " \n" \
182 ".section .fixup,\"ax\" \n" \
184 "90: movel #0, %1 \n" \
189 ".section __ex_table,\"a\" \n" \
209 : "+a" (addr), "+r" (n), "+r" (result) : "a" (io))
211 #define MAC_PDMA_DELAY 32
213 static inline int mac_pdma_recv(void __iomem *io, unsigned char *start, int n)
215 unsigned char *addr = start;
219 MOVE_BYTE("%3@,%0@");
223 if (n >= 1 && ((unsigned long)addr & 1)) {
224 MOVE_BYTE("%3@,%0@");
229 MOVE_16_WORDS("%3@,%0@+");
231 MOVE_WORD("%3@,%0@+");
233 return start - addr; /* Negated to indicate uncertain length */
235 MOVE_BYTE("%3@,%0@");
240 static inline int mac_pdma_send(unsigned char *start, void __iomem *io, int n)
242 unsigned char *addr = start;
246 MOVE_BYTE("%0@,%3@");
250 if (n >= 1 && ((unsigned long)addr & 1)) {
251 MOVE_BYTE("%0@,%3@");
256 MOVE_16_WORDS("%0@+,%3@");
258 MOVE_WORD("%0@+,%3@");
260 return start - addr; /* Negated to indicate uncertain length */
262 MOVE_BYTE("%0@,%3@");
267 /* The "SCSI DMA" chip on the IIfx implements this register. */
269 #define CTRL_INTERRUPTS_ENABLE BIT(1)
270 #define CTRL_HANDSHAKE_MODE BIT(3)
272 static inline void write_ctrl_reg(struct NCR5380_hostdata *hostdata, u32 value)
274 out_be32(hostdata->io + (CTRL_REG << 4), value);
277 static inline int macscsi_pread(struct NCR5380_hostdata *hostdata,
278 unsigned char *dst, int len)
280 u8 __iomem *s = hostdata->pdma_io + (INPUT_DATA_REG << 4);
281 unsigned char *d = dst;
284 hostdata->pdma_residual = len;
286 while (!NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
287 BASR_DRQ | BASR_PHASE_MATCH,
288 BASR_DRQ | BASR_PHASE_MATCH, 0)) {
291 if (macintosh_config->ident == MAC_MODEL_IIFX)
292 write_ctrl_reg(hostdata, CTRL_HANDSHAKE_MODE |
293 CTRL_INTERRUPTS_ENABLE);
295 bytes = mac_pdma_recv(s, d, min(hostdata->pdma_residual, 512));
299 hostdata->pdma_residual -= bytes;
302 if (hostdata->pdma_residual == 0)
305 if (NCR5380_poll_politely2(hostdata, STATUS_REG, SR_REQ, SR_REQ,
306 BUS_AND_STATUS_REG, BASR_ACK,
308 scmd_printk(KERN_DEBUG, hostdata->connected,
309 "%s: !REQ and !ACK\n", __func__);
310 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
314 udelay(MAC_PDMA_DELAY);
319 dsprintk(NDEBUG_PSEUDO_DMA, hostdata->host,
320 "%s: bus error (%d/%d)\n", __func__, d - dst, len);
321 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
326 scmd_printk(KERN_ERR, hostdata->connected,
327 "%s: phase mismatch or !DRQ\n", __func__);
328 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
331 if (macintosh_config->ident == MAC_MODEL_IIFX)
332 write_ctrl_reg(hostdata, CTRL_INTERRUPTS_ENABLE);
336 static inline int macscsi_pwrite(struct NCR5380_hostdata *hostdata,
337 unsigned char *src, int len)
339 unsigned char *s = src;
340 u8 __iomem *d = hostdata->pdma_io + (OUTPUT_DATA_REG << 4);
343 hostdata->pdma_residual = len;
345 while (!NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG,
346 BASR_DRQ | BASR_PHASE_MATCH,
347 BASR_DRQ | BASR_PHASE_MATCH, 0)) {
350 if (macintosh_config->ident == MAC_MODEL_IIFX)
351 write_ctrl_reg(hostdata, CTRL_HANDSHAKE_MODE |
352 CTRL_INTERRUPTS_ENABLE);
354 bytes = mac_pdma_send(s, d, min(hostdata->pdma_residual, 512));
358 hostdata->pdma_residual -= bytes;
361 if (hostdata->pdma_residual == 0) {
362 if (NCR5380_poll_politely(hostdata, TARGET_COMMAND_REG,
366 scmd_printk(KERN_ERR, hostdata->connected,
367 "%s: Last Byte Sent timeout\n", __func__);
373 if (NCR5380_poll_politely2(hostdata, STATUS_REG, SR_REQ, SR_REQ,
374 BUS_AND_STATUS_REG, BASR_ACK,
376 scmd_printk(KERN_DEBUG, hostdata->connected,
377 "%s: !REQ and !ACK\n", __func__);
378 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
382 udelay(MAC_PDMA_DELAY);
387 dsprintk(NDEBUG_PSEUDO_DMA, hostdata->host,
388 "%s: bus error (%d/%d)\n", __func__, s - src, len);
389 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
394 scmd_printk(KERN_ERR, hostdata->connected,
395 "%s: phase mismatch or !DRQ\n", __func__);
396 NCR5380_dprint(NDEBUG_PSEUDO_DMA, hostdata->host);
399 if (macintosh_config->ident == MAC_MODEL_IIFX)
400 write_ctrl_reg(hostdata, CTRL_INTERRUPTS_ENABLE);
404 static int macscsi_dma_xfer_len(struct NCR5380_hostdata *hostdata,
405 struct scsi_cmnd *cmd)
407 if (hostdata->flags & FLAG_NO_PSEUDO_DMA ||
408 cmd->SCp.this_residual < setup_use_pdma)
411 return cmd->SCp.this_residual;
414 static int macscsi_dma_residual(struct NCR5380_hostdata *hostdata)
416 return hostdata->pdma_residual;
421 #define DRV_MODULE_NAME "mac_scsi"
422 #define PFX DRV_MODULE_NAME ": "
424 static struct scsi_host_template mac_scsi_template = {
425 .module = THIS_MODULE,
426 .proc_name = DRV_MODULE_NAME,
427 .name = "Macintosh NCR5380 SCSI",
428 .info = macscsi_info,
429 .queuecommand = macscsi_queue_command,
430 .eh_abort_handler = macscsi_abort,
431 .eh_host_reset_handler = macscsi_host_reset,
436 .dma_boundary = PAGE_SIZE - 1,
437 .cmd_size = NCR5380_CMD_SIZE,
441 static int __init mac_scsi_probe(struct platform_device *pdev)
443 struct Scsi_Host *instance;
444 struct NCR5380_hostdata *hostdata;
447 struct resource *irq, *pio_mem, *pdma_mem = NULL;
449 pio_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
453 pdma_mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
455 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
457 if (!hwreg_present((unsigned char *)pio_mem->start +
458 (STATUS_REG << 4))) {
459 pr_info(PFX "no device detected at %pap\n", &pio_mem->start);
463 if (setup_can_queue > 0)
464 mac_scsi_template.can_queue = setup_can_queue;
465 if (setup_cmd_per_lun > 0)
466 mac_scsi_template.cmd_per_lun = setup_cmd_per_lun;
467 if (setup_sg_tablesize > 0)
468 mac_scsi_template.sg_tablesize = setup_sg_tablesize;
469 if (setup_hostid >= 0)
470 mac_scsi_template.this_id = setup_hostid & 7;
472 instance = scsi_host_alloc(&mac_scsi_template,
473 sizeof(struct NCR5380_hostdata));
478 instance->irq = irq->start;
480 instance->irq = NO_IRQ;
482 hostdata = shost_priv(instance);
483 hostdata->base = pio_mem->start;
484 hostdata->io = (u8 __iomem *)pio_mem->start;
486 if (pdma_mem && setup_use_pdma)
487 hostdata->pdma_io = (u8 __iomem *)pdma_mem->start;
489 host_flags |= FLAG_NO_PSEUDO_DMA;
491 host_flags |= setup_toshiba_delay > 0 ? FLAG_TOSHIBA_DELAY : 0;
493 error = NCR5380_init(instance, host_flags | FLAG_LATE_DMA_SETUP);
497 if (instance->irq != NO_IRQ) {
498 error = request_irq(instance->irq, macscsi_intr, IRQF_SHARED,
499 "NCR5380", instance);
504 NCR5380_maybe_reset_bus(instance);
506 error = scsi_add_host(instance, NULL);
510 platform_set_drvdata(pdev, instance);
512 scsi_scan_host(instance);
516 if (instance->irq != NO_IRQ)
517 free_irq(instance->irq, instance);
519 NCR5380_exit(instance);
521 scsi_host_put(instance);
525 static int __exit mac_scsi_remove(struct platform_device *pdev)
527 struct Scsi_Host *instance = platform_get_drvdata(pdev);
529 scsi_remove_host(instance);
530 if (instance->irq != NO_IRQ)
531 free_irq(instance->irq, instance);
532 NCR5380_exit(instance);
533 scsi_host_put(instance);
537 static struct platform_driver mac_scsi_driver = {
538 .remove = __exit_p(mac_scsi_remove),
540 .name = DRV_MODULE_NAME,
544 module_platform_driver_probe(mac_scsi_driver, mac_scsi_probe);
546 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
547 MODULE_LICENSE("GPL");