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