Subversion Repositories or1k

/*

 *  Copyright (c) 2000-2003 LSI Logic Corporation.

 *

 *

 *           Name:  MPI.H

 *          Title:  MPI Message independent structures and definitions

 *  Creation Date:  July 27, 2000

 *

 *    MPI.H Version:  01.02.10

 *

 *  Version History

 *  ---------------

 *

 *  Date      Version   Description

 *  --------  --------  ------------------------------------------------------

 *  05-08-00  00.10.01  Original release for 0.10 spec dated 4/26/2000.

 *  05-24-00  00.10.02  Added MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH definition.

 *  06-06-00  01.00.01  Update MPI_VERSION_MAJOR and MPI_VERSION_MINOR.

 *  06-22-00  01.00.02  Added MPI_IOCSTATUS_LAN_ definitions.

 *                      Removed LAN_SUSPEND function definition.

 *                      Added MPI_MSGFLAGS_CONTINUATION_REPLY definition.

 *  06-30-00  01.00.03  Added MPI_CONTEXT_REPLY_TYPE_LAN definition.

 *                      Added MPI_GET/SET_CONTEXT_REPLY_TYPE macros.

 *  07-27-00  01.00.04  Added MPI_FAULT_ definitions.

 *                      Removed MPI_IOCSTATUS_MSG/DATA_XFER_ERROR definitions.

 *                      Added MPI_IOCSTATUS_INTERNAL_ERROR definition.

 *                      Added MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH.

 *  11-02-00  01.01.01  Original release for post 1.0 work.

 *  12-04-00  01.01.02  Added new function codes.

 *  01-09-01  01.01.03  Added more definitions to the system interface section

 *                      Added MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT.

 *  01-25-01  01.01.04  Changed MPI_VERSION_MINOR from 0x00 to 0x01.

 *  02-20-01  01.01.05  Started using MPI_POINTER.

 *                      Fixed value for MPI_DIAG_RW_ENABLE.

 *                      Added defines for MPI_DIAG_PREVENT_IOC_BOOT and

 *                      MPI_DIAG_CLEAR_FLASH_BAD_SIG.

 *                      Obsoleted MPI_IOCSTATUS_TARGET_FC_ defines.

 *  02-27-01  01.01.06  Removed MPI_HOST_INDEX_REGISTER define.

 *                      Added function codes for RAID.

 *  04-09-01  01.01.07  Added alternate define for MPI_DOORBELL_ACTIVE,

 *                      MPI_DOORBELL_USED, to better match the spec.

 *  08-08-01  01.02.01  Original release for v1.2 work.

 *                      Changed MPI_VERSION_MINOR from 0x01 to 0x02.

 *                      Added define MPI_FUNCTION_TOOLBOX.

 *  09-28-01  01.02.02  New function code MPI_SCSI_ENCLOSURE_PROCESSOR.

 *  11-01-01  01.02.03  Changed name to MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR.

 *  03-14-02  01.02.04  Added MPI_HEADER_VERSION_ defines.

 *  05-31-02  01.02.05  Bumped MPI_HEADER_VERSION_UNIT.

 *  07-12-02  01.02.06  Added define for MPI_FUNCTION_MAILBOX.

 *  09-16-02  01.02.07  Bumped value for MPI_HEADER_VERSION_UNIT.

 *  11-15-02  01.02.08  Added define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX and

 *                      obsoleted define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX.

 *  04-01-03  01.02.09  New IOCStatus code: MPI_IOCSTATUS_FC_EXCHANGE_CANCELED

 *  06-26-03  01.02.10  Bumped MPI_HEADER_VERSION_UNIT value.

 *  --------------------------------------------------------------------------

 */

#ifndef MPI_H

#define MPI_H

/*****************************************************************************

*

*        M P I    V e r s i o n    D e f i n i t i o n s

*

*****************************************************************************/

#define MPI_VERSION_MAJOR                   (0x01)

#define MPI_VERSION_MINOR                   (0x02)

#define MPI_VERSION_MAJOR_MASK              (0xFF00)

#define MPI_VERSION_MAJOR_SHIFT             (8)

