ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / 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/sched.h>
79 #include <linux/blkdev.h>
80 #include <linux/delay.h>
81 #include <linux/stat.h>
82 #include <linux/string.h>
83 #include <linux/init.h>
84 #include <linux/interrupt.h>
85 #include <asm/io.h>
86 #include "scsi.h"
87 #include "hosts.h"
88 #include "dtc.h"
89 #define AUTOPROBE_IRQ
90 #include "NCR5380.h"
91
92
93 #define DTC_PUBLIC_RELEASE 2
94
95 /*#define DTCDEBUG 0x1*/
96 #define DTCDEBUG_INIT   0x1
97 #define DTCDEBUG_TRANSFER 0x2
98
99 /*
100  * The DTC3180 & 3280 boards are memory mapped.
101  * 
102  */
103
104 /*
105  */
106 /* Offset from DTC_5380_OFFSET */
107 #define DTC_CONTROL_REG         0x100   /* rw */
108 #define D_CR_ACCESS             0x80    /* ro set=can access 3280 registers */
109 #define CSR_DIR_READ            0x40    /* rw direction, 1 = read 0 = write */
110
111 #define CSR_RESET              0x80     /* wo  Resets 53c400 */
112 #define CSR_5380_REG           0x80     /* ro  5380 registers can be accessed */
113 #define CSR_TRANS_DIR          0x40     /* rw  Data transfer direction */
114 #define CSR_SCSI_BUFF_INTR     0x20     /* rw  Enable int on transfer ready */
115 #define CSR_5380_INTR          0x10     /* rw  Enable 5380 interrupts */
116 #define CSR_SHARED_INTR        0x08     /* rw  Interrupt sharing */
117 #define CSR_HOST_BUF_NOT_RDY   0x04     /* ro  Host buffer not ready */
118 #define CSR_SCSI_BUF_RDY       0x02     /* ro  SCSI buffer ready */
119 #define CSR_GATED_5380_IRQ     0x01     /* ro  Last block xferred */
120 #define CSR_INT_BASE (CSR_SCSI_BUFF_INTR | CSR_5380_INTR)
121
122
123 #define DTC_BLK_CNT             0x101   /* rw 
124                                          * # of 128-byte blocks to transfer */
125
126
127 #define D_CR_ACCESS             0x80    /* ro set=can access 3280 registers */
128
129 #define DTC_SWITCH_REG          0x3982  /* ro - DIP switches */
130 #define DTC_RESUME_XFER         0x3982  /* wo - resume data xfer 
131                                          * after disconnect/reconnect*/
132
133 #define DTC_5380_OFFSET         0x3880  /* 8 registers here, see NCR5380.h */
134
135 /*!!!! for dtc, it's a 128 byte buffer at 3900 !!! */
136 #define DTC_DATA_BUF            0x3900  /* rw 128 bytes long */
137
138 static struct override {
139         unsigned int address;
140         int irq;
141 } overrides
142 #ifdef OVERRIDE
143 [] __initdata = OVERRIDE;
144 #else
145 [4] __initdata = { {
146 0, IRQ_AUTO}, {
147 0, IRQ_AUTO}, {
148 0, IRQ_AUTO}, {
149 0, IRQ_AUTO}};
150 #endif
151
152 #define NO_OVERRIDES (sizeof(overrides) / sizeof(struct override))
153
154 static struct base {
155         unsigned long address;
156         int noauto;
157 } bases[] __initdata = { 
158         { 0xcc000, 0 }, 
159         { 0xc8000, 0 }, 
160         { 0xdc000, 0 }, 
161         { 0xd8000, 0 }
162 };
163
164 #define NO_BASES (sizeof (bases) / sizeof (struct base))
165
166 static const struct signature {
167         const char *string;
168         int offset;
169 } signatures[] = { 
170         {"DATA TECHNOLOGY CORPORATION BIOS", 0x25},
171 };
172
173 #define NO_SIGNATURES (sizeof (signatures) /  sizeof (struct signature))
174
175 #ifndef MODULE
176 /*
177  * Function : dtc_setup(char *str, int *ints)
178  *
179  * Purpose : LILO command line initialization of the overrides array,
180  * 
181  * Inputs : str - unused, ints - array of integer parameters with ints[0]
182  *      equal to the number of ints.
183  *
184 */
185
186 static void __init dtc_setup(char *str, int *ints)
187 {
188         static int commandline_current = 0;
189         int i;
190         if (ints[0] != 2)
191                 printk("dtc_setup: usage dtc=address,irq\n");
192         else if (commandline_current < NO_OVERRIDES) {
193                 overrides[commandline_current].address = ints[1];
194                 overrides[commandline_current].irq = ints[2];
195                 for (i = 0; i < NO_BASES; ++i)
196                         if (bases[i].address == ints[1]) {
197                                 bases[i].noauto = 1;
198                                 break;
199                         }
200                 ++commandline_current;
201         }
202 }
203 #endif
204
205 /* 
206  * Function : int dtc_detect(Scsi_Host_Template * tpnt)
207  *
208  * Purpose : detects and initializes DTC 3180/3280 controllers
209  *      that were autoprobed, overridden on the LILO command line, 
210  *      or specified at compile time.
211  *
212  * Inputs : tpnt - template for this SCSI adapter.
213  * 
214  * Returns : 1 if a host adapter was found, 0 if not.
215  *
216 */
217
218 static int __init dtc_detect(Scsi_Host_Template * tpnt)
219 {
220         static int current_override = 0, current_base = 0;
221         struct Scsi_Host *instance;
222         unsigned int base;
223         int sig, count;
224
225         tpnt->proc_name = "dtc3x80";
226         tpnt->proc_info = &dtc_proc_info;
227
228         for (count = 0; current_override < NO_OVERRIDES; ++current_override) {
229                 base = 0;
230
231                 if (overrides[current_override].address)
232                         base = overrides[current_override].address;
233                 else
234                         for (; !base && (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                                 for (sig = 0; sig < NO_SIGNATURES; ++sig)
239                                         if (!bases[current_base].noauto && isa_check_signature(bases[current_base].address + signatures[sig].offset, signatures[sig].string, strlen(signatures[sig].string))) {
240                                                 base = bases[current_base].address;
241 #if (DTCDEBUG & DTCDEBUG_INIT)
242                                                 printk("scsi-dtc : detected board.\n");
243 #endif
244                                                 break;
245                                         }
246                         }
247
248 #if defined(DTCDEBUG) && (DTCDEBUG & DTCDEBUG_INIT)
249                 printk("scsi-dtc : base = %08x\n", base);
250 #endif
251
252                 if (!base)
253                         break;
254
255                 instance = scsi_register(tpnt, sizeof(struct NCR5380_hostdata));
256                 if (instance == NULL)
257                         break;
258
259                 instance->base = base;
260
261                 NCR5380_init(instance, 0);
262
263                 NCR5380_write(DTC_CONTROL_REG, CSR_5380_INTR);  /* Enable int's */
264                 if (overrides[current_override].irq != IRQ_AUTO)
265                         instance->irq = overrides[current_override].irq;
266                 else
267                         instance->irq = NCR5380_probe_irq(instance, DTC_IRQS);
268
269 #ifndef DONT_USE_INTR
270                 /* With interrupts enabled, it will sometimes hang when doing heavy
271                  * reads. So better not enable them until I finger it out. */
272                 if (instance->irq != SCSI_IRQ_NONE)
273                         if (request_irq(instance->irq, dtc_intr, SA_INTERRUPT, "dtc", instance)) {
274                                 printk(KERN_ERR "scsi%d : IRQ%d not free, interrupts disabled\n", instance->host_no, instance->irq);
275                                 instance->irq = SCSI_IRQ_NONE;
276                         }
277
278                 if (instance->irq == SCSI_IRQ_NONE) {
279                         printk(KERN_WARNING "scsi%d : interrupts not enabled. for better interactive performance,\n", instance->host_no);
280                         printk(KERN_WARNING "scsi%d : please jumper the board for a free IRQ.\n", instance->host_no);
281                 }
282 #else
283                 if (instance->irq != SCSI_IRQ_NONE)
284                         printk(KERN_WARNING "scsi%d : interrupts not used. Might as well not jumper it.\n", instance->host_no);
285                 instance->irq = SCSI_IRQ_NONE;
286 #endif
287 #if defined(DTCDEBUG) && (DTCDEBUG & DTCDEBUG_INIT)
288                 printk("scsi%d : irq = %d\n", instance->host_no, instance->irq);
289 #endif
290
291                 printk(KERN_INFO "scsi%d : at 0x%05X", instance->host_no, (int) instance->base);
292                 if (instance->irq == SCSI_IRQ_NONE)
293                         printk(" interrupts disabled");
294                 else
295                         printk(" irq %d", instance->irq);
296                 printk(" options CAN_QUEUE=%d  CMD_PER_LUN=%d release=%d", CAN_QUEUE, CMD_PER_LUN, DTC_PUBLIC_RELEASE);
297                 NCR5380_print_options(instance);
298                 printk("\n");
299
300                 ++current_override;
301                 ++count;
302         }
303         return count;
304 }
305
306 /*
307  * Function : int dtc_biosparam(Disk * disk, struct block_device *dev, int *ip)
308  *
309  * Purpose : Generates a BIOS / DOS compatible H-C-S mapping for 
310  *      the specified device / size.
311  * 
312  * Inputs : size = size of device in sectors (512 bytes), dev = block device
313  *      major / minor, ip[] = {heads, sectors, cylinders}  
314  *
315  * Returns : always 0 (success), initializes ip
316  *      
317 */
318
319 /* 
320  * XXX Most SCSI boards use this mapping, I could be incorrect.  Some one
321  * using hard disks on a trantor should verify that this mapping corresponds
322  * to that used by the BIOS / ASPI driver by running the linux fdisk program
323  * and matching the H_C_S coordinates to what DOS uses.
324 */
325
326 static int dtc_biosparam(struct scsi_device *sdev, struct block_device *dev,
327                          sector_t capacity, int *ip)
328 {
329         int size = capacity;
330
331         ip[0] = 64;
332         ip[1] = 32;
333         ip[2] = size >> 11;
334         return 0;
335 }
336
337
338 /****************************************************************
339  * Function : int NCR5380_pread (struct Scsi_Host *instance, 
340  *      unsigned char *dst, int len)
341  *
342  * Purpose : Fast 5380 pseudo-dma read function, reads len bytes to 
343  *      dst
344  * 
345  * Inputs : dst = destination, len = length in bytes
346  *
347  * Returns : 0 on success, non zero on a failure such as a watchdog 
348  *      timeout.
349 */
350
351 static int dtc_maxi = 0;
352 static int dtc_wmaxi = 0;
353
354 static inline int NCR5380_pread(struct Scsi_Host *instance, unsigned char *dst, int len)
355 {
356         unsigned char *d = dst;
357         int i;                  /* For counting time spent in the poll-loop */
358         NCR5380_local_declare();
359         NCR5380_setup(instance);
360
361         i = 0;
362         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
363         NCR5380_write(MODE_REG, MR_ENABLE_EOP_INTR | MR_DMA_MODE);
364         if (instance->irq == SCSI_IRQ_NONE)
365                 NCR5380_write(DTC_CONTROL_REG, CSR_DIR_READ);
366         else
367                 NCR5380_write(DTC_CONTROL_REG, CSR_DIR_READ | CSR_INT_BASE);
368         NCR5380_write(DTC_BLK_CNT, len >> 7);   /* Block count */
369         rtrc(1);
370         while (len > 0) {
371                 rtrc(2);
372                 while (NCR5380_read(DTC_CONTROL_REG) & CSR_HOST_BUF_NOT_RDY)
373                         ++i;
374                 rtrc(3);
375                 isa_memcpy_fromio(d, base + DTC_DATA_BUF, 128);
376                 d += 128;
377                 len -= 128;
378                 rtrc(7);
379                 /*** with int's on, it sometimes hangs after here.
380                  * Looks like something makes HBNR go away. */
381         }
382         rtrc(4);
383         while (!(NCR5380_read(DTC_CONTROL_REG) & D_CR_ACCESS))
384                 ++i;
385         NCR5380_write(MODE_REG, 0);     /* Clear the operating mode */
386         rtrc(0);
387         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
388         if (i > dtc_maxi)
389                 dtc_maxi = i;
390         return (0);
391 }
392
393 /****************************************************************
394  * Function : int NCR5380_pwrite (struct Scsi_Host *instance, 
395  *      unsigned char *src, int len)
396  *
397  * Purpose : Fast 5380 pseudo-dma write function, transfers len bytes from
398  *      src
399  * 
400  * Inputs : src = source, len = length in bytes
401  *
402  * Returns : 0 on success, non zero on a failure such as a watchdog 
403  *      timeout.
404 */
405
406 static inline int NCR5380_pwrite(struct Scsi_Host *instance, unsigned char *src, int len)
407 {
408         int i;
409         NCR5380_local_declare();
410         NCR5380_setup(instance);
411
412         NCR5380_read(RESET_PARITY_INTERRUPT_REG);
413         NCR5380_write(MODE_REG, MR_ENABLE_EOP_INTR | MR_DMA_MODE);
414         /* set direction (write) */
415         if (instance->irq == SCSI_IRQ_NONE)
416                 NCR5380_write(DTC_CONTROL_REG, 0);
417         else
418                 NCR5380_write(DTC_CONTROL_REG, CSR_5380_INTR);
419         NCR5380_write(DTC_BLK_CNT, len >> 7);   /* Block count */
420         for (i = 0; len > 0; ++i) {
421                 rtrc(5);
422                 /* Poll until the host buffer can accept data. */
423                 while (NCR5380_read(DTC_CONTROL_REG) & CSR_HOST_BUF_NOT_RDY)
424                         ++i;
425                 rtrc(3);
426                 isa_memcpy_toio(base + DTC_DATA_BUF, src, 128);
427                 src += 128;
428                 len -= 128;
429         }
430         rtrc(4);
431         while (!(NCR5380_read(DTC_CONTROL_REG) & D_CR_ACCESS))
432                 ++i;
433         rtrc(6);
434         /* Wait until the last byte has been sent to the disk */
435         while (!(NCR5380_read(TARGET_COMMAND_REG) & TCR_LAST_BYTE_SENT))
436                 ++i;
437         rtrc(7);
438         /* Check for parity error here. fixme. */
439         NCR5380_write(MODE_REG, 0);     /* Clear the operating mode */
440         rtrc(0);
441         if (i > dtc_wmaxi)
442                 dtc_wmaxi = i;
443         return (0);
444 }
445
446 MODULE_LICENSE("GPL");
447
448 #include "NCR5380.c"
449
450 static int dtc_release(struct Scsi_Host *shost)
451 {
452         if (shost->irq)
453                 free_irq(shost->irq, NULL);
454         if (shost->io_port && shost->n_io_port)
455                 release_region(shost->io_port, shost->n_io_port);
456         scsi_unregister(shost);
457         return 0;
458 }
459
460 static Scsi_Host_Template driver_template = {
461         .name                           = "DTC 3180/3280 ",
462         .detect                         = dtc_detect,
463         .release                        = dtc_release,
464         .queuecommand                   = dtc_queue_command,
465         .eh_abort_handler               = dtc_abort,
466         .eh_bus_reset_handler           = dtc_bus_reset,
467         .eh_device_reset_handler        = dtc_device_reset,
468         .eh_host_reset_handler          = dtc_host_reset,
469         .bios_param                     = dtc_biosparam,
470         .can_queue                      = CAN_QUEUE,
471         .this_id                        = 7,
472         .sg_tablesize                   = SG_ALL,
473         .cmd_per_lun                    = CMD_PER_LUN,
474         .use_clustering                 = DISABLE_CLUSTERING,
475 };
476 #include "scsi_module.c"