File: /usr/src/linux/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 General 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 * 21/01/99 bv - v1.03e
67 * - Added PCI_ID structure
68 **************************************************************************/
69
70 #ifndef CVT_LINUX_VERSION
71 #define CVT_LINUX_VERSION(V,P,S) (((V) * 65536) + ((P) * 256) + (S))
72 #endif
73
74 #ifndef LINUX_VERSION_CODE
75 #include <linux/version.h>
76 #endif
77
78 #include "sd.h"
79
80 extern int i91u_detect(Scsi_Host_Template *);
81 extern int i91u_release(struct Scsi_Host *);
82 extern int i91u_command(Scsi_Cmnd *);
83 extern int i91u_queue(Scsi_Cmnd *, void (*done) (Scsi_Cmnd *));
84 extern int i91u_abort(Scsi_Cmnd *);
85 extern int i91u_reset(Scsi_Cmnd *, unsigned int);
86 extern int i91u_biosparam(Scsi_Disk *, kdev_t, int *); /*for linux v2.0 */
87
88 #define i91u_REVID "Initio INI-9X00U/UW SCSI device driver; Revision: 1.03g"
89
90 #define INI9100U { \
91 next: NULL, \
92 module: NULL, \
93 proc_name: "INI9100U", \
94 proc_info: NULL, \
95 name: i91u_REVID, \
96 detect: i91u_detect, \
97 release: i91u_release, \
98 info: NULL, \
99 command: i91u_command, \
100 queuecommand: i91u_queue, \
101 eh_strategy_handler: NULL, \
102 eh_abort_handler: NULL, \
103 eh_device_reset_handler: NULL, \
104 eh_bus_reset_handler: NULL, \
105 eh_host_reset_handler: NULL, \
106 abort: i91u_abort, \
107 reset: i91u_reset, \
108 slave_attach: NULL, \
109 bios_param: i91u_biosparam, \
110 can_queue: 1, \
111 this_id: 1, \
112 sg_tablesize: SG_ALL, \
113 cmd_per_lun: 1, \
114 present: 0, \
115 unchecked_isa_dma: 0, \
116 use_clustering: ENABLE_CLUSTERING, \
117 use_new_eh_code: 0 \
118 }
119
120 #define VIRT_TO_BUS(i) (unsigned int) virt_to_bus((void *)(i))
121 #define ULONG unsigned long
122 #define USHORT unsigned short
123 #define UCHAR unsigned char
124 #define BYTE unsigned char
125 #define WORD unsigned short
126 #define DWORD unsigned long
127 #define UBYTE unsigned char
128 #define UWORD unsigned short
129 #define UDWORD unsigned long
130 #ifdef ALPHA
131 #define U32 unsigned int
132 #else
133 #define U32 unsigned long
134 #endif
135
136 #ifndef NULL
137 #define NULL 0 /* zero */
138 #endif
139 #ifndef TRUE
140 #define TRUE (1) /* boolean true */
141 #endif
142 #ifndef FALSE
143 #define FALSE (0) /* boolean false */
144 #endif
145 #ifndef FAILURE
146 #define FAILURE (-1)
147 #endif
148
149 #define i91u_MAXQUEUE 2
150 #define TOTAL_SG_ENTRY 32
151 #define MAX_TARGETS 16
152 #define SENSE_SIZE 14
153
154 #define INI_VENDOR_ID 0x1101 /* Initio's PCI vendor ID */
155 #define DMX_VENDOR_ID 0x134a /* Domex's PCI vendor ID */
156 #define I950_DEVICE_ID 0x9500 /* Initio's inic-950 product ID */
157 #define I940_DEVICE_ID 0x9400 /* Initio's inic-940 product ID */
158 #define I935_DEVICE_ID 0x9401 /* Initio's inic-935 product ID */
159 #define I920_DEVICE_ID 0x0002 /* Initio's other product ID */
160
161 /************************************************************************/
162 /* Vendor ID/Device ID Pair Structure */
163 /************************************************************************/
164 typedef struct PCI_ID_Struc {
165 unsigned short vendor_id;
166 unsigned short device_id;
167 } PCI_ID;
168
169 /************************************************************************/
170 /* Scatter-Gather Element Structure */
171 /************************************************************************/
172 typedef struct SG_Struc {
173 U32 SG_Ptr; /* Data Pointer */
174 U32 SG_Len; /* Data Length */
175 } SG;
176
177 /***********************************************************************
178 SCSI Control Block
179 ************************************************************************/
180 typedef struct Scsi_Ctrl_Blk {
181 U32 SCB_InitioReserved[9]; /* 0 */
182
183 UBYTE SCB_Opcode; /*24 SCB command code */
184 UBYTE SCB_Flags; /*25 SCB Flags */
185 UBYTE SCB_Target; /*26 Target Id */
186 UBYTE SCB_Lun; /*27 Lun */
187 U32 SCB_BufPtr; /*28 Data Buffer Pointer */
188 U32 SCB_BufLen; /*2C Data Allocation Length */
189 UBYTE SCB_SGLen; /*30 SG list # */
190 UBYTE SCB_SenseLen; /*31 Sense Allocation Length */
191 UBYTE SCB_HaStat; /*32 */
192 UBYTE SCB_TaStat; /*33 */
193 UBYTE SCB_CDBLen; /*34 CDB Length */
194 UBYTE SCB_Ident; /*35 Identify */
195 UBYTE SCB_TagMsg; /*36 Tag Message */
196 UBYTE SCB_TagId; /*37 Queue Tag */
197 UBYTE SCB_CDB[12]; /*38 */
198 U32 SCB_SGPAddr; /*44 SG List/Sense Buf phy. Addr. */
199 U32 SCB_SensePtr; /*48 Sense data pointer */
200 void (*SCB_Post) (BYTE *, BYTE *); /*4C POST routine */
201 Scsi_Cmnd *SCB_Srb; /*50 SRB Pointer */
202 SG SCB_SGList[TOTAL_SG_ENTRY]; /*54 Start of SG list */
203 } SCB;
204
205 /* Opcodes of SCB_Opcode */
206 #define ExecSCSI 0x1
207 #define BusDevRst 0x2
208 #define AbortCmd 0x3
209
210 /* Bit Definition for SCB_Flags */
211 #define SCF_DONE 0x01
212 #define SCF_POST 0x02
213 #define SCF_SENSE 0x04
214 #define SCF_DIR 0x18
215 #define SCF_NO_DCHK 0x00
216 #define SCF_DIN 0x08
217 #define SCF_DOUT 0x10
218 #define SCF_NO_XF 0x18
219 #define SCF_POLL 0x40
220 #define SCF_SG 0x80
221
222 /* Error Codes for SCB_HaStat */
223 #define HOST_SEL_TOUT 0x11
224 #define HOST_DO_DU 0x12
225 #define HOST_BUS_FREE 0x13
226 #define HOST_BAD_PHAS 0x14
227 #define HOST_INV_CMD 0x16
228 #define HOST_SCSI_RST 0x1B
229 #define HOST_DEV_RST 0x1C
230
231 /* Error Codes for SCB_TaStat */
232 #define TARGET_CHKCOND 0x02
233 #define TARGET_BUSY 0x08
234
235 /* Queue tag msg: Simple_quque_tag, Head_of_queue_tag, Ordered_queue_tag */
236 #define MSG_STAG 0x20
237 #define MSG_HTAG 0x21
238 #define MSG_OTAG 0x22
239
240 /***********************************************************************
241 Target Device Control Structure
242 **********************************************************************/
243
244 typedef struct Tar_Ctrl_Struc {
245 ULONG TCS_InitioReserved; /* 0 */
246
247 UWORD TCS_DrvFlags; /* 4 */
248 UBYTE TCS_DrvHead; /* 6 */
249 UBYTE TCS_DrvSector; /* 7 */
250 } TCS;
251
252 /***********************************************************************
253 Target Device Control Structure
254 **********************************************************************/
255 /* Bit Definition for TCF_DrvFlags */
256 #define TCF_DRV_255_63 0x0400
257
258 /***********************************************************************
259 Host Adapter Control Structure
260 ************************************************************************/
261 typedef struct Ha_Ctrl_Struc {
262 UWORD HCS_Base; /* 00 */
263 UWORD HCS_BIOS; /* 02 */
264 UBYTE HCS_Intr; /* 04 */
265 UBYTE HCS_SCSI_ID; /* 05 */
266 UBYTE HCS_MaxTar; /* 06 */
267 UBYTE HCS_NumScbs; /* 07 */
268
269 UBYTE HCS_Flags; /* 08 */
270 UBYTE HCS_Index; /* 09 */
271 UBYTE HCS_Reserved[2]; /* 0a */
272 ULONG HCS_InitioReserved[27]; /* 0C */
273 TCS HCS_Tcs[16]; /* 78 -> 16 Targets */
274 Scsi_Cmnd *pSRB_head; /* SRB save queue header */
275 Scsi_Cmnd *pSRB_tail; /* SRB save queue tail */
276 spinlock_t HCS_AvailLock;
277 spinlock_t HCS_SemaphLock;
278 spinlock_t pSRB_lock;
279 struct pci_dev *pci_dev;
280 } HCS;
281
282 /* Bit Definition for HCB_Flags */
283 #define HCF_EXPECT_RESET 0x10
284
285 /* SCSI related definition */
286 #define DISC_NOT_ALLOW 0x80 /* Disconnect is not allowed */
287 #define DISC_ALLOW 0xC0 /* Disconnect is allowed */
288