#define MPI_VERSION_MINOR_MASK              (0x00FF)

#define MPI_VERSION_MINOR_SHIFT             (0)

#define MPI_VERSION ((MPI_VERSION_MAJOR << MPI_VERSION_MAJOR_SHIFT) |   \

                                      MPI_VERSION_MINOR)

#define MPI_VERSION_01_00                   (0x0100)

#define MPI_VERSION_01_01                   (0x0101)

#define MPI_VERSION_01_02                   (0x0102)

/* Note: The major versions of 0xe0 through 0xff are reserved */

/* versioning for this MPI header set */

#define MPI_HEADER_VERSION_UNIT             (0x0C)

#define MPI_HEADER_VERSION_DEV              (0x00)

#define MPI_HEADER_VERSION_UNIT_MASK        (0xFF00)

#define MPI_HEADER_VERSION_UNIT_SHIFT       (8)

#define MPI_HEADER_VERSION_DEV_MASK         (0x00FF)

#define MPI_HEADER_VERSION_DEV_SHIFT        (0)

#define MPI_HEADER_VERSION ((MPI_HEADER_VERSION_UNIT << 8) | MPI_HEADER_VERSION_DEV)

/*****************************************************************************

*

*        I O C    S t a t e    D e f i n i t i o n s

*

*****************************************************************************/

#define MPI_IOC_STATE_RESET                 (0x00000000)

#define MPI_IOC_STATE_READY                 (0x10000000)

#define MPI_IOC_STATE_OPERATIONAL           (0x20000000)

#define MPI_IOC_STATE_FAULT                 (0x40000000)

#define MPI_IOC_STATE_MASK                  (0xF0000000)

#define MPI_IOC_STATE_SHIFT                 (28)

/* Fault state codes (product independent range 0x8000-0xFFFF) */

#define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR  (0x8111)

#define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT     (0x8112)

#define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR    (0x8113)

#define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT       (0x8114)

#define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR        (0x8115)

#define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT           (0x8116)

#define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR     (0x8117)

#define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT        (0x8118)

/*****************************************************************************

*

*        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

*

*****************************************************************************/

/* S y s t e m    D o o r b e l l */

#define MPI_DOORBELL_OFFSET                 (0x00000000)

#define MPI_DOORBELL_ACTIVE                 (0x08000000) /* DoorbellUsed */

#define MPI_DOORBELL_USED                   (MPI_DOORBELL_ACTIVE)

#define MPI_DOORBELL_ACTIVE_SHIFT           (27)

#define MPI_DOORBELL_WHO_INIT_MASK          (0x07000000)

#define MPI_DOORBELL_WHO_INIT_SHIFT         (24)

#define MPI_DOORBELL_FUNCTION_MASK          (0xFF000000)

#define MPI_DOORBELL_FUNCTION_SHIFT         (24)

#define MPI_DOORBELL_ADD_DWORDS_MASK        (0x00FF0000)

#define MPI_DOORBELL_ADD_DWORDS_SHIFT       (16)

#define MPI_DOORBELL_DATA_MASK              (0x0000FFFF)

#define MPI_WRITE_SEQUENCE_OFFSET           (0x00000004)

#define MPI_WRSEQ_KEY_VALUE_MASK            (0x0000000F)

#define MPI_WRSEQ_1ST_KEY_VALUE             (0x04)

#define MPI_WRSEQ_2ND_KEY_VALUE             (0x0B)

#define MPI_WRSEQ_3RD_KEY_VALUE             (0x02)

#define MPI_WRSEQ_4TH_KEY_VALUE             (0x07)

#define MPI_WRSEQ_5TH_KEY_VALUE             (0x0D)

#define MPI_DIAGNOSTIC_OFFSET               (0x00000008)

#define MPI_DIAG_CLEAR_FLASH_BAD_SIG        (0x00000400)

#define MPI_DIAG_PREVENT_IOC_BOOT           (0x00000200)

#define MPI_DIAG_DRWE                       (0x00000080)

#define MPI_DIAG_FLASH_BAD_SIG              (0x00000040)

#define MPI_DIAG_RESET_HISTORY              (0x00000020)

