mpi2_ioc.h 85 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708
  1. /*
  2. * Copyright (c) 2000-2014 LSI Corporation.
  3. *
  4. *
  5. * Name: mpi2_ioc.h
  6. * Title: MPI IOC, Port, Event, FW Download, and FW Upload messages
  7. * Creation Date: October 11, 2006
  8. *
  9. * mpi2_ioc.h Version: 02.00.24
  10. *
  11. * Version History
  12. * ---------------
  13. *
  14. * Date Version Description
  15. * -------- -------- ------------------------------------------------------
  16. * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
  17. * 06-04-07 02.00.01 In IOCFacts Reply structure, renamed MaxDevices to
  18. * MaxTargets.
  19. * Added TotalImageSize field to FWDownload Request.
  20. * Added reserved words to FWUpload Request.
  21. * 06-26-07 02.00.02 Added IR Configuration Change List Event.
  22. * 08-31-07 02.00.03 Removed SystemReplyQueueDepth field from the IOCInit
  23. * request and replaced it with
  24. * ReplyDescriptorPostQueueDepth and ReplyFreeQueueDepth.
  25. * Replaced the MinReplyQueueDepth field of the IOCFacts
  26. * reply with MaxReplyDescriptorPostQueueDepth.
  27. * Added MPI2_RDPQ_DEPTH_MIN define to specify the minimum
  28. * depth for the Reply Descriptor Post Queue.
  29. * Added SASAddress field to Initiator Device Table
  30. * Overflow Event data.
  31. * 10-31-07 02.00.04 Added ReasonCode MPI2_EVENT_SAS_INIT_RC_NOT_RESPONDING
  32. * for SAS Initiator Device Status Change Event data.
  33. * Modified Reason Code defines for SAS Topology Change
  34. * List Event data, including adding a bit for PHY Vacant
  35. * status, and adding a mask for the Reason Code.
  36. * Added define for
  37. * MPI2_EVENT_SAS_TOPO_ES_DELAY_NOT_RESPONDING.
  38. * Added define for MPI2_EXT_IMAGE_TYPE_MEGARAID.
  39. * 12-18-07 02.00.05 Added Boot Status defines for the IOCExceptions field of
  40. * the IOCFacts Reply.
  41. * Removed MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER define.
  42. * Moved MPI2_VERSION_UNION to mpi2.h.
  43. * Changed MPI2_EVENT_NOTIFICATION_REQUEST to use masks
  44. * instead of enables, and added SASBroadcastPrimitiveMasks
  45. * field.
  46. * Added Log Entry Added Event and related structure.
  47. * 02-29-08 02.00.06 Added define MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID.
  48. * Removed define MPI2_IOCFACTS_PROTOCOL_SMP_TARGET.
  49. * Added MaxVolumes and MaxPersistentEntries fields to
  50. * IOCFacts reply.
  51. * Added ProtocalFlags and IOCCapabilities fields to
  52. * MPI2_FW_IMAGE_HEADER.
  53. * Removed MPI2_PORTENABLE_FLAGS_ENABLE_SINGLE_PORT.
  54. * 03-03-08 02.00.07 Fixed MPI2_FW_IMAGE_HEADER by changing Reserved26 to
  55. * a U16 (from a U32).
  56. * Removed extra 's' from EventMasks name.
  57. * 06-27-08 02.00.08 Fixed an offset in a comment.
  58. * 10-02-08 02.00.09 Removed SystemReplyFrameSize from MPI2_IOC_INIT_REQUEST.
  59. * Removed CurReplyFrameSize from MPI2_IOC_FACTS_REPLY and
  60. * renamed MinReplyFrameSize to ReplyFrameSize.
  61. * Added MPI2_IOCFACTS_EXCEPT_IR_FOREIGN_CONFIG_MAX.
  62. * Added two new RAIDOperation values for Integrated RAID
  63. * Operations Status Event data.
  64. * Added four new IR Configuration Change List Event data
  65. * ReasonCode values.
  66. * Added two new ReasonCode defines for SAS Device Status
  67. * Change Event data.
  68. * Added three new DiscoveryStatus bits for the SAS
  69. * Discovery event data.
  70. * Added Multiplexing Status Change bit to the PhyStatus
  71. * field of the SAS Topology Change List event data.
  72. * Removed define for MPI2_INIT_IMAGE_BOOTFLAGS_XMEMCOPY.
  73. * BootFlags are now product-specific.
  74. * Added defines for the indivdual signature bytes
  75. * for MPI2_INIT_IMAGE_FOOTER.
  76. * 01-19-09 02.00.10 Added MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY define.
  77. * Added MPI2_EVENT_SAS_DISC_DS_DOWNSTREAM_INITIATOR
  78. * define.
  79. * Added MPI2_EVENT_SAS_DEV_STAT_RC_SATA_INIT_FAILURE
  80. * define.
  81. * Removed MPI2_EVENT_SAS_DISC_DS_SATA_INIT_FAILURE define.
  82. * 05-06-09 02.00.11 Added MPI2_IOCFACTS_CAPABILITY_RAID_ACCELERATOR define.
  83. * Added MPI2_IOCFACTS_CAPABILITY_MSI_X_INDEX define.
  84. * Added two new reason codes for SAS Device Status Change
  85. * Event.
  86. * Added new event: SAS PHY Counter.
  87. * 07-30-09 02.00.12 Added GPIO Interrupt event define and structure.
  88. * Added MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER define.
  89. * Added new product id family for 2208.
  90. * 10-28-09 02.00.13 Added HostMSIxVectors field to MPI2_IOC_INIT_REQUEST.
  91. * Added MaxMSIxVectors field to MPI2_IOC_FACTS_REPLY.
  92. * Added MinDevHandle field to MPI2_IOC_FACTS_REPLY.
  93. * Added MPI2_IOCFACTS_CAPABILITY_HOST_BASED_DISCOVERY.
  94. * Added MPI2_EVENT_HOST_BASED_DISCOVERY_PHY define.
  95. * Added MPI2_EVENT_SAS_TOPO_ES_NO_EXPANDER define.
  96. * Added Host Based Discovery Phy Event data.
  97. * Added defines for ProductID Product field
  98. * (MPI2_FW_HEADER_PID_).
  99. * Modified values for SAS ProductID Family
  100. * (MPI2_FW_HEADER_PID_FAMILY_).
  101. * 02-10-10 02.00.14 Added SAS Quiesce Event structure and defines.
  102. * Added PowerManagementControl Request structures and
  103. * defines.
  104. * 05-12-10 02.00.15 Marked Task Set Full Event as obsolete.
  105. * Added MPI2_EVENT_SAS_TOPO_LR_UNSUPPORTED_PHY define.
  106. * 11-10-10 02.00.16 Added MPI2_FW_DOWNLOAD_ITYPE_MIN_PRODUCT_SPECIFIC.
  107. * 02-23-11 02.00.17 Added SAS NOTIFY Primitive event, and added
  108. * SASNotifyPrimitiveMasks field to
  109. * MPI2_EVENT_NOTIFICATION_REQUEST.
  110. * Added Temperature Threshold Event.
  111. * Added Host Message Event.
  112. * Added Send Host Message request and reply.
  113. * 05-25-11 02.00.18 For Extended Image Header, added
  114. * MPI2_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC and
  115. * MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC defines.
  116. * Deprecated MPI2_EXT_IMAGE_TYPE_MAX define.
  117. * 08-24-11 02.00.19 Added PhysicalPort field to
  118. * MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE structure.
  119. * Marked MPI2_PM_CONTROL_FEATURE_PCIE_LINK as obsolete.
  120. * 03-29-12 02.00.21 Added a product specific range to event values.
  121. * 07-26-12 02.00.22 Added MPI2_IOCFACTS_EXCEPT_PARTIAL_MEMORY_FAILURE.
  122. * Added ElapsedSeconds field to
  123. * MPI2_EVENT_DATA_IR_OPERATION_STATUS.
  124. * 08-19-13 02.00.23 For IOCInit, added MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE
  125. * and MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY.
  126. * Added MPI2_IOCFACTS_CAPABILITY_RDPQ_ARRAY_CAPABLE.
  127. * Added MPI2_FW_DOWNLOAD_ITYPE_PUBLIC_KEY.
  128. * Added Encrypted Hash Extended Image.
  129. * 12-05-13 02.00.24 Added MPI25_HASH_IMAGE_TYPE_BIOS.
  130. * --------------------------------------------------------------------------
  131. */
  132. #ifndef MPI2_IOC_H
  133. #define MPI2_IOC_H
  134. /*****************************************************************************
  135. *
  136. * IOC Messages
  137. *
  138. *****************************************************************************/
  139. /****************************************************************************
  140. * IOCInit message
  141. ****************************************************************************/
  142. /* IOCInit Request message */
  143. typedef struct _MPI2_IOC_INIT_REQUEST
  144. {
  145. U8 WhoInit; /* 0x00 */
  146. U8 Reserved1; /* 0x01 */
  147. U8 ChainOffset; /* 0x02 */
  148. U8 Function; /* 0x03 */
  149. U16 Reserved2; /* 0x04 */
  150. U8 Reserved3; /* 0x06 */
  151. U8 MsgFlags; /* 0x07 */
  152. U8 VP_ID; /* 0x08 */
  153. U8 VF_ID; /* 0x09 */
  154. U16 Reserved4; /* 0x0A */
  155. U16 MsgVersion; /* 0x0C */
  156. U16 HeaderVersion; /* 0x0E */
  157. U32 Reserved5; /* 0x10 */
  158. U16 Reserved6; /* 0x14 */
  159. U8 Reserved7; /* 0x16 */
  160. U8 HostMSIxVectors; /* 0x17 */
  161. U16 Reserved8; /* 0x18 */
  162. U16 SystemRequestFrameSize; /* 0x1A */
  163. U16 ReplyDescriptorPostQueueDepth; /* 0x1C */
  164. U16 ReplyFreeQueueDepth; /* 0x1E */
  165. U32 SenseBufferAddressHigh; /* 0x20 */
  166. U32 SystemReplyAddressHigh; /* 0x24 */
  167. U64 SystemRequestFrameBaseAddress; /* 0x28 */
  168. U64 ReplyDescriptorPostQueueAddress;/* 0x30 */
  169. U64 ReplyFreeQueueAddress; /* 0x38 */
  170. U64 TimeStamp; /* 0x40 */
  171. } MPI2_IOC_INIT_REQUEST, MPI2_POINTER PTR_MPI2_IOC_INIT_REQUEST,
  172. Mpi2IOCInitRequest_t, MPI2_POINTER pMpi2IOCInitRequest_t;
  173. /* WhoInit values */
  174. #define MPI2_WHOINIT_NOT_INITIALIZED (0x00)
  175. #define MPI2_WHOINIT_SYSTEM_BIOS (0x01)
  176. #define MPI2_WHOINIT_ROM_BIOS (0x02)
  177. #define MPI2_WHOINIT_PCI_PEER (0x03)
  178. #define MPI2_WHOINIT_HOST_DRIVER (0x04)
  179. #define MPI2_WHOINIT_MANUFACTURER (0x05)
  180. /* MsgFlags */
  181. #define MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE (0x01)
  182. /* MsgVersion */
  183. #define MPI2_IOCINIT_MSGVERSION_MAJOR_MASK (0xFF00)
  184. #define MPI2_IOCINIT_MSGVERSION_MAJOR_SHIFT (8)
  185. #define MPI2_IOCINIT_MSGVERSION_MINOR_MASK (0x00FF)
  186. #define MPI2_IOCINIT_MSGVERSION_MINOR_SHIFT (0)
  187. /* HeaderVersion */
  188. #define MPI2_IOCINIT_HDRVERSION_UNIT_MASK (0xFF00)
  189. #define MPI2_IOCINIT_HDRVERSION_UNIT_SHIFT (8)
  190. #define MPI2_IOCINIT_HDRVERSION_DEV_MASK (0x00FF)
  191. #define MPI2_IOCINIT_HDRVERSION_DEV_SHIFT (0)
  192. /* minimum depth for a Reply Descriptor Post Queue */
  193. #define MPI2_RDPQ_DEPTH_MIN (16)
  194. /* Reply Descriptor Post Queue Array Entry */
  195. typedef struct _MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY {
  196. U64 RDPQBaseAddress; /* 0x00 */
  197. U32 Reserved1; /* 0x08 */
  198. U32 Reserved2; /* 0x0C */
  199. } MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY,
  200. MPI2_POINTER PTR_MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY,
  201. Mpi2IOCInitRDPQArrayEntry, MPI2_POINTER pMpi2IOCInitRDPQArrayEntry;
  202. /* IOCInit Reply message */
  203. typedef struct _MPI2_IOC_INIT_REPLY
  204. {
  205. U8 WhoInit; /* 0x00 */
  206. U8 Reserved1; /* 0x01 */
  207. U8 MsgLength; /* 0x02 */
  208. U8 Function; /* 0x03 */
  209. U16 Reserved2; /* 0x04 */
  210. U8 Reserved3; /* 0x06 */
  211. U8 MsgFlags; /* 0x07 */
  212. U8 VP_ID; /* 0x08 */
  213. U8 VF_ID; /* 0x09 */
  214. U16 Reserved4; /* 0x0A */
  215. U16 Reserved5; /* 0x0C */
  216. U16 IOCStatus; /* 0x0E */
  217. U32 IOCLogInfo; /* 0x10 */
  218. } MPI2_IOC_INIT_REPLY, MPI2_POINTER PTR_MPI2_IOC_INIT_REPLY,
  219. Mpi2IOCInitReply_t, MPI2_POINTER pMpi2IOCInitReply_t;
  220. /****************************************************************************
  221. * IOCFacts message
  222. ****************************************************************************/
  223. /* IOCFacts Request message */
  224. typedef struct _MPI2_IOC_FACTS_REQUEST
  225. {
  226. U16 Reserved1; /* 0x00 */
  227. U8 ChainOffset; /* 0x02 */
  228. U8 Function; /* 0x03 */
  229. U16 Reserved2; /* 0x04 */
  230. U8 Reserved3; /* 0x06 */
  231. U8 MsgFlags; /* 0x07 */
  232. U8 VP_ID; /* 0x08 */
  233. U8 VF_ID; /* 0x09 */
  234. U16 Reserved4; /* 0x0A */
  235. } MPI2_IOC_FACTS_REQUEST, MPI2_POINTER PTR_MPI2_IOC_FACTS_REQUEST,
  236. Mpi2IOCFactsRequest_t, MPI2_POINTER pMpi2IOCFactsRequest_t;
  237. /* IOCFacts Reply message */
  238. typedef struct _MPI2_IOC_FACTS_REPLY
  239. {
  240. U16 MsgVersion; /* 0x00 */
  241. U8 MsgLength; /* 0x02 */
  242. U8 Function; /* 0x03 */
  243. U16 HeaderVersion; /* 0x04 */
  244. U8 IOCNumber; /* 0x06 */
  245. U8 MsgFlags; /* 0x07 */
  246. U8 VP_ID; /* 0x08 */
  247. U8 VF_ID; /* 0x09 */
  248. U16 Reserved1; /* 0x0A */
  249. U16 IOCExceptions; /* 0x0C */
  250. U16 IOCStatus; /* 0x0E */
  251. U32 IOCLogInfo; /* 0x10 */
  252. U8 MaxChainDepth; /* 0x14 */
  253. U8 WhoInit; /* 0x15 */
  254. U8 NumberOfPorts; /* 0x16 */
  255. U8 MaxMSIxVectors; /* 0x17 */
  256. U16 RequestCredit; /* 0x18 */
  257. U16 ProductID; /* 0x1A */
  258. U32 IOCCapabilities; /* 0x1C */
  259. MPI2_VERSION_UNION FWVersion; /* 0x20 */
  260. U16 IOCRequestFrameSize; /* 0x24 */
  261. U16 Reserved3; /* 0x26 */
  262. U16 MaxInitiators; /* 0x28 */
  263. U16 MaxTargets; /* 0x2A */
  264. U16 MaxSasExpanders; /* 0x2C */
  265. U16 MaxEnclosures; /* 0x2E */
  266. U16 ProtocolFlags; /* 0x30 */
  267. U16 HighPriorityCredit; /* 0x32 */
  268. U16 MaxReplyDescriptorPostQueueDepth; /* 0x34 */
  269. U8 ReplyFrameSize; /* 0x36 */
  270. U8 MaxVolumes; /* 0x37 */
  271. U16 MaxDevHandle; /* 0x38 */
  272. U16 MaxPersistentEntries; /* 0x3A */
  273. U16 MinDevHandle; /* 0x3C */
  274. U16 Reserved4; /* 0x3E */
  275. } MPI2_IOC_FACTS_REPLY, MPI2_POINTER PTR_MPI2_IOC_FACTS_REPLY,
  276. Mpi2IOCFactsReply_t, MPI2_POINTER pMpi2IOCFactsReply_t;
  277. /* MsgVersion */
  278. #define MPI2_IOCFACTS_MSGVERSION_MAJOR_MASK (0xFF00)
  279. #define MPI2_IOCFACTS_MSGVERSION_MAJOR_SHIFT (8)
  280. #define MPI2_IOCFACTS_MSGVERSION_MINOR_MASK (0x00FF)
  281. #define MPI2_IOCFACTS_MSGVERSION_MINOR_SHIFT (0)
  282. /* HeaderVersion */
  283. #define MPI2_IOCFACTS_HDRVERSION_UNIT_MASK (0xFF00)
  284. #define MPI2_IOCFACTS_HDRVERSION_UNIT_SHIFT (8)
  285. #define MPI2_IOCFACTS_HDRVERSION_DEV_MASK (0x00FF)
  286. #define MPI2_IOCFACTS_HDRVERSION_DEV_SHIFT (0)
  287. /* IOCExceptions */
  288. #define MPI2_IOCFACTS_EXCEPT_PARTIAL_MEMORY_FAILURE (0x0200)
  289. #define MPI2_IOCFACTS_EXCEPT_IR_FOREIGN_CONFIG_MAX (0x0100)
  290. #define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_MASK (0x00E0)
  291. #define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_GOOD (0x0000)
  292. #define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_BACKUP (0x0020)
  293. #define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_RESTORED (0x0040)
  294. #define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_CORRUPT_BACKUP (0x0060)
  295. #define MPI2_IOCFACTS_EXCEPT_METADATA_UNSUPPORTED (0x0010)
  296. #define MPI2_IOCFACTS_EXCEPT_MANUFACT_CHECKSUM_FAIL (0x0008)
  297. #define MPI2_IOCFACTS_EXCEPT_FW_CHECKSUM_FAIL (0x0004)
  298. #define MPI2_IOCFACTS_EXCEPT_RAID_CONFIG_INVALID (0x0002)
  299. #define MPI2_IOCFACTS_EXCEPT_CONFIG_CHECKSUM_FAIL (0x0001)
  300. /* defines for WhoInit field are after the IOCInit Request */
  301. /* ProductID field uses MPI2_FW_HEADER_PID_ */
  302. /* IOCCapabilities */
  303. #define MPI2_IOCFACTS_CAPABILITY_RDPQ_ARRAY_CAPABLE (0x00040000)
  304. #define MPI2_IOCFACTS_CAPABILITY_HOST_BASED_DISCOVERY (0x00010000)
  305. #define MPI2_IOCFACTS_CAPABILITY_MSI_X_INDEX (0x00008000)
  306. #define MPI2_IOCFACTS_CAPABILITY_RAID_ACCELERATOR (0x00004000)
  307. #define MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY (0x00002000)
  308. #define MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID (0x00001000)
  309. #define MPI2_IOCFACTS_CAPABILITY_TLR (0x00000800)
  310. #define MPI2_IOCFACTS_CAPABILITY_MULTICAST (0x00000100)
  311. #define MPI2_IOCFACTS_CAPABILITY_BIDIRECTIONAL_TARGET (0x00000080)
  312. #define MPI2_IOCFACTS_CAPABILITY_EEDP (0x00000040)
  313. #define MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER (0x00000020)
  314. #define MPI2_IOCFACTS_CAPABILITY_SNAPSHOT_BUFFER (0x00000010)
  315. #define MPI2_IOCFACTS_CAPABILITY_DIAG_TRACE_BUFFER (0x00000008)
  316. #define MPI2_IOCFACTS_CAPABILITY_TASK_SET_FULL_HANDLING (0x00000004)
  317. /* ProtocolFlags */
  318. #define MPI2_IOCFACTS_PROTOCOL_SCSI_TARGET (0x0001)
  319. #define MPI2_IOCFACTS_PROTOCOL_SCSI_INITIATOR (0x0002)
  320. /****************************************************************************
  321. * PortFacts message
  322. ****************************************************************************/
  323. /* PortFacts Request message */
  324. typedef struct _MPI2_PORT_FACTS_REQUEST
  325. {
  326. U16 Reserved1; /* 0x00 */
  327. U8 ChainOffset; /* 0x02 */
  328. U8 Function; /* 0x03 */
  329. U16 Reserved2; /* 0x04 */
  330. U8 PortNumber; /* 0x06 */
  331. U8 MsgFlags; /* 0x07 */
  332. U8 VP_ID; /* 0x08 */
  333. U8 VF_ID; /* 0x09 */
  334. U16 Reserved3; /* 0x0A */
  335. } MPI2_PORT_FACTS_REQUEST, MPI2_POINTER PTR_MPI2_PORT_FACTS_REQUEST,
  336. Mpi2PortFactsRequest_t, MPI2_POINTER pMpi2PortFactsRequest_t;
  337. /* PortFacts Reply message */
  338. typedef struct _MPI2_PORT_FACTS_REPLY
  339. {
  340. U16 Reserved1; /* 0x00 */
  341. U8 MsgLength; /* 0x02 */
  342. U8 Function; /* 0x03 */
  343. U16 Reserved2; /* 0x04 */
  344. U8 PortNumber; /* 0x06 */
  345. U8 MsgFlags; /* 0x07 */
  346. U8 VP_ID; /* 0x08 */
  347. U8 VF_ID; /* 0x09 */
  348. U16 Reserved3; /* 0x0A */
  349. U16 Reserved4; /* 0x0C */
  350. U16 IOCStatus; /* 0x0E */
  351. U32 IOCLogInfo; /* 0x10 */
  352. U8 Reserved5; /* 0x14 */
  353. U8 PortType; /* 0x15 */
  354. U16 Reserved6; /* 0x16 */
  355. U16 MaxPostedCmdBuffers; /* 0x18 */
  356. U16 Reserved7; /* 0x1A */
  357. } MPI2_PORT_FACTS_REPLY, MPI2_POINTER PTR_MPI2_PORT_FACTS_REPLY,
  358. Mpi2PortFactsReply_t, MPI2_POINTER pMpi2PortFactsReply_t;
  359. /* PortType values */
  360. #define MPI2_PORTFACTS_PORTTYPE_INACTIVE (0x00)
  361. #define MPI2_PORTFACTS_PORTTYPE_FC (0x10)
  362. #define MPI2_PORTFACTS_PORTTYPE_ISCSI (0x20)
  363. #define MPI2_PORTFACTS_PORTTYPE_SAS_PHYSICAL (0x30)
  364. #define MPI2_PORTFACTS_PORTTYPE_SAS_VIRTUAL (0x31)
  365. /****************************************************************************
  366. * PortEnable message
  367. ****************************************************************************/
  368. /* PortEnable Request message */
  369. typedef struct _MPI2_PORT_ENABLE_REQUEST
  370. {
  371. U16 Reserved1; /* 0x00 */
  372. U8 ChainOffset; /* 0x02 */
  373. U8 Function; /* 0x03 */
  374. U8 Reserved2; /* 0x04 */
  375. U8 PortFlags; /* 0x05 */
  376. U8 Reserved3; /* 0x06 */
  377. U8 MsgFlags; /* 0x07 */
  378. U8 VP_ID; /* 0x08 */
  379. U8 VF_ID; /* 0x09 */
  380. U16 Reserved4; /* 0x0A */
  381. } MPI2_PORT_ENABLE_REQUEST, MPI2_POINTER PTR_MPI2_PORT_ENABLE_REQUEST,
  382. Mpi2PortEnableRequest_t, MPI2_POINTER pMpi2PortEnableRequest_t;
  383. /* PortEnable Reply message */
  384. typedef struct _MPI2_PORT_ENABLE_REPLY
  385. {
  386. U16 Reserved1; /* 0x00 */
  387. U8 MsgLength; /* 0x02 */
  388. U8 Function; /* 0x03 */
  389. U8 Reserved2; /* 0x04 */
  390. U8 PortFlags; /* 0x05 */
  391. U8 Reserved3; /* 0x06 */
  392. U8 MsgFlags; /* 0x07 */
  393. U8 VP_ID; /* 0x08 */
  394. U8 VF_ID; /* 0x09 */
  395. U16 Reserved4; /* 0x0A */
  396. U16 Reserved5; /* 0x0C */
  397. U16 IOCStatus; /* 0x0E */
  398. U32 IOCLogInfo; /* 0x10 */
  399. } MPI2_PORT_ENABLE_REPLY, MPI2_POINTER PTR_MPI2_PORT_ENABLE_REPLY,
  400. Mpi2PortEnableReply_t, MPI2_POINTER pMpi2PortEnableReply_t;
  401. /****************************************************************************
  402. * EventNotification message
  403. ****************************************************************************/
  404. /* EventNotification Request message */
  405. #define MPI2_EVENT_NOTIFY_EVENTMASK_WORDS (4)
  406. typedef struct _MPI2_EVENT_NOTIFICATION_REQUEST
  407. {
  408. U16 Reserved1; /* 0x00 */
  409. U8 ChainOffset; /* 0x02 */
  410. U8 Function; /* 0x03 */
  411. U16 Reserved2; /* 0x04 */
  412. U8 Reserved3; /* 0x06 */
  413. U8 MsgFlags; /* 0x07 */
  414. U8 VP_ID; /* 0x08 */
  415. U8 VF_ID; /* 0x09 */
  416. U16 Reserved4; /* 0x0A */
  417. U32 Reserved5; /* 0x0C */
  418. U32 Reserved6; /* 0x10 */
  419. U32 EventMasks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];/* 0x14 */
  420. U16 SASBroadcastPrimitiveMasks; /* 0x24 */
  421. U16 SASNotifyPrimitiveMasks; /* 0x26 */
  422. U32 Reserved8; /* 0x28 */
  423. } MPI2_EVENT_NOTIFICATION_REQUEST,
  424. MPI2_POINTER PTR_MPI2_EVENT_NOTIFICATION_REQUEST,
  425. Mpi2EventNotificationRequest_t, MPI2_POINTER pMpi2EventNotificationRequest_t;
  426. /* EventNotification Reply message */
  427. typedef struct _MPI2_EVENT_NOTIFICATION_REPLY
  428. {
  429. U16 EventDataLength; /* 0x00 */
  430. U8 MsgLength; /* 0x02 */
  431. U8 Function; /* 0x03 */
  432. U16 Reserved1; /* 0x04 */
  433. U8 AckRequired; /* 0x06 */
  434. U8 MsgFlags; /* 0x07 */
  435. U8 VP_ID; /* 0x08 */
  436. U8 VF_ID; /* 0x09 */
  437. U16 Reserved2; /* 0x0A */
  438. U16 Reserved3; /* 0x0C */
  439. U16 IOCStatus; /* 0x0E */
  440. U32 IOCLogInfo; /* 0x10 */
  441. U16 Event; /* 0x14 */
  442. U16 Reserved4; /* 0x16 */
  443. U32 EventContext; /* 0x18 */
  444. U32 EventData[1]; /* 0x1C */
  445. } MPI2_EVENT_NOTIFICATION_REPLY, MPI2_POINTER PTR_MPI2_EVENT_NOTIFICATION_REPLY,
  446. Mpi2EventNotificationReply_t, MPI2_POINTER pMpi2EventNotificationReply_t;
  447. /* AckRequired */
  448. #define MPI2_EVENT_NOTIFICATION_ACK_NOT_REQUIRED (0x00)
  449. #define MPI2_EVENT_NOTIFICATION_ACK_REQUIRED (0x01)
  450. /* Event */
  451. #define MPI2_EVENT_LOG_DATA (0x0001)
  452. #define MPI2_EVENT_STATE_CHANGE (0x0002)
  453. #define MPI2_EVENT_HARD_RESET_RECEIVED (0x0005)
  454. #define MPI2_EVENT_EVENT_CHANGE (0x000A)
  455. #define MPI2_EVENT_TASK_SET_FULL (0x000E) /* obsolete */
  456. #define MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE (0x000F)
  457. #define MPI2_EVENT_IR_OPERATION_STATUS (0x0014)
  458. #define MPI2_EVENT_SAS_DISCOVERY (0x0016)
  459. #define MPI2_EVENT_SAS_BROADCAST_PRIMITIVE (0x0017)
  460. #define MPI2_EVENT_SAS_INIT_DEVICE_STATUS_CHANGE (0x0018)
  461. #define MPI2_EVENT_SAS_INIT_TABLE_OVERFLOW (0x0019)
  462. #define MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST (0x001C)
  463. #define MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE (0x001D)
  464. #define MPI2_EVENT_IR_VOLUME (0x001E)
  465. #define MPI2_EVENT_IR_PHYSICAL_DISK (0x001F)
  466. #define MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST (0x0020)
  467. #define MPI2_EVENT_LOG_ENTRY_ADDED (0x0021)
  468. #define MPI2_EVENT_SAS_PHY_COUNTER (0x0022)
  469. #define MPI2_EVENT_GPIO_INTERRUPT (0x0023)
  470. #define MPI2_EVENT_HOST_BASED_DISCOVERY_PHY (0x0024)
  471. #define MPI2_EVENT_SAS_QUIESCE (0x0025)
  472. #define MPI2_EVENT_SAS_NOTIFY_PRIMITIVE (0x0026)
  473. #define MPI2_EVENT_TEMP_THRESHOLD (0x0027)
  474. #define MPI2_EVENT_HOST_MESSAGE (0x0028)
  475. #define MPI2_EVENT_MIN_PRODUCT_SPECIFIC (0x006E)
  476. #define MPI2_EVENT_MAX_PRODUCT_SPECIFIC (0x007F)
  477. /* Log Entry Added Event data */
  478. /* the following structure matches MPI2_LOG_0_ENTRY in mpi2_cnfg.h */
  479. #define MPI2_EVENT_DATA_LOG_DATA_LENGTH (0x1C)
  480. typedef struct _MPI2_EVENT_DATA_LOG_ENTRY_ADDED
  481. {
  482. U64 TimeStamp; /* 0x00 */
  483. U32 Reserved1; /* 0x08 */
  484. U16 LogSequence; /* 0x0C */
  485. U16 LogEntryQualifier; /* 0x0E */
  486. U8 VP_ID; /* 0x10 */
  487. U8 VF_ID; /* 0x11 */
  488. U16 Reserved2; /* 0x12 */
  489. U8 LogData[MPI2_EVENT_DATA_LOG_DATA_LENGTH];/* 0x14 */
  490. } MPI2_EVENT_DATA_LOG_ENTRY_ADDED,
  491. MPI2_POINTER PTR_MPI2_EVENT_DATA_LOG_ENTRY_ADDED,
  492. Mpi2EventDataLogEntryAdded_t, MPI2_POINTER pMpi2EventDataLogEntryAdded_t;
  493. /* GPIO Interrupt Event data */
  494. typedef struct _MPI2_EVENT_DATA_GPIO_INTERRUPT {
  495. U8 GPIONum; /* 0x00 */
  496. U8 Reserved1; /* 0x01 */
  497. U16 Reserved2; /* 0x02 */
  498. } MPI2_EVENT_DATA_GPIO_INTERRUPT,
  499. MPI2_POINTER PTR_MPI2_EVENT_DATA_GPIO_INTERRUPT,
  500. Mpi2EventDataGpioInterrupt_t, MPI2_POINTER pMpi2EventDataGpioInterrupt_t;
  501. /* Temperature Threshold Event data */
  502. typedef struct _MPI2_EVENT_DATA_TEMPERATURE {
  503. U16 Status; /* 0x00 */
  504. U8 SensorNum; /* 0x02 */
  505. U8 Reserved1; /* 0x03 */
  506. U16 CurrentTemperature; /* 0x04 */
  507. U16 Reserved2; /* 0x06 */
  508. U32 Reserved3; /* 0x08 */
  509. U32 Reserved4; /* 0x0C */
  510. } MPI2_EVENT_DATA_TEMPERATURE,
  511. MPI2_POINTER PTR_MPI2_EVENT_DATA_TEMPERATURE,
  512. Mpi2EventDataTemperature_t, MPI2_POINTER pMpi2EventDataTemperature_t;
  513. /* Temperature Threshold Event data Status bits */
  514. #define MPI2_EVENT_TEMPERATURE3_EXCEEDED (0x0008)
  515. #define MPI2_EVENT_TEMPERATURE2_EXCEEDED (0x0004)
  516. #define MPI2_EVENT_TEMPERATURE1_EXCEEDED (0x0002)
  517. #define MPI2_EVENT_TEMPERATURE0_EXCEEDED (0x0001)
  518. /* Host Message Event data */
  519. typedef struct _MPI2_EVENT_DATA_HOST_MESSAGE {
  520. U8 SourceVF_ID; /* 0x00 */
  521. U8 Reserved1; /* 0x01 */
  522. U16 Reserved2; /* 0x02 */
  523. U32 Reserved3; /* 0x04 */
  524. U32 HostData[1]; /* 0x08 */
  525. } MPI2_EVENT_DATA_HOST_MESSAGE, MPI2_POINTER PTR_MPI2_EVENT_DATA_HOST_MESSAGE,
  526. Mpi2EventDataHostMessage_t, MPI2_POINTER pMpi2EventDataHostMessage_t;
  527. /* Hard Reset Received Event data */
  528. typedef struct _MPI2_EVENT_DATA_HARD_RESET_RECEIVED
  529. {
  530. U8 Reserved1; /* 0x00 */
  531. U8 Port; /* 0x01 */
  532. U16 Reserved2; /* 0x02 */
  533. } MPI2_EVENT_DATA_HARD_RESET_RECEIVED,
  534. MPI2_POINTER PTR_MPI2_EVENT_DATA_HARD_RESET_RECEIVED,
  535. Mpi2EventDataHardResetReceived_t,
  536. MPI2_POINTER pMpi2EventDataHardResetReceived_t;
  537. /* Task Set Full Event data */
  538. /* this event is obsolete */
  539. typedef struct _MPI2_EVENT_DATA_TASK_SET_FULL
  540. {
  541. U16 DevHandle; /* 0x00 */
  542. U16 CurrentDepth; /* 0x02 */
  543. } MPI2_EVENT_DATA_TASK_SET_FULL, MPI2_POINTER PTR_MPI2_EVENT_DATA_TASK_SET_FULL,
  544. Mpi2EventDataTaskSetFull_t, MPI2_POINTER pMpi2EventDataTaskSetFull_t;
  545. /* SAS Device Status Change Event data */
  546. typedef struct _MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE
  547. {
  548. U16 TaskTag; /* 0x00 */
  549. U8 ReasonCode; /* 0x02 */
  550. U8 PhysicalPort; /* 0x03 */
  551. U8 ASC; /* 0x04 */
  552. U8 ASCQ; /* 0x05 */
  553. U16 DevHandle; /* 0x06 */
  554. U32 Reserved2; /* 0x08 */
  555. U64 SASAddress; /* 0x0C */
  556. U8 LUN[8]; /* 0x14 */
  557. } MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE,
  558. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE,
  559. Mpi2EventDataSasDeviceStatusChange_t,
  560. MPI2_POINTER pMpi2EventDataSasDeviceStatusChange_t;
  561. /* SAS Device Status Change Event data ReasonCode values */
  562. #define MPI2_EVENT_SAS_DEV_STAT_RC_SMART_DATA (0x05)
  563. #define MPI2_EVENT_SAS_DEV_STAT_RC_UNSUPPORTED (0x07)
  564. #define MPI2_EVENT_SAS_DEV_STAT_RC_INTERNAL_DEVICE_RESET (0x08)
  565. #define MPI2_EVENT_SAS_DEV_STAT_RC_TASK_ABORT_INTERNAL (0x09)
  566. #define MPI2_EVENT_SAS_DEV_STAT_RC_ABORT_TASK_SET_INTERNAL (0x0A)
  567. #define MPI2_EVENT_SAS_DEV_STAT_RC_CLEAR_TASK_SET_INTERNAL (0x0B)
  568. #define MPI2_EVENT_SAS_DEV_STAT_RC_QUERY_TASK_INTERNAL (0x0C)
  569. #define MPI2_EVENT_SAS_DEV_STAT_RC_ASYNC_NOTIFICATION (0x0D)
  570. #define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_INTERNAL_DEV_RESET (0x0E)
  571. #define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_TASK_ABORT_INTERNAL (0x0F)
  572. #define MPI2_EVENT_SAS_DEV_STAT_RC_SATA_INIT_FAILURE (0x10)
  573. #define MPI2_EVENT_SAS_DEV_STAT_RC_EXPANDER_REDUCED_FUNCTIONALITY (0x11)
  574. #define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_EXPANDER_REDUCED_FUNCTIONALITY (0x12)
  575. /* Integrated RAID Operation Status Event data */
  576. typedef struct _MPI2_EVENT_DATA_IR_OPERATION_STATUS
  577. {
  578. U16 VolDevHandle; /* 0x00 */
  579. U16 Reserved1; /* 0x02 */
  580. U8 RAIDOperation; /* 0x04 */
  581. U8 PercentComplete; /* 0x05 */
  582. U16 Reserved2; /* 0x06 */
  583. U32 ElapsedSeconds; /* 0x08 */
  584. } MPI2_EVENT_DATA_IR_OPERATION_STATUS,
  585. MPI2_POINTER PTR_MPI2_EVENT_DATA_IR_OPERATION_STATUS,
  586. Mpi2EventDataIrOperationStatus_t,
  587. MPI2_POINTER pMpi2EventDataIrOperationStatus_t;
  588. /* Integrated RAID Operation Status Event data RAIDOperation values */
  589. #define MPI2_EVENT_IR_RAIDOP_RESYNC (0x00)
  590. #define MPI2_EVENT_IR_RAIDOP_ONLINE_CAP_EXPANSION (0x01)
  591. #define MPI2_EVENT_IR_RAIDOP_CONSISTENCY_CHECK (0x02)
  592. #define MPI2_EVENT_IR_RAIDOP_BACKGROUND_INIT (0x03)
  593. #define MPI2_EVENT_IR_RAIDOP_MAKE_DATA_CONSISTENT (0x04)
  594. /* Integrated RAID Volume Event data */
  595. typedef struct _MPI2_EVENT_DATA_IR_VOLUME
  596. {
  597. U16 VolDevHandle; /* 0x00 */
  598. U8 ReasonCode; /* 0x02 */
  599. U8 Reserved1; /* 0x03 */
  600. U32 NewValue; /* 0x04 */
  601. U32 PreviousValue; /* 0x08 */
  602. } MPI2_EVENT_DATA_IR_VOLUME, MPI2_POINTER PTR_MPI2_EVENT_DATA_IR_VOLUME,
  603. Mpi2EventDataIrVolume_t, MPI2_POINTER pMpi2EventDataIrVolume_t;
  604. /* Integrated RAID Volume Event data ReasonCode values */
  605. #define MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED (0x01)
  606. #define MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED (0x02)
  607. #define MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED (0x03)
  608. /* Integrated RAID Physical Disk Event data */
  609. typedef struct _MPI2_EVENT_DATA_IR_PHYSICAL_DISK
  610. {
  611. U16 Reserved1; /* 0x00 */
  612. U8 ReasonCode; /* 0x02 */
  613. U8 PhysDiskNum; /* 0x03 */
  614. U16 PhysDiskDevHandle; /* 0x04 */
  615. U16 Reserved2; /* 0x06 */
  616. U16 Slot; /* 0x08 */
  617. U16 EnclosureHandle; /* 0x0A */
  618. U32 NewValue; /* 0x0C */
  619. U32 PreviousValue; /* 0x10 */
  620. } MPI2_EVENT_DATA_IR_PHYSICAL_DISK,
  621. MPI2_POINTER PTR_MPI2_EVENT_DATA_IR_PHYSICAL_DISK,
  622. Mpi2EventDataIrPhysicalDisk_t, MPI2_POINTER pMpi2EventDataIrPhysicalDisk_t;
  623. /* Integrated RAID Physical Disk Event data ReasonCode values */
  624. #define MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED (0x01)
  625. #define MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED (0x02)
  626. #define MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED (0x03)
  627. /* Integrated RAID Configuration Change List Event data */
  628. /*
  629. * Host code (drivers, BIOS, utilities, etc.) should leave this define set to
  630. * one and check NumElements at runtime.
  631. */
  632. #ifndef MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT
  633. #define MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT (1)
  634. #endif
  635. typedef struct _MPI2_EVENT_IR_CONFIG_ELEMENT
  636. {
  637. U16 ElementFlags; /* 0x00 */
  638. U16 VolDevHandle; /* 0x02 */
  639. U8 ReasonCode; /* 0x04 */
  640. U8 PhysDiskNum; /* 0x05 */
  641. U16 PhysDiskDevHandle; /* 0x06 */
  642. } MPI2_EVENT_IR_CONFIG_ELEMENT, MPI2_POINTER PTR_MPI2_EVENT_IR_CONFIG_ELEMENT,
  643. Mpi2EventIrConfigElement_t, MPI2_POINTER pMpi2EventIrConfigElement_t;
  644. /* IR Configuration Change List Event data ElementFlags values */
  645. #define MPI2_EVENT_IR_CHANGE_EFLAGS_ELEMENT_TYPE_MASK (0x000F)
  646. #define MPI2_EVENT_IR_CHANGE_EFLAGS_VOLUME_ELEMENT (0x0000)
  647. #define MPI2_EVENT_IR_CHANGE_EFLAGS_VOLPHYSDISK_ELEMENT (0x0001)
  648. #define MPI2_EVENT_IR_CHANGE_EFLAGS_HOTSPARE_ELEMENT (0x0002)
  649. /* IR Configuration Change List Event data ReasonCode values */
  650. #define MPI2_EVENT_IR_CHANGE_RC_ADDED (0x01)
  651. #define MPI2_EVENT_IR_CHANGE_RC_REMOVED (0x02)
  652. #define MPI2_EVENT_IR_CHANGE_RC_NO_CHANGE (0x03)
  653. #define MPI2_EVENT_IR_CHANGE_RC_HIDE (0x04)
  654. #define MPI2_EVENT_IR_CHANGE_RC_UNHIDE (0x05)
  655. #define MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED (0x06)
  656. #define MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED (0x07)
  657. #define MPI2_EVENT_IR_CHANGE_RC_PD_CREATED (0x08)
  658. #define MPI2_EVENT_IR_CHANGE_RC_PD_DELETED (0x09)
  659. typedef struct _MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST
  660. {
  661. U8 NumElements; /* 0x00 */
  662. U8 Reserved1; /* 0x01 */
  663. U8 Reserved2; /* 0x02 */
  664. U8 ConfigNum; /* 0x03 */
  665. U32 Flags; /* 0x04 */
  666. MPI2_EVENT_IR_CONFIG_ELEMENT ConfigElement[MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT]; /* 0x08 */
  667. } MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST,
  668. MPI2_POINTER PTR_MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST,
  669. Mpi2EventDataIrConfigChangeList_t,
  670. MPI2_POINTER pMpi2EventDataIrConfigChangeList_t;
  671. /* IR Configuration Change List Event data Flags values */
  672. #define MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG (0x00000001)
  673. /* SAS Discovery Event data */
  674. typedef struct _MPI2_EVENT_DATA_SAS_DISCOVERY
  675. {
  676. U8 Flags; /* 0x00 */
  677. U8 ReasonCode; /* 0x01 */
  678. U8 PhysicalPort; /* 0x02 */
  679. U8 Reserved1; /* 0x03 */
  680. U32 DiscoveryStatus; /* 0x04 */
  681. } MPI2_EVENT_DATA_SAS_DISCOVERY,
  682. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_DISCOVERY,
  683. Mpi2EventDataSasDiscovery_t, MPI2_POINTER pMpi2EventDataSasDiscovery_t;
  684. /* SAS Discovery Event data Flags values */
  685. #define MPI2_EVENT_SAS_DISC_DEVICE_CHANGE (0x02)
  686. #define MPI2_EVENT_SAS_DISC_IN_PROGRESS (0x01)
  687. /* SAS Discovery Event data ReasonCode values */
  688. #define MPI2_EVENT_SAS_DISC_RC_STARTED (0x01)
  689. #define MPI2_EVENT_SAS_DISC_RC_COMPLETED (0x02)
  690. /* SAS Discovery Event data DiscoveryStatus values */
  691. #define MPI2_EVENT_SAS_DISC_DS_MAX_ENCLOSURES_EXCEED (0x80000000)
  692. #define MPI2_EVENT_SAS_DISC_DS_MAX_EXPANDERS_EXCEED (0x40000000)
  693. #define MPI2_EVENT_SAS_DISC_DS_MAX_DEVICES_EXCEED (0x20000000)
  694. #define MPI2_EVENT_SAS_DISC_DS_MAX_TOPO_PHYS_EXCEED (0x10000000)
  695. #define MPI2_EVENT_SAS_DISC_DS_DOWNSTREAM_INITIATOR (0x08000000)
  696. #define MPI2_EVENT_SAS_DISC_DS_MULTI_SUBTRACTIVE_SUBTRACTIVE (0x00008000)
  697. #define MPI2_EVENT_SAS_DISC_DS_EXP_MULTI_SUBTRACTIVE (0x00004000)
  698. #define MPI2_EVENT_SAS_DISC_DS_MULTI_PORT_DOMAIN (0x00002000)
  699. #define MPI2_EVENT_SAS_DISC_DS_TABLE_TO_SUBTRACTIVE_LINK (0x00001000)
  700. #define MPI2_EVENT_SAS_DISC_DS_UNSUPPORTED_DEVICE (0x00000800)
  701. #define MPI2_EVENT_SAS_DISC_DS_TABLE_LINK (0x00000400)
  702. #define MPI2_EVENT_SAS_DISC_DS_SUBTRACTIVE_LINK (0x00000200)
  703. #define MPI2_EVENT_SAS_DISC_DS_SMP_CRC_ERROR (0x00000100)
  704. #define MPI2_EVENT_SAS_DISC_DS_SMP_FUNCTION_FAILED (0x00000080)
  705. #define MPI2_EVENT_SAS_DISC_DS_INDEX_NOT_EXIST (0x00000040)
  706. #define MPI2_EVENT_SAS_DISC_DS_OUT_ROUTE_ENTRIES (0x00000020)
  707. #define MPI2_EVENT_SAS_DISC_DS_SMP_TIMEOUT (0x00000010)
  708. #define MPI2_EVENT_SAS_DISC_DS_MULTIPLE_PORTS (0x00000004)
  709. #define MPI2_EVENT_SAS_DISC_DS_UNADDRESSABLE_DEVICE (0x00000002)
  710. #define MPI2_EVENT_SAS_DISC_DS_LOOP_DETECTED (0x00000001)
  711. /* SAS Broadcast Primitive Event data */
  712. typedef struct _MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE
  713. {
  714. U8 PhyNum; /* 0x00 */
  715. U8 Port; /* 0x01 */
  716. U8 PortWidth; /* 0x02 */
  717. U8 Primitive; /* 0x03 */
  718. } MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE,
  719. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE,
  720. Mpi2EventDataSasBroadcastPrimitive_t,
  721. MPI2_POINTER pMpi2EventDataSasBroadcastPrimitive_t;
  722. /* defines for the Primitive field */
  723. #define MPI2_EVENT_PRIMITIVE_CHANGE (0x01)
  724. #define MPI2_EVENT_PRIMITIVE_SES (0x02)
  725. #define MPI2_EVENT_PRIMITIVE_EXPANDER (0x03)
  726. #define MPI2_EVENT_PRIMITIVE_ASYNCHRONOUS_EVENT (0x04)
  727. #define MPI2_EVENT_PRIMITIVE_RESERVED3 (0x05)
  728. #define MPI2_EVENT_PRIMITIVE_RESERVED4 (0x06)
  729. #define MPI2_EVENT_PRIMITIVE_CHANGE0_RESERVED (0x07)
  730. #define MPI2_EVENT_PRIMITIVE_CHANGE1_RESERVED (0x08)
  731. /* SAS Notify Primitive Event data */
  732. typedef struct _MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE {
  733. U8 PhyNum; /* 0x00 */
  734. U8 Port; /* 0x01 */
  735. U8 Reserved1; /* 0x02 */
  736. U8 Primitive; /* 0x03 */
  737. } MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE,
  738. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE,
  739. Mpi2EventDataSasNotifyPrimitive_t,
  740. MPI2_POINTER pMpi2EventDataSasNotifyPrimitive_t;
  741. /* defines for the Primitive field */
  742. #define MPI2_EVENT_NOTIFY_ENABLE_SPINUP (0x01)
  743. #define MPI2_EVENT_NOTIFY_POWER_LOSS_EXPECTED (0x02)
  744. #define MPI2_EVENT_NOTIFY_RESERVED1 (0x03)
  745. #define MPI2_EVENT_NOTIFY_RESERVED2 (0x04)
  746. /* SAS Initiator Device Status Change Event data */
  747. typedef struct _MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE
  748. {
  749. U8 ReasonCode; /* 0x00 */
  750. U8 PhysicalPort; /* 0x01 */
  751. U16 DevHandle; /* 0x02 */
  752. U64 SASAddress; /* 0x04 */
  753. } MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE,
  754. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE,
  755. Mpi2EventDataSasInitDevStatusChange_t,
  756. MPI2_POINTER pMpi2EventDataSasInitDevStatusChange_t;
  757. /* SAS Initiator Device Status Change event ReasonCode values */
  758. #define MPI2_EVENT_SAS_INIT_RC_ADDED (0x01)
  759. #define MPI2_EVENT_SAS_INIT_RC_NOT_RESPONDING (0x02)
  760. /* SAS Initiator Device Table Overflow Event data */
  761. typedef struct _MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW
  762. {
  763. U16 MaxInit; /* 0x00 */
  764. U16 CurrentInit; /* 0x02 */
  765. U64 SASAddress; /* 0x04 */
  766. } MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW,
  767. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW,
  768. Mpi2EventDataSasInitTableOverflow_t,
  769. MPI2_POINTER pMpi2EventDataSasInitTableOverflow_t;
  770. /* SAS Topology Change List Event data */
  771. /*
  772. * Host code (drivers, BIOS, utilities, etc.) should leave this define set to
  773. * one and check NumEntries at runtime.
  774. */
  775. #ifndef MPI2_EVENT_SAS_TOPO_PHY_COUNT
  776. #define MPI2_EVENT_SAS_TOPO_PHY_COUNT (1)
  777. #endif
  778. typedef struct _MPI2_EVENT_SAS_TOPO_PHY_ENTRY
  779. {
  780. U16 AttachedDevHandle; /* 0x00 */
  781. U8 LinkRate; /* 0x02 */
  782. U8 PhyStatus; /* 0x03 */
  783. } MPI2_EVENT_SAS_TOPO_PHY_ENTRY, MPI2_POINTER PTR_MPI2_EVENT_SAS_TOPO_PHY_ENTRY,
  784. Mpi2EventSasTopoPhyEntry_t, MPI2_POINTER pMpi2EventSasTopoPhyEntry_t;
  785. typedef struct _MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST
  786. {
  787. U16 EnclosureHandle; /* 0x00 */
  788. U16 ExpanderDevHandle; /* 0x02 */
  789. U8 NumPhys; /* 0x04 */
  790. U8 Reserved1; /* 0x05 */
  791. U16 Reserved2; /* 0x06 */
  792. U8 NumEntries; /* 0x08 */
  793. U8 StartPhyNum; /* 0x09 */
  794. U8 ExpStatus; /* 0x0A */
  795. U8 PhysicalPort; /* 0x0B */
  796. MPI2_EVENT_SAS_TOPO_PHY_ENTRY PHY[MPI2_EVENT_SAS_TOPO_PHY_COUNT]; /* 0x0C*/
  797. } MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST,
  798. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST,
  799. Mpi2EventDataSasTopologyChangeList_t,
  800. MPI2_POINTER pMpi2EventDataSasTopologyChangeList_t;
  801. /* values for the ExpStatus field */
  802. #define MPI2_EVENT_SAS_TOPO_ES_NO_EXPANDER (0x00)
  803. #define MPI2_EVENT_SAS_TOPO_ES_ADDED (0x01)
  804. #define MPI2_EVENT_SAS_TOPO_ES_NOT_RESPONDING (0x02)
  805. #define MPI2_EVENT_SAS_TOPO_ES_RESPONDING (0x03)
  806. #define MPI2_EVENT_SAS_TOPO_ES_DELAY_NOT_RESPONDING (0x04)
  807. /* defines for the LinkRate field */
  808. #define MPI2_EVENT_SAS_TOPO_LR_CURRENT_MASK (0xF0)
  809. #define MPI2_EVENT_SAS_TOPO_LR_CURRENT_SHIFT (4)
  810. #define MPI2_EVENT_SAS_TOPO_LR_PREV_MASK (0x0F)
  811. #define MPI2_EVENT_SAS_TOPO_LR_PREV_SHIFT (0)
  812. #define MPI2_EVENT_SAS_TOPO_LR_UNKNOWN_LINK_RATE (0x00)
  813. #define MPI2_EVENT_SAS_TOPO_LR_PHY_DISABLED (0x01)
  814. #define MPI2_EVENT_SAS_TOPO_LR_NEGOTIATION_FAILED (0x02)
  815. #define MPI2_EVENT_SAS_TOPO_LR_SATA_OOB_COMPLETE (0x03)
  816. #define MPI2_EVENT_SAS_TOPO_LR_PORT_SELECTOR (0x04)
  817. #define MPI2_EVENT_SAS_TOPO_LR_SMP_RESET_IN_PROGRESS (0x05)
  818. #define MPI2_EVENT_SAS_TOPO_LR_UNSUPPORTED_PHY (0x06)
  819. #define MPI2_EVENT_SAS_TOPO_LR_RATE_1_5 (0x08)
  820. #define MPI2_EVENT_SAS_TOPO_LR_RATE_3_0 (0x09)
  821. #define MPI2_EVENT_SAS_TOPO_LR_RATE_6_0 (0x0A)
  822. /* values for the PhyStatus field */
  823. #define MPI2_EVENT_SAS_TOPO_PHYSTATUS_VACANT (0x80)
  824. #define MPI2_EVENT_SAS_TOPO_PS_MULTIPLEX_CHANGE (0x10)
  825. /* values for the PhyStatus ReasonCode sub-field */
  826. #define MPI2_EVENT_SAS_TOPO_RC_MASK (0x0F)
  827. #define MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED (0x01)
  828. #define MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING (0x02)
  829. #define MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED (0x03)
  830. #define MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE (0x04)
  831. #define MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING (0x05)
  832. /* SAS Enclosure Device Status Change Event data */
  833. typedef struct _MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE
  834. {
  835. U16 EnclosureHandle; /* 0x00 */
  836. U8 ReasonCode; /* 0x02 */
  837. U8 PhysicalPort; /* 0x03 */
  838. U64 EnclosureLogicalID; /* 0x04 */
  839. U16 NumSlots; /* 0x0C */
  840. U16 StartSlot; /* 0x0E */
  841. U32 PhyBits; /* 0x10 */
  842. } MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE,
  843. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE,
  844. Mpi2EventDataSasEnclDevStatusChange_t,
  845. MPI2_POINTER pMpi2EventDataSasEnclDevStatusChange_t;
  846. /* SAS Enclosure Device Status Change event ReasonCode values */
  847. #define MPI2_EVENT_SAS_ENCL_RC_ADDED (0x01)
  848. #define MPI2_EVENT_SAS_ENCL_RC_NOT_RESPONDING (0x02)
  849. /* SAS PHY Counter Event data */
  850. typedef struct _MPI2_EVENT_DATA_SAS_PHY_COUNTER {
  851. U64 TimeStamp; /* 0x00 */
  852. U32 Reserved1; /* 0x08 */
  853. U8 PhyEventCode; /* 0x0C */
  854. U8 PhyNum; /* 0x0D */
  855. U16 Reserved2; /* 0x0E */
  856. U32 PhyEventInfo; /* 0x10 */
  857. U8 CounterType; /* 0x14 */
  858. U8 ThresholdWindow; /* 0x15 */
  859. U8 TimeUnits; /* 0x16 */
  860. U8 Reserved3; /* 0x17 */
  861. U32 EventThreshold; /* 0x18 */
  862. U16 ThresholdFlags; /* 0x1C */
  863. U16 Reserved4; /* 0x1E */
  864. } MPI2_EVENT_DATA_SAS_PHY_COUNTER,
  865. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_PHY_COUNTER,
  866. Mpi2EventDataSasPhyCounter_t, MPI2_POINTER pMpi2EventDataSasPhyCounter_t;
  867. /* use MPI2_SASPHY3_EVENT_CODE_ values from mpi2_cnfg.h for the
  868. * PhyEventCode field
  869. * use MPI2_SASPHY3_COUNTER_TYPE_ values from mpi2_cnfg.h for the
  870. * CounterType field
  871. * use MPI2_SASPHY3_TIME_UNITS_ values from mpi2_cnfg.h for the
  872. * TimeUnits field
  873. * use MPI2_SASPHY3_TFLAGS_ values from mpi2_cnfg.h for the
  874. * ThresholdFlags field
  875. * */
  876. /* SAS Quiesce Event data */
  877. typedef struct _MPI2_EVENT_DATA_SAS_QUIESCE {
  878. U8 ReasonCode; /* 0x00 */
  879. U8 Reserved1; /* 0x01 */
  880. U16 Reserved2; /* 0x02 */
  881. U32 Reserved3; /* 0x04 */
  882. } MPI2_EVENT_DATA_SAS_QUIESCE,
  883. MPI2_POINTER PTR_MPI2_EVENT_DATA_SAS_QUIESCE,
  884. Mpi2EventDataSasQuiesce_t, MPI2_POINTER pMpi2EventDataSasQuiesce_t;
  885. /* SAS Quiesce Event data ReasonCode values */
  886. #define MPI2_EVENT_SAS_QUIESCE_RC_STARTED (0x01)
  887. #define MPI2_EVENT_SAS_QUIESCE_RC_COMPLETED (0x02)
  888. /* Host Based Discovery Phy Event data */
  889. typedef struct _MPI2_EVENT_HBD_PHY_SAS {
  890. U8 Flags; /* 0x00 */
  891. U8 NegotiatedLinkRate; /* 0x01 */
  892. U8 PhyNum; /* 0x02 */
  893. U8 PhysicalPort; /* 0x03 */
  894. U32 Reserved1; /* 0x04 */
  895. U8 InitialFrame[28]; /* 0x08 */
  896. } MPI2_EVENT_HBD_PHY_SAS, MPI2_POINTER PTR_MPI2_EVENT_HBD_PHY_SAS,
  897. Mpi2EventHbdPhySas_t, MPI2_POINTER pMpi2EventHbdPhySas_t;
  898. /* values for the Flags field */
  899. #define MPI2_EVENT_HBD_SAS_FLAGS_FRAME_VALID (0x02)
  900. #define MPI2_EVENT_HBD_SAS_FLAGS_SATA_FRAME (0x01)
  901. /* use MPI2_SAS_NEG_LINK_RATE_ defines from mpi2_cnfg.h for
  902. * the NegotiatedLinkRate field */
  903. typedef union _MPI2_EVENT_HBD_DESCRIPTOR {
  904. MPI2_EVENT_HBD_PHY_SAS Sas;
  905. } MPI2_EVENT_HBD_DESCRIPTOR, MPI2_POINTER PTR_MPI2_EVENT_HBD_DESCRIPTOR,
  906. Mpi2EventHbdDescriptor_t, MPI2_POINTER pMpi2EventHbdDescriptor_t;
  907. typedef struct _MPI2_EVENT_DATA_HBD_PHY {
  908. U8 DescriptorType; /* 0x00 */
  909. U8 Reserved1; /* 0x01 */
  910. U16 Reserved2; /* 0x02 */
  911. U32 Reserved3; /* 0x04 */
  912. MPI2_EVENT_HBD_DESCRIPTOR Descriptor; /* 0x08 */
  913. } MPI2_EVENT_DATA_HBD_PHY, MPI2_POINTER PTR_MPI2_EVENT_DATA_HBD_PHY,
  914. Mpi2EventDataHbdPhy_t, MPI2_POINTER pMpi2EventDataMpi2EventDataHbdPhy_t;
  915. /* values for the DescriptorType field */
  916. #define MPI2_EVENT_HBD_DT_SAS (0x01)
  917. /****************************************************************************
  918. * EventAck message
  919. ****************************************************************************/
  920. /* EventAck Request message */
  921. typedef struct _MPI2_EVENT_ACK_REQUEST
  922. {
  923. U16 Reserved1; /* 0x00 */
  924. U8 ChainOffset; /* 0x02 */
  925. U8 Function; /* 0x03 */
  926. U16 Reserved2; /* 0x04 */
  927. U8 Reserved3; /* 0x06 */
  928. U8 MsgFlags; /* 0x07 */
  929. U8 VP_ID; /* 0x08 */
  930. U8 VF_ID; /* 0x09 */
  931. U16 Reserved4; /* 0x0A */
  932. U16 Event; /* 0x0C */
  933. U16 Reserved5; /* 0x0E */
  934. U32 EventContext; /* 0x10 */
  935. } MPI2_EVENT_ACK_REQUEST, MPI2_POINTER PTR_MPI2_EVENT_ACK_REQUEST,
  936. Mpi2EventAckRequest_t, MPI2_POINTER pMpi2EventAckRequest_t;
  937. /* EventAck Reply message */
  938. typedef struct _MPI2_EVENT_ACK_REPLY
  939. {
  940. U16 Reserved1; /* 0x00 */
  941. U8 MsgLength; /* 0x02 */
  942. U8 Function; /* 0x03 */
  943. U16 Reserved2; /* 0x04 */
  944. U8 Reserved3; /* 0x06 */
  945. U8 MsgFlags; /* 0x07 */
  946. U8 VP_ID; /* 0x08 */
  947. U8 VF_ID; /* 0x09 */
  948. U16 Reserved4; /* 0x0A */
  949. U16 Reserved5; /* 0x0C */
  950. U16 IOCStatus; /* 0x0E */
  951. U32 IOCLogInfo; /* 0x10 */
  952. } MPI2_EVENT_ACK_REPLY, MPI2_POINTER PTR_MPI2_EVENT_ACK_REPLY,
  953. Mpi2EventAckReply_t, MPI2_POINTER pMpi2EventAckReply_t;
  954. /****************************************************************************
  955. * SendHostMessage message
  956. ****************************************************************************/
  957. /* SendHostMessage Request message */
  958. typedef struct _MPI2_SEND_HOST_MESSAGE_REQUEST {
  959. U16 HostDataLength; /* 0x00 */
  960. U8 ChainOffset; /* 0x02 */
  961. U8 Function; /* 0x03 */
  962. U16 Reserved1; /* 0x04 */
  963. U8 Reserved2; /* 0x06 */
  964. U8 MsgFlags; /* 0x07 */
  965. U8 VP_ID; /* 0x08 */
  966. U8 VF_ID; /* 0x09 */
  967. U16 Reserved3; /* 0x0A */
  968. U8 Reserved4; /* 0x0C */
  969. U8 DestVF_ID; /* 0x0D */
  970. U16 Reserved5; /* 0x0E */
  971. U32 Reserved6; /* 0x10 */
  972. U32 Reserved7; /* 0x14 */
  973. U32 Reserved8; /* 0x18 */
  974. U32 Reserved9; /* 0x1C */
  975. U32 Reserved10; /* 0x20 */
  976. U32 HostData[1]; /* 0x24 */
  977. } MPI2_SEND_HOST_MESSAGE_REQUEST,
  978. MPI2_POINTER PTR_MPI2_SEND_HOST_MESSAGE_REQUEST,
  979. Mpi2SendHostMessageRequest_t, MPI2_POINTER pMpi2SendHostMessageRequest_t;
  980. /* SendHostMessage Reply message */
  981. typedef struct _MPI2_SEND_HOST_MESSAGE_REPLY {
  982. U16 HostDataLength; /* 0x00 */
  983. U8 MsgLength; /* 0x02 */
  984. U8 Function; /* 0x03 */
  985. U16 Reserved1; /* 0x04 */
  986. U8 Reserved2; /* 0x06 */
  987. U8 MsgFlags; /* 0x07 */
  988. U8 VP_ID; /* 0x08 */
  989. U8 VF_ID; /* 0x09 */
  990. U16 Reserved3; /* 0x0A */
  991. U16 Reserved4; /* 0x0C */
  992. U16 IOCStatus; /* 0x0E */
  993. U32 IOCLogInfo; /* 0x10 */
  994. } MPI2_SEND_HOST_MESSAGE_REPLY, MPI2_POINTER PTR_MPI2_SEND_HOST_MESSAGE_REPLY,
  995. Mpi2SendHostMessageReply_t, MPI2_POINTER pMpi2SendHostMessageReply_t;
  996. /****************************************************************************
  997. * FWDownload message
  998. ****************************************************************************/
  999. /* FWDownload Request message */
  1000. typedef struct _MPI2_FW_DOWNLOAD_REQUEST
  1001. {
  1002. U8 ImageType; /* 0x00 */
  1003. U8 Reserved1; /* 0x01 */
  1004. U8 ChainOffset; /* 0x02 */
  1005. U8 Function; /* 0x03 */
  1006. U16 Reserved2; /* 0x04 */
  1007. U8 Reserved3; /* 0x06 */
  1008. U8 MsgFlags; /* 0x07 */
  1009. U8 VP_ID; /* 0x08 */
  1010. U8 VF_ID; /* 0x09 */
  1011. U16 Reserved4; /* 0x0A */
  1012. U32 TotalImageSize; /* 0x0C */
  1013. U32 Reserved5; /* 0x10 */
  1014. MPI2_MPI_SGE_UNION SGL; /* 0x14 */
  1015. } MPI2_FW_DOWNLOAD_REQUEST, MPI2_POINTER PTR_MPI2_FW_DOWNLOAD_REQUEST,
  1016. Mpi2FWDownloadRequest, MPI2_POINTER pMpi2FWDownloadRequest;
  1017. #define MPI2_FW_DOWNLOAD_MSGFLGS_LAST_SEGMENT (0x01)
  1018. #define MPI2_FW_DOWNLOAD_ITYPE_FW (0x01)
  1019. #define MPI2_FW_DOWNLOAD_ITYPE_BIOS (0x02)
  1020. #define MPI2_FW_DOWNLOAD_ITYPE_MANUFACTURING (0x06)
  1021. #define MPI2_FW_DOWNLOAD_ITYPE_CONFIG_1 (0x07)
  1022. #define MPI2_FW_DOWNLOAD_ITYPE_CONFIG_2 (0x08)
  1023. #define MPI2_FW_DOWNLOAD_ITYPE_MEGARAID (0x09)
  1024. #define MPI2_FW_DOWNLOAD_ITYPE_COMPLETE (0x0A)
  1025. #define MPI2_FW_DOWNLOAD_ITYPE_COMMON_BOOT_BLOCK (0x0B)
  1026. #define MPI2_FW_DOWNLOAD_ITYPE_PUBLIC_KEY (0x0C)
  1027. #define MPI2_FW_DOWNLOAD_ITYPE_MIN_PRODUCT_SPECIFIC (0xF0)
  1028. /* FWDownload TransactionContext Element */
  1029. typedef struct _MPI2_FW_DOWNLOAD_TCSGE
  1030. {
  1031. U8 Reserved1; /* 0x00 */
  1032. U8 ContextSize; /* 0x01 */
  1033. U8 DetailsLength; /* 0x02 */
  1034. U8 Flags; /* 0x03 */
  1035. U32 Reserved2; /* 0x04 */
  1036. U32 ImageOffset; /* 0x08 */
  1037. U32 ImageSize; /* 0x0C */
  1038. } MPI2_FW_DOWNLOAD_TCSGE, MPI2_POINTER PTR_MPI2_FW_DOWNLOAD_TCSGE,
  1039. Mpi2FWDownloadTCSGE_t, MPI2_POINTER pMpi2FWDownloadTCSGE_t;
  1040. /* FWDownload Reply message */
  1041. typedef struct _MPI2_FW_DOWNLOAD_REPLY
  1042. {
  1043. U8 ImageType; /* 0x00 */
  1044. U8 Reserved1; /* 0x01 */
  1045. U8 MsgLength; /* 0x02 */
  1046. U8 Function; /* 0x03 */
  1047. U16 Reserved2; /* 0x04 */
  1048. U8 Reserved3; /* 0x06 */
  1049. U8 MsgFlags; /* 0x07 */
  1050. U8 VP_ID; /* 0x08 */
  1051. U8 VF_ID; /* 0x09 */
  1052. U16 Reserved4; /* 0x0A */
  1053. U16 Reserved5; /* 0x0C */
  1054. U16 IOCStatus; /* 0x0E */
  1055. U32 IOCLogInfo; /* 0x10 */
  1056. } MPI2_FW_DOWNLOAD_REPLY, MPI2_POINTER PTR_MPI2_FW_DOWNLOAD_REPLY,
  1057. Mpi2FWDownloadReply_t, MPI2_POINTER pMpi2FWDownloadReply_t;
  1058. /****************************************************************************
  1059. * FWUpload message
  1060. ****************************************************************************/
  1061. /* FWUpload Request message */
  1062. typedef struct _MPI2_FW_UPLOAD_REQUEST
  1063. {
  1064. U8 ImageType; /* 0x00 */
  1065. U8 Reserved1; /* 0x01 */
  1066. U8 ChainOffset; /* 0x02 */
  1067. U8 Function; /* 0x03 */
  1068. U16 Reserved2; /* 0x04 */
  1069. U8 Reserved3; /* 0x06 */
  1070. U8 MsgFlags; /* 0x07 */
  1071. U8 VP_ID; /* 0x08 */
  1072. U8 VF_ID; /* 0x09 */
  1073. U16 Reserved4; /* 0x0A */
  1074. U32 Reserved5; /* 0x0C */
  1075. U32 Reserved6; /* 0x10 */
  1076. MPI2_MPI_SGE_UNION SGL; /* 0x14 */
  1077. } MPI2_FW_UPLOAD_REQUEST, MPI2_POINTER PTR_MPI2_FW_UPLOAD_REQUEST,
  1078. Mpi2FWUploadRequest_t, MPI2_POINTER pMpi2FWUploadRequest_t;
  1079. #define MPI2_FW_UPLOAD_ITYPE_FW_CURRENT (0x00)
  1080. #define MPI2_FW_UPLOAD_ITYPE_FW_FLASH (0x01)
  1081. #define MPI2_FW_UPLOAD_ITYPE_BIOS_FLASH (0x02)
  1082. #define MPI2_FW_UPLOAD_ITYPE_FW_BACKUP (0x05)
  1083. #define MPI2_FW_UPLOAD_ITYPE_MANUFACTURING (0x06)
  1084. #define MPI2_FW_UPLOAD_ITYPE_CONFIG_1 (0x07)
  1085. #define MPI2_FW_UPLOAD_ITYPE_CONFIG_2 (0x08)
  1086. #define MPI2_FW_UPLOAD_ITYPE_MEGARAID (0x09)
  1087. #define MPI2_FW_UPLOAD_ITYPE_COMPLETE (0x0A)
  1088. #define MPI2_FW_UPLOAD_ITYPE_COMMON_BOOT_BLOCK (0x0B)
  1089. typedef struct _MPI2_FW_UPLOAD_TCSGE
  1090. {
  1091. U8 Reserved1; /* 0x00 */
  1092. U8 ContextSize; /* 0x01 */
  1093. U8 DetailsLength; /* 0x02 */
  1094. U8 Flags; /* 0x03 */
  1095. U32 Reserved2; /* 0x04 */
  1096. U32 ImageOffset; /* 0x08 */
  1097. U32 ImageSize; /* 0x0C */
  1098. } MPI2_FW_UPLOAD_TCSGE, MPI2_POINTER PTR_MPI2_FW_UPLOAD_TCSGE,
  1099. Mpi2FWUploadTCSGE_t, MPI2_POINTER pMpi2FWUploadTCSGE_t;
  1100. /* FWUpload Reply message */
  1101. typedef struct _MPI2_FW_UPLOAD_REPLY
  1102. {
  1103. U8 ImageType; /* 0x00 */
  1104. U8 Reserved1; /* 0x01 */
  1105. U8 MsgLength; /* 0x02 */
  1106. U8 Function; /* 0x03 */
  1107. U16 Reserved2; /* 0x04 */
  1108. U8 Reserved3; /* 0x06 */
  1109. U8 MsgFlags; /* 0x07 */
  1110. U8 VP_ID; /* 0x08 */
  1111. U8 VF_ID; /* 0x09 */
  1112. U16 Reserved4; /* 0x0A */
  1113. U16 Reserved5; /* 0x0C */
  1114. U16 IOCStatus; /* 0x0E */
  1115. U32 IOCLogInfo; /* 0x10 */
  1116. U32 ActualImageSize; /* 0x14 */
  1117. } MPI2_FW_UPLOAD_REPLY, MPI2_POINTER PTR_MPI2_FW_UPLOAD_REPLY,
  1118. Mpi2FWUploadReply_t, MPI2_POINTER pMPi2FWUploadReply_t;
  1119. /* FW Image Header */
  1120. typedef struct _MPI2_FW_IMAGE_HEADER
  1121. {
  1122. U32 Signature; /* 0x00 */
  1123. U32 Signature0; /* 0x04 */
  1124. U32 Signature1; /* 0x08 */
  1125. U32 Signature2; /* 0x0C */
  1126. MPI2_VERSION_UNION MPIVersion; /* 0x10 */
  1127. MPI2_VERSION_UNION FWVersion; /* 0x14 */
  1128. MPI2_VERSION_UNION NVDATAVersion; /* 0x18 */
  1129. MPI2_VERSION_UNION PackageVersion; /* 0x1C */
  1130. U16 VendorID; /* 0x20 */
  1131. U16 ProductID; /* 0x22 */
  1132. U16 ProtocolFlags; /* 0x24 */
  1133. U16 Reserved26; /* 0x26 */
  1134. U32 IOCCapabilities; /* 0x28 */
  1135. U32 ImageSize; /* 0x2C */
  1136. U32 NextImageHeaderOffset; /* 0x30 */
  1137. U32 Checksum; /* 0x34 */
  1138. U32 Reserved38; /* 0x38 */
  1139. U32 Reserved3C; /* 0x3C */
  1140. U32 Reserved40; /* 0x40 */
  1141. U32 Reserved44; /* 0x44 */
  1142. U32 Reserved48; /* 0x48 */
  1143. U32 Reserved4C; /* 0x4C */
  1144. U32 Reserved50; /* 0x50 */
  1145. U32 Reserved54; /* 0x54 */
  1146. U32 Reserved58; /* 0x58 */
  1147. U32 Reserved5C; /* 0x5C */
  1148. U32 Reserved60; /* 0x60 */
  1149. U32 FirmwareVersionNameWhat; /* 0x64 */
  1150. U8 FirmwareVersionName[32]; /* 0x68 */
  1151. U32 VendorNameWhat; /* 0x88 */
  1152. U8 VendorName[32]; /* 0x8C */
  1153. U32 PackageNameWhat; /* 0x88 */
  1154. U8 PackageName[32]; /* 0x8C */
  1155. U32 ReservedD0; /* 0xD0 */
  1156. U32 ReservedD4; /* 0xD4 */
  1157. U32 ReservedD8; /* 0xD8 */
  1158. U32 ReservedDC; /* 0xDC */
  1159. U32 ReservedE0; /* 0xE0 */
  1160. U32 ReservedE4; /* 0xE4 */
  1161. U32 ReservedE8; /* 0xE8 */
  1162. U32 ReservedEC; /* 0xEC */
  1163. U32 ReservedF0; /* 0xF0 */
  1164. U32 ReservedF4; /* 0xF4 */
  1165. U32 ReservedF8; /* 0xF8 */
  1166. U32 ReservedFC; /* 0xFC */
  1167. } MPI2_FW_IMAGE_HEADER, MPI2_POINTER PTR_MPI2_FW_IMAGE_HEADER,
  1168. Mpi2FWImageHeader_t, MPI2_POINTER pMpi2FWImageHeader_t;
  1169. /* Signature field */
  1170. #define MPI2_FW_HEADER_SIGNATURE_OFFSET (0x00)
  1171. #define MPI2_FW_HEADER_SIGNATURE_MASK (0xFF000000)
  1172. #define MPI2_FW_HEADER_SIGNATURE (0xEA000000)
  1173. /* Signature0 field */
  1174. #define MPI2_FW_HEADER_SIGNATURE0_OFFSET (0x04)
  1175. #define MPI2_FW_HEADER_SIGNATURE0 (0x5AFAA55A)
  1176. /* Signature1 field */
  1177. #define MPI2_FW_HEADER_SIGNATURE1_OFFSET (0x08)
  1178. #define MPI2_FW_HEADER_SIGNATURE1 (0xA55AFAA5)
  1179. /* Signature2 field */
  1180. #define MPI2_FW_HEADER_SIGNATURE2_OFFSET (0x0C)
  1181. #define MPI2_FW_HEADER_SIGNATURE2 (0x5AA55AFA)
  1182. /* defines for using the ProductID field */
  1183. #define MPI2_FW_HEADER_PID_TYPE_MASK (0xF000)
  1184. #define MPI2_FW_HEADER_PID_TYPE_SAS (0x2000)
  1185. #define MPI2_FW_HEADER_PID_PROD_MASK (0x0F00)
  1186. #define MPI2_FW_HEADER_PID_PROD_A (0x0000)
  1187. #define MPI2_FW_HEADER_PID_PROD_TARGET_INITIATOR_SCSI (0x0200)
  1188. #define MPI2_FW_HEADER_PID_PROD_IR_SCSI (0x0700)
  1189. #define MPI2_FW_HEADER_PID_FAMILY_MASK (0x00FF)
  1190. /* SAS */
  1191. #define MPI2_FW_HEADER_PID_FAMILY_2108_SAS (0x0013)
  1192. #define MPI2_FW_HEADER_PID_FAMILY_2208_SAS (0x0014)
  1193. /* use MPI2_IOCFACTS_PROTOCOL_ defines for ProtocolFlags field */
  1194. /* use MPI2_IOCFACTS_CAPABILITY_ defines for IOCCapabilities field */
  1195. #define MPI2_FW_HEADER_IMAGESIZE_OFFSET (0x2C)
  1196. #define MPI2_FW_HEADER_NEXTIMAGE_OFFSET (0x30)
  1197. #define MPI2_FW_HEADER_VERNMHWAT_OFFSET (0x64)
  1198. #define MPI2_FW_HEADER_WHAT_SIGNATURE (0x29232840)
  1199. #define MPI2_FW_HEADER_SIZE (0x100)
  1200. /* Extended Image Header */
  1201. typedef struct _MPI2_EXT_IMAGE_HEADER
  1202. {
  1203. U8 ImageType; /* 0x00 */
  1204. U8 Reserved1; /* 0x01 */
  1205. U16 Reserved2; /* 0x02 */
  1206. U32 Checksum; /* 0x04 */
  1207. U32 ImageSize; /* 0x08 */
  1208. U32 NextImageHeaderOffset; /* 0x0C */
  1209. U32 PackageVersion; /* 0x10 */
  1210. U32 Reserved3; /* 0x14 */
  1211. U32 Reserved4; /* 0x18 */
  1212. U32 Reserved5; /* 0x1C */
  1213. U8 IdentifyString[32]; /* 0x20 */
  1214. } MPI2_EXT_IMAGE_HEADER, MPI2_POINTER PTR_MPI2_EXT_IMAGE_HEADER,
  1215. Mpi2ExtImageHeader_t, MPI2_POINTER pMpi2ExtImageHeader_t;
  1216. /* useful offsets */
  1217. #define MPI2_EXT_IMAGE_IMAGETYPE_OFFSET (0x00)
  1218. #define MPI2_EXT_IMAGE_IMAGESIZE_OFFSET (0x08)
  1219. #define MPI2_EXT_IMAGE_NEXTIMAGE_OFFSET (0x0C)
  1220. #define MPI2_EXT_IMAGE_HEADER_SIZE (0x40)
  1221. /* defines for the ImageType field */
  1222. #define MPI2_EXT_IMAGE_TYPE_UNSPECIFIED (0x00)
  1223. #define MPI2_EXT_IMAGE_TYPE_FW (0x01)
  1224. #define MPI2_EXT_IMAGE_TYPE_NVDATA (0x03)
  1225. #define MPI2_EXT_IMAGE_TYPE_BOOTLOADER (0x04)
  1226. #define MPI2_EXT_IMAGE_TYPE_INITIALIZATION (0x05)
  1227. #define MPI2_EXT_IMAGE_TYPE_FLASH_LAYOUT (0x06)
  1228. #define MPI2_EXT_IMAGE_TYPE_SUPPORTED_DEVICES (0x07)
  1229. #define MPI2_EXT_IMAGE_TYPE_MEGARAID (0x08)
  1230. #define MPI2_EXT_IMAGE_TYPE_ENCRYPTED_HASH (0x09)
  1231. #define MPI2_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC (0x80)
  1232. #define MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC (0xFF)
  1233. #define MPI2_EXT_IMAGE_TYPE_MAX \
  1234. (MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC) /* deprecated */
  1235. /* FLASH Layout Extended Image Data */
  1236. /*
  1237. * Host code (drivers, BIOS, utilities, etc.) should leave this define set to
  1238. * one and check RegionsPerLayout at runtime.
  1239. */
  1240. #ifndef MPI2_FLASH_NUMBER_OF_REGIONS
  1241. #define MPI2_FLASH_NUMBER_OF_REGIONS (1)
  1242. #endif
  1243. /*
  1244. * Host code (drivers, BIOS, utilities, etc.) should leave this define set to
  1245. * one and check NumberOfLayouts at runtime.
  1246. */
  1247. #ifndef MPI2_FLASH_NUMBER_OF_LAYOUTS
  1248. #define MPI2_FLASH_NUMBER_OF_LAYOUTS (1)
  1249. #endif
  1250. typedef struct _MPI2_FLASH_REGION
  1251. {
  1252. U8 RegionType; /* 0x00 */
  1253. U8 Reserved1; /* 0x01 */
  1254. U16 Reserved2; /* 0x02 */
  1255. U32 RegionOffset; /* 0x04 */
  1256. U32 RegionSize; /* 0x08 */
  1257. U32 Reserved3; /* 0x0C */
  1258. } MPI2_FLASH_REGION, MPI2_POINTER PTR_MPI2_FLASH_REGION,
  1259. Mpi2FlashRegion_t, MPI2_POINTER pMpi2FlashRegion_t;
  1260. typedef struct _MPI2_FLASH_LAYOUT
  1261. {
  1262. U32 FlashSize; /* 0x00 */
  1263. U32 Reserved1; /* 0x04 */
  1264. U32 Reserved2; /* 0x08 */
  1265. U32 Reserved3; /* 0x0C */
  1266. MPI2_FLASH_REGION Region[MPI2_FLASH_NUMBER_OF_REGIONS];/* 0x10 */
  1267. } MPI2_FLASH_LAYOUT, MPI2_POINTER PTR_MPI2_FLASH_LAYOUT,
  1268. Mpi2FlashLayout_t, MPI2_POINTER pMpi2FlashLayout_t;
  1269. typedef struct _MPI2_FLASH_LAYOUT_DATA
  1270. {
  1271. U8 ImageRevision; /* 0x00 */
  1272. U8 Reserved1; /* 0x01 */
  1273. U8 SizeOfRegion; /* 0x02 */
  1274. U8 Reserved2; /* 0x03 */
  1275. U16 NumberOfLayouts; /* 0x04 */
  1276. U16 RegionsPerLayout; /* 0x06 */
  1277. U16 MinimumSectorAlignment; /* 0x08 */
  1278. U16 Reserved3; /* 0x0A */
  1279. U32 Reserved4; /* 0x0C */
  1280. MPI2_FLASH_LAYOUT Layout[MPI2_FLASH_NUMBER_OF_LAYOUTS];/* 0x10 */
  1281. } MPI2_FLASH_LAYOUT_DATA, MPI2_POINTER PTR_MPI2_FLASH_LAYOUT_DATA,
  1282. Mpi2FlashLayoutData_t, MPI2_POINTER pMpi2FlashLayoutData_t;
  1283. /* defines for the RegionType field */
  1284. #define MPI2_FLASH_REGION_UNUSED (0x00)
  1285. #define MPI2_FLASH_REGION_FIRMWARE (0x01)
  1286. #define MPI2_FLASH_REGION_BIOS (0x02)
  1287. #define MPI2_FLASH_REGION_NVDATA (0x03)
  1288. #define MPI2_FLASH_REGION_FIRMWARE_BACKUP (0x05)
  1289. #define MPI2_FLASH_REGION_MFG_INFORMATION (0x06)
  1290. #define MPI2_FLASH_REGION_CONFIG_1 (0x07)
  1291. #define MPI2_FLASH_REGION_CONFIG_2 (0x08)
  1292. #define MPI2_FLASH_REGION_MEGARAID (0x09)
  1293. #define MPI2_FLASH_REGION_INIT (0x0A)
  1294. /* ImageRevision */
  1295. #define MPI2_FLASH_LAYOUT_IMAGE_REVISION (0x00)
  1296. /* Supported Devices Extended Image Data */
  1297. /*
  1298. * Host code (drivers, BIOS, utilities, etc.) should leave this define set to
  1299. * one and check NumberOfDevices at runtime.
  1300. */
  1301. #ifndef MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES
  1302. #define MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES (1)
  1303. #endif
  1304. typedef struct _MPI2_SUPPORTED_DEVICE
  1305. {
  1306. U16 DeviceID; /* 0x00 */
  1307. U16 VendorID; /* 0x02 */
  1308. U16 DeviceIDMask; /* 0x04 */
  1309. U16 Reserved1; /* 0x06 */
  1310. U8 LowPCIRev; /* 0x08 */
  1311. U8 HighPCIRev; /* 0x09 */
  1312. U16 Reserved2; /* 0x0A */
  1313. U32 Reserved3; /* 0x0C */
  1314. } MPI2_SUPPORTED_DEVICE, MPI2_POINTER PTR_MPI2_SUPPORTED_DEVICE,
  1315. Mpi2SupportedDevice_t, MPI2_POINTER pMpi2SupportedDevice_t;
  1316. typedef struct _MPI2_SUPPORTED_DEVICES_DATA
  1317. {
  1318. U8 ImageRevision; /* 0x00 */
  1319. U8 Reserved1; /* 0x01 */
  1320. U8 NumberOfDevices; /* 0x02 */
  1321. U8 Reserved2; /* 0x03 */
  1322. U32 Reserved3; /* 0x04 */
  1323. MPI2_SUPPORTED_DEVICE SupportedDevice[MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES]; /* 0x08 */
  1324. } MPI2_SUPPORTED_DEVICES_DATA, MPI2_POINTER PTR_MPI2_SUPPORTED_DEVICES_DATA,
  1325. Mpi2SupportedDevicesData_t, MPI2_POINTER pMpi2SupportedDevicesData_t;
  1326. /* ImageRevision */
  1327. #define MPI2_SUPPORTED_DEVICES_IMAGE_REVISION (0x00)
  1328. /* Init Extended Image Data */
  1329. typedef struct _MPI2_INIT_IMAGE_FOOTER
  1330. {
  1331. U32 BootFlags; /* 0x00 */
  1332. U32 ImageSize; /* 0x04 */
  1333. U32 Signature0; /* 0x08 */
  1334. U32 Signature1; /* 0x0C */
  1335. U32 Signature2; /* 0x10 */
  1336. U32 ResetVector; /* 0x14 */
  1337. } MPI2_INIT_IMAGE_FOOTER, MPI2_POINTER PTR_MPI2_INIT_IMAGE_FOOTER,
  1338. Mpi2InitImageFooter_t, MPI2_POINTER pMpi2InitImageFooter_t;
  1339. /* defines for the BootFlags field */
  1340. #define MPI2_INIT_IMAGE_BOOTFLAGS_OFFSET (0x00)
  1341. /* defines for the ImageSize field */
  1342. #define MPI2_INIT_IMAGE_IMAGESIZE_OFFSET (0x04)
  1343. /* defines for the Signature0 field */
  1344. #define MPI2_INIT_IMAGE_SIGNATURE0_OFFSET (0x08)
  1345. #define MPI2_INIT_IMAGE_SIGNATURE0 (0x5AA55AEA)
  1346. /* defines for the Signature1 field */
  1347. #define MPI2_INIT_IMAGE_SIGNATURE1_OFFSET (0x0C)
  1348. #define MPI2_INIT_IMAGE_SIGNATURE1 (0xA55AEAA5)
  1349. /* defines for the Signature2 field */
  1350. #define MPI2_INIT_IMAGE_SIGNATURE2_OFFSET (0x10)
  1351. #define MPI2_INIT_IMAGE_SIGNATURE2 (0x5AEAA55A)
  1352. /* Signature fields as individual bytes */
  1353. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_0 (0xEA)
  1354. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_1 (0x5A)
  1355. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_2 (0xA5)
  1356. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_3 (0x5A)
  1357. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_4 (0xA5)
  1358. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_5 (0xEA)
  1359. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_6 (0x5A)
  1360. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_7 (0xA5)
  1361. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_8 (0x5A)
  1362. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_9 (0xA5)
  1363. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_A (0xEA)
  1364. #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_B (0x5A)
  1365. /* defines for the ResetVector field */
  1366. #define MPI2_INIT_IMAGE_RESETVECTOR_OFFSET (0x14)
  1367. /* Encrypted Hash Extended Image Data */
  1368. typedef struct _MPI25_ENCRYPTED_HASH_ENTRY {
  1369. U8 HashImageType; /* 0x00 */
  1370. U8 HashAlgorithm; /* 0x01 */
  1371. U8 EncryptionAlgorithm; /* 0x02 */
  1372. U8 Reserved1; /* 0x03 */
  1373. U32 Reserved2; /* 0x04 */
  1374. U32 EncryptedHash[1]; /* 0x08 */
  1375. } MPI25_ENCRYPTED_HASH_ENTRY, MPI2_POINTER PTR_MPI25_ENCRYPTED_HASH_ENTRY,
  1376. Mpi25EncryptedHashEntry_t, MPI2_POINTER pMpi25EncryptedHashEntry_t;
  1377. /* values for HashImageType */
  1378. #define MPI25_HASH_IMAGE_TYPE_UNUSED (0x00)
  1379. #define MPI25_HASH_IMAGE_TYPE_FIRMWARE (0x01)
  1380. #define MPI25_HASH_IMAGE_TYPE_BIOS (0x02)
  1381. /* values for HashAlgorithm */
  1382. #define MPI25_HASH_ALGORITHM_UNUSED (0x00)
  1383. #define MPI25_HASH_ALGORITHM_SHA256 (0x01)
  1384. /* values for EncryptionAlgorithm */
  1385. #define MPI25_ENCRYPTION_ALG_UNUSED (0x00)
  1386. #define MPI25_ENCRYPTION_ALG_RSA256 (0x01)
  1387. typedef struct _MPI25_ENCRYPTED_HASH_DATA {
  1388. U8 ImageVersion; /* 0x00 */
  1389. U8 NumHash; /* 0x01 */
  1390. U16 Reserved1; /* 0x02 */
  1391. U32 Reserved2; /* 0x04 */
  1392. MPI25_ENCRYPTED_HASH_ENTRY EncryptedHashEntry[1]; /* 0x08 */
  1393. } MPI25_ENCRYPTED_HASH_DATA, MPI2_POINTER PTR_MPI25_ENCRYPTED_HASH_DATA,
  1394. Mpi25EncryptedHashData_t, MPI2_POINTER pMpi25EncryptedHashData_t;
  1395. /****************************************************************************
  1396. * PowerManagementControl message
  1397. ****************************************************************************/
  1398. /* PowerManagementControl Request message */
  1399. typedef struct _MPI2_PWR_MGMT_CONTROL_REQUEST {
  1400. U8 Feature; /* 0x00 */
  1401. U8 Reserved1; /* 0x01 */
  1402. U8 ChainOffset; /* 0x02 */
  1403. U8 Function; /* 0x03 */
  1404. U16 Reserved2; /* 0x04 */
  1405. U8 Reserved3; /* 0x06 */
  1406. U8 MsgFlags; /* 0x07 */
  1407. U8 VP_ID; /* 0x08 */
  1408. U8 VF_ID; /* 0x09 */
  1409. U16 Reserved4; /* 0x0A */
  1410. U8 Parameter1; /* 0x0C */
  1411. U8 Parameter2; /* 0x0D */
  1412. U8 Parameter3; /* 0x0E */
  1413. U8 Parameter4; /* 0x0F */
  1414. U32 Reserved5; /* 0x10 */
  1415. U32 Reserved6; /* 0x14 */
  1416. } MPI2_PWR_MGMT_CONTROL_REQUEST, MPI2_POINTER PTR_MPI2_PWR_MGMT_CONTROL_REQUEST,
  1417. Mpi2PwrMgmtControlRequest_t, MPI2_POINTER pMpi2PwrMgmtControlRequest_t;
  1418. /* defines for the Feature field */
  1419. #define MPI2_PM_CONTROL_FEATURE_DA_PHY_POWER_COND (0x01)
  1420. #define MPI2_PM_CONTROL_FEATURE_PORT_WIDTH_MODULATION (0x02)
  1421. #define MPI2_PM_CONTROL_FEATURE_PCIE_LINK (0x03) /* obsolete */
  1422. #define MPI2_PM_CONTROL_FEATURE_IOC_SPEED (0x04)
  1423. #define MPI2_PM_CONTROL_FEATURE_MIN_PRODUCT_SPECIFIC (0x80)
  1424. #define MPI2_PM_CONTROL_FEATURE_MAX_PRODUCT_SPECIFIC (0xFF)
  1425. /* parameter usage for the MPI2_PM_CONTROL_FEATURE_DA_PHY_POWER_COND Feature */
  1426. /* Parameter1 contains a PHY number */
  1427. /* Parameter2 indicates power condition action using these defines */
  1428. #define MPI2_PM_CONTROL_PARAM2_PARTIAL (0x01)
  1429. #define MPI2_PM_CONTROL_PARAM2_SLUMBER (0x02)
  1430. #define MPI2_PM_CONTROL_PARAM2_EXIT_PWR_MGMT (0x03)
  1431. /* Parameter3 and Parameter4 are reserved */
  1432. /* parameter usage for the MPI2_PM_CONTROL_FEATURE_PORT_WIDTH_MODULATION
  1433. * Feature */
  1434. /* Parameter1 contains SAS port width modulation group number */
  1435. /* Parameter2 indicates IOC action using these defines */
  1436. #define MPI2_PM_CONTROL_PARAM2_REQUEST_OWNERSHIP (0x01)
  1437. #define MPI2_PM_CONTROL_PARAM2_CHANGE_MODULATION (0x02)
  1438. #define MPI2_PM_CONTROL_PARAM2_RELINQUISH_OWNERSHIP (0x03)
  1439. /* Parameter3 indicates desired modulation level using these defines */
  1440. #define MPI2_PM_CONTROL_PARAM3_25_PERCENT (0x00)
  1441. #define MPI2_PM_CONTROL_PARAM3_50_PERCENT (0x01)
  1442. #define MPI2_PM_CONTROL_PARAM3_75_PERCENT (0x02)
  1443. #define MPI2_PM_CONTROL_PARAM3_100_PERCENT (0x03)
  1444. /* Parameter4 is reserved */
  1445. /* parameter usage for the MPI2_PM_CONTROL_FEATURE_PCIE_LINK Feature */
  1446. /* Parameter1 indicates desired PCIe link speed using these defines */
  1447. #define MPI2_PM_CONTROL_PARAM1_PCIE_2_5_GBPS (0x00) /* obsolete */
  1448. #define MPI2_PM_CONTROL_PARAM1_PCIE_5_0_GBPS (0x01) /* obsolete */
  1449. #define MPI2_PM_CONTROL_PARAM1_PCIE_8_0_GBPS (0x02) /* obsolete */
  1450. /* Parameter2 indicates desired PCIe link width using these defines */
  1451. #define MPI2_PM_CONTROL_PARAM2_WIDTH_X1 (0x01) /* obsolete */
  1452. #define MPI2_PM_CONTROL_PARAM2_WIDTH_X2 (0x02) /* obsolete */
  1453. #define MPI2_PM_CONTROL_PARAM2_WIDTH_X4 (0x04) /* obsolete */
  1454. #define MPI2_PM_CONTROL_PARAM2_WIDTH_X8 (0x08) /* obsolete */
  1455. /* Parameter3 and Parameter4 are reserved */
  1456. /* parameter usage for the MPI2_PM_CONTROL_FEATURE_IOC_SPEED Feature */
  1457. /* Parameter1 indicates desired IOC hardware clock speed using these defines */
  1458. #define MPI2_PM_CONTROL_PARAM1_FULL_IOC_SPEED (0x01)
  1459. #define MPI2_PM_CONTROL_PARAM1_HALF_IOC_SPEED (0x02)
  1460. #define MPI2_PM_CONTROL_PARAM1_QUARTER_IOC_SPEED (0x04)
  1461. #define MPI2_PM_CONTROL_PARAM1_EIGHTH_IOC_SPEED (0x08)
  1462. /* Parameter2, Parameter3, and Parameter4 are reserved */
  1463. /* PowerManagementControl Reply message */
  1464. typedef struct _MPI2_PWR_MGMT_CONTROL_REPLY {
  1465. U8 Feature; /* 0x00 */
  1466. U8 Reserved1; /* 0x01 */
  1467. U8 MsgLength; /* 0x02 */
  1468. U8 Function; /* 0x03 */
  1469. U16 Reserved2; /* 0x04 */
  1470. U8 Reserved3; /* 0x06 */
  1471. U8 MsgFlags; /* 0x07 */
  1472. U8 VP_ID; /* 0x08 */
  1473. U8 VF_ID; /* 0x09 */
  1474. U16 Reserved4; /* 0x0A */
  1475. U16 Reserved5; /* 0x0C */
  1476. U16 IOCStatus; /* 0x0E */
  1477. U32 IOCLogInfo; /* 0x10 */
  1478. } MPI2_PWR_MGMT_CONTROL_REPLY, MPI2_POINTER PTR_MPI2_PWR_MGMT_CONTROL_REPLY,
  1479. Mpi2PwrMgmtControlReply_t, MPI2_POINTER pMpi2PwrMgmtControlReply_t;
  1480. #endif