1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright 2000-2020 Broadcom Inc. All rights reserved.
4 *
5 *
6 *          Name:  mpi2_ioc.h
7 *         Title:  MPI IOC, Port, Event, FW Download, and FW Upload messages
8 * Creation Date:  October 11, 2006
9 *
10 * mpi2_ioc.h Version:  02.00.37
11 *
12 * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
13 *       prefix are for use only on MPI v2.5 products, and must not be used
14 *       with MPI v2.0 products. Unless otherwise noted, names beginning with
15 *       MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
16 *
17 * Version History
18 * ---------------
19 *
20 * Date      Version   Description
21 * --------  --------  ------------------------------------------------------
22 * 04-30-07  02.00.00  Corresponds to Fusion-MPT MPI Specification Rev A.
23 * 06-04-07  02.00.01  In IOCFacts Reply structure, renamed MaxDevices to
24 *                     MaxTargets.
25 *                     Added TotalImageSize field to FWDownload Request.
26 *                     Added reserved words to FWUpload Request.
27 * 06-26-07  02.00.02  Added IR Configuration Change List Event.
28 * 08-31-07  02.00.03  Removed SystemReplyQueueDepth field from the IOCInit
29 *                     request and replaced it with
30 *                     ReplyDescriptorPostQueueDepth and ReplyFreeQueueDepth.
31 *                     Replaced the MinReplyQueueDepth field of the IOCFacts
32 *                     reply with MaxReplyDescriptorPostQueueDepth.
33 *                     Added MPI2_RDPQ_DEPTH_MIN define to specify the minimum
34 *                     depth for the Reply Descriptor Post Queue.
35 *                     Added SASAddress field to Initiator Device Table
36 *                     Overflow Event data.
37 * 10-31-07  02.00.04  Added ReasonCode MPI2_EVENT_SAS_INIT_RC_NOT_RESPONDING
38 *                     for SAS Initiator Device Status Change Event data.
39 *                     Modified Reason Code defines for SAS Topology Change
40 *                     List Event data, including adding a bit for PHY Vacant
41 *                     status, and adding a mask for the Reason Code.
42 *                     Added define for
43 *                     MPI2_EVENT_SAS_TOPO_ES_DELAY_NOT_RESPONDING.
44 *                     Added define for MPI2_EXT_IMAGE_TYPE_MEGARAID.
45 * 12-18-07  02.00.05  Added Boot Status defines for the IOCExceptions field of
46 *                     the IOCFacts Reply.
47 *                     Removed MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER define.
48 *                     Moved MPI2_VERSION_UNION to mpi2.h.
49 *                     Changed MPI2_EVENT_NOTIFICATION_REQUEST to use masks
50 *                     instead of enables, and added SASBroadcastPrimitiveMasks
51 *                     field.
52 *                     Added Log Entry Added Event and related structure.
53 * 02-29-08  02.00.06  Added define MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID.
54 *                     Removed define MPI2_IOCFACTS_PROTOCOL_SMP_TARGET.
55 *                     Added MaxVolumes and MaxPersistentEntries fields to
56 *                     IOCFacts reply.
57 *                     Added ProtocalFlags and IOCCapabilities fields to
58 *                     MPI2_FW_IMAGE_HEADER.
59 *                     Removed MPI2_PORTENABLE_FLAGS_ENABLE_SINGLE_PORT.
60 * 03-03-08  02.00.07  Fixed MPI2_FW_IMAGE_HEADER by changing Reserved26 to
61 *                     a U16 (from a U32).
62 *                     Removed extra 's' from EventMasks name.
63 * 06-27-08  02.00.08  Fixed an offset in a comment.
64 * 10-02-08  02.00.09  Removed SystemReplyFrameSize from MPI2_IOC_INIT_REQUEST.
65 *                     Removed CurReplyFrameSize from MPI2_IOC_FACTS_REPLY and
66 *                     renamed MinReplyFrameSize to ReplyFrameSize.
67 *                     Added MPI2_IOCFACTS_EXCEPT_IR_FOREIGN_CONFIG_MAX.
68 *                     Added two new RAIDOperation values for Integrated RAID
69 *                     Operations Status Event data.
70 *                     Added four new IR Configuration Change List Event data
71 *                     ReasonCode values.
72 *                     Added two new ReasonCode defines for SAS Device Status
73 *                     Change Event data.
74 *                     Added three new DiscoveryStatus bits for the SAS
75 *                     Discovery event data.
76 *                     Added Multiplexing Status Change bit to the PhyStatus
77 *                     field of the SAS Topology Change List event data.
78 *                     Removed define for MPI2_INIT_IMAGE_BOOTFLAGS_XMEMCOPY.
79 *                     BootFlags are now product-specific.
80 *                     Added defines for the indivdual signature bytes
81 *                     for MPI2_INIT_IMAGE_FOOTER.
82 * 01-19-09  02.00.10  Added MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY define.
83 *                     Added MPI2_EVENT_SAS_DISC_DS_DOWNSTREAM_INITIATOR
84 *                     define.
85 *                     Added MPI2_EVENT_SAS_DEV_STAT_RC_SATA_INIT_FAILURE
86 *                     define.
87 *                     Removed MPI2_EVENT_SAS_DISC_DS_SATA_INIT_FAILURE define.
88 * 05-06-09  02.00.11  Added MPI2_IOCFACTS_CAPABILITY_RAID_ACCELERATOR define.
89 *                     Added MPI2_IOCFACTS_CAPABILITY_MSI_X_INDEX define.
90 *                     Added two new reason codes for SAS Device Status Change
91 *                     Event.
92 *                     Added new event: SAS PHY Counter.
93 * 07-30-09  02.00.12  Added GPIO Interrupt event define and structure.
94 *                     Added MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER define.
95 *                     Added new product id family for 2208.
96 * 10-28-09  02.00.13  Added HostMSIxVectors field to MPI2_IOC_INIT_REQUEST.
97 *                     Added MaxMSIxVectors field to MPI2_IOC_FACTS_REPLY.
98 *                     Added MinDevHandle field to MPI2_IOC_FACTS_REPLY.
99 *                     Added MPI2_IOCFACTS_CAPABILITY_HOST_BASED_DISCOVERY.
100 *                     Added MPI2_EVENT_HOST_BASED_DISCOVERY_PHY define.
101 *                     Added MPI2_EVENT_SAS_TOPO_ES_NO_EXPANDER define.
102 *                     Added Host Based Discovery Phy Event data.
103 *                     Added defines for ProductID Product field
104 *                     (MPI2_FW_HEADER_PID_).
105 *                     Modified values for SAS ProductID Family
106 *                     (MPI2_FW_HEADER_PID_FAMILY_).
107 * 02-10-10  02.00.14  Added SAS Quiesce Event structure and defines.
108 *                     Added PowerManagementControl Request structures and
109 *                     defines.
110 * 05-12-10  02.00.15  Marked Task Set Full Event as obsolete.
111 *                     Added MPI2_EVENT_SAS_TOPO_LR_UNSUPPORTED_PHY define.
112 * 11-10-10  02.00.16  Added MPI2_FW_DOWNLOAD_ITYPE_MIN_PRODUCT_SPECIFIC.
113 * 02-23-11  02.00.17  Added SAS NOTIFY Primitive event, and added
114 *                     SASNotifyPrimitiveMasks field to
115 *                     MPI2_EVENT_NOTIFICATION_REQUEST.
116 *                     Added Temperature Threshold Event.
117 *                     Added Host Message Event.
118 *                     Added Send Host Message request and reply.
119 * 05-25-11  02.00.18  For Extended Image Header, added
120 *                     MPI2_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC and
121 *                     MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC defines.
122 *                     Deprecated MPI2_EXT_IMAGE_TYPE_MAX define.
123 * 08-24-11  02.00.19  Added PhysicalPort field to
124 *                     MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE structure.
125 *                     Marked MPI2_PM_CONTROL_FEATURE_PCIE_LINK as obsolete.
126 * 11-18-11  02.00.20  Incorporating additions for MPI v2.5.
127 * 03-29-12  02.00.21  Added a product specific range to event values.
128 * 07-26-12  02.00.22  Added MPI2_IOCFACTS_EXCEPT_PARTIAL_MEMORY_FAILURE.
129 *                     Added ElapsedSeconds field to
130 *                     MPI2_EVENT_DATA_IR_OPERATION_STATUS.
131 * 08-19-13  02.00.23  For IOCInit, added MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE
132 *			and MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY.
133 *			Added MPI2_IOCFACTS_CAPABILITY_RDPQ_ARRAY_CAPABLE.
134 *			Added MPI2_FW_DOWNLOAD_ITYPE_PUBLIC_KEY.
135 *			Added Encrypted Hash Extended Image.
136 * 12-05-13  02.00.24  Added MPI25_HASH_IMAGE_TYPE_BIOS.
137 * 11-18-14  02.00.25  Updated copyright information.
138 * 03-16-15  02.00.26  Updated for MPI v2.6.
139 *		       Added MPI2_EVENT_ACTIVE_CABLE_EXCEPTION and
140 *		       MPI26_EVENT_DATA_ACTIVE_CABLE_EXCEPT.
141 *                     Added MPI26_FW_HEADER_PID_FAMILY_3324_SAS and
142 *                     MPI26_FW_HEADER_PID_FAMILY_3516_SAS.
143 *                     Added MPI26_CTRL_OP_SHUTDOWN.
144 * 08-25-15  02.00.27  Added IC ARCH Class based signature defines.
145 *                     Added MPI26_EVENT_PCIE_ENUM_ES_RESOURCES_EXHAUSTED event.
146 *                     Added ConigurationFlags field to IOCInit message to
147 *                     support NVMe SGL format control.
148 *                     Added PCIe SRIOV support.
149 * 02-17-16   02.00.28 Added SAS 4 22.5 gbs speed support.
150 *                     Added PCIe 4 16.0 GT/sec speec support.
151 *                     Removed AHCI support.
152 *                     Removed SOP support.
153 * 07-01-16   02.00.29 Added Archclass for 4008 product.
154 *                     Added IOCException MPI2_IOCFACTS_EXCEPT_PCIE_DISABLED
155 * 08-23-16   02.00.30 Added new defines for the ImageType field of FWDownload
156 *                     Request Message.
157 *                     Added new defines for the ImageType field of FWUpload
158 *                     Request Message.
159 *                     Added new values for the RegionType field in the Layout
160 *                     Data sections of the FLASH Layout Extended Image Data.
161 *                     Added new defines for the ReasonCode field of
162 *                     Active Cable Exception Event.
163 *                     Added MPI2_EVENT_ENCL_DEVICE_STATUS_CHANGE and
164 *                     MPI26_EVENT_DATA_ENCL_DEV_STATUS_CHANGE.
165 * 11-23-16   02.00.31 Added MPI2_EVENT_SAS_DEVICE_DISCOVERY_ERROR and
166 *                     MPI25_EVENT_DATA_SAS_DEVICE_DISCOVERY_ERROR.
167 * 02-02-17   02.00.32 Added MPI2_FW_DOWNLOAD_ITYPE_CBB_BACKUP.
168 *                     Added MPI25_EVENT_DATA_ACTIVE_CABLE_EXCEPT and related
169 *                     defines for the ReasonCode field.
170 * 06-13-17   02.00.33 Added MPI2_FW_DOWNLOAD_ITYPE_CPLD.
171 * 09-29-17   02.00.34 Added MPI26_EVENT_PCIDEV_STAT_RC_PCIE_HOT_RESET_FAILED
172 *                     to the ReasonCode field in PCIe Device Status Change
173 *                     Event Data.
174 * 07-22-18   02.00.35 Added FW_DOWNLOAD_ITYPE_CPLD and _PSOC.
175 *                     Moved FW image definitions ionto new mpi2_image,h
176 * 08-14-18   02.00.36 Fixed definition of MPI2_FW_DOWNLOAD_ITYPE_PSOC (0x16)
177 * 09-07-18   02.00.37 Added MPI26_EVENT_PCIE_TOPO_PI_16_LANES
178 * 10-02-19   02.00.38 Added MPI26_IOCINIT_CFGFLAGS_COREDUMP_ENABLE
179 *                     Added MPI26_IOCFACTS_CAPABILITY_COREDUMP_ENABLED
180 *                     Added MPI2_FW_DOWNLOAD_ITYPE_COREDUMP
181 *                     Added MPI2_FW_UPLOAD_ITYPE_COREDUMP
182 * --------------------------------------------------------------------------
183 */
184
185#ifndef MPI2_IOC_H
186#define MPI2_IOC_H
187
188/*****************************************************************************
189*
190*              IOC Messages
191*
192*****************************************************************************/
193
194/****************************************************************************
195* IOCInit message
196****************************************************************************/
197
198/*IOCInit Request message */
199typedef struct _MPI2_IOC_INIT_REQUEST {
200	U8 WhoInit;		/*0x00 */
201	U8 Reserved1;		/*0x01 */
202	U8 ChainOffset;		/*0x02 */
203	U8 Function;		/*0x03 */
204	U16 Reserved2;		/*0x04 */
205	U8 Reserved3;		/*0x06 */
206	U8 MsgFlags;		/*0x07 */
207	U8 VP_ID;		/*0x08 */
208	U8 VF_ID;		/*0x09 */
209	U16 Reserved4;		/*0x0A */
210	U16 MsgVersion;		/*0x0C */
211	U16 HeaderVersion;	/*0x0E */
212	U32 Reserved5;		/*0x10 */
213	U16 ConfigurationFlags;	/* 0x14 */
214	U8 HostPageSize;	/*0x16 */
215	U8 HostMSIxVectors;	/*0x17 */
216	U16 Reserved8;		/*0x18 */
217	U16 SystemRequestFrameSize;	/*0x1A */
218	U16 ReplyDescriptorPostQueueDepth;	/*0x1C */
219	U16 ReplyFreeQueueDepth;	/*0x1E */
220	U32 SenseBufferAddressHigh;	/*0x20 */
221	U32 SystemReplyAddressHigh;	/*0x24 */
222	U64 SystemRequestFrameBaseAddress;	/*0x28 */
223	U64 ReplyDescriptorPostQueueAddress;	/*0x30 */
224	U64 ReplyFreeQueueAddress;	/*0x38 */
225	U64 TimeStamp;		/*0x40 */
226} MPI2_IOC_INIT_REQUEST, *PTR_MPI2_IOC_INIT_REQUEST,
227	Mpi2IOCInitRequest_t, *pMpi2IOCInitRequest_t;
228
229/*WhoInit values */
230#define MPI2_WHOINIT_NOT_INITIALIZED            (0x00)
231#define MPI2_WHOINIT_SYSTEM_BIOS                (0x01)
232#define MPI2_WHOINIT_ROM_BIOS                   (0x02)
233#define MPI2_WHOINIT_PCI_PEER                   (0x03)
234#define MPI2_WHOINIT_HOST_DRIVER                (0x04)
235#define MPI2_WHOINIT_MANUFACTURER               (0x05)
236
237/* MsgFlags */
238#define MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE    (0x01)
239
240
241/*MsgVersion */
242#define MPI2_IOCINIT_MSGVERSION_MAJOR_MASK      (0xFF00)
243#define MPI2_IOCINIT_MSGVERSION_MAJOR_SHIFT     (8)
244#define MPI2_IOCINIT_MSGVERSION_MINOR_MASK      (0x00FF)
245#define MPI2_IOCINIT_MSGVERSION_MINOR_SHIFT     (0)
246
247/*HeaderVersion */
248#define MPI2_IOCINIT_HDRVERSION_UNIT_MASK       (0xFF00)
249#define MPI2_IOCINIT_HDRVERSION_UNIT_SHIFT      (8)
250#define MPI2_IOCINIT_HDRVERSION_DEV_MASK        (0x00FF)
251#define MPI2_IOCINIT_HDRVERSION_DEV_SHIFT       (0)
252
253/*ConfigurationFlags */
254#define MPI26_IOCINIT_CFGFLAGS_NVME_SGL_FORMAT  (0x0001)
255#define MPI26_IOCINIT_CFGFLAGS_COREDUMP_ENABLE  (0x0002)
256
257/*minimum depth for a Reply Descriptor Post Queue */
258#define MPI2_RDPQ_DEPTH_MIN                     (16)
259
260/* Reply Descriptor Post Queue Array Entry */
261typedef struct _MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY {
262	U64                 RDPQBaseAddress;                    /* 0x00 */
263	U32                 Reserved1;                          /* 0x08 */
264	U32                 Reserved2;                          /* 0x0C */
265} MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY,
266*PTR_MPI2_IOC_INIT_RDPQ_ARRAY_ENTRY,
267Mpi2IOCInitRDPQArrayEntry, *pMpi2IOCInitRDPQArrayEntry;
268
269
270/*IOCInit Reply message */
271typedef struct _MPI2_IOC_INIT_REPLY {
272	U8 WhoInit;		/*0x00 */
273	U8 Reserved1;		/*0x01 */
274	U8 MsgLength;		/*0x02 */
275	U8 Function;		/*0x03 */
276	U16 Reserved2;		/*0x04 */
277	U8 Reserved3;		/*0x06 */
278	U8 MsgFlags;		/*0x07 */
279	U8 VP_ID;		/*0x08 */
280	U8 VF_ID;		/*0x09 */
281	U16 Reserved4;		/*0x0A */
282	U16 Reserved5;		/*0x0C */
283	U16 IOCStatus;		/*0x0E */
284	U32 IOCLogInfo;		/*0x10 */
285} MPI2_IOC_INIT_REPLY, *PTR_MPI2_IOC_INIT_REPLY,
286	Mpi2IOCInitReply_t, *pMpi2IOCInitReply_t;
287
288/****************************************************************************
289* IOCFacts message
290****************************************************************************/
291
292/*IOCFacts Request message */
293typedef struct _MPI2_IOC_FACTS_REQUEST {
294	U16 Reserved1;		/*0x00 */
295	U8 ChainOffset;		/*0x02 */
296	U8 Function;		/*0x03 */
297	U16 Reserved2;		/*0x04 */
298	U8 Reserved3;		/*0x06 */
299	U8 MsgFlags;		/*0x07 */
300	U8 VP_ID;		/*0x08 */
301	U8 VF_ID;		/*0x09 */
302	U16 Reserved4;		/*0x0A */
303} MPI2_IOC_FACTS_REQUEST, *PTR_MPI2_IOC_FACTS_REQUEST,
304	Mpi2IOCFactsRequest_t, *pMpi2IOCFactsRequest_t;
305
306/*IOCFacts Reply message */
307typedef struct _MPI2_IOC_FACTS_REPLY {
308	U16 MsgVersion;		/*0x00 */
309	U8 MsgLength;		/*0x02 */
310	U8 Function;		/*0x03 */
311	U16 HeaderVersion;	/*0x04 */
312	U8 IOCNumber;		/*0x06 */
313	U8 MsgFlags;		/*0x07 */
314	U8 VP_ID;		/*0x08 */
315	U8 VF_ID;		/*0x09 */
316	U16 Reserved1;		/*0x0A */
317	U16 IOCExceptions;	/*0x0C */
318	U16 IOCStatus;		/*0x0E */
319	U32 IOCLogInfo;		/*0x10 */
320	U8 MaxChainDepth;	/*0x14 */
321	U8 WhoInit;		/*0x15 */
322	U8 NumberOfPorts;	/*0x16 */
323	U8 MaxMSIxVectors;	/*0x17 */
324	U16 RequestCredit;	/*0x18 */
325	U16 ProductID;		/*0x1A */
326	U32 IOCCapabilities;	/*0x1C */
327	MPI2_VERSION_UNION FWVersion;	/*0x20 */
328	U16 IOCRequestFrameSize;	/*0x24 */
329	U16 IOCMaxChainSegmentSize;	/*0x26 */
330	U16 MaxInitiators;	/*0x28 */
331	U16 MaxTargets;		/*0x2A */
332	U16 MaxSasExpanders;	/*0x2C */
333	U16 MaxEnclosures;	/*0x2E */
334	U16 ProtocolFlags;	/*0x30 */
335	U16 HighPriorityCredit;	/*0x32 */
336	U16 MaxReplyDescriptorPostQueueDepth;	/*0x34 */
337	U8 ReplyFrameSize;	/*0x36 */
338	U8 MaxVolumes;		/*0x37 */
339	U16 MaxDevHandle;	/*0x38 */
340	U16 MaxPersistentEntries;	/*0x3A */
341	U16 MinDevHandle;	/*0x3C */
342	U8 CurrentHostPageSize;	/* 0x3E */
343	U8 Reserved4;		/* 0x3F */
344	U8 SGEModifierMask;	/*0x40 */
345	U8 SGEModifierValue;	/*0x41 */
346	U8 SGEModifierShift;	/*0x42 */
347	U8 Reserved5;		/*0x43 */
348} MPI2_IOC_FACTS_REPLY, *PTR_MPI2_IOC_FACTS_REPLY,
349	Mpi2IOCFactsReply_t, *pMpi2IOCFactsReply_t;
350
351/*MsgVersion */
352#define MPI2_IOCFACTS_MSGVERSION_MAJOR_MASK             (0xFF00)
353#define MPI2_IOCFACTS_MSGVERSION_MAJOR_SHIFT            (8)
354#define MPI2_IOCFACTS_MSGVERSION_MINOR_MASK             (0x00FF)
355#define MPI2_IOCFACTS_MSGVERSION_MINOR_SHIFT            (0)
356
357/*HeaderVersion */
358#define MPI2_IOCFACTS_HDRVERSION_UNIT_MASK              (0xFF00)
359#define MPI2_IOCFACTS_HDRVERSION_UNIT_SHIFT             (8)
360#define MPI2_IOCFACTS_HDRVERSION_DEV_MASK               (0x00FF)
361#define MPI2_IOCFACTS_HDRVERSION_DEV_SHIFT              (0)
362
363/*IOCExceptions */
364#define MPI2_IOCFACTS_EXCEPT_PCIE_DISABLED              (0x0400)
365#define MPI2_IOCFACTS_EXCEPT_PARTIAL_MEMORY_FAILURE     (0x0200)
366#define MPI2_IOCFACTS_EXCEPT_IR_FOREIGN_CONFIG_MAX      (0x0100)
367
368#define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_MASK              (0x00E0)
369#define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_GOOD              (0x0000)
370#define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_BACKUP            (0x0020)
371#define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_RESTORED          (0x0040)
372#define MPI2_IOCFACTS_EXCEPT_BOOTSTAT_CORRUPT_BACKUP    (0x0060)
373
374#define MPI2_IOCFACTS_EXCEPT_METADATA_UNSUPPORTED       (0x0010)
375#define MPI2_IOCFACTS_EXCEPT_MANUFACT_CHECKSUM_FAIL     (0x0008)
376#define MPI2_IOCFACTS_EXCEPT_FW_CHECKSUM_FAIL           (0x0004)
377#define MPI2_IOCFACTS_EXCEPT_RAID_CONFIG_INVALID        (0x0002)
378#define MPI2_IOCFACTS_EXCEPT_CONFIG_CHECKSUM_FAIL       (0x0001)
379
380/*defines for WhoInit field are after the IOCInit Request */
381
382/*ProductID field uses MPI2_FW_HEADER_PID_ */
383
384/*IOCCapabilities */
385#define MPI26_IOCFACTS_CAPABILITY_COREDUMP_ENABLED      (0x00200000)
386#define MPI26_IOCFACTS_CAPABILITY_PCIE_SRIOV            (0x00100000)
387#define MPI26_IOCFACTS_CAPABILITY_ATOMIC_REQ            (0x00080000)
388#define MPI2_IOCFACTS_CAPABILITY_RDPQ_ARRAY_CAPABLE     (0x00040000)
389#define MPI25_IOCFACTS_CAPABILITY_FAST_PATH_CAPABLE     (0x00020000)
390#define MPI2_IOCFACTS_CAPABILITY_HOST_BASED_DISCOVERY   (0x00010000)
391#define MPI2_IOCFACTS_CAPABILITY_MSI_X_INDEX            (0x00008000)
392#define MPI2_IOCFACTS_CAPABILITY_RAID_ACCELERATOR       (0x00004000)
393#define MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY           (0x00002000)
394#define MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID        (0x00001000)
395#define MPI2_IOCFACTS_CAPABILITY_TLR                    (0x00000800)
396#define MPI2_IOCFACTS_CAPABILITY_MULTICAST              (0x00000100)
397#define MPI2_IOCFACTS_CAPABILITY_BIDIRECTIONAL_TARGET   (0x00000080)
398#define MPI2_IOCFACTS_CAPABILITY_EEDP                   (0x00000040)
399#define MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER        (0x00000020)
400#define MPI2_IOCFACTS_CAPABILITY_SNAPSHOT_BUFFER        (0x00000010)
401#define MPI2_IOCFACTS_CAPABILITY_DIAG_TRACE_BUFFER      (0x00000008)
402#define MPI2_IOCFACTS_CAPABILITY_TASK_SET_FULL_HANDLING (0x00000004)
403
404/*ProtocolFlags */
405#define MPI2_IOCFACTS_PROTOCOL_NVME_DEVICES             (0x0008)
406#define MPI2_IOCFACTS_PROTOCOL_SCSI_INITIATOR           (0x0002)
407#define MPI2_IOCFACTS_PROTOCOL_SCSI_TARGET              (0x0001)
408
409/****************************************************************************
410* PortFacts message
411****************************************************************************/
412
413/*PortFacts Request message */
414typedef struct _MPI2_PORT_FACTS_REQUEST {
415	U16 Reserved1;		/*0x00 */
416	U8 ChainOffset;		/*0x02 */
417	U8 Function;		/*0x03 */
418	U16 Reserved2;		/*0x04 */
419	U8 PortNumber;		/*0x06 */
420	U8 MsgFlags;		/*0x07 */
421	U8 VP_ID;		/*0x08 */
422	U8 VF_ID;		/*0x09 */
423	U16 Reserved3;		/*0x0A */
424} MPI2_PORT_FACTS_REQUEST, *PTR_MPI2_PORT_FACTS_REQUEST,
425	Mpi2PortFactsRequest_t, *pMpi2PortFactsRequest_t;
426
427/*PortFacts Reply message */
428typedef struct _MPI2_PORT_FACTS_REPLY {
429	U16 Reserved1;		/*0x00 */
430	U8 MsgLength;		/*0x02 */
431	U8 Function;		/*0x03 */
432	U16 Reserved2;		/*0x04 */
433	U8 PortNumber;		/*0x06 */
434	U8 MsgFlags;		/*0x07 */
435	U8 VP_ID;		/*0x08 */
436	U8 VF_ID;		/*0x09 */
437	U16 Reserved3;		/*0x0A */
438	U16 Reserved4;		/*0x0C */
439	U16 IOCStatus;		/*0x0E */
440	U32 IOCLogInfo;		/*0x10 */
441	U8 Reserved5;		/*0x14 */
442	U8 PortType;		/*0x15 */
443	U16 Reserved6;		/*0x16 */
444	U16 MaxPostedCmdBuffers;	/*0x18 */
445	U16 Reserved7;		/*0x1A */
446} MPI2_PORT_FACTS_REPLY, *PTR_MPI2_PORT_FACTS_REPLY,
447	Mpi2PortFactsReply_t, *pMpi2PortFactsReply_t;
448
449/*PortType values */
450#define MPI2_PORTFACTS_PORTTYPE_INACTIVE            (0x00)
451#define MPI2_PORTFACTS_PORTTYPE_FC                  (0x10)
452#define MPI2_PORTFACTS_PORTTYPE_ISCSI               (0x20)
453#define MPI2_PORTFACTS_PORTTYPE_SAS_PHYSICAL        (0x30)
454#define MPI2_PORTFACTS_PORTTYPE_SAS_VIRTUAL         (0x31)
455#define MPI2_PORTFACTS_PORTTYPE_TRI_MODE            (0x40)
456
457
458/****************************************************************************
459* PortEnable message
460****************************************************************************/
461
462/*PortEnable Request message */
463typedef struct _MPI2_PORT_ENABLE_REQUEST {
464	U16 Reserved1;		/*0x00 */
465	U8 ChainOffset;		/*0x02 */
466	U8 Function;		/*0x03 */
467	U8 Reserved2;		/*0x04 */
468	U8 PortFlags;		/*0x05 */
469	U8 Reserved3;		/*0x06 */
470	U8 MsgFlags;		/*0x07 */
471	U8 VP_ID;		/*0x08 */
472	U8 VF_ID;		/*0x09 */
473	U16 Reserved4;		/*0x0A */
474} MPI2_PORT_ENABLE_REQUEST, *PTR_MPI2_PORT_ENABLE_REQUEST,
475	Mpi2PortEnableRequest_t, *pMpi2PortEnableRequest_t;
476
477/*PortEnable Reply message */
478typedef struct _MPI2_PORT_ENABLE_REPLY {
479	U16 Reserved1;		/*0x00 */
480	U8 MsgLength;		/*0x02 */
481	U8 Function;		/*0x03 */
482	U8 Reserved2;		/*0x04 */
483	U8 PortFlags;		/*0x05 */
484	U8 Reserved3;		/*0x06 */
485	U8 MsgFlags;		/*0x07 */
486	U8 VP_ID;		/*0x08 */
487	U8 VF_ID;		/*0x09 */
488	U16 Reserved4;		/*0x0A */
489	U16 Reserved5;		/*0x0C */
490	U16 IOCStatus;		/*0x0E */
491	U32 IOCLogInfo;		/*0x10 */
492} MPI2_PORT_ENABLE_REPLY, *PTR_MPI2_PORT_ENABLE_REPLY,
493	Mpi2PortEnableReply_t, *pMpi2PortEnableReply_t;
494
495/****************************************************************************
496* EventNotification message
497****************************************************************************/
498
499/*EventNotification Request message */
500#define MPI2_EVENT_NOTIFY_EVENTMASK_WORDS           (4)
501
502typedef struct _MPI2_EVENT_NOTIFICATION_REQUEST {
503	U16 Reserved1;		/*0x00 */
504	U8 ChainOffset;		/*0x02 */
505	U8 Function;		/*0x03 */
506	U16 Reserved2;		/*0x04 */
507	U8 Reserved3;		/*0x06 */
508	U8 MsgFlags;		/*0x07 */
509	U8 VP_ID;		/*0x08 */
510	U8 VF_ID;		/*0x09 */
511	U16 Reserved4;		/*0x0A */
512	U32 Reserved5;		/*0x0C */
513	U32 Reserved6;		/*0x10 */
514	U32 EventMasks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];	/*0x14 */
515	U16 SASBroadcastPrimitiveMasks;	/*0x24 */
516	U16 SASNotifyPrimitiveMasks;	/*0x26 */
517	U32 Reserved8;		/*0x28 */
518} MPI2_EVENT_NOTIFICATION_REQUEST,
519	*PTR_MPI2_EVENT_NOTIFICATION_REQUEST,
520	Mpi2EventNotificationRequest_t,
521	*pMpi2EventNotificationRequest_t;
522
523/*EventNotification Reply message */
524typedef struct _MPI2_EVENT_NOTIFICATION_REPLY {
525	U16 EventDataLength;	/*0x00 */
526	U8 MsgLength;		/*0x02 */
527	U8 Function;		/*0x03 */
528	U16 Reserved1;		/*0x04 */
529	U8 AckRequired;		/*0x06 */
530	U8 MsgFlags;		/*0x07 */
531	U8 VP_ID;		/*0x08 */
532	U8 VF_ID;		/*0x09 */
533	U16 Reserved2;		/*0x0A */
534	U16 Reserved3;		/*0x0C */
535	U16 IOCStatus;		/*0x0E */
536	U32 IOCLogInfo;		/*0x10 */
537	U16 Event;		/*0x14 */
538	U16 Reserved4;		/*0x16 */
539	U32 EventContext;	/*0x18 */
540	U32 EventData[];	/*0x1C */
541} MPI2_EVENT_NOTIFICATION_REPLY, *PTR_MPI2_EVENT_NOTIFICATION_REPLY,
542	Mpi2EventNotificationReply_t,
543	*pMpi2EventNotificationReply_t;
544
545/*AckRequired */
546#define MPI2_EVENT_NOTIFICATION_ACK_NOT_REQUIRED    (0x00)
547#define MPI2_EVENT_NOTIFICATION_ACK_REQUIRED        (0x01)
548
549/*Event */
550#define MPI2_EVENT_LOG_DATA                         (0x0001)
551#define MPI2_EVENT_STATE_CHANGE                     (0x0002)
552#define MPI2_EVENT_HARD_RESET_RECEIVED              (0x0005)
553#define MPI2_EVENT_EVENT_CHANGE                     (0x000A)
554#define MPI2_EVENT_TASK_SET_FULL                    (0x000E)	/*obsolete */
555#define MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE         (0x000F)
556#define MPI2_EVENT_IR_OPERATION_STATUS              (0x0014)
557#define MPI2_EVENT_SAS_DISCOVERY                    (0x0016)
558#define MPI2_EVENT_SAS_BROADCAST_PRIMITIVE          (0x0017)
559#define MPI2_EVENT_SAS_INIT_DEVICE_STATUS_CHANGE    (0x0018)
560#define MPI2_EVENT_SAS_INIT_TABLE_OVERFLOW          (0x0019)
561#define MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST         (0x001C)
562#define MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE    (0x001D)
563#define MPI2_EVENT_ENCL_DEVICE_STATUS_CHANGE        (0x001D)
564#define MPI2_EVENT_IR_VOLUME                        (0x001E)
565#define MPI2_EVENT_IR_PHYSICAL_DISK                 (0x001F)
566#define MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST     (0x0020)
567#define MPI2_EVENT_LOG_ENTRY_ADDED                  (0x0021)
568#define MPI2_EVENT_SAS_PHY_COUNTER                  (0x0022)
569#define MPI2_EVENT_GPIO_INTERRUPT                   (0x0023)
570#define MPI2_EVENT_HOST_BASED_DISCOVERY_PHY         (0x0024)
571#define MPI2_EVENT_SAS_QUIESCE                      (0x0025)
572#define MPI2_EVENT_SAS_NOTIFY_PRIMITIVE             (0x0026)
573#define MPI2_EVENT_TEMP_THRESHOLD                   (0x0027)
574#define MPI2_EVENT_HOST_MESSAGE                     (0x0028)
575#define MPI2_EVENT_POWER_PERFORMANCE_CHANGE         (0x0029)
576#define MPI2_EVENT_PCIE_DEVICE_STATUS_CHANGE        (0x0030)
577#define MPI2_EVENT_PCIE_ENUMERATION                 (0x0031)
578#define MPI2_EVENT_PCIE_TOPOLOGY_CHANGE_LIST        (0x0032)
579#define MPI2_EVENT_PCIE_LINK_COUNTER                (0x0033)
580#define MPI2_EVENT_ACTIVE_CABLE_EXCEPTION           (0x0034)
581#define MPI2_EVENT_SAS_DEVICE_DISCOVERY_ERROR       (0x0035)
582#define MPI2_EVENT_MIN_PRODUCT_SPECIFIC             (0x006E)
583#define MPI2_EVENT_MAX_PRODUCT_SPECIFIC             (0x007F)
584
585/*Log Entry Added Event data */
586
587/*the following structure matches MPI2_LOG_0_ENTRY in mpi2_cnfg.h */
588#define MPI2_EVENT_DATA_LOG_DATA_LENGTH             (0x1C)
589
590typedef struct _MPI2_EVENT_DATA_LOG_ENTRY_ADDED {
591	U64 TimeStamp;		/*0x00 */
592	U32 Reserved1;		/*0x08 */
593	U16 LogSequence;	/*0x0C */
594	U16 LogEntryQualifier;	/*0x0E */
595	U8 VP_ID;		/*0x10 */
596	U8 VF_ID;		/*0x11 */
597	U16 Reserved2;		/*0x12 */
598	U8 LogData[MPI2_EVENT_DATA_LOG_DATA_LENGTH];	/*0x14 */
599} MPI2_EVENT_DATA_LOG_ENTRY_ADDED,
600	*PTR_MPI2_EVENT_DATA_LOG_ENTRY_ADDED,
601	Mpi2EventDataLogEntryAdded_t,
602	*pMpi2EventDataLogEntryAdded_t;
603
604/*GPIO Interrupt Event data */
605
606typedef struct _MPI2_EVENT_DATA_GPIO_INTERRUPT {
607	U8 GPIONum;		/*0x00 */
608	U8 Reserved1;		/*0x01 */
609	U16 Reserved2;		/*0x02 */
610} MPI2_EVENT_DATA_GPIO_INTERRUPT,
611	*PTR_MPI2_EVENT_DATA_GPIO_INTERRUPT,
612	Mpi2EventDataGpioInterrupt_t,
613	*pMpi2EventDataGpioInterrupt_t;
614
615/*Temperature Threshold Event data */
616
617typedef struct _MPI2_EVENT_DATA_TEMPERATURE {
618	U16 Status;		/*0x00 */
619	U8 SensorNum;		/*0x02 */
620	U8 Reserved1;		/*0x03 */
621	U16 CurrentTemperature;	/*0x04 */
622	U16 Reserved2;		/*0x06 */
623	U32 Reserved3;		/*0x08 */
624	U32 Reserved4;		/*0x0C */
625} MPI2_EVENT_DATA_TEMPERATURE,
626	*PTR_MPI2_EVENT_DATA_TEMPERATURE,
627	Mpi2EventDataTemperature_t, *pMpi2EventDataTemperature_t;
628
629/*Temperature Threshold Event data Status bits */
630#define MPI2_EVENT_TEMPERATURE3_EXCEEDED            (0x0008)
631#define MPI2_EVENT_TEMPERATURE2_EXCEEDED            (0x0004)
632#define MPI2_EVENT_TEMPERATURE1_EXCEEDED            (0x0002)
633#define MPI2_EVENT_TEMPERATURE0_EXCEEDED            (0x0001)
634
635/*Host Message Event data */
636
637typedef struct _MPI2_EVENT_DATA_HOST_MESSAGE {
638	U8 SourceVF_ID;		/*0x00 */
639	U8 Reserved1;		/*0x01 */
640	U16 Reserved2;		/*0x02 */
641	U32 Reserved3;		/*0x04 */
642	U32 HostData[];		/*0x08 */
643} MPI2_EVENT_DATA_HOST_MESSAGE, *PTR_MPI2_EVENT_DATA_HOST_MESSAGE,
644	Mpi2EventDataHostMessage_t, *pMpi2EventDataHostMessage_t;
645
646/*Power Performance Change Event data */
647
648typedef struct _MPI2_EVENT_DATA_POWER_PERF_CHANGE {
649	U8 CurrentPowerMode;	/*0x00 */
650	U8 PreviousPowerMode;	/*0x01 */
651	U16 Reserved1;		/*0x02 */
652} MPI2_EVENT_DATA_POWER_PERF_CHANGE,
653	*PTR_MPI2_EVENT_DATA_POWER_PERF_CHANGE,
654	Mpi2EventDataPowerPerfChange_t,
655	*pMpi2EventDataPowerPerfChange_t;
656
657/*defines for CurrentPowerMode and PreviousPowerMode fields */
658#define MPI2_EVENT_PM_INIT_MASK              (0xC0)
659#define MPI2_EVENT_PM_INIT_UNAVAILABLE       (0x00)
660#define MPI2_EVENT_PM_INIT_HOST              (0x40)
661#define MPI2_EVENT_PM_INIT_IO_UNIT           (0x80)
662#define MPI2_EVENT_PM_INIT_PCIE_DPA          (0xC0)
663
664#define MPI2_EVENT_PM_MODE_MASK              (0x07)
665#define MPI2_EVENT_PM_MODE_UNAVAILABLE       (0x00)
666#define MPI2_EVENT_PM_MODE_UNKNOWN           (0x01)
667#define MPI2_EVENT_PM_MODE_FULL_POWER        (0x04)
668#define MPI2_EVENT_PM_MODE_REDUCED_POWER     (0x05)
669#define MPI2_EVENT_PM_MODE_STANDBY           (0x06)
670
671/* Active Cable Exception Event data */
672
673typedef struct _MPI26_EVENT_DATA_ACTIVE_CABLE_EXCEPT {
674	U32         ActiveCablePowerRequirement;        /* 0x00 */
675	U8          ReasonCode;                         /* 0x04 */
676	U8          ReceptacleID;                       /* 0x05 */
677	U16         Reserved1;                          /* 0x06 */
678} MPI25_EVENT_DATA_ACTIVE_CABLE_EXCEPT,
679	*PTR_MPI25_EVENT_DATA_ACTIVE_CABLE_EXCEPT,
680	Mpi25EventDataActiveCableExcept_t,
681	*pMpi25EventDataActiveCableExcept_t,
682	MPI26_EVENT_DATA_ACTIVE_CABLE_EXCEPT,
683	*PTR_MPI26_EVENT_DATA_ACTIVE_CABLE_EXCEPT,
684	Mpi26EventDataActiveCableExcept_t,
685	*pMpi26EventDataActiveCableExcept_t;
686
687/*MPI2.5 defines for the ReasonCode field */
688#define MPI25_EVENT_ACTIVE_CABLE_INSUFFICIENT_POWER     (0x00)
689#define MPI25_EVENT_ACTIVE_CABLE_PRESENT                (0x01)
690#define MPI25_EVENT_ACTIVE_CABLE_DEGRADED               (0x02)
691
692/* defines for ReasonCode field */
693#define MPI26_EVENT_ACTIVE_CABLE_INSUFFICIENT_POWER     (0x00)
694#define MPI26_EVENT_ACTIVE_CABLE_PRESENT                (0x01)
695#define MPI26_EVENT_ACTIVE_CABLE_DEGRADED               (0x02)
696
697/*Hard Reset Received Event data */
698
699typedef struct _MPI2_EVENT_DATA_HARD_RESET_RECEIVED {
700	U8 Reserved1;		/*0x00 */
701	U8 Port;		/*0x01 */
702	U16 Reserved2;		/*0x02 */
703} MPI2_EVENT_DATA_HARD_RESET_RECEIVED,
704	*PTR_MPI2_EVENT_DATA_HARD_RESET_RECEIVED,
705	Mpi2EventDataHardResetReceived_t,
706	*pMpi2EventDataHardResetReceived_t;
707
708/*Task Set Full Event data */
709/*  this event is obsolete */
710
711typedef struct _MPI2_EVENT_DATA_TASK_SET_FULL {
712	U16 DevHandle;		/*0x00 */
713	U16 CurrentDepth;	/*0x02 */
714} MPI2_EVENT_DATA_TASK_SET_FULL, *PTR_MPI2_EVENT_DATA_TASK_SET_FULL,
715	Mpi2EventDataTaskSetFull_t, *pMpi2EventDataTaskSetFull_t;
716
717/*SAS Device Status Change Event data */
718
719typedef struct _MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE {
720	U16 TaskTag;		/*0x00 */
721	U8 ReasonCode;		/*0x02 */
722	U8 PhysicalPort;	/*0x03 */
723	U8 ASC;			/*0x04 */
724	U8 ASCQ;		/*0x05 */
725	U16 DevHandle;		/*0x06 */
726	U32 Reserved2;		/*0x08 */
727	U64 SASAddress;		/*0x0C */
728	U8 LUN[8];		/*0x14 */
729} MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE,
730	*PTR_MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE,
731	Mpi2EventDataSasDeviceStatusChange_t,
732	*pMpi2EventDataSasDeviceStatusChange_t;
733
734/*SAS Device Status Change Event data ReasonCode values */
735#define MPI2_EVENT_SAS_DEV_STAT_RC_SMART_DATA                           (0x05)
736#define MPI2_EVENT_SAS_DEV_STAT_RC_UNSUPPORTED                          (0x07)
737#define MPI2_EVENT_SAS_DEV_STAT_RC_INTERNAL_DEVICE_RESET                (0x08)
738#define MPI2_EVENT_SAS_DEV_STAT_RC_TASK_ABORT_INTERNAL                  (0x09)
739#define MPI2_EVENT_SAS_DEV_STAT_RC_ABORT_TASK_SET_INTERNAL              (0x0A)
740#define MPI2_EVENT_SAS_DEV_STAT_RC_CLEAR_TASK_SET_INTERNAL              (0x0B)
741#define MPI2_EVENT_SAS_DEV_STAT_RC_QUERY_TASK_INTERNAL                  (0x0C)
742#define MPI2_EVENT_SAS_DEV_STAT_RC_ASYNC_NOTIFICATION                   (0x0D)
743#define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_INTERNAL_DEV_RESET               (0x0E)
744#define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_TASK_ABORT_INTERNAL              (0x0F)
745#define MPI2_EVENT_SAS_DEV_STAT_RC_SATA_INIT_FAILURE                    (0x10)
746#define MPI2_EVENT_SAS_DEV_STAT_RC_EXPANDER_REDUCED_FUNCTIONALITY       (0x11)
747#define MPI2_EVENT_SAS_DEV_STAT_RC_CMP_EXPANDER_REDUCED_FUNCTIONALITY   (0x12)
748
749/*Integrated RAID Operation Status Event data */
750
751typedef struct _MPI2_EVENT_DATA_IR_OPERATION_STATUS {
752	U16 VolDevHandle;	/*0x00 */
753	U16 Reserved1;		/*0x02 */
754	U8 RAIDOperation;	/*0x04 */
755	U8 PercentComplete;	/*0x05 */
756	U16 Reserved2;		/*0x06 */
757	U32 ElapsedSeconds;	/*0x08 */
758} MPI2_EVENT_DATA_IR_OPERATION_STATUS,
759	*PTR_MPI2_EVENT_DATA_IR_OPERATION_STATUS,
760	Mpi2EventDataIrOperationStatus_t,
761	*pMpi2EventDataIrOperationStatus_t;
762
763/*Integrated RAID Operation Status Event data RAIDOperation values */
764#define MPI2_EVENT_IR_RAIDOP_RESYNC                     (0x00)
765#define MPI2_EVENT_IR_RAIDOP_ONLINE_CAP_EXPANSION       (0x01)
766#define MPI2_EVENT_IR_RAIDOP_CONSISTENCY_CHECK          (0x02)
767#define MPI2_EVENT_IR_RAIDOP_BACKGROUND_INIT            (0x03)
768#define MPI2_EVENT_IR_RAIDOP_MAKE_DATA_CONSISTENT       (0x04)
769
770/*Integrated RAID Volume Event data */
771
772typedef struct _MPI2_EVENT_DATA_IR_VOLUME {
773	U16 VolDevHandle;	/*0x00 */
774	U8 ReasonCode;		/*0x02 */
775	U8 Reserved1;		/*0x03 */
776	U32 NewValue;		/*0x04 */
777	U32 PreviousValue;	/*0x08 */
778} MPI2_EVENT_DATA_IR_VOLUME, *PTR_MPI2_EVENT_DATA_IR_VOLUME,
779	Mpi2EventDataIrVolume_t, *pMpi2EventDataIrVolume_t;
780
781/*Integrated RAID Volume Event data ReasonCode values */
782#define MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED        (0x01)
783#define MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED    (0x02)
784#define MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED           (0x03)
785
786/*Integrated RAID Physical Disk Event data */
787
788typedef struct _MPI2_EVENT_DATA_IR_PHYSICAL_DISK {
789	U16 Reserved1;		/*0x00 */
790	U8 ReasonCode;		/*0x02 */
791	U8 PhysDiskNum;		/*0x03 */
792	U16 PhysDiskDevHandle;	/*0x04 */
793	U16 Reserved2;		/*0x06 */
794	U16 Slot;		/*0x08 */
795	U16 EnclosureHandle;	/*0x0A */
796	U32 NewValue;		/*0x0C */
797	U32 PreviousValue;	/*0x10 */
798} MPI2_EVENT_DATA_IR_PHYSICAL_DISK,
799	*PTR_MPI2_EVENT_DATA_IR_PHYSICAL_DISK,
800	Mpi2EventDataIrPhysicalDisk_t,
801	*pMpi2EventDataIrPhysicalDisk_t;
802
803/*Integrated RAID Physical Disk Event data ReasonCode values */
804#define MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED      (0x01)
805#define MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED  (0x02)
806#define MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED         (0x03)
807
808/*Integrated RAID Configuration Change List Event data */
809
810/*
811 *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
812 *one and check NumElements at runtime.
813 */
814#ifndef MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT
815#define MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT          (1)
816#endif
817
818typedef struct _MPI2_EVENT_IR_CONFIG_ELEMENT {
819	U16 ElementFlags;	/*0x00 */
820	U16 VolDevHandle;	/*0x02 */
821	U8 ReasonCode;		/*0x04 */
822	U8 PhysDiskNum;		/*0x05 */
823	U16 PhysDiskDevHandle;	/*0x06 */
824} MPI2_EVENT_IR_CONFIG_ELEMENT, *PTR_MPI2_EVENT_IR_CONFIG_ELEMENT,
825	Mpi2EventIrConfigElement_t, *pMpi2EventIrConfigElement_t;
826
827/*IR Configuration Change List Event data ElementFlags values */
828#define MPI2_EVENT_IR_CHANGE_EFLAGS_ELEMENT_TYPE_MASK   (0x000F)
829#define MPI2_EVENT_IR_CHANGE_EFLAGS_VOLUME_ELEMENT      (0x0000)
830#define MPI2_EVENT_IR_CHANGE_EFLAGS_VOLPHYSDISK_ELEMENT (0x0001)
831#define MPI2_EVENT_IR_CHANGE_EFLAGS_HOTSPARE_ELEMENT    (0x0002)
832
833/*IR Configuration Change List Event data ReasonCode values */
834#define MPI2_EVENT_IR_CHANGE_RC_ADDED                   (0x01)
835#define MPI2_EVENT_IR_CHANGE_RC_REMOVED                 (0x02)
836#define MPI2_EVENT_IR_CHANGE_RC_NO_CHANGE               (0x03)
837#define MPI2_EVENT_IR_CHANGE_RC_HIDE                    (0x04)
838#define MPI2_EVENT_IR_CHANGE_RC_UNHIDE                  (0x05)
839#define MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED          (0x06)
840#define MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED          (0x07)
841#define MPI2_EVENT_IR_CHANGE_RC_PD_CREATED              (0x08)
842#define MPI2_EVENT_IR_CHANGE_RC_PD_DELETED              (0x09)
843
844typedef struct _MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST {
845	U8 NumElements;		/*0x00 */
846	U8 Reserved1;		/*0x01 */
847	U8 Reserved2;		/*0x02 */
848	U8 ConfigNum;		/*0x03 */
849	U32 Flags;		/*0x04 */
850	MPI2_EVENT_IR_CONFIG_ELEMENT
851		ConfigElement[MPI2_EVENT_IR_CONFIG_ELEMENT_COUNT];/*0x08 */
852} MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST,
853	*PTR_MPI2_EVENT_DATA_IR_CONFIG_CHANGE_LIST,
854	Mpi2EventDataIrConfigChangeList_t,
855	*pMpi2EventDataIrConfigChangeList_t;
856
857/*IR Configuration Change List Event data Flags values */
858#define MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG   (0x00000001)
859
860/*SAS Discovery Event data */
861
862typedef struct _MPI2_EVENT_DATA_SAS_DISCOVERY {
863	U8 Flags;		/*0x00 */
864	U8 ReasonCode;		/*0x01 */
865	U8 PhysicalPort;	/*0x02 */
866	U8 Reserved1;		/*0x03 */
867	U32 DiscoveryStatus;	/*0x04 */
868} MPI2_EVENT_DATA_SAS_DISCOVERY,
869	*PTR_MPI2_EVENT_DATA_SAS_DISCOVERY,
870	Mpi2EventDataSasDiscovery_t, *pMpi2EventDataSasDiscovery_t;
871
872/*SAS Discovery Event data Flags values */
873#define MPI2_EVENT_SAS_DISC_DEVICE_CHANGE                   (0x02)
874#define MPI2_EVENT_SAS_DISC_IN_PROGRESS                     (0x01)
875
876/*SAS Discovery Event data ReasonCode values */
877#define MPI2_EVENT_SAS_DISC_RC_STARTED                      (0x01)
878#define MPI2_EVENT_SAS_DISC_RC_COMPLETED                    (0x02)
879
880/*SAS Discovery Event data DiscoveryStatus values */
881#define MPI2_EVENT_SAS_DISC_DS_MAX_ENCLOSURES_EXCEED            (0x80000000)
882#define MPI2_EVENT_SAS_DISC_DS_MAX_EXPANDERS_EXCEED             (0x40000000)
883#define MPI2_EVENT_SAS_DISC_DS_MAX_DEVICES_EXCEED               (0x20000000)
884#define MPI2_EVENT_SAS_DISC_DS_MAX_TOPO_PHYS_EXCEED             (0x10000000)
885#define MPI2_EVENT_SAS_DISC_DS_DOWNSTREAM_INITIATOR             (0x08000000)
886#define MPI2_EVENT_SAS_DISC_DS_MULTI_SUBTRACTIVE_SUBTRACTIVE    (0x00008000)
887#define MPI2_EVENT_SAS_DISC_DS_EXP_MULTI_SUBTRACTIVE            (0x00004000)
888#define MPI2_EVENT_SAS_DISC_DS_MULTI_PORT_DOMAIN                (0x00002000)
889#define MPI2_EVENT_SAS_DISC_DS_TABLE_TO_SUBTRACTIVE_LINK        (0x00001000)
890#define MPI2_EVENT_SAS_DISC_DS_UNSUPPORTED_DEVICE               (0x00000800)
891#define MPI2_EVENT_SAS_DISC_DS_TABLE_LINK                       (0x00000400)
892#define MPI2_EVENT_SAS_DISC_DS_SUBTRACTIVE_LINK                 (0x00000200)
893#define MPI2_EVENT_SAS_DISC_DS_SMP_CRC_ERROR                    (0x00000100)
894#define MPI2_EVENT_SAS_DISC_DS_SMP_FUNCTION_FAILED              (0x00000080)
895#define MPI2_EVENT_SAS_DISC_DS_INDEX_NOT_EXIST                  (0x00000040)
896#define MPI2_EVENT_SAS_DISC_DS_OUT_ROUTE_ENTRIES                (0x00000020)
897#define MPI2_EVENT_SAS_DISC_DS_SMP_TIMEOUT                      (0x00000010)
898#define MPI2_EVENT_SAS_DISC_DS_MULTIPLE_PORTS                   (0x00000004)
899#define MPI2_EVENT_SAS_DISC_DS_UNADDRESSABLE_DEVICE             (0x00000002)
900#define MPI2_EVENT_SAS_DISC_DS_LOOP_DETECTED                    (0x00000001)
901
902/*SAS Broadcast Primitive Event data */
903
904typedef struct _MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE {
905	U8 PhyNum;		/*0x00 */
906	U8 Port;		/*0x01 */
907	U8 PortWidth;		/*0x02 */
908	U8 Primitive;		/*0x03 */
909} MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE,
910	*PTR_MPI2_EVENT_DATA_SAS_BROADCAST_PRIMITIVE,
911	Mpi2EventDataSasBroadcastPrimitive_t,
912	*pMpi2EventDataSasBroadcastPrimitive_t;
913
914/*defines for the Primitive field */
915#define MPI2_EVENT_PRIMITIVE_CHANGE                         (0x01)
916#define MPI2_EVENT_PRIMITIVE_SES                            (0x02)
917#define MPI2_EVENT_PRIMITIVE_EXPANDER                       (0x03)
918#define MPI2_EVENT_PRIMITIVE_ASYNCHRONOUS_EVENT             (0x04)
919#define MPI2_EVENT_PRIMITIVE_RESERVED3                      (0x05)
920#define MPI2_EVENT_PRIMITIVE_RESERVED4                      (0x06)
921#define MPI2_EVENT_PRIMITIVE_CHANGE0_RESERVED               (0x07)
922#define MPI2_EVENT_PRIMITIVE_CHANGE1_RESERVED               (0x08)
923
924/*SAS Notify Primitive Event data */
925
926typedef struct _MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE {
927	U8 PhyNum;		/*0x00 */
928	U8 Port;		/*0x01 */
929	U8 Reserved1;		/*0x02 */
930	U8 Primitive;		/*0x03 */
931} MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE,
932	*PTR_MPI2_EVENT_DATA_SAS_NOTIFY_PRIMITIVE,
933	Mpi2EventDataSasNotifyPrimitive_t,
934	*pMpi2EventDataSasNotifyPrimitive_t;
935
936/*defines for the Primitive field */
937#define MPI2_EVENT_NOTIFY_ENABLE_SPINUP                     (0x01)
938#define MPI2_EVENT_NOTIFY_POWER_LOSS_EXPECTED               (0x02)
939#define MPI2_EVENT_NOTIFY_RESERVED1                         (0x03)
940#define MPI2_EVENT_NOTIFY_RESERVED2                         (0x04)
941
942/*SAS Initiator Device Status Change Event data */
943
944typedef struct _MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE {
945	U8 ReasonCode;		/*0x00 */
946	U8 PhysicalPort;	/*0x01 */
947	U16 DevHandle;		/*0x02 */
948	U64 SASAddress;		/*0x04 */
949} MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE,
950	*PTR_MPI2_EVENT_DATA_SAS_INIT_DEV_STATUS_CHANGE,
951	Mpi2EventDataSasInitDevStatusChange_t,
952	*pMpi2EventDataSasInitDevStatusChange_t;
953
954/*SAS Initiator Device Status Change event ReasonCode values */
955#define MPI2_EVENT_SAS_INIT_RC_ADDED                (0x01)
956#define MPI2_EVENT_SAS_INIT_RC_NOT_RESPONDING       (0x02)
957
958/*SAS Initiator Device Table Overflow Event data */
959
960typedef struct _MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW {
961	U16 MaxInit;		/*0x00 */
962	U16 CurrentInit;	/*0x02 */
963	U64 SASAddress;		/*0x04 */
964} MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW,
965	*PTR_MPI2_EVENT_DATA_SAS_INIT_TABLE_OVERFLOW,
966	Mpi2EventDataSasInitTableOverflow_t,
967	*pMpi2EventDataSasInitTableOverflow_t;
968
969/*SAS Topology Change List Event data */
970
971/*
972 *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
973 *one and check NumEntries at runtime.
974 */
975#ifndef MPI2_EVENT_SAS_TOPO_PHY_COUNT
976#define MPI2_EVENT_SAS_TOPO_PHY_COUNT           (1)
977#endif
978
979typedef struct _MPI2_EVENT_SAS_TOPO_PHY_ENTRY {
980	U16 AttachedDevHandle;	/*0x00 */
981	U8 LinkRate;		/*0x02 */
982	U8 PhyStatus;		/*0x03 */
983} MPI2_EVENT_SAS_TOPO_PHY_ENTRY, *PTR_MPI2_EVENT_SAS_TOPO_PHY_ENTRY,
984	Mpi2EventSasTopoPhyEntry_t, *pMpi2EventSasTopoPhyEntry_t;
985
986typedef struct _MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST {
987	U16 EnclosureHandle;	/*0x00 */
988	U16 ExpanderDevHandle;	/*0x02 */
989	U8 NumPhys;		/*0x04 */
990	U8 Reserved1;		/*0x05 */
991	U16 Reserved2;		/*0x06 */
992	U8 NumEntries;		/*0x08 */
993	U8 StartPhyNum;		/*0x09 */
994	U8 ExpStatus;		/*0x0A */
995	U8 PhysicalPort;	/*0x0B */
996	MPI2_EVENT_SAS_TOPO_PHY_ENTRY
997	PHY[MPI2_EVENT_SAS_TOPO_PHY_COUNT];	/*0x0C */
998} MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST,
999	*PTR_MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST,
1000	Mpi2EventDataSasTopologyChangeList_t,
1001	*pMpi2EventDataSasTopologyChangeList_t;
1002
1003/*values for the ExpStatus field */
1004#define MPI2_EVENT_SAS_TOPO_ES_NO_EXPANDER                  (0x00)
1005#define MPI2_EVENT_SAS_TOPO_ES_ADDED                        (0x01)
1006#define MPI2_EVENT_SAS_TOPO_ES_NOT_RESPONDING               (0x02)
1007#define MPI2_EVENT_SAS_TOPO_ES_RESPONDING                   (0x03)
1008#define MPI2_EVENT_SAS_TOPO_ES_DELAY_NOT_RESPONDING         (0x04)
1009
1010/*defines for the LinkRate field */
1011#define MPI2_EVENT_SAS_TOPO_LR_CURRENT_MASK                 (0xF0)
1012#define MPI2_EVENT_SAS_TOPO_LR_CURRENT_SHIFT                (4)
1013#define MPI2_EVENT_SAS_TOPO_LR_PREV_MASK                    (0x0F)
1014#define MPI2_EVENT_SAS_TOPO_LR_PREV_SHIFT                   (0)
1015
1016#define MPI2_EVENT_SAS_TOPO_LR_UNKNOWN_LINK_RATE            (0x00)
1017#define MPI2_EVENT_SAS_TOPO_LR_PHY_DISABLED                 (0x01)
1018#define MPI2_EVENT_SAS_TOPO_LR_NEGOTIATION_FAILED           (0x02)
1019#define MPI2_EVENT_SAS_TOPO_LR_SATA_OOB_COMPLETE            (0x03)
1020#define MPI2_EVENT_SAS_TOPO_LR_PORT_SELECTOR                (0x04)
1021#define MPI2_EVENT_SAS_TOPO_LR_SMP_RESET_IN_PROGRESS        (0x05)
1022#define MPI2_EVENT_SAS_TOPO_LR_UNSUPPORTED_PHY              (0x06)
1023#define MPI2_EVENT_SAS_TOPO_LR_RATE_1_5                     (0x08)
1024#define MPI2_EVENT_SAS_TOPO_LR_RATE_3_0                     (0x09)
1025#define MPI2_EVENT_SAS_TOPO_LR_RATE_6_0                     (0x0A)
1026#define MPI25_EVENT_SAS_TOPO_LR_RATE_12_0                   (0x0B)
1027#define MPI26_EVENT_SAS_TOPO_LR_RATE_22_5                   (0x0C)
1028
1029/*values for the PhyStatus field */
1030#define MPI2_EVENT_SAS_TOPO_PHYSTATUS_VACANT                (0x80)
1031#define MPI2_EVENT_SAS_TOPO_PS_MULTIPLEX_CHANGE             (0x10)
1032/*values for the PhyStatus ReasonCode sub-field */
1033#define MPI2_EVENT_SAS_TOPO_RC_MASK                         (0x0F)
1034#define MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED                   (0x01)
1035#define MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING          (0x02)
1036#define MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED                  (0x03)
1037#define MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE                    (0x04)
1038#define MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING         (0x05)
1039
1040/*SAS Enclosure Device Status Change Event data */
1041
1042typedef struct _MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE {
1043	U16 EnclosureHandle;	/*0x00 */
1044	U8 ReasonCode;		/*0x02 */
1045	U8 PhysicalPort;	/*0x03 */
1046	U64 EnclosureLogicalID;	/*0x04 */
1047	U16 NumSlots;		/*0x0C */
1048	U16 StartSlot;		/*0x0E */
1049	U32 PhyBits;		/*0x10 */
1050} MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE,
1051	*PTR_MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE,
1052	Mpi2EventDataSasEnclDevStatusChange_t,
1053	*pMpi2EventDataSasEnclDevStatusChange_t,
1054	MPI26_EVENT_DATA_ENCL_DEV_STATUS_CHANGE,
1055	*PTR_MPI26_EVENT_DATA_ENCL_DEV_STATUS_CHANGE,
1056	Mpi26EventDataEnclDevStatusChange_t,
1057	*pMpi26EventDataEnclDevStatusChange_t;
1058
1059/*SAS Enclosure Device Status Change event ReasonCode values */
1060#define MPI2_EVENT_SAS_ENCL_RC_ADDED                (0x01)
1061#define MPI2_EVENT_SAS_ENCL_RC_NOT_RESPONDING       (0x02)
1062
1063/*Enclosure Device Status Change event ReasonCode values */
1064#define MPI26_EVENT_ENCL_RC_ADDED                   (0x01)
1065#define MPI26_EVENT_ENCL_RC_NOT_RESPONDING          (0x02)
1066
1067
1068typedef struct _MPI25_EVENT_DATA_SAS_DEVICE_DISCOVERY_ERROR {
1069	U16	DevHandle;                  /*0x00 */
1070	U8	ReasonCode;                 /*0x02 */
1071	U8	PhysicalPort;               /*0x03 */
1072	U32	Reserved1[2];               /*0x04 */
1073	U64	SASAddress;                 /*0x0C */
1074	U32	Reserved2[2];               /*0x14 */
1075} MPI25_EVENT_DATA_SAS_DEVICE_DISCOVERY_ERROR,
1076	*PTR_MPI25_EVENT_DATA_SAS_DEVICE_DISCOVERY_ERROR,
1077	Mpi25EventDataSasDeviceDiscoveryError_t,
1078	*pMpi25EventDataSasDeviceDiscoveryError_t;
1079
1080/*SAS Device Discovery Error Event data ReasonCode values */
1081#define MPI25_EVENT_SAS_DISC_ERR_SMP_FAILED         (0x01)
1082#define MPI25_EVENT_SAS_DISC_ERR_SMP_TIMEOUT        (0x02)
1083
1084/*SAS PHY Counter Event data */
1085
1086typedef struct _MPI2_EVENT_DATA_SAS_PHY_COUNTER {
1087	U64 TimeStamp;		/*0x00 */
1088	U32 Reserved1;		/*0x08 */
1089	U8 PhyEventCode;	/*0x0C */
1090	U8 PhyNum;		/*0x0D */
1091	U16 Reserved2;		/*0x0E */
1092	U32 PhyEventInfo;	/*0x10 */
1093	U8 CounterType;		/*0x14 */
1094	U8 ThresholdWindow;	/*0x15 */
1095	U8 TimeUnits;		/*0x16 */
1096	U8 Reserved3;		/*0x17 */
1097	U32 EventThreshold;	/*0x18 */
1098	U16 ThresholdFlags;	/*0x1C */
1099	U16 Reserved4;		/*0x1E */
1100} MPI2_EVENT_DATA_SAS_PHY_COUNTER,
1101	*PTR_MPI2_EVENT_DATA_SAS_PHY_COUNTER,
1102	Mpi2EventDataSasPhyCounter_t,
1103	*pMpi2EventDataSasPhyCounter_t;
1104
1105/*use MPI2_SASPHY3_EVENT_CODE_ values from mpi2_cnfg.h
1106 *for the PhyEventCode field */
1107
1108/*use MPI2_SASPHY3_COUNTER_TYPE_ values from mpi2_cnfg.h
1109 *for the CounterType field */
1110
1111/*use MPI2_SASPHY3_TIME_UNITS_ values from mpi2_cnfg.h
1112 *for the TimeUnits field */
1113
1114/*use MPI2_SASPHY3_TFLAGS_ values from mpi2_cnfg.h
1115 *for the ThresholdFlags field */
1116
1117/*SAS Quiesce Event data */
1118
1119typedef struct _MPI2_EVENT_DATA_SAS_QUIESCE {
1120	U8 ReasonCode;		/*0x00 */
1121	U8 Reserved1;		/*0x01 */
1122	U16 Reserved2;		/*0x02 */
1123	U32 Reserved3;		/*0x04 */
1124} MPI2_EVENT_DATA_SAS_QUIESCE,
1125	*PTR_MPI2_EVENT_DATA_SAS_QUIESCE,
1126	Mpi2EventDataSasQuiesce_t, *pMpi2EventDataSasQuiesce_t;
1127
1128/*SAS Quiesce Event data ReasonCode values */
1129#define MPI2_EVENT_SAS_QUIESCE_RC_STARTED                   (0x01)
1130#define MPI2_EVENT_SAS_QUIESCE_RC_COMPLETED                 (0x02)
1131
1132/*Host Based Discovery Phy Event data */
1133
1134typedef struct _MPI2_EVENT_HBD_PHY_SAS {
1135	U8 Flags;		/*0x00 */
1136	U8 NegotiatedLinkRate;	/*0x01 */
1137	U8 PhyNum;		/*0x02 */
1138	U8 PhysicalPort;	/*0x03 */
1139	U32 Reserved1;		/*0x04 */
1140	U8 InitialFrame[28];	/*0x08 */
1141} MPI2_EVENT_HBD_PHY_SAS, *PTR_MPI2_EVENT_HBD_PHY_SAS,
1142	Mpi2EventHbdPhySas_t, *pMpi2EventHbdPhySas_t;
1143
1144/*values for the Flags field */
1145#define MPI2_EVENT_HBD_SAS_FLAGS_FRAME_VALID        (0x02)
1146#define MPI2_EVENT_HBD_SAS_FLAGS_SATA_FRAME         (0x01)
1147
1148/*use MPI2_SAS_NEG_LINK_RATE_ defines from mpi2_cnfg.h
1149 *for the NegotiatedLinkRate field */
1150
1151typedef union _MPI2_EVENT_HBD_DESCRIPTOR {
1152	MPI2_EVENT_HBD_PHY_SAS Sas;
1153} MPI2_EVENT_HBD_DESCRIPTOR, *PTR_MPI2_EVENT_HBD_DESCRIPTOR,
1154	Mpi2EventHbdDescriptor_t, *pMpi2EventHbdDescriptor_t;
1155
1156typedef struct _MPI2_EVENT_DATA_HBD_PHY {
1157	U8 DescriptorType;	/*0x00 */
1158	U8 Reserved1;		/*0x01 */
1159	U16 Reserved2;		/*0x02 */
1160	U32 Reserved3;		/*0x04 */
1161	MPI2_EVENT_HBD_DESCRIPTOR Descriptor;	/*0x08 */
1162} MPI2_EVENT_DATA_HBD_PHY, *PTR_MPI2_EVENT_DATA_HBD_PHY,
1163	Mpi2EventDataHbdPhy_t,
1164	*pMpi2EventDataMpi2EventDataHbdPhy_t;
1165
1166/*values for the DescriptorType field */
1167#define MPI2_EVENT_HBD_DT_SAS               (0x01)
1168
1169
1170/*PCIe Device Status Change Event data (MPI v2.6 and later) */
1171
1172typedef struct _MPI26_EVENT_DATA_PCIE_DEVICE_STATUS_CHANGE {
1173	U16	TaskTag;                        /*0x00 */
1174	U8	ReasonCode;                     /*0x02 */
1175	U8	PhysicalPort;                   /*0x03 */
1176	U8	ASC;                            /*0x04 */
1177	U8	ASCQ;                           /*0x05 */
1178	U16	DevHandle;                      /*0x06 */
1179	U32	Reserved2;                      /*0x08 */
1180	U64	WWID;                           /*0x0C */
1181	U8	LUN[8];                         /*0x14 */
1182} MPI26_EVENT_DATA_PCIE_DEVICE_STATUS_CHANGE,
1183	*PTR_MPI26_EVENT_DATA_PCIE_DEVICE_STATUS_CHANGE,
1184	Mpi26EventDataPCIeDeviceStatusChange_t,
1185	*pMpi26EventDataPCIeDeviceStatusChange_t;
1186
1187/*PCIe Device Status Change Event data ReasonCode values */
1188#define MPI26_EVENT_PCIDEV_STAT_RC_SMART_DATA                           (0x05)
1189#define MPI26_EVENT_PCIDEV_STAT_RC_UNSUPPORTED                          (0x07)
1190#define MPI26_EVENT_PCIDEV_STAT_RC_INTERNAL_DEVICE_RESET                (0x08)
1191#define MPI26_EVENT_PCIDEV_STAT_RC_TASK_ABORT_INTERNAL                  (0x09)
1192#define MPI26_EVENT_PCIDEV_STAT_RC_ABORT_TASK_SET_INTERNAL              (0x0A)
1193#define MPI26_EVENT_PCIDEV_STAT_RC_CLEAR_TASK_SET_INTERNAL              (0x0B)
1194#define MPI26_EVENT_PCIDEV_STAT_RC_QUERY_TASK_INTERNAL                  (0x0C)
1195#define MPI26_EVENT_PCIDEV_STAT_RC_ASYNC_NOTIFICATION                   (0x0D)
1196#define MPI26_EVENT_PCIDEV_STAT_RC_CMP_INTERNAL_DEV_RESET               (0x0E)
1197#define MPI26_EVENT_PCIDEV_STAT_RC_CMP_TASK_ABORT_INTERNAL              (0x0F)
1198#define MPI26_EVENT_PCIDEV_STAT_RC_DEV_INIT_FAILURE                     (0x10)
1199#define MPI26_EVENT_PCIDEV_STAT_RC_PCIE_HOT_RESET_FAILED                (0x11)
1200
1201
1202/*PCIe Enumeration Event data (MPI v2.6 and later) */
1203
1204typedef struct _MPI26_EVENT_DATA_PCIE_ENUMERATION {
1205	U8	Flags;                      /*0x00 */
1206	U8	ReasonCode;                 /*0x01 */
1207	U8	PhysicalPort;               /*0x02 */
1208	U8	Reserved1;                  /*0x03 */
1209	U32	EnumerationStatus;          /*0x04 */
1210} MPI26_EVENT_DATA_PCIE_ENUMERATION,
1211	*PTR_MPI26_EVENT_DATA_PCIE_ENUMERATION,
1212	Mpi26EventDataPCIeEnumeration_t,
1213	*pMpi26EventDataPCIeEnumeration_t;
1214
1215/*PCIe Enumeration Event data Flags values */
1216#define MPI26_EVENT_PCIE_ENUM_DEVICE_CHANGE                 (0x02)
1217#define MPI26_EVENT_PCIE_ENUM_IN_PROGRESS                   (0x01)
1218
1219/*PCIe Enumeration Event data ReasonCode values */
1220#define MPI26_EVENT_PCIE_ENUM_RC_STARTED                    (0x01)
1221#define MPI26_EVENT_PCIE_ENUM_RC_COMPLETED                  (0x02)
1222
1223/*PCIe Enumeration Event data EnumerationStatus values */
1224#define MPI26_EVENT_PCIE_ENUM_ES_MAX_SWITCHES_EXCEED            (0x40000000)
1225#define MPI26_EVENT_PCIE_ENUM_ES_MAX_DEVICES_EXCEED             (0x20000000)
1226#define MPI26_EVENT_PCIE_ENUM_ES_RESOURCES_EXHAUSTED            (0x10000000)
1227
1228
1229/*PCIe Topology Change List Event data (MPI v2.6 and later) */
1230
1231/*
1232 *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
1233 *one and check NumEntries at runtime.
1234 */
1235#ifndef MPI26_EVENT_PCIE_TOPO_PORT_COUNT
1236#define MPI26_EVENT_PCIE_TOPO_PORT_COUNT        (1)
1237#endif
1238
1239typedef struct _MPI26_EVENT_PCIE_TOPO_PORT_ENTRY {
1240	U16	AttachedDevHandle;      /*0x00 */
1241	U8	PortStatus;             /*0x02 */
1242	U8	Reserved1;              /*0x03 */
1243	U8	CurrentPortInfo;        /*0x04 */
1244	U8	Reserved2;              /*0x05 */
1245	U8	PreviousPortInfo;       /*0x06 */
1246	U8	Reserved3;              /*0x07 */
1247} MPI26_EVENT_PCIE_TOPO_PORT_ENTRY,
1248	*PTR_MPI26_EVENT_PCIE_TOPO_PORT_ENTRY,
1249	Mpi26EventPCIeTopoPortEntry_t,
1250	*pMpi26EventPCIeTopoPortEntry_t;
1251
1252/*PCIe Topology Change List Event data PortStatus values */
1253#define MPI26_EVENT_PCIE_TOPO_PS_DEV_ADDED                  (0x01)
1254#define MPI26_EVENT_PCIE_TOPO_PS_NOT_RESPONDING             (0x02)
1255#define MPI26_EVENT_PCIE_TOPO_PS_PORT_CHANGED               (0x03)
1256#define MPI26_EVENT_PCIE_TOPO_PS_NO_CHANGE                  (0x04)
1257#define MPI26_EVENT_PCIE_TOPO_PS_DELAY_NOT_RESPONDING       (0x05)
1258
1259/*PCIe Topology Change List Event data defines for CurrentPortInfo and
1260 *PreviousPortInfo
1261 */
1262#define MPI26_EVENT_PCIE_TOPO_PI_LANE_MASK                  (0xF0)
1263#define MPI26_EVENT_PCIE_TOPO_PI_LANES_UNKNOWN              (0x00)
1264#define MPI26_EVENT_PCIE_TOPO_PI_1_LANE                     (0x10)
1265#define MPI26_EVENT_PCIE_TOPO_PI_2_LANES                    (0x20)
1266#define MPI26_EVENT_PCIE_TOPO_PI_4_LANES                    (0x30)
1267#define MPI26_EVENT_PCIE_TOPO_PI_8_LANES                    (0x40)
1268#define MPI26_EVENT_PCIE_TOPO_PI_16_LANES                   (0x50)
1269
1270#define MPI26_EVENT_PCIE_TOPO_PI_RATE_MASK                  (0x0F)
1271#define MPI26_EVENT_PCIE_TOPO_PI_RATE_UNKNOWN               (0x00)
1272#define MPI26_EVENT_PCIE_TOPO_PI_RATE_DISABLED              (0x01)
1273#define MPI26_EVENT_PCIE_TOPO_PI_RATE_2_5                   (0x02)
1274#define MPI26_EVENT_PCIE_TOPO_PI_RATE_5_0                   (0x03)
1275#define MPI26_EVENT_PCIE_TOPO_PI_RATE_8_0                   (0x04)
1276#define MPI26_EVENT_PCIE_TOPO_PI_RATE_16_0                  (0x05)
1277
1278typedef struct _MPI26_EVENT_DATA_PCIE_TOPOLOGY_CHANGE_LIST {
1279	U16	EnclosureHandle;        /*0x00 */
1280	U16	SwitchDevHandle;        /*0x02 */
1281	U8	NumPorts;               /*0x04 */
1282	U8	Reserved1;              /*0x05 */
1283	U16	Reserved2;              /*0x06 */
1284	U8	NumEntries;             /*0x08 */
1285	U8	StartPortNum;           /*0x09 */
1286	U8	SwitchStatus;           /*0x0A */
1287	U8	PhysicalPort;           /*0x0B */
1288	MPI26_EVENT_PCIE_TOPO_PORT_ENTRY
1289		PortEntry[MPI26_EVENT_PCIE_TOPO_PORT_COUNT]; /*0x0C */
1290} MPI26_EVENT_DATA_PCIE_TOPOLOGY_CHANGE_LIST,
1291	*PTR_MPI26_EVENT_DATA_PCIE_TOPOLOGY_CHANGE_LIST,
1292	Mpi26EventDataPCIeTopologyChangeList_t,
1293	*pMpi26EventDataPCIeTopologyChangeList_t;
1294
1295/*PCIe Topology Change List Event data SwitchStatus values */
1296#define MPI26_EVENT_PCIE_TOPO_SS_NO_PCIE_SWITCH             (0x00)
1297#define MPI26_EVENT_PCIE_TOPO_SS_ADDED                      (0x01)
1298#define MPI26_EVENT_PCIE_TOPO_SS_NOT_RESPONDING             (0x02)
1299#define MPI26_EVENT_PCIE_TOPO_SS_RESPONDING                 (0x03)
1300#define MPI26_EVENT_PCIE_TOPO_SS_DELAY_NOT_RESPONDING       (0x04)
1301
1302/*PCIe Link Counter Event data (MPI v2.6 and later) */
1303
1304typedef struct _MPI26_EVENT_DATA_PCIE_LINK_COUNTER {
1305	U64	TimeStamp;          /*0x00 */
1306	U32	Reserved1;          /*0x08 */
1307	U8	LinkEventCode;      /*0x0C */
1308	U8	LinkNum;            /*0x0D */
1309	U16	Reserved2;          /*0x0E */
1310	U32	LinkEventInfo;      /*0x10 */
1311	U8	CounterType;        /*0x14 */
1312	U8	ThresholdWindow;    /*0x15 */
1313	U8	TimeUnits;          /*0x16 */
1314	U8	Reserved3;          /*0x17 */
1315	U32	EventThreshold;     /*0x18 */
1316	U16	ThresholdFlags;     /*0x1C */
1317	U16	Reserved4;          /*0x1E */
1318} MPI26_EVENT_DATA_PCIE_LINK_COUNTER,
1319	*PTR_MPI26_EVENT_DATA_PCIE_LINK_COUNTER,
1320	Mpi26EventDataPcieLinkCounter_t, *pMpi26EventDataPcieLinkCounter_t;
1321
1322
1323/*use MPI26_PCIELINK3_EVTCODE_ values from mpi2_cnfg.h for the LinkEventCode
1324 *field
1325 */
1326
1327/*use MPI26_PCIELINK3_COUNTER_TYPE_ values from mpi2_cnfg.h for the CounterType
1328 *field
1329 */
1330
1331/*use MPI26_PCIELINK3_TIME_UNITS_ values from mpi2_cnfg.h for the TimeUnits
1332 *field
1333 */
1334
1335/*use MPI26_PCIELINK3_TFLAGS_ values from mpi2_cnfg.h for the ThresholdFlags
1336 *field
1337 */
1338
1339/****************************************************************************
1340* EventAck message
1341****************************************************************************/
1342
1343/*EventAck Request message */
1344typedef struct _MPI2_EVENT_ACK_REQUEST {
1345	U16 Reserved1;		/*0x00 */
1346	U8 ChainOffset;		/*0x02 */
1347	U8 Function;		/*0x03 */
1348	U16 Reserved2;		/*0x04 */
1349	U8 Reserved3;		/*0x06 */
1350	U8 MsgFlags;		/*0x07 */
1351	U8 VP_ID;		/*0x08 */
1352	U8 VF_ID;		/*0x09 */
1353	U16 Reserved4;		/*0x0A */
1354	U16 Event;		/*0x0C */
1355	U16 Reserved5;		/*0x0E */
1356	U32 EventContext;	/*0x10 */
1357} MPI2_EVENT_ACK_REQUEST, *PTR_MPI2_EVENT_ACK_REQUEST,
1358	Mpi2EventAckRequest_t, *pMpi2EventAckRequest_t;
1359
1360/*EventAck Reply message */
1361typedef struct _MPI2_EVENT_ACK_REPLY {
1362	U16 Reserved1;		/*0x00 */
1363	U8 MsgLength;		/*0x02 */
1364	U8 Function;		/*0x03 */
1365	U16 Reserved2;		/*0x04 */
1366	U8 Reserved3;		/*0x06 */
1367	U8 MsgFlags;		/*0x07 */
1368	U8 VP_ID;		/*0x08 */
1369	U8 VF_ID;		/*0x09 */
1370	U16 Reserved4;		/*0x0A */
1371	U16 Reserved5;		/*0x0C */
1372	U16 IOCStatus;		/*0x0E */
1373	U32 IOCLogInfo;		/*0x10 */
1374} MPI2_EVENT_ACK_REPLY, *PTR_MPI2_EVENT_ACK_REPLY,
1375	Mpi2EventAckReply_t, *pMpi2EventAckReply_t;
1376
1377/****************************************************************************
1378* SendHostMessage message
1379****************************************************************************/
1380
1381/*SendHostMessage Request message */
1382typedef struct _MPI2_SEND_HOST_MESSAGE_REQUEST {
1383	U16 HostDataLength;	/*0x00 */
1384	U8 ChainOffset;		/*0x02 */
1385	U8 Function;		/*0x03 */
1386	U16 Reserved1;		/*0x04 */
1387	U8 Reserved2;		/*0x06 */
1388	U8 MsgFlags;		/*0x07 */
1389	U8 VP_ID;		/*0x08 */
1390	U8 VF_ID;		/*0x09 */
1391	U16 Reserved3;		/*0x0A */
1392	U8 Reserved4;		/*0x0C */
1393	U8 DestVF_ID;		/*0x0D */
1394	U16 Reserved5;		/*0x0E */
1395	U32 Reserved6;		/*0x10 */
1396	U32 Reserved7;		/*0x14 */
1397	U32 Reserved8;		/*0x18 */
1398	U32 Reserved9;		/*0x1C */
1399	U32 Reserved10;		/*0x20 */
1400	U32 HostData[];		/*0x24 */
1401} MPI2_SEND_HOST_MESSAGE_REQUEST,
1402	*PTR_MPI2_SEND_HOST_MESSAGE_REQUEST,
1403	Mpi2SendHostMessageRequest_t,
1404	*pMpi2SendHostMessageRequest_t;
1405
1406/*SendHostMessage Reply message */
1407typedef struct _MPI2_SEND_HOST_MESSAGE_REPLY {
1408	U16 HostDataLength;	/*0x00 */
1409	U8 MsgLength;		/*0x02 */
1410	U8 Function;		/*0x03 */
1411	U16 Reserved1;		/*0x04 */
1412	U8 Reserved2;		/*0x06 */
1413	U8 MsgFlags;		/*0x07 */
1414	U8 VP_ID;		/*0x08 */
1415	U8 VF_ID;		/*0x09 */
1416	U16 Reserved3;		/*0x0A */
1417	U16 Reserved4;		/*0x0C */
1418	U16 IOCStatus;		/*0x0E */
1419	U32 IOCLogInfo;		/*0x10 */
1420} MPI2_SEND_HOST_MESSAGE_REPLY, *PTR_MPI2_SEND_HOST_MESSAGE_REPLY,
1421	Mpi2SendHostMessageReply_t, *pMpi2SendHostMessageReply_t;
1422
1423/****************************************************************************
1424* FWDownload message
1425****************************************************************************/
1426
1427/*MPI v2.0 FWDownload Request message */
1428typedef struct _MPI2_FW_DOWNLOAD_REQUEST {
1429	U8 ImageType;		/*0x00 */
1430	U8 Reserved1;		/*0x01 */
1431	U8 ChainOffset;		/*0x02 */
1432	U8 Function;		/*0x03 */
1433	U16 Reserved2;		/*0x04 */
1434	U8 Reserved3;		/*0x06 */
1435	U8 MsgFlags;		/*0x07 */
1436	U8 VP_ID;		/*0x08 */
1437	U8 VF_ID;		/*0x09 */
1438	U16 Reserved4;		/*0x0A */
1439	U32 TotalImageSize;	/*0x0C */
1440	U32 Reserved5;		/*0x10 */
1441	MPI2_MPI_SGE_UNION SGL;	/*0x14 */
1442} MPI2_FW_DOWNLOAD_REQUEST, *PTR_MPI2_FW_DOWNLOAD_REQUEST,
1443	Mpi2FWDownloadRequest, *pMpi2FWDownloadRequest;
1444
1445#define MPI2_FW_DOWNLOAD_MSGFLGS_LAST_SEGMENT   (0x01)
1446
1447#define MPI2_FW_DOWNLOAD_ITYPE_FW                   (0x01)
1448#define MPI2_FW_DOWNLOAD_ITYPE_BIOS                 (0x02)
1449#define MPI2_FW_DOWNLOAD_ITYPE_MANUFACTURING        (0x06)
1450#define MPI2_FW_DOWNLOAD_ITYPE_CONFIG_1             (0x07)
1451#define MPI2_FW_DOWNLOAD_ITYPE_CONFIG_2             (0x08)
1452#define MPI2_FW_DOWNLOAD_ITYPE_MEGARAID             (0x09)
1453#define MPI2_FW_DOWNLOAD_ITYPE_COMPLETE             (0x0A)
1454#define MPI2_FW_DOWNLOAD_ITYPE_COMMON_BOOT_BLOCK    (0x0B)
1455#define MPI2_FW_DOWNLOAD_ITYPE_PUBLIC_KEY           (0x0C)
1456#define MPI2_FW_DOWNLOAD_ITYPE_CBB_BACKUP           (0x0D)
1457#define MPI2_FW_DOWNLOAD_ITYPE_SBR                  (0x0E)
1458#define MPI2_FW_DOWNLOAD_ITYPE_SBR_BACKUP           (0x0F)
1459#define MPI2_FW_DOWNLOAD_ITYPE_HIIM                 (0x10)
1460#define MPI2_FW_DOWNLOAD_ITYPE_HIIA                 (0x11)
1461#define MPI2_FW_DOWNLOAD_ITYPE_CTLR                 (0x12)
1462#define MPI2_FW_DOWNLOAD_ITYPE_IMR_FIRMWARE         (0x13)
1463#define MPI2_FW_DOWNLOAD_ITYPE_MR_NVDATA            (0x14)
1464/*MPI v2.6 and newer */
1465#define MPI2_FW_DOWNLOAD_ITYPE_CPLD                 (0x15)
1466#define MPI2_FW_DOWNLOAD_ITYPE_PSOC                 (0x16)
1467#define MPI2_FW_DOWNLOAD_ITYPE_COREDUMP             (0x17)
1468#define MPI2_FW_DOWNLOAD_ITYPE_MIN_PRODUCT_SPECIFIC (0xF0)
1469
1470/*MPI v2.0 FWDownload TransactionContext Element */
1471typedef struct _MPI2_FW_DOWNLOAD_TCSGE {
1472	U8 Reserved1;		/*0x00 */
1473	U8 ContextSize;		/*0x01 */
1474	U8 DetailsLength;	/*0x02 */
1475	U8 Flags;		/*0x03 */
1476	U32 Reserved2;		/*0x04 */
1477	U32 ImageOffset;	/*0x08 */
1478	U32 ImageSize;		/*0x0C */
1479} MPI2_FW_DOWNLOAD_TCSGE, *PTR_MPI2_FW_DOWNLOAD_TCSGE,
1480	Mpi2FWDownloadTCSGE_t, *pMpi2FWDownloadTCSGE_t;
1481
1482/*MPI v2.5 FWDownload Request message */
1483typedef struct _MPI25_FW_DOWNLOAD_REQUEST {
1484	U8 ImageType;		/*0x00 */
1485	U8 Reserved1;		/*0x01 */
1486	U8 ChainOffset;		/*0x02 */
1487	U8 Function;		/*0x03 */
1488	U16 Reserved2;		/*0x04 */
1489	U8 Reserved3;		/*0x06 */
1490	U8 MsgFlags;		/*0x07 */
1491	U8 VP_ID;		/*0x08 */
1492	U8 VF_ID;		/*0x09 */
1493	U16 Reserved4;		/*0x0A */
1494	U32 TotalImageSize;	/*0x0C */
1495	U32 Reserved5;		/*0x10 */
1496	U32 Reserved6;		/*0x14 */
1497	U32 ImageOffset;	/*0x18 */
1498	U32 ImageSize;		/*0x1C */
1499	MPI25_SGE_IO_UNION SGL;	/*0x20 */
1500} MPI25_FW_DOWNLOAD_REQUEST, *PTR_MPI25_FW_DOWNLOAD_REQUEST,
1501	Mpi25FWDownloadRequest, *pMpi25FWDownloadRequest;
1502
1503/*FWDownload Reply message */
1504typedef struct _MPI2_FW_DOWNLOAD_REPLY {
1505	U8 ImageType;		/*0x00 */
1506	U8 Reserved1;		/*0x01 */
1507	U8 MsgLength;		/*0x02 */
1508	U8 Function;		/*0x03 */
1509	U16 Reserved2;		/*0x04 */
1510	U8 Reserved3;		/*0x06 */
1511	U8 MsgFlags;		/*0x07 */
1512	U8 VP_ID;		/*0x08 */
1513	U8 VF_ID;		/*0x09 */
1514	U16 Reserved4;		/*0x0A */
1515	U16 Reserved5;		/*0x0C */
1516	U16 IOCStatus;		/*0x0E */
1517	U32 IOCLogInfo;		/*0x10 */
1518} MPI2_FW_DOWNLOAD_REPLY, *PTR_MPI2_FW_DOWNLOAD_REPLY,
1519	Mpi2FWDownloadReply_t, *pMpi2FWDownloadReply_t;
1520
1521/****************************************************************************
1522* FWUpload message
1523****************************************************************************/
1524
1525/*MPI v2.0 FWUpload Request message */
1526typedef struct _MPI2_FW_UPLOAD_REQUEST {
1527	U8 ImageType;		/*0x00 */
1528	U8 Reserved1;		/*0x01 */
1529	U8 ChainOffset;		/*0x02 */
1530	U8 Function;		/*0x03 */
1531	U16 Reserved2;		/*0x04 */
1532	U8 Reserved3;		/*0x06 */
1533	U8 MsgFlags;		/*0x07 */
1534	U8 VP_ID;		/*0x08 */
1535	U8 VF_ID;		/*0x09 */
1536	U16 Reserved4;		/*0x0A */
1537	U32 Reserved5;		/*0x0C */
1538	U32 Reserved6;		/*0x10 */
1539	MPI2_MPI_SGE_UNION SGL;	/*0x14 */
1540} MPI2_FW_UPLOAD_REQUEST, *PTR_MPI2_FW_UPLOAD_REQUEST,
1541	Mpi2FWUploadRequest_t, *pMpi2FWUploadRequest_t;
1542
1543#define MPI2_FW_UPLOAD_ITYPE_FW_CURRENT         (0x00)
1544#define MPI2_FW_UPLOAD_ITYPE_FW_FLASH           (0x01)
1545#define MPI2_FW_UPLOAD_ITYPE_BIOS_FLASH         (0x02)
1546#define MPI2_FW_UPLOAD_ITYPE_FW_BACKUP          (0x05)
1547#define MPI2_FW_UPLOAD_ITYPE_MANUFACTURING      (0x06)
1548#define MPI2_FW_UPLOAD_ITYPE_CONFIG_1           (0x07)
1549#define MPI2_FW_UPLOAD_ITYPE_CONFIG_2           (0x08)
1550#define MPI2_FW_UPLOAD_ITYPE_MEGARAID           (0x09)
1551#define MPI2_FW_UPLOAD_ITYPE_COMPLETE           (0x0A)
1552#define MPI2_FW_UPLOAD_ITYPE_COMMON_BOOT_BLOCK  (0x0B)
1553#define MPI2_FW_UPLOAD_ITYPE_CBB_BACKUP         (0x0D)
1554#define MPI2_FW_UPLOAD_ITYPE_SBR                (0x0E)
1555#define MPI2_FW_UPLOAD_ITYPE_SBR_BACKUP         (0x0F)
1556#define MPI2_FW_UPLOAD_ITYPE_HIIM               (0x10)
1557#define MPI2_FW_UPLOAD_ITYPE_HIIA               (0x11)
1558#define MPI2_FW_UPLOAD_ITYPE_CTLR               (0x12)
1559#define MPI2_FW_UPLOAD_ITYPE_IMR_FIRMWARE       (0x13)
1560#define MPI2_FW_UPLOAD_ITYPE_MR_NVDATA          (0x14)
1561
1562
1563/*MPI v2.0 FWUpload TransactionContext Element */
1564typedef struct _MPI2_FW_UPLOAD_TCSGE {
1565	U8 Reserved1;		/*0x00 */
1566	U8 ContextSize;		/*0x01 */
1567	U8 DetailsLength;	/*0x02 */
1568	U8 Flags;		/*0x03 */
1569	U32 Reserved2;		/*0x04 */
1570	U32 ImageOffset;	/*0x08 */
1571	U32 ImageSize;		/*0x0C */
1572} MPI2_FW_UPLOAD_TCSGE, *PTR_MPI2_FW_UPLOAD_TCSGE,
1573	Mpi2FWUploadTCSGE_t, *pMpi2FWUploadTCSGE_t;
1574
1575/*MPI v2.5 FWUpload Request message */
1576typedef struct _MPI25_FW_UPLOAD_REQUEST {
1577	U8 ImageType;		/*0x00 */
1578	U8 Reserved1;		/*0x01 */
1579	U8 ChainOffset;		/*0x02 */
1580	U8 Function;		/*0x03 */
1581	U16 Reserved2;		/*0x04 */
1582	U8 Reserved3;		/*0x06 */
1583	U8 MsgFlags;		/*0x07 */
1584	U8 VP_ID;		/*0x08 */
1585	U8 VF_ID;		/*0x09 */
1586	U16 Reserved4;		/*0x0A */
1587	U32 Reserved5;		/*0x0C */
1588	U32 Reserved6;		/*0x10 */
1589	U32 Reserved7;		/*0x14 */
1590	U32 ImageOffset;	/*0x18 */
1591	U32 ImageSize;		/*0x1C */
1592	MPI25_SGE_IO_UNION SGL;	/*0x20 */
1593} MPI25_FW_UPLOAD_REQUEST, *PTR_MPI25_FW_UPLOAD_REQUEST,
1594	Mpi25FWUploadRequest_t, *pMpi25FWUploadRequest_t;
1595
1596/*FWUpload Reply message */
1597typedef struct _MPI2_FW_UPLOAD_REPLY {
1598	U8 ImageType;		/*0x00 */
1599	U8 Reserved1;		/*0x01 */
1600	U8 MsgLength;		/*0x02 */
1601	U8 Function;		/*0x03 */
1602	U16 Reserved2;		/*0x04 */
1603	U8 Reserved3;		/*0x06 */
1604	U8 MsgFlags;		/*0x07 */
1605	U8 VP_ID;		/*0x08 */
1606	U8 VF_ID;		/*0x09 */
1607	U16 Reserved4;		/*0x0A */
1608	U16 Reserved5;		/*0x0C */
1609	U16 IOCStatus;		/*0x0E */
1610	U32 IOCLogInfo;		/*0x10 */
1611	U32 ActualImageSize;	/*0x14 */
1612} MPI2_FW_UPLOAD_REPLY, *PTR_MPI2_FW_UPLOAD_REPLY,
1613	Mpi2FWUploadReply_t, *pMPi2FWUploadReply_t;
1614
1615
1616/****************************************************************************
1617* PowerManagementControl message
1618****************************************************************************/
1619
1620/*PowerManagementControl Request message */
1621typedef struct _MPI2_PWR_MGMT_CONTROL_REQUEST {
1622	U8 Feature;		/*0x00 */
1623	U8 Reserved1;		/*0x01 */
1624	U8 ChainOffset;		/*0x02 */
1625	U8 Function;		/*0x03 */
1626	U16 Reserved2;		/*0x04 */
1627	U8 Reserved3;		/*0x06 */
1628	U8 MsgFlags;		/*0x07 */
1629	U8 VP_ID;		/*0x08 */
1630	U8 VF_ID;		/*0x09 */
1631	U16 Reserved4;		/*0x0A */
1632	U8 Parameter1;		/*0x0C */
1633	U8 Parameter2;		/*0x0D */
1634	U8 Parameter3;		/*0x0E */
1635	U8 Parameter4;		/*0x0F */
1636	U32 Reserved5;		/*0x10 */
1637	U32 Reserved6;		/*0x14 */
1638} MPI2_PWR_MGMT_CONTROL_REQUEST, *PTR_MPI2_PWR_MGMT_CONTROL_REQUEST,
1639	Mpi2PwrMgmtControlRequest_t, *pMpi2PwrMgmtControlRequest_t;
1640
1641/*defines for the Feature field */
1642#define MPI2_PM_CONTROL_FEATURE_DA_PHY_POWER_COND       (0x01)
1643#define MPI2_PM_CONTROL_FEATURE_PORT_WIDTH_MODULATION   (0x02)
1644#define MPI2_PM_CONTROL_FEATURE_PCIE_LINK               (0x03)	/*obsolete */
1645#define MPI2_PM_CONTROL_FEATURE_IOC_SPEED               (0x04)
1646#define MPI2_PM_CONTROL_FEATURE_GLOBAL_PWR_MGMT_MODE    (0x05)
1647#define MPI2_PM_CONTROL_FEATURE_MIN_PRODUCT_SPECIFIC    (0x80)
1648#define MPI2_PM_CONTROL_FEATURE_MAX_PRODUCT_SPECIFIC    (0xFF)
1649
1650/*parameter usage for the MPI2_PM_CONTROL_FEATURE_DA_PHY_POWER_COND Feature */
1651/*Parameter1 contains a PHY number */
1652/*Parameter2 indicates power condition action using these defines */
1653#define MPI2_PM_CONTROL_PARAM2_PARTIAL                  (0x01)
1654#define MPI2_PM_CONTROL_PARAM2_SLUMBER                  (0x02)
1655#define MPI2_PM_CONTROL_PARAM2_EXIT_PWR_MGMT            (0x03)
1656/*Parameter3 and Parameter4 are reserved */
1657
1658/*parameter usage for the MPI2_PM_CONTROL_FEATURE_PORT_WIDTH_MODULATION
1659 * Feature */
1660/*Parameter1 contains SAS port width modulation group number */
1661/*Parameter2 indicates IOC action using these defines */
1662#define MPI2_PM_CONTROL_PARAM2_REQUEST_OWNERSHIP        (0x01)
1663#define MPI2_PM_CONTROL_PARAM2_CHANGE_MODULATION        (0x02)
1664#define MPI2_PM_CONTROL_PARAM2_RELINQUISH_OWNERSHIP     (0x03)
1665/*Parameter3 indicates desired modulation level using these defines */
1666#define MPI2_PM_CONTROL_PARAM3_25_PERCENT               (0x00)
1667#define MPI2_PM_CONTROL_PARAM3_50_PERCENT               (0x01)
1668#define MPI2_PM_CONTROL_PARAM3_75_PERCENT               (0x02)
1669#define MPI2_PM_CONTROL_PARAM3_100_PERCENT              (0x03)
1670/*Parameter4 is reserved */
1671
1672/*this next set (_PCIE_LINK) is obsolete */
1673/*parameter usage for the MPI2_PM_CONTROL_FEATURE_PCIE_LINK Feature */
1674/*Parameter1 indicates desired PCIe link speed using these defines */
1675#define MPI2_PM_CONTROL_PARAM1_PCIE_2_5_GBPS            (0x00)	/*obsolete */
1676#define MPI2_PM_CONTROL_PARAM1_PCIE_5_0_GBPS            (0x01)	/*obsolete */
1677#define MPI2_PM_CONTROL_PARAM1_PCIE_8_0_GBPS            (0x02)	/*obsolete */
1678/*Parameter2 indicates desired PCIe link width using these defines */
1679#define MPI2_PM_CONTROL_PARAM2_WIDTH_X1                 (0x01)	/*obsolete */
1680#define MPI2_PM_CONTROL_PARAM2_WIDTH_X2                 (0x02)	/*obsolete */
1681#define MPI2_PM_CONTROL_PARAM2_WIDTH_X4                 (0x04)	/*obsolete */
1682#define MPI2_PM_CONTROL_PARAM2_WIDTH_X8                 (0x08)	/*obsolete */
1683/*Parameter3 and Parameter4 are reserved */
1684
1685/*parameter usage for the MPI2_PM_CONTROL_FEATURE_IOC_SPEED Feature */
1686/*Parameter1 indicates desired IOC hardware clock speed using these defines */
1687#define MPI2_PM_CONTROL_PARAM1_FULL_IOC_SPEED           (0x01)
1688#define MPI2_PM_CONTROL_PARAM1_HALF_IOC_SPEED           (0x02)
1689#define MPI2_PM_CONTROL_PARAM1_QUARTER_IOC_SPEED        (0x04)
1690#define MPI2_PM_CONTROL_PARAM1_EIGHTH_IOC_SPEED         (0x08)
1691/*Parameter2, Parameter3, and Parameter4 are reserved */
1692
1693/*parameter usage for the MPI2_PM_CONTROL_FEATURE_GLOBAL_PWR_MGMT_MODE Feature*/
1694/*Parameter1 indicates host action regarding global power management mode */
1695#define MPI2_PM_CONTROL_PARAM1_TAKE_CONTROL             (0x01)
1696#define MPI2_PM_CONTROL_PARAM1_CHANGE_GLOBAL_MODE       (0x02)
1697#define MPI2_PM_CONTROL_PARAM1_RELEASE_CONTROL          (0x03)
1698/*Parameter2 indicates the requested global power management mode */
1699#define MPI2_PM_CONTROL_PARAM2_FULL_PWR_PERF            (0x01)
1700#define MPI2_PM_CONTROL_PARAM2_REDUCED_PWR_PERF         (0x08)
1701#define MPI2_PM_CONTROL_PARAM2_STANDBY                  (0x40)
1702/*Parameter3 and Parameter4 are reserved */
1703
1704/*PowerManagementControl Reply message */
1705typedef struct _MPI2_PWR_MGMT_CONTROL_REPLY {
1706	U8 Feature;		/*0x00 */
1707	U8 Reserved1;		/*0x01 */
1708	U8 MsgLength;		/*0x02 */
1709	U8 Function;		/*0x03 */
1710	U16 Reserved2;		/*0x04 */
1711	U8 Reserved3;		/*0x06 */
1712	U8 MsgFlags;		/*0x07 */
1713	U8 VP_ID;		/*0x08 */
1714	U8 VF_ID;		/*0x09 */
1715	U16 Reserved4;		/*0x0A */
1716	U16 Reserved5;		/*0x0C */
1717	U16 IOCStatus;		/*0x0E */
1718	U32 IOCLogInfo;		/*0x10 */
1719} MPI2_PWR_MGMT_CONTROL_REPLY, *PTR_MPI2_PWR_MGMT_CONTROL_REPLY,
1720	Mpi2PwrMgmtControlReply_t, *pMpi2PwrMgmtControlReply_t;
1721
1722/****************************************************************************
1723*  IO Unit Control messages (MPI v2.6 and later only.)
1724****************************************************************************/
1725
1726/* IO Unit Control Request Message */
1727typedef struct _MPI26_IOUNIT_CONTROL_REQUEST {
1728	U8                      Operation;          /* 0x00 */
1729	U8                      Reserved1;          /* 0x01 */
1730	U8                      ChainOffset;        /* 0x02 */
1731	U8                      Function;           /* 0x03 */
1732	U16                     DevHandle;          /* 0x04 */
1733	U8                      IOCParameter;       /* 0x06 */
1734	U8                      MsgFlags;           /* 0x07 */
1735	U8                      VP_ID;              /* 0x08 */
1736	U8                      VF_ID;              /* 0x09 */
1737	U16                     Reserved3;          /* 0x0A */
1738	U16                     Reserved4;          /* 0x0C */
1739	U8                      PhyNum;             /* 0x0E */
1740	U8                      PrimFlags;          /* 0x0F */
1741	U32                     Primitive;          /* 0x10 */
1742	U8                      LookupMethod;       /* 0x14 */
1743	U8                      Reserved5;          /* 0x15 */
1744	U16                     SlotNumber;         /* 0x16 */
1745	U64                     LookupAddress;      /* 0x18 */
1746	U32                     IOCParameterValue;  /* 0x20 */
1747	U32                     Reserved7;          /* 0x24 */
1748	U32                     Reserved8;          /* 0x28 */
1749} MPI26_IOUNIT_CONTROL_REQUEST,
1750	*PTR_MPI26_IOUNIT_CONTROL_REQUEST,
1751	Mpi26IoUnitControlRequest_t,
1752	*pMpi26IoUnitControlRequest_t;
1753
1754/* values for the Operation field */
1755#define MPI26_CTRL_OP_CLEAR_ALL_PERSISTENT              (0x02)
1756#define MPI26_CTRL_OP_SAS_PHY_LINK_RESET                (0x06)
1757#define MPI26_CTRL_OP_SAS_PHY_HARD_RESET                (0x07)
1758#define MPI26_CTRL_OP_PHY_CLEAR_ERROR_LOG               (0x08)
1759#define MPI26_CTRL_OP_LINK_CLEAR_ERROR_LOG              (0x09)
1760#define MPI26_CTRL_OP_SAS_SEND_PRIMITIVE                (0x0A)
1761#define MPI26_CTRL_OP_FORCE_FULL_DISCOVERY              (0x0B)
1762#define MPI26_CTRL_OP_REMOVE_DEVICE                     (0x0D)
1763#define MPI26_CTRL_OP_LOOKUP_MAPPING                    (0x0E)
1764#define MPI26_CTRL_OP_SET_IOC_PARAMETER                 (0x0F)
1765#define MPI26_CTRL_OP_ENABLE_FP_DEVICE                  (0x10)
1766#define MPI26_CTRL_OP_DISABLE_FP_DEVICE                 (0x11)
1767#define MPI26_CTRL_OP_ENABLE_FP_ALL                     (0x12)
1768#define MPI26_CTRL_OP_DISABLE_FP_ALL                    (0x13)
1769#define MPI26_CTRL_OP_DEV_ENABLE_NCQ                    (0x14)
1770#define MPI26_CTRL_OP_DEV_DISABLE_NCQ                   (0x15)
1771#define MPI26_CTRL_OP_SHUTDOWN                          (0x16)
1772#define MPI26_CTRL_OP_DEV_ENABLE_PERSIST_CONNECTION     (0x17)
1773#define MPI26_CTRL_OP_DEV_DISABLE_PERSIST_CONNECTION    (0x18)
1774#define MPI26_CTRL_OP_DEV_CLOSE_PERSIST_CONNECTION      (0x19)
1775#define MPI26_CTRL_OP_ENABLE_NVME_SGL_FORMAT            (0x1A)
1776#define MPI26_CTRL_OP_DISABLE_NVME_SGL_FORMAT           (0x1B)
1777#define MPI26_CTRL_OP_PRODUCT_SPECIFIC_MIN              (0x80)
1778
1779/* values for the PrimFlags field */
1780#define MPI26_CTRL_PRIMFLAGS_SINGLE                     (0x08)
1781#define MPI26_CTRL_PRIMFLAGS_TRIPLE                     (0x02)
1782#define MPI26_CTRL_PRIMFLAGS_REDUNDANT                  (0x01)
1783
1784/* values for the LookupMethod field */
1785#define MPI26_CTRL_LOOKUP_METHOD_WWID_ADDRESS           (0x01)
1786#define MPI26_CTRL_LOOKUP_METHOD_ENCLOSURE_SLOT         (0x02)
1787#define MPI26_CTRL_LOOKUP_METHOD_SAS_DEVICE_NAME        (0x03)
1788
1789
1790/* IO Unit Control Reply Message */
1791typedef struct _MPI26_IOUNIT_CONTROL_REPLY {
1792	U8                      Operation;          /* 0x00 */
1793	U8                      Reserved1;          /* 0x01 */
1794	U8                      MsgLength;          /* 0x02 */
1795	U8                      Function;           /* 0x03 */
1796	U16                     DevHandle;          /* 0x04 */
1797	U8                      IOCParameter;       /* 0x06 */
1798	U8                      MsgFlags;           /* 0x07 */
1799	U8                      VP_ID;              /* 0x08 */
1800	U8                      VF_ID;              /* 0x09 */
1801	U16                     Reserved3;          /* 0x0A */
1802	U16                     Reserved4;          /* 0x0C */
1803	U16                     IOCStatus;          /* 0x0E */
1804	U32                     IOCLogInfo;         /* 0x10 */
1805} MPI26_IOUNIT_CONTROL_REPLY,
1806	*PTR_MPI26_IOUNIT_CONTROL_REPLY,
1807	Mpi26IoUnitControlReply_t,
1808	*pMpi26IoUnitControlReply_t;
1809
1810
1811#endif
1812