/* *  Copyright (c) 2000-2001 LSI Logic Corporation. * * *           Name:  MPI.H *          Title:  MPI Message independent structures and definitions *  Creation Date:  July 27, 2000 * *    MPI Version:  01.01.07 * *  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. *  -------------------------------------------------------------------------- */#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                   (0x01)#define MPI_VERSION            ((MPI_VERSION_MAJOR << 8) | MPI_VERSION_MINOR)/* Note: The major versions of 0xe0 through 0xff are reserved *//*******************************************************************************        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_VOLUME                    (0x15)#define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH       (0x16)#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];