#define MPI_DIAG_RW_ENABLE                  (0x00000010)

#define MPI_DIAG_RESET_ADAPTER              (0x00000004)

#define MPI_DIAG_DISABLE_ARM                (0x00000002)

#define MPI_DIAG_MEM_ENABLE                 (0x00000001)

#define MPI_TEST_BASE_ADDRESS_OFFSET        (0x0000000C)

#define MPI_DIAG_RW_DATA_OFFSET             (0x00000010)

#define MPI_DIAG_RW_ADDRESS_OFFSET          (0x00000014)

#define MPI_HOST_INTERRUPT_STATUS_OFFSET    (0x00000030)

#define MPI_HIS_IOP_DOORBELL_STATUS         (0x80000000)

#define MPI_HIS_REPLY_MESSAGE_INTERRUPT     (0x00000008)

#define MPI_HIS_DOORBELL_INTERRUPT          (0x00000001)

#define MPI_HOST_INTERRUPT_MASK_OFFSET      (0x00000034)

#define MPI_HIM_RIM                         (0x00000008)

#define MPI_HIM_DIM                         (0x00000001)

#define MPI_REQUEST_QUEUE_OFFSET            (0x00000040)

#define MPI_REQUEST_POST_FIFO_OFFSET        (0x00000040)

#define MPI_REPLY_QUEUE_OFFSET              (0x00000044)

#define MPI_REPLY_POST_FIFO_OFFSET          (0x00000044)

#define MPI_REPLY_FREE_FIFO_OFFSET          (0x00000044)

/*****************************************************************************

*

*        M e s s a g e    F r a m e    D e s c r i p t o r s

*

*****************************************************************************/

#define MPI_REQ_MF_DESCRIPTOR_NB_MASK       (0x00000003)

#define MPI_REQ_MF_DESCRIPTOR_F_BIT         (0x00000004)

#define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK  (0xFFFFFFF8)

#define MPI_ADDRESS_REPLY_A_BIT             (0x80000000)

#define MPI_ADDRESS_REPLY_ADDRESS_MASK      (0x7FFFFFFF)

#define MPI_CONTEXT_REPLY_A_BIT             (0x80000000)

#define MPI_CONTEXT_REPLY_TYPE_MASK         (0x60000000)

#define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT    (0x00)

#define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET  (0x01)

#define MPI_CONTEXT_REPLY_TYPE_LAN          (0x02)

#define MPI_CONTEXT_REPLY_TYPE_SHIFT        (29)

#define MPI_CONTEXT_REPLY_CONTEXT_MASK      (0x1FFFFFFF)

/****************************************************************************/

/* Context Reply macros                                                     */

/****************************************************************************/

#define MPI_GET_CONTEXT_REPLY_TYPE(x)  (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) \

                                          >> MPI_CONTEXT_REPLY_TYPE_SHIFT)

#define MPI_SET_CONTEXT_REPLY_TYPE(x, typ)                                  \

            ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) |                   \

                            (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) &      \

                                        MPI_CONTEXT_REPLY_TYPE_MASK))

/*****************************************************************************

*

*        M e s s a g e    F u n c t i o n s

*              0x80 -> 0x8F reserved for private message use per product

*

*

*****************************************************************************/

#define MPI_FUNCTION_SCSI_IO_REQUEST                (0x00)

#define MPI_FUNCTION_SCSI_TASK_MGMT                 (0x01)

#define MPI_FUNCTION_IOC_INIT                       (0x02)

#define MPI_FUNCTION_IOC_FACTS                      (0x03)

#define MPI_FUNCTION_CONFIG                         (0x04)

#define MPI_FUNCTION_PORT_FACTS                     (0x05)

#define MPI_FUNCTION_PORT_ENABLE                    (0x06)

#define MPI_FUNCTION_EVENT_NOTIFICATION             (0x07)

#define MPI_FUNCTION_EVENT_ACK                      (0x08)

#define MPI_FUNCTION_FW_DOWNLOAD                    (0x09)

#define MPI_FUNCTION_TARGET_CMD_BUFFER_POST         (0x0A)

