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