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