[SCSI] sgiwd93: interfacing to wd33c93
[linux-2.6] / drivers / scsi / dtc.c
1
2 #define AUTOSENSE
3 #define PSEUDO_DMA
4 #define DONT_USE_INTR
5 #define UNSAFE                  /* Leave interrupts enabled during pseudo-dma I/O */
6 #define xNDEBUG (NDEBUG_INTR+NDEBUG_RESELECTION+\
7                  NDEBUG_SELECTION+NDEBUG_ARBITRATION)
8 #define DMA_WORKS_RIGHT
9
10
11 /*
12  * DTC 3180/3280 driver, by
13  *      Ray Van Tassle  rayvt@comm.mot.com
14  *
15  *      taken from ...
16  *      Trantor T128/T128F/T228 driver by...
17  *
18  *      Drew Eckhardt
19  *      Visionary Computing
20  *      (Unix and Linux consulting and custom programming)
21  *      drew@colorado.edu
22  *      +1 (303) 440-4894
23  *
24  * DISTRIBUTION RELEASE 1.
25  *
26  * For more information, please consult 
27  *
28  * NCR 5380 Family
29  * SCSI Protocol Controller
30  * Databook
31 */
32
33 /*
34  * Options : 
35  * AUTOSENSE - if defined, REQUEST SENSE will be performed automatically
36  *      for commands that return with a CHECK CONDITION status. 
37  *
38  * PSEUDO_DMA - enables PSEUDO-DMA hardware, should give a 3-4X performance
39  * increase compared to polled I/O.
40  *
41  * PARITY - enable parity checking.  Not supported.
42  *
43  * UNSAFE - leave interrupts enabled during pseudo-DMA transfers. 
44  *              You probably want this.
45  *
46  * The card is detected and initialized in one of several ways : 
47  * 1.  Autoprobe (default) - since the board is memory mapped, 
48  *     a BIOS signature is scanned for to locate the registers.
49  *     An interrupt is triggered to autoprobe for the interrupt
50  *     line.
51  *
52  * 2.  With command line overrides - dtc=address,irq may be 
53  *     used on the LILO command line to override the defaults.
54  * 
55 */
56
57 /*----------------------------------------------------------------*/
58 /* the following will set the monitor border color (useful to find
59  where something crashed or gets stuck at */
60 /* 1 = blue
61  2 = green
62  3 = cyan
63  4 = red
64  5 = magenta
65  6 = yellow
66  7 = white
67 */
68 #if 0
69 #define rtrc(i) {inb(0x3da); outb(0x31, 0x3c0); outb((i), 0x3c0);}
70 #else
71 #define rtrc(i) {}
72 #endif
73
74
75 #include <asm/system.h>
76 #include <linux/module.h>
77 #include <linux/signal.h>
78 #include <linux/blkdev.h>
79 #include <linux/delay.h>
80 #include <linux/stat.h>
81 #include <linux/string.h>
82 #include <linux/init.h>
83 #include <linux/interrupt.h>
84 #include <linux/io.h>
85 #include "scsi.h"
86 #include <scsi/scsi_host.h>
87 #include "dtc.h"
88 #define AUTOPROBE_IRQ
89 #include "NCR5380.h"
90
91
92 #define DTC_PUBLIC_RELEASE 2
93
94 /*
95  * The DTC3180 & 3280 boards are memory mapped.
96  * 
97  */
98
99 /*
100  */
101 /* Offset from DTC_5380_OFFSET */
102 #define DTC_CONTROL_REG         0x100   /* rw */
103 #define D_CR_ACCESS             0x80    /* ro set=can access 3280 registers */
104 #define CSR_DIR_READ            0x40    /* rw direction, 1 = read 0 = write */
105
106 #define CSR_RESET              0x80     /* wo  Resets 53c400 */
107 #define CSR_5380_REG           0x80     /* ro  5380 registers can be accessed */
108 #define CSR_TRANS_DIR          0x40     /* rw  Data transfer direction */
109 #define CSR_SCSI_BUFF_INTR     0x20     /* rw  Enable int on transfer ready */
110 #define CSR_5380_INTR          0x10     /* rw  Enable 5380 interrupts */
111 #define CSR_SHARED_INTR        0x08     /* rw  Interrupt sharing */
112 #define CSR_HOST_BUF_NOT_RDY   0x04     /* ro  Host buffer not ready */
113 #define CSR_SCSI_BUF_RDY       0x02     /* ro  SCSI buffer ready */
114 #define CSR_GATED_5380_IRQ     0x01     /* ro  Last block xferred */
115 #define CSR_INT_BASE (CSR_SCSI_BUFF_INTR | CSR_5380_INTR)
116
117
118 #define DTC_BLK_CNT             0x101   /* rw 
119                                          * # of 128-byte blocks to transfer */
120
121
122 #define D_CR_ACCESS             0x80    /* ro set=can access 3280 registers */
123
124 #define DTC_SWITCH_REG          0x3982  /* ro - DIP switches */
125 #define DTC_RESUME_XFER         0x3982  /* wo - resume data xfer 
126                                          * after disconnect/reconnect*/
127
128 #define DTC_5380_OFFSET         0x3880  /* 8 registers here, see NCR5380.h */
129
130 /*!!!! for dtc, it's a 128 byte buffer at 3900 !!! */
131 #define DTC_DATA_BUF            0x3900  /* rw 128 bytes long */
132
133 static struct override {
134         unsigned int address;
135         int irq;
136 } overrides
137 #ifdef OVERRIDE
138 [] __initdata = OVERRIDE;
139 #else
140 [4] __initdata = { {
141 0, IRQ_AUTO}, {
142 0, IRQ_AUTO}, {
143 0, IRQ_AUTO}, {
144 0, IRQ_AUTO}};
145 #endif
146
147 #define NO_OVERRIDES ARRAY_SIZE(overrides)
148
149 static struct base {
150         unsigned long address;
151         int noauto;
152 } bases[] __initdata = {
153         { 0xcc000, 0 },
154         { 0xc8000, 0 },
155         { 0xdc000, 0 },
156         { 0xd8000, 0 }
157 };
158
159 #define NO_BASES ARRAY_SIZE(bases)
160
161 static const struct signature {
162         const char *string;
163         int offset;
164 } signatures[] = {
165         {"DATA TECHNOLOGY CORPORATION BIOS", 0x25},
166 };
167
168 #define NO_SIGNATURES ARRAY_SIZE(signatures)
169
170 #ifndef MODULE
171 /*
172  * Function : dtc_setup(char *str, int *ints)
173  *
174  * Purpose : LILO command line initialization of the overrides array,
175  *
176  * Inputs : str - unused, ints - array of integer parameters with ints[0]
177  *      equal to the number of ints.
178  *
179 */
180
181 static void __init dtc_setup(char *str, int *ints)
182 {
183         static int commandline_current = 0;
184         int i;
185         if (ints[0] != 2)
186                 printk("dtc_setup: usage dtc=address,irq\n");
187         else if (commandline_current < NO_OVERRIDES) {
188                 overrides[commandline_current].address = ints[1];
189                 overrides[commandline_current].irq = ints[2];
190                 for (i = 0; i < NO_BASES; ++i)
191                         if (bases[i].address == ints[1]) {
192                                 bases[i].noauto = 1;
193                                 break;
194                         }
195                 ++commandline_current;
196         }
197 }
198 #endif
199
200 /* 
201  * Function : int dtc_detect(struct scsi_host_template * tpnt)
202  *
203  * Purpose : detects and initializes DTC 3180/3280 controllers
204  *      that were autoprobed, overridden on the LILO command line, 
205  *      or specified at compile time.
206  *
207  * Inputs : tpnt - template for this SCSI adapter.
208  * 
209  * Returns : 1 if a host adapter was found, 0 if not.
210  *
211 */
212
213 static int __init dtc_detect(struct scsi_host_template * tpnt)
214 {
215         static int current_override = 0, current_base = 0;
216         struct Scsi_Host *instance;
217         unsigned int addr;
218         void __iomem *base;
219         int sig, count;
220
221         tpnt->proc_name = "dtc3x80";
222         tpnt->proc_info = &dtc_proc_info;
223
224         for (count = 0; current_override < NO_OVERRIDES; ++current_override) {
225                 addr = 0;
226                 base = NULL;
227
228                 if (overrides[current_override].address) {
229                         addr = overrides[current_override].address;
230                         base = ioremap(addr, 0x2000);
231                         if (!base)
232                                 addr = 0;
233                 } else
234                         for (; !addr && (current_base < NO_BASES); ++current_base) {
235 #if (DTCDEBUG & DTCDEBUG_INIT)
236                                 printk("scsi-dtc : probing address %08x\n", bases[current_base].address);
237 #endif
238                                 if (bases[current_base].noauto)
239                                         continue;
240                                 base = ioremap(bases[current_base].address, 0x2000);
241                                 if (!base)
242                                         continue;
243                                 for (sig = 0; sig < NO_SIGNATURES; ++sig) {
244                                         if (check_signature(base + signatures[sig].offset, signatures[sig].string, strlen(signatures[sig].string))) {
245                                                 addr = bases[current_base].address;
246 #if (DTCDEBUG & DTCDEBUG_INIT)
247                                                 printk("scsi-dtc : detected board.\n");
248 #endif
249                                                 goto found;
250                                         }
251                                 }
252                                 iounmap(base);
253                         }
254
255 #if defined(DTCDEBUG) && (DTCDEBUG & DTCDEBUG_INIT)
256                 printk("scsi-dtc : base = %08x\n", addr);
257 #endif
258
259                 if (!addr)
260                         break;
261
262 found:
263                 instance = scsi_register(tpnt, sizeof(struct NCR5380_hostdata));
264                 if (instance == NULL)
265                         break;
266
267                 instance->base = addr;
268                 ((struct NCR5380_hostdata *)(instance)->hostdata)->base = base;
269
270                 NCR5380_init(instance, 0);
271
272                 NCR5380_write(DTC_CONTROL_REG, CSR_5380_INTR);  /* Enable int's */
273                 if (overrides[current_override].irq != IRQ_AUTO)
274                         instance->irq = overrides[current_override].irq;
275                 else
276                         instance->irq = NCR5380_probe_irq(instance, DTC_IRQS);
277
278 #ifndef DONT_USE_INTR
279                 /* With interrupts enabled, it will sometimes hang when doing heavy
280                  * reads. So better not enable them until I finger it out. */
281                 if (instance->irq != SCSI_IRQ_NONE)
282                         if (request_irq(instance->irq, dtc_intr, IRQF_DISABLED, "dtc", instance)) {
283                                 printk(KERN_ERR "scsi%d : IRQ%d not free, interrupts disabled\n", instance->host_no, instance->irq);
284                                 instance->irq = SCSI_IRQ_NONE;
285                         }
286
287                 if (instance->irq == SCSI_IRQ_NONE) {
288                         printk(KERN_WARNING "scsi%d : interrupts not enabled. for better interactive performance,\n", instance->host_no);
289                         printk(KERN_WARNING "scsi%d : please jumper the board for a free IRQ.\n", instance->host_no);
290                 }
291 #else
292                 if (instance->irq != SCSI_IRQ_NONE)
293                         printk(KERN_WARNING "scsi%d : interrupts not used. Might as well not jumper it.\n", instance->host_no);
294                 instance->irq = SCSI_IRQ_NONE;
295 #endif
296 #if defined(DTCDEBUG) && (DTCDEBUG & DTCDEBUG_INIT)
297                 printk("scsi%d : irq = %d\n", instance->host_no, instance->irq);
298 #endif
299
300                 printk(KERN_INFO "scsi%d : at 0x%05X", instance->host_no, (int) instance->base);
301                 if (instance->irq == SCSI_IRQ_NONE)
302                         printk(" interrupts disabled");
303                 else
304                         printk(" irq %d", instance->irq);
305                 printk(" options CAN_QUEUE=%d  CMD_PER_LUN=%d release=%d", CAN_QUEUE, CMD_PER_LUN, DTC_PUBLIC_RELEASE);
306                 NCR5380_print_options(instance);
307                 printk("\n");
308
309                 ++current_override;
310                 ++count;
311         }
312         return count;
313 }
314
315 /*
316  * Function : int dtc_biosparam(Disk * disk, struct block_device *dev, int *ip)
317  *
318  * Purpose : Generates a BIOS / DOS compatible H-C-S mapping for 
319  *      the specified device / size.
320  * 
321  * Inputs : size = size of device in sectors (512 bytes), dev = block device
322  *      major / minor, ip[] = {heads, sectors, cylinders}  
323  *
324  * Returns : always 0 (success), initializes ip
325  *      
326 */
327
328 /* 
329  * XXX Most SCSI boards use this mapping, I could be incorrect.  Some one
330  * using hard disks on a trantor should verify that this mapping corresponds
331  * to that used by the BIOS / ASPI driver by running the linux fdisk program
332  * and matching the H_C_S coordinates to what DOS uses.
333 */
334
335 static int dtc_biosparam(struct scsi_device *sdev, struct block_device *dev,
336                          sector_t capacity, int *ip)
337 {
338         int size = capacity;
339
340         ip[0] = 64;
341         ip[1] = 32;
342         ip[2] = size >> 11;
343         return 0;
344 }
345
346
347 /****************************************************************
348  * Function : int NCR5380_pread (struct Scsi_Host *instance, 
349  *      unsigned char *dst, int len)
350  *
351  * Purpose : Fast 5380 pseudo-dma read function, reads len bytes to 
352  *      dst
353  * 
354  * Inputs : dst = destination, len = length in bytes
355  *
356  * Returns : 0 on success, non zero on a failure such as a watchdog 
357  *      timeout.
358 */
359
360 static int dtc_maxi = 0;
361 static int dtc_wmaxi = 0;
362
363 static inline int NCR5380_pread(struct Scsi_Host *instance, unsigned char *dst, int len)
364 {
365         unsigned char *d = dst;
366         int i;                  /* For counting time spent in the poll-loop */
367         NCR5380_local_declare();
368         NCR5380_setup(instance);
369
370         i = 0;
371         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
372         NCR5380_write(MODE_REG, MR_ENABLE_EOP_INTR | MR_DMA_MODE);
373         if (instance->irq == SCSI_IRQ_NONE)
374                 NCR5380_write(DTC_CONTROL_REG, CSR_DIR_READ);
375         else
376                 NCR5380_write(DTC_CONTROL_REG, CSR_DIR_READ | CSR_INT_BASE);
377         NCR5380_write(DTC_BLK_CNT, len >> 7);   /* Block count */
378         rtrc(1);
379         while (len > 0) {
380                 rtrc(2);
381                 while (NCR5380_read(DTC_CONTROL_REG) & CSR_HOST_BUF_NOT_RDY)
382                         ++i;
383                 rtrc(3);
384                 memcpy_fromio(d, base + DTC_DATA_BUF, 128);
385                 d += 128;
386                 len -= 128;
387                 rtrc(7);
388                 /*** with int's on, it sometimes hangs after here.
389                  * Looks like something makes HBNR go away. */
390         }
391         rtrc(4);
392         while (!(NCR5380_read(DTC_CONTROL_REG) & D_CR_ACCESS))
393                 ++i;
394         NCR5380_write(MODE_REG, 0);     /* Clear the operating mode */
395         rtrc(0);
396         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
397         if (i > dtc_maxi)
398                 dtc_maxi = i;
399         return (0);
400 }
401
402 /****************************************************************
403  * Function : int NCR5380_pwrite (struct Scsi_Host *instance, 
404  *      unsigned char *src, int len)
405  *
406  * Purpose : Fast 5380 pseudo-dma write function, transfers len bytes from
407  *      src
408  * 
409  * Inputs : src = source, len = length in bytes
410  *
411  * Returns : 0 on success, non zero on a failure such as a watchdog 
412  *      timeout.
413 */
414
415 static inline int NCR5380_pwrite(struct Scsi_Host *instance, unsigned char *src, int len)
416 {
417         int i;
418         NCR5380_local_declare();
419         NCR5380_setup(instance);
420
421         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
422         NCR5380_write(MODE_REG, MR_ENABLE_EOP_INTR | MR_DMA_MODE);
423         /* set direction (write) */
424         if (instance->irq == SCSI_IRQ_NONE)
425                 NCR5380_write(DTC_CONTROL_REG, 0);
426         else
427                 NCR5380_write(DTC_CONTROL_REG, CSR_5380_INTR);
428         NCR5380_write(DTC_BLK_CNT, len >> 7);   /* Block count */
429         for (i = 0; len > 0; ++i) {
430                 rtrc(5);
431                 /* Poll until the host buffer can accept data. */
432                 while (NCR5380_read(DTC_CONTROL_REG) & CSR_HOST_BUF_NOT_RDY)
433                         ++i;
434                 rtrc(3);
435                 memcpy_toio(base + DTC_DATA_BUF, src, 128);
436                 src += 128;
437                 len -= 128;
438         }
439         rtrc(4);
440         while (!(NCR5380_read(DTC_CONTROL_REG) & D_CR_ACCESS))
441                 ++i;
442         rtrc(6);
443         /* Wait until the last byte has been sent to the disk */
444         while (!(NCR5380_read(TARGET_COMMAND_REG) & TCR_LAST_BYTE_SENT))
445                 ++i;
446         rtrc(7);
447         /* Check for parity error here. fixme. */
448         NCR5380_write(MODE_REG, 0);     /* Clear the operating mode */
449         rtrc(0);
450         if (i > dtc_wmaxi)
451                 dtc_wmaxi = i;
452         return (0);
453 }
454
455 MODULE_LICENSE("GPL");
456
457 #include "NCR5380.c"
458
459 static int dtc_release(struct Scsi_Host *shost)
460 {
461         NCR5380_local_declare();
462         NCR5380_setup(shost);
463         if (shost->irq)
464                 free_irq(shost->irq, NULL);
465         NCR5380_exit(shost);
466         if (shost->io_port && shost->n_io_port)
467                 release_region(shost->io_port, shost->n_io_port);
468         scsi_unregister(shost);
469         iounmap(base);
470         return 0;
471 }
472
473 static struct scsi_host_template driver_template = {
474         .name                           = "DTC 3180/3280 ",
475         .detect                         = dtc_detect,
476         .release                        = dtc_release,
477         .queuecommand                   = dtc_queue_command,
478         .eh_abort_handler               = dtc_abort,
479         .eh_bus_reset_handler           = dtc_bus_reset,
480         .bios_param                     = dtc_biosparam,
481         .can_queue                      = CAN_QUEUE,
482         .this_id                        = 7,
483         .sg_tablesize                   = SG_ALL,
484         .cmd_per_lun                    = CMD_PER_LUN,
485         .use_clustering                 = DISABLE_CLUSTERING,
486 };
487 #include "scsi_module.c"