1/*
2 * Copyright (c) 2000-2014 LSI Corporation.
3 *
4 *
5 *          Name:  mpi2_raid.h
6 *         Title:  MPI Integrated RAID messages and structures
7 * Creation Date:  April 26, 2007
8 *
9 *   mpi2_raid.h Version:  02.00.10
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 * 08-31-07  02.00.01  Modifications to RAID Action request and reply,
18 *                     including the Actions and ActionData.
19 * 02-29-08  02.00.02  Added MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD.
20 * 05-21-08  02.00.03  Added MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS so that
21 *                     the PhysDisk array in MPI2_RAID_VOLUME_CREATION_STRUCT
22 *                     can be sized by the build environment.
23 * 07-30-09  02.00.04  Added proper define for the Use Default Settings bit of
24 *                     VolumeCreationFlags and marked the old one as obsolete.
25 * 05-12-10  02.00.05  Added MPI2_RAID_VOL_FLAGS_OP_MDC define.
26 * 08-24-10  02.00.06  Added MPI2_RAID_ACTION_COMPATIBILITY_CHECK along with
27 *                     related structures and defines.
28 *                     Added product-specific range to RAID Action values.
29 * 11-18-11  02.00.07  Incorporating additions for MPI v2.5.
30 * 02-06-12  02.00.08  Added MPI2_RAID_ACTION_PHYSDISK_HIDDEN.
31 * 07-26-12  02.00.09  Added ElapsedSeconds field to MPI2_RAID_VOL_INDICATOR.
32 *                     Added MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID define.
33 * 04-17-13  02.00.10  Added MPI25_RAID_ACTION_ADATA_ALLOW_PI.
34 * --------------------------------------------------------------------------
35 */
36
37#ifndef MPI2_RAID_H
38#define MPI2_RAID_H
39
40/*****************************************************************************
41*
42*              Integrated RAID Messages
43*
44*****************************************************************************/
45
46/****************************************************************************
47* RAID Action messages
48****************************************************************************/
49
50/* ActionDataWord defines for use with MPI2_RAID_ACTION_CREATE_VOLUME action */
51#define MPI25_RAID_ACTION_ADATA_ALLOW_PI            (0x80000000)
52
53/*ActionDataWord defines for use with MPI2_RAID_ACTION_DELETE_VOLUME action */
54#define MPI2_RAID_ACTION_ADATA_KEEP_LBA0            (0x00000000)
55#define MPI2_RAID_ACTION_ADATA_ZERO_LBA0            (0x00000001)
56
57/*use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for
58 *MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
59
60/*ActionDataWord defines for use with
61 *MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES action */
62#define MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD  (0x00000001)
63
64/*ActionDataWord for MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE Action */
65typedef struct _MPI2_RAID_ACTION_RATE_DATA {
66	U8 RateToChange;	/*0x00 */
67	U8 RateOrMode;		/*0x01 */
68	U16 DataScrubDuration;	/*0x02 */
69} MPI2_RAID_ACTION_RATE_DATA, *PTR_MPI2_RAID_ACTION_RATE_DATA,
70	Mpi2RaidActionRateData_t, *pMpi2RaidActionRateData_t;
71
72#define MPI2_RAID_ACTION_SET_RATE_RESYNC            (0x00)
73#define MPI2_RAID_ACTION_SET_RATE_DATA_SCRUB        (0x01)
74#define MPI2_RAID_ACTION_SET_RATE_POWERSAVE_MODE    (0x02)
75
76/*ActionDataWord for MPI2_RAID_ACTION_START_RAID_FUNCTION Action */
77typedef struct _MPI2_RAID_ACTION_START_RAID_FUNCTION {
78	U8 RAIDFunction;	/*0x00 */
79	U8 Flags;		/*0x01 */
80	U16 Reserved1;		/*0x02 */
81} MPI2_RAID_ACTION_START_RAID_FUNCTION,
82	*PTR_MPI2_RAID_ACTION_START_RAID_FUNCTION,
83	Mpi2RaidActionStartRaidFunction_t,
84	*pMpi2RaidActionStartRaidFunction_t;
85
86/*defines for the RAIDFunction field */
87#define MPI2_RAID_ACTION_START_BACKGROUND_INIT      (0x00)
88#define MPI2_RAID_ACTION_START_ONLINE_CAP_EXPANSION (0x01)
89#define MPI2_RAID_ACTION_START_CONSISTENCY_CHECK    (0x02)
90
91/*defines for the Flags field */
92#define MPI2_RAID_ACTION_START_NEW                  (0x00)
93#define MPI2_RAID_ACTION_START_RESUME               (0x01)
94
95/*ActionDataWord for MPI2_RAID_ACTION_STOP_RAID_FUNCTION Action */
96typedef struct _MPI2_RAID_ACTION_STOP_RAID_FUNCTION {
97	U8 RAIDFunction;	/*0x00 */
98	U8 Flags;		/*0x01 */
99	U16 Reserved1;		/*0x02 */
100} MPI2_RAID_ACTION_STOP_RAID_FUNCTION,
101	*PTR_MPI2_RAID_ACTION_STOP_RAID_FUNCTION,
102	Mpi2RaidActionStopRaidFunction_t,
103	*pMpi2RaidActionStopRaidFunction_t;
104
105/*defines for the RAIDFunction field */
106#define MPI2_RAID_ACTION_STOP_BACKGROUND_INIT       (0x00)
107#define MPI2_RAID_ACTION_STOP_ONLINE_CAP_EXPANSION  (0x01)
108#define MPI2_RAID_ACTION_STOP_CONSISTENCY_CHECK     (0x02)
109
110/*defines for the Flags field */
111#define MPI2_RAID_ACTION_STOP_ABORT                 (0x00)
112#define MPI2_RAID_ACTION_STOP_PAUSE                 (0x01)
113
114/*ActionDataWord for MPI2_RAID_ACTION_CREATE_HOT_SPARE Action */
115typedef struct _MPI2_RAID_ACTION_HOT_SPARE {
116	U8 HotSparePool;	/*0x00 */
117	U8 Reserved1;		/*0x01 */
118	U16 DevHandle;		/*0x02 */
119} MPI2_RAID_ACTION_HOT_SPARE, *PTR_MPI2_RAID_ACTION_HOT_SPARE,
120	Mpi2RaidActionHotSpare_t, *pMpi2RaidActionHotSpare_t;
121
122/*ActionDataWord for MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE Action */
123typedef struct _MPI2_RAID_ACTION_FW_UPDATE_MODE {
124	U8 Flags;		/*0x00 */
125	U8 DeviceFirmwareUpdateModeTimeout;	/*0x01 */
126	U16 Reserved1;		/*0x02 */
127} MPI2_RAID_ACTION_FW_UPDATE_MODE,
128	*PTR_MPI2_RAID_ACTION_FW_UPDATE_MODE,
129	Mpi2RaidActionFwUpdateMode_t,
130	*pMpi2RaidActionFwUpdateMode_t;
131
132/*ActionDataWord defines for use with
133 *MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE action */
134#define MPI2_RAID_ACTION_ADATA_DISABLE_FW_UPDATE        (0x00)
135#define MPI2_RAID_ACTION_ADATA_ENABLE_FW_UPDATE         (0x01)
136
137typedef union _MPI2_RAID_ACTION_DATA {
138	U32 Word;
139	MPI2_RAID_ACTION_RATE_DATA Rates;
140	MPI2_RAID_ACTION_START_RAID_FUNCTION StartRaidFunction;
141	MPI2_RAID_ACTION_STOP_RAID_FUNCTION StopRaidFunction;
142	MPI2_RAID_ACTION_HOT_SPARE HotSpare;
143	MPI2_RAID_ACTION_FW_UPDATE_MODE FwUpdateMode;
144} MPI2_RAID_ACTION_DATA, *PTR_MPI2_RAID_ACTION_DATA,
145	Mpi2RaidActionData_t, *pMpi2RaidActionData_t;
146
147/*RAID Action Request Message */
148typedef struct _MPI2_RAID_ACTION_REQUEST {
149	U8 Action;		/*0x00 */
150	U8 Reserved1;		/*0x01 */
151	U8 ChainOffset;		/*0x02 */
152	U8 Function;		/*0x03 */
153	U16 VolDevHandle;	/*0x04 */
154	U8 PhysDiskNum;		/*0x06 */
155	U8 MsgFlags;		/*0x07 */
156	U8 VP_ID;		/*0x08 */
157	U8 VF_ID;		/*0x09 */
158	U16 Reserved2;		/*0x0A */
159	U32 Reserved3;		/*0x0C */
160	MPI2_RAID_ACTION_DATA ActionDataWord;	/*0x10 */
161	MPI2_SGE_SIMPLE_UNION ActionDataSGE;	/*0x14 */
162} MPI2_RAID_ACTION_REQUEST, *PTR_MPI2_RAID_ACTION_REQUEST,
163	Mpi2RaidActionRequest_t, *pMpi2RaidActionRequest_t;
164
165/*RAID Action request Action values */
166
167#define MPI2_RAID_ACTION_INDICATOR_STRUCT           (0x01)
168#define MPI2_RAID_ACTION_CREATE_VOLUME              (0x02)
169#define MPI2_RAID_ACTION_DELETE_VOLUME              (0x03)
170#define MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES        (0x04)
171#define MPI2_RAID_ACTION_ENABLE_ALL_VOLUMES         (0x05)
172#define MPI2_RAID_ACTION_PHYSDISK_OFFLINE           (0x0A)
173#define MPI2_RAID_ACTION_PHYSDISK_ONLINE            (0x0B)
174#define MPI2_RAID_ACTION_FAIL_PHYSDISK              (0x0F)
175#define MPI2_RAID_ACTION_ACTIVATE_VOLUME            (0x11)
176#define MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE      (0x15)
177#define MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE     (0x17)
178#define MPI2_RAID_ACTION_SET_VOLUME_NAME            (0x18)
179#define MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE     (0x19)
180#define MPI2_RAID_ACTION_ENABLE_FAILED_VOLUME       (0x1C)
181#define MPI2_RAID_ACTION_CREATE_HOT_SPARE           (0x1D)
182#define MPI2_RAID_ACTION_DELETE_HOT_SPARE           (0x1E)
183#define MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED  (0x20)
184#define MPI2_RAID_ACTION_START_RAID_FUNCTION        (0x21)
185#define MPI2_RAID_ACTION_STOP_RAID_FUNCTION         (0x22)
186#define MPI2_RAID_ACTION_COMPATIBILITY_CHECK        (0x23)
187#define MPI2_RAID_ACTION_PHYSDISK_HIDDEN            (0x24)
188#define MPI2_RAID_ACTION_MIN_PRODUCT_SPECIFIC       (0x80)
189#define MPI2_RAID_ACTION_MAX_PRODUCT_SPECIFIC       (0xFF)
190
191/*RAID Volume Creation Structure */
192
193/*
194 *The following define can be customized for the targeted product.
195 */
196#ifndef MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS
197#define MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS        (1)
198#endif
199
200typedef struct _MPI2_RAID_VOLUME_PHYSDISK {
201	U8 RAIDSetNum;		/*0x00 */
202	U8 PhysDiskMap;		/*0x01 */
203	U16 PhysDiskDevHandle;	/*0x02 */
204} MPI2_RAID_VOLUME_PHYSDISK, *PTR_MPI2_RAID_VOLUME_PHYSDISK,
205	Mpi2RaidVolumePhysDisk_t, *pMpi2RaidVolumePhysDisk_t;
206
207/*defines for the PhysDiskMap field */
208#define MPI2_RAIDACTION_PHYSDISK_PRIMARY            (0x01)
209#define MPI2_RAIDACTION_PHYSDISK_SECONDARY          (0x02)
210
211typedef struct _MPI2_RAID_VOLUME_CREATION_STRUCT {
212	U8 NumPhysDisks;	/*0x00 */
213	U8 VolumeType;		/*0x01 */
214	U16 Reserved1;		/*0x02 */
215	U32 VolumeCreationFlags;	/*0x04 */
216	U32 VolumeSettings;	/*0x08 */
217	U8 Reserved2;		/*0x0C */
218	U8 ResyncRate;		/*0x0D */
219	U16 DataScrubDuration;	/*0x0E */
220	U64 VolumeMaxLBA;	/*0x10 */
221	U32 StripeSize;		/*0x18 */
222	U8 Name[16];		/*0x1C */
223	MPI2_RAID_VOLUME_PHYSDISK
224		PhysDisk[MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS];	/*0x2C */
225} MPI2_RAID_VOLUME_CREATION_STRUCT,
226	*PTR_MPI2_RAID_VOLUME_CREATION_STRUCT,
227	Mpi2RaidVolumeCreationStruct_t,
228	*pMpi2RaidVolumeCreationStruct_t;
229
230/*use MPI2_RAID_VOL_TYPE_ defines from mpi2_cnfg.h for VolumeType */
231
232/*defines for the VolumeCreationFlags field */
233#define MPI2_RAID_VOL_CREATION_DEFAULT_SETTINGS     (0x80000000)
234#define MPI2_RAID_VOL_CREATION_BACKGROUND_INIT      (0x00000004)
235#define MPI2_RAID_VOL_CREATION_LOW_LEVEL_INIT       (0x00000002)
236#define MPI2_RAID_VOL_CREATION_MIGRATE_DATA         (0x00000001)
237/*The following is an obsolete define.
238 *It must be shifted left 24 bits in order to set the proper bit.
239 */
240#define MPI2_RAID_VOL_CREATION_USE_DEFAULT_SETTINGS (0x80)
241
242/*RAID Online Capacity Expansion Structure */
243
244typedef struct _MPI2_RAID_ONLINE_CAPACITY_EXPANSION {
245	U32 Flags;		/*0x00 */
246	U16 DevHandle0;		/*0x04 */
247	U16 Reserved1;		/*0x06 */
248	U16 DevHandle1;		/*0x08 */
249	U16 Reserved2;		/*0x0A */
250} MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
251	*PTR_MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
252	Mpi2RaidOnlineCapacityExpansion_t,
253	*pMpi2RaidOnlineCapacityExpansion_t;
254
255/*RAID Compatibility Input Structure */
256
257typedef struct _MPI2_RAID_COMPATIBILITY_INPUT_STRUCT {
258	U16 SourceDevHandle;	/*0x00 */
259	U16 CandidateDevHandle;	/*0x02 */
260	U32 Flags;		/*0x04 */
261	U32 Reserved1;		/*0x08 */
262	U32 Reserved2;		/*0x0C */
263} MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
264	*PTR_MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
265	Mpi2RaidCompatibilityInputStruct_t,
266	*pMpi2RaidCompatibilityInputStruct_t;
267
268/*defines for RAID Compatibility Structure Flags field */
269#define MPI2_RAID_COMPAT_SOURCE_IS_VOLUME_FLAG      (0x00000002)
270#define MPI2_RAID_COMPAT_REPORT_SOURCE_INFO_FLAG    (0x00000001)
271
272/*RAID Volume Indicator Structure */
273
274typedef struct _MPI2_RAID_VOL_INDICATOR {
275	U64 TotalBlocks;	/*0x00 */
276	U64 BlocksRemaining;	/*0x08 */
277	U32 Flags;		/*0x10 */
278	U32 ElapsedSeconds;	/* 0x14 */
279} MPI2_RAID_VOL_INDICATOR, *PTR_MPI2_RAID_VOL_INDICATOR,
280	Mpi2RaidVolIndicator_t, *pMpi2RaidVolIndicator_t;
281
282/*defines for RAID Volume Indicator Flags field */
283#define MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID   (0x80000000)
284#define MPI2_RAID_VOL_FLAGS_OP_MASK                 (0x0000000F)
285#define MPI2_RAID_VOL_FLAGS_OP_BACKGROUND_INIT      (0x00000000)
286#define MPI2_RAID_VOL_FLAGS_OP_ONLINE_CAP_EXPANSION (0x00000001)
287#define MPI2_RAID_VOL_FLAGS_OP_CONSISTENCY_CHECK    (0x00000002)
288#define MPI2_RAID_VOL_FLAGS_OP_RESYNC               (0x00000003)
289#define MPI2_RAID_VOL_FLAGS_OP_MDC                  (0x00000004)
290
291/*RAID Compatibility Result Structure */
292
293typedef struct _MPI2_RAID_COMPATIBILITY_RESULT_STRUCT {
294	U8 State;		/*0x00 */
295	U8 Reserved1;		/*0x01 */
296	U16 Reserved2;		/*0x02 */
297	U32 GenericAttributes;	/*0x04 */
298	U32 OEMSpecificAttributes;	/*0x08 */
299	U32 Reserved3;		/*0x0C */
300	U32 Reserved4;		/*0x10 */
301} MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
302	*PTR_MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
303	Mpi2RaidCompatibilityResultStruct_t,
304	*pMpi2RaidCompatibilityResultStruct_t;
305
306/*defines for RAID Compatibility Result Structure State field */
307#define MPI2_RAID_COMPAT_STATE_COMPATIBLE           (0x00)
308#define MPI2_RAID_COMPAT_STATE_NOT_COMPATIBLE       (0x01)
309
310/*defines for RAID Compatibility Result Structure GenericAttributes field */
311#define MPI2_RAID_COMPAT_GENATTRIB_4K_SECTOR            (0x00000010)
312
313#define MPI2_RAID_COMPAT_GENATTRIB_MEDIA_MASK           (0x0000000C)
314#define MPI2_RAID_COMPAT_GENATTRIB_SOLID_STATE_DRIVE    (0x00000008)
315#define MPI2_RAID_COMPAT_GENATTRIB_HARD_DISK_DRIVE      (0x00000004)
316
317#define MPI2_RAID_COMPAT_GENATTRIB_PROTOCOL_MASK        (0x00000003)
318#define MPI2_RAID_COMPAT_GENATTRIB_SAS_PROTOCOL         (0x00000002)
319#define MPI2_RAID_COMPAT_GENATTRIB_SATA_PROTOCOL        (0x00000001)
320
321/*RAID Action Reply ActionData union */
322typedef union _MPI2_RAID_ACTION_REPLY_DATA {
323	U32 Word[6];
324	MPI2_RAID_VOL_INDICATOR RaidVolumeIndicator;
325	U16 VolDevHandle;
326	U8 VolumeState;
327	U8 PhysDiskNum;
328	MPI2_RAID_COMPATIBILITY_RESULT_STRUCT RaidCompatibilityResult;
329} MPI2_RAID_ACTION_REPLY_DATA, *PTR_MPI2_RAID_ACTION_REPLY_DATA,
330	Mpi2RaidActionReplyData_t, *pMpi2RaidActionReplyData_t;
331
332/*use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for
333 *MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
334
335/*RAID Action Reply Message */
336typedef struct _MPI2_RAID_ACTION_REPLY {
337	U8 Action;		/*0x00 */
338	U8 Reserved1;		/*0x01 */
339	U8 MsgLength;		/*0x02 */
340	U8 Function;		/*0x03 */
341	U16 VolDevHandle;	/*0x04 */
342	U8 PhysDiskNum;		/*0x06 */
343	U8 MsgFlags;		/*0x07 */
344	U8 VP_ID;		/*0x08 */
345	U8 VF_ID;		/*0x09 */
346	U16 Reserved2;		/*0x0A */
347	U16 Reserved3;		/*0x0C */
348	U16 IOCStatus;		/*0x0E */
349	U32 IOCLogInfo;		/*0x10 */
350	MPI2_RAID_ACTION_REPLY_DATA ActionData;	/*0x14 */
351} MPI2_RAID_ACTION_REPLY, *PTR_MPI2_RAID_ACTION_REPLY,
352	Mpi2RaidActionReply_t, *pMpi2RaidActionReply_t;
353
354#endif
355