sys/dev/disk/mpt/mpilib/mpi.h

   1 /* $FreeBSD: src/sys/dev/mpt/mpilib/mpi.h,v 1.1.2.2 2002/09/01 23:08:06 mjacob Exp $ */
   2 /* $DragonFly: src/sys/dev/disk/mpt/mpilib/mpi.h,v 1.2 2003/06/17 04:28:28 dillon Exp $ */
   3 /*
   4  * Copyright (c) 2000, 2001 by LSI Logic Corporation
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice immediately at the beginning of the file, without modification,
  11  *    this list of conditions, and the following disclaimer.
  12  * 2. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  *
  28  *           Name:  MPI.H
  29  *          Title:  MPI Message independent structures and definitions
  30  *  Creation Date:  July 27, 2000
  31  *
  32  *    MPI Version:  01.02.03
  33  *
  34  *  Version History
  35  *  ---------------
  36  *
  37  *  Date      Version   Description
  38  *  --------  --------  ------------------------------------------------------
  39  *  05-08-00  00.10.01  Original release for 0.10 spec dated 4/26/2000.
  40  *  05-24-00  00.10.02  Added MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH definition.
  41  *  06-06-00  01.00.01  Update MPI_VERSION_MAJOR and MPI_VERSION_MINOR.
  42  *  06-22-00  01.00.02  Added MPI_IOCSTATUS_LAN_ definitions.
  43  *                      Removed LAN_SUSPEND function definition.
  44  *                      Added MPI_MSGFLAGS_CONTINUATION_REPLY definition.
  45  *  06-30-00  01.00.03  Added MPI_CONTEXT_REPLY_TYPE_LAN definition.
  46  *                      Added MPI_GET/SET_CONTEXT_REPLY_TYPE macros.
  47  *  07-27-00  01.00.04  Added MPI_FAULT_ definitions.
  48  *                      Removed MPI_IOCSTATUS_MSG/DATA_XFER_ERROR definitions.
  49  *                      Added MPI_IOCSTATUS_INTERNAL_ERROR definition.
  50  *                      Added MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH.
  51  *  11-02-00  01.01.01  Original release for post 1.0 work.
  52  *  12-04-00  01.01.02  Added new function codes.
  53  *  01-09-01  01.01.03  Added more definitions to the system interface section
  54  *                      Added MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT.
  55  *  01-25-01  01.01.04  Changed MPI_VERSION_MINOR from 0x00 to 0x01.
  56  *  02-20-01  01.01.05  Started using MPI_POINTER.
  57  *                      Fixed value for MPI_DIAG_RW_ENABLE.
  58  *                      Added defines for MPI_DIAG_PREVENT_IOC_BOOT and
  59  *                      MPI_DIAG_CLEAR_FLASH_BAD_SIG.
  60  *                      Obsoleted MPI_IOCSTATUS_TARGET_FC_ defines.
  61  *  02-27-01  01.01.06  Removed MPI_HOST_INDEX_REGISTER define.
  62  *                      Added function codes for RAID.
  63  *  04-09-01  01.01.07  Added alternate define for MPI_DOORBELL_ACTIVE,
  64  *                      MPI_DOORBELL_USED, to better match the spec.
  65  *  08-08-01  01.02.01  Original release for v1.2 work.
  66  *                      Changed MPI_VERSION_MINOR from 0x01 to 0x02.
  67  *                      Added define MPI_FUNCTION_TOOLBOX.
  68  *  09-28-01  01.02.02  New function code MPI_SCSI_ENCLOSURE_PROCESSOR.
  69  *  11-01-01  01.02.03  Changed name to MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR.
  70  *  --------------------------------------------------------------------------
  71  */
  72
  73 #ifndef MPI_H
  74 #define MPI_H
  75
  76
  77 /*****************************************************************************
  78 *
  79 *        M P I    V e r s i o n    D e f i n i t i o n s
  80 *
  81 *****************************************************************************/
  82
  83 #define MPI_VERSION_MAJOR                   (0x01)
  84 #define MPI_VERSION_MINOR                   (0x02)
  85 #define MPI_VERSION            ((MPI_VERSION_MAJOR << 8) | MPI_VERSION_MINOR)
  86
  87 /* Note: The major versions of 0xe0 through 0xff are reserved */
  88
  89 /*****************************************************************************
  90 *
  91 *        I O C    S t a t e    D e f i n i t i o n s
  92 *
  93 *****************************************************************************/
  94
  95 #define MPI_IOC_STATE_RESET                 (0x00000000)
  96 #define MPI_IOC_STATE_READY                 (0x10000000)
  97 #define MPI_IOC_STATE_OPERATIONAL           (0x20000000)
  98 #define MPI_IOC_STATE_FAULT                 (0x40000000)
  99
 100 #define MPI_IOC_STATE_MASK                  (0xF0000000)
 101 #define MPI_IOC_STATE_SHIFT                 (28)
 102
 103 /* Fault state codes (product independent range 0x8000-0xFFFF) */
 104
 105 #define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR  (0x8111)
 106 #define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT     (0x8112)
 107 #define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR    (0x8113)
 108 #define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT       (0x8114)
 109 #define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR        (0x8115)
 110 #define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT           (0x8116)
 111 #define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR     (0x8117)
 112 #define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT        (0x8118)
 113
 114
 115 /*****************************************************************************
 116 *
 117 *        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
 118 *
 119 *****************************************************************************/
 120
 121 /* S y s t e m    D o o r b e l l */
 122 #define MPI_DOORBELL_OFFSET                 (0x00000000)
 123 #define MPI_DOORBELL_ACTIVE                 (0x08000000) /* DoorbellUsed */
 124 #define MPI_DOORBELL_USED                   (MPI_DOORBELL_ACTIVE)
 125 #define MPI_DOORBELL_ACTIVE_SHIFT           (27)
 126 #define MPI_DOORBELL_WHO_INIT_MASK          (0x07000000)
 127 #define MPI_DOORBELL_WHO_INIT_SHIFT         (24)
 128 #define MPI_DOORBELL_FUNCTION_MASK          (0xFF000000)
 129 #define MPI_DOORBELL_FUNCTION_SHIFT         (24)
 130 #define MPI_DOORBELL_ADD_DWORDS_MASK        (0x00FF0000)
 131 #define MPI_DOORBELL_ADD_DWORDS_SHIFT       (16)
 132 #define MPI_DOORBELL_DATA_MASK              (0x0000FFFF)
 133
 134
 135 #define MPI_WRITE_SEQUENCE_OFFSET           (0x00000004)
 136 #define MPI_WRSEQ_KEY_VALUE_MASK            (0x0000000F)
 137 #define MPI_WRSEQ_1ST_KEY_VALUE             (0x04)
 138 #define MPI_WRSEQ_2ND_KEY_VALUE             (0x0B)
 139 #define MPI_WRSEQ_3RD_KEY_VALUE             (0x02)
 140 #define MPI_WRSEQ_4TH_KEY_VALUE             (0x07)
 141 #define MPI_WRSEQ_5TH_KEY_VALUE             (0x0D)
 142
 143 #define MPI_DIAGNOSTIC_OFFSET               (0x00000008)
 144 #define MPI_DIAG_CLEAR_FLASH_BAD_SIG        (0x00000400)
 145 #define MPI_DIAG_PREVENT_IOC_BOOT           (0x00000200)
 146 #define MPI_DIAG_DRWE                       (0x00000080)
 147 #define MPI_DIAG_FLASH_BAD_SIG              (0x00000040)
 148 #define MPI_DIAG_RESET_HISTORY              (0x00000020)
 149 #define MPI_DIAG_RW_ENABLE                  (0x00000010)
 150 #define MPI_DIAG_RESET_ADAPTER              (0x00000004)
 151 #define MPI_DIAG_DISABLE_ARM                (0x00000002)
 152 #define MPI_DIAG_MEM_ENABLE                 (0x00000001)
 153
 154 #define MPI_TEST_BASE_ADDRESS_OFFSET        (0x0000000C)
 155
 156 #define MPI_DIAG_RW_DATA_OFFSET             (0x00000010)
 157
 158 #define MPI_DIAG_RW_ADDRESS_OFFSET          (0x00000014)
 159
 160 #define MPI_HOST_INTERRUPT_STATUS_OFFSET    (0x00000030)
 161 #define MPI_HIS_IOP_DOORBELL_STATUS         (0x80000000)
 162 #define MPI_HIS_REPLY_MESSAGE_INTERRUPT     (0x00000008)
 163 #define MPI_HIS_DOORBELL_INTERRUPT          (0x00000001)
 164
 165 #define MPI_HOST_INTERRUPT_MASK_OFFSET      (0x00000034)
 166 #define MPI_HIM_RIM                         (0x00000008)
 167 #define MPI_HIM_DIM                         (0x00000001)
 168
 169 #define MPI_REQUEST_QUEUE_OFFSET            (0x00000040)
 170 #define MPI_REQUEST_POST_FIFO_OFFSET        (0x00000040)
 171
 172 #define MPI_REPLY_QUEUE_OFFSET              (0x00000044)
 173 #define MPI_REPLY_POST_FIFO_OFFSET          (0x00000044)
 174 #define MPI_REPLY_FREE_FIFO_OFFSET          (0x00000044)
 175
 176
 177
 178 /*****************************************************************************
 179 *
 180 *        M e s s a g e    F r a m e    D e s c r i p t o r s
 181 *
 182 *****************************************************************************/
 183
 184 #define MPI_REQ_MF_DESCRIPTOR_NB_MASK       (0x00000003)
 185 #define MPI_REQ_MF_DESCRIPTOR_F_BIT         (0x00000004)
 186 #define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK  (0xFFFFFFF8)
 187
 188 #define MPI_ADDRESS_REPLY_A_BIT             (0x80000000)
 189 #define MPI_ADDRESS_REPLY_ADDRESS_MASK      (0x7FFFFFFF)
 190
 191 #define MPI_CONTEXT_REPLY_A_BIT             (0x80000000)
 192 #define MPI_CONTEXT_REPLY_TYPE_MASK         (0x60000000)
 193 #define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT    (0x00)
 194 #define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET  (0x01)
 195 #define MPI_CONTEXT_REPLY_TYPE_LAN          (0x02)
 196 #define MPI_CONTEXT_REPLY_TYPE_SHIFT        (29)
 197 #define MPI_CONTEXT_REPLY_CONTEXT_MASK      (0x1FFFFFFF)
 198
 199
 200 /****************************************************************************/
 201 /* Context Reply macros                                                     */
 202 /****************************************************************************/
 203
 204 #define MPI_GET_CONTEXT_REPLY_TYPE(x)  (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) \
 205                                           >> MPI_CONTEXT_REPLY_TYPE_SHIFT)
 206
 207 #define MPI_SET_CONTEXT_REPLY_TYPE(x, typ)                                  \
 208             ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) |                   \
 209                             (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) &      \
 210                                         MPI_CONTEXT_REPLY_TYPE_MASK))
 211
 212
 213 /*****************************************************************************
 214 *
 215 *        M e s s a g e    F u n c t i o n s
 216 *              0x80 -> 0x8F reserved for private message use per product
 217 *
 218 *
 219 *****************************************************************************/
 220
 221 #define MPI_FUNCTION_SCSI_IO_REQUEST                (0x00)
 222 #define MPI_FUNCTION_SCSI_TASK_MGMT                 (0x01)
 223 #define MPI_FUNCTION_IOC_INIT                       (0x02)
 224 #define MPI_FUNCTION_IOC_FACTS                      (0x03)
 225 #define MPI_FUNCTION_CONFIG                         (0x04)
 226 #define MPI_FUNCTION_PORT_FACTS                     (0x05)
 227 #define MPI_FUNCTION_PORT_ENABLE                    (0x06)
 228 #define MPI_FUNCTION_EVENT_NOTIFICATION             (0x07)
 229 #define MPI_FUNCTION_EVENT_ACK                      (0x08)
 230 #define MPI_FUNCTION_FW_DOWNLOAD                    (0x09)
 231 #define MPI_FUNCTION_TARGET_CMD_BUFFER_POST         (0x0A)
 232 #define MPI_FUNCTION_TARGET_ASSIST                  (0x0B)
 233 #define MPI_FUNCTION_TARGET_STATUS_SEND             (0x0C)
 234 #define MPI_FUNCTION_TARGET_MODE_ABORT              (0x0D)
 235 #define MPI_FUNCTION_TARGET_FC_BUF_POST_LINK_SRVC   (0x0E) /* obsolete name */
 236 #define MPI_FUNCTION_TARGET_FC_RSP_LINK_SRVC        (0x0F) /* obsolete name */
 237 #define MPI_FUNCTION_TARGET_FC_EX_SEND_LINK_SRVC    (0x10) /* obsolete name */
 238 #define MPI_FUNCTION_TARGET_FC_ABORT                (0x11) /* obsolete name */
 239 #define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST          (0x0E)
 240 #define MPI_FUNCTION_FC_LINK_SRVC_RSP               (0x0F)
 241 #define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND           (0x10)
 242 #define MPI_FUNCTION_FC_ABORT                       (0x11)
 243 #define MPI_FUNCTION_FW_UPLOAD                      (0x12)
 244 #define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND       (0x13)
 245 #define MPI_FUNCTION_FC_PRIMITIVE_SEND              (0x14)
 246
 247 #define MPI_FUNCTION_RAID_ACTION                    (0x15)
 248 #define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH       (0x16)
 249
 250 #define MPI_FUNCTION_TOOLBOX                        (0x17)
 251
 252 #define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR       (0x18)
 253
 254 #define MPI_FUNCTION_LAN_SEND                       (0x20)
 255 #define MPI_FUNCTION_LAN_RECEIVE                    (0x21)
 256 #define MPI_FUNCTION_LAN_RESET                      (0x22)
 257
 258 #define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET         (0x40)
 259 #define MPI_FUNCTION_IO_UNIT_RESET                  (0x41)
 260 #define MPI_FUNCTION_HANDSHAKE                      (0x42)
 261 #define MPI_FUNCTION_REPLY_FRAME_REMOVAL            (0x43)
 262
 263
 264
 265 /*****************************************************************************
 266 *
 267 *        S c a t t e r    G a t h e r    E l e m e n t s
 268 *
 269 *****************************************************************************/
 270
 271 /****************************************************************************/
 272 /*  Simple element structures                                               */
 273 /****************************************************************************/
 274
 275 typedef struct _SGE_SIMPLE32
 276 {
 277     U32                     FlagsLength;
 278     U32                     Address;
 279 } SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32,
 280   SGESimple32_t, MPI_POINTER pSGESimple32_t;
 281
 282 typedef struct _SGE_SIMPLE64
 283 {
 284     U32                     FlagsLength;
 285     U64                     Address;
 286 } SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64,
 287   SGESimple64_t, MPI_POINTER pSGESimple64_t;
 288
 289 typedef struct _SGE_SIMPLE_UNION
 290 {
 291     U32                     FlagsLength;
 292     union
 293     {
 294         U32                 Address32;
 295         U64                 Address64;
 296     } _u;
 297 } SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t,
 298   SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION;
 299
 300 /****************************************************************************/
 301 /*  Chain element structures                                                */
 302 /****************************************************************************/
 303
 304 typedef struct _SGE_CHAIN32
 305 {
 306     U16                     Length;
 307     U8                      NextChainOffset;
 308     U8                      Flags;
 309     U32                     Address;
 310 } SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32,
 311   SGEChain32_t, MPI_POINTER pSGEChain32_t;
 312
 313 typedef struct _SGE_CHAIN64
 314 {
 315     U16                     Length;
 316     U8                      NextChainOffset;
 317     U8                      Flags;
 318     U64                     Address;
 319 } SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64,
 320   SGEChain64_t, MPI_POINTER pSGEChain64_t;
 321
 322 typedef struct _SGE_CHAIN_UNION
 323 {
 324     U16                     Length;
 325     U8                      NextChainOffset;
 326     U8                      Flags;
 327     union
 328     {
 329         U32                 Address32;
 330         U64                 Address64;
 331     } _u;
 332 } SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION,
 333   SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t;
 334
 335 /****************************************************************************/
 336 /*  Transaction Context element                                             */
 337 /****************************************************************************/
 338
 339 typedef struct _SGE_TRANSACTION32
 340 {
 341     U8                      Reserved;
 342     U8                      ContextSize;
 343     U8                      DetailsLength;
 344     U8                      Flags;
 345     U32                     TransactionContext[1];
 346     U32                     TransactionDetails[1];
 347 } SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32,
 348   SGETransaction32_t, MPI_POINTER pSGETransaction32_t;
 349
 350 typedef struct _SGE_TRANSACTION64
 351 {
 352     U8                      Reserved;
 353     U8                      ContextSize;
 354     U8                      DetailsLength;
 355     U8                      Flags;
 356     U32                     TransactionContext[2];
 357     U32                     TransactionDetails[1];
 358 } SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64,
 359   SGETransaction64_t, MPI_POINTER pSGETransaction64_t;
 360
 361 typedef struct _SGE_TRANSACTION96
 362 {
 363     U8                      Reserved;
 364     U8                      ContextSize;
 365     U8                      DetailsLength;
 366     U8                      Flags;
 367     U32                     TransactionContext[3];
 368     U32                     TransactionDetails[1];
 369 } SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96,
 370   SGETransaction96_t, MPI_POINTER pSGETransaction96_t;
 371
 372 typedef struct _SGE_TRANSACTION128
 373 {
 374     U8                      Reserved;
 375     U8                      ContextSize;
 376     U8                      DetailsLength;
 377     U8                      Flags;
 378     U32                     TransactionContext[4];
 379     U32                     TransactionDetails[1];
 380 } SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128,
 381   SGETransaction_t128, MPI_POINTER pSGETransaction_t128;
 382
 383 typedef struct _SGE_TRANSACTION_UNION
 384 {
 385     U8                      Reserved;
 386     U8                      ContextSize;
 387     U8                      DetailsLength;
 388     U8                      Flags;
 389     union
 390     {
 391         U32                 TransactionContext32[1];
 392         U32                 TransactionContext64[2];
 393         U32                 TransactionContext96[3];
 394         U32                 TransactionContext128[4];
 395     } _u;
 396     U32                     TransactionDetails[1];
 397 } SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION,
 398   SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t;
 399
 400
 401 /****************************************************************************/
 402 /*  SGE IO types union  for IO SGL's                                        */
 403 /****************************************************************************/
 404
 405 typedef struct _SGE_IO_UNION
 406 {
 407     union
 408     {
 409         SGE_SIMPLE_UNION    Simple;
 410         SGE_CHAIN_UNION     Chain;
 411     } _u;
 412 } SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION,
 413   SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t;
 414
 415 /****************************************************************************/
 416 /*  SGE union for SGL's with Simple and Transaction elements                */
 417 /****************************************************************************/
 418
 419 typedef struct _SGE_TRANS_SIMPLE_UNION
 420 {
 421     union
 422     {
 423         SGE_SIMPLE_UNION        Simple;
 424         SGE_TRANSACTION_UNION   Transaction;
 425     } _u;
 426 } SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION,
 427   SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t;
 428
 429 /****************************************************************************/
 430 /*  All SGE types union                                                     */
 431 /****************************************************************************/
 432
 433 typedef struct _SGE_MPI_UNION
 434 {
 435     union
 436     {
 437         SGE_SIMPLE_UNION        Simple;
 438         SGE_CHAIN_UNION         Chain;
 439         SGE_TRANSACTION_UNION   Transaction;
 440     } _u;
 441 } SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION,
 442   MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t,
 443   SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t;
 444
 445
 446 /****************************************************************************/
 447 /*  SGE field definition and masks                                          */
 448 /****************************************************************************/
 449
 450 /* Flags field bit definitions */
 451
 452 #define MPI_SGE_FLAGS_LAST_ELEMENT              (0x80)
 453 #define MPI_SGE_FLAGS_END_OF_BUFFER             (0x40)
 454 #define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK         (0x30)
 455 #define MPI_SGE_FLAGS_LOCAL_ADDRESS             (0x08)
 456 #define MPI_SGE_FLAGS_DIRECTION                 (0x04)
 457 #define MPI_SGE_FLAGS_ADDRESS_SIZE              (0x02)
 458 #define MPI_SGE_FLAGS_END_OF_LIST               (0x01)
 459
 460 #define MPI_SGE_FLAGS_SHIFT                     (24)
 461
 462 #define MPI_SGE_LENGTH_MASK                     (0x00FFFFFF)
 463 #define MPI_SGE_CHAIN_LENGTH_MASK               (0x0000FFFF)
 464
 465 /* Element Type */
 466
 467 #define MPI_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00)
 468 #define MPI_SGE_FLAGS_SIMPLE_ELEMENT            (0x10)
 469 #define MPI_SGE_FLAGS_CHAIN_ELEMENT             (0x30)
 470 #define MPI_SGE_FLAGS_ELEMENT_MASK              (0x30)
 471
 472 /* Address location */
 473
 474 #define MPI_SGE_FLAGS_SYSTEM_ADDRESS            (0x00)
 475
 476 /* Direction */
 477
 478 #define MPI_SGE_FLAGS_IOC_TO_HOST               (0x00)
 479 #define MPI_SGE_FLAGS_HOST_TO_IOC               (0x04)
 480
 481 /* Address Size */
 482
 483 #define MPI_SGE_FLAGS_32_BIT_ADDRESSING         (0x00)
 484 #define MPI_SGE_FLAGS_64_BIT_ADDRESSING         (0x02)
 485
 486 /* Context Size */
 487
 488 #define MPI_SGE_FLAGS_32_BIT_CONTEXT            (0x00)
 489 #define MPI_SGE_FLAGS_64_BIT_CONTEXT            (0x02)
 490 #define MPI_SGE_FLAGS_96_BIT_CONTEXT            (0x04)
 491 #define MPI_SGE_FLAGS_128_BIT_CONTEXT           (0x06)
 492
 493 #define MPI_SGE_CHAIN_OFFSET_MASK               (0x00FF0000)
 494 #define MPI_SGE_CHAIN_OFFSET_SHIFT              (16)
 495
 496
 497 /****************************************************************************/
 498 /*  SGE operation Macros                                                    */
 499 /****************************************************************************/
 500
 501          /* SIMPLE FlagsLength manipulations... */
 502 #define  MPI_SGE_SET_FLAGS(f)           ((U32)(f) << MPI_SGE_FLAGS_SHIFT)
 503 #define  MPI_SGE_GET_FLAGS(fl)          (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT)
 504 #define  MPI_SGE_LENGTH(fl)             ((fl) & MPI_SGE_LENGTH_MASK)
 505 #define  MPI_SGE_CHAIN_LENGTH(fl)       ((fl) & MPI_SGE_CHAIN_LENGTH_MASK)
 506
 507 #define  MPI_SGE_SET_FLAGS_LENGTH(f,l)  (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l))
 508
 509 #define  MPI_pSGE_GET_FLAGS(psg)        MPI_SGE_GET_FLAGS((psg)->FlagsLength)
 510 #define  MPI_pSGE_GET_LENGTH(psg)       MPI_SGE_LENGTH((psg)->FlagsLength)
 511 #define  MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l)  (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l)
 512          /* CAUTION - The following are READ-MODIFY-WRITE! */
 513 #define  MPI_pSGE_SET_FLAGS(psg,f)      (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f)
 514 #define  MPI_pSGE_SET_LENGTH(psg,l)     (psg)->FlagsLength |= MPI_SGE_LENGTH(l)
 515
 516 #define  MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT)
 517
 518
 519
 520 /*****************************************************************************
 521 *
 522 *        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
 523 *
 524 *****************************************************************************/
 525
 526 /****************************************************************************/
 527 /* Standard message request header for all request messages                 */
 528 /****************************************************************************/
 529
 530 typedef struct _MSG_REQUEST_HEADER
 531 {
 532     U8                      Reserved[2];      /* function specific */
 533     U8                      ChainOffset;
 534     U8                      Function;
 535     U8                      Reserved1[3];     /* function specific */
 536     U8                      MsgFlags;
 537     U32                     MsgContext;
 538 } MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER,
 539   MPIHeader_t, MPI_POINTER pMPIHeader_t;
 540
 541
 542 /****************************************************************************/
 543 /*  Default Reply                                                           */
 544 /****************************************************************************/
 545
 546 typedef struct _MSG_DEFAULT_REPLY
 547 {
 548     U8                      Reserved[2];      /* function specific */
 549     U8                      MsgLength;
 550     U8                      Function;
 551     U8                      Reserved1[3];     /* function specific */
 552     U8                      MsgFlags;
 553     U32                     MsgContext;
 554     U8                      Reserved2[2];     /* function specific */
 555     U16                     IOCStatus;
 556     U32                     IOCLogInfo;
 557 } MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY,
 558   MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t;
 559
 560
 561 /* MsgFlags definition for all replies */
 562
 563 #define MPI_MSGFLAGS_CONTINUATION_REPLY         (0x80)
 564
 565
 566 /*****************************************************************************
 567 *
 568 *               I O C    S t a t u s   V a l u e s
 569 *
 570 *****************************************************************************/
 571
 572 /****************************************************************************/
 573 /*  Common IOCStatus values for all replies                                 */
 574 /****************************************************************************/
 575
 576 #define MPI_IOCSTATUS_SUCCESS                  (0x0000)
 577 #define MPI_IOCSTATUS_INVALID_FUNCTION         (0x0001)
 578 #define MPI_IOCSTATUS_BUSY                     (0x0002)
 579 #define MPI_IOCSTATUS_INVALID_SGL              (0x0003)
 580 #define MPI_IOCSTATUS_INTERNAL_ERROR           (0x0004)
 581 #define MPI_IOCSTATUS_RESERVED                 (0x0005)
 582 #define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES   (0x0006)
 583 #define MPI_IOCSTATUS_INVALID_FIELD            (0x0007)
 584 #define MPI_IOCSTATUS_INVALID_STATE            (0x0008)
 585
 586 /****************************************************************************/
 587 /*  Config IOCStatus values                                                 */
 588 /****************************************************************************/
 589
 590 #define MPI_IOCSTATUS_CONFIG_INVALID_ACTION    (0x0020)
 591 #define MPI_IOCSTATUS_CONFIG_INVALID_TYPE      (0x0021)
 592 #define MPI_IOCSTATUS_CONFIG_INVALID_PAGE      (0x0022)
 593 #define MPI_IOCSTATUS_CONFIG_INVALID_DATA      (0x0023)
 594 #define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS       (0x0024)
 595 #define MPI_IOCSTATUS_CONFIG_CANT_COMMIT       (0x0025)
 596
 597 /****************************************************************************/
 598 /*  SCSIIO Reply (SPI & FCP) initiator values                               */
 599 /****************************************************************************/
 600
 601 #define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR     (0x0040)
 602 #define MPI_IOCSTATUS_SCSI_INVALID_BUS         (0x0041)
 603 #define MPI_IOCSTATUS_SCSI_INVALID_TARGETID    (0x0042)
 604 #define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE    (0x0043)
 605 #define MPI_IOCSTATUS_SCSI_DATA_OVERRUN        (0x0044)
 606 #define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN       (0x0045)
 607 #define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR       (0x0046)
 608 #define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR      (0x0047)
 609 #define MPI_IOCSTATUS_SCSI_TASK_TERMINATED     (0x0048)
 610 #define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH   (0x0049)
 611 #define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED    (0x004A)
 612 #define MPI_IOCSTATUS_SCSI_IOC_TERMINATED      (0x004B)
 613 #define MPI_IOCSTATUS_SCSI_EXT_TERMINATED      (0x004C)
 614
 615 /****************************************************************************/
 616 /*  SCSI (SPI & FCP) target values                                          */
 617 /****************************************************************************/
 618
 619 #define MPI_IOCSTATUS_TARGET_PRIORITY_IO         (0x0060)
 620 #define MPI_IOCSTATUS_TARGET_INVALID_PORT        (0x0061)
 621 #define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX    (0x0062)
 622 #define MPI_IOCSTATUS_TARGET_ABORTED             (0x0063)
 623 #define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE   (0x0064)
 624 #define MPI_IOCSTATUS_TARGET_NO_CONNECTION       (0x0065)
 625 #define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A)
 626 #define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT   (0x006B)
 627
 628 /****************************************************************************/
 629 /*  Additional FCP target values                                            */
 630 /****************************************************************************/
 631
 632 #define MPI_IOCSTATUS_TARGET_FC_ABORTED         (0x0066)    /* obsolete */
 633 #define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID   (0x0067)    /* obsolete */
 634 #define MPI_IOCSTATUS_TARGET_FC_DID_INVALID     (0x0068)    /* obsolete */
 635 #define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069)    /* obsolete */
 636
 637 /****************************************************************************/
 638 /*  Fibre Channel Direct Access values                                      */
 639 /****************************************************************************/
 640
 641 #define MPI_IOCSTATUS_FC_ABORTED                (0x0066)
 642 #define MPI_IOCSTATUS_FC_RX_ID_INVALID          (0x0067)
 643 #define MPI_IOCSTATUS_FC_DID_INVALID            (0x0068)
 644 #define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT        (0x0069)
 645
 646 /****************************************************************************/
 647 /*  LAN values                                                              */
 648 /****************************************************************************/
 649
 650 #define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND      (0x0080)
 651 #define MPI_IOCSTATUS_LAN_DEVICE_FAILURE        (0x0081)
 652 #define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR        (0x0082)
 653 #define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED      (0x0083)
 654 #define MPI_IOCSTATUS_LAN_RECEIVE_ERROR         (0x0084)
 655 #define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED       (0x0085)
 656 #define MPI_IOCSTATUS_LAN_PARTIAL_PACKET        (0x0086)
 657 #define MPI_IOCSTATUS_LAN_CANCELED              (0x0087)
 658
 659
 660 /****************************************************************************/
 661 /*  IOCStatus flag to indicate that log info is available                   */
 662 /****************************************************************************/
 663
 664 #define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE   (0x8000)
 665 #define MPI_IOCSTATUS_MASK                      (0x7FFF)
 666
 667 /****************************************************************************/
 668 /*  LogInfo Types                                                           */
 669 /****************************************************************************/
 670
 671 #define MPI_IOCLOGINFO_TYPE_MASK                (0xF0000000)
 672 #define MPI_IOCLOGINFO_TYPE_NONE                (0x0)
 673 #define MPI_IOCLOGINFO_TYPE_SCSI                (0x1)
 674 #define MPI_IOCLOGINFO_TYPE_FC                  (0x2)
 675 #define MPI_IOCLOGINFO_LOG_DATA_MASK            (0x0FFFFFFF)
 676
 677
 678 #endif