mpi2_init.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
  1. /*
  2. * Copyright 2000-2015 Avago Technologies. All rights reserved.
  3. *
  4. *
  5. * Name: mpi2_init.h
  6. * Title: MPI SCSI initiator mode messages and structures
  7. * Creation Date: June 23, 2006
  8. *
  9. * mpi2_init.h Version: 02.00.17
  10. *
  11. * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
  12. * prefix are for use only on MPI v2.5 products, and must not be used
  13. * with MPI v2.0 products. Unless otherwise noted, names beginning with
  14. * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
  15. *
  16. * Version History
  17. * ---------------
  18. *
  19. * Date Version Description
  20. * -------- -------- ------------------------------------------------------
  21. * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
  22. * 10-31-07 02.00.01 Fixed name for pMpi2SCSITaskManagementRequest_t.
  23. * 12-18-07 02.00.02 Modified Task Management Target Reset Method defines.
  24. * 02-29-08 02.00.03 Added Query Task Set and Query Unit Attention.
  25. * 03-03-08 02.00.04 Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
  26. * 05-21-08 02.00.05 Fixed typo in name of Mpi2SepRequest_t.
  27. * 10-02-08 02.00.06 Removed Untagged and No Disconnect values from SCSI IO
  28. * Control field Task Attribute flags.
  29. * Moved LUN field defines to mpi2.h becasue they are
  30. * common to many structures.
  31. * 05-06-09 02.00.07 Changed task management type of Query Unit Attention to
  32. * Query Asynchronous Event.
  33. * Defined two new bits in the SlotStatus field of the SCSI
  34. * Enclosure Processor Request and Reply.
  35. * 10-28-09 02.00.08 Added defines for decoding the ResponseInfo bytes for
  36. * both SCSI IO Error Reply and SCSI Task Management Reply.
  37. * Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
  38. * Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
  39. * 02-10-10 02.00.09 Removed unused structure that had "#if 0" around it.
  40. * 05-12-10 02.00.10 Added optional vendor-unique region to SCSI IO Request.
  41. * 11-10-10 02.00.11 Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
  42. * 11-18-11 02.00.12 Incorporating additions for MPI v2.5.
  43. * 02-06-12 02.00.13 Added alternate defines for Task Priority / Command
  44. * Priority to match SAM-4.
  45. * Added EEDPErrorOffset to MPI2_SCSI_IO_REPLY.
  46. * 07-10-12 02.00.14 Added MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION.
  47. * 04-09-13 02.00.15 Added SCSIStatusQualifier field to MPI2_SCSI_IO_REPLY,
  48. * replacing the Reserved4 field.
  49. * 11-18-14 02.00.16 Updated copyright information.
  50. * 03-xx-15 02.00.17 Updated for MPI v2.6.
  51. * Added MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF and
  52. * MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF.
  53. * --------------------------------------------------------------------------
  54. */
  55. #ifndef MPI2_INIT_H
  56. #define MPI2_INIT_H
  57. /*****************************************************************************
  58. *
  59. * SCSI Initiator Messages
  60. *
  61. *****************************************************************************/
  62. /****************************************************************************
  63. * SCSI IO messages and associated structures
  64. ****************************************************************************/
  65. typedef struct _MPI2_SCSI_IO_CDB_EEDP32 {
  66. U8 CDB[20]; /*0x00 */
  67. U32 PrimaryReferenceTag; /*0x14 */
  68. U16 PrimaryApplicationTag; /*0x18 */
  69. U16 PrimaryApplicationTagMask; /*0x1A */
  70. U32 TransferLength; /*0x1C */
  71. } MPI2_SCSI_IO_CDB_EEDP32, *PTR_MPI2_SCSI_IO_CDB_EEDP32,
  72. Mpi2ScsiIoCdbEedp32_t, *pMpi2ScsiIoCdbEedp32_t;
  73. /*MPI v2.0 CDB field */
  74. typedef union _MPI2_SCSI_IO_CDB_UNION {
  75. U8 CDB32[32];
  76. MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
  77. MPI2_SGE_SIMPLE_UNION SGE;
  78. } MPI2_SCSI_IO_CDB_UNION, *PTR_MPI2_SCSI_IO_CDB_UNION,
  79. Mpi2ScsiIoCdb_t, *pMpi2ScsiIoCdb_t;
  80. /*MPI v2.0 SCSI IO Request Message */
  81. typedef struct _MPI2_SCSI_IO_REQUEST {
  82. U16 DevHandle; /*0x00 */
  83. U8 ChainOffset; /*0x02 */
  84. U8 Function; /*0x03 */
  85. U16 Reserved1; /*0x04 */
  86. U8 Reserved2; /*0x06 */
  87. U8 MsgFlags; /*0x07 */
  88. U8 VP_ID; /*0x08 */
  89. U8 VF_ID; /*0x09 */
  90. U16 Reserved3; /*0x0A */
  91. U32 SenseBufferLowAddress; /*0x0C */
  92. U16 SGLFlags; /*0x10 */
  93. U8 SenseBufferLength; /*0x12 */
  94. U8 Reserved4; /*0x13 */
  95. U8 SGLOffset0; /*0x14 */
  96. U8 SGLOffset1; /*0x15 */
  97. U8 SGLOffset2; /*0x16 */
  98. U8 SGLOffset3; /*0x17 */
  99. U32 SkipCount; /*0x18 */
  100. U32 DataLength; /*0x1C */
  101. U32 BidirectionalDataLength; /*0x20 */
  102. U16 IoFlags; /*0x24 */
  103. U16 EEDPFlags; /*0x26 */
  104. U32 EEDPBlockSize; /*0x28 */
  105. U32 SecondaryReferenceTag; /*0x2C */
  106. U16 SecondaryApplicationTag; /*0x30 */
  107. U16 ApplicationTagTranslationMask; /*0x32 */
  108. U8 LUN[8]; /*0x34 */
  109. U32 Control; /*0x3C */
  110. MPI2_SCSI_IO_CDB_UNION CDB; /*0x40 */
  111. #ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /*typically this is left undefined */
  112. MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion;
  113. #endif
  114. MPI2_SGE_IO_UNION SGL; /*0x60 */
  115. } MPI2_SCSI_IO_REQUEST, *PTR_MPI2_SCSI_IO_REQUEST,
  116. Mpi2SCSIIORequest_t, *pMpi2SCSIIORequest_t;
  117. /*SCSI IO MsgFlags bits */
  118. /*MsgFlags for SenseBufferAddressSpace */
  119. #define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR (0x0C)
  120. #define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR (0x00)
  121. #define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR (0x04)
  122. #define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR (0x08)
  123. #define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR (0x0C)
  124. #define MPI26_SCSIIO_MSGFLAGS_IOCCTL_SENSE_ADDR (0x08)
  125. /*SCSI IO SGLFlags bits */
  126. /*base values for Data Location Address Space */
  127. #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK (0x0C)
  128. #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR (0x00)
  129. #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR (0x04)
  130. #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR (0x08)
  131. #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR (0x0C)
  132. /*base values for Type */
  133. #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK (0x03)
  134. #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI (0x00)
  135. #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32 (0x01)
  136. #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64 (0x02)
  137. /*shift values for each sub-field */
  138. #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT (12)
  139. #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT (8)
  140. #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT (4)
  141. #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT (0)
  142. /*number of SGLOffset fields */
  143. #define MPI2_SCSIIO_NUM_SGLOFFSETS (4)
  144. /*SCSI IO IoFlags bits */
  145. /*Large CDB Address Space */
  146. #define MPI2_SCSIIO_CDB_ADDR_MASK (0x6000)
  147. #define MPI2_SCSIIO_CDB_ADDR_SYSTEM (0x0000)
  148. #define MPI2_SCSIIO_CDB_ADDR_IOCDDR (0x2000)
  149. #define MPI2_SCSIIO_CDB_ADDR_IOCPLB (0x4000)
  150. #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA (0x6000)
  151. #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
  152. #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
  153. #define MPI2_SCSIIO_IOFLAGS_MULTICAST (0x0400)
  154. #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
  155. #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
  156. /*SCSI IO EEDPFlags bits */
  157. #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000)
  158. #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG (0x4000)
  159. #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG (0x2000)
  160. #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG (0x1000)
  161. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG (0x0400)
  162. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG (0x0200)
  163. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD (0x0100)
  164. #define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG (0x0008)
  165. #define MPI2_SCSIIO_EEDPFLAGS_MASK_OP (0x0007)
  166. #define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP (0x0000)
  167. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP (0x0001)
  168. #define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP (0x0002)
  169. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP (0x0003)
  170. #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP (0x0004)
  171. #define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP (0x0006)
  172. #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP (0x0007)
  173. /*SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
  174. /*SCSI IO Control bits */
  175. #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK (0xFC000000)
  176. #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT (26)
  177. #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK (0x03000000)
  178. #define MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION (24)
  179. #define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000)
  180. #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000)
  181. #define MPI2_SCSIIO_CONTROL_READ (0x02000000)
  182. #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000)
  183. #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800)
  184. #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11)
  185. /*alternate name for the previous field; called Command Priority in SAM-4 */
  186. #define MPI2_SCSIIO_CONTROL_CMDPRI_MASK (0x00007800)
  187. #define MPI2_SCSIIO_CONTROL_CMDPRI_SHIFT (11)
  188. #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700)
  189. #define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000)
  190. #define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100)
  191. #define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200)
  192. #define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400)
  193. #define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0)
  194. #define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000)
  195. #define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040)
  196. #define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080)
  197. /*MPI v2.5 CDB field */
  198. typedef union _MPI25_SCSI_IO_CDB_UNION {
  199. U8 CDB32[32];
  200. MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
  201. MPI2_IEEE_SGE_SIMPLE64 SGE;
  202. } MPI25_SCSI_IO_CDB_UNION, *PTR_MPI25_SCSI_IO_CDB_UNION,
  203. Mpi25ScsiIoCdb_t, *pMpi25ScsiIoCdb_t;
  204. /*MPI v2.5/2.6 SCSI IO Request Message */
  205. typedef struct _MPI25_SCSI_IO_REQUEST {
  206. U16 DevHandle; /*0x00 */
  207. U8 ChainOffset; /*0x02 */
  208. U8 Function; /*0x03 */
  209. U16 Reserved1; /*0x04 */
  210. U8 Reserved2; /*0x06 */
  211. U8 MsgFlags; /*0x07 */
  212. U8 VP_ID; /*0x08 */
  213. U8 VF_ID; /*0x09 */
  214. U16 Reserved3; /*0x0A */
  215. U32 SenseBufferLowAddress; /*0x0C */
  216. U8 DMAFlags; /*0x10 */
  217. U8 Reserved5; /*0x11 */
  218. U8 SenseBufferLength; /*0x12 */
  219. U8 Reserved4; /*0x13 */
  220. U8 SGLOffset0; /*0x14 */
  221. U8 SGLOffset1; /*0x15 */
  222. U8 SGLOffset2; /*0x16 */
  223. U8 SGLOffset3; /*0x17 */
  224. U32 SkipCount; /*0x18 */
  225. U32 DataLength; /*0x1C */
  226. U32 BidirectionalDataLength; /*0x20 */
  227. U16 IoFlags; /*0x24 */
  228. U16 EEDPFlags; /*0x26 */
  229. U16 EEDPBlockSize; /*0x28 */
  230. U16 Reserved6; /*0x2A */
  231. U32 SecondaryReferenceTag; /*0x2C */
  232. U16 SecondaryApplicationTag; /*0x30 */
  233. U16 ApplicationTagTranslationMask; /*0x32 */
  234. U8 LUN[8]; /*0x34 */
  235. U32 Control; /*0x3C */
  236. MPI25_SCSI_IO_CDB_UNION CDB; /*0x40 */
  237. #ifdef MPI25_SCSI_IO_VENDOR_UNIQUE_REGION /*typically this is left undefined */
  238. MPI25_SCSI_IO_VENDOR_UNIQUE VendorRegion;
  239. #endif
  240. MPI25_SGE_IO_UNION SGL; /*0x60 */
  241. } MPI25_SCSI_IO_REQUEST, *PTR_MPI25_SCSI_IO_REQUEST,
  242. Mpi25SCSIIORequest_t, *pMpi25SCSIIORequest_t;
  243. /*use MPI2_SCSIIO_MSGFLAGS_ defines for the MsgFlags field */
  244. /*Defines for the DMAFlags field
  245. * Each setting affects 4 SGLS, from SGL0 to SGL3.
  246. * D = Data
  247. * C = Cache DIF
  248. * I = Interleaved
  249. * H = Host DIF
  250. */
  251. #define MPI25_SCSIIO_DMAFLAGS_OP_MASK (0x0F)
  252. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_D (0x00)
  253. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_C (0x01)
  254. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_I (0x02)
  255. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_C (0x03)
  256. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_I (0x04)
  257. #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_I_I (0x05)
  258. #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_C (0x06)
  259. #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_I (0x07)
  260. #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_I_I (0x08)
  261. #define MPI25_SCSIIO_DMAFLAGS_OP_D_I_I_I (0x09)
  262. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_D (0x0A)
  263. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_C (0x0B)
  264. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_I (0x0C)
  265. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_C (0x0D)
  266. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_I (0x0E)
  267. #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_I_I (0x0F)
  268. /*number of SGLOffset fields */
  269. #define MPI25_SCSIIO_NUM_SGLOFFSETS (4)
  270. /*defines for the IoFlags field */
  271. #define MPI25_SCSIIO_IOFLAGS_IO_PATH_MASK (0xC000)
  272. #define MPI25_SCSIIO_IOFLAGS_NORMAL_PATH (0x0000)
  273. #define MPI25_SCSIIO_IOFLAGS_FAST_PATH (0x4000)
  274. #define MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH (0x2000)
  275. #define MPI25_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
  276. #define MPI25_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
  277. #define MPI26_SCSIIO_IOFLAGS_PORT_REQUEST (0x0400)
  278. #define MPI25_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
  279. /*MPI v2.5 defines for the EEDPFlags bits */
  280. /*use MPI2_SCSIIO_EEDPFLAGS_ defines for the other EEDPFlags bits */
  281. #define MPI25_SCSIIO_EEDPFLAGS_ESCAPE_MODE_MASK (0x00C0)
  282. #define MPI25_SCSIIO_EEDPFLAGS_COMPATIBLE_MODE (0x0000)
  283. #define MPI25_SCSIIO_EEDPFLAGS_DO_NOT_DISABLE_MODE (0x0040)
  284. #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_DISABLE_MODE (0x0080)
  285. #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_REFTAG_DISABLE_MODE (0x00C0)
  286. #define MPI25_SCSIIO_EEDPFLAGS_HOST_GUARD_METHOD_MASK (0x0030)
  287. #define MPI25_SCSIIO_EEDPFLAGS_T10_CRC_HOST_GUARD (0x0000)
  288. #define MPI25_SCSIIO_EEDPFLAGS_IP_CHKSUM_HOST_GUARD (0x0010)
  289. /*use MPI2_LUN_ defines from mpi2.h for the LUN field */
  290. /*use MPI2_SCSIIO_CONTROL_ defines for the Control field */
  291. /*NOTE: The SCSI IO Reply is nearly the same for MPI 2.0 and MPI 2.5, so
  292. * MPI2_SCSI_IO_REPLY is used for both.
  293. */
  294. /*SCSI IO Error Reply Message */
  295. typedef struct _MPI2_SCSI_IO_REPLY {
  296. U16 DevHandle; /*0x00 */
  297. U8 MsgLength; /*0x02 */
  298. U8 Function; /*0x03 */
  299. U16 Reserved1; /*0x04 */
  300. U8 Reserved2; /*0x06 */
  301. U8 MsgFlags; /*0x07 */
  302. U8 VP_ID; /*0x08 */
  303. U8 VF_ID; /*0x09 */
  304. U16 Reserved3; /*0x0A */
  305. U8 SCSIStatus; /*0x0C */
  306. U8 SCSIState; /*0x0D */
  307. U16 IOCStatus; /*0x0E */
  308. U32 IOCLogInfo; /*0x10 */
  309. U32 TransferCount; /*0x14 */
  310. U32 SenseCount; /*0x18 */
  311. U32 ResponseInfo; /*0x1C */
  312. U16 TaskTag; /*0x20 */
  313. U16 SCSIStatusQualifier; /* 0x22 */
  314. U32 BidirectionalTransferCount; /*0x24 */
  315. U32 EEDPErrorOffset; /*0x28 *//*MPI 2.5 only; Reserved in MPI 2.0*/
  316. U32 Reserved6; /*0x2C */
  317. } MPI2_SCSI_IO_REPLY, *PTR_MPI2_SCSI_IO_REPLY,
  318. Mpi2SCSIIOReply_t, *pMpi2SCSIIOReply_t;
  319. /*SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
  320. #define MPI2_SCSI_STATUS_GOOD (0x00)
  321. #define MPI2_SCSI_STATUS_CHECK_CONDITION (0x02)
  322. #define MPI2_SCSI_STATUS_CONDITION_MET (0x04)
  323. #define MPI2_SCSI_STATUS_BUSY (0x08)
  324. #define MPI2_SCSI_STATUS_INTERMEDIATE (0x10)
  325. #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET (0x14)
  326. #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT (0x18)
  327. #define MPI2_SCSI_STATUS_COMMAND_TERMINATED (0x22) /*obsolete */
  328. #define MPI2_SCSI_STATUS_TASK_SET_FULL (0x28)
  329. #define MPI2_SCSI_STATUS_ACA_ACTIVE (0x30)
  330. #define MPI2_SCSI_STATUS_TASK_ABORTED (0x40)
  331. /*SCSI IO Reply SCSIState flags */
  332. #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID (0x10)
  333. #define MPI2_SCSI_STATE_TERMINATED (0x08)
  334. #define MPI2_SCSI_STATE_NO_SCSI_STATUS (0x04)
  335. #define MPI2_SCSI_STATE_AUTOSENSE_FAILED (0x02)
  336. #define MPI2_SCSI_STATE_AUTOSENSE_VALID (0x01)
  337. /*masks and shifts for the ResponseInfo field */
  338. #define MPI2_SCSI_RI_MASK_REASONCODE (0x000000FF)
  339. #define MPI2_SCSI_RI_SHIFT_REASONCODE (0)
  340. #define MPI2_SCSI_TASKTAG_UNKNOWN (0xFFFF)
  341. /****************************************************************************
  342. * SCSI Task Management messages
  343. ****************************************************************************/
  344. /*SCSI Task Management Request Message */
  345. typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST {
  346. U16 DevHandle; /*0x00 */
  347. U8 ChainOffset; /*0x02 */
  348. U8 Function; /*0x03 */
  349. U8 Reserved1; /*0x04 */
  350. U8 TaskType; /*0x05 */
  351. U8 Reserved2; /*0x06 */
  352. U8 MsgFlags; /*0x07 */
  353. U8 VP_ID; /*0x08 */
  354. U8 VF_ID; /*0x09 */
  355. U16 Reserved3; /*0x0A */
  356. U8 LUN[8]; /*0x0C */
  357. U32 Reserved4[7]; /*0x14 */
  358. U16 TaskMID; /*0x30 */
  359. U16 Reserved5; /*0x32 */
  360. } MPI2_SCSI_TASK_MANAGE_REQUEST,
  361. *PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
  362. Mpi2SCSITaskManagementRequest_t,
  363. *pMpi2SCSITaskManagementRequest_t;
  364. /*TaskType values */
  365. #define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK (0x01)
  366. #define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET (0x02)
  367. #define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET (0x03)
  368. #define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET (0x05)
  369. #define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET (0x06)
  370. #define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK (0x07)
  371. #define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA (0x08)
  372. #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET (0x09)
  373. #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT (0x0A)
  374. /*obsolete TaskType name */
  375. #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION \
  376. (MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT)
  377. /*MsgFlags bits */
  378. #define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET (0x18)
  379. #define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET (0x00)
  380. #define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST (0x08)
  381. #define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET (0x10)
  382. #define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU (0x01)
  383. /*SCSI Task Management Reply Message */
  384. typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY {
  385. U16 DevHandle; /*0x00 */
  386. U8 MsgLength; /*0x02 */
  387. U8 Function; /*0x03 */
  388. U8 ResponseCode; /*0x04 */
  389. U8 TaskType; /*0x05 */
  390. U8 Reserved1; /*0x06 */
  391. U8 MsgFlags; /*0x07 */
  392. U8 VP_ID; /*0x08 */
  393. U8 VF_ID; /*0x09 */
  394. U16 Reserved2; /*0x0A */
  395. U16 Reserved3; /*0x0C */
  396. U16 IOCStatus; /*0x0E */
  397. U32 IOCLogInfo; /*0x10 */
  398. U32 TerminationCount; /*0x14 */
  399. U32 ResponseInfo; /*0x18 */
  400. } MPI2_SCSI_TASK_MANAGE_REPLY,
  401. *PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
  402. Mpi2SCSITaskManagementReply_t, *pMpi2SCSIManagementReply_t;
  403. /*ResponseCode values */
  404. #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE (0x00)
  405. #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME (0x02)
  406. #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED (0x04)
  407. #define MPI2_SCSITASKMGMT_RSP_TM_FAILED (0x05)
  408. #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED (0x08)
  409. #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN (0x09)
  410. #define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG (0x0A)
  411. #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC (0x80)
  412. /*masks and shifts for the ResponseInfo field */
  413. #define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE (0x000000FF)
  414. #define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE (0)
  415. #define MPI2_SCSITASKMGMT_RI_MASK_ARI2 (0x0000FF00)
  416. #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2 (8)
  417. #define MPI2_SCSITASKMGMT_RI_MASK_ARI1 (0x00FF0000)
  418. #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1 (16)
  419. #define MPI2_SCSITASKMGMT_RI_MASK_ARI0 (0xFF000000)
  420. #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0 (24)
  421. /****************************************************************************
  422. * SCSI Enclosure Processor messages
  423. ****************************************************************************/
  424. /*SCSI Enclosure Processor Request Message */
  425. typedef struct _MPI2_SEP_REQUEST {
  426. U16 DevHandle; /*0x00 */
  427. U8 ChainOffset; /*0x02 */
  428. U8 Function; /*0x03 */
  429. U8 Action; /*0x04 */
  430. U8 Flags; /*0x05 */
  431. U8 Reserved1; /*0x06 */
  432. U8 MsgFlags; /*0x07 */
  433. U8 VP_ID; /*0x08 */
  434. U8 VF_ID; /*0x09 */
  435. U16 Reserved2; /*0x0A */
  436. U32 SlotStatus; /*0x0C */
  437. U32 Reserved3; /*0x10 */
  438. U32 Reserved4; /*0x14 */
  439. U32 Reserved5; /*0x18 */
  440. U16 Slot; /*0x1C */
  441. U16 EnclosureHandle; /*0x1E */
  442. } MPI2_SEP_REQUEST, *PTR_MPI2_SEP_REQUEST,
  443. Mpi2SepRequest_t, *pMpi2SepRequest_t;
  444. /*Action defines */
  445. #define MPI2_SEP_REQ_ACTION_WRITE_STATUS (0x00)
  446. #define MPI2_SEP_REQ_ACTION_READ_STATUS (0x01)
  447. /*Flags defines */
  448. #define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS (0x00)
  449. #define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS (0x01)
  450. /*SlotStatus defines */
  451. #define MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF (0x00080000)
  452. #define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE (0x00040000)
  453. #define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000)
  454. #define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED (0x00000200)
  455. #define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE (0x00000100)
  456. #define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED (0x00000080)
  457. #define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT (0x00000040)
  458. #define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY (0x00000010)
  459. #define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY (0x00000008)
  460. #define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING (0x00000004)
  461. #define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY (0x00000002)
  462. #define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR (0x00000001)
  463. /*SCSI Enclosure Processor Reply Message */
  464. typedef struct _MPI2_SEP_REPLY {
  465. U16 DevHandle; /*0x00 */
  466. U8 MsgLength; /*0x02 */
  467. U8 Function; /*0x03 */
  468. U8 Action; /*0x04 */
  469. U8 Flags; /*0x05 */
  470. U8 Reserved1; /*0x06 */
  471. U8 MsgFlags; /*0x07 */
  472. U8 VP_ID; /*0x08 */
  473. U8 VF_ID; /*0x09 */
  474. U16 Reserved2; /*0x0A */
  475. U16 Reserved3; /*0x0C */
  476. U16 IOCStatus; /*0x0E */
  477. U32 IOCLogInfo; /*0x10 */
  478. U32 SlotStatus; /*0x14 */
  479. U32 Reserved4; /*0x18 */
  480. U16 Slot; /*0x1C */
  481. U16 EnclosureHandle; /*0x1E */
  482. } MPI2_SEP_REPLY, *PTR_MPI2_SEP_REPLY,
  483. Mpi2SepReply_t, *pMpi2SepReply_t;
  484. /*SlotStatus defines */
  485. #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF (0x00080000)
  486. #define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY (0x00040000)
  487. #define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000)
  488. #define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED (0x00000200)
  489. #define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE (0x00000100)
  490. #define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED (0x00000080)
  491. #define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT (0x00000040)
  492. #define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY (0x00000010)
  493. #define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY (0x00000008)
  494. #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING (0x00000004)
  495. #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY (0x00000002)
  496. #define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR (0x00000001)
  497. #endif