5b5c592a37e3c23eb5f73505603c6e471b53a64b
[dragonfly.git] / sys / dev / disk / mpt / mpilib / mpi.h
1 /* $FreeBSD: src/sys/dev/mpt/mpilib/mpi.h,v 1.9 2007/06/03 22:58:26 scottl Exp $ */
2 /*-
3  * Copyright (c) 2000-2005, LSI Logic Corporation and its contributors.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    substantially similar to the "NO WARRANTY" disclaimer below
13  *    ("Disclaimer") and any redistribution must be conditioned upon including
14  *    a substantially similar Disclaimer requirement for further binary
15  *    redistribution.
16  * 3. Neither the name of the LSI Logic Corporation nor the names of its
17  *    contributors may be used to endorse or promote products derived from
18  *    this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
30  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  *           Name:  mpi.h
33  *          Title:  MPI Message independent structures and definitions
34  *  Creation Date:  July 27, 2000
35  *
36  *    mpi.h Version:  01.05.13
37  *
38  *  Version History
39  *  ---------------
40  *
41  *  Date      Version   Description
42  *  --------  --------  ------------------------------------------------------
43  *  05-08-00  00.10.01  Original release for 0.10 spec dated 4/26/2000.
44  *  05-24-00  00.10.02  Added MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH definition.
45  *  06-06-00  01.00.01  Update MPI_VERSION_MAJOR and MPI_VERSION_MINOR.
46  *  06-22-00  01.00.02  Added MPI_IOCSTATUS_LAN_ definitions.
47  *                      Removed LAN_SUSPEND function definition.
48  *                      Added MPI_MSGFLAGS_CONTINUATION_REPLY definition.
49  *  06-30-00  01.00.03  Added MPI_CONTEXT_REPLY_TYPE_LAN definition.
50  *                      Added MPI_GET/SET_CONTEXT_REPLY_TYPE macros.
51  *  07-27-00  01.00.04  Added MPI_FAULT_ definitions.
52  *                      Removed MPI_IOCSTATUS_MSG/DATA_XFER_ERROR definitions.
53  *                      Added MPI_IOCSTATUS_INTERNAL_ERROR definition.
54  *                      Added MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH.
55  *  11-02-00  01.01.01  Original release for post 1.0 work.
56  *  12-04-00  01.01.02  Added new function codes.
57  *  01-09-01  01.01.03  Added more definitions to the system interface section
58  *                      Added MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT.
59  *  01-25-01  01.01.04  Changed MPI_VERSION_MINOR from 0x00 to 0x01.
60  *  02-20-01  01.01.05  Started using MPI_POINTER.
61  *                      Fixed value for MPI_DIAG_RW_ENABLE.
62  *                      Added defines for MPI_DIAG_PREVENT_IOC_BOOT and
63  *                      MPI_DIAG_CLEAR_FLASH_BAD_SIG.
64  *                      Obsoleted MPI_IOCSTATUS_TARGET_FC_ defines.
65  *  02-27-01  01.01.06  Removed MPI_HOST_INDEX_REGISTER define.
66  *                      Added function codes for RAID.
67  *  04-09-01  01.01.07  Added alternate define for MPI_DOORBELL_ACTIVE,
68  *                      MPI_DOORBELL_USED, to better match the spec.
69  *  08-08-01  01.02.01  Original release for v1.2 work.
70  *                      Changed MPI_VERSION_MINOR from 0x01 to 0x02.
71  *                      Added define MPI_FUNCTION_TOOLBOX.
72  *  09-28-01  01.02.02  New function code MPI_SCSI_ENCLOSURE_PROCESSOR.
73  *  11-01-01  01.02.03  Changed name to MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR.
74  *  03-14-02  01.02.04  Added MPI_HEADER_VERSION_ defines.
75  *  05-31-02  01.02.05  Bumped MPI_HEADER_VERSION_UNIT.
76  *  07-12-02  01.02.06  Added define for MPI_FUNCTION_MAILBOX.
77  *  09-16-02  01.02.07  Bumped value for MPI_HEADER_VERSION_UNIT.
78  *  11-15-02  01.02.08  Added define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX and
79  *                      obsoleted define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX.
80  *  04-01-03  01.02.09  New IOCStatus code: MPI_IOCSTATUS_FC_EXCHANGE_CANCELED
81  *  06-26-03  01.02.10  Bumped MPI_HEADER_VERSION_UNIT value.
82  *  01-16-04  01.02.11  Added define for MPI_IOCLOGINFO_TYPE_SHIFT.
83  *  04-29-04  01.02.12  Added function codes for MPI_FUNCTION_DIAG_BUFFER_POST
84  *                      and MPI_FUNCTION_DIAG_RELEASE.
85  *                      Added MPI_IOCSTATUS_DIAGNOSTIC_RELEASED define.
86  *                      Bumped MPI_HEADER_VERSION_UNIT value.
87  *  05-11-04  01.03.01  Bumped MPI_VERSION_MINOR for MPI v1.3.
88  *                      Added codes for Inband.
89  *  08-19-04  01.05.01  Added defines for Host Buffer Access Control doorbell.
90  *                      Added define for offset of High Priority Request Queue.
91  *                      Added new function codes and new IOCStatus codes.
92  *                      Added a IOCLogInfo type of SAS.
93  *  12-07-04  01.05.02  Bumped MPI_HEADER_VERSION_UNIT.
94  *  12-09-04  01.05.03  Bumped MPI_HEADER_VERSION_UNIT.
95  *  01-15-05  01.05.04  Bumped MPI_HEADER_VERSION_UNIT.
96  *  02-09-05  01.05.05  Bumped MPI_HEADER_VERSION_UNIT.
97  *  02-22-05  01.05.06  Bumped MPI_HEADER_VERSION_UNIT.
98  *  03-11-05  01.05.07  Removed function codes for SCSI IO 32 and
99  *                      TargetAssistExtended requests.
100  *                      Removed EEDP IOCStatus codes.
101  *  06-24-05  01.05.08  Added function codes for SCSI IO 32 and
102  *                      TargetAssistExtended requests.
103  *                      Added EEDP IOCStatus codes.
104  *  08-03-05  01.05.09  Bumped MPI_HEADER_VERSION_UNIT.
105  *  08-30-05  01.05.10  Added 2 new IOCStatus codes for Target.
106  *  03-27-06  01.05.11  Bumped MPI_HEADER_VERSION_UNIT.
107  *  10-11-06  01.05.12  Bumped MPI_HEADER_VERSION_UNIT.
108  *  05-24-07  01.05.13  Bumped MPI_HEADER_VERSION_UNIT.
109  *  --------------------------------------------------------------------------
110  */
111
112 #ifndef MPI_H
113 #define MPI_H
114
115
116 /*****************************************************************************
117 *
118 *        M P I    V e r s i o n    D e f i n i t i o n s
119 *
120 *****************************************************************************/
121
122 #define MPI_VERSION_MAJOR                   (0x01)
123 #define MPI_VERSION_MINOR                   (0x05)
124 #define MPI_VERSION_MAJOR_MASK              (0xFF00)
125 #define MPI_VERSION_MAJOR_SHIFT             (8)
126 #define MPI_VERSION_MINOR_MASK              (0x00FF)
127 #define MPI_VERSION_MINOR_SHIFT             (0)
128 #define MPI_VERSION ((MPI_VERSION_MAJOR << MPI_VERSION_MAJOR_SHIFT) |   \
129                                       MPI_VERSION_MINOR)
130
131 #define MPI_VERSION_01_00                   (0x0100)
132 #define MPI_VERSION_01_01                   (0x0101)
133 #define MPI_VERSION_01_02                   (0x0102)
134 #define MPI_VERSION_01_03                   (0x0103)
135 #define MPI_VERSION_01_05                   (0x0105)
136 /* Note: The major versions of 0xe0 through 0xff are reserved */
137
138 /* versioning for this MPI header set */
139 #define MPI_HEADER_VERSION_UNIT             (0x10)
140 #define MPI_HEADER_VERSION_DEV              (0x00)
141 #define MPI_HEADER_VERSION_UNIT_MASK        (0xFF00)
142 #define MPI_HEADER_VERSION_UNIT_SHIFT       (8)
143 #define MPI_HEADER_VERSION_DEV_MASK         (0x00FF)
144 #define MPI_HEADER_VERSION_DEV_SHIFT        (0)
145 #define MPI_HEADER_VERSION ((MPI_HEADER_VERSION_UNIT << 8) | MPI_HEADER_VERSION_DEV)
146
147 /*****************************************************************************
148 *
149 *        I O C    S t a t e    D e f i n i t i o n s
150 *
151 *****************************************************************************/
152
153 #define MPI_IOC_STATE_RESET                 (0x00000000)
154 #define MPI_IOC_STATE_READY                 (0x10000000)
155 #define MPI_IOC_STATE_OPERATIONAL           (0x20000000)
156 #define MPI_IOC_STATE_FAULT                 (0x40000000)
157
158 #define MPI_IOC_STATE_MASK                  (0xF0000000)
159 #define MPI_IOC_STATE_SHIFT                 (28)
160
161 /* Fault state codes (product independent range 0x8000-0xFFFF) */
162
163 #define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR  (0x8111)
164 #define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT     (0x8112)
165 #define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR    (0x8113)
166 #define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT       (0x8114)
167 #define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR        (0x8115)
168 #define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT           (0x8116)
169 #define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR     (0x8117)
170 #define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT        (0x8118)
171
172
173 /*****************************************************************************
174 *
175 *        P C I    S y s t e m    I n t e r f a c e    R e g i s t e r s
176 *
177 *****************************************************************************/
178
179 /*
180  * Defines for working with the System Doorbell register.
181  * Values for doorbell function codes are included in the section that defines
182  * all the function codes (further on in this file).
183  */
184 #define MPI_DOORBELL_OFFSET                 (0x00000000)
185 #define MPI_DOORBELL_ACTIVE                 (0x08000000) /* DoorbellUsed */
186 #define MPI_DOORBELL_USED                   (MPI_DOORBELL_ACTIVE)
187 #define MPI_DOORBELL_ACTIVE_SHIFT           (27)
188 #define MPI_DOORBELL_WHO_INIT_MASK          (0x07000000)
189 #define MPI_DOORBELL_WHO_INIT_SHIFT         (24)
190 #define MPI_DOORBELL_FUNCTION_MASK          (0xFF000000)
191 #define MPI_DOORBELL_FUNCTION_SHIFT         (24)
192 #define MPI_DOORBELL_ADD_DWORDS_MASK        (0x00FF0000)
193 #define MPI_DOORBELL_ADD_DWORDS_SHIFT       (16)
194 #define MPI_DOORBELL_DATA_MASK              (0x0000FFFF)
195 #define MPI_DOORBELL_FUNCTION_SPECIFIC_MASK (0x0000FFFF)
196
197 /* values for Host Buffer Access Control doorbell function */
198 #define MPI_DB_HPBAC_VALUE_MASK             (0x0000F000)
199 #define MPI_DB_HPBAC_ENABLE_ACCESS          (0x01)
200 #define MPI_DB_HPBAC_DISABLE_ACCESS         (0x02)
201 #define MPI_DB_HPBAC_FREE_BUFFER            (0x03)
202
203
204 #define MPI_WRITE_SEQUENCE_OFFSET           (0x00000004)
205 #define MPI_WRSEQ_KEY_VALUE_MASK            (0x0000000F)
206 #define MPI_WRSEQ_1ST_KEY_VALUE             (0x04)
207 #define MPI_WRSEQ_2ND_KEY_VALUE             (0x0B)
208 #define MPI_WRSEQ_3RD_KEY_VALUE             (0x02)
209 #define MPI_WRSEQ_4TH_KEY_VALUE             (0x07)
210 #define MPI_WRSEQ_5TH_KEY_VALUE             (0x0D)
211
212 #define MPI_DIAGNOSTIC_OFFSET               (0x00000008)
213 #define MPI_DIAG_CLEAR_FLASH_BAD_SIG        (0x00000400)
214 #define MPI_DIAG_PREVENT_IOC_BOOT           (0x00000200)
215 #define MPI_DIAG_DRWE                       (0x00000080)
216 #define MPI_DIAG_FLASH_BAD_SIG              (0x00000040)
217 #define MPI_DIAG_RESET_HISTORY              (0x00000020)
218 #define MPI_DIAG_RW_ENABLE                  (0x00000010)
219 #define MPI_DIAG_RESET_ADAPTER              (0x00000004)
220 #define MPI_DIAG_DISABLE_ARM                (0x00000002)
221 #define MPI_DIAG_MEM_ENABLE                 (0x00000001)
222
223 #define MPI_TEST_BASE_ADDRESS_OFFSET        (0x0000000C)
224
225 #define MPI_DIAG_RW_DATA_OFFSET             (0x00000010)
226
227 #define MPI_DIAG_RW_ADDRESS_OFFSET          (0x00000014)
228
229 #define MPI_HOST_INTERRUPT_STATUS_OFFSET    (0x00000030)
230 #define MPI_HIS_IOP_DOORBELL_STATUS         (0x80000000)
231 #define MPI_HIS_REPLY_MESSAGE_INTERRUPT     (0x00000008)
232 #define MPI_HIS_DOORBELL_INTERRUPT          (0x00000001)
233
234 #define MPI_HOST_INTERRUPT_MASK_OFFSET      (0x00000034)
235 #define MPI_HIM_RIM                         (0x00000008)
236 #define MPI_HIM_DIM                         (0x00000001)
237
238 #define MPI_REQUEST_QUEUE_OFFSET            (0x00000040)
239 #define MPI_REQUEST_POST_FIFO_OFFSET        (0x00000040)
240
241 #define MPI_REPLY_QUEUE_OFFSET              (0x00000044)
242 #define MPI_REPLY_POST_FIFO_OFFSET          (0x00000044)
243 #define MPI_REPLY_FREE_FIFO_OFFSET          (0x00000044)
244
245 #define MPI_HI_PRI_REQUEST_QUEUE_OFFSET     (0x00000048)
246
247
248
249 /*****************************************************************************
250 *
251 *        M e s s a g e    F r a m e    D e s c r i p t o r s
252 *
253 *****************************************************************************/
254
255 #define MPI_REQ_MF_DESCRIPTOR_NB_MASK       (0x00000003)
256 #define MPI_REQ_MF_DESCRIPTOR_F_BIT         (0x00000004)
257 #define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK  (0xFFFFFFF8)
258
259 #define MPI_ADDRESS_REPLY_A_BIT             (0x80000000)
260 #define MPI_ADDRESS_REPLY_ADDRESS_MASK      (0x7FFFFFFF)
261
262 #define MPI_CONTEXT_REPLY_A_BIT             (0x80000000)
263 #define MPI_CONTEXT_REPLY_TYPE_MASK         (0x60000000)
264 #define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT    (0x00)
265 #define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET  (0x01)
266 #define MPI_CONTEXT_REPLY_TYPE_LAN          (0x02)
267 #define MPI_CONTEXT_REPLY_TYPE_SHIFT        (29)
268 #define MPI_CONTEXT_REPLY_CONTEXT_MASK      (0x1FFFFFFF)
269
270
271 /****************************************************************************/
272 /* Context Reply macros                                                     */
273 /****************************************************************************/
274
275 #define MPI_GET_CONTEXT_REPLY_TYPE(x)  (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) \
276                                           >> MPI_CONTEXT_REPLY_TYPE_SHIFT)
277
278 #define MPI_SET_CONTEXT_REPLY_TYPE(x, typ)                                  \
279             ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) |                   \
280                             (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) &      \
281                                         MPI_CONTEXT_REPLY_TYPE_MASK))
282
283
284 /*****************************************************************************
285 *
286 *        M e s s a g e    F u n c t i o n s
287 *              0x80 -> 0x8F reserved for private message use per product
288 *
289 *
290 *****************************************************************************/
291
292 #define MPI_FUNCTION_SCSI_IO_REQUEST                (0x00)
293 #define MPI_FUNCTION_SCSI_TASK_MGMT                 (0x01)
294 #define MPI_FUNCTION_IOC_INIT                       (0x02)
295 #define MPI_FUNCTION_IOC_FACTS                      (0x03)
296 #define MPI_FUNCTION_CONFIG                         (0x04)
297 #define MPI_FUNCTION_PORT_FACTS                     (0x05)
298 #define MPI_FUNCTION_PORT_ENABLE                    (0x06)
299 #define MPI_FUNCTION_EVENT_NOTIFICATION             (0x07)
300 #define MPI_FUNCTION_EVENT_ACK                      (0x08)
301 #define MPI_FUNCTION_FW_DOWNLOAD                    (0x09)
302 #define MPI_FUNCTION_TARGET_CMD_BUFFER_POST         (0x0A)
303 #define MPI_FUNCTION_TARGET_ASSIST                  (0x0B)
304 #define MPI_FUNCTION_TARGET_STATUS_SEND             (0x0C)
305 #define MPI_FUNCTION_TARGET_MODE_ABORT              (0x0D)
306 #define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST          (0x0E)
307 #define MPI_FUNCTION_FC_LINK_SRVC_RSP               (0x0F)
308 #define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND           (0x10)
309 #define MPI_FUNCTION_FC_ABORT                       (0x11)
310 #define MPI_FUNCTION_FW_UPLOAD                      (0x12)
311 #define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND       (0x13)
312 #define MPI_FUNCTION_FC_PRIMITIVE_SEND              (0x14)
313
314 #define MPI_FUNCTION_RAID_ACTION                    (0x15)
315 #define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH       (0x16)
316
317 #define MPI_FUNCTION_TOOLBOX                        (0x17)
318
319 #define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR       (0x18)
320
321 #define MPI_FUNCTION_MAILBOX                        (0x19)
322
323 #define MPI_FUNCTION_SMP_PASSTHROUGH                (0x1A)
324 #define MPI_FUNCTION_SAS_IO_UNIT_CONTROL            (0x1B)
325 #define MPI_FUNCTION_SATA_PASSTHROUGH               (0x1C)
326
327 #define MPI_FUNCTION_DIAG_BUFFER_POST               (0x1D)
328 #define MPI_FUNCTION_DIAG_RELEASE                   (0x1E)
329
330 #define MPI_FUNCTION_SCSI_IO_32                     (0x1F)
331
332 #define MPI_FUNCTION_LAN_SEND                       (0x20)
333 #define MPI_FUNCTION_LAN_RECEIVE                    (0x21)
334 #define MPI_FUNCTION_LAN_RESET                      (0x22)
335
336 #define MPI_FUNCTION_TARGET_ASSIST_EXTENDED         (0x23)
337 #define MPI_FUNCTION_TARGET_CMD_BUF_BASE_POST       (0x24)
338 #define MPI_FUNCTION_TARGET_CMD_BUF_LIST_POST       (0x25)
339
340 #define MPI_FUNCTION_INBAND_BUFFER_POST             (0x28)
341 #define MPI_FUNCTION_INBAND_SEND                    (0x29)
342 #define MPI_FUNCTION_INBAND_RSP                     (0x2A)
343 #define MPI_FUNCTION_INBAND_ABORT                   (0x2B)
344
345 #define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET         (0x40)
346 #define MPI_FUNCTION_IO_UNIT_RESET                  (0x41)
347 #define MPI_FUNCTION_HANDSHAKE                      (0x42)
348 #define MPI_FUNCTION_REPLY_FRAME_REMOVAL            (0x43)
349 #define MPI_FUNCTION_HOST_PAGEBUF_ACCESS_CONTROL    (0x44)
350
351
352 /* standard version format */
353 typedef struct _MPI_VERSION_STRUCT
354 {
355     U8                      Dev;                        /* 00h */
356     U8                      Unit;                       /* 01h */
357     U8                      Minor;                      /* 02h */
358     U8                      Major;                      /* 03h */
359 } MPI_VERSION_STRUCT, MPI_POINTER PTR_MPI_VERSION_STRUCT,
360   MpiVersionStruct_t, MPI_POINTER pMpiVersionStruct;
361
362 typedef union _MPI_VERSION_FORMAT
363 {
364     MPI_VERSION_STRUCT      Struct;
365     U32                     Word;
366 } MPI_VERSION_FORMAT, MPI_POINTER PTR_MPI_VERSION_FORMAT,
367   MpiVersionFormat_t, MPI_POINTER pMpiVersionFormat_t;
368
369
370 /*****************************************************************************
371 *
372 *        S c a t t e r    G a t h e r    E l e m e n t s
373 *
374 *****************************************************************************/
375
376 /****************************************************************************/
377 /*  Simple element structures                                               */
378 /****************************************************************************/
379
380 typedef struct _SGE_SIMPLE32
381 {
382     U32                     FlagsLength;
383     U32                     Address;
384 } SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32,
385   SGESimple32_t, MPI_POINTER pSGESimple32_t;
386
387 typedef struct _SGE_SIMPLE64
388 {
389     U32                     FlagsLength;
390     U64                     Address;
391 } SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64,
392   SGESimple64_t, MPI_POINTER pSGESimple64_t;
393
394 typedef struct _SGE_SIMPLE_UNION
395 {
396     U32                     FlagsLength;
397     union
398     {
399         U32                 Address32;
400         U64                 Address64;
401     }u;
402 } SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION,
403   SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t;
404
405 /****************************************************************************/
406 /*  Chain element structures                                                */
407 /****************************************************************************/
408
409 typedef struct _SGE_CHAIN32
410 {
411     U16                     Length;
412     U8                      NextChainOffset;
413     U8                      Flags;
414     U32                     Address;
415 } SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32,
416   SGEChain32_t, MPI_POINTER pSGEChain32_t;
417
418 typedef struct _SGE_CHAIN64
419 {
420     U16                     Length;
421     U8                      NextChainOffset;
422     U8                      Flags;
423     U64                     Address;
424 } SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64,
425   SGEChain64_t, MPI_POINTER pSGEChain64_t;
426
427 typedef struct _SGE_CHAIN_UNION
428 {
429     U16                     Length;
430     U8                      NextChainOffset;
431     U8                      Flags;
432     union
433     {
434         U32                 Address32;
435         U64                 Address64;
436     }u;
437 } SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION,
438   SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t;
439
440 /****************************************************************************/
441 /*  Transaction Context element                                             */
442 /****************************************************************************/
443
444 typedef struct _SGE_TRANSACTION32
445 {
446     U8                      Reserved;
447     U8                      ContextSize;
448     U8                      DetailsLength;
449     U8                      Flags;
450     U32                     TransactionContext[1];
451     U32                     TransactionDetails[1];
452 } SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32,
453   SGETransaction32_t, MPI_POINTER pSGETransaction32_t;
454
455 typedef struct _SGE_TRANSACTION64
456 {
457     U8                      Reserved;
458     U8                      ContextSize;
459     U8                      DetailsLength;
460     U8                      Flags;
461     U32                     TransactionContext[2];
462     U32                     TransactionDetails[1];
463 } SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64,
464   SGETransaction64_t, MPI_POINTER pSGETransaction64_t;
465
466 typedef struct _SGE_TRANSACTION96
467 {
468     U8                      Reserved;
469     U8                      ContextSize;
470     U8                      DetailsLength;
471     U8                      Flags;
472     U32                     TransactionContext[3];
473     U32                     TransactionDetails[1];
474 } SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96,
475   SGETransaction96_t, MPI_POINTER pSGETransaction96_t;
476
477 typedef struct _SGE_TRANSACTION128
478 {
479     U8                      Reserved;
480     U8                      ContextSize;
481     U8                      DetailsLength;
482     U8                      Flags;
483     U32                     TransactionContext[4];
484     U32                     TransactionDetails[1];
485 } SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128,
486   SGETransaction_t128, MPI_POINTER pSGETransaction_t128;
487
488 typedef struct _SGE_TRANSACTION_UNION
489 {
490     U8                      Reserved;
491     U8                      ContextSize;
492     U8                      DetailsLength;
493     U8                      Flags;
494     union
495     {
496         U32                 TransactionContext32[1];
497         U32                 TransactionContext64[2];
498         U32                 TransactionContext96[3];
499         U32                 TransactionContext128[4];
500     }u;
501     U32                     TransactionDetails[1];
502 } SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION,
503   SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t;
504
505
506 /****************************************************************************/
507 /*  SGE IO types union  for IO SGL's                                        */
508 /****************************************************************************/
509
510 typedef struct _SGE_IO_UNION
511 {
512     union
513     {
514         SGE_SIMPLE_UNION    Simple;
515         SGE_CHAIN_UNION     Chain;
516     } u;
517 } SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION,
518   SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t;
519
520 /****************************************************************************/
521 /*  SGE union for SGL's with Simple and Transaction elements                */
522 /****************************************************************************/
523
524 typedef struct _SGE_TRANS_SIMPLE_UNION
525 {
526     union
527     {
528         SGE_SIMPLE_UNION        Simple;
529         SGE_TRANSACTION_UNION   Transaction;
530     } u;
531 } SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION,
532   SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t;
533
534 /****************************************************************************/
535 /*  All SGE types union                                                     */
536 /****************************************************************************/
537
538 typedef struct _SGE_MPI_UNION
539 {
540     union
541     {
542         SGE_SIMPLE_UNION        Simple;
543         SGE_CHAIN_UNION         Chain;
544         SGE_TRANSACTION_UNION   Transaction;
545     } u;
546 } SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION,
547   MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t,
548   SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t;
549
550
551 /****************************************************************************/
552 /*  SGE field definition and masks                                          */
553 /****************************************************************************/
554
555 /* Flags field bit definitions */
556
557 #define MPI_SGE_FLAGS_LAST_ELEMENT              (0x80)
558 #define MPI_SGE_FLAGS_END_OF_BUFFER             (0x40)
559 #define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK         (0x30)
560 #define MPI_SGE_FLAGS_LOCAL_ADDRESS             (0x08)
561 #define MPI_SGE_FLAGS_DIRECTION                 (0x04)
562 #define MPI_SGE_FLAGS_ADDRESS_SIZE              (0x02)
563 #define MPI_SGE_FLAGS_END_OF_LIST               (0x01)
564
565 #define MPI_SGE_FLAGS_SHIFT                     (24)
566
567 #define MPI_SGE_LENGTH_MASK                     (0x00FFFFFF)
568 #define MPI_SGE_CHAIN_LENGTH_MASK               (0x0000FFFF)
569
570 /* Element Type */
571
572 #define MPI_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00)
573 #define MPI_SGE_FLAGS_SIMPLE_ELEMENT            (0x10)
574 #define MPI_SGE_FLAGS_CHAIN_ELEMENT             (0x30)
575 #define MPI_SGE_FLAGS_ELEMENT_MASK              (0x30)
576
577 /* Address location */
578
579 #define MPI_SGE_FLAGS_SYSTEM_ADDRESS            (0x00)
580
581 /* Direction */
582
583 #define MPI_SGE_FLAGS_IOC_TO_HOST               (0x00)
584 #define MPI_SGE_FLAGS_HOST_TO_IOC               (0x04)
585
586 /* Address Size */
587
588 #define MPI_SGE_FLAGS_32_BIT_ADDRESSING         (0x00)
589 #define MPI_SGE_FLAGS_64_BIT_ADDRESSING         (0x02)
590
591 /* Context Size */
592
593 #define MPI_SGE_FLAGS_32_BIT_CONTEXT            (0x00)
594 #define MPI_SGE_FLAGS_64_BIT_CONTEXT            (0x02)
595 #define MPI_SGE_FLAGS_96_BIT_CONTEXT            (0x04)
596 #define MPI_SGE_FLAGS_128_BIT_CONTEXT           (0x06)
597
598 #define MPI_SGE_CHAIN_OFFSET_MASK               (0x00FF0000)
599 #define MPI_SGE_CHAIN_OFFSET_SHIFT              (16)
600
601
602 /****************************************************************************/
603 /*  SGE operation Macros                                                    */
604 /****************************************************************************/
605
606          /* SIMPLE FlagsLength manipulations... */
607 #define  MPI_SGE_SET_FLAGS(f)           ((U32)(f) << MPI_SGE_FLAGS_SHIFT)
608 #define  MPI_SGE_GET_FLAGS(fl)          (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT)
609 #define  MPI_SGE_LENGTH(fl)             ((fl) & MPI_SGE_LENGTH_MASK)
610 #define  MPI_SGE_CHAIN_LENGTH(fl)       ((fl) & MPI_SGE_CHAIN_LENGTH_MASK)
611
612 #define  MPI_SGE_SET_FLAGS_LENGTH(f,l)  (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l))
613
614 #define  MPI_pSGE_GET_FLAGS(psg)        MPI_SGE_GET_FLAGS((psg)->FlagsLength)
615 #define  MPI_pSGE_GET_LENGTH(psg)       MPI_SGE_LENGTH((psg)->FlagsLength)
616 #define  MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l)  (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l)
617          /* CAUTION - The following are READ-MODIFY-WRITE! */
618 #define  MPI_pSGE_SET_FLAGS(psg,f)      (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f)
619 #define  MPI_pSGE_SET_LENGTH(psg,l)     (psg)->FlagsLength |= MPI_SGE_LENGTH(l)
620
621 #define  MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT)
622
623
624
625 /*****************************************************************************
626 *
627 *        S t a n d a r d    M e s s a g e    S t r u c t u r e s
628 *
629 *****************************************************************************/
630
631 /****************************************************************************/
632 /* Standard message request header for all request messages                 */
633 /****************************************************************************/
634
635 typedef struct _MSG_REQUEST_HEADER
636 {
637     U8                      Reserved[2];      /* function specific */
638     U8                      ChainOffset;
639     U8                      Function;
640     U8                      Reserved1[3];     /* function specific */
641     U8                      MsgFlags;
642     U32                     MsgContext;
643 } MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER,
644   MPIHeader_t, MPI_POINTER pMPIHeader_t;
645
646
647 /****************************************************************************/
648 /*  Default Reply                                                           */
649 /****************************************************************************/
650
651 typedef struct _MSG_DEFAULT_REPLY
652 {
653     U8                      Reserved[2];      /* function specific */
654     U8                      MsgLength;
655     U8                      Function;
656     U8                      Reserved1[3];     /* function specific */
657     U8                      MsgFlags;
658     U32                     MsgContext;
659     U8                      Reserved2[2];     /* function specific */
660     U16                     IOCStatus;
661     U32                     IOCLogInfo;
662 } MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY,
663   MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t;
664
665
666 /* MsgFlags definition for all replies */
667
668 #define MPI_MSGFLAGS_CONTINUATION_REPLY         (0x80)
669
670
671 /*****************************************************************************
672 *
673 *               I O C    S t a t u s   V a l u e s
674 *
675 *****************************************************************************/
676
677 /****************************************************************************/
678 /*  Common IOCStatus values for all replies                                 */
679 /****************************************************************************/
680
681 #define MPI_IOCSTATUS_SUCCESS                   (0x0000)
682 #define MPI_IOCSTATUS_INVALID_FUNCTION          (0x0001)
683 #define MPI_IOCSTATUS_BUSY                      (0x0002)
684 #define MPI_IOCSTATUS_INVALID_SGL               (0x0003)
685 #define MPI_IOCSTATUS_INTERNAL_ERROR            (0x0004)
686 #define MPI_IOCSTATUS_RESERVED                  (0x0005)
687 #define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES    (0x0006)
688 #define MPI_IOCSTATUS_INVALID_FIELD             (0x0007)
689 #define MPI_IOCSTATUS_INVALID_STATE             (0x0008)
690 #define MPI_IOCSTATUS_OP_STATE_NOT_SUPPORTED    (0x0009)
691
692 /****************************************************************************/
693 /*  Config IOCStatus values                                                 */
694 /****************************************************************************/
695
696 #define MPI_IOCSTATUS_CONFIG_INVALID_ACTION     (0x0020)
697 #define MPI_IOCSTATUS_CONFIG_INVALID_TYPE       (0x0021)
698 #define MPI_IOCSTATUS_CONFIG_INVALID_PAGE       (0x0022)
699 #define MPI_IOCSTATUS_CONFIG_INVALID_DATA       (0x0023)
700 #define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS        (0x0024)
701 #define MPI_IOCSTATUS_CONFIG_CANT_COMMIT        (0x0025)
702
703 /****************************************************************************/
704 /*  SCSIIO Reply (SPI & FCP) initiator values                               */
705 /****************************************************************************/
706
707 #define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR      (0x0040)
708 #define MPI_IOCSTATUS_SCSI_INVALID_BUS          (0x0041)
709 #define MPI_IOCSTATUS_SCSI_INVALID_TARGETID     (0x0042)
710 #define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE     (0x0043)
711 #define MPI_IOCSTATUS_SCSI_DATA_OVERRUN         (0x0044)
712 #define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN        (0x0045)
713 #define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR        (0x0046)
714 #define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR       (0x0047)
715 #define MPI_IOCSTATUS_SCSI_TASK_TERMINATED      (0x0048)
716 #define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH    (0x0049)
717 #define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED     (0x004A)
718 #define MPI_IOCSTATUS_SCSI_IOC_TERMINATED       (0x004B)
719 #define MPI_IOCSTATUS_SCSI_EXT_TERMINATED       (0x004C)
720
721 /****************************************************************************/
722 /*  For use by SCSI Initiator and SCSI Target end-to-end data protection    */
723 /****************************************************************************/
724
725 #define MPI_IOCSTATUS_EEDP_GUARD_ERROR          (0x004D)
726 #define MPI_IOCSTATUS_EEDP_REF_TAG_ERROR        (0x004E)
727 #define MPI_IOCSTATUS_EEDP_APP_TAG_ERROR        (0x004F)
728
729
730 /****************************************************************************/
731 /*  SCSI Target values                                                      */
732 /****************************************************************************/
733
734 #define MPI_IOCSTATUS_TARGET_PRIORITY_IO         (0x0060)
735 #define MPI_IOCSTATUS_TARGET_INVALID_PORT        (0x0061)
736 #define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX    (0x0062)   /* obsolete name */
737 #define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX    (0x0062)
738 #define MPI_IOCSTATUS_TARGET_ABORTED             (0x0063)
739 #define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE   (0x0064)
740 #define MPI_IOCSTATUS_TARGET_NO_CONNECTION       (0x0065)
741 #define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A)
742 #define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT   (0x006B)
743 #define MPI_IOCSTATUS_TARGET_DATA_OFFSET_ERROR   (0x006D)
744 #define MPI_IOCSTATUS_TARGET_TOO_MUCH_WRITE_DATA (0x006E)
745 #define MPI_IOCSTATUS_TARGET_IU_TOO_SHORT        (0x006F)
746 #define MPI_IOCSTATUS_TARGET_ACK_NAK_TIMEOUT     (0x0070)
747 #define MPI_IOCSTATUS_TARGET_NAK_RECEIVED        (0x0071)
748
749 /****************************************************************************/
750 /*  Additional FCP target values (obsolete)                                 */
751 /****************************************************************************/
752
753 #define MPI_IOCSTATUS_TARGET_FC_ABORTED         (0x0066)    /* obsolete */
754 #define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID   (0x0067)    /* obsolete */
755 #define MPI_IOCSTATUS_TARGET_FC_DID_INVALID     (0x0068)    /* obsolete */
756 #define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069)    /* obsolete */
757
758 /****************************************************************************/
759 /*  Fibre Channel Direct Access values                                      */
760 /****************************************************************************/
761
762 #define MPI_IOCSTATUS_FC_ABORTED                (0x0066)
763 #define MPI_IOCSTATUS_FC_RX_ID_INVALID          (0x0067)
764 #define MPI_IOCSTATUS_FC_DID_INVALID            (0x0068)
765 #define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT        (0x0069)
766 #define MPI_IOCSTATUS_FC_EXCHANGE_CANCELED      (0x006C)
767
768 /****************************************************************************/
769 /*  LAN values                                                              */
770 /****************************************************************************/
771
772 #define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND      (0x0080)
773 #define MPI_IOCSTATUS_LAN_DEVICE_FAILURE        (0x0081)
774 #define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR        (0x0082)
775 #define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED      (0x0083)
776 #define MPI_IOCSTATUS_LAN_RECEIVE_ERROR         (0x0084)
777 #define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED       (0x0085)
778 #define MPI_IOCSTATUS_LAN_PARTIAL_PACKET        (0x0086)
779 #define MPI_IOCSTATUS_LAN_CANCELED              (0x0087)
780
781 /****************************************************************************/
782 /*  Serial Attached SCSI values                                             */
783 /****************************************************************************/
784
785 #define MPI_IOCSTATUS_SAS_SMP_REQUEST_FAILED    (0x0090)
786 #define MPI_IOCSTATUS_SAS_SMP_DATA_OVERRUN      (0x0091)
787
788 /****************************************************************************/
789 /*  Inband values                                                           */
790 /****************************************************************************/
791
792 #define MPI_IOCSTATUS_INBAND_ABORTED            (0x0098)
793 #define MPI_IOCSTATUS_INBAND_NO_CONNECTION      (0x0099)
794
795 /****************************************************************************/
796 /*  Diagnostic Tools values                                                 */
797 /****************************************************************************/
798
799 #define MPI_IOCSTATUS_DIAGNOSTIC_RELEASED       (0x00A0)
800
801
802 /****************************************************************************/
803 /*  IOCStatus flag to indicate that log info is available                   */
804 /****************************************************************************/
805
806 #define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE   (0x8000)
807 #define MPI_IOCSTATUS_MASK                      (0x7FFF)
808
809 /****************************************************************************/
810 /*  LogInfo Types                                                           */
811 /****************************************************************************/
812
813 #define MPI_IOCLOGINFO_TYPE_MASK                (0xF0000000)
814 #define MPI_IOCLOGINFO_TYPE_SHIFT               (28)
815 #define MPI_IOCLOGINFO_TYPE_NONE                (0x0)
816 #define MPI_IOCLOGINFO_TYPE_SCSI                (0x1)
817 #define MPI_IOCLOGINFO_TYPE_FC                  (0x2)
818 #define MPI_IOCLOGINFO_TYPE_SAS                 (0x3)
819 #define MPI_IOCLOGINFO_TYPE_ISCSI               (0x4)
820 #define MPI_IOCLOGINFO_LOG_DATA_MASK            (0x0FFFFFFF)
821
822
823 #endif