/* *  Copyright (c) 2000-2007 LSI Corporation. * * *           Name:  mpi.h *          Title:  MPI Message independent structures and definitions *  Creation Date:  July 27, 2000 * *    mpi.h Version:  01.05.13 * *  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. *  01-16-04  01.02.11  Added define for MPI_IOCLOGINFO_TYPE_SHIFT. *  04-29-04  01.02.12  Added function codes for MPI_FUNCTION_DIAG_BUFFER_POST *                      and MPI_FUNCTION_DIAG_RELEASE. *                      Added MPI_IOCSTATUS_DIAGNOSTIC_RELEASED define. *                      Bumped MPI_HEADER_VERSION_UNIT value. *  05-11-04  01.03.01  Bumped MPI_VERSION_MINOR for MPI v1.3. *                      Added codes for Inband. *  08-19-04  01.05.01  Added defines for Host Buffer Access Control doorbell. *                      Added define for offset of High Priority Request Queue. *                      Added new function codes and new IOCStatus codes. *                      Added a IOCLogInfo type of SAS. *  12-07-04  01.05.02  Bumped MPI_HEADER_VERSION_UNIT. *  12-09-04  01.05.03  Bumped MPI_HEADER_VERSION_UNIT. *  01-15-05  01.05.04  Bumped MPI_HEADER_VERSION_UNIT. *  02-09-05  01.05.05  Bumped MPI_HEADER_VERSION_UNIT. *  02-22-05  01.05.06  Bumped MPI_HEADER_VERSION_UNIT. *  03-11-05  01.05.07  Removed function codes for SCSI IO 32 and *                      TargetAssistExtended requests. *                      Removed EEDP IOCStatus codes. *  06-24-05  01.05.08  Added function codes for SCSI IO 32 and *                      TargetAssistExtended requests. *                      Added EEDP IOCStatus codes. *  08-03-05  01.05.09  Bumped MPI_HEADER_VERSION_UNIT. *  08-30-05  01.05.10  Added 2 new IOCStatus codes for Target. *  03-27-06  01.05.11  Bumped MPI_HEADER_VERSION_UNIT. *  10-11-06  01.05.12  Bumped MPI_HEADER_VERSION_UNIT. *  05-24-07  01.05.13  Bumped MPI_HEADER_VERSION_UNIT. *  -------------------------------------------------------------------------- */#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                   (0x05)#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)#define MPI_VERSION_01_03                   (0x0103)#define MPI_VERSION_01_05                   (0x0105)/* Note: The major versions of 0xe0 through 0xff are reserved *//* versioning for this MPI header set */#define MPI_HEADER_VERSION_UNIT             (0x10)#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******************************************************************************//* * Defines for working with the System Doorbell register. * Values for doorbell function codes are included in the section that defines * all the function codes (further on in this file). */#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_DOORBELL_FUNCTION_SPECIFIC_MASK (0x0000FFFF)/* values for Host Buffer Access Control doorbell function */#define MPI_DB_HPBAC_VALUE_MASK             (0x0000F000)#define MPI_DB_HPBAC_ENABLE_ACCESS          (0x01)#define MPI_DB_HPBAC_DISABLE_ACCESS         (0x02)#define MPI_DB_HPBAC_FREE_BUFFER            (0x03)#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)#define MPI_HI_PRI_REQUEST_QUEUE_OFFSET     (0x00000048)/*******************************************************************************        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)