drivers/message/fusion/lsi/mpi.h

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