2 * Sun3 SCSI stuff by Erik Verbruggen (erik@bigmama.xtdnet.nl)
4 * Sun3 DMA routines added by Sam Creasey (sammy@sammy.net)
6 * VME support added by Sam Creasey
8 * TODO: modify this driver to support multiple Sun3 SCSI VME boards
10 * Adapted from mac_scsinew.c:
13 * Generic Macintosh NCR5380 driver
15 * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
17 * derived in part from:
20 * Generic Generic NCR5380 driver
22 * Copyright 1995, Russell King
25 #include <linux/types.h>
26 #include <linux/delay.h>
27 #include <linux/module.h>
28 #include <linux/ioport.h>
29 #include <linux/init.h>
30 #include <linux/blkdev.h>
31 #include <linux/platform_device.h>
36 #include <scsi/scsi_host.h>
37 #include "sun3_scsi.h"
39 /* Definitions for the core NCR5380 driver. */
42 /* #define SUPPORT_TAGS */
43 /* minimum number of bytes to do dma on */
44 #define DMA_MIN_SIZE 129
46 /* #define MAX_TAGS 32 */
48 #define NCR5380_implementation_fields /* none */
50 #define NCR5380_read(reg) sun3scsi_read(reg)
51 #define NCR5380_write(reg, value) sun3scsi_write(reg, value)
53 #define NCR5380_queue_command sun3scsi_queue_command
54 #define NCR5380_bus_reset sun3scsi_bus_reset
55 #define NCR5380_abort sun3scsi_abort
56 #define NCR5380_show_info sun3scsi_show_info
57 #define NCR5380_info sun3scsi_info
59 #define NCR5380_dma_read_setup(instance, data, count) \
60 sun3scsi_dma_setup(data, count, 0)
61 #define NCR5380_dma_write_setup(instance, data, count) \
62 sun3scsi_dma_setup(data, count, 1)
63 #define NCR5380_dma_residual(instance) \
64 sun3scsi_dma_residual(instance)
65 #define NCR5380_dma_xfer_len(instance, cmd, phase) \
66 sun3scsi_dma_xfer_len(cmd->SCp.this_residual, cmd, !((phase) & SR_IO))
68 #define NCR5380_acquire_dma_irq(instance) (1)
69 #define NCR5380_release_dma_irq(instance)
74 extern int sun3_map_test(unsigned long, char *);
76 static int setup_can_queue = -1;
77 module_param(setup_can_queue, int, 0);
78 static int setup_cmd_per_lun = -1;
79 module_param(setup_cmd_per_lun, int, 0);
80 static int setup_sg_tablesize = -1;
81 module_param(setup_sg_tablesize, int, 0);
83 static int setup_use_tagged_queuing = -1;
84 module_param(setup_use_tagged_queuing, int, 0);
86 static int setup_hostid = -1;
87 module_param(setup_hostid, int, 0);
89 /* ms to wait after hitting dma regs */
90 #define SUN3_DMA_DELAY 10
92 /* dvma buffer to allocate -- 32k should hopefully be more than sufficient */
93 #define SUN3_DVMA_BUFSIZE 0xe000
95 static struct scsi_cmnd *sun3_dma_setup_done;
96 static unsigned char *sun3_scsi_regp;
97 static volatile struct sun3_dma_regs *dregs;
98 static struct sun3_udc_regs *udc_regs;
99 static unsigned char *sun3_dma_orig_addr;
100 static unsigned long sun3_dma_orig_count;
101 static int sun3_dma_active;
102 static unsigned long last_residual;
103 static struct Scsi_Host *default_instance;
106 * NCR 5380 register access functions
109 static inline unsigned char sun3scsi_read(int reg)
111 return in_8(sun3_scsi_regp + reg);
114 static inline void sun3scsi_write(int reg, int value)
116 out_8(sun3_scsi_regp + reg, value);
119 #ifndef SUN3_SCSI_VME
120 /* dma controller register access functions */
122 static inline unsigned short sun3_udc_read(unsigned char reg)
126 dregs->udc_addr = UDC_CSR;
127 udelay(SUN3_DMA_DELAY);
128 ret = dregs->udc_data;
129 udelay(SUN3_DMA_DELAY);
134 static inline void sun3_udc_write(unsigned short val, unsigned char reg)
136 dregs->udc_addr = reg;
137 udelay(SUN3_DMA_DELAY);
138 dregs->udc_data = val;
139 udelay(SUN3_DMA_DELAY);
143 // safe bits for the CSR
144 #define CSR_GOOD 0x060f
146 static irqreturn_t scsi_sun3_intr(int irq, void *dummy)
148 unsigned short csr = dregs->csr;
152 dregs->csr &= ~CSR_DMA_ENABLE;
155 if(csr & ~CSR_GOOD) {
156 if(csr & CSR_DMA_BUSERR) {
157 printk("scsi%d: bus error in dma\n", default_instance->host_no);
160 if(csr & CSR_DMA_CONFLICT) {
161 printk("scsi%d: dma conflict\n", default_instance->host_no);
166 if(csr & (CSR_SDB_INT | CSR_DMA_INT)) {
167 NCR5380_intr(irq, dummy);
171 return IRQ_RETVAL(handled);
175 * Debug stuff - to be called on NMI, or sysrq key. Use at your own risk;
176 * reentering NCR5380_print_status seems to have ugly side effects
179 /* this doesn't seem to get used at all -- sam */
181 void sun3_sun3_debug (void)
185 if (default_instance) {
186 local_irq_save(flags);
187 NCR5380_print_status(default_instance);
188 local_irq_restore(flags);
194 /* sun3scsi_dma_setup() -- initialize the dma controller for a read/write */
195 static unsigned long sun3scsi_dma_setup(void *data, unsigned long count, int write_flag)
199 if(sun3_dma_orig_addr != NULL)
200 dvma_unmap(sun3_dma_orig_addr);
203 addr = (void *)dvma_map_vme((unsigned long) data, count);
205 addr = (void *)dvma_map((unsigned long) data, count);
208 sun3_dma_orig_addr = addr;
209 sun3_dma_orig_count = count;
211 #ifndef SUN3_SCSI_VME
212 dregs->fifo_count = 0;
213 sun3_udc_write(UDC_RESET, UDC_CSR);
216 dregs->csr &= ~CSR_FIFO;
217 dregs->csr |= CSR_FIFO;
222 dregs->csr |= CSR_SEND;
224 dregs->csr &= ~CSR_SEND;
227 dregs->csr |= CSR_PACK_ENABLE;
229 dregs->dma_addr_hi = ((unsigned long)addr >> 16);
230 dregs->dma_addr_lo = ((unsigned long)addr & 0xffff);
232 dregs->dma_count_hi = 0;
233 dregs->dma_count_lo = 0;
234 dregs->fifo_count_hi = 0;
235 dregs->fifo_count = 0;
237 /* byte count for fifo */
238 dregs->fifo_count = count;
240 sun3_udc_write(UDC_RESET, UDC_CSR);
243 dregs->csr &= ~CSR_FIFO;
244 dregs->csr |= CSR_FIFO;
246 if(dregs->fifo_count != count) {
247 printk("scsi%d: fifo_mismatch %04x not %04x\n",
248 default_instance->host_no, dregs->fifo_count,
249 (unsigned int) count);
250 NCR5380_dprint(NDEBUG_DMA, default_instance);
254 udc_regs->addr_hi = (((unsigned long)(addr) & 0xff0000) >> 8);
255 udc_regs->addr_lo = ((unsigned long)(addr) & 0xffff);
256 udc_regs->count = count/2; /* count in words */
257 udc_regs->mode_hi = UDC_MODE_HIWORD;
261 udc_regs->mode_lo = UDC_MODE_LSEND;
262 udc_regs->rsel = UDC_RSEL_SEND;
264 udc_regs->mode_lo = UDC_MODE_LRECV;
265 udc_regs->rsel = UDC_RSEL_RECV;
268 /* announce location of regs block */
269 sun3_udc_write(((dvma_vtob(udc_regs) & 0xff0000) >> 8),
272 sun3_udc_write((dvma_vtob(udc_regs) & 0xffff), UDC_CHN_LO);
274 /* set dma master on */
275 sun3_udc_write(0xd, UDC_MODE);
277 /* interrupt enable */
278 sun3_udc_write(UDC_INT_ENABLE, UDC_CSR);
285 #ifndef SUN3_SCSI_VME
286 static inline unsigned long sun3scsi_dma_count(struct Scsi_Host *instance)
288 unsigned short resid;
290 dregs->udc_addr = 0x32;
291 udelay(SUN3_DMA_DELAY);
292 resid = dregs->udc_data;
293 udelay(SUN3_DMA_DELAY);
296 return (unsigned long) resid;
300 static inline unsigned long sun3scsi_dma_residual(struct Scsi_Host *instance)
302 return last_residual;
305 static inline unsigned long sun3scsi_dma_xfer_len(unsigned long wanted,
306 struct scsi_cmnd *cmd,
309 if (cmd->request->cmd_type == REQ_TYPE_FS)
315 static inline int sun3scsi_dma_start(unsigned long count, unsigned char *data)
322 dregs->dma_count_hi = (sun3_dma_orig_count >> 16);
323 dregs->dma_count_lo = (sun3_dma_orig_count & 0xffff);
325 dregs->fifo_count_hi = (sun3_dma_orig_count >> 16);
326 dregs->fifo_count = (sun3_dma_orig_count & 0xffff);
328 /* if(!(csr & CSR_DMA_ENABLE))
329 * dregs->csr |= CSR_DMA_ENABLE;
332 sun3_udc_write(UDC_CHN_START, UDC_CSR);
338 /* clean up after our dma is done */
339 static int sun3scsi_dma_finish(int write_flag)
341 unsigned short __maybe_unused count;
348 dregs->csr &= ~CSR_DMA_ENABLE;
350 fifo = dregs->fifo_count;
352 if ((fifo > 0) && (fifo < sun3_dma_orig_count))
356 last_residual = fifo;
357 /* empty bytes from the fifo which didn't make it */
358 if ((!write_flag) && (dregs->csr & CSR_LEFT)) {
359 unsigned char *vaddr;
361 vaddr = (unsigned char *)dvma_vmetov(sun3_dma_orig_addr);
363 vaddr += (sun3_dma_orig_count - fifo);
366 switch (dregs->csr & CSR_LEFT) {
368 *vaddr = (dregs->bpack_lo & 0xff00) >> 8;
372 *vaddr = (dregs->bpack_hi & 0x00ff);
376 *vaddr = (dregs->bpack_hi & 0xff00) >> 8;
381 // check to empty the fifo on a read
383 int tmo = 20000; /* .2 sec */
386 if(dregs->csr & CSR_FIFO_EMPTY)
390 printk("sun3scsi: fifo failed to empty!\n");
397 count = sun3scsi_dma_count(default_instance);
399 fifo = dregs->fifo_count;
400 last_residual = fifo;
402 /* empty bytes from the fifo which didn't make it */
403 if((!write_flag) && (count - fifo) == 2) {
405 unsigned char *vaddr;
407 data = dregs->fifo_data;
408 vaddr = (unsigned char *)dvma_btov(sun3_dma_orig_addr);
410 vaddr += (sun3_dma_orig_count - fifo);
412 vaddr[-2] = (data & 0xff00) >> 8;
413 vaddr[-1] = (data & 0xff);
417 dvma_unmap(sun3_dma_orig_addr);
418 sun3_dma_orig_addr = NULL;
421 dregs->dma_addr_hi = 0;
422 dregs->dma_addr_lo = 0;
423 dregs->dma_count_hi = 0;
424 dregs->dma_count_lo = 0;
426 dregs->fifo_count = 0;
427 dregs->fifo_count_hi = 0;
429 dregs->csr &= ~CSR_SEND;
430 /* dregs->csr |= CSR_DMA_ENABLE; */
432 sun3_udc_write(UDC_RESET, UDC_CSR);
433 dregs->fifo_count = 0;
434 dregs->csr &= ~CSR_SEND;
437 dregs->csr &= ~CSR_FIFO;
438 dregs->csr |= CSR_FIFO;
441 sun3_dma_setup_done = NULL;
447 #include "atari_NCR5380.c"
450 #define SUN3_SCSI_NAME "Sun3 NCR5380 VME SCSI"
451 #define DRV_MODULE_NAME "sun3_scsi_vme"
453 #define SUN3_SCSI_NAME "Sun3 NCR5380 SCSI"
454 #define DRV_MODULE_NAME "sun3_scsi"
457 #define PFX DRV_MODULE_NAME ": "
459 static struct scsi_host_template sun3_scsi_template = {
460 .module = THIS_MODULE,
461 .proc_name = DRV_MODULE_NAME,
462 .show_info = sun3scsi_show_info,
463 .name = SUN3_SCSI_NAME,
464 .info = sun3scsi_info,
465 .queuecommand = sun3scsi_queue_command,
466 .eh_abort_handler = sun3scsi_abort,
467 .eh_bus_reset_handler = sun3scsi_bus_reset,
470 .sg_tablesize = SG_NONE,
472 .use_clustering = DISABLE_CLUSTERING
475 static int __init sun3_scsi_probe(struct platform_device *pdev)
477 struct Scsi_Host *instance;
479 struct resource *irq, *mem;
480 unsigned char *ioaddr;
486 if (setup_can_queue > 0)
487 sun3_scsi_template.can_queue = setup_can_queue;
488 if (setup_cmd_per_lun > 0)
489 sun3_scsi_template.cmd_per_lun = setup_cmd_per_lun;
490 if (setup_sg_tablesize >= 0)
491 sun3_scsi_template.sg_tablesize = setup_sg_tablesize;
492 if (setup_hostid >= 0)
493 sun3_scsi_template.this_id = setup_hostid & 7;
497 for (i = 0; i < 2; i++) {
500 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
501 mem = platform_get_resource(pdev, IORESOURCE_MEM, i);
505 ioaddr = sun3_ioremap(mem->start, resource_size(mem),
506 SUN3_PAGE_TYPE_VME16);
507 dregs = (struct sun3_dma_regs *)(ioaddr + 8);
509 if (sun3_map_test((unsigned long)dregs, &x)) {
510 unsigned short oldcsr;
514 udelay(SUN3_DMA_DELAY);
515 if (dregs->csr == 0x1400)
527 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
528 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
532 ioaddr = ioremap(mem->start, resource_size(mem));
533 dregs = (struct sun3_dma_regs *)(ioaddr + 8);
535 udc_regs = dvma_malloc(sizeof(struct sun3_udc_regs));
537 pr_err(PFX "couldn't allocate DVMA memory!\n");
543 sun3_scsi_regp = ioaddr;
545 instance = scsi_host_alloc(&sun3_scsi_template,
546 sizeof(struct NCR5380_hostdata));
551 default_instance = instance;
553 instance->io_port = (unsigned long)ioaddr;
554 instance->irq = irq->start;
557 host_flags |= setup_use_tagged_queuing > 0 ? FLAG_TAGGED_QUEUING : 0;
560 error = NCR5380_init(instance, host_flags);
564 error = request_irq(instance->irq, scsi_sun3_intr, 0,
565 "NCR5380", instance);
568 pr_err(PFX "scsi%d: IRQ %d not free, bailing out\n",
569 instance->host_no, instance->irq);
572 pr_warn(PFX "scsi%d: IRQ %d not free, interrupts disabled\n",
573 instance->host_no, instance->irq);
574 instance->irq = NO_IRQ;
579 udelay(SUN3_DMA_DELAY);
580 dregs->csr = CSR_SCSI | CSR_FIFO | CSR_INTR;
581 udelay(SUN3_DMA_DELAY);
582 dregs->fifo_count = 0;
584 dregs->fifo_count_hi = 0;
585 dregs->dma_addr_hi = 0;
586 dregs->dma_addr_lo = 0;
587 dregs->dma_count_hi = 0;
588 dregs->dma_count_lo = 0;
590 dregs->ivect = VME_DATA24 | (instance->irq & 0xff);
593 NCR5380_maybe_reset_bus(instance);
595 error = scsi_add_host(instance, NULL);
599 platform_set_drvdata(pdev, instance);
601 scsi_scan_host(instance);
605 if (instance->irq != NO_IRQ)
606 free_irq(instance->irq, instance);
608 NCR5380_exit(instance);
610 scsi_host_put(instance);
614 iounmap(sun3_scsi_regp);
618 static int __exit sun3_scsi_remove(struct platform_device *pdev)
620 struct Scsi_Host *instance = platform_get_drvdata(pdev);
622 scsi_remove_host(instance);
623 if (instance->irq != NO_IRQ)
624 free_irq(instance->irq, instance);
625 NCR5380_exit(instance);
626 scsi_host_put(instance);
629 iounmap(sun3_scsi_regp);
633 static struct platform_driver sun3_scsi_driver = {
634 .remove = __exit_p(sun3_scsi_remove),
636 .name = DRV_MODULE_NAME,
640 module_platform_driver_probe(sun3_scsi_driver, sun3_scsi_probe);
642 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
643 MODULE_LICENSE("GPL");