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