#define MPI_FUNCTION_TARGET_ASSIST                  (0x0B)

#define MPI_FUNCTION_TARGET_STATUS_SEND             (0x0C)

#define MPI_FUNCTION_TARGET_MODE_ABORT              (0x0D)

#define MPI_FUNCTION_TARGET_FC_BUF_POST_LINK_SRVC   (0x0E) /* obsolete name */

#define MPI_FUNCTION_TARGET_FC_RSP_LINK_SRVC        (0x0F) /* obsolete name */

#define MPI_FUNCTION_TARGET_FC_EX_SEND_LINK_SRVC    (0x10) /* obsolete name */

#define MPI_FUNCTION_TARGET_FC_ABORT                (0x11) /* obsolete name */

#define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST          (0x0E)

#define MPI_FUNCTION_FC_LINK_SRVC_RSP               (0x0F)

#define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND           (0x10)

#define MPI_FUNCTION_FC_ABORT                       (0x11)

#define MPI_FUNCTION_FW_UPLOAD                      (0x12)

#define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND       (0x13)

#define MPI_FUNCTION_FC_PRIMITIVE_SEND              (0x14)

#define MPI_FUNCTION_RAID_ACTION                    (0x15)

#define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH       (0x16)

#define MPI_FUNCTION_TOOLBOX                        (0x17)

#define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR       (0x18)

#define MPI_FUNCTION_MAILBOX                        (0x19)

#define MPI_FUNCTION_LAN_SEND                       (0x20)

#define MPI_FUNCTION_LAN_RECEIVE                    (0x21)

#define MPI_FUNCTION_LAN_RESET                      (0x22)

#define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET         (0x40)

#define MPI_FUNCTION_IO_UNIT_RESET                  (0x41)

#define MPI_FUNCTION_HANDSHAKE                      (0x42)

#define MPI_FUNCTION_REPLY_FRAME_REMOVAL            (0x43)

/*****************************************************************************

*

*        S c a t t e r    G a t h e r    E l e m e n t s

*

*****************************************************************************/

/****************************************************************************/

/*  Simple element structures                                               */

/****************************************************************************/

typedef struct _SGE_SIMPLE32

{

    U32                     FlagsLength;

    U32                     Address;

} SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32,

  SGESimple32_t, MPI_POINTER pSGESimple32_t;

typedef struct _SGE_SIMPLE64

{

    U32                     FlagsLength;

    U64                     Address;

} SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64,

  SGESimple64_t, MPI_POINTER pSGESimple64_t;

typedef struct _SGE_SIMPLE_UNION

{

    U32                     FlagsLength;

    union

    {

        U32                 Address32;

        U64                 Address64;

    }u;

} SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t,

  SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION;

/****************************************************************************/

/*  Chain element structures                                                */

/****************************************************************************/

typedef struct _SGE_CHAIN32

{

    U16                     Length;

    U8                      NextChainOffset;

    U8                      Flags;

    U32                     Address;

} SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32,

  SGEChain32_t, MPI_POINTER pSGEChain32_t;

typedef struct _SGE_CHAIN64

{

    U16                     Length;

    U8                      NextChainOffset;

    U8                      Flags;

    U64                     Address;

} SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64,

  SGEChain64_t, MPI_POINTER pSGEChain64_t;

typedef struct _SGE_CHAIN_UNION

{

    U16                     Length;

    U8                      NextChainOffset;

    U8                      Flags;

    union

    {

        U32                 Address32;

        U64                 Address64;

    }u;

} SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION,

  SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t;

/****************************************************************************/

/*  Transaction Context element                                             */

/****************************************************************************/

typedef struct _SGE_TRANSACTION32

{

    U8                      Reserved;

    U8                      ContextSize;

    U8                      DetailsLength;

    U8                      Flags;

    U32                     TransactionContext[1];

    U32                     TransactionDetails[1];

} SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32,

  SGETransaction32_t, MPI_POINTER pSGETransaction32_t;

typedef struct _SGE_TRANSACTION64

