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 * Revision History: 57 * 06/18/98 HL, Initial production Version 1.02 58 * 12/19/98 bv, Use spinlocks for 2.1.95 and up 59 * 06/25/02 Doug Ledford <dledford@redhat.com> 60 * - This and the i60uscsi.h file are almost identical, 61 * merged them into a single header used by both .c files. 62 */ 63 64#define inia100_REVID "Initio INI-A100U2W SCSI device driver; Revision: 1.02d" 65 66#define ULONG unsigned long 67#define USHORT unsigned short 68#define UCHAR unsigned char 69#define BYTE unsigned char 70#define WORD unsigned short 71#define DWORD unsigned long 72#define UBYTE unsigned char 73#define UWORD unsigned short 74#define UDWORD unsigned long 75#define U32 u32 76 77#define ORC_MAXQUEUE 245 78#define ORC_MAXTAGS 64 79 80#define TOTAL_SG_ENTRY 32 81#define MAX_TARGETS 16 82#define IMAX_CDB 15 83#define SENSE_SIZE 14 84 85/************************************************************************/ 86/* Scatter-Gather Element Structure */ 87/************************************************************************/ 88typedef struct ORC_SG_Struc { 89 U32 SG_Ptr; /* Data Pointer */ 90 U32 SG_Len; /* Data Length */ 91} ORC_SG; 92 93/* SCSI related definition */ 94#define DISC_NOT_ALLOW 0x80 /* Disconnect is not allowed */ 95#define DISC_ALLOW 0xC0 /* Disconnect is allowed */ 96 97 98#define ORC_OFFSET_SCB 16 99#define ORC_MAX_SCBS 250 100#define MAX_CHANNELS 2 101#define MAX_ESCB_ELE 64 102#define TCF_DRV_255_63 0x0400 103 104/********************************************************/ 105/* Orchid Host Command Set */ 106/********************************************************/ 107#define ORC_CMD_NOP 0x00 /* Host command - NOP */ 108#define ORC_CMD_VERSION 0x01 /* Host command - Get F/W version */ 109#define ORC_CMD_ECHO 0x02 /* Host command - ECHO */ 110#define ORC_CMD_SET_NVM 0x03 /* Host command - Set NVRAM */ 111#define ORC_CMD_GET_NVM 0x04 /* Host command - Get NVRAM */ 112#define ORC_CMD_GET_BUS_STATUS 0x05 /* Host command - Get SCSI bus status */ 113#define ORC_CMD_ABORT_SCB 0x06 /* Host command - Abort SCB */ 114#define ORC_CMD_ISSUE_SCB 0x07 /* Host command - Issue SCB */ 115 116/********************************************************/ 117/* Orchid Register Set */ 118/********************************************************/ 119#define ORC_GINTS 0xA0 /* Global Interrupt Status */ 120#define QINT 0x04 /* Reply Queue Interrupt */ 121#define ORC_GIMSK 0xA1 /* Global Interrupt MASK */ 122#define MQINT 0x04 /* Mask Reply Queue Interrupt */ 123#define ORC_GCFG 0xA2 /* Global Configure */ 124#define EEPRG 0x01 /* Enable EEPROM programming */ 125#define ORC_GSTAT 0xA3 /* Global status */ 126#define WIDEBUS 0x10 /* Wide SCSI Devices connected */ 127#define ORC_HDATA 0xA4 /* Host Data */ 128#define ORC_HCTRL 0xA5 /* Host Control */ 129#define SCSIRST 0x80 /* SCSI bus reset */ 130#define HDO 0x40 /* Host data out */ 131#define HOSTSTOP 0x02 /* Host stop RISC engine */ 132#define DEVRST 0x01 /* Device reset */ 133#define ORC_HSTUS 0xA6 /* Host Status */ 134#define HDI 0x02 /* Host data in */ 135#define RREADY 0x01 /* RISC engine is ready to receive */ 136#define ORC_NVRAM 0xA7 /* Nvram port address */ 137#define SE2CS 0x008 138#define SE2CLK 0x004 139#define SE2DO 0x002 140#define SE2DI 0x001 141#define ORC_PQUEUE 0xA8 /* Posting queue FIFO */ 142#define ORC_PQCNT 0xA9 /* Posting queue FIFO Cnt */ 143#define ORC_RQUEUE 0xAA /* Reply queue FIFO */ 144#define ORC_RQUEUECNT 0xAB /* Reply queue FIFO Cnt */ 145#define ORC_FWBASEADR 0xAC /* Firmware base address */ 146 147#define ORC_EBIOSADR0 0xB0 /* External Bios address */ 148#define ORC_EBIOSADR1 0xB1 /* External Bios address */ 149#define ORC_EBIOSADR2 0xB2 /* External Bios address */ 150#define ORC_EBIOSDATA 0xB3 /* External Bios address */ 151 152#define ORC_SCBSIZE 0xB7 /* SCB size register */ 153#define ORC_SCBBASE0 0xB8 /* SCB base address 0 */ 154#define ORC_SCBBASE1 0xBC /* SCB base address 1 */ 155 156#define ORC_RISCCTL 0xE0 /* RISC Control */ 157#define PRGMRST 0x002 158#define DOWNLOAD 0x001 159#define ORC_PRGMCTR0 0xE2 /* RISC program counter */ 160#define ORC_PRGMCTR1 0xE3 /* RISC program counter */ 161#define ORC_RISCRAM 0xEC /* RISC RAM data port 4 bytes */ 162 163typedef struct orc_extended_scb { /* Extended SCB */ 164 ORC_SG ESCB_SGList[TOTAL_SG_ENTRY]; /*0 Start of SG list */ 165 struct scsi_cmnd *SCB_Srb; /*50 SRB Pointer */ 166} ESCB; 167 168/*********************************************************************** 169 SCSI Control Block 170************************************************************************/ 171typedef struct orc_scb { /* Scsi_Ctrl_Blk */ 172 UBYTE SCB_Opcode; /*00 SCB command code&residual */ 173 UBYTE SCB_Flags; /*01 SCB Flags */ 174 UBYTE SCB_Target; /*02 Target Id */ 175 UBYTE SCB_Lun; /*03 Lun */ 176 U32 SCB_Reserved0; /*04 Reserved for ORCHID must 0 */ 177 U32 SCB_XferLen; /*08 Data Transfer Length */ 178 U32 SCB_Reserved1; /*0C Reserved for ORCHID must 0 */ 179 U32 SCB_SGLen; /*10 SG list # * 8 */ 180 U32 SCB_SGPAddr; /*14 SG List Buf physical Addr */ 181 U32 SCB_SGPAddrHigh; /*18 SG Buffer high physical Addr */ 182 UBYTE SCB_HaStat; /*1C Host Status */ 183 UBYTE SCB_TaStat; /*1D Target Status */ 184 UBYTE SCB_Status; /*1E SCB status */ 185 UBYTE SCB_Link; /*1F Link pointer, default 0xFF */ 186 UBYTE SCB_SenseLen; /*20 Sense Allocation Length */ 187 UBYTE SCB_CDBLen; /*21 CDB Length */ 188 UBYTE SCB_Ident; /*22 Identify */ 189 UBYTE SCB_TagMsg; /*23 Tag Message */ 190 UBYTE SCB_CDB[IMAX_CDB]; /*24 SCSI CDBs */ 191 UBYTE SCB_ScbIdx; /*3C Index for this ORCSCB */ 192 U32 SCB_SensePAddr; /*34 Sense Buffer physical Addr */ 193 194 ESCB *SCB_EScb; /*38 Extended SCB Pointer */ 195#ifndef ALPHA 196 UBYTE SCB_Reserved2[4]; /*3E Reserved for Driver use */ 197#endif 198} ORC_SCB; 199 200/* Opcodes of ORCSCB_Opcode */ 201#define ORC_EXECSCSI 0x00 /* SCSI initiator command with residual */ 202#define ORC_BUSDEVRST 0x01 /* SCSI Bus Device Reset */ 203 204/* Status of ORCSCB_Status */ 205#define ORCSCB_COMPLETE 0x00 /* SCB request completed */ 206#define ORCSCB_POST 0x01 /* SCB is posted by the HOST */ 207 208/* Bit Definition for ORCSCB_Flags */ 209#define SCF_DISINT 0x01 /* Disable HOST interrupt */ 210#define SCF_DIR 0x18 /* Direction bits */ 211#define SCF_NO_DCHK 0x00 /* Direction determined by SCSI */ 212#define SCF_DIN 0x08 /* From Target to Initiator */ 213#define SCF_DOUT 0x10 /* From Initiator to Target */ 214#define SCF_NO_XF 0x18 /* No data transfer */ 215#define SCF_POLL 0x40 216 217/* Error Codes for ORCSCB_HaStat */ 218#define HOST_SEL_TOUT 0x11 219#define HOST_DO_DU 0x12 220#define HOST_BUS_FREE 0x13 221#define HOST_BAD_PHAS 0x14 222#define HOST_INV_CMD 0x16 223#define HOST_SCSI_RST 0x1B 224#define HOST_DEV_RST 0x1C 225 226 227/* Error Codes for ORCSCB_TaStat */ 228#define TARGET_CHK_COND 0x02 229#define TARGET_BUSY 0x08 230#define TARGET_TAG_FULL 0x28 231 232 233/*********************************************************************** 234 Target Device Control Structure 235**********************************************************************/ 236 237typedef struct ORC_Tar_Ctrl_Struc { 238 UBYTE TCS_DrvDASD; /* 6 */ 239 UBYTE TCS_DrvSCSI; /* 7 */ 240 UBYTE TCS_DrvHead; /* 8 */ 241 UWORD TCS_DrvFlags; /* 4 */ 242 UBYTE TCS_DrvSector; /* 7 */ 243} ORC_TCS; 244 245/* Bit Definition for TCF_DrvFlags */ 246#define TCS_DF_NODASD_SUPT 0x20 /* Suppress OS/2 DASD Mgr support */ 247#define TCS_DF_NOSCSI_SUPT 0x40 /* Suppress OS/2 SCSI Mgr support */ 248 249 250/*********************************************************************** 251 Host Adapter Control Structure 252************************************************************************/ 253typedef struct ORC_Ha_Ctrl_Struc { 254 USHORT HCS_Base; /* 00 */ 255 UBYTE HCS_Index; /* 02 */ 256 UBYTE HCS_Intr; /* 04 */ 257 UBYTE HCS_SCSI_ID; /* 06 H/A SCSI ID */ 258 UBYTE HCS_BIOS; /* 07 BIOS configuration */ 259 260 UBYTE HCS_Flags; /* 0B */ 261 UBYTE HCS_HAConfig1; /* 1B SCSI0MAXTags */ 262 UBYTE HCS_MaxTar; /* 1B SCSI0MAXTags */ 263 264 USHORT HCS_Units; /* Number of units this adapter */ 265 USHORT HCS_AFlags; /* Adapter info. defined flags */ 266 ULONG HCS_Timeout; /* Adapter timeout value */ 267 ORC_SCB *HCS_virScbArray; /* 28 Virtual Pointer to SCB array */ 268 dma_addr_t HCS_physScbArray; /* Scb Physical address */ 269 ESCB *HCS_virEscbArray; /* Virtual pointer to ESCB Scatter list */ 270 dma_addr_t HCS_physEscbArray; /* scatter list Physical address */ 271 UBYTE TargetFlag[16]; /* 30 target configuration, TCF_EN_TAG */ 272 UBYTE MaximumTags[16]; /* 40 ORC_MAX_SCBS */ 273 UBYTE ActiveTags[16][16]; /* 50 */ 274 ORC_TCS HCS_Tcs[16]; /* 28 */ 275 U32 BitAllocFlag[MAX_CHANNELS][8]; /* Max STB is 256, So 256/32 */ 276 spinlock_t BitAllocFlagLock; 277 struct pci_dev *pdev; 278} ORC_HCS; 279 280/* Bit Definition for HCS_Flags */ 281 282#define HCF_SCSI_RESET 0x01 /* SCSI BUS RESET */ 283#define HCF_PARITY 0x02 /* parity card */ 284#define HCF_LVDS 0x10 /* parity card */ 285 286/* Bit Definition for TargetFlag */ 287 288#define TCF_EN_255 0x08 289#define TCF_EN_TAG 0x10 290#define TCF_BUSY 0x20 291#define TCF_DISCONNECT 0x40 292#define TCF_SPIN_UP 0x80 293 294/* Bit Definition for HCS_AFlags */ 295#define HCS_AF_IGNORE 0x01 /* Adapter ignore */ 296#define HCS_AF_DISABLE_RESET 0x10 /* Adapter disable reset */ 297#define HCS_AF_DISABLE_ADPT 0x80 /* Adapter disable */ 298 299typedef struct _NVRAM { 300/*----------header ---------------*/ 301 UCHAR SubVendorID0; /* 00 - Sub Vendor ID */ 302 UCHAR SubVendorID1; /* 00 - Sub Vendor ID */ 303 UCHAR SubSysID0; /* 02 - Sub System ID */ 304 UCHAR SubSysID1; /* 02 - Sub System ID */ 305 UCHAR SubClass; /* 04 - Sub Class */ 306 UCHAR VendorID0; /* 05 - Vendor ID */ 307 UCHAR VendorID1; /* 05 - Vendor ID */ 308 UCHAR DeviceID0; /* 07 - Device ID */ 309 UCHAR DeviceID1; /* 07 - Device ID */ 310 UCHAR Reserved0[2]; /* 09 - Reserved */ 311 UCHAR Revision; /* 0B - Revision of data structure */ 312 /* ----Host Adapter Structure ---- */ 313 UCHAR NumOfCh; /* 0C - Number of SCSI channel */ 314 UCHAR BIOSConfig1; /* 0D - BIOS configuration 1 */ 315 UCHAR BIOSConfig2; /* 0E - BIOS boot channel&target ID */ 316 UCHAR BIOSConfig3; /* 0F - BIOS configuration 3 */ 317 /* ----SCSI channel Structure ---- */ 318 /* from "CTRL-I SCSI Host Adapter SetUp menu " */ 319 UCHAR SCSI0Id; /* 10 - Channel 0 SCSI ID */ 320 UCHAR SCSI0Config; /* 11 - Channel 0 SCSI configuration */ 321 UCHAR SCSI0MaxTags; /* 12 - Channel 0 Maximum tags */ 322 UCHAR SCSI0ResetTime; /* 13 - Channel 0 Reset recovering time */ 323 UCHAR ReservedforChannel0[2]; /* 14 - Reserved */ 324 325 /* ----SCSI target Structure ---- */ 326 /* from "CTRL-I SCSI device SetUp menu " */ 327 UCHAR Target00Config; /* 16 - Channel 0 Target 0 config */ 328 UCHAR Target01Config; /* 17 - Channel 0 Target 1 config */ 329 UCHAR Target02Config; /* 18 - Channel 0 Target 2 config */ 330 UCHAR Target03Config; /* 19 - Channel 0 Target 3 config */ 331 UCHAR Target04Config; /* 1A - Channel 0 Target 4 config */ 332 UCHAR Target05Config; /* 1B - Channel 0 Target 5 config */ 333 UCHAR Target06Config; /* 1C - Channel 0 Target 6 config */ 334 UCHAR Target07Config; /* 1D - Channel 0 Target 7 config */ 335 UCHAR Target08Config; /* 1E - Channel 0 Target 8 config */ 336 UCHAR Target09Config; /* 1F - Channel 0 Target 9 config */ 337 UCHAR Target0AConfig; /* 20 - Channel 0 Target A config */ 338 UCHAR Target0BConfig; /* 21 - Channel 0 Target B config */ 339 UCHAR Target0CConfig; /* 22 - Channel 0 Target C config */ 340 UCHAR Target0DConfig; /* 23 - Channel 0 Target D config */ 341 UCHAR Target0EConfig; /* 24 - Channel 0 Target E config */ 342 UCHAR Target0FConfig; /* 25 - Channel 0 Target F config */ 343 344 UCHAR SCSI1Id; /* 26 - Channel 1 SCSI ID */ 345 UCHAR SCSI1Config; /* 27 - Channel 1 SCSI configuration */ 346 UCHAR SCSI1MaxTags; /* 28 - Channel 1 Maximum tags */ 347 UCHAR SCSI1ResetTime; /* 29 - Channel 1 Reset recovering time */ 348 UCHAR ReservedforChannel1[2]; /* 2A - Reserved */ 349 350 /* ----SCSI target Structure ---- */ 351 /* from "CTRL-I SCSI device SetUp menu " */ 352 UCHAR Target10Config; /* 2C - Channel 1 Target 0 config */ 353 UCHAR Target11Config; /* 2D - Channel 1 Target 1 config */ 354 UCHAR Target12Config; /* 2E - Channel 1 Target 2 config */ 355 UCHAR Target13Config; /* 2F - Channel 1 Target 3 config */ 356 UCHAR Target14Config; /* 30 - Channel 1 Target 4 config */ 357 UCHAR Target15Config; /* 31 - Channel 1 Target 5 config */ 358 UCHAR Target16Config; /* 32 - Channel 1 Target 6 config */ 359 UCHAR Target17Config; /* 33 - Channel 1 Target 7 config */ 360 UCHAR Target18Config; /* 34 - Channel 1 Target 8 config */ 361 UCHAR Target19Config; /* 35 - Channel 1 Target 9 config */ 362 UCHAR Target1AConfig; /* 36 - Channel 1 Target A config */ 363 UCHAR Target1BConfig; /* 37 - Channel 1 Target B config */ 364 UCHAR Target1CConfig; /* 38 - Channel 1 Target C config */ 365 UCHAR Target1DConfig; /* 39 - Channel 1 Target D config */ 366 UCHAR Target1EConfig; /* 3A - Channel 1 Target E config */ 367 UCHAR Target1FConfig; /* 3B - Channel 1 Target F config */ 368 UCHAR reserved[3]; /* 3C - Reserved */ 369 /* ---------- CheckSum ---------- */ 370 UCHAR CheckSum; /* 3F - Checksum of NVRam */ 371} NVRAM, *PNVRAM; 372 373/* Bios Configuration for nvram->BIOSConfig1 */ 374#define NBC_BIOSENABLE 0x01 /* BIOS enable */ 375#define NBC_CDROM 0x02 /* Support bootable CDROM */ 376#define NBC_REMOVABLE 0x04 /* Support removable drive */ 377 378/* Bios Configuration for nvram->BIOSConfig2 */ 379#define NBB_TARGET_MASK 0x0F /* Boot SCSI target ID number */ 380#define NBB_CHANL_MASK 0xF0 /* Boot SCSI channel number */ 381 382/* Bit definition for nvram->SCSIConfig */ 383#define NCC_BUSRESET 0x01 /* Reset SCSI bus at power up */ 384#define NCC_PARITYCHK 0x02 /* SCSI parity enable */ 385#define NCC_LVDS 0x10 /* Enable LVDS */ 386#define NCC_ACTTERM1 0x20 /* Enable active terminator 1 */ 387#define NCC_ACTTERM2 0x40 /* Enable active terminator 2 */ 388#define NCC_AUTOTERM 0x80 /* Enable auto termination */ 389 390/* Bit definition for nvram->TargetxConfig */ 391#define NTC_PERIOD 0x07 /* Maximum Sync. Speed */ 392#define NTC_1GIGA 0x08 /* 255 head / 63 sectors (64/32) */ 393#define NTC_NO_SYNC 0x10 /* NO SYNC. NEGO */ 394#define NTC_NO_WIDESYNC 0x20 /* NO WIDE SYNC. NEGO */ 395#define NTC_DISC_ENABLE 0x40 /* Enable SCSI disconnect */ 396#define NTC_SPINUP 0x80 /* Start disk drive */ 397 398/* Default NVRam values */ 399#define NBC_DEFAULT (NBC_ENABLE) 400#define NCC_DEFAULT (NCC_BUSRESET | NCC_AUTOTERM | NCC_PARITYCHK) 401#define NCC_MAX_TAGS 0x20 /* Maximum tags per target */ 402#define NCC_RESET_TIME 0x0A /* SCSI RESET recovering time */ 403#define NTC_DEFAULT (NTC_1GIGA | NTC_NO_WIDESYNC | NTC_DISC_ENABLE) 404 405#define ORC_RD(x,y) (UCHAR)(inb( (int)((ULONG)((ULONG)x+(UCHAR)y)) )) 406#define ORC_RDWORD(x,y) (short)(inl((int)((ULONG)((ULONG)x+(UCHAR)y)) )) 407#define ORC_RDLONG(x,y) (long)(inl((int)((ULONG)((ULONG)x+(UCHAR)y)) )) 408 409#define ORC_WR( adr,data) outb( (UCHAR)(data), (int)(adr)) 410#define ORC_WRSHORT(adr,data) outw( (UWORD)(data), (int)(adr)) 411#define ORC_WRLONG( adr,data) outl( (ULONG)(data), (int)(adr)) 412