xref: /OK3568_Linux_fs/kernel/drivers/scsi/ips.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*****************************************************************************/
2*4882a593Smuzhiyun /* ips.h -- driver for the Adaptec / IBM ServeRAID controller                */
3*4882a593Smuzhiyun /*                                                                           */
4*4882a593Smuzhiyun /* Written By: Keith Mitchell, IBM Corporation                               */
5*4882a593Smuzhiyun /*             Jack Hammer, Adaptec, Inc.                                    */
6*4882a593Smuzhiyun /*             David Jeffery, Adaptec, Inc.                                  */
7*4882a593Smuzhiyun /*                                                                           */
8*4882a593Smuzhiyun /* Copyright (C) 1999 IBM Corporation                                        */
9*4882a593Smuzhiyun /* Copyright (C) 2003 Adaptec, Inc.                                          */
10*4882a593Smuzhiyun /*                                                                           */
11*4882a593Smuzhiyun /* This program is free software; you can redistribute it and/or modify      */
12*4882a593Smuzhiyun /* it under the terms of the GNU General Public License as published by      */
13*4882a593Smuzhiyun /* the Free Software Foundation; either version 2 of the License, or         */
14*4882a593Smuzhiyun /* (at your option) any later version.                                       */
15*4882a593Smuzhiyun /*                                                                           */
16*4882a593Smuzhiyun /* This program is distributed in the hope that it will be useful,           */
17*4882a593Smuzhiyun /* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
18*4882a593Smuzhiyun /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             */
19*4882a593Smuzhiyun /* GNU General Public License for more details.                              */
20*4882a593Smuzhiyun /*                                                                           */
21*4882a593Smuzhiyun /* NO WARRANTY                                                               */
22*4882a593Smuzhiyun /* THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR        */
23*4882a593Smuzhiyun /* CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT      */
24*4882a593Smuzhiyun /* LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,      */
25*4882a593Smuzhiyun /* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is    */
26*4882a593Smuzhiyun /* solely responsible for determining the appropriateness of using and       */
27*4882a593Smuzhiyun /* distributing the Program and assumes all risks associated with its        */
28*4882a593Smuzhiyun /* exercise of rights under this Agreement, including but not limited to     */
29*4882a593Smuzhiyun /* the risks and costs of program errors, damage to or loss of data,         */
30*4882a593Smuzhiyun /* programs or equipment, and unavailability or interruption of operations.  */
31*4882a593Smuzhiyun /*                                                                           */
32*4882a593Smuzhiyun /* DISCLAIMER OF LIABILITY                                                   */
33*4882a593Smuzhiyun /* NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY   */
34*4882a593Smuzhiyun /* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL        */
35*4882a593Smuzhiyun /* DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND   */
36*4882a593Smuzhiyun /* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR     */
37*4882a593Smuzhiyun /* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE    */
38*4882a593Smuzhiyun /* USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED  */
39*4882a593Smuzhiyun /* HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES             */
40*4882a593Smuzhiyun /*                                                                           */
41*4882a593Smuzhiyun /* You should have received a copy of the GNU General Public License         */
42*4882a593Smuzhiyun /* along with this program; if not, write to the Free Software               */
43*4882a593Smuzhiyun /* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
44*4882a593Smuzhiyun /*                                                                           */
45*4882a593Smuzhiyun /* Bugs/Comments/Suggestions should be mailed to:                            */
46*4882a593Smuzhiyun /*      ipslinux@adaptec.com                                                 */
47*4882a593Smuzhiyun /*                                                                           */
48*4882a593Smuzhiyun /*****************************************************************************/
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun #ifndef _IPS_H_
51*4882a593Smuzhiyun    #define _IPS_H_
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #include <linux/nmi.h>
54*4882a593Smuzhiyun #include <linux/uaccess.h>
55*4882a593Smuzhiyun    #include <asm/io.h>
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun    /*
58*4882a593Smuzhiyun     * Some handy macros
59*4882a593Smuzhiyun     */
60*4882a593Smuzhiyun    #define IPS_HA(x)                   ((ips_ha_t *) x->hostdata)
61*4882a593Smuzhiyun    #define IPS_COMMAND_ID(ha, scb)     (int) (scb - ha->scbs)
62*4882a593Smuzhiyun    #define IPS_IS_TROMBONE(ha)         (((ha->pcidev->device == IPS_DEVICEID_COPPERHEAD) && \
63*4882a593Smuzhiyun                                          (ha->pcidev->revision >= IPS_REVID_TROMBONE32) && \
64*4882a593Smuzhiyun                                          (ha->pcidev->revision <= IPS_REVID_TROMBONE64)) ? 1 : 0)
65*4882a593Smuzhiyun    #define IPS_IS_CLARINET(ha)         (((ha->pcidev->device == IPS_DEVICEID_COPPERHEAD) && \
66*4882a593Smuzhiyun                                          (ha->pcidev->revision >= IPS_REVID_CLARINETP1) && \
67*4882a593Smuzhiyun                                          (ha->pcidev->revision <= IPS_REVID_CLARINETP3)) ? 1 : 0)
68*4882a593Smuzhiyun    #define IPS_IS_MORPHEUS(ha)         (ha->pcidev->device == IPS_DEVICEID_MORPHEUS)
69*4882a593Smuzhiyun    #define IPS_IS_MARCO(ha)            (ha->pcidev->device == IPS_DEVICEID_MARCO)
70*4882a593Smuzhiyun    #define IPS_USE_I2O_DELIVER(ha)     ((IPS_IS_MORPHEUS(ha) || \
71*4882a593Smuzhiyun                                          (IPS_IS_TROMBONE(ha) && \
72*4882a593Smuzhiyun                                           (ips_force_i2o))) ? 1 : 0)
73*4882a593Smuzhiyun    #define IPS_USE_MEMIO(ha)           ((IPS_IS_MORPHEUS(ha) || \
74*4882a593Smuzhiyun                                          ((IPS_IS_TROMBONE(ha) || IPS_IS_CLARINET(ha)) && \
75*4882a593Smuzhiyun                                           (ips_force_memio))) ? 1 : 0)
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun     #define IPS_HAS_ENH_SGLIST(ha)    (IPS_IS_MORPHEUS(ha) || IPS_IS_MARCO(ha))
78*4882a593Smuzhiyun     #define IPS_USE_ENH_SGLIST(ha)    ((ha)->flags & IPS_HA_ENH_SG)
79*4882a593Smuzhiyun     #define IPS_SGLIST_SIZE(ha)       (IPS_USE_ENH_SGLIST(ha) ? \
80*4882a593Smuzhiyun                                          sizeof(IPS_ENH_SG_LIST) : sizeof(IPS_STD_SG_LIST))
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun   #define IPS_PRINTK(level, pcidev, format, arg...)                 \
83*4882a593Smuzhiyun             dev_printk(level , &((pcidev)->dev) , format , ## arg)
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun    #define MDELAY(n)			\
86*4882a593Smuzhiyun 	do {				\
87*4882a593Smuzhiyun 		mdelay(n);		\
88*4882a593Smuzhiyun 		touch_nmi_watchdog();	\
89*4882a593Smuzhiyun 	} while (0)
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun    #ifndef min
92*4882a593Smuzhiyun       #define min(x,y) ((x) < (y) ? x : y)
93*4882a593Smuzhiyun    #endif
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun    #ifndef __iomem       /* For clean compiles in earlier kernels without __iomem annotations */
96*4882a593Smuzhiyun       #define __iomem
97*4882a593Smuzhiyun    #endif
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun    /*
100*4882a593Smuzhiyun     * Adapter address map equates
101*4882a593Smuzhiyun     */
102*4882a593Smuzhiyun    #define IPS_REG_HISR                 0x08    /* Host Interrupt Status Reg   */
103*4882a593Smuzhiyun    #define IPS_REG_CCSAR                0x10    /* Cmd Channel System Addr Reg */
104*4882a593Smuzhiyun    #define IPS_REG_CCCR                 0x14    /* Cmd Channel Control Reg     */
105*4882a593Smuzhiyun    #define IPS_REG_SQHR                 0x20    /* Status Q Head Reg           */
106*4882a593Smuzhiyun    #define IPS_REG_SQTR                 0x24    /* Status Q Tail Reg           */
107*4882a593Smuzhiyun    #define IPS_REG_SQER                 0x28    /* Status Q End Reg            */
108*4882a593Smuzhiyun    #define IPS_REG_SQSR                 0x2C    /* Status Q Start Reg          */
109*4882a593Smuzhiyun    #define IPS_REG_SCPR                 0x05    /* Subsystem control port reg  */
110*4882a593Smuzhiyun    #define IPS_REG_ISPR                 0x06    /* interrupt status port reg   */
111*4882a593Smuzhiyun    #define IPS_REG_CBSP                 0x07    /* CBSP register               */
112*4882a593Smuzhiyun    #define IPS_REG_FLAP                 0x18    /* Flash address port          */
113*4882a593Smuzhiyun    #define IPS_REG_FLDP                 0x1C    /* Flash data port             */
114*4882a593Smuzhiyun    #define IPS_REG_NDAE                 0x38    /* Anaconda 64 NDAE Register   */
115*4882a593Smuzhiyun    #define IPS_REG_I2O_INMSGQ           0x40    /* I2O Inbound Message Queue   */
116*4882a593Smuzhiyun    #define IPS_REG_I2O_OUTMSGQ          0x44    /* I2O Outbound Message Queue  */
117*4882a593Smuzhiyun    #define IPS_REG_I2O_HIR              0x30    /* I2O Interrupt Status        */
118*4882a593Smuzhiyun    #define IPS_REG_I960_IDR             0x20    /* i960 Inbound Doorbell       */
119*4882a593Smuzhiyun    #define IPS_REG_I960_MSG0            0x18    /* i960 Outbound Reg 0         */
120*4882a593Smuzhiyun    #define IPS_REG_I960_MSG1            0x1C    /* i960 Outbound Reg 1         */
121*4882a593Smuzhiyun    #define IPS_REG_I960_OIMR            0x34    /* i960 Oubound Int Mask Reg   */
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun    /*
124*4882a593Smuzhiyun     * Adapter register bit equates
125*4882a593Smuzhiyun     */
126*4882a593Smuzhiyun    #define IPS_BIT_GHI                  0x04    /* HISR General Host Interrupt */
127*4882a593Smuzhiyun    #define IPS_BIT_SQO                  0x02    /* HISR Status Q Overflow      */
128*4882a593Smuzhiyun    #define IPS_BIT_SCE                  0x01    /* HISR Status Channel Enqueue */
129*4882a593Smuzhiyun    #define IPS_BIT_SEM                  0x08    /* CCCR Semaphore Bit          */
130*4882a593Smuzhiyun    #define IPS_BIT_ILE                  0x10    /* CCCR ILE Bit                */
131*4882a593Smuzhiyun    #define IPS_BIT_START_CMD            0x101A  /* CCCR Start Command Channel  */
132*4882a593Smuzhiyun    #define IPS_BIT_START_STOP           0x0002  /* CCCR Start/Stop Bit         */
133*4882a593Smuzhiyun    #define IPS_BIT_RST                  0x80    /* SCPR Reset Bit              */
134*4882a593Smuzhiyun    #define IPS_BIT_EBM                  0x02    /* SCPR Enable Bus Master      */
135*4882a593Smuzhiyun    #define IPS_BIT_EI                   0x80    /* HISR Enable Interrupts      */
136*4882a593Smuzhiyun    #define IPS_BIT_OP                   0x01    /* OP bit in CBSP              */
137*4882a593Smuzhiyun    #define IPS_BIT_I2O_OPQI             0x08    /* General Host Interrupt      */
138*4882a593Smuzhiyun    #define IPS_BIT_I960_MSG0I           0x01    /* Message Register 0 Interrupt*/
139*4882a593Smuzhiyun    #define IPS_BIT_I960_MSG1I           0x02    /* Message Register 1 Interrupt*/
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun    /*
142*4882a593Smuzhiyun     * Adapter Command ID Equates
143*4882a593Smuzhiyun     */
144*4882a593Smuzhiyun    #define IPS_CMD_GET_LD_INFO          0x19
145*4882a593Smuzhiyun    #define IPS_CMD_GET_SUBSYS           0x40
146*4882a593Smuzhiyun    #define IPS_CMD_READ_CONF            0x38
147*4882a593Smuzhiyun    #define IPS_CMD_RW_NVRAM_PAGE        0xBC
148*4882a593Smuzhiyun    #define IPS_CMD_READ                 0x02
149*4882a593Smuzhiyun    #define IPS_CMD_WRITE                0x03
150*4882a593Smuzhiyun    #define IPS_CMD_FFDC                 0xD7
151*4882a593Smuzhiyun    #define IPS_CMD_ENQUIRY              0x05
152*4882a593Smuzhiyun    #define IPS_CMD_FLUSH                0x0A
153*4882a593Smuzhiyun    #define IPS_CMD_READ_SG              0x82
154*4882a593Smuzhiyun    #define IPS_CMD_WRITE_SG             0x83
155*4882a593Smuzhiyun    #define IPS_CMD_DCDB                 0x04
156*4882a593Smuzhiyun    #define IPS_CMD_DCDB_SG              0x84
157*4882a593Smuzhiyun    #define IPS_CMD_EXTENDED_DCDB 	    0x95
158*4882a593Smuzhiyun    #define IPS_CMD_EXTENDED_DCDB_SG	    0x96
159*4882a593Smuzhiyun    #define IPS_CMD_CONFIG_SYNC          0x58
160*4882a593Smuzhiyun    #define IPS_CMD_ERROR_TABLE          0x17
161*4882a593Smuzhiyun    #define IPS_CMD_DOWNLOAD             0x20
162*4882a593Smuzhiyun    #define IPS_CMD_RW_BIOSFW            0x22
163*4882a593Smuzhiyun    #define IPS_CMD_GET_VERSION_INFO     0xC6
164*4882a593Smuzhiyun    #define IPS_CMD_RESET_CHANNEL        0x1A
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun    /*
167*4882a593Smuzhiyun     * Adapter Equates
168*4882a593Smuzhiyun     */
169*4882a593Smuzhiyun    #define IPS_CSL                      0xFF
170*4882a593Smuzhiyun    #define IPS_POCL                     0x30
171*4882a593Smuzhiyun    #define IPS_NORM_STATE               0x00
172*4882a593Smuzhiyun    #define IPS_MAX_ADAPTER_TYPES        3
173*4882a593Smuzhiyun    #define IPS_MAX_ADAPTERS             16
174*4882a593Smuzhiyun    #define IPS_MAX_IOCTL                1
175*4882a593Smuzhiyun    #define IPS_MAX_IOCTL_QUEUE          8
176*4882a593Smuzhiyun    #define IPS_MAX_QUEUE                128
177*4882a593Smuzhiyun    #define IPS_BLKSIZE                  512
178*4882a593Smuzhiyun    #define IPS_MAX_SG                   17
179*4882a593Smuzhiyun    #define IPS_MAX_LD                   8
180*4882a593Smuzhiyun    #define IPS_MAX_CHANNELS             4
181*4882a593Smuzhiyun    #define IPS_MAX_TARGETS              15
182*4882a593Smuzhiyun    #define IPS_MAX_CHUNKS               16
183*4882a593Smuzhiyun    #define IPS_MAX_CMDS                 128
184*4882a593Smuzhiyun    #define IPS_MAX_XFER                 0x10000
185*4882a593Smuzhiyun    #define IPS_NVRAM_P5_SIG             0xFFDDBB99
186*4882a593Smuzhiyun    #define IPS_MAX_POST_BYTES           0x02
187*4882a593Smuzhiyun    #define IPS_MAX_CONFIG_BYTES         0x02
188*4882a593Smuzhiyun    #define IPS_GOOD_POST_STATUS         0x80
189*4882a593Smuzhiyun    #define IPS_SEM_TIMEOUT              2000
190*4882a593Smuzhiyun    #define IPS_IOCTL_COMMAND            0x0D
191*4882a593Smuzhiyun    #define IPS_INTR_ON                  0
192*4882a593Smuzhiyun    #define IPS_INTR_IORL                1
193*4882a593Smuzhiyun    #define IPS_FFDC                     99
194*4882a593Smuzhiyun    #define IPS_ADAPTER_ID               0xF
195*4882a593Smuzhiyun    #define IPS_VENDORID_IBM             0x1014
196*4882a593Smuzhiyun    #define IPS_VENDORID_ADAPTEC         0x9005
197*4882a593Smuzhiyun    #define IPS_DEVICEID_COPPERHEAD      0x002E
198*4882a593Smuzhiyun    #define IPS_DEVICEID_MORPHEUS        0x01BD
199*4882a593Smuzhiyun    #define IPS_DEVICEID_MARCO           0x0250
200*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_4M           0x01BE
201*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_4L           0x01BF
202*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_4MX          0x0208
203*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_4LX          0x020E
204*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_5I2          0x0259
205*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_5I1          0x0258
206*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_6M           0x0279
207*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_6I           0x028C
208*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_7k           0x028E
209*4882a593Smuzhiyun    #define IPS_SUBDEVICEID_7M           0x028F
210*4882a593Smuzhiyun    #define IPS_IOCTL_SIZE               8192
211*4882a593Smuzhiyun    #define IPS_STATUS_SIZE              4
212*4882a593Smuzhiyun    #define IPS_STATUS_Q_SIZE            (IPS_MAX_CMDS+1) * IPS_STATUS_SIZE
213*4882a593Smuzhiyun    #define IPS_IMAGE_SIZE               500 * 1024
214*4882a593Smuzhiyun    #define IPS_MEMMAP_SIZE              128
215*4882a593Smuzhiyun    #define IPS_ONE_MSEC                 1
216*4882a593Smuzhiyun    #define IPS_ONE_SEC                  1000
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun    /*
219*4882a593Smuzhiyun     * Geometry Settings
220*4882a593Smuzhiyun     */
221*4882a593Smuzhiyun    #define IPS_COMP_HEADS               128
222*4882a593Smuzhiyun    #define IPS_COMP_SECTORS             32
223*4882a593Smuzhiyun    #define IPS_NORM_HEADS               254
224*4882a593Smuzhiyun    #define IPS_NORM_SECTORS             63
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun    /*
227*4882a593Smuzhiyun     * Adapter Basic Status Codes
228*4882a593Smuzhiyun     */
229*4882a593Smuzhiyun    #define IPS_BASIC_STATUS_MASK        0xFF
230*4882a593Smuzhiyun    #define IPS_GSC_STATUS_MASK          0x0F
231*4882a593Smuzhiyun    #define IPS_CMD_SUCCESS              0x00
232*4882a593Smuzhiyun    #define IPS_CMD_RECOVERED_ERROR      0x01
233*4882a593Smuzhiyun    #define IPS_INVAL_OPCO               0x03
234*4882a593Smuzhiyun    #define IPS_INVAL_CMD_BLK            0x04
235*4882a593Smuzhiyun    #define IPS_INVAL_PARM_BLK           0x05
236*4882a593Smuzhiyun    #define IPS_BUSY                     0x08
237*4882a593Smuzhiyun    #define IPS_CMD_CMPLT_WERROR         0x0C
238*4882a593Smuzhiyun    #define IPS_LD_ERROR                 0x0D
239*4882a593Smuzhiyun    #define IPS_CMD_TIMEOUT              0x0E
240*4882a593Smuzhiyun    #define IPS_PHYS_DRV_ERROR           0x0F
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun    /*
243*4882a593Smuzhiyun     * Adapter Extended Status Equates
244*4882a593Smuzhiyun     */
245*4882a593Smuzhiyun    #define IPS_ERR_SEL_TO               0xF0
246*4882a593Smuzhiyun    #define IPS_ERR_OU_RUN               0xF2
247*4882a593Smuzhiyun    #define IPS_ERR_HOST_RESET           0xF7
248*4882a593Smuzhiyun    #define IPS_ERR_DEV_RESET            0xF8
249*4882a593Smuzhiyun    #define IPS_ERR_RECOVERY             0xFC
250*4882a593Smuzhiyun    #define IPS_ERR_CKCOND               0xFF
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun    /*
253*4882a593Smuzhiyun     * Operating System Defines
254*4882a593Smuzhiyun     */
255*4882a593Smuzhiyun    #define IPS_OS_WINDOWS_NT            0x01
256*4882a593Smuzhiyun    #define IPS_OS_NETWARE               0x02
257*4882a593Smuzhiyun    #define IPS_OS_OPENSERVER            0x03
258*4882a593Smuzhiyun    #define IPS_OS_UNIXWARE              0x04
259*4882a593Smuzhiyun    #define IPS_OS_SOLARIS               0x05
260*4882a593Smuzhiyun    #define IPS_OS_OS2                   0x06
261*4882a593Smuzhiyun    #define IPS_OS_LINUX                 0x07
262*4882a593Smuzhiyun    #define IPS_OS_FREEBSD               0x08
263*4882a593Smuzhiyun 
264*4882a593Smuzhiyun    /*
265*4882a593Smuzhiyun     * Adapter Revision ID's
266*4882a593Smuzhiyun     */
267*4882a593Smuzhiyun    #define IPS_REVID_SERVERAID          0x02
268*4882a593Smuzhiyun    #define IPS_REVID_NAVAJO             0x03
269*4882a593Smuzhiyun    #define IPS_REVID_SERVERAID2         0x04
270*4882a593Smuzhiyun    #define IPS_REVID_CLARINETP1         0x05
271*4882a593Smuzhiyun    #define IPS_REVID_CLARINETP2         0x07
272*4882a593Smuzhiyun    #define IPS_REVID_CLARINETP3         0x0D
273*4882a593Smuzhiyun    #define IPS_REVID_TROMBONE32         0x0F
274*4882a593Smuzhiyun    #define IPS_REVID_TROMBONE64         0x10
275*4882a593Smuzhiyun 
276*4882a593Smuzhiyun    /*
277*4882a593Smuzhiyun     * NVRAM Page 5 Adapter Defines
278*4882a593Smuzhiyun     */
279*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID         0x01
280*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID2        0x02
281*4882a593Smuzhiyun    #define IPS_ADTYPE_NAVAJO            0x03
282*4882a593Smuzhiyun    #define IPS_ADTYPE_KIOWA             0x04
283*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID3        0x05
284*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID3L       0x06
285*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID4H       0x07
286*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID4M       0x08
287*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID4L       0x09
288*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID4MX      0x0A
289*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID4LX      0x0B
290*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID5I2      0x0C
291*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID5I1      0x0D
292*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID6M       0x0E
293*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID6I       0x0F
294*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID7t       0x10
295*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID7k       0x11
296*4882a593Smuzhiyun    #define IPS_ADTYPE_SERVERAID7M       0x12
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun    /*
299*4882a593Smuzhiyun     * Adapter Command/Status Packet Definitions
300*4882a593Smuzhiyun     */
301*4882a593Smuzhiyun    #define IPS_SUCCESS                  0x01 /* Successfully completed       */
302*4882a593Smuzhiyun    #define IPS_SUCCESS_IMM              0x02 /* Success - Immediately        */
303*4882a593Smuzhiyun    #define IPS_FAILURE                  0x04 /* Completed with Error         */
304*4882a593Smuzhiyun 
305*4882a593Smuzhiyun    /*
306*4882a593Smuzhiyun     * Logical Drive Equates
307*4882a593Smuzhiyun     */
308*4882a593Smuzhiyun    #define IPS_LD_OFFLINE               0x02
309*4882a593Smuzhiyun    #define IPS_LD_OKAY                  0x03
310*4882a593Smuzhiyun    #define IPS_LD_FREE                  0x00
311*4882a593Smuzhiyun    #define IPS_LD_SYS                   0x06
312*4882a593Smuzhiyun    #define IPS_LD_CRS                   0x24
313*4882a593Smuzhiyun 
314*4882a593Smuzhiyun    /*
315*4882a593Smuzhiyun     * DCDB Table Equates
316*4882a593Smuzhiyun     */
317*4882a593Smuzhiyun    #define IPS_NO_DISCONNECT            0x00
318*4882a593Smuzhiyun    #define IPS_DISCONNECT_ALLOWED       0x80
319*4882a593Smuzhiyun    #define IPS_NO_AUTO_REQSEN           0x40
320*4882a593Smuzhiyun    #define IPS_DATA_NONE                0x00
321*4882a593Smuzhiyun    #define IPS_DATA_UNK                 0x00
322*4882a593Smuzhiyun    #define IPS_DATA_IN                  0x01
323*4882a593Smuzhiyun    #define IPS_DATA_OUT                 0x02
324*4882a593Smuzhiyun    #define IPS_TRANSFER64K              0x08
325*4882a593Smuzhiyun    #define IPS_NOTIMEOUT                0x00
326*4882a593Smuzhiyun    #define IPS_TIMEOUT10                0x10
327*4882a593Smuzhiyun    #define IPS_TIMEOUT60                0x20
328*4882a593Smuzhiyun    #define IPS_TIMEOUT20M               0x30
329*4882a593Smuzhiyun 
330*4882a593Smuzhiyun    /*
331*4882a593Smuzhiyun     * SCSI Inquiry Data Flags
332*4882a593Smuzhiyun     */
333*4882a593Smuzhiyun    #define IPS_SCSI_INQ_TYPE_DASD       0x00
334*4882a593Smuzhiyun    #define IPS_SCSI_INQ_TYPE_PROCESSOR  0x03
335*4882a593Smuzhiyun    #define IPS_SCSI_INQ_LU_CONNECTED    0x00
336*4882a593Smuzhiyun    #define IPS_SCSI_INQ_RD_REV2         0x02
337*4882a593Smuzhiyun    #define IPS_SCSI_INQ_REV2            0x02
338*4882a593Smuzhiyun    #define IPS_SCSI_INQ_REV3            0x03
339*4882a593Smuzhiyun    #define IPS_SCSI_INQ_Address16       0x01
340*4882a593Smuzhiyun    #define IPS_SCSI_INQ_Address32       0x02
341*4882a593Smuzhiyun    #define IPS_SCSI_INQ_MedChanger      0x08
342*4882a593Smuzhiyun    #define IPS_SCSI_INQ_MultiPort       0x10
343*4882a593Smuzhiyun    #define IPS_SCSI_INQ_EncServ         0x40
344*4882a593Smuzhiyun    #define IPS_SCSI_INQ_SoftReset       0x01
345*4882a593Smuzhiyun    #define IPS_SCSI_INQ_CmdQue          0x02
346*4882a593Smuzhiyun    #define IPS_SCSI_INQ_Linked          0x08
347*4882a593Smuzhiyun    #define IPS_SCSI_INQ_Sync            0x10
348*4882a593Smuzhiyun    #define IPS_SCSI_INQ_WBus16          0x20
349*4882a593Smuzhiyun    #define IPS_SCSI_INQ_WBus32          0x40
350*4882a593Smuzhiyun    #define IPS_SCSI_INQ_RelAdr          0x80
351*4882a593Smuzhiyun 
352*4882a593Smuzhiyun    /*
353*4882a593Smuzhiyun     * SCSI Request Sense Data Flags
354*4882a593Smuzhiyun     */
355*4882a593Smuzhiyun    #define IPS_SCSI_REQSEN_VALID        0x80
356*4882a593Smuzhiyun    #define IPS_SCSI_REQSEN_CURRENT_ERR  0x70
357*4882a593Smuzhiyun    #define IPS_SCSI_REQSEN_NO_SENSE     0x00
358*4882a593Smuzhiyun 
359*4882a593Smuzhiyun    /*
360*4882a593Smuzhiyun     * SCSI Mode Page Equates
361*4882a593Smuzhiyun     */
362*4882a593Smuzhiyun    #define IPS_SCSI_MP3_SoftSector      0x01
363*4882a593Smuzhiyun    #define IPS_SCSI_MP3_HardSector      0x02
364*4882a593Smuzhiyun    #define IPS_SCSI_MP3_Removeable      0x04
365*4882a593Smuzhiyun    #define IPS_SCSI_MP3_AllocateSurface 0x08
366*4882a593Smuzhiyun 
367*4882a593Smuzhiyun    /*
368*4882a593Smuzhiyun     * HA Flags
369*4882a593Smuzhiyun     */
370*4882a593Smuzhiyun 
371*4882a593Smuzhiyun    #define IPS_HA_ENH_SG                0x1
372*4882a593Smuzhiyun 
373*4882a593Smuzhiyun    /*
374*4882a593Smuzhiyun     * SCB Flags
375*4882a593Smuzhiyun     */
376*4882a593Smuzhiyun    #define IPS_SCB_MAP_SG               0x00008
377*4882a593Smuzhiyun    #define IPS_SCB_MAP_SINGLE           0X00010
378*4882a593Smuzhiyun 
379*4882a593Smuzhiyun    /*
380*4882a593Smuzhiyun     * Passthru stuff
381*4882a593Smuzhiyun     */
382*4882a593Smuzhiyun    #define IPS_COPPUSRCMD              (('C'<<8) | 65)
383*4882a593Smuzhiyun    #define IPS_COPPIOCCMD              (('C'<<8) | 66)
384*4882a593Smuzhiyun    #define IPS_NUMCTRLS                (('C'<<8) | 68)
385*4882a593Smuzhiyun    #define IPS_CTRLINFO                (('C'<<8) | 69)
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun    /* flashing defines */
388*4882a593Smuzhiyun    #define IPS_FW_IMAGE                0x00
389*4882a593Smuzhiyun    #define IPS_BIOS_IMAGE              0x01
390*4882a593Smuzhiyun    #define IPS_WRITE_FW                0x01
391*4882a593Smuzhiyun    #define IPS_WRITE_BIOS              0x02
392*4882a593Smuzhiyun    #define IPS_ERASE_BIOS              0x03
393*4882a593Smuzhiyun    #define IPS_BIOS_HEADER             0xC0
394*4882a593Smuzhiyun 
395*4882a593Smuzhiyun    /* time oriented stuff */
396*4882a593Smuzhiyun    #define IPS_SECS_8HOURS              28800
397*4882a593Smuzhiyun 
398*4882a593Smuzhiyun    /*
399*4882a593Smuzhiyun     * Scsi_Host Template
400*4882a593Smuzhiyun     */
401*4882a593Smuzhiyun    static int ips_biosparam(struct scsi_device *sdev, struct block_device *bdev,
402*4882a593Smuzhiyun 		sector_t capacity, int geom[]);
403*4882a593Smuzhiyun    static int ips_slave_configure(struct scsi_device *SDptr);
404*4882a593Smuzhiyun 
405*4882a593Smuzhiyun /*
406*4882a593Smuzhiyun  * Raid Command Formats
407*4882a593Smuzhiyun  */
408*4882a593Smuzhiyun typedef struct {
409*4882a593Smuzhiyun    uint8_t  op_code;
410*4882a593Smuzhiyun    uint8_t  command_id;
411*4882a593Smuzhiyun    uint8_t  log_drv;
412*4882a593Smuzhiyun    uint8_t  sg_count;
413*4882a593Smuzhiyun    uint32_t lba;
414*4882a593Smuzhiyun    uint32_t sg_addr;
415*4882a593Smuzhiyun    uint16_t sector_count;
416*4882a593Smuzhiyun    uint8_t  segment_4G;
417*4882a593Smuzhiyun    uint8_t  enhanced_sg;
418*4882a593Smuzhiyun    uint32_t ccsar;
419*4882a593Smuzhiyun    uint32_t cccr;
420*4882a593Smuzhiyun } IPS_IO_CMD, *PIPS_IO_CMD;
421*4882a593Smuzhiyun 
422*4882a593Smuzhiyun typedef struct {
423*4882a593Smuzhiyun    uint8_t  op_code;
424*4882a593Smuzhiyun    uint8_t  command_id;
425*4882a593Smuzhiyun    uint16_t reserved;
426*4882a593Smuzhiyun    uint32_t reserved2;
427*4882a593Smuzhiyun    uint32_t buffer_addr;
428*4882a593Smuzhiyun    uint32_t reserved3;
429*4882a593Smuzhiyun    uint32_t ccsar;
430*4882a593Smuzhiyun    uint32_t cccr;
431*4882a593Smuzhiyun } IPS_LD_CMD, *PIPS_LD_CMD;
432*4882a593Smuzhiyun 
433*4882a593Smuzhiyun typedef struct {
434*4882a593Smuzhiyun    uint8_t  op_code;
435*4882a593Smuzhiyun    uint8_t  command_id;
436*4882a593Smuzhiyun    uint8_t  reserved;
437*4882a593Smuzhiyun    uint8_t  reserved2;
438*4882a593Smuzhiyun    uint32_t reserved3;
439*4882a593Smuzhiyun    uint32_t buffer_addr;
440*4882a593Smuzhiyun    uint32_t reserved4;
441*4882a593Smuzhiyun } IPS_IOCTL_CMD, *PIPS_IOCTL_CMD;
442*4882a593Smuzhiyun 
443*4882a593Smuzhiyun typedef struct {
444*4882a593Smuzhiyun    uint8_t  op_code;
445*4882a593Smuzhiyun    uint8_t  command_id;
446*4882a593Smuzhiyun    uint8_t  channel;
447*4882a593Smuzhiyun    uint8_t  reserved3;
448*4882a593Smuzhiyun    uint8_t  reserved4;
449*4882a593Smuzhiyun    uint8_t  reserved5;
450*4882a593Smuzhiyun    uint8_t  reserved6;
451*4882a593Smuzhiyun    uint8_t  reserved7;
452*4882a593Smuzhiyun    uint8_t  reserved8;
453*4882a593Smuzhiyun    uint8_t  reserved9;
454*4882a593Smuzhiyun    uint8_t  reserved10;
455*4882a593Smuzhiyun    uint8_t  reserved11;
456*4882a593Smuzhiyun    uint8_t  reserved12;
457*4882a593Smuzhiyun    uint8_t  reserved13;
458*4882a593Smuzhiyun    uint8_t  reserved14;
459*4882a593Smuzhiyun    uint8_t  adapter_flag;
460*4882a593Smuzhiyun } IPS_RESET_CMD, *PIPS_RESET_CMD;
461*4882a593Smuzhiyun 
462*4882a593Smuzhiyun typedef struct {
463*4882a593Smuzhiyun    uint8_t  op_code;
464*4882a593Smuzhiyun    uint8_t  command_id;
465*4882a593Smuzhiyun    uint16_t reserved;
466*4882a593Smuzhiyun    uint32_t reserved2;
467*4882a593Smuzhiyun    uint32_t dcdb_address;
468*4882a593Smuzhiyun    uint16_t reserved3;
469*4882a593Smuzhiyun    uint8_t  segment_4G;
470*4882a593Smuzhiyun    uint8_t  enhanced_sg;
471*4882a593Smuzhiyun    uint32_t ccsar;
472*4882a593Smuzhiyun    uint32_t cccr;
473*4882a593Smuzhiyun } IPS_DCDB_CMD, *PIPS_DCDB_CMD;
474*4882a593Smuzhiyun 
475*4882a593Smuzhiyun typedef struct {
476*4882a593Smuzhiyun    uint8_t  op_code;
477*4882a593Smuzhiyun    uint8_t  command_id;
478*4882a593Smuzhiyun    uint8_t  channel;
479*4882a593Smuzhiyun    uint8_t  source_target;
480*4882a593Smuzhiyun    uint32_t reserved;
481*4882a593Smuzhiyun    uint32_t reserved2;
482*4882a593Smuzhiyun    uint32_t reserved3;
483*4882a593Smuzhiyun    uint32_t ccsar;
484*4882a593Smuzhiyun    uint32_t cccr;
485*4882a593Smuzhiyun } IPS_CS_CMD, *PIPS_CS_CMD;
486*4882a593Smuzhiyun 
487*4882a593Smuzhiyun typedef struct {
488*4882a593Smuzhiyun    uint8_t  op_code;
489*4882a593Smuzhiyun    uint8_t  command_id;
490*4882a593Smuzhiyun    uint8_t  log_drv;
491*4882a593Smuzhiyun    uint8_t  control;
492*4882a593Smuzhiyun    uint32_t reserved;
493*4882a593Smuzhiyun    uint32_t reserved2;
494*4882a593Smuzhiyun    uint32_t reserved3;
495*4882a593Smuzhiyun    uint32_t ccsar;
496*4882a593Smuzhiyun    uint32_t cccr;
497*4882a593Smuzhiyun } IPS_US_CMD, *PIPS_US_CMD;
498*4882a593Smuzhiyun 
499*4882a593Smuzhiyun typedef struct {
500*4882a593Smuzhiyun    uint8_t  op_code;
501*4882a593Smuzhiyun    uint8_t  command_id;
502*4882a593Smuzhiyun    uint8_t  reserved;
503*4882a593Smuzhiyun    uint8_t  state;
504*4882a593Smuzhiyun    uint32_t reserved2;
505*4882a593Smuzhiyun    uint32_t reserved3;
506*4882a593Smuzhiyun    uint32_t reserved4;
507*4882a593Smuzhiyun    uint32_t ccsar;
508*4882a593Smuzhiyun    uint32_t cccr;
509*4882a593Smuzhiyun } IPS_FC_CMD, *PIPS_FC_CMD;
510*4882a593Smuzhiyun 
511*4882a593Smuzhiyun typedef struct {
512*4882a593Smuzhiyun    uint8_t  op_code;
513*4882a593Smuzhiyun    uint8_t  command_id;
514*4882a593Smuzhiyun    uint8_t  reserved;
515*4882a593Smuzhiyun    uint8_t  desc;
516*4882a593Smuzhiyun    uint32_t reserved2;
517*4882a593Smuzhiyun    uint32_t buffer_addr;
518*4882a593Smuzhiyun    uint32_t reserved3;
519*4882a593Smuzhiyun    uint32_t ccsar;
520*4882a593Smuzhiyun    uint32_t cccr;
521*4882a593Smuzhiyun } IPS_STATUS_CMD, *PIPS_STATUS_CMD;
522*4882a593Smuzhiyun 
523*4882a593Smuzhiyun typedef struct {
524*4882a593Smuzhiyun    uint8_t  op_code;
525*4882a593Smuzhiyun    uint8_t  command_id;
526*4882a593Smuzhiyun    uint8_t  page;
527*4882a593Smuzhiyun    uint8_t  write;
528*4882a593Smuzhiyun    uint32_t reserved;
529*4882a593Smuzhiyun    uint32_t buffer_addr;
530*4882a593Smuzhiyun    uint32_t reserved2;
531*4882a593Smuzhiyun    uint32_t ccsar;
532*4882a593Smuzhiyun    uint32_t cccr;
533*4882a593Smuzhiyun } IPS_NVRAM_CMD, *PIPS_NVRAM_CMD;
534*4882a593Smuzhiyun 
535*4882a593Smuzhiyun typedef struct
536*4882a593Smuzhiyun {
537*4882a593Smuzhiyun     uint8_t  op_code;
538*4882a593Smuzhiyun     uint8_t  command_id;
539*4882a593Smuzhiyun     uint16_t reserved;
540*4882a593Smuzhiyun     uint32_t count;
541*4882a593Smuzhiyun     uint32_t buffer_addr;
542*4882a593Smuzhiyun     uint32_t reserved2;
543*4882a593Smuzhiyun } IPS_VERSION_INFO, *PIPS_VERSION_INFO;
544*4882a593Smuzhiyun 
545*4882a593Smuzhiyun typedef struct {
546*4882a593Smuzhiyun    uint8_t  op_code;
547*4882a593Smuzhiyun    uint8_t  command_id;
548*4882a593Smuzhiyun    uint8_t  reset_count;
549*4882a593Smuzhiyun    uint8_t  reset_type;
550*4882a593Smuzhiyun    uint8_t  second;
551*4882a593Smuzhiyun    uint8_t  minute;
552*4882a593Smuzhiyun    uint8_t  hour;
553*4882a593Smuzhiyun    uint8_t  day;
554*4882a593Smuzhiyun    uint8_t  reserved1[4];
555*4882a593Smuzhiyun    uint8_t  month;
556*4882a593Smuzhiyun    uint8_t  yearH;
557*4882a593Smuzhiyun    uint8_t  yearL;
558*4882a593Smuzhiyun    uint8_t  reserved2;
559*4882a593Smuzhiyun } IPS_FFDC_CMD, *PIPS_FFDC_CMD;
560*4882a593Smuzhiyun 
561*4882a593Smuzhiyun typedef struct {
562*4882a593Smuzhiyun    uint8_t  op_code;
563*4882a593Smuzhiyun    uint8_t  command_id;
564*4882a593Smuzhiyun    uint8_t  type;
565*4882a593Smuzhiyun    uint8_t  direction;
566*4882a593Smuzhiyun    uint32_t count;
567*4882a593Smuzhiyun    uint32_t buffer_addr;
568*4882a593Smuzhiyun    uint8_t  total_packets;
569*4882a593Smuzhiyun    uint8_t  packet_num;
570*4882a593Smuzhiyun    uint16_t reserved;
571*4882a593Smuzhiyun } IPS_FLASHFW_CMD, *PIPS_FLASHFW_CMD;
572*4882a593Smuzhiyun 
573*4882a593Smuzhiyun typedef struct {
574*4882a593Smuzhiyun    uint8_t  op_code;
575*4882a593Smuzhiyun    uint8_t  command_id;
576*4882a593Smuzhiyun    uint8_t  type;
577*4882a593Smuzhiyun    uint8_t  direction;
578*4882a593Smuzhiyun    uint32_t count;
579*4882a593Smuzhiyun    uint32_t buffer_addr;
580*4882a593Smuzhiyun    uint32_t offset;
581*4882a593Smuzhiyun } IPS_FLASHBIOS_CMD, *PIPS_FLASHBIOS_CMD;
582*4882a593Smuzhiyun 
583*4882a593Smuzhiyun typedef union {
584*4882a593Smuzhiyun    IPS_IO_CMD         basic_io;
585*4882a593Smuzhiyun    IPS_LD_CMD         logical_info;
586*4882a593Smuzhiyun    IPS_IOCTL_CMD      ioctl_info;
587*4882a593Smuzhiyun    IPS_DCDB_CMD       dcdb;
588*4882a593Smuzhiyun    IPS_CS_CMD         config_sync;
589*4882a593Smuzhiyun    IPS_US_CMD         unlock_stripe;
590*4882a593Smuzhiyun    IPS_FC_CMD         flush_cache;
591*4882a593Smuzhiyun    IPS_STATUS_CMD     status;
592*4882a593Smuzhiyun    IPS_NVRAM_CMD      nvram;
593*4882a593Smuzhiyun    IPS_FFDC_CMD       ffdc;
594*4882a593Smuzhiyun    IPS_FLASHFW_CMD    flashfw;
595*4882a593Smuzhiyun    IPS_FLASHBIOS_CMD  flashbios;
596*4882a593Smuzhiyun    IPS_VERSION_INFO   version_info;
597*4882a593Smuzhiyun    IPS_RESET_CMD      reset;
598*4882a593Smuzhiyun } IPS_HOST_COMMAND, *PIPS_HOST_COMMAND;
599*4882a593Smuzhiyun 
600*4882a593Smuzhiyun typedef struct {
601*4882a593Smuzhiyun    uint8_t  logical_id;
602*4882a593Smuzhiyun    uint8_t  reserved;
603*4882a593Smuzhiyun    uint8_t  raid_level;
604*4882a593Smuzhiyun    uint8_t  state;
605*4882a593Smuzhiyun    uint32_t sector_count;
606*4882a593Smuzhiyun } IPS_DRIVE_INFO, *PIPS_DRIVE_INFO;
607*4882a593Smuzhiyun 
608*4882a593Smuzhiyun typedef struct {
609*4882a593Smuzhiyun    uint8_t       no_of_log_drive;
610*4882a593Smuzhiyun    uint8_t       reserved[3];
611*4882a593Smuzhiyun    IPS_DRIVE_INFO drive_info[IPS_MAX_LD];
612*4882a593Smuzhiyun } IPS_LD_INFO, *PIPS_LD_INFO;
613*4882a593Smuzhiyun 
614*4882a593Smuzhiyun typedef struct {
615*4882a593Smuzhiyun    uint8_t   device_address;
616*4882a593Smuzhiyun    uint8_t   cmd_attribute;
617*4882a593Smuzhiyun    uint16_t  transfer_length;
618*4882a593Smuzhiyun    uint32_t  buffer_pointer;
619*4882a593Smuzhiyun    uint8_t   cdb_length;
620*4882a593Smuzhiyun    uint8_t   sense_length;
621*4882a593Smuzhiyun    uint8_t   sg_count;
622*4882a593Smuzhiyun    uint8_t   reserved;
623*4882a593Smuzhiyun    uint8_t   scsi_cdb[12];
624*4882a593Smuzhiyun    uint8_t   sense_info[64];
625*4882a593Smuzhiyun    uint8_t   scsi_status;
626*4882a593Smuzhiyun    uint8_t   reserved2[3];
627*4882a593Smuzhiyun } IPS_DCDB_TABLE, *PIPS_DCDB_TABLE;
628*4882a593Smuzhiyun 
629*4882a593Smuzhiyun typedef struct {
630*4882a593Smuzhiyun    uint8_t   device_address;
631*4882a593Smuzhiyun    uint8_t   cmd_attribute;
632*4882a593Smuzhiyun    uint8_t   cdb_length;
633*4882a593Smuzhiyun    uint8_t   reserved_for_LUN;
634*4882a593Smuzhiyun    uint32_t  transfer_length;
635*4882a593Smuzhiyun    uint32_t  buffer_pointer;
636*4882a593Smuzhiyun    uint16_t  sg_count;
637*4882a593Smuzhiyun    uint8_t   sense_length;
638*4882a593Smuzhiyun    uint8_t   scsi_status;
639*4882a593Smuzhiyun    uint32_t  reserved;
640*4882a593Smuzhiyun    uint8_t   scsi_cdb[16];
641*4882a593Smuzhiyun    uint8_t   sense_info[56];
642*4882a593Smuzhiyun } IPS_DCDB_TABLE_TAPE, *PIPS_DCDB_TABLE_TAPE;
643*4882a593Smuzhiyun 
644*4882a593Smuzhiyun typedef union {
645*4882a593Smuzhiyun    struct {
646*4882a593Smuzhiyun       volatile uint8_t  reserved;
647*4882a593Smuzhiyun       volatile uint8_t  command_id;
648*4882a593Smuzhiyun       volatile uint8_t  basic_status;
649*4882a593Smuzhiyun       volatile uint8_t  extended_status;
650*4882a593Smuzhiyun    } fields;
651*4882a593Smuzhiyun 
652*4882a593Smuzhiyun    volatile uint32_t    value;
653*4882a593Smuzhiyun } IPS_STATUS, *PIPS_STATUS;
654*4882a593Smuzhiyun 
655*4882a593Smuzhiyun typedef struct {
656*4882a593Smuzhiyun    IPS_STATUS           status[IPS_MAX_CMDS + 1];
657*4882a593Smuzhiyun    volatile PIPS_STATUS p_status_start;
658*4882a593Smuzhiyun    volatile PIPS_STATUS p_status_end;
659*4882a593Smuzhiyun    volatile PIPS_STATUS p_status_tail;
660*4882a593Smuzhiyun    volatile uint32_t    hw_status_start;
661*4882a593Smuzhiyun    volatile uint32_t    hw_status_tail;
662*4882a593Smuzhiyun } IPS_ADAPTER, *PIPS_ADAPTER;
663*4882a593Smuzhiyun 
664*4882a593Smuzhiyun typedef struct {
665*4882a593Smuzhiyun    uint8_t  ucLogDriveCount;
666*4882a593Smuzhiyun    uint8_t  ucMiscFlag;
667*4882a593Smuzhiyun    uint8_t  ucSLTFlag;
668*4882a593Smuzhiyun    uint8_t  ucBSTFlag;
669*4882a593Smuzhiyun    uint8_t  ucPwrChgCnt;
670*4882a593Smuzhiyun    uint8_t  ucWrongAdrCnt;
671*4882a593Smuzhiyun    uint8_t  ucUnidentCnt;
672*4882a593Smuzhiyun    uint8_t  ucNVramDevChgCnt;
673*4882a593Smuzhiyun    uint8_t  CodeBlkVersion[8];
674*4882a593Smuzhiyun    uint8_t  BootBlkVersion[8];
675*4882a593Smuzhiyun    uint32_t ulDriveSize[IPS_MAX_LD];
676*4882a593Smuzhiyun    uint8_t  ucConcurrentCmdCount;
677*4882a593Smuzhiyun    uint8_t  ucMaxPhysicalDevices;
678*4882a593Smuzhiyun    uint16_t usFlashRepgmCount;
679*4882a593Smuzhiyun    uint8_t  ucDefunctDiskCount;
680*4882a593Smuzhiyun    uint8_t  ucRebuildFlag;
681*4882a593Smuzhiyun    uint8_t  ucOfflineLogDrvCount;
682*4882a593Smuzhiyun    uint8_t  ucCriticalDrvCount;
683*4882a593Smuzhiyun    uint16_t usConfigUpdateCount;
684*4882a593Smuzhiyun    uint8_t  ucBlkFlag;
685*4882a593Smuzhiyun    uint8_t  reserved;
686*4882a593Smuzhiyun    uint16_t usAddrDeadDisk[IPS_MAX_CHANNELS * (IPS_MAX_TARGETS + 1)];
687*4882a593Smuzhiyun } IPS_ENQ, *PIPS_ENQ;
688*4882a593Smuzhiyun 
689*4882a593Smuzhiyun typedef struct {
690*4882a593Smuzhiyun    uint8_t  ucInitiator;
691*4882a593Smuzhiyun    uint8_t  ucParameters;
692*4882a593Smuzhiyun    uint8_t  ucMiscFlag;
693*4882a593Smuzhiyun    uint8_t  ucState;
694*4882a593Smuzhiyun    uint32_t ulBlockCount;
695*4882a593Smuzhiyun    uint8_t  ucDeviceId[28];
696*4882a593Smuzhiyun } IPS_DEVSTATE, *PIPS_DEVSTATE;
697*4882a593Smuzhiyun 
698*4882a593Smuzhiyun typedef struct {
699*4882a593Smuzhiyun    uint8_t  ucChn;
700*4882a593Smuzhiyun    uint8_t  ucTgt;
701*4882a593Smuzhiyun    uint16_t ucReserved;
702*4882a593Smuzhiyun    uint32_t ulStartSect;
703*4882a593Smuzhiyun    uint32_t ulNoOfSects;
704*4882a593Smuzhiyun } IPS_CHUNK, *PIPS_CHUNK;
705*4882a593Smuzhiyun 
706*4882a593Smuzhiyun typedef struct {
707*4882a593Smuzhiyun    uint16_t ucUserField;
708*4882a593Smuzhiyun    uint8_t  ucState;
709*4882a593Smuzhiyun    uint8_t  ucRaidCacheParam;
710*4882a593Smuzhiyun    uint8_t  ucNoOfChunkUnits;
711*4882a593Smuzhiyun    uint8_t  ucStripeSize;
712*4882a593Smuzhiyun    uint8_t  ucParams;
713*4882a593Smuzhiyun    uint8_t  ucReserved;
714*4882a593Smuzhiyun    uint32_t ulLogDrvSize;
715*4882a593Smuzhiyun    IPS_CHUNK chunk[IPS_MAX_CHUNKS];
716*4882a593Smuzhiyun } IPS_LD, *PIPS_LD;
717*4882a593Smuzhiyun 
718*4882a593Smuzhiyun typedef struct {
719*4882a593Smuzhiyun    uint8_t  board_disc[8];
720*4882a593Smuzhiyun    uint8_t  processor[8];
721*4882a593Smuzhiyun    uint8_t  ucNoChanType;
722*4882a593Smuzhiyun    uint8_t  ucNoHostIntType;
723*4882a593Smuzhiyun    uint8_t  ucCompression;
724*4882a593Smuzhiyun    uint8_t  ucNvramType;
725*4882a593Smuzhiyun    uint32_t ulNvramSize;
726*4882a593Smuzhiyun } IPS_HARDWARE, *PIPS_HARDWARE;
727*4882a593Smuzhiyun 
728*4882a593Smuzhiyun typedef struct {
729*4882a593Smuzhiyun    uint8_t        ucLogDriveCount;
730*4882a593Smuzhiyun    uint8_t        ucDateD;
731*4882a593Smuzhiyun    uint8_t        ucDateM;
732*4882a593Smuzhiyun    uint8_t        ucDateY;
733*4882a593Smuzhiyun    uint8_t        init_id[4];
734*4882a593Smuzhiyun    uint8_t        host_id[12];
735*4882a593Smuzhiyun    uint8_t        time_sign[8];
736*4882a593Smuzhiyun    uint32_t       UserOpt;
737*4882a593Smuzhiyun    uint16_t       user_field;
738*4882a593Smuzhiyun    uint8_t        ucRebuildRate;
739*4882a593Smuzhiyun    uint8_t        ucReserve;
740*4882a593Smuzhiyun    IPS_HARDWARE   hardware_disc;
741*4882a593Smuzhiyun    IPS_LD         logical_drive[IPS_MAX_LD];
742*4882a593Smuzhiyun    IPS_DEVSTATE   dev[IPS_MAX_CHANNELS][IPS_MAX_TARGETS+1];
743*4882a593Smuzhiyun    uint8_t        reserved[512];
744*4882a593Smuzhiyun } IPS_CONF, *PIPS_CONF;
745*4882a593Smuzhiyun 
746*4882a593Smuzhiyun typedef struct {
747*4882a593Smuzhiyun    uint32_t  signature;
748*4882a593Smuzhiyun    uint8_t   reserved1;
749*4882a593Smuzhiyun    uint8_t   adapter_slot;
750*4882a593Smuzhiyun    uint16_t  adapter_type;
751*4882a593Smuzhiyun    uint8_t   ctrl_bios[8];
752*4882a593Smuzhiyun    uint8_t   versioning;                   /* 1 = Versioning Supported, else 0 */
753*4882a593Smuzhiyun    uint8_t   version_mismatch;             /* 1 = Versioning MisMatch,  else 0 */
754*4882a593Smuzhiyun    uint8_t   reserved2;
755*4882a593Smuzhiyun    uint8_t   operating_system;
756*4882a593Smuzhiyun    uint8_t   driver_high[4];
757*4882a593Smuzhiyun    uint8_t   driver_low[4];
758*4882a593Smuzhiyun    uint8_t   BiosCompatibilityID[8];
759*4882a593Smuzhiyun    uint8_t   ReservedForOS2[8];
760*4882a593Smuzhiyun    uint8_t   bios_high[4];                 /* Adapter's Flashed BIOS Version   */
761*4882a593Smuzhiyun    uint8_t   bios_low[4];
762*4882a593Smuzhiyun    uint8_t   adapter_order[16];            /* BIOS Telling us the Sort Order   */
763*4882a593Smuzhiyun    uint8_t   Filler[60];
764*4882a593Smuzhiyun } IPS_NVRAM_P5, *PIPS_NVRAM_P5;
765*4882a593Smuzhiyun 
766*4882a593Smuzhiyun /*--------------------------------------------------------------------------*/
767*4882a593Smuzhiyun /* Data returned from a GetVersion Command                                  */
768*4882a593Smuzhiyun /*--------------------------------------------------------------------------*/
769*4882a593Smuzhiyun 
770*4882a593Smuzhiyun                                              /* SubSystem Parameter[4]      */
771*4882a593Smuzhiyun #define  IPS_GET_VERSION_SUPPORT 0x00018000  /* Mask for Versioning Support */
772*4882a593Smuzhiyun 
773*4882a593Smuzhiyun typedef struct
774*4882a593Smuzhiyun {
775*4882a593Smuzhiyun    uint32_t  revision;
776*4882a593Smuzhiyun    uint8_t   bootBlkVersion[32];
777*4882a593Smuzhiyun    uint8_t   bootBlkAttributes[4];
778*4882a593Smuzhiyun    uint8_t   codeBlkVersion[32];
779*4882a593Smuzhiyun    uint8_t   biosVersion[32];
780*4882a593Smuzhiyun    uint8_t   biosAttributes[4];
781*4882a593Smuzhiyun    uint8_t   compatibilityId[32];
782*4882a593Smuzhiyun    uint8_t   reserved[4];
783*4882a593Smuzhiyun } IPS_VERSION_DATA;
784*4882a593Smuzhiyun 
785*4882a593Smuzhiyun 
786*4882a593Smuzhiyun typedef struct _IPS_SUBSYS {
787*4882a593Smuzhiyun    uint32_t  param[128];
788*4882a593Smuzhiyun } IPS_SUBSYS, *PIPS_SUBSYS;
789*4882a593Smuzhiyun 
790*4882a593Smuzhiyun /**
791*4882a593Smuzhiyun  ** SCSI Structures
792*4882a593Smuzhiyun  **/
793*4882a593Smuzhiyun 
794*4882a593Smuzhiyun /*
795*4882a593Smuzhiyun  * Inquiry Data Format
796*4882a593Smuzhiyun  */
797*4882a593Smuzhiyun typedef struct {
798*4882a593Smuzhiyun    uint8_t   DeviceType;
799*4882a593Smuzhiyun    uint8_t   DeviceTypeQualifier;
800*4882a593Smuzhiyun    uint8_t   Version;
801*4882a593Smuzhiyun    uint8_t   ResponseDataFormat;
802*4882a593Smuzhiyun    uint8_t   AdditionalLength;
803*4882a593Smuzhiyun    uint8_t   Reserved;
804*4882a593Smuzhiyun    uint8_t   Flags[2];
805*4882a593Smuzhiyun    uint8_t   VendorId[8];
806*4882a593Smuzhiyun    uint8_t   ProductId[16];
807*4882a593Smuzhiyun    uint8_t   ProductRevisionLevel[4];
808*4882a593Smuzhiyun    uint8_t   Reserved2;                                  /* Provides NULL terminator to name */
809*4882a593Smuzhiyun } IPS_SCSI_INQ_DATA, *PIPS_SCSI_INQ_DATA;
810*4882a593Smuzhiyun 
811*4882a593Smuzhiyun /*
812*4882a593Smuzhiyun  * Read Capacity Data Format
813*4882a593Smuzhiyun  */
814*4882a593Smuzhiyun typedef struct {
815*4882a593Smuzhiyun    uint32_t lba;
816*4882a593Smuzhiyun    uint32_t len;
817*4882a593Smuzhiyun } IPS_SCSI_CAPACITY;
818*4882a593Smuzhiyun 
819*4882a593Smuzhiyun /*
820*4882a593Smuzhiyun  * Request Sense Data Format
821*4882a593Smuzhiyun  */
822*4882a593Smuzhiyun typedef struct {
823*4882a593Smuzhiyun    uint8_t  ResponseCode;
824*4882a593Smuzhiyun    uint8_t  SegmentNumber;
825*4882a593Smuzhiyun    uint8_t  Flags;
826*4882a593Smuzhiyun    uint8_t  Information[4];
827*4882a593Smuzhiyun    uint8_t  AdditionalLength;
828*4882a593Smuzhiyun    uint8_t  CommandSpecific[4];
829*4882a593Smuzhiyun    uint8_t  AdditionalSenseCode;
830*4882a593Smuzhiyun    uint8_t  AdditionalSenseCodeQual;
831*4882a593Smuzhiyun    uint8_t  FRUCode;
832*4882a593Smuzhiyun    uint8_t  SenseKeySpecific[3];
833*4882a593Smuzhiyun } IPS_SCSI_REQSEN;
834*4882a593Smuzhiyun 
835*4882a593Smuzhiyun /*
836*4882a593Smuzhiyun  * Sense Data Format - Page 3
837*4882a593Smuzhiyun  */
838*4882a593Smuzhiyun typedef struct {
839*4882a593Smuzhiyun    uint8_t  PageCode;
840*4882a593Smuzhiyun    uint8_t  PageLength;
841*4882a593Smuzhiyun    uint16_t TracksPerZone;
842*4882a593Smuzhiyun    uint16_t AltSectorsPerZone;
843*4882a593Smuzhiyun    uint16_t AltTracksPerZone;
844*4882a593Smuzhiyun    uint16_t AltTracksPerVolume;
845*4882a593Smuzhiyun    uint16_t SectorsPerTrack;
846*4882a593Smuzhiyun    uint16_t BytesPerSector;
847*4882a593Smuzhiyun    uint16_t Interleave;
848*4882a593Smuzhiyun    uint16_t TrackSkew;
849*4882a593Smuzhiyun    uint16_t CylinderSkew;
850*4882a593Smuzhiyun    uint8_t  flags;
851*4882a593Smuzhiyun    uint8_t  reserved[3];
852*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE3;
853*4882a593Smuzhiyun 
854*4882a593Smuzhiyun /*
855*4882a593Smuzhiyun  * Sense Data Format - Page 4
856*4882a593Smuzhiyun  */
857*4882a593Smuzhiyun typedef struct {
858*4882a593Smuzhiyun    uint8_t  PageCode;
859*4882a593Smuzhiyun    uint8_t  PageLength;
860*4882a593Smuzhiyun    uint16_t CylindersHigh;
861*4882a593Smuzhiyun    uint8_t  CylindersLow;
862*4882a593Smuzhiyun    uint8_t  Heads;
863*4882a593Smuzhiyun    uint16_t WritePrecompHigh;
864*4882a593Smuzhiyun    uint8_t  WritePrecompLow;
865*4882a593Smuzhiyun    uint16_t ReducedWriteCurrentHigh;
866*4882a593Smuzhiyun    uint8_t  ReducedWriteCurrentLow;
867*4882a593Smuzhiyun    uint16_t StepRate;
868*4882a593Smuzhiyun    uint16_t LandingZoneHigh;
869*4882a593Smuzhiyun    uint8_t  LandingZoneLow;
870*4882a593Smuzhiyun    uint8_t  flags;
871*4882a593Smuzhiyun    uint8_t  RotationalOffset;
872*4882a593Smuzhiyun    uint8_t  Reserved;
873*4882a593Smuzhiyun    uint16_t MediumRotationRate;
874*4882a593Smuzhiyun    uint8_t  Reserved2[2];
875*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE4;
876*4882a593Smuzhiyun 
877*4882a593Smuzhiyun /*
878*4882a593Smuzhiyun  * Sense Data Format - Page 8
879*4882a593Smuzhiyun  */
880*4882a593Smuzhiyun typedef struct {
881*4882a593Smuzhiyun    uint8_t  PageCode;
882*4882a593Smuzhiyun    uint8_t  PageLength;
883*4882a593Smuzhiyun    uint8_t  flags;
884*4882a593Smuzhiyun    uint8_t  RetentPrio;
885*4882a593Smuzhiyun    uint16_t DisPrefetchLen;
886*4882a593Smuzhiyun    uint16_t MinPrefetchLen;
887*4882a593Smuzhiyun    uint16_t MaxPrefetchLen;
888*4882a593Smuzhiyun    uint16_t MaxPrefetchCeiling;
889*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE8;
890*4882a593Smuzhiyun 
891*4882a593Smuzhiyun /*
892*4882a593Smuzhiyun  * Sense Data Format - Block Descriptor (DASD)
893*4882a593Smuzhiyun  */
894*4882a593Smuzhiyun typedef struct {
895*4882a593Smuzhiyun    uint32_t NumberOfBlocks;
896*4882a593Smuzhiyun    uint8_t  DensityCode;
897*4882a593Smuzhiyun    uint16_t BlockLengthHigh;
898*4882a593Smuzhiyun    uint8_t  BlockLengthLow;
899*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE_BLKDESC;
900*4882a593Smuzhiyun 
901*4882a593Smuzhiyun /*
902*4882a593Smuzhiyun  * Sense Data Format - Mode Page Header
903*4882a593Smuzhiyun  */
904*4882a593Smuzhiyun typedef struct {
905*4882a593Smuzhiyun    uint8_t  DataLength;
906*4882a593Smuzhiyun    uint8_t  MediumType;
907*4882a593Smuzhiyun    uint8_t  Reserved;
908*4882a593Smuzhiyun    uint8_t  BlockDescLength;
909*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE_HEADER;
910*4882a593Smuzhiyun 
911*4882a593Smuzhiyun typedef struct {
912*4882a593Smuzhiyun    IPS_SCSI_MODE_PAGE_HEADER  hdr;
913*4882a593Smuzhiyun    IPS_SCSI_MODE_PAGE_BLKDESC blkdesc;
914*4882a593Smuzhiyun 
915*4882a593Smuzhiyun    union {
916*4882a593Smuzhiyun       IPS_SCSI_MODE_PAGE3 pg3;
917*4882a593Smuzhiyun       IPS_SCSI_MODE_PAGE4 pg4;
918*4882a593Smuzhiyun       IPS_SCSI_MODE_PAGE8 pg8;
919*4882a593Smuzhiyun    } pdata;
920*4882a593Smuzhiyun } IPS_SCSI_MODE_PAGE_DATA;
921*4882a593Smuzhiyun 
922*4882a593Smuzhiyun /*
923*4882a593Smuzhiyun  * Scatter Gather list format
924*4882a593Smuzhiyun  */
925*4882a593Smuzhiyun typedef struct ips_sglist {
926*4882a593Smuzhiyun    uint32_t address;
927*4882a593Smuzhiyun    uint32_t length;
928*4882a593Smuzhiyun } IPS_STD_SG_LIST;
929*4882a593Smuzhiyun 
930*4882a593Smuzhiyun typedef struct ips_enh_sglist {
931*4882a593Smuzhiyun    uint32_t address_lo;
932*4882a593Smuzhiyun    uint32_t address_hi;
933*4882a593Smuzhiyun    uint32_t length;
934*4882a593Smuzhiyun    uint32_t reserved;
935*4882a593Smuzhiyun } IPS_ENH_SG_LIST;
936*4882a593Smuzhiyun 
937*4882a593Smuzhiyun typedef union {
938*4882a593Smuzhiyun    void             *list;
939*4882a593Smuzhiyun    IPS_STD_SG_LIST  *std_list;
940*4882a593Smuzhiyun    IPS_ENH_SG_LIST  *enh_list;
941*4882a593Smuzhiyun } IPS_SG_LIST;
942*4882a593Smuzhiyun 
943*4882a593Smuzhiyun typedef struct {
944*4882a593Smuzhiyun    char *option_name;
945*4882a593Smuzhiyun    int  *option_flag;
946*4882a593Smuzhiyun    int   option_value;
947*4882a593Smuzhiyun } IPS_OPTION;
948*4882a593Smuzhiyun 
949*4882a593Smuzhiyun /*
950*4882a593Smuzhiyun  * Status Info
951*4882a593Smuzhiyun  */
952*4882a593Smuzhiyun typedef struct ips_stat {
953*4882a593Smuzhiyun    uint32_t residue_len;
954*4882a593Smuzhiyun    void     *scb_addr;
955*4882a593Smuzhiyun    uint8_t  padding[12 - sizeof(void *)];
956*4882a593Smuzhiyun } ips_stat_t;
957*4882a593Smuzhiyun 
958*4882a593Smuzhiyun /*
959*4882a593Smuzhiyun  * SCB Queue Format
960*4882a593Smuzhiyun  */
961*4882a593Smuzhiyun typedef struct ips_scb_queue {
962*4882a593Smuzhiyun    struct ips_scb *head;
963*4882a593Smuzhiyun    struct ips_scb *tail;
964*4882a593Smuzhiyun    int             count;
965*4882a593Smuzhiyun } ips_scb_queue_t;
966*4882a593Smuzhiyun 
967*4882a593Smuzhiyun /*
968*4882a593Smuzhiyun  * Wait queue_format
969*4882a593Smuzhiyun  */
970*4882a593Smuzhiyun typedef struct ips_wait_queue {
971*4882a593Smuzhiyun 	struct scsi_cmnd *head;
972*4882a593Smuzhiyun 	struct scsi_cmnd *tail;
973*4882a593Smuzhiyun 	int count;
974*4882a593Smuzhiyun } ips_wait_queue_entry_t;
975*4882a593Smuzhiyun 
976*4882a593Smuzhiyun typedef struct ips_copp_wait_item {
977*4882a593Smuzhiyun 	struct scsi_cmnd *scsi_cmd;
978*4882a593Smuzhiyun 	struct ips_copp_wait_item *next;
979*4882a593Smuzhiyun } ips_copp_wait_item_t;
980*4882a593Smuzhiyun 
981*4882a593Smuzhiyun typedef struct ips_copp_queue {
982*4882a593Smuzhiyun    struct ips_copp_wait_item *head;
983*4882a593Smuzhiyun    struct ips_copp_wait_item *tail;
984*4882a593Smuzhiyun    int                        count;
985*4882a593Smuzhiyun } ips_copp_queue_t;
986*4882a593Smuzhiyun 
987*4882a593Smuzhiyun /* forward decl for host structure */
988*4882a593Smuzhiyun struct ips_ha;
989*4882a593Smuzhiyun 
990*4882a593Smuzhiyun typedef struct {
991*4882a593Smuzhiyun    int       (*reset)(struct ips_ha *);
992*4882a593Smuzhiyun    int       (*issue)(struct ips_ha *, struct ips_scb *);
993*4882a593Smuzhiyun    int       (*isinit)(struct ips_ha *);
994*4882a593Smuzhiyun    int       (*isintr)(struct ips_ha *);
995*4882a593Smuzhiyun    int       (*init)(struct ips_ha *);
996*4882a593Smuzhiyun    int       (*erasebios)(struct ips_ha *);
997*4882a593Smuzhiyun    int       (*programbios)(struct ips_ha *, char *, uint32_t, uint32_t);
998*4882a593Smuzhiyun    int       (*verifybios)(struct ips_ha *, char *, uint32_t, uint32_t);
999*4882a593Smuzhiyun    void      (*statinit)(struct ips_ha *);
1000*4882a593Smuzhiyun    int       (*intr)(struct ips_ha *);
1001*4882a593Smuzhiyun    void      (*enableint)(struct ips_ha *);
1002*4882a593Smuzhiyun    uint32_t (*statupd)(struct ips_ha *);
1003*4882a593Smuzhiyun } ips_hw_func_t;
1004*4882a593Smuzhiyun 
1005*4882a593Smuzhiyun typedef struct ips_ha {
1006*4882a593Smuzhiyun    uint8_t            ha_id[IPS_MAX_CHANNELS+1];
1007*4882a593Smuzhiyun    uint32_t           dcdb_active[IPS_MAX_CHANNELS];
1008*4882a593Smuzhiyun    uint32_t           io_addr;            /* Base I/O address           */
1009*4882a593Smuzhiyun    uint8_t            ntargets;           /* Number of targets          */
1010*4882a593Smuzhiyun    uint8_t            nbus;               /* Number of buses            */
1011*4882a593Smuzhiyun    uint8_t            nlun;               /* Number of Luns             */
1012*4882a593Smuzhiyun    uint16_t           ad_type;            /* Adapter type               */
1013*4882a593Smuzhiyun    uint16_t           host_num;           /* Adapter number             */
1014*4882a593Smuzhiyun    uint32_t           max_xfer;           /* Maximum Xfer size          */
1015*4882a593Smuzhiyun    uint32_t           max_cmds;           /* Max concurrent commands    */
1016*4882a593Smuzhiyun    uint32_t           num_ioctl;          /* Number of Ioctls           */
1017*4882a593Smuzhiyun    ips_stat_t         sp;                 /* Status packer pointer      */
1018*4882a593Smuzhiyun    struct ips_scb    *scbs;               /* Array of all CCBS          */
1019*4882a593Smuzhiyun    struct ips_scb    *scb_freelist;       /* SCB free list              */
1020*4882a593Smuzhiyun    ips_wait_queue_entry_t   scb_waitlist;       /* Pending SCB list           */
1021*4882a593Smuzhiyun    ips_copp_queue_t   copp_waitlist;      /* Pending PT list            */
1022*4882a593Smuzhiyun    ips_scb_queue_t    scb_activelist;     /* Active SCB list            */
1023*4882a593Smuzhiyun    IPS_IO_CMD        *dummy;              /* dummy command              */
1024*4882a593Smuzhiyun    IPS_ADAPTER       *adapt;              /* Adapter status area        */
1025*4882a593Smuzhiyun    IPS_LD_INFO       *logical_drive_info; /* Adapter Logical Drive Info */
1026*4882a593Smuzhiyun    dma_addr_t         logical_drive_info_dma_addr; /* Logical Drive Info DMA Address */
1027*4882a593Smuzhiyun    IPS_ENQ           *enq;                /* Adapter Enquiry data       */
1028*4882a593Smuzhiyun    IPS_CONF          *conf;               /* Adapter config data        */
1029*4882a593Smuzhiyun    IPS_NVRAM_P5      *nvram;              /* NVRAM page 5 data          */
1030*4882a593Smuzhiyun    IPS_SUBSYS        *subsys;             /* Subsystem parameters       */
1031*4882a593Smuzhiyun    char              *ioctl_data;         /* IOCTL data area            */
1032*4882a593Smuzhiyun    uint32_t           ioctl_datasize;     /* IOCTL data size            */
1033*4882a593Smuzhiyun    uint32_t           cmd_in_progress;    /* Current command in progress*/
1034*4882a593Smuzhiyun    int                flags;              /*                            */
1035*4882a593Smuzhiyun    uint8_t            waitflag;           /* are we waiting for cmd     */
1036*4882a593Smuzhiyun    uint8_t            active;
1037*4882a593Smuzhiyun    int                ioctl_reset;        /* IOCTL Requested Reset Flag */
1038*4882a593Smuzhiyun    uint16_t           reset_count;        /* number of resets           */
1039*4882a593Smuzhiyun    time64_t           last_ffdc;          /* last time we sent ffdc info*/
1040*4882a593Smuzhiyun    uint8_t            slot_num;           /* PCI Slot Number            */
1041*4882a593Smuzhiyun    int                ioctl_len;          /* size of ioctl buffer       */
1042*4882a593Smuzhiyun    dma_addr_t         ioctl_busaddr;      /* dma address of ioctl buffer*/
1043*4882a593Smuzhiyun    uint8_t            bios_version[8];    /* BIOS Revision              */
1044*4882a593Smuzhiyun    uint32_t           mem_addr;           /* Memory mapped address      */
1045*4882a593Smuzhiyun    uint32_t           io_len;             /* Size of IO Address         */
1046*4882a593Smuzhiyun    uint32_t           mem_len;            /* Size of memory address     */
1047*4882a593Smuzhiyun    char              __iomem *mem_ptr;    /* Memory mapped Ptr          */
1048*4882a593Smuzhiyun    char              __iomem *ioremap_ptr;/* ioremapped memory pointer  */
1049*4882a593Smuzhiyun    ips_hw_func_t      func;               /* hw function pointers       */
1050*4882a593Smuzhiyun    struct pci_dev    *pcidev;             /* PCI device handle          */
1051*4882a593Smuzhiyun    char              *flash_data;         /* Save Area for flash data   */
1052*4882a593Smuzhiyun    int                flash_len;          /* length of flash buffer     */
1053*4882a593Smuzhiyun    u32                flash_datasize;     /* Save Area for flash data size */
1054*4882a593Smuzhiyun    dma_addr_t         flash_busaddr;      /* dma address of flash buffer*/
1055*4882a593Smuzhiyun    dma_addr_t         enq_busaddr;        /* dma address of enq struct  */
1056*4882a593Smuzhiyun    uint8_t            requires_esl;       /* Requires an EraseStripeLock */
1057*4882a593Smuzhiyun } ips_ha_t;
1058*4882a593Smuzhiyun 
1059*4882a593Smuzhiyun typedef void (*ips_scb_callback) (ips_ha_t *, struct ips_scb *);
1060*4882a593Smuzhiyun 
1061*4882a593Smuzhiyun /*
1062*4882a593Smuzhiyun  * SCB Format
1063*4882a593Smuzhiyun  */
1064*4882a593Smuzhiyun typedef struct ips_scb {
1065*4882a593Smuzhiyun    IPS_HOST_COMMAND  cmd;
1066*4882a593Smuzhiyun    IPS_DCDB_TABLE    dcdb;
1067*4882a593Smuzhiyun    uint8_t           target_id;
1068*4882a593Smuzhiyun    uint8_t           bus;
1069*4882a593Smuzhiyun    uint8_t           lun;
1070*4882a593Smuzhiyun    uint8_t           cdb[12];
1071*4882a593Smuzhiyun    uint32_t          scb_busaddr;
1072*4882a593Smuzhiyun    uint32_t          old_data_busaddr;  // Obsolete, but kept for old utility compatibility
1073*4882a593Smuzhiyun    uint32_t          timeout;
1074*4882a593Smuzhiyun    uint8_t           basic_status;
1075*4882a593Smuzhiyun    uint8_t           extended_status;
1076*4882a593Smuzhiyun    uint8_t           breakup;
1077*4882a593Smuzhiyun    uint8_t           sg_break;
1078*4882a593Smuzhiyun    uint32_t          data_len;
1079*4882a593Smuzhiyun    uint32_t          sg_len;
1080*4882a593Smuzhiyun    uint32_t          flags;
1081*4882a593Smuzhiyun    uint32_t          op_code;
1082*4882a593Smuzhiyun    IPS_SG_LIST       sg_list;
1083*4882a593Smuzhiyun    struct scsi_cmnd *scsi_cmd;
1084*4882a593Smuzhiyun    struct ips_scb   *q_next;
1085*4882a593Smuzhiyun    ips_scb_callback  callback;
1086*4882a593Smuzhiyun    uint32_t          sg_busaddr;
1087*4882a593Smuzhiyun    int               sg_count;
1088*4882a593Smuzhiyun    dma_addr_t        data_busaddr;
1089*4882a593Smuzhiyun } ips_scb_t;
1090*4882a593Smuzhiyun 
1091*4882a593Smuzhiyun typedef struct ips_scb_pt {
1092*4882a593Smuzhiyun    IPS_HOST_COMMAND  cmd;
1093*4882a593Smuzhiyun    IPS_DCDB_TABLE    dcdb;
1094*4882a593Smuzhiyun    uint8_t           target_id;
1095*4882a593Smuzhiyun    uint8_t           bus;
1096*4882a593Smuzhiyun    uint8_t           lun;
1097*4882a593Smuzhiyun    uint8_t           cdb[12];
1098*4882a593Smuzhiyun    uint32_t          scb_busaddr;
1099*4882a593Smuzhiyun    uint32_t          data_busaddr;
1100*4882a593Smuzhiyun    uint32_t          timeout;
1101*4882a593Smuzhiyun    uint8_t           basic_status;
1102*4882a593Smuzhiyun    uint8_t           extended_status;
1103*4882a593Smuzhiyun    uint16_t          breakup;
1104*4882a593Smuzhiyun    uint32_t          data_len;
1105*4882a593Smuzhiyun    uint32_t          sg_len;
1106*4882a593Smuzhiyun    uint32_t          flags;
1107*4882a593Smuzhiyun    uint32_t          op_code;
1108*4882a593Smuzhiyun    IPS_SG_LIST      *sg_list;
1109*4882a593Smuzhiyun    struct scsi_cmnd *scsi_cmd;
1110*4882a593Smuzhiyun    struct ips_scb   *q_next;
1111*4882a593Smuzhiyun    ips_scb_callback  callback;
1112*4882a593Smuzhiyun } ips_scb_pt_t;
1113*4882a593Smuzhiyun 
1114*4882a593Smuzhiyun /*
1115*4882a593Smuzhiyun  * Passthru Command Format
1116*4882a593Smuzhiyun  */
1117*4882a593Smuzhiyun typedef struct {
1118*4882a593Smuzhiyun    uint8_t       CoppID[4];
1119*4882a593Smuzhiyun    uint32_t      CoppCmd;
1120*4882a593Smuzhiyun    uint32_t      PtBuffer;
1121*4882a593Smuzhiyun    uint8_t      *CmdBuffer;
1122*4882a593Smuzhiyun    uint32_t      CmdBSize;
1123*4882a593Smuzhiyun    ips_scb_pt_t  CoppCP;
1124*4882a593Smuzhiyun    uint32_t      TimeOut;
1125*4882a593Smuzhiyun    uint8_t       BasicStatus;
1126*4882a593Smuzhiyun    uint8_t       ExtendedStatus;
1127*4882a593Smuzhiyun    uint8_t       AdapterType;
1128*4882a593Smuzhiyun    uint8_t       reserved;
1129*4882a593Smuzhiyun } ips_passthru_t;
1130*4882a593Smuzhiyun 
1131*4882a593Smuzhiyun #endif
1132*4882a593Smuzhiyun 
1133*4882a593Smuzhiyun /* The Version Information below gets created by SED during the build process. */
1134*4882a593Smuzhiyun /* Do not modify the next line; it's what SED is looking for to do the insert. */
1135*4882a593Smuzhiyun /* Version Info                                                                */
1136*4882a593Smuzhiyun /*************************************************************************
1137*4882a593Smuzhiyun *
1138*4882a593Smuzhiyun * VERSION.H -- version numbers and copyright notices in various formats
1139*4882a593Smuzhiyun *
1140*4882a593Smuzhiyun *************************************************************************/
1141*4882a593Smuzhiyun 
1142*4882a593Smuzhiyun #define IPS_VER_MAJOR 7
1143*4882a593Smuzhiyun #define IPS_VER_MAJOR_STRING __stringify(IPS_VER_MAJOR)
1144*4882a593Smuzhiyun #define IPS_VER_MINOR 12
1145*4882a593Smuzhiyun #define IPS_VER_MINOR_STRING __stringify(IPS_VER_MINOR)
1146*4882a593Smuzhiyun #define IPS_VER_BUILD 05
1147*4882a593Smuzhiyun #define IPS_VER_BUILD_STRING __stringify(IPS_VER_BUILD)
1148*4882a593Smuzhiyun #define IPS_VER_STRING IPS_VER_MAJOR_STRING "." \
1149*4882a593Smuzhiyun 		IPS_VER_MINOR_STRING "." IPS_VER_BUILD_STRING
1150*4882a593Smuzhiyun #define IPS_RELEASE_ID 0x00020000
1151*4882a593Smuzhiyun #define IPS_BUILD_IDENT 761
1152*4882a593Smuzhiyun #define IPS_LEGALCOPYRIGHT_STRING "(C) Copyright IBM Corp. 1994, 2002. All Rights Reserved."
1153*4882a593Smuzhiyun #define IPS_ADAPTECCOPYRIGHT_STRING "(c) Copyright Adaptec, Inc. 2002 to 2004. All Rights Reserved."
1154*4882a593Smuzhiyun #define IPS_DELLCOPYRIGHT_STRING "(c) Copyright Dell 2004. All Rights Reserved."
1155*4882a593Smuzhiyun #define IPS_NT_LEGALCOPYRIGHT_STRING "(C) Copyright IBM Corp. 1994, 2002."
1156*4882a593Smuzhiyun 
1157*4882a593Smuzhiyun /* Version numbers for various adapters */
1158*4882a593Smuzhiyun #define IPS_VER_SERVERAID1 "2.25.01"
1159*4882a593Smuzhiyun #define IPS_VER_SERVERAID2 "2.88.13"
1160*4882a593Smuzhiyun #define IPS_VER_NAVAJO "2.88.13"
1161*4882a593Smuzhiyun #define IPS_VER_SERVERAID3 "6.10.24"
1162*4882a593Smuzhiyun #define IPS_VER_SERVERAID4H "7.12.02"
1163*4882a593Smuzhiyun #define IPS_VER_SERVERAID4MLx "7.12.02"
1164*4882a593Smuzhiyun #define IPS_VER_SARASOTA "7.12.02"
1165*4882a593Smuzhiyun #define IPS_VER_MARCO "7.12.02"
1166*4882a593Smuzhiyun #define IPS_VER_SEBRING "7.12.02"
1167*4882a593Smuzhiyun #define IPS_VER_KEYWEST "7.12.02"
1168*4882a593Smuzhiyun 
1169*4882a593Smuzhiyun /* Compatibility IDs for various adapters */
1170*4882a593Smuzhiyun #define IPS_COMPAT_UNKNOWN ""
1171*4882a593Smuzhiyun #define IPS_COMPAT_CURRENT "KW710"
1172*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID1 "2.25.01"
1173*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID2 "2.88.13"
1174*4882a593Smuzhiyun #define IPS_COMPAT_NAVAJO  "2.88.13"
1175*4882a593Smuzhiyun #define IPS_COMPAT_KIOWA "2.88.13"
1176*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID3H  "SB610"
1177*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID3L  "SB610"
1178*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID4H  "KW710"
1179*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID4M  "KW710"
1180*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID4L  "KW710"
1181*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID4Mx "KW710"
1182*4882a593Smuzhiyun #define IPS_COMPAT_SERVERAID4Lx "KW710"
1183*4882a593Smuzhiyun #define IPS_COMPAT_SARASOTA     "KW710"
1184*4882a593Smuzhiyun #define IPS_COMPAT_MARCO        "KW710"
1185*4882a593Smuzhiyun #define IPS_COMPAT_SEBRING      "KW710"
1186*4882a593Smuzhiyun #define IPS_COMPAT_TAMPA        "KW710"
1187*4882a593Smuzhiyun #define IPS_COMPAT_KEYWEST      "KW710"
1188*4882a593Smuzhiyun #define IPS_COMPAT_BIOS "KW710"
1189*4882a593Smuzhiyun 
1190*4882a593Smuzhiyun #define IPS_COMPAT_MAX_ADAPTER_TYPE 18
1191*4882a593Smuzhiyun #define IPS_COMPAT_ID_LENGTH 8
1192*4882a593Smuzhiyun 
1193*4882a593Smuzhiyun #define IPS_DEFINE_COMPAT_TABLE(tablename) \
1194*4882a593Smuzhiyun    char tablename[IPS_COMPAT_MAX_ADAPTER_TYPE] [IPS_COMPAT_ID_LENGTH] = { \
1195*4882a593Smuzhiyun       IPS_COMPAT_UNKNOWN, \
1196*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID1, \
1197*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID2, \
1198*4882a593Smuzhiyun       IPS_COMPAT_NAVAJO, \
1199*4882a593Smuzhiyun       IPS_COMPAT_KIOWA, \
1200*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID3H, \
1201*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID3L, \
1202*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID4H, \
1203*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID4M, \
1204*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID4L, \
1205*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID4Mx, \
1206*4882a593Smuzhiyun       IPS_COMPAT_SERVERAID4Lx, \
1207*4882a593Smuzhiyun       IPS_COMPAT_SARASOTA,         /* one-channel variety of SARASOTA */  \
1208*4882a593Smuzhiyun       IPS_COMPAT_SARASOTA,         /* two-channel variety of SARASOTA */  \
1209*4882a593Smuzhiyun       IPS_COMPAT_MARCO, \
1210*4882a593Smuzhiyun       IPS_COMPAT_SEBRING, \
1211*4882a593Smuzhiyun       IPS_COMPAT_TAMPA, \
1212*4882a593Smuzhiyun       IPS_COMPAT_KEYWEST \
1213*4882a593Smuzhiyun    }
1214*4882a593Smuzhiyun 
1215*4882a593Smuzhiyun 
1216*4882a593Smuzhiyun /*
1217*4882a593Smuzhiyun  * Overrides for Emacs so that we almost follow Linus's tabbing style.
1218*4882a593Smuzhiyun  * Emacs will notice this stuff at the end of the file and automatically
1219*4882a593Smuzhiyun  * adjust the settings for this buffer only.  This must remain at the end
1220*4882a593Smuzhiyun  * of the file.
1221*4882a593Smuzhiyun  * ---------------------------------------------------------------------------
1222*4882a593Smuzhiyun  * Local variables:
1223*4882a593Smuzhiyun  * c-indent-level: 2
1224*4882a593Smuzhiyun  * c-brace-imaginary-offset: 0
1225*4882a593Smuzhiyun  * c-brace-offset: -2
1226*4882a593Smuzhiyun  * c-argdecl-indent: 2
1227*4882a593Smuzhiyun  * c-label-offset: -2
1228*4882a593Smuzhiyun  * c-continued-statement-offset: 2
1229*4882a593Smuzhiyun  * c-continued-brace-offset: 0
1230*4882a593Smuzhiyun  * indent-tabs-mode: nil
1231*4882a593Smuzhiyun  * tab-width: 8
1232*4882a593Smuzhiyun  * End:
1233*4882a593Smuzhiyun  */
1234