{

    U8                      Reserved;

    U8                      ContextSize;

    U8                      DetailsLength;

    U8                      Flags;

    U32                     TransactionContext[2];

    U32                     TransactionDetails[1];

} SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64,

  SGETransaction64_t, MPI_POINTER pSGETransaction64_t;

typedef struct _SGE_TRANSACTION96

{

    U8                      Reserved;

    U8                      ContextSize;

    U8                      DetailsLength;

    U8                      Flags;

    U32                     TransactionContext[3];

    U32                     TransactionDetails[1];

} SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96,

  SGETransaction96_t, MPI_POINTER pSGETransaction96_t;

typedef struct _SGE_TRANSACTION128

{

    U8                      Reserved;

    U8                      ContextSize;

    U8                      DetailsLength;

    U8                      Flags;

    U32                     TransactionContext[4];

    U32                     TransactionDetails[1];

} SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128,

  SGETransaction_t128, MPI_POINTER pSGETransaction_t128;

typedef struct _SGE_TRANSACTION_UNION

{

    U8                      Reserved;

    U8                      ContextSize;

    U8                      DetailsLength;

    U8                      Flags;

    union

    {

        U32                 TransactionContext32[1];

        U32                 TransactionContext64[2];

        U32                 TransactionContext96[3];

        U32                 TransactionContext128[4];

    }u;

    U32                     TransactionDetails[1];

} SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION,

  SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t;

/****************************************************************************/

/*  SGE IO types union  for IO SGL's                                        */

/****************************************************************************/

typedef struct _SGE_IO_UNION

{

    union

    {

        SGE_SIMPLE_UNION    Simple;

        SGE_CHAIN_UNION     Chain;

    } u;

} SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION,

  SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t;

/****************************************************************************/

/*  SGE union for SGL's with Simple and Transaction elements                */

/****************************************************************************/

typedef struct _SGE_TRANS_SIMPLE_UNION

{

    union

    {

        SGE_SIMPLE_UNION        Simple;

        SGE_TRANSACTION_UNION   Transaction;

    } u;

} SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION,

  SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t;

/****************************************************************************/

/*  All SGE types union                                                     */

/****************************************************************************/

typedef struct _SGE_MPI_UNION

{

    union

    {

        SGE_SIMPLE_UNION        Simple;

        SGE_CHAIN_UNION         Chain;

        SGE_TRANSACTION_UNION   Transaction;

    } u;

} SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION,

  MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t,

  SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t;

/****************************************************************************/

/*  SGE field definition and masks                                          */

/****************************************************************************/

/* Flags field bit definitions */

#define MPI_SGE_FLAGS_LAST_ELEMENT              (0x80)

#define MPI_SGE_FLAGS_END_OF_BUFFER             (0x40)

#define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK         (0x30)

#define MPI_SGE_FLAGS_LOCAL_ADDRESS             (0x08)

#define MPI_SGE_FLAGS_DIRECTION                 (0x04)

#define MPI_SGE_FLAGS_ADDRESS_SIZE              (0x02)

#define MPI_SGE_FLAGS_END_OF_LIST               (0x01)

#define MPI_SGE_FLAGS_SHIFT                     (24)

#define MPI_SGE_LENGTH_MASK                     (0x00FFFFFF)

#define MPI_SGE_CHAIN_LENGTH_MASK               (0x0000FFFF)

/* Element Type */

#define MPI_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00)

#define MPI_SGE_FLAGS_SIMPLE_ELEMENT            (0x10)

#define MPI_SGE_FLAGS_CHAIN_ELEMENT             (0x30)

#define MPI_SGE_FLAGS_ELEMENT_MASK              (0x30)

/* Address location */

#define MPI_SGE_FLAGS_SYSTEM_ADDRESS            (0x00)

/* Direction */

#define MPI_SGE_FLAGS_IOC_TO_HOST               (0x00)

#define MPI_SGE_FLAGS_HOST_TO_IOC               (0x04)

/* Address Size */

#define MPI_SGE_FLAGS_32_BIT_ADDRESSING         (0x00)

#define MPI_SGE_FLAGS_64_BIT_ADDRESSING         (0x02)

/* Context Size */

#define MPI_SGE_FLAGS_32_BIT_CONTEXT            (0x00)

