[SCSI] SCSI megaraid_sas: handle thrown errors
[linux-2.6] / drivers / scsi / ultrastor.c
1 /*
2  *      ultrastor.c     Copyright (C) 1992 David B. Gentzel
3  *      Low-level SCSI driver for UltraStor 14F, 24F, and 34F
4  *      by David B. Gentzel, Whitfield Software Services, Carnegie, PA
5  *          (gentzel@nova.enet.dec.com)
6  *  scatter/gather added by Scott Taylor (n217cg@tamuts.tamu.edu)
7  *  24F and multiple command support by John F. Carr (jfc@athena.mit.edu)
8  *    John's work modified by Caleb Epstein (cae@jpmorgan.com) and 
9  *    Eric Youngdale (ericy@cais.com).
10  *      Thanks to UltraStor for providing the necessary documentation
11  *
12  *  This is an old driver, for the 14F and 34F you should be using the
13  *  u14-34f driver instead.
14  */
15
16 /*
17  * TODO:
18  *      1. Find out why scatter/gather is limited to 16 requests per command.
19  *         This is fixed, at least on the 24F, as of version 1.12 - CAE.
20  *      2. Look at command linking (mscp.command_link and
21  *         mscp.command_link_id).  (Does not work with many disks, 
22  *                              and no performance increase.  ERY).
23  *      3. Allow multiple adapters.
24  */
25
26 /*
27  * NOTES:
28  *    The UltraStor 14F, 24F, and 34F are a family of intelligent, high
29  *    performance SCSI-2 host adapters.  They all support command queueing
30  *    and scatter/gather I/O.  Some of them can also emulate the standard
31  *    WD1003 interface for use with OS's which don't support SCSI.  Here
32  *    is the scoop on the various models:
33  *      14F - ISA first-party DMA HA with floppy support and WD1003 emulation.
34  *      14N - ISA HA with floppy support.  I think that this is a non-DMA
35  *            HA.  Nothing further known.
36  *      24F - EISA Bus Master HA with floppy support and WD1003 emulation.
37  *      34F - VL-Bus Bus Master HA with floppy support (no WD1003 emulation).
38  *
39  *    The 14F, 24F, and 34F are supported by this driver.
40  *
41  *    Places flagged with a triple question-mark are things which are either
42  *    unfinished, questionable, or wrong.
43  */
44
45 /* Changes from version 1.11 alpha to 1.12
46  *
47  * Increased the size of the scatter-gather list to 33 entries for
48  * the 24F adapter (it was 16).  I don't have the specs for the 14F
49  * or the 34F, so they may support larger s-g lists as well.
50  *
51  * Caleb Epstein <cae@jpmorgan.com>
52  */
53
54 /* Changes from version 1.9 to 1.11
55  *
56  * Patches to bring this driver up to speed with the default kernel
57  * driver which supports only the 14F and 34F adapters.  This version
58  * should compile cleanly into 0.99.13, 0.99.12 and probably 0.99.11.
59  *
60  * Fixes from Eric Youngdale to fix a few possible race conditions and
61  * several problems with bit testing operations (insufficient
62  * parentheses).
63  *
64  * Removed the ultrastor_abort() and ultrastor_reset() functions
65  * (enclosed them in #if 0 / #endif).  These functions, at least on
66  * the 24F, cause the SCSI bus to do odd things and generally lead to
67  * kernel panics and machine hangs.  This is like the Adaptec code.
68  *
69  * Use check/snarf_region for 14f, 34f to avoid I/O space address conflicts.
70  */
71
72 /* Changes from version 1.8 to version 1.9
73  *
74  *  0.99.11 patches (cae@jpmorgan.com) */
75
76 /* Changes from version 1.7 to version 1.8
77  *
78  * Better error reporting.
79  */
80
81 /* Changes from version 1.6 to version 1.7
82  *
83  * Removed CSIR command code.
84  *
85  * Better race condition avoidance (xchgb function added).
86  *
87  * Set ICM and OGM status to zero at probe (24F)
88  *
89  * reset sends soft reset to UltraStor adapter
90  *
91  * reset adapter if adapter interrupts with an invalid MSCP address
92  *
93  * handle aborted command interrupt (24F)
94  *
95  */
96
97 /* Changes from version 1.5 to version 1.6:
98  *
99  * Read MSCP address from ICM _before_ clearing the interrupt flag.
100  * This fixes a race condition.
101  */
102
103 /* Changes from version 1.4 to version 1.5:
104  *
105  * Abort now calls done when multiple commands are enabled.
106  *
107  * Clear busy when aborted command finishes, not when abort is called.
108  *
109  * More debugging messages for aborts.
110  */
111
112 /* Changes from version 1.3 to version 1.4:
113  *
114  * Enable automatic request of sense data on error (requires newer version
115  * of scsi.c to be useful).
116  *
117  * Fix PORT_OVERRIDE for 14F.
118  *
119  * Fix abort and reset to work properly (config.aborted wasn't cleared
120  * after it was tested, so after a command abort no further commands would
121  * work).
122  *
123  * Boot time test to enable SCSI bus reset (defaults to not allowing reset).
124  *
125  * Fix test for OGM busy -- the busy bit is in different places on the 24F.
126  *
127  * Release ICM slot by clearing first byte on 24F.
128  */
129
130 #include <linux/module.h>
131 #include <linux/blkdev.h>
132 #include <linux/interrupt.h>
133 #include <linux/stddef.h>
134 #include <linux/string.h>
135 #include <linux/kernel.h>
136 #include <linux/ioport.h>
137 #include <linux/proc_fs.h>
138 #include <linux/spinlock.h>
139 #include <linux/stat.h>
140 #include <linux/bitops.h>
141
142 #include <asm/io.h>
143 #include <asm/system.h>
144 #include <asm/dma.h>
145
146 #define ULTRASTOR_PRIVATE       /* Get the private stuff from ultrastor.h */
147 #include "scsi.h"
148 #include <scsi/scsi_host.h>
149 #include "ultrastor.h"
150
151 #define FALSE 0
152 #define TRUE 1
153
154 #ifndef ULTRASTOR_DEBUG
155 #define ULTRASTOR_DEBUG (UD_ABORT|UD_CSIR|UD_RESET)
156 #endif
157
158 #define VERSION "1.12"
159
160 #define PACKED          __attribute__((packed))
161 #define ALIGNED(x)      __attribute__((aligned(x)))
162
163
164 /* The 14F uses an array of 4-byte ints for its scatter/gather list.
165    The data can be unaligned, but need not be.  It's easier to give
166    the list normal alignment since it doesn't need to fit into a
167    packed structure.  */
168
169 typedef struct {
170   u32 address;
171   u32 num_bytes;
172 } ultrastor_sg_list;
173
174
175 /* MailBox SCSI Command Packet.  Basic command structure for communicating
176    with controller. */
177 struct mscp {
178   unsigned char opcode: 3;              /* type of command */
179   unsigned char xdir: 2;                /* data transfer direction */
180   unsigned char dcn: 1;         /* disable disconnect */
181   unsigned char ca: 1;          /* use cache (if available) */
182   unsigned char sg: 1;          /* scatter/gather operation */
183   unsigned char target_id: 3;           /* target SCSI id */
184   unsigned char ch_no: 2;               /* SCSI channel (always 0 for 14f) */
185   unsigned char lun: 3;         /* logical unit number */
186   unsigned int transfer_data PACKED;    /* transfer data pointer */
187   unsigned int transfer_data_length PACKED;     /* length in bytes */
188   unsigned int command_link PACKED;     /* for linking command chains */
189   unsigned char scsi_command_link_id;   /* identifies command in chain */
190   unsigned char number_of_sg_list;      /* (if sg is set) 8 bytes per list */
191   unsigned char length_of_sense_byte;
192   unsigned char length_of_scsi_cdbs;    /* 6, 10, or 12 */
193   unsigned char scsi_cdbs[12];  /* SCSI commands */
194   unsigned char adapter_status; /* non-zero indicates HA error */
195   unsigned char target_status;  /* non-zero indicates target error */
196   u32 sense_data PACKED;
197   /* The following fields are for software only.  They are included in
198      the MSCP structure because they are associated with SCSI requests.  */
199   void (*done) (struct scsi_cmnd *);
200   struct scsi_cmnd *SCint;
201   ultrastor_sg_list sglist[ULTRASTOR_24F_MAX_SG]; /* use larger size for 24F */
202 };
203
204
205 /* Port addresses (relative to the base address) */
206 #define U14F_PRODUCT_ID(port) ((port) + 0x4)
207 #define CONFIG(port) ((port) + 0x6)
208
209 /* Port addresses relative to the doorbell base address.  */
210 #define LCL_DOORBELL_MASK(port) ((port) + 0x0)
211 #define LCL_DOORBELL_INTR(port) ((port) + 0x1)
212 #define SYS_DOORBELL_MASK(port) ((port) + 0x2)
213 #define SYS_DOORBELL_INTR(port) ((port) + 0x3)
214
215
216 /* Used to store configuration info read from config i/o registers.  Most of
217    this is not used yet, but might as well save it.
218    
219    This structure also holds port addresses that are not at the same offset
220    on the 14F and 24F.
221    
222    This structure holds all data that must be duplicated to support multiple
223    adapters.  */
224
225 static struct ultrastor_config
226 {
227   unsigned short port_address;          /* base address of card */
228   unsigned short doorbell_address;      /* base address of doorbell CSRs */
229   unsigned short ogm_address;           /* base address of OGM */
230   unsigned short icm_address;           /* base address of ICM */
231   const void *bios_segment;
232   unsigned char interrupt: 4;
233   unsigned char dma_channel: 3;
234   unsigned char bios_drive_number: 1;
235   unsigned char heads;
236   unsigned char sectors;
237   unsigned char ha_scsi_id: 3;
238   unsigned char subversion: 4;
239   unsigned char revision;
240   /* The slot number is used to distinguish the 24F (slot != 0) from
241      the 14F and 34F (slot == 0). */
242   unsigned char slot;
243
244 #ifdef PRINT_U24F_VERSION
245   volatile int csir_done;
246 #endif
247
248   /* A pool of MSCP structures for this adapter, and a bitmask of
249      busy structures.  (If ULTRASTOR_14F_MAX_CMDS == 1, a 1 byte
250      busy flag is used instead.)  */
251
252 #if ULTRASTOR_MAX_CMDS == 1
253   unsigned char mscp_busy;
254 #else
255   unsigned long mscp_free;
256 #endif
257   volatile unsigned char aborted[ULTRASTOR_MAX_CMDS];
258   struct mscp mscp[ULTRASTOR_MAX_CMDS];
259 } config = {0};
260
261 /* Set this to 1 to reset the SCSI bus on error.  */
262 static int ultrastor_bus_reset;
263
264
265 /* Allowed BIOS base addresses (NULL indicates reserved) */
266 static const void *const bios_segment_table[8] = {
267   NULL,      (void *)0xC4000, (void *)0xC8000, (void *)0xCC000,
268   (void *)0xD0000, (void *)0xD4000, (void *)0xD8000, (void *)0xDC000,
269 };
270
271 /* Allowed IRQs for 14f */
272 static const unsigned char interrupt_table_14f[4] = { 15, 14, 11, 10 };
273
274 /* Allowed DMA channels for 14f (0 indicates reserved) */
275 static const unsigned char dma_channel_table_14f[4] = { 5, 6, 7, 0 };
276
277 /* Head/sector mappings allowed by 14f */
278 static const struct {
279   unsigned char heads;
280   unsigned char sectors;
281 } mapping_table[4] = { { 16, 63 }, { 64, 32 }, { 64, 63 }, { 64, 32 } };
282
283 #ifndef PORT_OVERRIDE
284 /* ??? A probe of address 0x310 screws up NE2000 cards */
285 static const unsigned short ultrastor_ports_14f[] = {
286   0x330, 0x340, /*0x310,*/ 0x230, 0x240, 0x210, 0x130, 0x140,
287 };
288 #endif
289
290 static void ultrastor_interrupt(int, void *, struct pt_regs *);
291 static irqreturn_t do_ultrastor_interrupt(int, void *, struct pt_regs *);
292 static inline void build_sg_list(struct mscp *, struct scsi_cmnd *SCpnt);
293
294
295 /* Always called with host lock held */
296
297 static inline int find_and_clear_bit_16(unsigned long *field)
298 {
299   int rv;
300
301   if (*field == 0) panic("No free mscp");
302   asm("xorl %0,%0\n0:\tbsfw %1,%w0\n\tbtr %0,%1\n\tjnc 0b"
303       : "=&r" (rv), "=m" (*field) : "1" (*field));
304   return rv;
305 }
306
307 /* This has been re-implemented with the help of Richard Earnshaw,
308    <rwe@pegasus.esprit.ec.org> and works with gcc-2.5.8 and gcc-2.6.0.
309    The instability noted by jfc below appears to be a bug in
310    gcc-2.5.x when compiling w/o optimization.  --Caleb
311
312    This asm is fragile: it doesn't work without the casts and it may
313    not work without optimization.  Maybe I should add a swap builtin
314    to gcc.  --jfc  */
315 static inline unsigned char xchgb(unsigned char reg,
316                                   volatile unsigned char *mem)
317 {
318   __asm__ ("xchgb %0,%1" : "=q" (reg), "=m" (*mem) : "0" (reg));
319   return reg;
320 }
321
322 #if ULTRASTOR_DEBUG & (UD_COMMAND | UD_ABORT)
323
324 /* Always called with the host lock held */
325 static void log_ultrastor_abort(struct ultrastor_config *config,
326                                 int command)
327 {
328   static char fmt[80] = "abort %d (%x); MSCP free pool: %x;";
329   int i;
330
331   for (i = 0; i < ULTRASTOR_MAX_CMDS; i++)
332     {
333       fmt[20 + i*2] = ' ';
334       if (! (config->mscp_free & (1 << i)))
335         fmt[21 + i*2] = '0' + config->mscp[i].target_id;
336       else
337         fmt[21 + i*2] = '-';
338     }
339   fmt[20 + ULTRASTOR_MAX_CMDS * 2] = '\n';
340   fmt[21 + ULTRASTOR_MAX_CMDS * 2] = 0;
341   printk(fmt, command, &config->mscp[command], config->mscp_free);
342
343 }
344 #endif
345
346 static int ultrastor_14f_detect(struct scsi_host_template * tpnt)
347 {
348     size_t i;
349     unsigned char in_byte, version_byte = 0;
350     struct config_1 {
351       unsigned char bios_segment: 3;
352       unsigned char removable_disks_as_fixed: 1;
353       unsigned char interrupt: 2;
354     unsigned char dma_channel: 2;
355     } config_1;
356     struct config_2 {
357       unsigned char ha_scsi_id: 3;
358       unsigned char mapping_mode: 2;
359       unsigned char bios_drive_number: 1;
360       unsigned char tfr_port: 2;
361     } config_2;
362
363 #if (ULTRASTOR_DEBUG & UD_DETECT)
364     printk("US14F: detect: called\n");
365 #endif
366
367     /* If a 24F has already been configured, don't look for a 14F.  */
368     if (config.bios_segment)
369         return FALSE;
370
371 #ifdef PORT_OVERRIDE
372     if(!request_region(PORT_OVERRIDE, 0xc, "ultrastor")) {
373       printk("Ultrastor I/O space already in use\n");
374       return FALSE;
375     };
376     config.port_address = PORT_OVERRIDE;
377 #else
378     for (i = 0; i < ARRAY_SIZE(ultrastor_ports_14f); i++) {
379       if(!request_region(ultrastor_ports_14f[i], 0x0c, "ultrastor")) continue;
380       config.port_address = ultrastor_ports_14f[i];
381 #endif
382
383 #if (ULTRASTOR_DEBUG & UD_DETECT)
384         printk("US14F: detect: testing port address %03X\n", config.port_address);
385 #endif
386
387         in_byte = inb(U14F_PRODUCT_ID(config.port_address));
388         if (in_byte != US14F_PRODUCT_ID_0) {
389 #if (ULTRASTOR_DEBUG & UD_DETECT)
390 # ifdef PORT_OVERRIDE
391             printk("US14F: detect: wrong product ID 0 - %02X\n", in_byte);
392 # else
393             printk("US14F: detect: no adapter at port %03X\n", config.port_address);
394 # endif
395 #endif
396 #ifdef PORT_OVERRIDE
397             goto out_release_port;
398 #else
399             release_region(config.port_address, 0x0c);
400             continue;
401 #endif
402         }
403         in_byte = inb(U14F_PRODUCT_ID(config.port_address) + 1);
404         /* Only upper nibble is significant for Product ID 1 */
405         if ((in_byte & 0xF0) != US14F_PRODUCT_ID_1) {
406 #if (ULTRASTOR_DEBUG & UD_DETECT)
407 # ifdef PORT_OVERRIDE
408             printk("US14F: detect: wrong product ID 1 - %02X\n", in_byte);
409 # else
410             printk("US14F: detect: no adapter at port %03X\n", config.port_address);
411 # endif
412 #endif
413 #ifdef PORT_OVERRIDE
414             goto out_release_port;
415 #else
416             release_region(config.port_address, 0x0c);
417             continue;
418 #endif
419         }
420         version_byte = in_byte;
421 #ifndef PORT_OVERRIDE
422         break;
423     }
424     if (i == ARRAY_SIZE(ultrastor_ports_14f)) {
425 # if (ULTRASTOR_DEBUG & UD_DETECT)
426         printk("US14F: detect: no port address found!\n");
427 # endif
428         /* all ports probed already released - we can just go straight out */
429         return FALSE;
430     }
431 #endif
432
433 #if (ULTRASTOR_DEBUG & UD_DETECT)
434     printk("US14F: detect: adapter found at port address %03X\n",
435            config.port_address);
436 #endif
437
438     /* Set local doorbell mask to disallow bus reset unless
439        ultrastor_bus_reset is true.  */
440     outb(ultrastor_bus_reset ? 0xc2 : 0x82, LCL_DOORBELL_MASK(config.port_address));
441
442     /* All above tests passed, must be the right thing.  Get some useful
443        info. */
444
445     /* Register the I/O space that we use */
446
447     *(char *)&config_1 = inb(CONFIG(config.port_address + 0));
448     *(char *)&config_2 = inb(CONFIG(config.port_address + 1));
449     config.bios_segment = bios_segment_table[config_1.bios_segment];
450     config.doorbell_address = config.port_address;
451     config.ogm_address = config.port_address + 0x8;
452     config.icm_address = config.port_address + 0xC;
453     config.interrupt = interrupt_table_14f[config_1.interrupt];
454     config.ha_scsi_id = config_2.ha_scsi_id;
455     config.heads = mapping_table[config_2.mapping_mode].heads;
456     config.sectors = mapping_table[config_2.mapping_mode].sectors;
457     config.bios_drive_number = config_2.bios_drive_number;
458     config.subversion = (version_byte & 0x0F);
459     if (config.subversion == U34F)
460         config.dma_channel = 0;
461     else
462         config.dma_channel = dma_channel_table_14f[config_1.dma_channel];
463
464     if (!config.bios_segment) {
465 #if (ULTRASTOR_DEBUG & UD_DETECT)
466         printk("US14F: detect: not detected.\n");
467 #endif
468         goto out_release_port;
469     }
470
471     /* Final consistency check, verify previous info. */
472     if (config.subversion != U34F)
473         if (!config.dma_channel || !(config_2.tfr_port & 0x2)) {
474 #if (ULTRASTOR_DEBUG & UD_DETECT)
475             printk("US14F: detect: consistency check failed\n");
476 #endif
477            goto out_release_port;
478         }
479
480     /* If we were TRULY paranoid, we could issue a host adapter inquiry
481        command here and verify the data returned.  But frankly, I'm
482        exhausted! */
483
484     /* Finally!  Now I'm satisfied... */
485 #if (ULTRASTOR_DEBUG & UD_DETECT)
486     printk("US14F: detect: detect succeeded\n"
487            "  Port address: %03X\n"
488            "  BIOS segment: %05X\n"
489            "  Interrupt: %u\n"
490            "  DMA channel: %u\n"
491            "  H/A SCSI ID: %u\n"
492            "  Subversion: %u\n",
493            config.port_address, config.bios_segment, config.interrupt,
494            config.dma_channel, config.ha_scsi_id, config.subversion);
495 #endif
496     tpnt->this_id = config.ha_scsi_id;
497     tpnt->unchecked_isa_dma = (config.subversion != U34F);
498
499 #if ULTRASTOR_MAX_CMDS > 1
500     config.mscp_free = ~0;
501 #endif
502
503     /*
504      * Brrr, &config.mscp[0].SCint->host) it is something magical....
505      * XXX and FIXME
506      */
507     if (request_irq(config.interrupt, do_ultrastor_interrupt, 0, "Ultrastor", &config.mscp[0].SCint->device->host)) {
508         printk("Unable to allocate IRQ%u for UltraStor controller.\n",
509                config.interrupt);
510         goto out_release_port;
511     }
512     if (config.dma_channel && request_dma(config.dma_channel,"Ultrastor")) {
513         printk("Unable to allocate DMA channel %u for UltraStor controller.\n",
514                config.dma_channel);
515         free_irq(config.interrupt, NULL);
516         goto out_release_port;
517     }
518     tpnt->sg_tablesize = ULTRASTOR_14F_MAX_SG;
519     printk("UltraStor driver version" VERSION ".  Using %d SG lists.\n",
520            ULTRASTOR_14F_MAX_SG);
521
522     return TRUE;
523 out_release_port:
524     release_region(config.port_address, 0x0c);
525     return FALSE;
526 }
527
528 static int ultrastor_24f_detect(struct scsi_host_template * tpnt)
529 {
530   int i;
531   struct Scsi_Host * shpnt = NULL;
532
533 #if (ULTRASTOR_DEBUG & UD_DETECT)
534   printk("US24F: detect");
535 #endif
536
537   /* probe each EISA slot at slot address C80 */
538   for (i = 1; i < 15; i++)
539     {
540       unsigned char config_1, config_2;
541       unsigned short addr = (i << 12) | ULTRASTOR_24F_PORT;
542
543       if (inb(addr) != US24F_PRODUCT_ID_0 &&
544           inb(addr+1) != US24F_PRODUCT_ID_1 &&
545           inb(addr+2) != US24F_PRODUCT_ID_2)
546         continue;
547
548       config.revision = inb(addr+3);
549       config.slot = i;
550       if (! (inb(addr+4) & 1))
551         {
552 #if (ULTRASTOR_DEBUG & UD_DETECT)
553           printk("U24F: found disabled card in slot %u\n", i);
554 #endif
555           continue;
556         }
557 #if (ULTRASTOR_DEBUG & UD_DETECT)
558       printk("U24F: found card in slot %u\n", i);
559 #endif
560       config_1 = inb(addr + 5);
561       config.bios_segment = bios_segment_table[config_1 & 7];
562       switch(config_1 >> 4)
563         {
564         case 1:
565           config.interrupt = 15;
566           break;
567         case 2:
568           config.interrupt = 14;
569           break;
570         case 4:
571           config.interrupt = 11;
572           break;
573         case 8:
574           config.interrupt = 10;
575           break;
576         default:
577           printk("U24F: invalid IRQ\n");
578           return FALSE;
579         }
580
581       /* BIOS addr set */
582       /* base port set */
583       config.port_address = addr;
584       config.doorbell_address = addr + 12;
585       config.ogm_address = addr + 0x17;
586       config.icm_address = addr + 0x1C;
587       config_2 = inb(addr + 7);
588       config.ha_scsi_id = config_2 & 7;
589       config.heads = mapping_table[(config_2 >> 3) & 3].heads;
590       config.sectors = mapping_table[(config_2 >> 3) & 3].sectors;
591 #if (ULTRASTOR_DEBUG & UD_DETECT)
592       printk("US24F: detect: detect succeeded\n"
593              "  Port address: %03X\n"
594              "  BIOS segment: %05X\n"
595              "  Interrupt: %u\n"
596              "  H/A SCSI ID: %u\n",
597              config.port_address, config.bios_segment,
598              config.interrupt, config.ha_scsi_id);
599 #endif
600       tpnt->this_id = config.ha_scsi_id;
601       tpnt->unchecked_isa_dma = 0;
602       tpnt->sg_tablesize = ULTRASTOR_24F_MAX_SG;
603
604       shpnt = scsi_register(tpnt, 0);
605       if (!shpnt) {
606              printk(KERN_WARNING "(ultrastor:) Could not register scsi device. Aborting registration.\n");
607              free_irq(config.interrupt, do_ultrastor_interrupt);
608              return FALSE;
609       }
610       
611       if (request_irq(config.interrupt, do_ultrastor_interrupt, 0, "Ultrastor", shpnt))
612         {
613           printk("Unable to allocate IRQ%u for UltraStor controller.\n",
614                  config.interrupt);
615           return FALSE;
616         }
617
618       shpnt->irq = config.interrupt;
619       shpnt->dma_channel = config.dma_channel;
620       shpnt->io_port = config.port_address;
621
622 #if ULTRASTOR_MAX_CMDS > 1
623       config.mscp_free = ~0;
624 #endif
625       /* Mark ICM and OGM free */
626       outb(0, addr + 0x16);
627       outb(0, addr + 0x1B);
628
629       /* Set local doorbell mask to disallow bus reset unless
630          ultrastor_bus_reset is true.  */
631       outb(ultrastor_bus_reset ? 0xc2 : 0x82, LCL_DOORBELL_MASK(addr+12));
632       outb(0x02, SYS_DOORBELL_MASK(addr+12));
633       printk("UltraStor driver version " VERSION ".  Using %d SG lists.\n",
634              tpnt->sg_tablesize);
635       return TRUE;
636     }
637   return FALSE;
638 }
639
640 static int ultrastor_detect(struct scsi_host_template * tpnt)
641 {
642         tpnt->proc_name = "ultrastor";
643         return ultrastor_14f_detect(tpnt) || ultrastor_24f_detect(tpnt);
644 }
645
646 static int ultrastor_release(struct Scsi_Host *shost)
647 {
648         if (shost->irq)
649                 free_irq(shost->irq, NULL);
650         if (shost->dma_channel != 0xff)
651                 free_dma(shost->dma_channel);
652         if (shost->io_port && shost->n_io_port)
653                 release_region(shost->io_port, shost->n_io_port);
654         scsi_unregister(shost);
655         return 0;
656 }
657
658 static const char *ultrastor_info(struct Scsi_Host * shpnt)
659 {
660     static char buf[64];
661
662     if (config.slot)
663       sprintf(buf, "UltraStor 24F SCSI @ Slot %u IRQ%u",
664               config.slot, config.interrupt);
665     else if (config.subversion)
666       sprintf(buf, "UltraStor 34F SCSI @ Port %03X BIOS %05X IRQ%u",
667               config.port_address, (int)config.bios_segment,
668               config.interrupt);
669     else
670       sprintf(buf, "UltraStor 14F SCSI @ Port %03X BIOS %05X IRQ%u DMA%u",
671               config.port_address, (int)config.bios_segment,
672               config.interrupt, config.dma_channel);
673     return buf;
674 }
675
676 static inline void build_sg_list(struct mscp *mscp, struct scsi_cmnd *SCpnt)
677 {
678         struct scatterlist *sl;
679         long transfer_length = 0;
680         int i, max;
681
682         sl = (struct scatterlist *) SCpnt->request_buffer;
683         max = SCpnt->use_sg;
684         for (i = 0; i < max; i++) {
685                 mscp->sglist[i].address = isa_page_to_bus(sl[i].page) + sl[i].offset;
686                 mscp->sglist[i].num_bytes = sl[i].length;
687                 transfer_length += sl[i].length;
688         }
689         mscp->number_of_sg_list = max;
690         mscp->transfer_data = isa_virt_to_bus(mscp->sglist);
691         /* ??? May not be necessary.  Docs are unclear as to whether transfer
692            length field is ignored or whether it should be set to the total
693            number of bytes of the transfer.  */
694         mscp->transfer_data_length = transfer_length;
695 }
696
697 static int ultrastor_queuecommand(struct scsi_cmnd *SCpnt,
698                                 void (*done) (struct scsi_cmnd *))
699 {
700     struct mscp *my_mscp;
701 #if ULTRASTOR_MAX_CMDS > 1
702     int mscp_index;
703 #endif
704     unsigned int status;
705
706     /* Next test is for debugging; "can't happen" */
707     if ((config.mscp_free & ((1U << ULTRASTOR_MAX_CMDS) - 1)) == 0)
708         panic("ultrastor_queuecommand: no free MSCP\n");
709     mscp_index = find_and_clear_bit_16(&config.mscp_free);
710
711     /* Has the command been aborted?  */
712     if (xchgb(0xff, &config.aborted[mscp_index]) != 0)
713       {
714         status = DID_ABORT << 16;
715         goto aborted;
716       }
717
718     my_mscp = &config.mscp[mscp_index];
719
720     *(unsigned char *)my_mscp = OP_SCSI | (DTD_SCSI << 3);
721
722     /* Tape drives don't work properly if the cache is used.  The SCSI
723        READ command for a tape doesn't have a block offset, and the adapter
724        incorrectly assumes that all reads from the tape read the same
725        blocks.  Results will depend on read buffer size and other disk
726        activity. 
727
728        ???  Which other device types should never use the cache?   */
729     my_mscp->ca = SCpnt->device->type != TYPE_TAPE;
730     my_mscp->target_id = SCpnt->device->id;
731     my_mscp->ch_no = 0;
732     my_mscp->lun = SCpnt->device->lun;
733     if (SCpnt->use_sg) {
734         /* Set scatter/gather flag in SCSI command packet */
735         my_mscp->sg = TRUE;
736         build_sg_list(my_mscp, SCpnt);
737     } else {
738         /* Unset scatter/gather flag in SCSI command packet */
739         my_mscp->sg = FALSE;
740         my_mscp->transfer_data = isa_virt_to_bus(SCpnt->request_buffer);
741         my_mscp->transfer_data_length = SCpnt->request_bufflen;
742     }
743     my_mscp->command_link = 0;          /*???*/
744     my_mscp->scsi_command_link_id = 0;  /*???*/
745     my_mscp->length_of_sense_byte = sizeof SCpnt->sense_buffer;
746     my_mscp->length_of_scsi_cdbs = SCpnt->cmd_len;
747     memcpy(my_mscp->scsi_cdbs, SCpnt->cmnd, my_mscp->length_of_scsi_cdbs);
748     my_mscp->adapter_status = 0;
749     my_mscp->target_status = 0;
750     my_mscp->sense_data = isa_virt_to_bus(&SCpnt->sense_buffer);
751     my_mscp->done = done;
752     my_mscp->SCint = SCpnt;
753     SCpnt->host_scribble = (unsigned char *)my_mscp;
754
755     /* Find free OGM slot.  On 24F, look for OGM status byte == 0.
756        On 14F and 34F, wait for local interrupt pending flag to clear. 
757        
758        FIXME: now we are using new_eh we should punt here and let the
759        midlayer sort it out */
760
761 retry:
762     if (config.slot)
763         while (inb(config.ogm_address - 1) != 0 && config.aborted[mscp_index] == 0xff)
764                 barrier();
765
766     /* else??? */
767
768     while ((inb(LCL_DOORBELL_INTR(config.doorbell_address)) & (config.slot ? 2 : 1))  && config.aborted[mscp_index] == 0xff)
769         barrier();
770
771     /* To avoid race conditions, keep the code to write to the adapter
772        atomic.  This simplifies the abort code.  Right now the
773        scsi mid layer has the host_lock already held
774      */
775
776     if (inb(LCL_DOORBELL_INTR(config.doorbell_address)) & (config.slot ? 2 : 1))
777       goto retry;
778
779     status = xchgb(0, &config.aborted[mscp_index]);
780     if (status != 0xff) {
781
782 #if ULTRASTOR_DEBUG & (UD_COMMAND | UD_ABORT)
783         printk("USx4F: queuecommand: aborted\n");
784 #if ULTRASTOR_MAX_CMDS > 1
785         log_ultrastor_abort(&config, mscp_index);
786 #endif
787 #endif
788         status <<= 16;
789
790       aborted:
791         set_bit(mscp_index, &config.mscp_free);
792         /* If the driver queues commands, call the done proc here.  Otherwise
793            return an error.  */
794 #if ULTRASTOR_MAX_CMDS > 1
795         SCpnt->result = status;
796         done(SCpnt);
797         return 0;
798 #else
799         return status;
800 #endif
801     }
802
803     /* Store pointer in OGM address bytes */
804     outl(isa_virt_to_bus(my_mscp), config.ogm_address);
805
806     /* Issue OGM interrupt */
807     if (config.slot) {
808         /* Write OGM command register on 24F */
809         outb(1, config.ogm_address - 1);
810         outb(0x2, LCL_DOORBELL_INTR(config.doorbell_address));
811     } else {
812         outb(0x1, LCL_DOORBELL_INTR(config.doorbell_address));
813     }
814
815 #if (ULTRASTOR_DEBUG & UD_COMMAND)
816     printk("USx4F: queuecommand: returning\n");
817 #endif
818
819     return 0;
820 }
821
822 /* This code must deal with 2 cases:
823
824    1. The command has not been written to the OGM.  In this case, set
825    the abort flag and return.
826
827    2. The command has been written to the OGM and is stuck somewhere in
828    the adapter.
829
830    2a.  On a 24F, ask the adapter to abort the command.  It will interrupt
831    when it does.
832
833    2b.  Call the command's done procedure.
834
835  */
836
837 static int ultrastor_abort(struct scsi_cmnd *SCpnt)
838 {
839 #if ULTRASTOR_DEBUG & UD_ABORT
840     char out[108];
841     unsigned char icm_status = 0, ogm_status = 0;
842     unsigned int icm_addr = 0, ogm_addr = 0;
843 #endif
844     unsigned int mscp_index;
845     unsigned char old_aborted;
846     unsigned long flags;
847     void (*done)(struct scsi_cmnd *);
848     struct Scsi_Host *host = SCpnt->device->host;
849
850     if(config.slot) 
851       return FAILED;  /* Do not attempt an abort for the 24f */
852       
853     /* Simple consistency checking */
854     if(!SCpnt->host_scribble)
855       return FAILED;
856
857     mscp_index = ((struct mscp *)SCpnt->host_scribble) - config.mscp;
858     if (mscp_index >= ULTRASTOR_MAX_CMDS)
859         panic("Ux4F aborting invalid MSCP");
860
861 #if ULTRASTOR_DEBUG & UD_ABORT
862     if (config.slot)
863       {
864         int port0 = (config.slot << 12) | 0xc80;
865         int i;
866         unsigned long flags;
867         
868         spin_lock_irqsave(host->host_lock, flags);
869         strcpy(out, "OGM %d:%x ICM %d:%x ports:  ");
870         for (i = 0; i < 16; i++)
871           {
872             unsigned char p = inb(port0 + i);
873             out[28 + i * 3] = "0123456789abcdef"[p >> 4];
874             out[29 + i * 3] = "0123456789abcdef"[p & 15];
875             out[30 + i * 3] = ' ';
876           }
877         out[28 + i * 3] = '\n';
878         out[29 + i * 3] = 0;
879         ogm_status = inb(port0 + 22);
880         ogm_addr = (unsigned int)isa_bus_to_virt(inl(port0 + 23));
881         icm_status = inb(port0 + 27);
882         icm_addr = (unsigned int)isa_bus_to_virt(inl(port0 + 28));
883         spin_unlock_irqrestore(host->host_lock, flags);
884       }
885
886     /* First check to see if an interrupt is pending.  I suspect the SiS
887        chipset loses interrupts.  (I also suspect is mangles data, but
888        one bug at a time... */
889     if (config.slot ? inb(config.icm_address - 1) == 2 :
890         (inb(SYS_DOORBELL_INTR(config.doorbell_address)) & 1))
891       {
892         printk("Ux4F: abort while completed command pending\n");
893         
894         spin_lock_irqsave(host->host_lock, flags);
895         /* FIXME: Ewww... need to think about passing host around properly */
896         ultrastor_interrupt(0, NULL, NULL);
897         spin_unlock_irqrestore(host->host_lock, flags);
898         return SUCCESS;
899       }
900 #endif
901
902     old_aborted = xchgb(DID_ABORT, &config.aborted[mscp_index]);
903
904     /* aborted == 0xff is the signal that queuecommand has not yet sent
905        the command.  It will notice the new abort flag and fail.  */
906     if (old_aborted == 0xff)
907         return SUCCESS;
908
909     /* On 24F, send an abort MSCP request.  The adapter will interrupt
910        and the interrupt handler will call done.  */
911     if (config.slot && inb(config.ogm_address - 1) == 0)
912       {
913         unsigned long flags;
914
915         spin_lock_irqsave(host->host_lock, flags);
916         outl(isa_virt_to_bus(&config.mscp[mscp_index]), config.ogm_address);
917         udelay(8);
918         outb(0x80, config.ogm_address - 1);
919         outb(0x2, LCL_DOORBELL_INTR(config.doorbell_address));
920 #if ULTRASTOR_DEBUG & UD_ABORT
921         log_ultrastor_abort(&config, mscp_index);
922         printk(out, ogm_status, ogm_addr, icm_status, icm_addr);
923 #endif
924         spin_unlock_irqrestore(host->host_lock, flags);
925         /* FIXME: add a wait for the abort to complete */
926         return SUCCESS;
927       }
928
929 #if ULTRASTOR_DEBUG & UD_ABORT
930     log_ultrastor_abort(&config, mscp_index);
931 #endif
932
933     /* Can't request a graceful abort.  Either this is not a 24F or
934        the OGM is busy.  Don't free the command -- the adapter might
935        still be using it.  Setting SCint = 0 causes the interrupt
936        handler to ignore the command.  */
937
938     /* FIXME - devices that implement soft resets will still be running
939        the command after a bus reset.  We would probably rather leave
940        the command in the queue.  The upper level code will automatically
941        leave the command in the active state instead of requeueing it. ERY */
942
943 #if ULTRASTOR_DEBUG & UD_ABORT
944     if (config.mscp[mscp_index].SCint != SCpnt)
945         printk("abort: command mismatch, %p != %p\n",
946                config.mscp[mscp_index].SCint, SCpnt);
947 #endif
948     if (config.mscp[mscp_index].SCint == 0)
949         return FAILED;
950
951     if (config.mscp[mscp_index].SCint != SCpnt) panic("Bad abort");
952     config.mscp[mscp_index].SCint = NULL;
953     done = config.mscp[mscp_index].done;
954     config.mscp[mscp_index].done = NULL;
955     SCpnt->result = DID_ABORT << 16;
956     
957     /* Take the host lock to guard against scsi layer re-entry */
958     done(SCpnt);
959
960     /* Need to set a timeout here in case command never completes.  */
961     return SUCCESS;
962 }
963
964 static int ultrastor_host_reset(struct scsi_cmnd * SCpnt)
965 {
966     unsigned long flags;
967     int i;
968     struct Scsi_Host *host = SCpnt->device->host;
969     
970 #if (ULTRASTOR_DEBUG & UD_RESET)
971     printk("US14F: reset: called\n");
972 #endif
973
974     if(config.slot)
975         return FAILED;
976
977     spin_lock_irqsave(host->host_lock, flags);
978     /* Reset the adapter and SCSI bus.  The SCSI bus reset can be
979        inhibited by clearing ultrastor_bus_reset before probe.  */
980     outb(0xc0, LCL_DOORBELL_INTR(config.doorbell_address));
981     if (config.slot)
982       {
983         outb(0, config.ogm_address - 1);
984         outb(0, config.icm_address - 1);
985       }
986
987 #if ULTRASTOR_MAX_CMDS == 1
988     if (config.mscp_busy && config.mscp->done && config.mscp->SCint)
989       {
990         config.mscp->SCint->result = DID_RESET << 16;
991         config.mscp->done(config.mscp->SCint);
992       }
993     config.mscp->SCint = 0;
994 #else
995     for (i = 0; i < ULTRASTOR_MAX_CMDS; i++)
996       {
997         if (! (config.mscp_free & (1 << i)) &&
998             config.mscp[i].done && config.mscp[i].SCint)
999           {
1000             config.mscp[i].SCint->result = DID_RESET << 16;
1001             config.mscp[i].done(config.mscp[i].SCint);
1002             config.mscp[i].done = NULL;
1003           }
1004         config.mscp[i].SCint = NULL;
1005       }
1006 #endif
1007
1008     /* FIXME - if the device implements soft resets, then the command
1009        will still be running.  ERY  
1010        
1011        Even bigger deal with new_eh! 
1012      */
1013
1014     memset((unsigned char *)config.aborted, 0, sizeof config.aborted);
1015 #if ULTRASTOR_MAX_CMDS == 1
1016     config.mscp_busy = 0;
1017 #else
1018     config.mscp_free = ~0;
1019 #endif
1020
1021     spin_unlock_irqrestore(host->host_lock, flags);
1022     return SUCCESS;
1023
1024 }
1025
1026 int ultrastor_biosparam(struct scsi_device *sdev, struct block_device *bdev,
1027                 sector_t capacity, int * dkinfo)
1028 {
1029     int size = capacity;
1030     unsigned int s = config.heads * config.sectors;
1031
1032     dkinfo[0] = config.heads;
1033     dkinfo[1] = config.sectors;
1034     dkinfo[2] = size / s;       /* Ignore partial cylinders */
1035 #if 0
1036     if (dkinfo[2] > 1024)
1037         dkinfo[2] = 1024;
1038 #endif
1039     return 0;
1040 }
1041
1042 static void ultrastor_interrupt(int irq, void *dev_id, struct pt_regs *regs)
1043 {
1044     unsigned int status;
1045 #if ULTRASTOR_MAX_CMDS > 1
1046     unsigned int mscp_index;
1047 #endif
1048     struct mscp *mscp;
1049     void (*done) (struct scsi_cmnd *);
1050     struct scsi_cmnd *SCtmp;
1051
1052 #if ULTRASTOR_MAX_CMDS == 1
1053     mscp = &config.mscp[0];
1054 #else
1055     mscp = (struct mscp *)isa_bus_to_virt(inl(config.icm_address));
1056     mscp_index = mscp - config.mscp;
1057     if (mscp_index >= ULTRASTOR_MAX_CMDS) {
1058         printk("Ux4F interrupt: bad MSCP address %x\n", (unsigned int) mscp);
1059         /* A command has been lost.  Reset and report an error
1060            for all commands.  */
1061         ultrastor_host_reset(dev_id);
1062         return;
1063     }
1064 #endif
1065
1066     /* Clean ICM slot (set ICMINT bit to 0) */
1067     if (config.slot) {
1068         unsigned char icm_status = inb(config.icm_address - 1);
1069 #if ULTRASTOR_DEBUG & (UD_INTERRUPT|UD_ERROR|UD_ABORT)
1070         if (icm_status != 1 && icm_status != 2)
1071             printk("US24F: ICM status %x for MSCP %d (%x)\n", icm_status,
1072                    mscp_index, (unsigned int) mscp);
1073 #endif
1074         /* The manual says clear interrupt then write 0 to ICM status.
1075            This seems backwards, but I'll do it anyway.  --jfc */
1076         outb(2, SYS_DOORBELL_INTR(config.doorbell_address));
1077         outb(0, config.icm_address - 1);
1078         if (icm_status == 4) {
1079             printk("UltraStor abort command failed\n");
1080             return;
1081         }
1082         if (icm_status == 3) {
1083             void (*done)(struct scsi_cmnd *) = mscp->done;
1084             if (done) {
1085                 mscp->done = NULL;
1086                 mscp->SCint->result = DID_ABORT << 16;
1087                 done(mscp->SCint);
1088             }
1089             return;
1090         }
1091     } else {
1092         outb(1, SYS_DOORBELL_INTR(config.doorbell_address));
1093     }
1094
1095     SCtmp = mscp->SCint;
1096     mscp->SCint = NULL;
1097
1098     if (SCtmp == 0)
1099       {
1100 #if ULTRASTOR_DEBUG & (UD_ABORT|UD_INTERRUPT)
1101         printk("MSCP %d (%x): no command\n", mscp_index, (unsigned int) mscp);
1102 #endif  
1103 #if ULTRASTOR_MAX_CMDS == 1
1104         config.mscp_busy = FALSE;
1105 #else
1106         set_bit(mscp_index, &config.mscp_free);
1107 #endif
1108         config.aborted[mscp_index] = 0;
1109         return;
1110       }
1111
1112     /* Save done locally and zero before calling.  This is needed as
1113        once we call done, we may get another command queued before this
1114        interrupt service routine can return. */
1115     done = mscp->done;
1116     mscp->done = NULL;
1117
1118     /* Let the higher levels know that we're done */
1119     switch (mscp->adapter_status)
1120       {
1121       case 0:
1122         status = DID_OK << 16;
1123         break;
1124       case 0x01:        /* invalid command */
1125       case 0x02:        /* invalid parameters */
1126       case 0x03:        /* invalid data list */
1127       default:
1128         status = DID_ERROR << 16;
1129         break;
1130       case 0x84:        /* SCSI bus abort */
1131         status = DID_ABORT << 16;
1132         break;
1133       case 0x91:
1134         status = DID_TIME_OUT << 16;
1135         break;
1136       }
1137
1138     SCtmp->result = status | mscp->target_status;
1139
1140     SCtmp->host_scribble = NULL;
1141
1142     /* Free up mscp block for next command */
1143 #if ULTRASTOR_MAX_CMDS == 1
1144     config.mscp_busy = FALSE;
1145 #else
1146     set_bit(mscp_index, &config.mscp_free);
1147 #endif
1148
1149 #if ULTRASTOR_DEBUG & (UD_ABORT|UD_INTERRUPT)
1150     if (config.aborted[mscp_index])
1151         printk("Ux4 interrupt: MSCP %d (%x) aborted = %d\n",
1152                mscp_index, (unsigned int) mscp, config.aborted[mscp_index]);
1153 #endif
1154     config.aborted[mscp_index] = 0;
1155
1156     if (done)
1157         done(SCtmp);
1158     else
1159         printk("US14F: interrupt: unexpected interrupt\n");
1160
1161     if (config.slot ? inb(config.icm_address - 1) :
1162        (inb(SYS_DOORBELL_INTR(config.doorbell_address)) & 1))
1163 #if (ULTRASTOR_DEBUG & UD_MULTI_CMD)
1164       printk("Ux4F: multiple commands completed\n");
1165 #else
1166       ;
1167 #endif
1168
1169 #if (ULTRASTOR_DEBUG & UD_INTERRUPT)
1170     printk("USx4F: interrupt: returning\n");
1171 #endif
1172 }
1173
1174 static irqreturn_t do_ultrastor_interrupt(int irq, void *dev_id,
1175                                                 struct pt_regs *regs)
1176 {
1177     unsigned long flags;
1178     struct Scsi_Host *dev = dev_id;
1179     
1180     spin_lock_irqsave(dev->host_lock, flags);
1181     ultrastor_interrupt(irq, dev_id, regs);
1182     spin_unlock_irqrestore(dev->host_lock, flags);
1183     return IRQ_HANDLED;
1184 }
1185
1186 MODULE_LICENSE("GPL");
1187
1188 static struct scsi_host_template driver_template = {
1189         .name              = "UltraStor 14F/24F/34F",
1190         .detect            = ultrastor_detect,
1191         .release           = ultrastor_release,
1192         .info              = ultrastor_info,
1193         .queuecommand      = ultrastor_queuecommand,
1194         .eh_abort_handler  = ultrastor_abort,
1195         .eh_host_reset_handler  = ultrastor_host_reset, 
1196         .bios_param        = ultrastor_biosparam,
1197         .can_queue         = ULTRASTOR_MAX_CMDS,
1198         .sg_tablesize      = ULTRASTOR_14F_MAX_SG,
1199         .cmd_per_lun       = ULTRASTOR_MAX_CMDS_PER_LUN,
1200         .unchecked_isa_dma = 1,
1201         .use_clustering    = ENABLE_CLUSTERING,
1202 };
1203 #include "scsi_module.c"