drivers/scsi/ini9100u.h

   1 /**************************************************************************
   2  * Initio 9100 device driver for Linux.
   3  *
   4  * Copyright (c) 1994-1998 Initio Corporation
   5  * All rights reserved.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * --------------------------------------------------------------------------
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the above copyright
  27  *    notice, this list of conditions, and the following disclaimer,
  28  *    without modification, immediately at the beginning of the file.
  29  * 2. Redistributions in binary form must reproduce the above copyright
  30  *    notice, this list of conditions and the following disclaimer in the
  31  *    documentation and/or other materials provided with the distribution.
  32  * 3. The name of the author may not be used to endorse or promote products
  33  *    derived from this software without specific prior written permission.
  34  *
  35  * Where this Software is combined with software released under the terms of
  36  * the GNU Public License ("GPL") and the terms of the GPL would require the
  37  * combined work to also be released under the terms of the GPL, the terms
  38  * and conditions of this License will apply in addition to those of the
  39  * GPL with the exception of any terms or conditions of this License that
  40  * conflict with, or are expressly prohibited by, the GPL.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  46  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *************************************************************************
  55  *
  56  * Module: ini9100u.h
  57  * Description: INI-9100U/UW LINUX device driver header
  58  * Revision History:
  59  * 06/18/96 Harry Chen, Initial Version 1.00A (Beta)
  60  * 06/23/98 hc  - v1.01k
  61  *              - Get it work for kernel version >= 2.1.75
  62  * 12/09/98 bv  - v1.03a
  63  *              - Removed unused code
  64  * 12/13/98 bv  - v1.03b
  65  *              - Add spinlocks to HCS structure.
  66 *******************************************************************************/
  67
  68 #ifndef CVT_LINUX_VERSION
  69 #define CVT_LINUX_VERSION(V,P,S)        (((V) * 65536) + ((P) * 256) + (S))
  70 #endif
  71
  72 #ifndef LINUX_VERSION_CODE
  73 #include <linux/version.h>
  74 #endif
  75
  76 #include "sd.h"
  77
  78 extern int i91u_detect(Scsi_Host_Template *);
  79 extern int i91u_command(Scsi_Cmnd *);
  80 extern int i91u_queue(Scsi_Cmnd *, void (*done) (Scsi_Cmnd *));
  81 extern int i91u_abort(Scsi_Cmnd *);
  82 extern int i91u_reset(Scsi_Cmnd *, unsigned int);
  83
  84 #if LINUX_VERSION_CODE >= CVT_LINUX_VERSION(1, 3, 0)
  85 extern int i91u_biosparam(Scsi_Disk *, kdev_t, int *);  /*for linux v2.0 */
  86 extern struct proc_dir_entry proc_scsi_ini9100u;
  87 #else
  88 extern int i91u_biosparam(Disk *, int, int *);  /*for linux v1.13 */
  89 #endif
  90
  91 #define i91u_REVID "Initio INI-9X00U/UW SCSI device driver; Revision: 1.03d"
  92
  93 #if LINUX_VERSION_CODE < CVT_LINUX_VERSION(1, 3, 0)
  94 #define INI9100U        { \
  95                 NULL, \
  96                 NULL, \
  97                 i91u_REVID, \
  98                 i91u_detect, \
  99                 NULL, \
 100                 NULL, \
 101                 i91u_command, \
 102                 i91u_queue, \
 103                 i91u_abort, \
 104                 i91u_reset, \
 105                 NULL, \
 106                 i91u_biosparam, \
 107                 1, \
 108                 7, \
 109                 SG_ALL, \
 110                 1, \
 111                 0, \
 112                 0, \
 113                 ENABLE_CLUSTERING \
 114 }
 115 #else
 116
 117 #if LINUX_VERSION_CODE < CVT_LINUX_VERSION(2, 1, 75)
 118 #define INI9100U        { \
 119                 NULL, \
 120                 NULL, \
 121                 &proc_scsi_ini9100u, \
 122                 NULL, \
 123                 i91u_REVID, \
 124                 i91u_detect, \
 125                 NULL, \
 126                 NULL, \
 127                 i91u_command, \
 128                 i91u_queue, \
 129                 i91u_abort, \
 130                 i91u_reset, \
 131                 NULL, \
 132                 i91u_biosparam, \
 133                 1, \
 134                 7, \
 135                 SG_ALL, \
 136                 1, \
 137                 0, \
 138                 0, \
 139                 ENABLE_CLUSTERING \
 140 }
 141 #else                           /* Version >= 2.1.75 */
 142 #define INI9100U        { \
 143         next:           NULL,                                           \
 144         module:         NULL,                                           \
 145         proc_dir:       &proc_scsi_ini9100u, \
 146         proc_info:      NULL,                           \
 147         name:           i91u_REVID, \
 148         detect:         i91u_detect, \
 149         release:        NULL, \
 150         info:           NULL,                                   \
 151         command:        i91u_command, \
 152         queuecommand:   i91u_queue, \
 153         eh_strategy_handler: NULL, \
 154         eh_abort_handler: NULL, \
 155         eh_device_reset_handler: NULL, \
 156         eh_bus_reset_handler: NULL, \
 157         eh_host_reset_handler: NULL, \
 158         abort:          i91u_abort, \
 159         reset:          i91u_reset, \
 160         slave_attach:   NULL, \
 161         bios_param:     i91u_biosparam, \
 162         can_queue:      1, \
 163         this_id:        1, \
 164         sg_tablesize:   SG_ALL, \
 165         cmd_per_lun:    1, \
 166         present:        0, \
 167         unchecked_isa_dma: 0, \
 168         use_clustering: ENABLE_CLUSTERING, \
 169  use_new_eh_code: 0 \
 170 }
 171 #endif
 172 #endif
 173
 174
 175 #define VIRT_TO_BUS(i)  (unsigned int) virt_to_bus((void *)(i))
 176 #define ULONG   unsigned long
 177 #define USHORT  unsigned short
 178 #define UCHAR   unsigned char
 179 #define BYTE    unsigned char
 180 #define WORD    unsigned short
 181 #define DWORD   unsigned long
 182 #define UBYTE   unsigned char
 183 #define UWORD   unsigned short
 184 #define UDWORD  unsigned long
 185 #ifdef ALPHA
 186 #define U32   unsigned int
 187 #else
 188 #define U32   unsigned long
 189 #endif
 190
 191 #ifndef NULL
 192 #define NULL     0              /* zero          */
 193 #endif
 194 #ifndef TRUE
 195 #define TRUE     (1)            /* boolean true  */
 196 #endif
 197 #ifndef FALSE
 198 #define FALSE    (0)            /* boolean false */
 199 #endif
 200 #ifndef FAILURE
 201 #define FAILURE  (-1)
 202 #endif
 203
 204 #define i91u_MAXQUEUE           2
 205 #define TOTAL_SG_ENTRY          32
 206 #define MAX_TARGETS             16
 207 #define SENSE_SIZE              14
 208
 209 #define INI_VENDOR_ID   0x1101  /* Initio's PCI vendor ID       */
 210 #define DMX_VENDOR_ID   0x134a  /* Domex's PCI vendor ID       */
 211 #define I950_DEVICE_ID  0x9500  /* Initio's inic-950 product ID   */
 212 #define I940_DEVICE_ID  0x9400  /* Initio's inic-940 product ID   */
 213 #define I935_DEVICE_ID  0x9401  /* Initio's inic-935 product ID   */
 214 #define I920_DEVICE_ID  0x0002  /* Initio's other product ID      */
 215
 216 /************************************************************************/
 217 /*              Scatter-Gather Element Structure                        */
 218 /************************************************************************/
 219 typedef struct SG_Struc {
 220         U32 SG_Ptr;             /* Data Pointer */
 221         U32 SG_Len;             /* Data Length */
 222 } SG;
 223
 224 /***********************************************************************
 225                 SCSI Control Block
 226 ************************************************************************/
 227 typedef struct Scsi_Ctrl_Blk {
 228         U32 SCB_InitioReserved[9];      /* 0 */
 229
 230         UBYTE SCB_Opcode;       /*24 SCB command code */
 231         UBYTE SCB_Flags;        /*25 SCB Flags */
 232         UBYTE SCB_Target;       /*26 Target Id */
 233         UBYTE SCB_Lun;          /*27 Lun */
 234         U32 SCB_BufPtr;         /*28 Data Buffer Pointer */
 235         U32 SCB_BufLen;         /*2C Data Allocation Length */
 236         UBYTE SCB_SGLen;        /*30 SG list # */
 237         UBYTE SCB_SenseLen;     /*31 Sense Allocation Length */
 238         UBYTE SCB_HaStat;       /*32 */
 239         UBYTE SCB_TaStat;       /*33 */
 240         UBYTE SCB_CDBLen;       /*34 CDB Length */
 241         UBYTE SCB_Ident;        /*35 Identify */
 242         UBYTE SCB_TagMsg;       /*36 Tag Message */
 243         UBYTE SCB_TagId;        /*37 Queue Tag */
 244         UBYTE SCB_CDB[12];      /*38 */
 245         U32 SCB_SGPAddr;        /*44 SG List/Sense Buf phy. Addr. */
 246         U32 SCB_SensePtr;       /*48 Sense data pointer */
 247         void (*SCB_Post) (BYTE *, BYTE *);      /*4C POST routine */
 248         Scsi_Cmnd *SCB_Srb;     /*50 SRB Pointer */
 249         SG SCB_SGList[TOTAL_SG_ENTRY];  /*54 Start of SG list */
 250 } SCB;
 251
 252 /* Opcodes of SCB_Opcode */
 253 #define ExecSCSI        0x1
 254 #define BusDevRst       0x2
 255 #define AbortCmd        0x3
 256
 257 /* Bit Definition for SCB_Flags */
 258 #define SCF_DONE        0x01
 259 #define SCF_POST        0x02
 260 #define SCF_SENSE       0x04
 261 #define SCF_DIR         0x18
 262 #define SCF_NO_DCHK     0x00
 263 #define SCF_DIN         0x08
 264 #define SCF_DOUT        0x10
 265 #define SCF_NO_XF       0x18
 266 #define SCF_POLL        0x40
 267 #define SCF_SG          0x80
 268
 269 /* Error Codes for SCB_HaStat */
 270 #define HOST_SEL_TOUT   0x11
 271 #define HOST_DO_DU      0x12
 272 #define HOST_BUS_FREE   0x13
 273 #define HOST_BAD_PHAS   0x14
 274 #define HOST_INV_CMD    0x16
 275 #define HOST_SCSI_RST   0x1B
 276 #define HOST_DEV_RST    0x1C
 277
 278 /* Error Codes for SCB_TaStat */
 279 #define TARGET_CHKCOND  0x02
 280 #define TARGET_BUSY     0x08
 281
 282 /* Queue tag msg: Simple_quque_tag, Head_of_queue_tag, Ordered_queue_tag */
 283 #define MSG_STAG        0x20
 284 #define MSG_HTAG        0x21
 285 #define MSG_OTAG        0x22
 286
 287 /***********************************************************************
 288                 Target Device Control Structure
 289 **********************************************************************/
 290
 291 typedef struct Tar_Ctrl_Struc {
 292         ULONG TCS_InitioReserved;       /* 0 */
 293
 294         UWORD TCS_DrvFlags;     /* 4 */
 295         UBYTE TCS_DrvHead;      /* 6 */
 296         UBYTE TCS_DrvSector;    /* 7 */
 297 } TCS;
 298
 299 /***********************************************************************
 300                 Target Device Control Structure
 301 **********************************************************************/
 302 /* Bit Definition for TCF_DrvFlags */
 303 #define TCF_DRV_255_63          0x0400
 304
 305 /***********************************************************************
 306               Host Adapter Control Structure
 307 ************************************************************************/
 308 typedef struct Ha_Ctrl_Struc {
 309         UWORD HCS_Base;         /* 00 */
 310         UWORD HCS_BIOS;         /* 02 */
 311         UBYTE HCS_Intr;         /* 04 */
 312         UBYTE HCS_SCSI_ID;      /* 05 */
 313         UBYTE HCS_MaxTar;       /* 06 */
 314         UBYTE HCS_NumScbs;      /* 07 */
 315
 316         UBYTE HCS_Flags;        /* 08 */
 317         UBYTE HCS_Index;        /* 09 */
 318         UBYTE HCS_Reserved[2];  /* 0a */
 319         ULONG HCS_InitioReserved[27];   /* 0C */
 320         TCS HCS_Tcs[16];        /* 78 -> 16 Targets */
 321         Scsi_Cmnd *pSRB_head;   /* SRB save queue header     */
 322         Scsi_Cmnd *pSRB_tail;   /* SRB save queue tail       */
 323 #if LINUX_VERSION_CODE >= CVT_LINUX_VERSION(2,1,95)
 324         spinlock_t HCS_AvailLock;
 325         spinlock_t HCS_SemaphLock;
 326         spinlock_t pSRB_lock;
 327 #endif
 328 } HCS;
 329
 330 /* Bit Definition for HCB_Flags */
 331 #define HCF_EXPECT_RESET        0x10
 332
 333 /* SCSI related definition                                              */
 334 #define DISC_NOT_ALLOW          0x80    /* Disconnect is not allowed    */
 335 #define DISC_ALLOW              0xC0    /* Disconnect is allowed        */