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