drivers/message/fusion/lsi/mpi.h

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