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