Merge tag 'sound-4.9-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[cascardo/linux.git] / drivers / scsi / t128.c
1 /*
2  * Trantor T128/T128F/T228 driver
3  *      Note : architecturally, the T100 and T130 are different and won't 
4  *      work
5  *
6  * Copyright 1993, Drew Eckhardt
7  *      Visionary Computing
8  *      (Unix and Linux consulting and custom programming)
9  *      drew@colorado.edu
10  *      +1 (303) 440-4894
11  *
12  * For more information, please consult 
13  *
14  * Trantor Systems, Ltd.
15  * T128/T128F/T228 SCSI Host Adapter
16  * Hardware Specifications
17  * 
18  * Trantor Systems, Ltd. 
19  * 5415 Randall Place
20  * Fremont, CA 94538
21  * 1+ (415) 770-1400, FAX 1+ (415) 770-9910
22  */
23
24 /*
25  * The card is detected and initialized in one of several ways : 
26  * 1.  Autoprobe (default) - since the board is memory mapped, 
27  *     a BIOS signature is scanned for to locate the registers.
28  *     An interrupt is triggered to autoprobe for the interrupt
29  *     line.
30  *
31  * 2.  With command line overrides - t128=address,irq may be 
32  *     used on the LILO command line to override the defaults.
33  *
34  * 3.  With the T128_OVERRIDE compile time define.  This is 
35  *     specified as an array of address, irq tuples.  Ie, for
36  *     one board at the default 0xcc000 address, IRQ5, I could say 
37  *     -DT128_OVERRIDE={{0xcc000, 5}}
38  *      
39  *     Note that if the override methods are used, place holders must
40  *     be specified for other boards in the system.
41  * 
42  * T128/T128F jumper/dipswitch settings (note : on my sample, the switches 
43  * were epoxy'd shut, meaning I couldn't change the 0xcc000 base address) :
44  *
45  * T128    Sw7 Sw8 Sw6 = 0ws Sw5 = boot 
46  * T128F   Sw6 Sw7 Sw5 = 0ws Sw4 = boot Sw8 = floppy disable
47  * cc000   off off      
48  * c8000   off on
49  * dc000   on  off
50  * d8000   on  on
51  *
52  * 
53  * Interrupts 
54  * There is a 12 pin jumper block, jp1, numbered as follows : 
55  *   T128 (JP1)          T128F (J5)
56  * 2 4 6 8 10 12        11 9  7 5 3 1
57  * 1 3 5 7 9  11        12 10 8 6 4 2
58  *
59  * 3   2-4
60  * 5   1-3
61  * 7   3-5
62  * T128F only 
63  * 10 8-10
64  * 12 7-9
65  * 14 10-12
66  * 15 9-11
67  */
68  
69 #include <linux/io.h>
70 #include <linux/blkdev.h>
71 #include <linux/interrupt.h>
72 #include <linux/init.h>
73 #include <linux/module.h>
74
75 #include <scsi/scsi_host.h>
76 #include "t128.h"
77 #include "NCR5380.h"
78
79 static struct override {
80     unsigned long address;
81     int irq;
82 } overrides
83 #ifdef T128_OVERRIDE
84     [] __initdata = T128_OVERRIDE;
85 #else
86     [4] __initdata = {{0, IRQ_AUTO}, {0, IRQ_AUTO},
87         {0 ,IRQ_AUTO}, {0, IRQ_AUTO}};
88 #endif
89
90 #define NO_OVERRIDES ARRAY_SIZE(overrides)
91
92 static struct base {
93     unsigned int address;
94     int noauto;
95 } bases[] __initdata = {
96     { 0xcc000, 0}, { 0xc8000, 0}, { 0xdc000, 0}, { 0xd8000, 0}
97 };
98
99 #define NO_BASES ARRAY_SIZE(bases)
100
101 static struct signature {
102     const char *string;
103     int offset;
104 } signatures[] __initdata = {
105 {"TSROM: SCSI BIOS, Version 1.12", 0x36},
106 };
107
108 #define NO_SIGNATURES ARRAY_SIZE(signatures)
109
110 #ifndef MODULE
111 /*
112  * Function : t128_setup(char *str, int *ints)
113  *
114  * Purpose : LILO command line initialization of the overrides array,
115  * 
116  * Inputs : str - unused, ints - array of integer parameters with ints[0]
117  *      equal to the number of ints.
118  *
119  */
120
121 static int __init t128_setup(char *str)
122 {
123         static int commandline_current;
124     int i;
125     int ints[10];
126
127     get_options(str, ARRAY_SIZE(ints), ints);
128     if (ints[0] != 2) 
129         printk("t128_setup : usage t128=address,irq\n");
130     else 
131         if (commandline_current < NO_OVERRIDES) {
132             overrides[commandline_current].address = ints[1];
133             overrides[commandline_current].irq = ints[2];
134             for (i = 0; i < NO_BASES; ++i)
135                 if (bases[i].address == ints[1]) {
136                     bases[i].noauto = 1;
137                     break;
138                 }
139             ++commandline_current;
140         }
141     return 1;
142 }
143
144 __setup("t128=", t128_setup);
145 #endif
146
147 /* 
148  * Function : int t128_detect(struct scsi_host_template * tpnt)
149  *
150  * Purpose : detects and initializes T128,T128F, or T228 controllers
151  *      that were autoprobed, overridden on the LILO command line, 
152  *      or specified at compile time.
153  *
154  * Inputs : tpnt - template for this SCSI adapter.
155  * 
156  * Returns : 1 if a host adapter was found, 0 if not.
157  *
158  */
159
160 static int __init t128_detect(struct scsi_host_template *tpnt)
161 {
162         static int current_override, current_base;
163     struct Scsi_Host *instance;
164     unsigned long base;
165     void __iomem *p;
166     int sig, count;
167
168     for (count = 0; current_override < NO_OVERRIDES; ++current_override) {
169         base = 0;
170         p = NULL;
171
172         if (overrides[current_override].address) {
173             base = overrides[current_override].address;
174             p = ioremap(bases[current_base].address, 0x2000);
175             if (!p)
176                 base = 0;
177         } else 
178             for (; !base && (current_base < NO_BASES); ++current_base) {
179                 dprintk(NDEBUG_INIT, "t128: probing address 0x%08x\n",
180                         bases[current_base].address);
181                 if (bases[current_base].noauto)
182                         continue;
183                 p = ioremap(bases[current_base].address, 0x2000);
184                 if (!p)
185                         continue;
186                 for (sig = 0; sig < NO_SIGNATURES; ++sig) 
187                     if (check_signature(p + signatures[sig].offset,
188                                         signatures[sig].string,
189                                         strlen(signatures[sig].string))) {
190                         base = bases[current_base].address;
191                         dprintk(NDEBUG_INIT, "t128: detected board\n");
192                         goto found;
193                     }
194                 iounmap(p);
195             }
196
197         dprintk(NDEBUG_INIT, "t128: base = 0x%08x\n", (unsigned int)base);
198
199         if (!base)
200             break;
201
202 found:
203         instance = scsi_register (tpnt, sizeof(struct NCR5380_hostdata));
204         if(instance == NULL)
205                 goto out_unmap;
206
207         instance->base = base;
208         ((struct NCR5380_hostdata *)instance->hostdata)->base = p;
209
210         if (NCR5380_init(instance, FLAG_DMA_FIXUP | FLAG_LATE_DMA_SETUP))
211                 goto out_unregister;
212
213         NCR5380_maybe_reset_bus(instance);
214
215         if (overrides[current_override].irq != IRQ_AUTO)
216             instance->irq = overrides[current_override].irq;
217         else 
218             instance->irq = NCR5380_probe_irq(instance, T128_IRQS);
219
220         /* Compatibility with documented NCR5380 kernel parameters */
221         if (instance->irq == 255)
222                 instance->irq = NO_IRQ;
223
224         if (instance->irq != NO_IRQ)
225             if (request_irq(instance->irq, t128_intr, 0, "t128",
226                             instance)) {
227                 printk("scsi%d : IRQ%d not free, interrupts disabled\n", 
228                     instance->host_no, instance->irq);
229                 instance->irq = NO_IRQ;
230             } 
231
232         if (instance->irq == NO_IRQ) {
233             printk("scsi%d : interrupts not enabled. for better interactive performance,\n", instance->host_no);
234             printk("scsi%d : please jumper the board for a free IRQ.\n", instance->host_no);
235         }
236
237         dprintk(NDEBUG_INIT, "scsi%d: irq = %d\n",
238                 instance->host_no, instance->irq);
239
240         ++current_override;
241         ++count;
242     }
243     return count;
244
245 out_unregister:
246         scsi_unregister(instance);
247 out_unmap:
248         iounmap(p);
249         return count;
250 }
251
252 static int t128_release(struct Scsi_Host *shost)
253 {
254         struct NCR5380_hostdata *hostdata = shost_priv(shost);
255
256         if (shost->irq != NO_IRQ)
257                 free_irq(shost->irq, shost);
258         NCR5380_exit(shost);
259         scsi_unregister(shost);
260         iounmap(hostdata->base);
261         return 0;
262 }
263
264 /*
265  * Function : int t128_biosparam(Disk * disk, struct block_device *dev, int *ip)
266  *
267  * Purpose : Generates a BIOS / DOS compatible H-C-S mapping for 
268  *      the specified device / size.
269  * 
270  * Inputs : size = size of device in sectors (512 bytes), dev = block device
271  *      major / minor, ip[] = {heads, sectors, cylinders}  
272  *
273  * Returns : always 0 (success), initializes ip
274  *      
275  */
276
277 /* 
278  * XXX Most SCSI boards use this mapping, I could be incorrect.  Some one
279  * using hard disks on a trantor should verify that this mapping corresponds
280  * to that used by the BIOS / ASPI driver by running the linux fdisk program
281  * and matching the H_C_S coordinates to what DOS uses.
282  */
283
284 static int t128_biosparam(struct scsi_device *sdev, struct block_device *bdev,
285                           sector_t capacity, int *ip)
286 {
287   ip[0] = 64;
288   ip[1] = 32;
289   ip[2] = capacity >> 11;
290   return 0;
291 }
292
293 /*
294  * Function : int t128_pread (struct Scsi_Host *instance,
295  *      unsigned char *dst, int len)
296  *
297  * Purpose : Fast 5380 pseudo-dma read function, transfers len bytes to 
298  *      dst
299  * 
300  * Inputs : dst = destination, len = length in bytes
301  *
302  * Returns : 0 on success, non zero on a failure such as a watchdog 
303  *      timeout.
304  */
305
306 static inline int t128_pread(struct Scsi_Host *instance,
307                              unsigned char *dst, int len)
308 {
309         struct NCR5380_hostdata *hostdata = shost_priv(instance);
310         void __iomem *reg, *base = hostdata->base;
311     unsigned char *d = dst;
312     register int i = len;
313
314     reg = base + T_DATA_REG_OFFSET;
315
316 #if 0
317     for (; i; --i) {
318         while (!(readb(base+T_STATUS_REG_OFFSET) & T_ST_RDY)) barrier();
319 #else
320     while (!(readb(base+T_STATUS_REG_OFFSET) & T_ST_RDY)) barrier();
321     for (; i; --i) {
322 #endif
323         *d++ = readb(reg);
324     }
325
326     if (readb(base + T_STATUS_REG_OFFSET) & T_ST_TIM) {
327         unsigned char tmp;
328         void __iomem *foo = base + T_CONTROL_REG_OFFSET;
329         tmp = readb(foo);
330         writeb(tmp | T_CR_CT, foo);
331         writeb(tmp, foo);
332         printk("scsi%d : watchdog timer fired in NCR5380_pread()\n",
333             instance->host_no);
334         return -1;
335     } else
336         return 0;
337 }
338
339 /*
340  * Function : int t128_pwrite (struct Scsi_Host *instance,
341  *      unsigned char *src, int len)
342  *
343  * Purpose : Fast 5380 pseudo-dma write function, transfers len bytes from
344  *      src
345  * 
346  * Inputs : src = source, len = length in bytes
347  *
348  * Returns : 0 on success, non zero on a failure such as a watchdog 
349  *      timeout.
350  */
351
352 static inline int t128_pwrite(struct Scsi_Host *instance,
353                               unsigned char *src, int len)
354 {
355         struct NCR5380_hostdata *hostdata = shost_priv(instance);
356         void __iomem *reg, *base = hostdata->base;
357     unsigned char *s = src;
358     register int i = len;
359
360     reg = base + T_DATA_REG_OFFSET;
361
362 #if 0
363     for (; i; --i) {
364         while (!(readb(base+T_STATUS_REG_OFFSET) & T_ST_RDY)) barrier();
365 #else
366     while (!(readb(base+T_STATUS_REG_OFFSET) & T_ST_RDY)) barrier();
367     for (; i; --i) {
368 #endif
369         writeb(*s++, reg);
370     }
371
372     if (readb(base + T_STATUS_REG_OFFSET) & T_ST_TIM) {
373         unsigned char tmp;
374         void __iomem *foo = base + T_CONTROL_REG_OFFSET;
375         tmp = readb(foo);
376         writeb(tmp | T_CR_CT, foo);
377         writeb(tmp, foo);
378         printk("scsi%d : watchdog timer fired in NCR5380_pwrite()\n",
379             instance->host_no);
380         return -1;
381     } else 
382         return 0;
383 }
384
385 MODULE_LICENSE("GPL");
386
387 #include "NCR5380.c"
388
389 static struct scsi_host_template driver_template = {
390         .name                   = "Trantor T128/T128F/T228",
391         .detect                 = t128_detect,
392         .release                = t128_release,
393         .proc_name              = "t128",
394         .info                   = t128_info,
395         .queuecommand           = t128_queue_command,
396         .eh_abort_handler       = t128_abort,
397         .eh_bus_reset_handler   = t128_bus_reset,
398         .bios_param             = t128_biosparam,
399         .can_queue              = 32,
400         .this_id                = 7,
401         .sg_tablesize           = SG_ALL,
402         .cmd_per_lun            = 2,
403         .use_clustering         = DISABLE_CLUSTERING,
404         .cmd_size               = NCR5380_CMD_SIZE,
405         .max_sectors            = 128,
406 };
407 #include "scsi_module.c"