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