mpi.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:27k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  *  Copyright (c) 2000-2001 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 Version:  01.02.03
  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.  *  --------------------------------------------------------------------------
  48.  */
  49. #ifndef MPI_H
  50. #define MPI_H
  51. /*****************************************************************************
  52. *
  53. *        M P I    V e r s i o n    D e f i n i t i o n s
  54. *
  55. *****************************************************************************/
  56. #define MPI_VERSION_MAJOR                   (0x01)
  57. #define MPI_VERSION_MINOR                   (0x02)
  58. #define MPI_VERSION            ((MPI_VERSION_MAJOR << 8) | MPI_VERSION_MINOR)
  59. /* Note: The major versions of 0xe0 through 0xff are reserved */
  60. /*****************************************************************************
  61. *
  62. *        I O C    S t a t e    D e f i n i t i o n s
  63. *
  64. *****************************************************************************/
  65. #define MPI_IOC_STATE_RESET                 (0x00000000)
  66. #define MPI_IOC_STATE_READY                 (0x10000000)
  67. #define MPI_IOC_STATE_OPERATIONAL           (0x20000000)
  68. #define MPI_IOC_STATE_FAULT                 (0x40000000)
  69. #define MPI_IOC_STATE_MASK                  (0xF0000000)
  70. #define MPI_IOC_STATE_SHIFT                 (28)
  71. /* Fault state codes (product independent range 0x8000-0xFFFF) */
  72. #define MPI_FAULT_REQUEST_MESSAGE_PCI_PARITY_ERROR  (0x8111)
  73. #define MPI_FAULT_REQUEST_MESSAGE_PCI_BUS_FAULT     (0x8112)
  74. #define MPI_FAULT_REPLY_MESSAGE_PCI_PARITY_ERROR    (0x8113)
  75. #define MPI_FAULT_REPLY_MESSAGE_PCI_BUS_FAULT       (0x8114)
  76. #define MPI_FAULT_DATA_SEND_PCI_PARITY_ERROR        (0x8115)
  77. #define MPI_FAULT_DATA_SEND_PCI_BUS_FAULT           (0x8116)
  78. #define MPI_FAULT_DATA_RECEIVE_PCI_PARITY_ERROR     (0x8117)
  79. #define MPI_FAULT_DATA_RECEIVE_PCI_BUS_FAULT        (0x8118)
  80. /*****************************************************************************
  81. *
  82. *        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
  83. *
  84. *****************************************************************************/
  85. /* S y s t e m    D o o r b e l l */
  86. #define MPI_DOORBELL_OFFSET                 (0x00000000)
  87. #define MPI_DOORBELL_ACTIVE                 (0x08000000) /* DoorbellUsed */
  88. #define MPI_DOORBELL_USED                   (MPI_DOORBELL_ACTIVE)
  89. #define MPI_DOORBELL_ACTIVE_SHIFT           (27)
  90. #define MPI_DOORBELL_WHO_INIT_MASK          (0x07000000)
  91. #define MPI_DOORBELL_WHO_INIT_SHIFT         (24)
  92. #define MPI_DOORBELL_FUNCTION_MASK          (0xFF000000)
  93. #define MPI_DOORBELL_FUNCTION_SHIFT         (24)
  94. #define MPI_DOORBELL_ADD_DWORDS_MASK        (0x00FF0000)
  95. #define MPI_DOORBELL_ADD_DWORDS_SHIFT       (16)
  96. #define MPI_DOORBELL_DATA_MASK              (0x0000FFFF)
  97. #define MPI_WRITE_SEQUENCE_OFFSET           (0x00000004)
  98. #define MPI_WRSEQ_KEY_VALUE_MASK            (0x0000000F)
  99. #define MPI_WRSEQ_1ST_KEY_VALUE             (0x04)
  100. #define MPI_WRSEQ_2ND_KEY_VALUE             (0x0B)
  101. #define MPI_WRSEQ_3RD_KEY_VALUE             (0x02)
  102. #define MPI_WRSEQ_4TH_KEY_VALUE             (0x07)
  103. #define MPI_WRSEQ_5TH_KEY_VALUE             (0x0D)
  104. #define MPI_DIAGNOSTIC_OFFSET               (0x00000008)
  105. #define MPI_DIAG_CLEAR_FLASH_BAD_SIG        (0x00000400)
  106. #define MPI_DIAG_PREVENT_IOC_BOOT           (0x00000200)
  107. #define MPI_DIAG_DRWE                       (0x00000080)
  108. #define MPI_DIAG_FLASH_BAD_SIG              (0x00000040)
  109. #define MPI_DIAG_RESET_HISTORY              (0x00000020)
  110. #define MPI_DIAG_RW_ENABLE                  (0x00000010)
  111. #define MPI_DIAG_RESET_ADAPTER              (0x00000004)
  112. #define MPI_DIAG_DISABLE_ARM                (0x00000002)
  113. #define MPI_DIAG_MEM_ENABLE                 (0x00000001)
  114. #define MPI_TEST_BASE_ADDRESS_OFFSET        (0x0000000C)
  115. #define MPI_DIAG_RW_DATA_OFFSET             (0x00000010)
  116. #define MPI_DIAG_RW_ADDRESS_OFFSET          (0x00000014)
  117. #define MPI_HOST_INTERRUPT_STATUS_OFFSET    (0x00000030)
  118. #define MPI_HIS_IOP_DOORBELL_STATUS         (0x80000000)
  119. #define MPI_HIS_REPLY_MESSAGE_INTERRUPT     (0x00000008)
  120. #define MPI_HIS_DOORBELL_INTERRUPT          (0x00000001)
  121. #define MPI_HOST_INTERRUPT_MASK_OFFSET      (0x00000034)
  122. #define MPI_HIM_RIM                         (0x00000008)
  123. #define MPI_HIM_DIM                         (0x00000001)
  124. #define MPI_REQUEST_QUEUE_OFFSET            (0x00000040)
  125. #define MPI_REQUEST_POST_FIFO_OFFSET        (0x00000040)
  126. #define MPI_REPLY_QUEUE_OFFSET              (0x00000044)
  127. #define MPI_REPLY_POST_FIFO_OFFSET          (0x00000044)
  128. #define MPI_REPLY_FREE_FIFO_OFFSET          (0x00000044)
  129. /*****************************************************************************
  130. *
  131. *        M e s s a g e    F r a m e    D e s c r i p t o r s
  132. *
  133. *****************************************************************************/
  134. #define MPI_REQ_MF_DESCRIPTOR_NB_MASK       (0x00000003)
  135. #define MPI_REQ_MF_DESCRIPTOR_F_BIT         (0x00000004)
  136. #define MPI_REQ_MF_DESCRIPTOR_ADDRESS_MASK  (0xFFFFFFF8)
  137. #define MPI_ADDRESS_REPLY_A_BIT             (0x80000000)
  138. #define MPI_ADDRESS_REPLY_ADDRESS_MASK      (0x7FFFFFFF)
  139. #define MPI_CONTEXT_REPLY_A_BIT             (0x80000000)
  140. #define MPI_CONTEXT_REPLY_TYPE_MASK         (0x60000000)
  141. #define MPI_CONTEXT_REPLY_TYPE_SCSI_INIT    (0x00)
  142. #define MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET  (0x01)
  143. #define MPI_CONTEXT_REPLY_TYPE_LAN          (0x02)
  144. #define MPI_CONTEXT_REPLY_TYPE_SHIFT        (29)
  145. #define MPI_CONTEXT_REPLY_CONTEXT_MASK      (0x1FFFFFFF)
  146. /****************************************************************************/
  147. /* Context Reply macros                                                     */
  148. /****************************************************************************/
  149. #define MPI_GET_CONTEXT_REPLY_TYPE(x)  (((x) & MPI_CONTEXT_REPLY_TYPE_MASK) 
  150.                                           >> MPI_CONTEXT_REPLY_TYPE_SHIFT)
  151. #define MPI_SET_CONTEXT_REPLY_TYPE(x, typ)                                  
  152.             ((x) = ((x) & ~MPI_CONTEXT_REPLY_TYPE_MASK) |                   
  153.                             (((typ) << MPI_CONTEXT_REPLY_TYPE_SHIFT) &      
  154.                                         MPI_CONTEXT_REPLY_TYPE_MASK))
  155. /*****************************************************************************
  156. *
  157. *        M e s s a g e    F u n c t i o n s
  158. *              0x80 -> 0x8F reserved for private message use per product
  159. *
  160. *
  161. *****************************************************************************/
  162. #define MPI_FUNCTION_SCSI_IO_REQUEST                (0x00)
  163. #define MPI_FUNCTION_SCSI_TASK_MGMT                 (0x01)
  164. #define MPI_FUNCTION_IOC_INIT                       (0x02)
  165. #define MPI_FUNCTION_IOC_FACTS                      (0x03)
  166. #define MPI_FUNCTION_CONFIG                         (0x04)
  167. #define MPI_FUNCTION_PORT_FACTS                     (0x05)
  168. #define MPI_FUNCTION_PORT_ENABLE                    (0x06)
  169. #define MPI_FUNCTION_EVENT_NOTIFICATION             (0x07)
  170. #define MPI_FUNCTION_EVENT_ACK                      (0x08)
  171. #define MPI_FUNCTION_FW_DOWNLOAD                    (0x09)
  172. #define MPI_FUNCTION_TARGET_CMD_BUFFER_POST         (0x0A)
  173. #define MPI_FUNCTION_TARGET_ASSIST                  (0x0B)
  174. #define MPI_FUNCTION_TARGET_STATUS_SEND             (0x0C)
  175. #define MPI_FUNCTION_TARGET_MODE_ABORT              (0x0D)
  176. #define MPI_FUNCTION_TARGET_FC_BUF_POST_LINK_SRVC   (0x0E) /* obsolete name */
  177. #define MPI_FUNCTION_TARGET_FC_RSP_LINK_SRVC        (0x0F) /* obsolete name */
  178. #define MPI_FUNCTION_TARGET_FC_EX_SEND_LINK_SRVC    (0x10) /* obsolete name */
  179. #define MPI_FUNCTION_TARGET_FC_ABORT                (0x11) /* obsolete name */
  180. #define MPI_FUNCTION_FC_LINK_SRVC_BUF_POST          (0x0E)
  181. #define MPI_FUNCTION_FC_LINK_SRVC_RSP               (0x0F)
  182. #define MPI_FUNCTION_FC_EX_LINK_SRVC_SEND           (0x10)
  183. #define MPI_FUNCTION_FC_ABORT                       (0x11)
  184. #define MPI_FUNCTION_FW_UPLOAD                      (0x12)
  185. #define MPI_FUNCTION_FC_COMMON_TRANSPORT_SEND       (0x13)
  186. #define MPI_FUNCTION_FC_PRIMITIVE_SEND              (0x14)
  187. #define MPI_FUNCTION_RAID_ACTION                    (0x15)
  188. #define MPI_FUNCTION_RAID_SCSI_IO_PASSTHROUGH       (0x16)
  189. #define MPI_FUNCTION_TOOLBOX                        (0x17)
  190. #define MPI_FUNCTION_SCSI_ENCLOSURE_PROCESSOR       (0x18)
  191. #define MPI_FUNCTION_LAN_SEND                       (0x20)
  192. #define MPI_FUNCTION_LAN_RECEIVE                    (0x21)
  193. #define MPI_FUNCTION_LAN_RESET                      (0x22)
  194. #define MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET         (0x40)
  195. #define MPI_FUNCTION_IO_UNIT_RESET                  (0x41)
  196. #define MPI_FUNCTION_HANDSHAKE                      (0x42)
  197. #define MPI_FUNCTION_REPLY_FRAME_REMOVAL            (0x43)
  198. /*****************************************************************************
  199. *
  200. *        S c a t t e r    G a t h e r    E l e m e n t s
  201. *
  202. *****************************************************************************/
  203. /****************************************************************************/
  204. /*  Simple element structures                                               */
  205. /****************************************************************************/
  206. typedef struct _SGE_SIMPLE32
  207. {
  208.     U32                     FlagsLength;
  209.     U32                     Address;
  210. } SGE_SIMPLE32, MPI_POINTER PTR_SGE_SIMPLE32,
  211.   SGESimple32_t, MPI_POINTER pSGESimple32_t;
  212. typedef struct _SGE_SIMPLE64
  213. {
  214.     U32                     FlagsLength;
  215.     U64                     Address;
  216. } SGE_SIMPLE64, MPI_POINTER PTR_SGE_SIMPLE64,
  217.   SGESimple64_t, MPI_POINTER pSGESimple64_t;
  218. typedef struct _SGE_SIMPLE_UNION
  219. {
  220.     U32                     FlagsLength;
  221.     union
  222.     {
  223.         U32                 Address32;
  224.         U64                 Address64;
  225.     }u;
  226. } SGESimpleUnion_t, MPI_POINTER pSGESimpleUnion_t,
  227.   SGE_SIMPLE_UNION, MPI_POINTER PTR_SGE_SIMPLE_UNION;
  228. /****************************************************************************/
  229. /*  Chain element structures                                                */
  230. /****************************************************************************/
  231. typedef struct _SGE_CHAIN32
  232. {
  233.     U16                     Length;
  234.     U8                      NextChainOffset;
  235.     U8                      Flags;
  236.     U32                     Address;
  237. } SGE_CHAIN32, MPI_POINTER PTR_SGE_CHAIN32,
  238.   SGEChain32_t, MPI_POINTER pSGEChain32_t;
  239. typedef struct _SGE_CHAIN64
  240. {
  241.     U16                     Length;
  242.     U8                      NextChainOffset;
  243.     U8                      Flags;
  244.     U64                     Address;
  245. } SGE_CHAIN64, MPI_POINTER PTR_SGE_CHAIN64,
  246.   SGEChain64_t, MPI_POINTER pSGEChain64_t;
  247. typedef struct _SGE_CHAIN_UNION
  248. {
  249.     U16                     Length;
  250.     U8                      NextChainOffset;
  251.     U8                      Flags;
  252.     union
  253.     {
  254.         U32                 Address32;
  255.         U64                 Address64;
  256.     }u;
  257. } SGE_CHAIN_UNION, MPI_POINTER PTR_SGE_CHAIN_UNION,
  258.   SGEChainUnion_t, MPI_POINTER pSGEChainUnion_t;
  259. /****************************************************************************/
  260. /*  Transaction Context element                                             */
  261. /****************************************************************************/
  262. typedef struct _SGE_TRANSACTION32
  263. {
  264.     U8                      Reserved;
  265.     U8                      ContextSize;
  266.     U8                      DetailsLength;
  267.     U8                      Flags;
  268.     U32                     TransactionContext[1];
  269.     U32                     TransactionDetails[1];
  270. } SGE_TRANSACTION32, MPI_POINTER PTR_SGE_TRANSACTION32,
  271.   SGETransaction32_t, MPI_POINTER pSGETransaction32_t;
  272. typedef struct _SGE_TRANSACTION64
  273. {
  274.     U8                      Reserved;
  275.     U8                      ContextSize;
  276.     U8                      DetailsLength;
  277.     U8                      Flags;
  278.     U32                     TransactionContext[2];
  279.     U32                     TransactionDetails[1];
  280. } SGE_TRANSACTION64, MPI_POINTER PTR_SGE_TRANSACTION64,
  281.   SGETransaction64_t, MPI_POINTER pSGETransaction64_t;
  282. typedef struct _SGE_TRANSACTION96
  283. {
  284.     U8                      Reserved;
  285.     U8                      ContextSize;
  286.     U8                      DetailsLength;
  287.     U8                      Flags;
  288.     U32                     TransactionContext[3];
  289.     U32                     TransactionDetails[1];
  290. } SGE_TRANSACTION96, MPI_POINTER PTR_SGE_TRANSACTION96,
  291.   SGETransaction96_t, MPI_POINTER pSGETransaction96_t;
  292. typedef struct _SGE_TRANSACTION128
  293. {
  294.     U8                      Reserved;
  295.     U8                      ContextSize;
  296.     U8                      DetailsLength;
  297.     U8                      Flags;
  298.     U32                     TransactionContext[4];
  299.     U32                     TransactionDetails[1];
  300. } SGE_TRANSACTION128, MPI_POINTER PTR_SGE_TRANSACTION128,
  301.   SGETransaction_t128, MPI_POINTER pSGETransaction_t128;
  302. typedef struct _SGE_TRANSACTION_UNION
  303. {
  304.     U8                      Reserved;
  305.     U8                      ContextSize;
  306.     U8                      DetailsLength;
  307.     U8                      Flags;
  308.     union
  309.     {
  310.         U32                 TransactionContext32[1];
  311.         U32                 TransactionContext64[2];
  312.         U32                 TransactionContext96[3];
  313.         U32                 TransactionContext128[4];
  314.     }u;
  315.     U32                     TransactionDetails[1];
  316. } SGE_TRANSACTION_UNION, MPI_POINTER PTR_SGE_TRANSACTION_UNION,
  317.   SGETransactionUnion_t, MPI_POINTER pSGETransactionUnion_t;
  318. /****************************************************************************/
  319. /*  SGE IO types union  for IO SGL's                                        */
  320. /****************************************************************************/
  321. typedef struct _SGE_IO_UNION
  322. {
  323.     union
  324.     {
  325.         SGE_SIMPLE_UNION    Simple;
  326.         SGE_CHAIN_UNION     Chain;
  327.     } u;
  328. } SGE_IO_UNION, MPI_POINTER PTR_SGE_IO_UNION,
  329.   SGEIOUnion_t, MPI_POINTER pSGEIOUnion_t;
  330. /****************************************************************************/
  331. /*  SGE union for SGL's with Simple and Transaction elements                */
  332. /****************************************************************************/
  333. typedef struct _SGE_TRANS_SIMPLE_UNION
  334. {
  335.     union
  336.     {
  337.         SGE_SIMPLE_UNION        Simple;
  338.         SGE_TRANSACTION_UNION   Transaction;
  339.     } u;
  340. } SGE_TRANS_SIMPLE_UNION, MPI_POINTER PTR_SGE_TRANS_SIMPLE_UNION,
  341.   SGETransSimpleUnion_t, MPI_POINTER pSGETransSimpleUnion_t;
  342. /****************************************************************************/
  343. /*  All SGE types union                                                     */
  344. /****************************************************************************/
  345. typedef struct _SGE_MPI_UNION
  346. {
  347.     union
  348.     {
  349.         SGE_SIMPLE_UNION        Simple;
  350.         SGE_CHAIN_UNION         Chain;
  351.         SGE_TRANSACTION_UNION   Transaction;
  352.     } u;
  353. } SGE_MPI_UNION, MPI_POINTER PTR_SGE_MPI_UNION,
  354.   MPI_SGE_UNION_t, MPI_POINTER pMPI_SGE_UNION_t,
  355.   SGEAllUnion_t, MPI_POINTER pSGEAllUnion_t;
  356. /****************************************************************************/
  357. /*  SGE field definition and masks                                          */
  358. /****************************************************************************/
  359. /* Flags field bit definitions */
  360. #define MPI_SGE_FLAGS_LAST_ELEMENT              (0x80)
  361. #define MPI_SGE_FLAGS_END_OF_BUFFER             (0x40)
  362. #define MPI_SGE_FLAGS_ELEMENT_TYPE_MASK         (0x30)
  363. #define MPI_SGE_FLAGS_LOCAL_ADDRESS             (0x08)
  364. #define MPI_SGE_FLAGS_DIRECTION                 (0x04)
  365. #define MPI_SGE_FLAGS_ADDRESS_SIZE              (0x02)
  366. #define MPI_SGE_FLAGS_END_OF_LIST               (0x01)
  367. #define MPI_SGE_FLAGS_SHIFT                     (24)
  368. #define MPI_SGE_LENGTH_MASK                     (0x00FFFFFF)
  369. #define MPI_SGE_CHAIN_LENGTH_MASK               (0x0000FFFF)
  370. /* Element Type */
  371. #define MPI_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00)
  372. #define MPI_SGE_FLAGS_SIMPLE_ELEMENT            (0x10)
  373. #define MPI_SGE_FLAGS_CHAIN_ELEMENT             (0x30)
  374. #define MPI_SGE_FLAGS_ELEMENT_MASK              (0x30)
  375. /* Address location */
  376. #define MPI_SGE_FLAGS_SYSTEM_ADDRESS            (0x00)
  377. /* Direction */
  378. #define MPI_SGE_FLAGS_IOC_TO_HOST               (0x00)
  379. #define MPI_SGE_FLAGS_HOST_TO_IOC               (0x04)
  380. /* Address Size */
  381. #define MPI_SGE_FLAGS_32_BIT_ADDRESSING         (0x00)
  382. #define MPI_SGE_FLAGS_64_BIT_ADDRESSING         (0x02)
  383. /* Context Size */
  384. #define MPI_SGE_FLAGS_32_BIT_CONTEXT            (0x00)
  385. #define MPI_SGE_FLAGS_64_BIT_CONTEXT            (0x02)
  386. #define MPI_SGE_FLAGS_96_BIT_CONTEXT            (0x04)
  387. #define MPI_SGE_FLAGS_128_BIT_CONTEXT           (0x06)
  388. #define MPI_SGE_CHAIN_OFFSET_MASK               (0x00FF0000)
  389. #define MPI_SGE_CHAIN_OFFSET_SHIFT              (16)
  390. /****************************************************************************/
  391. /*  SGE operation Macros                                                    */
  392. /****************************************************************************/
  393.          /* SIMPLE FlagsLength manipulations... */
  394. #define  MPI_SGE_SET_FLAGS(f)           ((U32)(f) << MPI_SGE_FLAGS_SHIFT)
  395. #define  MPI_SGE_GET_FLAGS(fl)          (((fl) & ~MPI_SGE_LENGTH_MASK) >> MPI_SGE_FLAGS_SHIFT)
  396. #define  MPI_SGE_LENGTH(fl)             ((fl) & MPI_SGE_LENGTH_MASK)
  397. #define  MPI_SGE_CHAIN_LENGTH(fl)       ((fl) & MPI_SGE_CHAIN_LENGTH_MASK)
  398. #define  MPI_SGE_SET_FLAGS_LENGTH(f,l)  (MPI_SGE_SET_FLAGS(f) | MPI_SGE_LENGTH(l))
  399. #define  MPI_pSGE_GET_FLAGS(psg)        MPI_SGE_GET_FLAGS((psg)->FlagsLength)
  400. #define  MPI_pSGE_GET_LENGTH(psg)       MPI_SGE_LENGTH((psg)->FlagsLength)
  401. #define  MPI_pSGE_SET_FLAGS_LENGTH(psg,f,l)  (psg)->FlagsLength = MPI_SGE_SET_FLAGS_LENGTH(f,l)
  402.          /* CAUTION - The following are READ-MODIFY-WRITE! */
  403. #define  MPI_pSGE_SET_FLAGS(psg,f)      (psg)->FlagsLength |= MPI_SGE_SET_FLAGS(f)
  404. #define  MPI_pSGE_SET_LENGTH(psg,l)     (psg)->FlagsLength |= MPI_SGE_LENGTH(l)
  405. #define  MPI_GET_CHAIN_OFFSET(x) ((x&MPI_SGE_CHAIN_OFFSET_MASK)>>MPI_SGE_CHAIN_OFFSET_SHIFT)
  406. /*****************************************************************************
  407. *
  408. *        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
  409. *
  410. *****************************************************************************/
  411. /****************************************************************************/
  412. /* Standard message request header for all request messages                 */
  413. /****************************************************************************/
  414. typedef struct _MSG_REQUEST_HEADER
  415. {
  416.     U8                      Reserved[2];      /* function specific */
  417.     U8                      ChainOffset;
  418.     U8                      Function;
  419.     U8                      Reserved1[3];     /* function specific */
  420.     U8                      MsgFlags;
  421.     U32                     MsgContext;
  422. } MSG_REQUEST_HEADER, MPI_POINTER PTR_MSG_REQUEST_HEADER,
  423.   MPIHeader_t, MPI_POINTER pMPIHeader_t;
  424. /****************************************************************************/
  425. /*  Default Reply                                                           */
  426. /****************************************************************************/
  427. typedef struct _MSG_DEFAULT_REPLY
  428. {
  429.     U8                      Reserved[2];      /* function specific */
  430.     U8                      MsgLength;
  431.     U8                      Function;
  432.     U8                      Reserved1[3];     /* function specific */
  433.     U8                      MsgFlags;
  434.     U32                     MsgContext;
  435.     U8                      Reserved2[2];     /* function specific */
  436.     U16                     IOCStatus;
  437.     U32                     IOCLogInfo;
  438. } MSG_DEFAULT_REPLY, MPI_POINTER PTR_MSG_DEFAULT_REPLY,
  439.   MPIDefaultReply_t, MPI_POINTER pMPIDefaultReply_t;
  440. /* MsgFlags definition for all replies */
  441. #define MPI_MSGFLAGS_CONTINUATION_REPLY         (0x80)
  442. /*****************************************************************************
  443. *
  444. *               I O C    S t a t u s   V a l u e s
  445. *
  446. *****************************************************************************/
  447. /****************************************************************************/
  448. /*  Common IOCStatus values for all replies                                 */
  449. /****************************************************************************/
  450. #define MPI_IOCSTATUS_SUCCESS                  (0x0000)
  451. #define MPI_IOCSTATUS_INVALID_FUNCTION         (0x0001)
  452. #define MPI_IOCSTATUS_BUSY                     (0x0002)
  453. #define MPI_IOCSTATUS_INVALID_SGL              (0x0003)
  454. #define MPI_IOCSTATUS_INTERNAL_ERROR           (0x0004)
  455. #define MPI_IOCSTATUS_RESERVED                 (0x0005)
  456. #define MPI_IOCSTATUS_INSUFFICIENT_RESOURCES   (0x0006)
  457. #define MPI_IOCSTATUS_INVALID_FIELD            (0x0007)
  458. #define MPI_IOCSTATUS_INVALID_STATE            (0x0008)
  459. /****************************************************************************/
  460. /*  Config IOCStatus values                                                 */
  461. /****************************************************************************/
  462. #define MPI_IOCSTATUS_CONFIG_INVALID_ACTION    (0x0020)
  463. #define MPI_IOCSTATUS_CONFIG_INVALID_TYPE      (0x0021)
  464. #define MPI_IOCSTATUS_CONFIG_INVALID_PAGE      (0x0022)
  465. #define MPI_IOCSTATUS_CONFIG_INVALID_DATA      (0x0023)
  466. #define MPI_IOCSTATUS_CONFIG_NO_DEFAULTS       (0x0024)
  467. #define MPI_IOCSTATUS_CONFIG_CANT_COMMIT       (0x0025)
  468. /****************************************************************************/
  469. /*  SCSIIO Reply (SPI & FCP) initiator values                               */
  470. /****************************************************************************/
  471. #define MPI_IOCSTATUS_SCSI_RECOVERED_ERROR     (0x0040)
  472. #define MPI_IOCSTATUS_SCSI_INVALID_BUS         (0x0041)
  473. #define MPI_IOCSTATUS_SCSI_INVALID_TARGETID    (0x0042)
  474. #define MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE    (0x0043)
  475. #define MPI_IOCSTATUS_SCSI_DATA_OVERRUN        (0x0044)
  476. #define MPI_IOCSTATUS_SCSI_DATA_UNDERRUN       (0x0045)
  477. #define MPI_IOCSTATUS_SCSI_IO_DATA_ERROR       (0x0046)
  478. #define MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR      (0x0047)
  479. #define MPI_IOCSTATUS_SCSI_TASK_TERMINATED     (0x0048)
  480. #define MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH   (0x0049)
  481. #define MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED    (0x004A)
  482. #define MPI_IOCSTATUS_SCSI_IOC_TERMINATED      (0x004B)
  483. #define MPI_IOCSTATUS_SCSI_EXT_TERMINATED      (0x004C)
  484. /****************************************************************************/
  485. /*  SCSI (SPI & FCP) target values                                          */
  486. /****************************************************************************/
  487. #define MPI_IOCSTATUS_TARGET_PRIORITY_IO         (0x0060)
  488. #define MPI_IOCSTATUS_TARGET_INVALID_PORT        (0x0061)
  489. #define MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX    (0x0062)
  490. #define MPI_IOCSTATUS_TARGET_ABORTED             (0x0063)
  491. #define MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE   (0x0064)
  492. #define MPI_IOCSTATUS_TARGET_NO_CONNECTION       (0x0065)
  493. #define MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH (0x006A)
  494. #define MPI_IOCSTATUS_TARGET_STS_DATA_NOT_SENT   (0x006B)
  495. /****************************************************************************/
  496. /*  Additional FCP target values                                            */
  497. /****************************************************************************/
  498. #define MPI_IOCSTATUS_TARGET_FC_ABORTED         (0x0066)    /* obsolete */
  499. #define MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID   (0x0067)    /* obsolete */
  500. #define MPI_IOCSTATUS_TARGET_FC_DID_INVALID     (0x0068)    /* obsolete */
  501. #define MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT (0x0069)    /* obsolete */
  502. /****************************************************************************/
  503. /*  Fibre Channel Direct Access values                                      */
  504. /****************************************************************************/
  505. #define MPI_IOCSTATUS_FC_ABORTED                (0x0066)
  506. #define MPI_IOCSTATUS_FC_RX_ID_INVALID          (0x0067)
  507. #define MPI_IOCSTATUS_FC_DID_INVALID            (0x0068)
  508. #define MPI_IOCSTATUS_FC_NODE_LOGGED_OUT        (0x0069)
  509. /****************************************************************************/
  510. /*  LAN values                                                              */
  511. /****************************************************************************/
  512. #define MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND      (0x0080)
  513. #define MPI_IOCSTATUS_LAN_DEVICE_FAILURE        (0x0081)
  514. #define MPI_IOCSTATUS_LAN_TRANSMIT_ERROR        (0x0082)
  515. #define MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED      (0x0083)
  516. #define MPI_IOCSTATUS_LAN_RECEIVE_ERROR         (0x0084)
  517. #define MPI_IOCSTATUS_LAN_RECEIVE_ABORTED       (0x0085)
  518. #define MPI_IOCSTATUS_LAN_PARTIAL_PACKET        (0x0086)
  519. #define MPI_IOCSTATUS_LAN_CANCELED              (0x0087)
  520. /****************************************************************************/
  521. /*  IOCStatus flag to indicate that log info is available                   */
  522. /****************************************************************************/
  523. #define MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE   (0x8000)
  524. #define MPI_IOCSTATUS_MASK                      (0x7FFF)
  525. /****************************************************************************/
  526. /*  LogInfo Types                                                           */
  527. /****************************************************************************/
  528. #define MPI_IOCLOGINFO_TYPE_MASK                (0xF0000000)
  529. #define MPI_IOCLOGINFO_TYPE_NONE                (0x0)
  530. #define MPI_IOCLOGINFO_TYPE_SCSI                (0x1)
  531. #define MPI_IOCLOGINFO_TYPE_FC                  (0x2)
  532. #define MPI_IOCLOGINFO_LOG_DATA_MASK            (0x0FFFFFFF)
  533. #endif