#define MPI_SGE_FLAGS_64_BIT_CONTEXT            (0x02)

#define MPI_SGE_FLAGS_96_BIT_CONTEXT            (0x04)

#define MPI_SGE_FLAGS_128_BIT_CONTEXT           (0x06)

#define MPI_SGE_CHAIN_OFFSET_MASK               (0x00FF0000)

#define MPI_SGE_CHAIN_OFFSET_SHIFT              (16)

/****************************************************************************/

/*  SGE operation Macros                                                    */

/****************************************************************************/

         /* SIMPLE FlagsLength manipulations... */

#define  MPI_SGE_SET_FLAGS(f)           ((U32)(f) << MPI_SGE_FLAGS_SHIFT)

#define  MPI_SGE_GET_FLAGS(fl)          (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT)

#define  MPI_SGE_LENGTH(fl)             ((fl) & MPI_SGE_LENGTH_MASK)

#define  MPI_SGE_CHAIN_LENGTH(fl)       ((fl) & MPI_SGE_CHAIN_LENGTH_MASK)

#define  MPI_SGE_SET_FLAGS_LENGTH(f,l)  (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l))

#define  MPI_pSGE_GET_FLAGS(psg)        MPI_SGE_GET_FLAGS((psg)->FlagsLength)

#define  MPI_pSGE_GET_LENGTH(psg)       MPI_SGE_LENGTH((psg)->FlagsLength)

#define  MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l)  (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l)

         /* CAUTION - The following are READ-MODIFY-WRITE! */

#define  MPI_pSGE_SET_FLAGS(psg,f)      (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f)

#define  MPI_pSGE_SET_LENGTH(psg,l)     (psg)->FlagsLength |= MPI_SGE_LENGTH(l)

#define  MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT)

/*****************************************************************************

*

*        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

*

*****************************************************************************/

/****************************************************************************/

/* Standard message request header for all request messages                 */

/****************************************************************************/

typedef struct _MSG_REQUEST_HEADER

{

    U8                      Reserved[2];      /* function specific */

    U8                      ChainOffset;

    U8                      Function;

    U8                      Reserved1[3];     /* function specific */

    U8                      MsgFlags;

    U32                     MsgContext;

} MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER,

  MPIHeader_t, MPI_POINTER pMPIHeader_t;

/****************************************************************************/

/*  Default Reply                                                           */

/****************************************************************************/

typedef struct _MSG_DEFAULT_REPLY

{

    U8                      Reserved[2];      /* function specific */

    U8                      MsgLength;

    U8                      Function;

    U8                      Reserved1[3];     /* function specific */

    U8                      MsgFlags;

    U32                     MsgContext;

    U8                      Reserved2[2];     /* function specific */

    U16                     IOCStatus;

    U32                     IOCLogInfo;

} MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY,

  MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t;

/* MsgFlags definition for all replies */

#define MPI_MSGFLAGS_CONTINUATION_REPLY         (0x80)

/*****************************************************************************

*

*               I O C    S t a t u s   V a l u e s

*

*****************************************************************************/

/****************************************************************************/

/*  Common IOCStatus values for all replies                                 */

/****************************************************************************/

#define MPI_IOCSTATUS_SUCCESS                  (0x0000)

#define MPI_IOCSTATUS_INVALID_FUNCTION         (0x0001)

#define MPI_IOCSTATUS_BUSY                     (0x0002)

#define MPI_IOCSTATUS_INVALID_SGL              (0x0003)

#define MPI_IOCSTATUS_INTERNAL_ERROR           (0x0004)

#define MPI_IOCSTATUS_RESERVED                 (0x0005)

#define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES   (0x0006)

#define MPI_IOCSTATUS_INVALID_FIELD            (0x0007)

#define MPI_IOCSTATUS_INVALID_STATE            (0x0008)

/****************************************************************************/

/*  Config IOCStatus values                                                 */

/****************************************************************************/

#define MPI_IOCSTATUS_CONFIG_INVALID_ACTION    (0x0020)

#define MPI_IOCSTATUS_CONFIG_INVALID_TYPE      (0x0021)

