v2.4.2.1 -> v2.4.2.2
[opensuse:kernel.git] / drivers / scsi / imm.c
1 /* imm.c   --  low level driver for the IOMEGA MatchMaker
2  * parallel port SCSI host adapter.
3  * 
4  * (The IMM is the embedded controller in the ZIP Plus drive.)
5  * 
6  * Current Maintainer: David Campbell (Perth, Western Australia)
7  *                     campbell@torque.net
8  *
9  * My unoffical company acronym list is 21 pages long:
10  *      FLA:    Four letter acronym with built in facility for
11  *              future expansion to five letters.
12  */
13
14 #include <linux/config.h>
15
16 /* The following #define is to avoid a clash with hosts.c */
17 #define IMM_CODE 1
18 #define IMM_PROBE_SPP   0x0001
19 #define IMM_PROBE_PS2   0x0002
20 #define IMM_PROBE_ECR   0x0010
21 #define IMM_PROBE_EPP17 0x0100
22 #define IMM_PROBE_EPP19 0x0200
23
24 void imm_reset_pulse(unsigned int base);
25 static int device_check(int host_no);
26
27 #include <linux/blk.h>
28 #include <asm/io.h>
29 #include <linux/parport.h>
30 #include "sd.h"
31 #include "hosts.h"
32 typedef struct {
33     struct pardevice *dev;      /* Parport device entry         */
34     int base;                   /* Actual port address          */
35     int base_hi;                /* Hi Base address for ECP-ISA chipset */
36     int mode;                   /* Transfer mode                */
37     int host;                   /* Host number (for proc)       */
38     Scsi_Cmnd *cur_cmd;         /* Current queued command       */
39     struct tq_struct imm_tq;    /* Polling interrupt stuff       */
40     unsigned long jstart;       /* Jiffies at start             */
41     unsigned failed:1;          /* Failure flag                 */
42     unsigned dp:1;              /* Data phase present           */
43     unsigned rd:1;              /* Read data in data phase      */
44     unsigned p_busy:1;          /* Parport sharing busy flag    */
45 } imm_struct;
46
47 #define IMM_EMPTY \
48 {       dev:            NULL,           \
49         base:           -1,             \
50         base_hi:        0,              \
51         mode:           IMM_AUTODETECT, \
52         host:           -1,             \
53         cur_cmd:        NULL,           \
54         imm_tq:         { routine: imm_interrupt },    \
55         jstart:         0,              \
56         failed:         0,              \
57         dp:             0,              \
58         rd:             0,              \
59         p_busy:         0               \
60 }
61
62 #include "imm.h"
63 #define NO_HOSTS 4
64 static imm_struct imm_hosts[NO_HOSTS] =
65 {IMM_EMPTY, IMM_EMPTY, IMM_EMPTY, IMM_EMPTY};
66
67 #define IMM_BASE(x)     imm_hosts[(x)].base
68 #define IMM_BASE_HI(x)     imm_hosts[(x)].base_hi
69
70 int parbus_base[NO_HOSTS] =
71 {0x03bc, 0x0378, 0x0278, 0x0000};
72
73 void imm_wakeup(void *ref)
74 {
75     imm_struct *imm_dev = (imm_struct *) ref;
76
77     if (!imm_dev->p_busy)
78         return;
79
80     if (parport_claim(imm_dev->dev)) {
81         printk("imm: bug in imm_wakeup\n");
82         return;
83     }
84     imm_dev->p_busy = 0;
85     imm_dev->base = imm_dev->dev->port->base;
86     if (imm_dev->cur_cmd)
87         imm_dev->cur_cmd->SCp.phase++;
88     return;
89 }
90
91 int imm_release(struct Scsi_Host *host)
92 {
93     int host_no = host->unique_id;
94
95     printk("Releasing imm%i\n", host_no);
96     parport_unregister_device(imm_hosts[host_no].dev);
97     return 0;
98 }
99
100 static int imm_pb_claim(int host_no)
101 {
102     if (parport_claim(imm_hosts[host_no].dev)) {
103         imm_hosts[host_no].p_busy = 1;
104         return 1;
105     }
106     if (imm_hosts[host_no].cur_cmd)
107         imm_hosts[host_no].cur_cmd->SCp.phase++;
108     return 0;
109 }
110
111 #define imm_pb_release(x) parport_release(imm_hosts[(x)].dev)
112
113 /***************************************************************************
114  *                   Parallel port probing routines                        *
115  ***************************************************************************/
116
117 static Scsi_Host_Template driver_template = IMM;
118 #include  "scsi_module.c"
119
120 int imm_detect(Scsi_Host_Template * host)
121 {
122     struct Scsi_Host *hreg;
123     int ports;
124     int i, nhosts, try_again;
125     struct parport *pb;
126
127     /*
128      * unlock to allow the lowlevel parport driver to probe
129      * the irqs
130      */
131     spin_unlock_irq(&io_request_lock);
132     pb = parport_enumerate();
133
134     printk("imm: Version %s\n", IMM_VERSION);
135     nhosts = 0;
136     try_again = 0;
137
138     if (!pb) {
139         printk("imm: parport reports no devices.\n");
140         spin_lock_irq(&io_request_lock);
141         return 0;
142     }
143   retry_entry:
144     for (i = 0; pb; i++, pb = pb->next) {
145         int modes, ppb;
146
147         imm_hosts[i].dev =
148             parport_register_device(pb, "imm", NULL, imm_wakeup,
149                                     NULL, 0, (void *) &imm_hosts[i]);
150
151         if (!imm_hosts[i].dev)
152             continue;
153
154         /* Claim the bus so it remembers what we do to the control
155          * registers. [ CTR and ECP ]
156          */
157         if (imm_pb_claim(i)) {
158             unsigned long now = jiffies;
159             while (imm_hosts[i].p_busy) {
160                 schedule();     /* We are safe to schedule here */
161                 if (time_after(jiffies, now + 3 * HZ)) {
162                     printk(KERN_ERR "imm%d: failed to claim parport because a "
163                       "pardevice is owning the port for too longtime!\n",
164                            i);
165                     spin_lock_irq(&io_request_lock);
166                     return 0;
167                 }
168             }
169         }
170         ppb = IMM_BASE(i) = imm_hosts[i].dev->port->base;
171         IMM_BASE_HI(i) = imm_hosts[i].dev->port->base_hi;
172         w_ctr(ppb, 0x0c);
173         modes = imm_hosts[i].dev->port->modes;
174
175         /* Mode detection works up the chain of speed
176          * This avoids a nasty if-then-else-if-... tree
177          */
178         imm_hosts[i].mode = IMM_NIBBLE;
179
180         if (modes & PARPORT_MODE_TRISTATE)
181             imm_hosts[i].mode = IMM_PS2;
182
183         /* Done configuration */
184         imm_pb_release(i);
185
186         if (imm_init(i)) {
187             parport_unregister_device(imm_hosts[i].dev);
188             continue;
189         }
190         /* now the glue ... */
191         switch (imm_hosts[i].mode) {
192         case IMM_NIBBLE:
193             ports = 3;
194             break;
195         case IMM_PS2:
196             ports = 3;
197             break;
198         case IMM_EPP_8:
199         case IMM_EPP_16:
200         case IMM_EPP_32:
201             ports = 8;
202             break;
203         default:                /* Never gets here */
204             continue;
205         }
206
207         host->can_queue = IMM_CAN_QUEUE;
208         host->sg_tablesize = imm_sg;
209         hreg = scsi_register(host, 0);
210         if(hreg == NULL)
211                 continue;
212         hreg->io_port = pb->base;
213         hreg->n_io_port = ports;
214         hreg->dma_channel = -1;
215         hreg->unique_id = i;
216         imm_hosts[i].host = hreg->host_no;
217         nhosts++;
218     }
219     if (nhosts == 0) {
220         if (try_again == 1) {
221             spin_lock_irq(&io_request_lock);
222             return 0;
223         }
224         try_again = 1;
225         goto retry_entry;
226     } else {
227         spin_lock_irq (&io_request_lock);
228         return 1;               /* return number of hosts detected */
229     }
230 }
231
232 /* This is to give the imm driver a way to modify the timings (and other
233  * parameters) by writing to the /proc/scsi/imm/0 file.
234  * Very simple method really... (To simple, no error checking :( )
235  * Reason: Kernel hackers HATE having to unload and reload modules for
236  * testing...
237  * Also gives a method to use a script to obtain optimum timings (TODO)
238  */
239 static inline int imm_proc_write(int hostno, char *buffer, int length)
240 {
241     unsigned long x;
242
243     if ((length > 5) && (strncmp(buffer, "mode=", 5) == 0)) {
244         x = simple_strtoul(buffer + 5, NULL, 0);
245         imm_hosts[hostno].mode = x;
246         return length;
247     }
248     printk("imm /proc: invalid variable\n");
249     return (-EINVAL);
250 }
251
252 int imm_proc_info(char *buffer, char **start, off_t offset,
253                   int length, int hostno, int inout)
254 {
255     int i;
256     int len = 0;
257
258     for (i = 0; i < 4; i++)
259         if (imm_hosts[i].host == hostno)
260             break;
261
262     if (inout)
263         return imm_proc_write(i, buffer, length);
264
265     len += sprintf(buffer + len, "Version : %s\n", IMM_VERSION);
266     len += sprintf(buffer + len, "Parport : %s\n", imm_hosts[i].dev->port->name);
267     len += sprintf(buffer + len, "Mode    : %s\n", IMM_MODE_STRING[imm_hosts[i].mode]);
268
269     /* Request for beyond end of buffer */
270     if (offset > len)
271         return 0;
272
273     *start = buffer + offset;
274     len -= offset;
275     if (len > length)
276         len = length;
277     return len;
278 }
279
280 #if IMM_DEBUG > 0
281 #define imm_fail(x,y) printk("imm: imm_fail(%i) from %s at line %d\n",\
282            y, __FUNCTION__, __LINE__); imm_fail_func(x,y);
283 static inline void imm_fail_func(int host_no, int error_code)
284 #else
285 static inline void imm_fail(int host_no, int error_code)
286 #endif
287 {
288     /* If we fail a device then we trash status / message bytes */
289     if (imm_hosts[host_no].cur_cmd) {
290         imm_hosts[host_no].cur_cmd->result = error_code << 16;
291         imm_hosts[host_no].failed = 1;
292     }
293 }
294
295 /*
296  * Wait for the high bit to be set.
297  * 
298  * In principle, this could be tied to an interrupt, but the adapter
299  * doesn't appear to be designed to support interrupts.  We spin on
300  * the 0x80 ready bit. 
301  */
302 static unsigned char imm_wait(int host_no)
303 {
304     int k;
305     unsigned short ppb = IMM_BASE(host_no);
306     unsigned char r;
307
308     w_ctr(ppb, 0x0c);
309
310     k = IMM_SPIN_TMO;
311     do {
312         r = r_str(ppb);
313         k--;
314         udelay(1);
315     }
316     while (!(r & 0x80) && (k));
317
318     /*
319      * STR register (LPT base+1) to SCSI mapping:
320      *
321      * STR      imm     imm
322      * ===================================
323      * 0x80     S_REQ   S_REQ
324      * 0x40     !S_BSY  (????)
325      * 0x20     !S_CD   !S_CD
326      * 0x10     !S_IO   !S_IO
327      * 0x08     (????)  !S_BSY
328      *
329      * imm      imm     meaning
330      * ==================================
331      * 0xf0     0xb8    Bit mask
332      * 0xc0     0x88    ZIP wants more data
333      * 0xd0     0x98    ZIP wants to send more data
334      * 0xe0     0xa8    ZIP is expecting SCSI command data
335      * 0xf0     0xb8    end of transfer, ZIP is sending status
336      */
337     w_ctr(ppb, 0x04);
338     if (k)
339         return (r & 0xb8);
340
341     /* Counter expired - Time out occurred */
342     imm_fail(host_no, DID_TIME_OUT);
343     printk("imm timeout in imm_wait\n");
344     return 0;                   /* command timed out */
345 }
346
347 static int imm_negotiate(imm_struct * tmp)
348 {
349     /*
350      * The following is supposedly the IEEE 1284-1994 negotiate
351      * sequence. I have yet to obtain a copy of the above standard
352      * so this is a bit of a guess...
353      *
354      * A fair chunk of this is based on the Linux parport implementation
355      * of IEEE 1284.
356      *
357      * Return 0 if data available
358      *        1 if no data available
359      */
360
361     unsigned short base = tmp->base;
362     unsigned char a, mode;
363
364     switch (tmp->mode) {
365     case IMM_NIBBLE:
366         mode = 0x00;
367         break;
368     case IMM_PS2:
369         mode = 0x01;
370         break;
371     default:
372         return 0;
373     }
374
375     w_ctr(base, 0x04);
376     udelay(5);
377     w_dtr(base, mode);
378     udelay(100);
379     w_ctr(base, 0x06);
380     udelay(5);
381     a = (r_str(base) & 0x20) ? 0 : 1;
382     udelay(5);
383     w_ctr(base, 0x07);
384     udelay(5);
385     w_ctr(base, 0x06);
386
387     if (a) {
388         printk("IMM: IEEE1284 negotiate indicates no data available.\n");
389         imm_fail(tmp->host, DID_ERROR);
390     }
391     return a;
392 }
393
394 /* 
395  * Clear EPP timeout bit. 
396  */
397 static inline void epp_reset(unsigned short ppb)
398 {
399     int i;
400
401     i = r_str(ppb);
402     w_str(ppb, i);
403     w_str(ppb, i & 0xfe);
404 }
405
406 /* 
407  * Wait for empty ECP fifo (if we are in ECP fifo mode only)
408  */
409 static inline void ecp_sync(unsigned short hostno)
410 {
411     int i, ppb_hi=IMM_BASE_HI(hostno);
412
413     if (ppb_hi == 0) return;
414
415     if ((r_ecr(ppb_hi) & 0xe0) == 0x60) { /* mode 011 == ECP fifo mode */
416         for (i = 0; i < 100; i++) {
417             if (r_ecr(ppb_hi) & 0x01)
418                 return;
419             udelay(5);
420         }
421         printk("imm: ECP sync failed as data still present in FIFO.\n");
422     }
423 }
424
425 static int imm_byte_out(unsigned short base, const char *buffer, int len)
426 {
427     int i;
428
429     w_ctr(base, 0x4);           /* apparently a sane mode */
430     for (i = len >> 1; i; i--) {
431         w_dtr(base, *buffer++);
432         w_ctr(base, 0x5);       /* Drop STROBE low */
433         w_dtr(base, *buffer++);
434         w_ctr(base, 0x0);       /* STROBE high + INIT low */
435     }
436     w_ctr(base, 0x4);           /* apparently a sane mode */
437     return 1;                   /* All went well - we hope! */
438 }
439
440 static int imm_nibble_in(unsigned short base, char *buffer, int len)
441 {
442     unsigned char l;
443     int i;
444
445     /*
446      * The following is based on documented timing signals
447      */
448     w_ctr(base, 0x4);
449     for (i = len; i; i--) {
450         w_ctr(base, 0x6);
451         l = (r_str(base) & 0xf0) >> 4;
452         w_ctr(base, 0x5);
453         *buffer++ = (r_str(base) & 0xf0) | l;
454         w_ctr(base, 0x4);
455     }
456     return 1;                   /* All went well - we hope! */
457 }
458
459 static int imm_byte_in(unsigned short base, char *buffer, int len)
460 {
461     int i;
462
463     /*
464      * The following is based on documented timing signals
465      */
466     w_ctr(base, 0x4);
467     for (i = len; i; i--) {
468         w_ctr(base, 0x26);
469         *buffer++ = r_dtr(base);
470         w_ctr(base, 0x25);
471     }
472     return 1;                   /* All went well - we hope! */
473 }
474
475 static int imm_out(int host_no, char *buffer, int len)
476 {
477     int r;
478     unsigned short ppb = IMM_BASE(host_no);
479
480     r = imm_wait(host_no);
481
482     /*
483      * Make sure that:
484      * a) the SCSI bus is BUSY (device still listening)
485      * b) the device is listening
486      */
487     if ((r & 0x18) != 0x08) {
488         imm_fail(host_no, DID_ERROR);
489         printk("IMM: returned SCSI status %2x\n", r);
490         return 0;
491     }
492     switch (imm_hosts[host_no].mode) {
493     case IMM_EPP_32:
494     case IMM_EPP_16:
495     case IMM_EPP_8:
496         epp_reset(ppb);
497         w_ctr(ppb, 0x4);
498 #ifdef CONFIG_SCSI_IZIP_EPP16
499         if (!(((long) buffer | len) & 0x01))
500             outsw(ppb + 4, buffer, len >> 1);
501 #else
502         if (!(((long) buffer | len) & 0x03))
503             outsl(ppb + 4, buffer, len >> 2);
504 #endif
505         else
506             outsb(ppb + 4, buffer, len);
507         w_ctr(ppb, 0xc);
508         r = !(r_str(ppb) & 0x01);
509         w_ctr(ppb, 0xc);
510         ecp_sync(host_no);
511         break;
512
513     case IMM_NIBBLE:
514     case IMM_PS2:
515         /* 8 bit output, with a loop */
516         r = imm_byte_out(ppb, buffer, len);
517         break;
518
519     default:
520         printk("IMM: bug in imm_out()\n");
521         r = 0;
522     }
523     return r;
524 }
525
526 static int imm_in(int host_no, char *buffer, int len)
527 {
528     int r;
529     unsigned short ppb = IMM_BASE(host_no);
530
531     r = imm_wait(host_no);
532
533     /*
534      * Make sure that:
535      * a) the SCSI bus is BUSY (device still listening)
536      * b) the device is sending data
537      */
538     if ((r & 0x18) != 0x18) {
539         imm_fail(host_no, DID_ERROR);
540         return 0;
541     }
542     switch (imm_hosts[host_no].mode) {
543     case IMM_NIBBLE:
544         /* 4 bit input, with a loop */
545         r = imm_nibble_in(ppb, buffer, len);
546         w_ctr(ppb, 0xc);
547         break;
548
549     case IMM_PS2:
550         /* 8 bit input, with a loop */
551         r = imm_byte_in(ppb, buffer, len);
552         w_ctr(ppb, 0xc);
553         break;
554
555     case IMM_EPP_32:
556     case IMM_EPP_16:
557     case IMM_EPP_8:
558         epp_reset(ppb);
559         w_ctr(ppb, 0x24);
560 #ifdef CONFIG_SCSI_IZIP_EPP16
561         if (!(((long) buffer | len) & 0x01))
562             insw(ppb + 4, buffer, len >> 1);
563 #else
564         if (!(((long) buffer | len) & 0x03))
565             insl(ppb + 4, buffer, len >> 2);
566 #endif
567         else
568             insb(ppb + 4, buffer, len);
569         w_ctr(ppb, 0x2c);
570         r = !(r_str(ppb) & 0x01);
571         w_ctr(ppb, 0x2c);
572         ecp_sync(host_no);
573         break;
574
575     default:
576         printk("IMM: bug in imm_ins()\n");
577         r = 0;
578         break;
579     }
580     return r;
581 }
582
583 static int imm_cpp(unsigned short ppb, unsigned char b)
584 {
585     /*
586      * Comments on udelay values refer to the
587      * Command Packet Protocol (CPP) timing diagram.
588      */
589
590     unsigned char s1, s2, s3;
591     w_ctr(ppb, 0x0c);
592     udelay(2);                  /* 1 usec - infinite */
593     w_dtr(ppb, 0xaa);
594     udelay(10);                 /* 7 usec - infinite */
595     w_dtr(ppb, 0x55);
596     udelay(10);                 /* 7 usec - infinite */
597     w_dtr(ppb, 0x00);
598     udelay(10);                 /* 7 usec - infinite */
599     w_dtr(ppb, 0xff);
600     udelay(10);                 /* 7 usec - infinite */
601     s1 = r_str(ppb) & 0xb8;
602     w_dtr(ppb, 0x87);
603     udelay(10);                 /* 7 usec - infinite */
604     s2 = r_str(ppb) & 0xb8;
605     w_dtr(ppb, 0x78);
606     udelay(10);                 /* 7 usec - infinite */
607     s3 = r_str(ppb) & 0x38;
608     /*
609      * Values for b are:
610      * 0000 00aa    Assign address aa to current device
611      * 0010 00aa    Select device aa in EPP Winbond mode
612      * 0010 10aa    Select device aa in EPP mode
613      * 0011 xxxx    Deselect all devices
614      * 0110 00aa    Test device aa
615      * 1101 00aa    Select device aa in ECP mode
616      * 1110 00aa    Select device aa in Compatible mode
617      */
618     w_dtr(ppb, b);
619     udelay(2);                  /* 1 usec - infinite */
620     w_ctr(ppb, 0x0c);
621     udelay(10);                 /* 7 usec - infinite */
622     w_ctr(ppb, 0x0d);
623     udelay(2);                  /* 1 usec - infinite */
624     w_ctr(ppb, 0x0c);
625     udelay(10);                 /* 7 usec - infinite */
626     w_dtr(ppb, 0xff);
627     udelay(10);                 /* 7 usec - infinite */
628
629     /*
630      * The following table is electrical pin values.
631      * (BSY is inverted at the CTR register)
632      *
633      *       BSY  ACK  POut SEL  Fault
634      * S1    0    X    1    1    1
635      * S2    1    X    0    1    1
636      * S3    L    X    1    1    S
637      *
638      * L => Last device in chain
639      * S => Selected
640      *
641      * Observered values for S1,S2,S3 are:
642      * Disconnect => f8/58/78
643      * Connect    => f8/58/70
644      */
645     if ((s1 == 0xb8) && (s2 == 0x18) && (s3 == 0x30))
646         return 1;               /* Connected */
647     if ((s1 == 0xb8) && (s2 == 0x18) && (s3 == 0x38))
648         return 0;               /* Disconnected */
649
650     return -1;                  /* No device present */
651 }
652
653 static inline int imm_connect(int host_no, int flag)
654 {
655     unsigned short ppb = IMM_BASE(host_no);
656
657     imm_cpp(ppb, 0xe0);         /* Select device 0 in compatible mode */
658     imm_cpp(ppb, 0x30);         /* Disconnect all devices */
659
660     if ((imm_hosts[host_no].mode == IMM_EPP_8) ||
661         (imm_hosts[host_no].mode == IMM_EPP_16) ||
662         (imm_hosts[host_no].mode == IMM_EPP_32))
663         return imm_cpp(ppb, 0x28);      /* Select device 0 in EPP mode */
664     return imm_cpp(ppb, 0xe0);  /* Select device 0 in compatible mode */
665 }
666
667 static void imm_disconnect(int host_no)
668 {
669     unsigned short ppb = IMM_BASE(host_no);
670
671     imm_cpp(ppb, 0x30);         /* Disconnect all devices */
672 }
673
674 static int imm_select(int host_no, int target)
675 {
676     int k;
677     unsigned short ppb = IMM_BASE(host_no);
678
679     /*
680      * Firstly we want to make sure there is nothing
681      * holding onto the SCSI bus.
682      */
683     w_ctr(ppb, 0xc);
684
685     k = IMM_SELECT_TMO;
686     do {
687         k--;
688     } while ((r_str(ppb) & 0x08) && (k));
689
690     if (!k)
691         return 0;
692
693     /*
694      * Now assert the SCSI ID (HOST and TARGET) on the data bus
695      */
696     w_ctr(ppb, 0x4);
697     w_dtr(ppb, 0x80 | (1 << target));
698     udelay(1);
699
700     /*
701      * Deassert SELIN first followed by STROBE
702      */
703     w_ctr(ppb, 0xc);
704     w_ctr(ppb, 0xd);
705
706     /*
707      * ACK should drop low while SELIN is deasserted.
708      * FAULT should drop low when the SCSI device latches the bus.
709      */
710     k = IMM_SELECT_TMO;
711     do {
712         k--;
713     }
714     while (!(r_str(ppb) & 0x08) && (k));
715
716     /*
717      * Place the interface back into a sane state (status mode)
718      */
719     w_ctr(ppb, 0xc);
720     return (k) ? 1 : 0;
721 }
722
723 static int imm_init(int host_no)
724 {
725     int retv;
726
727 #if defined(CONFIG_PARPORT) || defined(CONFIG_PARPORT_MODULE)
728     if (imm_pb_claim(host_no))
729         while (imm_hosts[host_no].p_busy)
730             schedule();         /* We can safe schedule here */
731 #endif
732     retv = imm_connect(host_no, 0);
733
734     if (retv == 1) {
735         imm_reset_pulse(IMM_BASE(host_no));
736         udelay(1000);           /* Delay to allow devices to settle */
737         imm_disconnect(host_no);
738         udelay(1000);           /* Another delay to allow devices to settle */
739         retv = device_check(host_no);
740         imm_pb_release(host_no);
741         return retv;
742     }
743     imm_pb_release(host_no);
744     return 1;
745 }
746
747 static inline int imm_send_command(Scsi_Cmnd * cmd)
748 {
749     int host_no = cmd->host->unique_id;
750     int k;
751
752     /* NOTE: IMM uses byte pairs */
753     for (k = 0; k < cmd->cmd_len; k += 2)
754         if (!imm_out(host_no, &cmd->cmnd[k], 2))
755             return 0;
756     return 1;
757 }
758
759 /*
760  * The bulk flag enables some optimisations in the data transfer loops,
761  * it should be true for any command that transfers data in integral
762  * numbers of sectors.
763  * 
764  * The driver appears to remain stable if we speed up the parallel port
765  * i/o in this function, but not elsewhere.
766  */
767 static int imm_completion(Scsi_Cmnd * cmd)
768 {
769     /* Return codes:
770      * -1     Error
771      *  0     Told to schedule
772      *  1     Finished data transfer
773      */
774     int host_no = cmd->host->unique_id;
775     unsigned short ppb = IMM_BASE(host_no);
776     unsigned long start_jiffies = jiffies;
777
778     unsigned char r, v;
779     int fast, bulk, status;
780
781     v = cmd->cmnd[0];
782     bulk = ((v == READ_6) ||
783             (v == READ_10) ||
784             (v == WRITE_6) ||
785             (v == WRITE_10));
786
787     /*
788      * We only get here if the drive is ready to comunicate,
789      * hence no need for a full imm_wait.
790      */
791     w_ctr(ppb, 0x0c);
792     r = (r_str(ppb) & 0xb8);
793
794     /*
795      * while (device is not ready to send status byte)
796      *     loop;
797      */
798     while (r != (unsigned char) 0xb8) {
799         /*
800          * If we have been running for more than a full timer tick
801          * then take a rest.
802          */
803         if (time_after(jiffies, start_jiffies + 1))
804             return 0;
805
806         /*
807          * FAIL if:
808          * a) Drive status is screwy (!ready && !present)
809          * b) Drive is requesting/sending more data than expected
810          */
811         if (((r & 0x88) != 0x88) || (cmd->SCp.this_residual <= 0)) {
812             imm_fail(host_no, DID_ERROR);
813             return -1;          /* ERROR_RETURN */
814         }
815         /* determine if we should use burst I/O */
816         if (imm_hosts[host_no].rd == 0) {
817             fast = (bulk && (cmd->SCp.this_residual >= IMM_BURST_SIZE)) ? IMM_BURST_SIZE : 2;
818             status = imm_out(host_no, cmd->SCp.ptr, fast);
819         } else {
820             fast = (bulk && (cmd->SCp.this_residual >= IMM_BURST_SIZE)) ? IMM_BURST_SIZE : 1;
821             status = imm_in(host_no, cmd->SCp.ptr, fast);
822         }
823
824         cmd->SCp.ptr += fast;
825         cmd->SCp.this_residual -= fast;
826
827         if (!status) {
828             imm_fail(host_no, DID_BUS_BUSY);
829             return -1;          /* ERROR_RETURN */
830         }
831         if (cmd->SCp.buffer && !cmd->SCp.this_residual) {
832             /* if scatter/gather, advance to the next segment */
833             if (cmd->SCp.buffers_residual--) {
834                 cmd->SCp.buffer++;
835                 cmd->SCp.this_residual = cmd->SCp.buffer->length;
836                 cmd->SCp.ptr = cmd->SCp.buffer->address;
837
838                 /*
839                  * Make sure that we transfer even number of bytes
840                  * otherwise it makes imm_byte_out() messy.
841                  */
842                 if (cmd->SCp.this_residual & 0x01)
843                     cmd->SCp.this_residual++;
844             }
845         }
846         /* Now check to see if the drive is ready to comunicate */
847         w_ctr(ppb, 0x0c);
848         r = (r_str(ppb) & 0xb8);
849
850         /* If not, drop back down to the scheduler and wait a timer tick */
851         if (!(r & 0x80))
852             return 0;
853     }
854     return 1;                   /* FINISH_RETURN */
855 }
856
857 /* deprecated synchronous interface */
858 int imm_command(Scsi_Cmnd * cmd)
859 {
860     static int first_pass = 1;
861     int host_no = cmd->host->unique_id;
862
863     if (first_pass) {
864         printk("imm: using non-queuing interface\n");
865         first_pass = 0;
866     }
867     if (imm_hosts[host_no].cur_cmd) {
868         printk("IMM: bug in imm_command\n");
869         return 0;
870     }
871     imm_hosts[host_no].failed = 0;
872     imm_hosts[host_no].jstart = jiffies;
873     imm_hosts[host_no].cur_cmd = cmd;
874     cmd->result = DID_ERROR << 16;      /* default return code */
875     cmd->SCp.phase = 0;
876
877     imm_pb_claim(host_no);
878
879     while (imm_engine(&imm_hosts[host_no], cmd))
880         schedule();
881
882     if (cmd->SCp.phase)         /* Only disconnect if we have connected */
883         imm_disconnect(cmd->host->unique_id);
884
885     imm_pb_release(host_no);
886     imm_hosts[host_no].cur_cmd = 0;
887     return cmd->result;
888 }
889
890 /*
891  * Since the IMM itself doesn't generate interrupts, we use
892  * the scheduler's task queue to generate a stream of call-backs and
893  * complete the request when the drive is ready.
894  */
895 static void imm_interrupt(void *data)
896 {
897     imm_struct *tmp = (imm_struct *) data;
898     Scsi_Cmnd *cmd = tmp->cur_cmd;
899     unsigned long flags;
900
901     if (!cmd) {
902         printk("IMM: bug in imm_interrupt\n");
903         return;
904     }
905     if (imm_engine(tmp, cmd)) {
906         tmp->imm_tq.data = (void *) tmp;
907         tmp->imm_tq.sync = 0;
908         queue_task(&tmp->imm_tq, &tq_timer);
909         return;
910     }
911     /* Command must of completed hence it is safe to let go... */
912 #if IMM_DEBUG > 0
913     switch ((cmd->result >> 16) & 0xff) {
914     case DID_OK:
915         break;
916     case DID_NO_CONNECT:
917         printk("imm: no device at SCSI ID %i\n", cmd->target);
918         break;
919     case DID_BUS_BUSY:
920         printk("imm: BUS BUSY - EPP timeout detected\n");
921         break;
922     case DID_TIME_OUT:
923         printk("imm: unknown timeout\n");
924         break;
925     case DID_ABORT:
926         printk("imm: told to abort\n");
927         break;
928     case DID_PARITY:
929         printk("imm: parity error (???)\n");
930         break;
931     case DID_ERROR:
932         printk("imm: internal driver error\n");
933         break;
934     case DID_RESET:
935         printk("imm: told to reset device\n");
936         break;
937     case DID_BAD_INTR:
938         printk("imm: bad interrupt (???)\n");
939         break;
940     default:
941         printk("imm: bad return code (%02x)\n", (cmd->result >> 16) & 0xff);
942     }
943 #endif
944
945     if (cmd->SCp.phase > 1)
946         imm_disconnect(cmd->host->unique_id);
947     if (cmd->SCp.phase > 0)
948         imm_pb_release(cmd->host->unique_id);
949
950     spin_lock_irqsave(&io_request_lock, flags);
951     tmp->cur_cmd = 0;
952     cmd->scsi_done(cmd);
953     spin_unlock_irqrestore(&io_request_lock, flags);
954     return;
955 }
956
957 static int imm_engine(imm_struct * tmp, Scsi_Cmnd * cmd)
958 {
959     int host_no = cmd->host->unique_id;
960     unsigned short ppb = IMM_BASE(host_no);
961     unsigned char l = 0, h = 0;
962     int retv, x;
963
964     /* First check for any errors that may of occurred
965      * Here we check for internal errors
966      */
967     if (tmp->failed)
968         return 0;
969
970     switch (cmd->SCp.phase) {
971     case 0:                     /* Phase 0 - Waiting for parport */
972         if ((jiffies - tmp->jstart) > HZ) {
973             /*
974              * We waited more than a second
975              * for parport to call us
976              */
977             imm_fail(host_no, DID_BUS_BUSY);
978             return 0;
979         }
980         return 1;               /* wait until imm_wakeup claims parport */
981         /* Phase 1 - Connected */
982     case 1:
983         imm_connect(host_no, CONNECT_EPP_MAYBE);
984         cmd->SCp.phase++;
985
986         /* Phase 2 - We are now talking to the scsi bus */
987     case 2:
988         if (!imm_select(host_no, cmd->target)) {
989             imm_fail(host_no, DID_NO_CONNECT);
990             return 0;
991         }
992         cmd->SCp.phase++;
993
994         /* Phase 3 - Ready to accept a command */
995     case 3:
996         w_ctr(ppb, 0x0c);
997         if (!(r_str(ppb) & 0x80))
998             return 1;
999
1000         if (!imm_send_command(cmd))
1001             return 0;
1002         cmd->SCp.phase++;
1003
1004         /* Phase 4 - Setup scatter/gather buffers */
1005     case 4:
1006         if (cmd->use_sg) {
1007             /* if many buffers are available, start filling the first */
1008             cmd->SCp.buffer = (struct scatterlist *) cmd->request_buffer;
1009             cmd->SCp.this_residual = cmd->SCp.buffer->length;
1010             cmd->SCp.ptr = cmd->SCp.buffer->address;
1011         } else {
1012             /* else fill the only available buffer */
1013             cmd->SCp.buffer = NULL;
1014             cmd->SCp.this_residual = cmd->request_bufflen;
1015             cmd->SCp.ptr = cmd->request_buffer;
1016         }
1017         cmd->SCp.buffers_residual = cmd->use_sg;
1018         cmd->SCp.phase++;
1019         if (cmd->SCp.this_residual & 0x01)
1020             cmd->SCp.this_residual++;
1021         /* Phase 5 - Pre-Data transfer stage */
1022     case 5:
1023         /* Spin lock for BUSY */
1024         w_ctr(ppb, 0x0c);
1025         if (!(r_str(ppb) & 0x80))
1026             return 1;
1027
1028         /* Require negotiation for read requests */
1029         x = (r_str(ppb) & 0xb8);
1030         tmp->rd = (x & 0x10) ? 1 : 0;
1031         tmp->dp = (x & 0x20) ? 0 : 1;
1032
1033         if ((tmp->dp) && (tmp->rd))
1034             if (imm_negotiate(tmp))
1035                 return 0;
1036         cmd->SCp.phase++;
1037
1038         /* Phase 6 - Data transfer stage */
1039     case 6:
1040         /* Spin lock for BUSY */
1041         w_ctr(ppb, 0x0c);
1042         if (!(r_str(ppb) & 0x80))
1043             return 1;
1044
1045         if (tmp->dp) {
1046             retv = imm_completion(cmd);
1047             if (retv == -1)
1048                 return 0;
1049             if (retv == 0)
1050                 return 1;
1051         }
1052         cmd->SCp.phase++;
1053
1054         /* Phase 7 - Post data transfer stage */
1055     case 7:
1056         if ((tmp->dp) && (tmp->rd)) {
1057             if ((tmp->mode == IMM_NIBBLE) || (tmp->mode == IMM_PS2)) {
1058                 w_ctr(ppb, 0x4);
1059                 w_ctr(ppb, 0xc);
1060                 w_ctr(ppb, 0xe);
1061                 w_ctr(ppb, 0x4);
1062             }
1063         }
1064         cmd->SCp.phase++;
1065
1066         /* Phase 8 - Read status/message */
1067     case 8:
1068         /* Check for data overrun */
1069         if (imm_wait(host_no) != (unsigned char) 0xb8) {
1070             imm_fail(host_no, DID_ERROR);
1071             return 0;
1072         }
1073         if (imm_negotiate(tmp))
1074             return 0;
1075         if (imm_in(host_no, &l, 1)) {   /* read status byte */
1076             /* Check for optional message byte */
1077             if (imm_wait(host_no) == (unsigned char) 0xb8)
1078                 imm_in(host_no, &h, 1);
1079             cmd->result = (DID_OK << 16) + (l & STATUS_MASK);
1080         }
1081         if ((tmp->mode == IMM_NIBBLE) || (tmp->mode == IMM_PS2)) {
1082             w_ctr(ppb, 0x4);
1083             w_ctr(ppb, 0xc);
1084             w_ctr(ppb, 0xe);
1085             w_ctr(ppb, 0x4);
1086         }
1087         return 0;               /* Finished */
1088         break;
1089
1090     default:
1091         printk("imm: Invalid scsi phase\n");
1092     }
1093     return 0;
1094 }
1095
1096 int imm_queuecommand(Scsi_Cmnd * cmd, void (*done) (Scsi_Cmnd *))
1097 {
1098     int host_no = cmd->host->unique_id;
1099
1100     if (imm_hosts[host_no].cur_cmd) {
1101         printk("IMM: bug in imm_queuecommand\n");
1102         return 0;
1103     }
1104     imm_hosts[host_no].failed = 0;
1105     imm_hosts[host_no].jstart = jiffies;
1106     imm_hosts[host_no].cur_cmd = cmd;
1107     cmd->scsi_done = done;
1108     cmd->result = DID_ERROR << 16;      /* default return code */
1109     cmd->SCp.phase = 0;         /* bus free */
1110
1111     imm_pb_claim(host_no);
1112
1113     imm_hosts[host_no].imm_tq.data = imm_hosts + host_no;
1114     imm_hosts[host_no].imm_tq.sync = 0;
1115     queue_task(&imm_hosts[host_no].imm_tq, &tq_immediate);
1116     mark_bh(IMMEDIATE_BH);
1117
1118     return 0;
1119 }
1120
1121 /*
1122  * Apparently the the disk->capacity attribute is off by 1 sector 
1123  * for all disk drives.  We add the one here, but it should really
1124  * be done in sd.c.  Even if it gets fixed there, this will still
1125  * work.
1126  */
1127 int imm_biosparam(Disk * disk, kdev_t dev, int ip[])
1128 {
1129     ip[0] = 0x40;
1130     ip[1] = 0x20;
1131     ip[2] = (disk->capacity + 1) / (ip[0] * ip[1]);
1132     if (ip[2] > 1024) {
1133         ip[0] = 0xff;
1134         ip[1] = 0x3f;
1135         ip[2] = (disk->capacity + 1) / (ip[0] * ip[1]);
1136     }
1137     return 0;
1138 }
1139
1140 int imm_abort(Scsi_Cmnd * cmd)
1141 {
1142     int host_no = cmd->host->unique_id;
1143     /*
1144      * There is no method for aborting commands since Iomega
1145      * have tied the SCSI_MESSAGE line high in the interface
1146      */
1147
1148     switch (cmd->SCp.phase) {
1149     case 0:                     /* Do not have access to parport */
1150     case 1:                     /* Have not connected to interface */
1151         imm_hosts[host_no].cur_cmd = NULL;      /* Forget the problem */
1152         return SUCCESS;
1153         break;
1154     default:                    /* SCSI command sent, can not abort */
1155         return FAILED;
1156         break;
1157     }
1158 }
1159
1160 void imm_reset_pulse(unsigned int base)
1161 {
1162     w_ctr(base, 0x04);
1163     w_dtr(base, 0x40);
1164     udelay(1);
1165     w_ctr(base, 0x0c);
1166     w_ctr(base, 0x0d);
1167     udelay(50);
1168     w_ctr(base, 0x0c);
1169     w_ctr(base, 0x04);
1170 }
1171
1172 int imm_reset(Scsi_Cmnd * cmd)
1173 {
1174     int host_no = cmd->host->unique_id;
1175
1176     if (cmd->SCp.phase)
1177         imm_disconnect(host_no);
1178     imm_hosts[host_no].cur_cmd = NULL;  /* Forget the problem */
1179
1180     imm_connect(host_no, CONNECT_NORMAL);
1181     imm_reset_pulse(IMM_BASE(host_no));
1182     udelay(1000);               /* device settle delay */
1183     imm_disconnect(host_no);
1184     udelay(1000);               /* device settle delay */
1185     return SUCCESS;
1186 }
1187
1188 static int device_check(int host_no)
1189 {
1190     /* This routine looks for a device and then attempts to use EPP
1191        to send a command. If all goes as planned then EPP is available. */
1192
1193     static char cmd[6] =
1194     {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
1195     int loop, old_mode, status, k, ppb = IMM_BASE(host_no);
1196     unsigned char l;
1197
1198     old_mode = imm_hosts[host_no].mode;
1199     for (loop = 0; loop < 8; loop++) {
1200         /* Attempt to use EPP for Test Unit Ready */
1201         if ((ppb & 0x0007) == 0x0000)
1202             imm_hosts[host_no].mode = IMM_EPP_32;
1203
1204       second_pass:
1205         imm_connect(host_no, CONNECT_EPP_MAYBE);
1206         /* Select SCSI device */
1207         if (!imm_select(host_no, loop)) {
1208             imm_disconnect(host_no);
1209             continue;
1210         }
1211         printk("imm: Found device at ID %i, Attempting to use %s\n", loop,
1212                IMM_MODE_STRING[imm_hosts[host_no].mode]);
1213
1214         /* Send SCSI command */
1215         status = 1;
1216         w_ctr(ppb, 0x0c);
1217         for (l = 0; (l < 3) && (status); l++)
1218             status = imm_out(host_no, &cmd[l << 1], 2);
1219
1220         if (!status) {
1221             imm_disconnect(host_no);
1222             imm_connect(host_no, CONNECT_EPP_MAYBE);
1223             imm_reset_pulse(IMM_BASE(host_no));
1224             udelay(1000);
1225             imm_disconnect(host_no);
1226             udelay(1000);
1227             if (imm_hosts[host_no].mode == IMM_EPP_32) {
1228                 imm_hosts[host_no].mode = old_mode;
1229                 goto second_pass;
1230             }
1231             printk("imm: Unable to establish communication, aborting driver load.\n");
1232             return 1;
1233         }
1234         w_ctr(ppb, 0x0c);
1235
1236         k = 1000000;            /* 1 Second */
1237         do {
1238             l = r_str(ppb);
1239             k--;
1240             udelay(1);
1241         } while (!(l & 0x80) && (k));
1242
1243         l &= 0xb8;
1244
1245         if (l != 0xb8) {
1246             imm_disconnect(host_no);
1247             imm_connect(host_no, CONNECT_EPP_MAYBE);
1248             imm_reset_pulse(IMM_BASE(host_no));
1249             udelay(1000);
1250             imm_disconnect(host_no);
1251             udelay(1000);
1252             if (imm_hosts[host_no].mode == IMM_EPP_32) {
1253                 imm_hosts[host_no].mode = old_mode;
1254                 goto second_pass;
1255             }
1256             printk("imm: Unable to establish communication, aborting driver load.\n");
1257             return 1;
1258         }
1259         imm_disconnect(host_no);
1260         printk("imm: Communication established at 0x%x with ID %i using %s\n", ppb, loop,
1261                IMM_MODE_STRING[imm_hosts[host_no].mode]);
1262         imm_connect(host_no, CONNECT_EPP_MAYBE);
1263         imm_reset_pulse(IMM_BASE(host_no));
1264         udelay(1000);
1265         imm_disconnect(host_no);
1266         udelay(1000);
1267         return 0;
1268     }
1269     printk("imm: No devices found, aborting driver load.\n");
1270     return 1;
1271 }