drivers/scsi/ppa.h

   1 /*  Driver for the PPA3 parallel port SCSI HBA embedded in
   2  * the Iomega ZIP drive
   3  *
   4  * (c) 1996     Grant R. Guenther  grant@torque.net
   5  *              David Campbell     campbell@torque.net
   6  *
   7  *      All comments to David.
   8  */
   9
  10 #ifndef _PPA_H
  11 #define _PPA_H
  12
  13 #define   PPA_VERSION   "2.07 (for Linux 2.4.x)"
  14
  15 /*
  16  * this driver has been hacked by Matteo Frigo (athena@theory.lcs.mit.edu)
  17  * to support EPP and scatter-gather.                        [0.26-athena]
  18  *
  19  * additional hacks by David Campbell
  20  * in response to this driver "mis-behaving" on his machine.
  21  *      Fixed EPP to handle "software" changing of EPP port data direction.
  22  *      Chased down EPP timeouts
  23  *      Made this driver "kernel version friendly"           [0.28-athena]
  24  *
  25  * [ Stuff removed ]
  26  *
  27  * Corrected ppa.h for 2.1.x kernels (>=2.1.85)
  28  * Modified "Nat Semi Kludge" for extended chipsets
  29  *                                                      [1.41]
  30  *
  31  * Fixed id_probe for EPP 1.9 chipsets (misdetected as EPP 1.7)
  32  *                                                      [1.42]
  33  *
  34  * Development solely for 2.1.x kernels from now on!
  35  *                                                      [2.00]
  36  *
  37  * Hack and slash at the init code (EPP device check routine)
  38  * Added INSANE option.
  39  *                                                      [2.01]
  40  *
  41  * Patch applied to sync against the 2.1.x kernel code
  42  * Included qboot_zip.sh
  43  *                                                      [2.02]
  44  *
  45  * Cleaned up the mess left by someone else trying to fix the
  46  * asm section to keep egcc happy. The asm section no longer
  47  * exists, the nibble code is *almost* as fast as the asm code
  48  * providing it is compiled with egcc.
  49  *
  50  * Other clean ups include the follow changes:
  51  *    CONFIG_SCSI_PPA_HAVE_PEDANTIC => CONFIG_SCSI_IZIP_EPP16
  52  *    added CONFIG_SCSI_IZIP_SLOW_CTR option
  53  *                                                      [2.03]
  54  *
  55  * Use ppa_wait() to check for ready AND connected status bits
  56  * Add ppa_wait() calls to ppa_completion()
  57  *  by Peter Cherriman <pjc@ecs.soton.ac.uk> and
  58  *     Tim Waugh <twaugh@redhat.com>
  59  *                                                      [2.04]
  60  *
  61  * Fix kernel panic on scsi timeout, 2000-08-18         [2.05]
  62  *
  63  * Avoid io_request_lock problems.
  64  * John Cavan <johncavan@home.com>                      [2.06]
  65  *
  66  * Busy wait for connected status bit in ppa_completion()
  67  *  in order to cope with some hardware that has this bit low
  68  *  for short periods of time.
  69  * Add udelay() to ppa_select()
  70  *  by Peter Cherriman <pjc@ecs.soton.ac.uk> and
  71  *     Oleg Makarenko <omakarenko@cyberplat.ru>
  72  *                                                      [2.07]
  73  */
  74 /* ------ END OF USER CONFIGURABLE PARAMETERS ----- */
  75
  76 #ifdef PPA_CODE
  77 #include  <linux/config.h>
  78 #include  <linux/stddef.h>
  79 #include  <linux/module.h>
  80 #include  <linux/kernel.h>
  81 #include  <linux/tqueue.h>
  82 #include  <linux/ioport.h>
  83 #include  <linux/delay.h>
  84 #include  <linux/proc_fs.h>
  85 #include  <linux/stat.h>
  86 #include  <linux/blk.h>
  87 #include  <linux/sched.h>
  88 #include  <linux/interrupt.h>
  89
  90 #include  <asm/io.h>
  91 #include  "sd.h"
  92 #include  "hosts.h"
  93 /* batteries not included :-) */
  94
  95 /*
  96  * modes in which the driver can operate
  97  */
  98 #define   PPA_AUTODETECT        0       /* Autodetect mode                */
  99 #define   PPA_NIBBLE            1       /* work in standard 4 bit mode    */
 100 #define   PPA_PS2               2       /* PS/2 byte mode         */
 101 #define   PPA_EPP_8             3       /* EPP mode, 8 bit                */
 102 #define   PPA_EPP_16            4       /* EPP mode, 16 bit               */
 103 #define   PPA_EPP_32            5       /* EPP mode, 32 bit               */
 104 #define   PPA_UNKNOWN           6       /* Just in case...                */
 105
 106 static char *PPA_MODE_STRING[] =
 107 {
 108     "Autodetect",
 109     "SPP",
 110     "PS/2",
 111     "EPP 8 bit",
 112     "EPP 16 bit",
 113 #ifdef CONFIG_SCSI_IZIP_EPP16
 114     "EPP 16 bit",
 115 #else
 116     "EPP 32 bit",
 117 #endif
 118     "Unknown"};
 119
 120 /* This is a global option */
 121 int ppa_sg = SG_ALL;            /* enable/disable scatter-gather. */
 122
 123 /* other options */
 124 #define PPA_CAN_QUEUE   1       /* use "queueing" interface */
 125 #define PPA_BURST_SIZE  512     /* data burst size */
 126 #define PPA_SELECT_TMO  5000    /* how long to wait for target ? */
 127 #define PPA_SPIN_TMO    50000   /* ppa_wait loop limiter */
 128 #define PPA_RECON_TMO   500     /* scsi reconnection loop limiter */
 129 #define PPA_DEBUG       0       /* debugging option */
 130 #define IN_EPP_MODE(x) (x == PPA_EPP_8 || x == PPA_EPP_16 || x == PPA_EPP_32)
 131
 132 /* args to ppa_connect */
 133 #define CONNECT_EPP_MAYBE 1
 134 #define CONNECT_NORMAL  0
 135
 136 #define r_dtr(x)        (unsigned char)inb((x))
 137 #define r_str(x)        (unsigned char)inb((x)+1)
 138 #define r_ctr(x)        (unsigned char)inb((x)+2)
 139 #define r_epp(x)        (unsigned char)inb((x)+4)
 140 #define r_fifo(x)       (unsigned char)inb((x)) /* x must be base_hi */
 141                                         /* On PCI is base+0x400 != base_hi */
 142 #define r_ecr(x)        (unsigned char)inb((x)+0x2) /* x must be base_hi */
 143
 144 #define w_dtr(x,y)      outb(y, (x))
 145 #define w_str(x,y)      outb(y, (x)+1)
 146 #define w_epp(x,y)      outb(y, (x)+4)
 147 #define w_fifo(x,y)     outb(y, (x))    /* x must be base_hi */
 148 #define w_ecr(x,y)      outb(y, (x)+0x2)/* x must be base_hi */
 149
 150 #ifdef CONFIG_SCSI_IZIP_SLOW_CTR
 151 #define w_ctr(x,y)      outb_p(y, (x)+2)
 152 #else
 153 #define w_ctr(x,y)      outb(y, (x)+2)
 154 #endif
 155
 156 static int ppa_engine(ppa_struct *, Scsi_Cmnd *);
 157 static int ppa_in(int, char *, int);
 158 static int ppa_init(int);
 159 static void ppa_interrupt(void *);
 160 static int ppa_out(int, char *, int);
 161
 162 #else
 163 #define ppa_release 0
 164 #endif
 165
 166 int ppa_detect(Scsi_Host_Template *);
 167 const char *ppa_info(struct Scsi_Host *);
 168 int ppa_command(Scsi_Cmnd *);
 169 int ppa_queuecommand(Scsi_Cmnd *, void (*done) (Scsi_Cmnd *));
 170 int ppa_abort(Scsi_Cmnd *);
 171 int ppa_reset(Scsi_Cmnd *);
 172 int ppa_proc_info(char *, char **, off_t, int, int, int);
 173 int ppa_biosparam(Disk *, kdev_t, int *);
 174
 175 #define PPA {   proc_name:                      "ppa",          \
 176                 proc_info:                      ppa_proc_info,          \
 177                 name:                           "Iomega VPI0 (ppa) interface",\
 178                 detect:                         ppa_detect,             \
 179                 release:                        ppa_release,            \
 180                 command:                        ppa_command,            \
 181                 queuecommand:                   ppa_queuecommand,       \
 182                 eh_abort_handler:               ppa_abort,              \
 183                 eh_device_reset_handler:        NULL,                   \
 184                 eh_bus_reset_handler:           ppa_reset,              \
 185                 eh_host_reset_handler:          ppa_reset,              \
 186                 use_new_eh_code:                1,                      \
 187                 bios_param:                     ppa_biosparam,          \
 188                 this_id:                        -1,                     \
 189                 sg_tablesize:                   SG_ALL,                 \
 190                 cmd_per_lun:                    1,                      \
 191                 use_clustering:                 ENABLE_CLUSTERING       \
 192 }
 193 #endif                          /* _PPA_H */