#define MPI_IOCSTATUS_CONFIG_INVALID_PAGE      (0x0022)

#define MPI_IOCSTATUS_CONFIG_INVALID_DATA      (0x0023)

#define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS       (0x0024)

#define MPI_IOCSTATUS_CONFIG_CANT_COMMIT       (0x0025)

/****************************************************************************/

/*  SCSIIO Reply (SPI & FCP) initiator values                               */

/****************************************************************************/

#define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR     (0x0040)

#define MPI_IOCSTATUS_SCSI_INVALID_BUS         (0x0041)

#define MPI_IOCSTATUS_SCSI_INVALID_TARGETID    (0x0042)

#define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE    (0x0043)

#define MPI_IOCSTATUS_SCSI_DATA_OVERRUN        (0x0044)

#define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN       (0x0045)

#define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR       (0x0046)

#define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR      (0x0047)

#define MPI_IOCSTATUS_SCSI_TASK_TERMINATED     (0x0048)

#define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH   (0x0049)

#define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED    (0x004A)

#define MPI_IOCSTATUS_SCSI_IOC_TERMINATED      (0x004B)

#define MPI_IOCSTATUS_SCSI_EXT_TERMINATED      (0x004C)

/****************************************************************************/

/*  SCSI (SPI & FCP) target values                                          */

/****************************************************************************/

#define MPI_IOCSTATUS_TARGET_PRIORITY_IO         (0x0060)

#define MPI_IOCSTATUS_TARGET_INVALID_PORT        (0x0061)

#define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX    (0x0062)   /* obsolete */

#define MPI_IOCSTATUS_TARGET_INVALID_IO_INDEX    (0x0062)

#define MPI_IOCSTATUS_TARGET_ABORTED             (0x0063)

#define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE   (0x0064)

#define MPI_IOCSTATUS_TARGET_NO_CONNECTION       (0x0065)

#define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A)

#define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT   (0x006B)

/****************************************************************************/

/*  Additional FCP target values                                            */

/****************************************************************************/

#define MPI_IOCSTATUS_TARGET_FC_ABORTED         (0x0066)    /* obsolete */

#define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID   (0x0067)    /* obsolete */

#define MPI_IOCSTATUS_TARGET_FC_DID_INVALID     (0x0068)    /* obsolete */

#define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069)    /* obsolete */

/****************************************************************************/

/*  Fibre Channel Direct Access values                                      */

/****************************************************************************/

#define MPI_IOCSTATUS_FC_ABORTED                (0x0066)

#define MPI_IOCSTATUS_FC_RX_ID_INVALID          (0x0067)

#define MPI_IOCSTATUS_FC_DID_INVALID            (0x0068)

#define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT        (0x0069)

#define MPI_IOCSTATUS_FC_EXCHANGE_CANCELED      (0x006C)

/****************************************************************************/

/*  LAN values                                                              */

/****************************************************************************/

#define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND      (0x0080)

#define MPI_IOCSTATUS_LAN_DEVICE_FAILURE        (0x0081)

#define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR        (0x0082)

#define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED      (0x0083)

#define MPI_IOCSTATUS_LAN_RECEIVE_ERROR         (0x0084)

#define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED       (0x0085)

#define MPI_IOCSTATUS_LAN_PARTIAL_PACKET        (0x0086)

#define MPI_IOCSTATUS_LAN_CANCELED              (0x0087)

/****************************************************************************/

/*  IOCStatus flag to indicate that log info is available                   */

/****************************************************************************/

#define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE   (0x8000)

#define MPI_IOCSTATUS_MASK                      (0x7FFF)

/****************************************************************************/

/*  LogInfo Types                                                           */

/****************************************************************************/

#define MPI_IOCLOGINFO_TYPE_MASK                (0xF0000000)

#define MPI_IOCLOGINFO_TYPE_NONE                (0x0)

#define MPI_IOCLOGINFO_TYPE_SCSI                (0x1)

#define MPI_IOCLOGINFO_TYPE_FC                  (0x2)

#define MPI_IOCLOGINFO_LOG_DATA_MASK            (0x0FFFFFFF)

#endif