2 * linux/drivers/acorn/scsi/eesox.c
4 * Copyright (C) 1997-2003 Russell King
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This driver is based on experimentation. Hence, it may have made
11 * assumptions about the particular card that I have available, and
12 * may not be reliable!
15 * 01-10-1997 RMK Created, READONLY version
16 * 15-02-1998 RMK READ/WRITE version
17 * added DMA support and hardware definitions
18 * 14-03-1998 RMK Updated DMA support
19 * Added terminator control
20 * 15-04-1998 RMK Only do PIO if FAS216 will allow it.
21 * 27-06-1998 RMK Changed asm/delay.h to linux/delay.h
22 * 02-04-2000 RMK 0.0.3 Fixed NO_IRQ/NO_DMA problem, updated for new
23 * error handling code.
25 #include <linux/module.h>
26 #include <linux/blkdev.h>
27 #include <linux/kernel.h>
28 #include <linux/string.h>
29 #include <linux/ioport.h>
30 #include <linux/sched.h>
31 #include <linux/proc_fs.h>
32 #include <linux/delay.h>
33 #include <linux/interrupt.h>
34 #include <linux/init.h>
35 #include <linux/dma-mapping.h>
40 #include <asm/ecard.h>
41 #include <asm/pgtable.h>
48 #include <scsi/scsicam.h>
50 #define EESOX_FAS216_OFFSET 0x3000
51 #define EESOX_FAS216_SHIFT 5
53 #define EESOX_DMASTAT 0x2800
54 #define EESOX_STAT_INTR 0x01
55 #define EESOX_STAT_DMA 0x02
57 #define EESOX_CONTROL 0x2800
58 #define EESOX_INTR_ENABLE 0x04
59 #define EESOX_TERM_ENABLE 0x02
60 #define EESOX_RESET 0x01
62 #define EESOX_DMADATA 0x3800
64 #define VERSION "1.10 (17/01/2003 2.5.59)"
67 * Use term=0,1,0,0,0 to turn terminators on/off
69 static int term[MAX_ECARDS] = { 1, 1, 1, 1, 1, 1, 1, 1 };
73 struct eesoxscsi_info {
75 struct expansion_card *ec;
79 struct scatterlist sg[NR_SG]; /* Scatter DMA list */
82 /* Prototype: void eesoxscsi_irqenable(ec, irqnr)
83 * Purpose : Enable interrupts on EESOX SCSI card
84 * Params : ec - expansion card structure
85 * : irqnr - interrupt number
88 eesoxscsi_irqenable(struct expansion_card *ec, int irqnr)
90 struct eesoxscsi_info *info = (struct eesoxscsi_info *)ec->irq_data;
92 info->control |= EESOX_INTR_ENABLE;
94 writeb(info->control, info->ctl_port);
97 /* Prototype: void eesoxscsi_irqdisable(ec, irqnr)
98 * Purpose : Disable interrupts on EESOX SCSI card
99 * Params : ec - expansion card structure
100 * : irqnr - interrupt number
103 eesoxscsi_irqdisable(struct expansion_card *ec, int irqnr)
105 struct eesoxscsi_info *info = (struct eesoxscsi_info *)ec->irq_data;
107 info->control &= ~EESOX_INTR_ENABLE;
109 writeb(info->control, info->ctl_port);
112 static const expansioncard_ops_t eesoxscsi_ops = {
113 .irqenable = eesoxscsi_irqenable,
114 .irqdisable = eesoxscsi_irqdisable,
117 /* Prototype: void eesoxscsi_terminator_ctl(*host, on_off)
118 * Purpose : Turn the EESOX SCSI terminators on or off
119 * Params : host - card to turn on/off
120 * : on_off - !0 to turn on, 0 to turn off
123 eesoxscsi_terminator_ctl(struct Scsi_Host *host, int on_off)
125 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
128 spin_lock_irqsave(host->host_lock, flags);
130 info->control |= EESOX_TERM_ENABLE;
132 info->control &= ~EESOX_TERM_ENABLE;
134 writeb(info->control, info->ctl_port);
135 spin_unlock_irqrestore(host->host_lock, flags);
138 /* Prototype: void eesoxscsi_intr(irq, *dev_id, *regs)
139 * Purpose : handle interrupts from EESOX SCSI card
140 * Params : irq - interrupt number
141 * dev_id - user-defined (Scsi_Host structure)
142 * regs - processor registers at interrupt
145 eesoxscsi_intr(int irq, void *dev_id, struct pt_regs *regs)
147 struct eesoxscsi_info *info = dev_id;
149 return fas216_intr(&info->info);
152 /* Prototype: fasdmatype_t eesoxscsi_dma_setup(host, SCpnt, direction, min_type)
153 * Purpose : initialises DMA/PIO
154 * Params : host - host
156 * direction - DMA on to/off of card
157 * min_type - minimum DMA support that we must have for this transfer
158 * Returns : type of transfer to be performed
161 eesoxscsi_dma_setup(struct Scsi_Host *host, Scsi_Pointer *SCp,
162 fasdmadir_t direction, fasdmatype_t min_type)
164 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
165 struct device *dev = scsi_get_device(host);
166 int dmach = host->dma_channel;
168 if (dmach != NO_DMA &&
169 (min_type == fasdma_real_all || SCp->this_residual >= 512)) {
170 int bufs, map_dir, dma_dir;
172 bufs = copy_SCp_to_sg(&info->sg[0], SCp, NR_SG);
174 if (direction == DMA_OUT)
175 map_dir = DMA_TO_DEVICE,
176 dma_dir = DMA_MODE_WRITE;
178 map_dir = DMA_FROM_DEVICE,
179 dma_dir = DMA_MODE_READ;
181 dma_map_sg(dev, info->sg, bufs + 1, map_dir);
184 set_dma_sg(dmach, info->sg, bufs + 1);
185 set_dma_mode(dmach, dma_dir);
187 return fasdma_real_all;
190 * We don't do DMA, we only do slow PIO
192 * Some day, we will do Pseudo DMA
194 return fasdma_pseudo;
197 static void eesoxscsi_buffer_in(void *buf, int length, void *base)
199 const void *reg_fas = base + EESOX_FAS216_OFFSET;
200 const void *reg_dmastat = base + EESOX_DMASTAT;
201 const void *reg_dmadata = base + EESOX_DMADATA;
202 const register unsigned long mask = 0xffff;
210 status = readb(reg_fas + (REG_STAT << EESOX_FAS216_SHIFT));
211 if (status & STAT_INT)
215 * DMA request active?
217 status = readb(reg_dmastat);
218 if (!(status & EESOX_STAT_DMA))
222 * Get number of bytes in FIFO
224 status = readb(reg_fas + (REG_CFIS << EESOX_FAS216_SHIFT)) & CFIS_CF;
233 if (((u32)buf) & 2 && status >= 2) {
234 *((u16 *)buf)++ = readl(reg_dmadata);
240 unsigned long l1, l2;
242 l1 = readl(reg_dmadata) & mask;
243 l1 |= readl(reg_dmadata) << 16;
244 l2 = readl(reg_dmadata) & mask;
245 l2 |= readl(reg_dmadata) << 16;
246 *((u32 *)buf)++ = l1;
247 *((u32 *)buf)++ = l2;
255 l1 = readl(reg_dmadata) & mask;
256 l1 |= readl(reg_dmadata) << 16;
258 *((u32 *)buf)++ = l1;
264 *((u16 *)buf)++ = readl(reg_dmadata);
270 static void eesoxscsi_buffer_out(void *buf, int length, void *base)
272 const void *reg_fas = base + EESOX_FAS216_OFFSET;
273 const void *reg_dmastat = base + EESOX_DMASTAT;
274 const void *reg_dmadata = base + EESOX_DMADATA;
282 status = readb(reg_fas + (REG_STAT << EESOX_FAS216_SHIFT));
283 if (status & STAT_INT)
287 * DMA request active?
289 status = readb(reg_dmastat);
290 if (!(status & EESOX_STAT_DMA))
294 * Get number of bytes in FIFO
296 status = readb(reg_fas + (REG_CFIS << EESOX_FAS216_SHIFT)) & CFIS_CF;
299 status = 16 - status;
307 if (((u32)buf) & 2 && status >= 2) {
308 writel(*((u16 *)buf)++ << 16, reg_dmadata);
314 unsigned long l1, l2;
316 l1 = *((u32 *)buf)++;
317 l2 = *((u32 *)buf)++;
319 writel(l1 << 16, reg_dmadata);
320 writel(l1, reg_dmadata);
321 writel(l2 << 16, reg_dmadata);
322 writel(l2, reg_dmadata);
330 l1 = *((u32 *)buf)++;
332 writel(l1 << 16, reg_dmadata);
333 writel(l1, reg_dmadata);
339 writel(*((u16 *)buf)++ << 16, reg_dmadata);
346 eesoxscsi_dma_pseudo(struct Scsi_Host *host, Scsi_Pointer *SCp,
347 fasdmadir_t dir, int transfer_size)
349 void *base = (void *)host->base;
351 eesoxscsi_buffer_in(SCp->ptr, SCp->this_residual, base);
353 eesoxscsi_buffer_out(SCp->ptr, SCp->this_residual, base);
357 /* Prototype: int eesoxscsi_dma_stop(host, SCpnt)
358 * Purpose : stops DMA/PIO
359 * Params : host - host
363 eesoxscsi_dma_stop(struct Scsi_Host *host, Scsi_Pointer *SCp)
365 if (host->dma_channel != NO_DMA)
366 disable_dma(host->dma_channel);
369 /* Prototype: const char *eesoxscsi_info(struct Scsi_Host * host)
370 * Purpose : returns a descriptive string about this interface,
371 * Params : host - driver host structure to return info for.
372 * Returns : pointer to a static buffer containing null terminated string.
374 const char *eesoxscsi_info(struct Scsi_Host *host)
376 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
377 static char string[150];
379 sprintf(string, "%s (%s) in slot %d v%s terminators o%s",
380 host->hostt->name, info->info.scsi.type, info->ec->slot_no,
381 VERSION, info->control & EESOX_TERM_ENABLE ? "n" : "ff");
386 /* Prototype: int eesoxscsi_set_proc_info(struct Scsi_Host *host, char *buffer, int length)
387 * Purpose : Set a driver specific function
388 * Params : host - host to setup
389 * : buffer - buffer containing string describing operation
390 * : length - length of string
391 * Returns : -EINVAL, or 0
394 eesoxscsi_set_proc_info(struct Scsi_Host *host, char *buffer, int length)
398 if (length >= 9 && strncmp(buffer, "EESOXSCSI", 9) == 0) {
402 if (length >= 5 && strncmp(buffer, "term=", 5) == 0) {
403 if (buffer[5] == '1')
404 eesoxscsi_terminator_ctl(host, 1);
405 else if (buffer[5] == '0')
406 eesoxscsi_terminator_ctl(host, 0);
417 /* Prototype: int eesoxscsi_proc_info(char *buffer, char **start, off_t offset,
418 * int length, int host_no, int inout)
419 * Purpose : Return information about the driver to a user process accessing
420 * the /proc filesystem.
421 * Params : buffer - a buffer to write information to
422 * start - a pointer into this buffer set by this routine to the start
423 * of the required information.
424 * offset - offset into information that we have read upto.
425 * length - length of buffer
426 * host_no - host number to return information for
427 * inout - 0 for reading, 1 for writing.
428 * Returns : length of data written to buffer.
430 int eesoxscsi_proc_info(struct Scsi_Host *host, char *buffer, char **start, off_t offset,
431 int length, int inout)
433 struct eesoxscsi_info *info;
438 return eesoxscsi_set_proc_info(host, buffer, length);
440 info = (struct eesoxscsi_info *)host->hostdata;
442 p += sprintf(p, "EESOX SCSI driver v%s\n", VERSION);
443 p += fas216_print_host(&info->info, p);
444 p += sprintf(p, "Term : o%s\n",
445 info->control & EESOX_TERM_ENABLE ? "n" : "ff");
447 p += fas216_print_stats(&info->info, p);
448 p += fas216_print_devices(&info->info, p);
450 *start = buffer + offset;
451 pos = p - buffer - offset;
458 static ssize_t eesoxscsi_show_term(struct device *dev, char *buf)
460 struct expansion_card *ec = ECARD_DEV(dev);
461 struct Scsi_Host *host = ecard_get_drvdata(ec);
462 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
464 return sprintf(buf, "%d\n", info->control & EESOX_TERM_ENABLE ? 1 : 0);
467 static ssize_t eesoxscsi_store_term(struct device *dev, const char *buf, size_t len)
469 struct expansion_card *ec = ECARD_DEV(dev);
470 struct Scsi_Host *host = ecard_get_drvdata(ec);
471 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
475 spin_lock_irqsave(host->host_lock, flags);
477 info->control |= EESOX_TERM_ENABLE;
479 info->control &= ~EESOX_TERM_ENABLE;
481 writeb(info->control, info->ctl_port);
482 spin_unlock_irqrestore(host->host_lock, flags);
488 static DEVICE_ATTR(bus_term, S_IRUGO | S_IWUSR,
489 eesoxscsi_show_term, eesoxscsi_store_term);
491 static Scsi_Host_Template eesox_template = {
492 .module = THIS_MODULE,
493 .proc_info = eesoxscsi_proc_info,
494 .name = "EESOX SCSI",
495 .info = eesoxscsi_info,
496 .queuecommand = fas216_queue_command,
497 .eh_host_reset_handler = fas216_eh_host_reset,
498 .eh_bus_reset_handler = fas216_eh_bus_reset,
499 .eh_device_reset_handler = fas216_eh_device_reset,
500 .eh_abort_handler = fas216_eh_abort,
503 .sg_tablesize = SG_ALL,
505 .use_clustering = DISABLE_CLUSTERING,
506 .proc_name = "eesox",
510 eesoxscsi_probe(struct expansion_card *ec, const struct ecard_id *id)
512 struct Scsi_Host *host;
513 struct eesoxscsi_info *info;
514 unsigned long resbase, reslen;
518 resbase = ecard_resource_start(ec, ECARD_RES_IOCFAST);
519 reslen = ecard_resource_len(ec, ECARD_RES_IOCFAST);
521 if (!request_mem_region(resbase, reslen, "eesoxscsi")) {
526 base = ioremap(resbase, reslen);
532 host = scsi_host_alloc(&eesox_template,
533 sizeof(struct eesoxscsi_info));
539 host->base = (unsigned long)base;
541 host->dma_channel = ec->dma;
543 ecard_set_drvdata(ec, host);
545 info = (struct eesoxscsi_info *)host->hostdata;
547 info->ctl_port = base + EESOX_CONTROL;
548 info->control = term[ec->slot_no] ? EESOX_TERM_ENABLE : 0;
549 writeb(info->control, info->ctl_port);
551 ec->irqaddr = base + EESOX_DMASTAT;
552 ec->irqmask = EESOX_STAT_INTR;
554 ec->ops = &eesoxscsi_ops;
556 info->info.scsi.io_base = base + EESOX_FAS216_OFFSET;
557 info->info.scsi.io_shift = EESOX_FAS216_SHIFT;
558 info->info.scsi.irq = host->irq;
559 info->info.ifcfg.clockrate = 40; /* MHz */
560 info->info.ifcfg.select_timeout = 255;
561 info->info.ifcfg.asyncperiod = 200; /* ns */
562 info->info.ifcfg.sync_max_depth = 7;
563 info->info.ifcfg.cntl3 = CNTL3_FASTSCSI | CNTL3_FASTCLK;
564 info->info.ifcfg.disconnect_ok = 1;
565 info->info.ifcfg.wide_max_size = 0;
566 info->info.ifcfg.capabilities = FASCAP_PSEUDODMA;
567 info->info.dma.setup = eesoxscsi_dma_setup;
568 info->info.dma.pseudo = eesoxscsi_dma_pseudo;
569 info->info.dma.stop = eesoxscsi_dma_stop;
571 device_create_file(&ec->dev, &dev_attr_bus_term);
573 ret = fas216_init(host);
577 ret = request_irq(host->irq, eesoxscsi_intr, 0, "eesoxscsi", info);
579 printk("scsi%d: IRQ%d not free: %d\n",
580 host->host_no, host->irq, ret);
584 if (host->dma_channel != NO_DMA) {
585 if (request_dma(host->dma_channel, "eesox")) {
586 printk("scsi%d: DMA%d not free, DMA disabled\n",
587 host->host_no, host->dma_channel);
588 host->dma_channel = NO_DMA;
590 set_dma_speed(host->dma_channel, 180);
591 info->info.ifcfg.capabilities |= FASCAP_DMA;
592 info->info.ifcfg.cntl3 |= CNTL3_BS8;
596 ret = fas216_add(host, &ec->dev);
600 if (host->dma_channel != NO_DMA)
601 free_dma(host->dma_channel);
602 free_irq(host->irq, host);
608 device_remove_file(&ec->dev, &dev_attr_bus_term);
615 release_mem_region(resbase, reslen);
621 static void __devexit eesoxscsi_remove(struct expansion_card *ec)
623 struct Scsi_Host *host = ecard_get_drvdata(ec);
624 struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
625 unsigned long resbase, reslen;
627 ecard_set_drvdata(ec, NULL);
630 if (host->dma_channel != NO_DMA)
631 free_dma(host->dma_channel);
632 free_irq(host->irq, info);
634 device_remove_file(&ec->dev, &dev_attr_bus_term);
636 iounmap((void *)host->base);
638 resbase = ecard_resource_start(ec, ECARD_RES_IOCFAST);
639 reslen = ecard_resource_len(ec, ECARD_RES_IOCFAST);
641 release_mem_region(resbase, reslen);
643 fas216_release(host);
647 static const struct ecard_id eesoxscsi_cids[] = {
648 { MANU_EESOX, PROD_EESOX_SCSI2 },
652 static struct ecard_driver eesoxscsi_driver = {
653 .probe = eesoxscsi_probe,
654 .remove = __devexit_p(eesoxscsi_remove),
655 .id_table = eesoxscsi_cids,
661 static int __init eesox_init(void)
663 return ecard_register_driver(&eesoxscsi_driver);
666 static void __exit eesox_exit(void)
668 ecard_remove_driver(&eesoxscsi_driver);
671 module_init(eesox_init);
672 module_exit(eesox_exit);
674 MODULE_AUTHOR("Russell King");
675 MODULE_DESCRIPTION("EESOX 'Fast' SCSI driver for Acorn machines");
676 MODULE_PARM(term, "1-8i");
677 MODULE_PARM_DESC(term, "SCSI bus termination");
678 MODULE_LICENSE("GPL");