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