inia100.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:17k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /**************************************************************************
  2.  * Initio A100 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: inia100.h
  57.  * Description: INI-A100U2W LINUX device driver header
  58.  * Revision History:
  59.  * 06/18/98 HL, Initial production Version 1.02
  60.  * 12/19/98 bv, Use spinlocks for 2.1.95 and up
  61.  ****************************************************************************/
  62. #ifndef CVT_LINUX_VERSION
  63. #define CVT_LINUX_VERSION(V,P,S) (((V) * 65536) + ((P) * 256) + (S))
  64. #endif
  65. #ifndef LINUX_VERSION_CODE
  66. #include <linux/version.h>
  67. #endif
  68. #include <linux/types.h>
  69. #include "sd.h"
  70. extern int inia100_detect(Scsi_Host_Template *);
  71. extern int inia100_release(struct Scsi_Host *);
  72. extern int inia100_command(Scsi_Cmnd *);
  73. extern int inia100_queue(Scsi_Cmnd *, void (*done) (Scsi_Cmnd *));
  74. extern int inia100_abort(Scsi_Cmnd *);
  75. extern int inia100_reset(Scsi_Cmnd *, unsigned int);
  76. extern int inia100_biosparam(Scsi_Disk *, kdev_t, int *); /*for linux v2.0 */
  77. #define inia100_REVID "Initio INI-A100U2W SCSI device driver; Revision: 1.02c"
  78. #define INIA100 { 
  79. next: NULL,
  80. module: NULL,
  81. proc_name: "INIA100", 
  82. proc_info: NULL,
  83. name: inia100_REVID, 
  84. detect: inia100_detect, 
  85. release: inia100_release, 
  86. info: NULL,
  87. command: inia100_command, 
  88. queuecommand: inia100_queue, 
  89.   eh_strategy_handler: NULL, 
  90.   eh_abort_handler: NULL, 
  91.   eh_device_reset_handler: NULL, 
  92.   eh_bus_reset_handler: NULL, 
  93.   eh_host_reset_handler: NULL, 
  94. abort: inia100_abort, 
  95. reset: inia100_reset, 
  96. slave_attach: NULL, 
  97. bios_param: inia100_biosparam, 
  98. can_queue: 1, 
  99. this_id: 1, 
  100. sg_tablesize: SG_ALL, 
  101. cmd_per_lun:  1, 
  102. present: 0, 
  103. unchecked_isa_dma: 0, 
  104. use_clustering: ENABLE_CLUSTERING, 
  105.  use_new_eh_code: 0 
  106. }
  107. #define VIRT_TO_BUS(i)  (unsigned int) virt_to_bus((void *)(i))
  108. #define ULONG   unsigned long
  109. #define PVOID   void *
  110. #define USHORT  unsigned short
  111. #define UCHAR   unsigned char
  112. #define BYTE    unsigned char
  113. #define WORD    unsigned short
  114. #define DWORD   unsigned long
  115. #define UBYTE   unsigned char
  116. #define UWORD   unsigned short
  117. #define UDWORD  unsigned long
  118. #define U32     u32
  119. #ifndef NULL
  120. #define NULL     0 /* zero          */
  121. #endif
  122. #ifndef TRUE
  123. #define TRUE     (1) /* boolean true  */
  124. #endif
  125. #ifndef FALSE
  126. #define FALSE    (0) /* boolean false */
  127. #endif
  128. #ifndef FAILURE
  129. #define FAILURE  (-1)
  130. #endif
  131. #if 1
  132. #define ORC_MAXQUEUE 245
  133. #else
  134. #define ORC_MAXQUEUE 25
  135. #endif
  136. #define TOTAL_SG_ENTRY 32
  137. #define MAX_TARGETS 16
  138. #define IMAX_CDB 15
  139. #define SENSE_SIZE 14
  140. #define MAX_SUPPORTED_ADAPTERS  4
  141. #define SUCCESSFUL              0x00
  142. #define I920_DEVICE_ID 0x0002 /* Initio's inic-950 product ID   */
  143. /************************************************************************/
  144. /*              Scatter-Gather Element Structure                        */
  145. /************************************************************************/
  146. typedef struct ORC_SG_Struc {
  147. U32 SG_Ptr; /* Data Pointer */
  148. U32 SG_Len; /* Data Length */
  149. } ORC_SG;
  150. /* SCSI related definition                                              */
  151. #define DISC_NOT_ALLOW          0x80 /* Disconnect is not allowed    */
  152. #define DISC_ALLOW              0xC0 /* Disconnect is allowed        */
  153. #define ORC_OFFSET_SCB 16
  154. #define ORC_MAX_SCBS     250
  155. #define MAX_CHANNELS       2
  156. #define MAX_ESCB_ELE 64
  157. #define TCF_DRV_255_63     0x0400
  158. /********************************************************/
  159. /*      Orchid Configuration Register Set               */
  160. /********************************************************/
  161. #define ORC_PVID 0x00 /* Vendor ID                      */
  162. #define ORC_VENDOR_ID 0x1101 /* Orchid vendor ID               */
  163. #define ORC_PDID        0x02 /* Device ID                    */
  164. #define ORC_DEVICE_ID 0x1060 /* Orchid device ID               */
  165. #define ORC_COMMAND 0x04 /* Command                        */
  166. #define BUSMS 0x04 /* BUS MASTER Enable              */
  167. #define IOSPA 0x01 /* IO Space Enable                */
  168. #define ORC_STATUS 0x06 /* Status register                */
  169. #define ORC_REVISION 0x08 /* Revision number                */
  170. #define ORC_BASE 0x10 /* Base address                   */
  171. #define ORC_BIOS 0x50 /* Expansion ROM base address     */
  172. #define ORC_INT_NUM 0x3C /* Interrupt line         */
  173. #define ORC_INT_PIN 0x3D /* Interrupt pin          */
  174. /********************************************************/
  175. /*      Orchid Host Command Set                         */
  176. /********************************************************/
  177. #define ORC_CMD_NOP 0x00 /* Host command - NOP             */
  178. #define ORC_CMD_VERSION 0x01 /* Host command - Get F/W version */
  179. #define ORC_CMD_ECHO 0x02 /* Host command - ECHO            */
  180. #define ORC_CMD_SET_NVM 0x03 /* Host command - Set NVRAM       */
  181. #define ORC_CMD_GET_NVM 0x04 /* Host command - Get NVRAM       */
  182. #define ORC_CMD_GET_BUS_STATUS 0x05 /* Host command - Get SCSI bus status */
  183. #define ORC_CMD_ABORT_SCB 0x06 /* Host command - Abort SCB       */
  184. #define ORC_CMD_ISSUE_SCB 0x07 /* Host command - Issue SCB       */
  185. /********************************************************/
  186. /*              Orchid Register Set                     */
  187. /********************************************************/
  188. #define ORC_GINTS 0xA0 /* Global Interrupt Status        */
  189. #define QINT 0x04 /* Reply Queue Interrupt  */
  190. #define ORC_GIMSK 0xA1 /* Global Interrupt MASK  */
  191. #define MQINT 0x04 /* Mask Reply Queue Interrupt     */
  192. #define ORC_GCFG 0xA2 /* Global Configure               */
  193. #define EEPRG 0x01 /* Enable EEPROM programming */
  194. #define ORC_GSTAT 0xA3 /* Global status          */
  195. #define WIDEBUS 0x10 /* Wide SCSI Devices connected    */
  196. #define ORC_HDATA 0xA4 /* Host Data                      */
  197. #define ORC_HCTRL 0xA5 /* Host Control                   */
  198. #define SCSIRST 0x80 /* SCSI bus reset         */
  199. #define HDO 0x40 /* Host data out          */
  200. #define HOSTSTOP 0x02 /* Host stop RISC engine  */
  201. #define DEVRST 0x01 /* Device reset                   */
  202. #define ORC_HSTUS 0xA6 /* Host Status                    */
  203. #define HDI 0x02 /* Host data in                   */
  204. #define RREADY 0x01 /* RISC engine is ready to receive */
  205. #define ORC_NVRAM 0xA7 /* Nvram port address             */
  206. #define SE2CS 0x008
  207. #define SE2CLK 0x004
  208. #define SE2DO 0x002
  209. #define SE2DI 0x001
  210. #define ORC_PQUEUE 0xA8 /* Posting queue FIFO             */
  211. #define ORC_PQCNT 0xA9 /* Posting queue FIFO Cnt */
  212. #define ORC_RQUEUE 0xAA /* Reply queue FIFO               */
  213. #define ORC_RQUEUECNT 0xAB /* Reply queue FIFO Cnt           */
  214. #define ORC_FWBASEADR 0xAC /* Firmware base address  */
  215. #define ORC_EBIOSADR0 0xB0 /* External Bios address */
  216. #define ORC_EBIOSADR1 0xB1 /* External Bios address */
  217. #define ORC_EBIOSADR2 0xB2 /* External Bios address */
  218. #define ORC_EBIOSDATA 0xB3 /* External Bios address */
  219. #define ORC_SCBSIZE 0xB7 /* SCB size register              */
  220. #define ORC_SCBBASE0 0xB8 /* SCB base address 0             */
  221. #define ORC_SCBBASE1 0xBC /* SCB base address 1             */
  222. #define ORC_RISCCTL 0xE0 /* RISC Control                   */
  223. #define PRGMRST 0x002
  224. #define DOWNLOAD 0x001
  225. #define ORC_PRGMCTR0 0xE2 /* RISC program counter           */
  226. #define ORC_PRGMCTR1 0xE3 /* RISC program counter           */
  227. #define ORC_RISCRAM 0xEC /* RISC RAM data port 4 bytes     */
  228. typedef struct orc_extended_scb { /* Extended SCB                 */
  229. ORC_SG ESCB_SGList[TOTAL_SG_ENTRY]; /*0 Start of SG list              */
  230. Scsi_Cmnd *SCB_Srb; /*50 SRB Pointer */
  231. } ESCB;
  232. /***********************************************************************
  233. SCSI Control Block
  234. ************************************************************************/
  235. typedef struct orc_scb { /* Scsi_Ctrl_Blk                */
  236. UBYTE SCB_Opcode; /*00 SCB command code&residual  */
  237. UBYTE SCB_Flags; /*01 SCB Flags                  */
  238. UBYTE SCB_Target; /*02 Target Id                  */
  239. UBYTE SCB_Lun; /*03 Lun                        */
  240. U32 SCB_Reserved0; /*04 Reserved for ORCHID must 0 */
  241. U32 SCB_XferLen; /*08 Data Transfer Length       */
  242. U32 SCB_Reserved1; /*0C Reserved for ORCHID must 0 */
  243. U32 SCB_SGLen; /*10 SG list # * 8              */
  244. U32 SCB_SGPAddr; /*14 SG List Buf physical Addr  */
  245. U32 SCB_SGPAddrHigh; /*18 SG Buffer high physical Addr */
  246. UBYTE SCB_HaStat; /*1C Host Status                */
  247. UBYTE SCB_TaStat; /*1D Target Status              */
  248. UBYTE SCB_Status; /*1E SCB status                 */
  249. UBYTE SCB_Link; /*1F Link pointer, default 0xFF */
  250. UBYTE SCB_SenseLen; /*20 Sense Allocation Length    */
  251. UBYTE SCB_CDBLen; /*21 CDB Length                 */
  252. UBYTE SCB_Ident; /*22 Identify                   */
  253. UBYTE SCB_TagMsg; /*23 Tag Message                */
  254. UBYTE SCB_CDB[IMAX_CDB]; /*24 SCSI CDBs                  */
  255. UBYTE SCB_ScbIdx; /*3C Index for this ORCSCB      */
  256. U32 SCB_SensePAddr; /*34 Sense Buffer physical Addr */
  257. ESCB *SCB_EScb; /*38 Extended SCB Pointer       */
  258. #ifndef ALPHA
  259. UBYTE SCB_Reserved2[4]; /*3E Reserved for Driver use    */
  260. #endif
  261. } ORC_SCB;
  262. /* Opcodes of ORCSCB_Opcode */
  263. #define ORC_EXECSCSI 0x00 /* SCSI initiator command with residual */
  264. #define ORC_BUSDEVRST 0x01 /* SCSI Bus Device Reset  */
  265. /* Status of ORCSCB_Status */
  266. #define ORCSCB_COMPLETE 0x00 /* SCB request completed  */
  267. #define ORCSCB_POST 0x01 /* SCB is posted by the HOST      */
  268. /* Bit Definition for ORCSCB_Flags */
  269. #define SCF_DISINT 0x01 /* Disable HOST interrupt */
  270. #define SCF_DIR 0x18 /* Direction bits         */
  271. #define SCF_NO_DCHK 0x00 /* Direction determined by SCSI   */
  272. #define SCF_DIN 0x08 /* From Target to Initiator       */
  273. #define SCF_DOUT 0x10 /* From Initiator to Target       */
  274. #define SCF_NO_XF 0x18 /* No data transfer               */
  275. #define SCF_POLL   0x40
  276. /* Error Codes for ORCSCB_HaStat */
  277. #define HOST_SEL_TOUT 0x11
  278. #define HOST_DO_DU 0x12
  279. #define HOST_BUS_FREE 0x13
  280. #define HOST_BAD_PHAS 0x14
  281. #define HOST_INV_CMD 0x16
  282. #define HOST_SCSI_RST 0x1B
  283. #define HOST_DEV_RST 0x1C
  284. /* Error Codes for ORCSCB_TaStat */
  285. #define TARGET_CHK_COND 0x02
  286. #define TARGET_BUSY 0x08
  287. #define TARGET_TAG_FULL 0x28
  288. /* Queue tag msg: Simple_quque_tag, Head_of_queue_tag, Ordered_queue_tag */
  289. #define MSG_STAG 0x20
  290. #define MSG_HTAG 0x21
  291. #define MSG_OTAG 0x22
  292. #define MSG_IGNOREWIDE 0x23
  293. #define MSG_IDENT 0x80
  294. #define MSG_DISC 0x40 /* Disconnect allowed             */
  295. /* SCSI MESSAGE */
  296. #define MSG_EXTEND 0x01
  297. #define MSG_SDP 0x02
  298. #define MSG_ABORT 0x06
  299. #define MSG_REJ 0x07
  300. #define MSG_NOP 0x08
  301. #define MSG_PARITY 0x09
  302. #define MSG_DEVRST 0x0C
  303. #define MSG_STAG 0x20
  304. /***********************************************************************
  305. Target Device Control Structure
  306. **********************************************************************/
  307. typedef struct ORC_Tar_Ctrl_Struc {
  308. UBYTE TCS_DrvDASD; /* 6 */
  309. UBYTE TCS_DrvSCSI; /* 7 */
  310. UBYTE TCS_DrvHead; /* 8 */
  311. UWORD TCS_DrvFlags; /* 4 */
  312. UBYTE TCS_DrvSector; /* 7 */
  313. } ORC_TCS, *PORC_TCS;
  314. /* Bit Definition for TCF_DrvFlags */
  315. #define TCS_DF_NODASD_SUPT 0x20 /* Suppress OS/2 DASD Mgr support */
  316. #define TCS_DF_NOSCSI_SUPT 0x40 /* Suppress OS/2 SCSI Mgr support */
  317. /***********************************************************************
  318.               Host Adapter Control Structure
  319. ************************************************************************/
  320. typedef struct ORC_Ha_Ctrl_Struc {
  321. USHORT HCS_Base; /* 00 */
  322. UBYTE HCS_Index; /* 02 */
  323. UBYTE HCS_Intr; /* 04 */
  324. UBYTE HCS_SCSI_ID; /* 06    H/A SCSI ID */
  325. UBYTE HCS_BIOS; /* 07    BIOS configuration */
  326. UBYTE HCS_Flags; /* 0B */
  327. UBYTE HCS_HAConfig1; /* 1B    SCSI0MAXTags */
  328. UBYTE HCS_MaxTar; /* 1B    SCSI0MAXTags */
  329. USHORT HCS_Units; /* Number of units this adapter  */
  330. USHORT HCS_AFlags; /* Adapter info. defined flags   */
  331. ULONG HCS_Timeout; /* Adapter timeout value   */
  332. PVOID HCS_virScbArray; /* 28 Virtual Pointer to SCB array     */
  333. U32 HCS_physScbArray; /* Scb Physical address */
  334. PVOID HCS_virEscbArray; /* Virtual pointer to ESCB Scatter list */
  335. U32 HCS_physEscbArray; /* scatter list Physical address */
  336. UBYTE TargetFlag[16]; /* 30  target configuration, TCF_EN_TAG */
  337. UBYTE MaximumTags[16]; /* 40  ORC_MAX_SCBS */
  338. UBYTE ActiveTags[16][16]; /* 50 */
  339. ORC_TCS HCS_Tcs[16]; /* 28 */
  340. U32 BitAllocFlag[MAX_CHANNELS][8]; /* Max STB is 256, So 256/32 */
  341. spinlock_t BitAllocFlagLock;
  342. Scsi_Cmnd *pSRB_head;
  343. Scsi_Cmnd *pSRB_tail;
  344. spinlock_t pSRB_lock;
  345. } ORC_HCS;
  346. /* Bit Definition for HCS_Flags */
  347. #define HCF_SCSI_RESET 0x01 /* SCSI BUS RESET         */
  348. #define HCF_PARITY     0x02 /* parity card                    */
  349. #define HCF_LVDS      0x10 /* parity card                    */
  350. /* Bit Definition for TargetFlag */
  351. #define TCF_EN_255     0x08
  352. #define TCF_EN_TAG     0x10
  353. #define TCF_BUSY       0x20
  354. #define TCF_DISCONNECT 0x40
  355. #define TCF_SPIN_UP   0x80
  356. /* Bit Definition for HCS_AFlags */
  357. #define HCS_AF_IGNORE 0x01 /* Adapter ignore         */
  358. #define HCS_AF_DISABLE_RESET 0x10 /* Adapter disable reset  */
  359. #define HCS_AF_DISABLE_ADPT 0x80 /* Adapter disable                */
  360. /*---------------------------------------*/
  361. /* TimeOut for RESET to complete (30s)   */
  362. /*                                       */
  363. /* After a RESET the drive is checked    */
  364. /* every 200ms.                          */
  365. /*---------------------------------------*/
  366. #define DELAYED_RESET_MAX       (30*1000L)
  367. #define DELAYED_RESET_INTERVAL  200L
  368. /*----------------------------------------------*/
  369. /* TimeOut for IRQ from last interrupt (5s)     */
  370. /*----------------------------------------------*/
  371. #define IRQ_TIMEOUT_INTERVAL    (5*1000L)
  372. /*----------------------------------------------*/
  373. /* Retry Delay interval (200ms)                 */
  374. /*----------------------------------------------*/
  375. #define DELAYED_RETRY_INTERVAL  200L
  376. #define INQUIRY_SIZE 36
  377. #define CAPACITY_SIZE 8
  378. #define DEFAULT_SENSE_LEN 14
  379. #define DEVICE_NOT_FOUND 0x86
  380. /*----------------------------------------------*/
  381. /* Definition for PCI device                    */
  382. /*----------------------------------------------*/
  383. #define MAX_PCI_DEVICES 21
  384. #define MAX_PCI_BUSES 8