2 * Copyright (c) 2013 LSI Corp.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * LSI MPT-Fusion Host Adapter FreeBSD
35 * Copyright (c) 2000-2013 LSI Corporation.
39 * Title: MPI Integrated RAID messages and structures
40 * Creation Date: April 26, 2007
42 * mpi2_raid.h Version: 02.00.10
47 * Date Version Description
48 * -------- -------- ------------------------------------------------------
49 * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
50 * 08-31-07 02.00.01 Modifications to RAID Action request and reply,
51 * including the Actions and ActionData.
52 * 02-29-08 02.00.02 Added MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD.
53 * 05-21-08 02.00.03 Added MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS so that
54 * the PhysDisk array in MPI2_RAID_VOLUME_CREATION_STRUCT
55 * can be sized by the build environment.
56 * 07-30-09 02.00.04 Added proper define for the Use Default Settings bit of
57 * VolumeCreationFlags and marked the old one as obsolete.
58 * 05-12-10 02.00.05 Added MPI2_RAID_VOL_FLAGS_OP_MDC define.
59 * 08-24-10 02.00.06 Added MPI2_RAID_ACTION_COMPATIBILITY_CHECK along with
60 * related structures and defines.
61 * Added product-specific range to RAID Action values.
62 * 11-18-11 02.00.07 Incorporating additions for MPI v2.5.
63 * 02-06-12 02.00.08 Added MPI2_RAID_ACTION_PHYSDISK_HIDDEN.
64 * 07-26-12 02.00.09 Added ElapsedSeconds field to MPI2_RAID_VOL_INDICATOR.
65 * Added MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID define.
66 * 04-17-13 02.00.10 Added MPI25_RAID_ACTION_ADATA_ALLOW_PI.
67 * --------------------------------------------------------------------------
73 /*****************************************************************************
75 * Integrated RAID Messages
77 *****************************************************************************/
79 /****************************************************************************
80 * RAID Action messages
81 ****************************************************************************/
83 /* ActionDataWord defines for use with MPI2_RAID_ACTION_CREATE_VOLUME action */
84 #define MPI25_RAID_ACTION_ADATA_ALLOW_PI (0x80000000)
86 /* ActionDataWord defines for use with MPI2_RAID_ACTION_DELETE_VOLUME action */
87 #define MPI2_RAID_ACTION_ADATA_KEEP_LBA0 (0x00000000)
88 #define MPI2_RAID_ACTION_ADATA_ZERO_LBA0 (0x00000001)
90 /* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
92 /* ActionDataWord defines for use with MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES action */
93 #define MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD (0x00000001)
95 /* ActionDataWord for MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE Action */
96 typedef struct _MPI2_RAID_ACTION_RATE_DATA
98 U8 RateToChange; /* 0x00 */
99 U8 RateOrMode; /* 0x01 */
100 U16 DataScrubDuration; /* 0x02 */
101 } MPI2_RAID_ACTION_RATE_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_RATE_DATA,
102 Mpi2RaidActionRateData_t, MPI2_POINTER pMpi2RaidActionRateData_t;
104 #define MPI2_RAID_ACTION_SET_RATE_RESYNC (0x00)
105 #define MPI2_RAID_ACTION_SET_RATE_DATA_SCRUB (0x01)
106 #define MPI2_RAID_ACTION_SET_RATE_POWERSAVE_MODE (0x02)
108 /* ActionDataWord for MPI2_RAID_ACTION_START_RAID_FUNCTION Action */
109 typedef struct _MPI2_RAID_ACTION_START_RAID_FUNCTION
111 U8 RAIDFunction; /* 0x00 */
113 U16 Reserved1; /* 0x02 */
114 } MPI2_RAID_ACTION_START_RAID_FUNCTION,
115 MPI2_POINTER PTR_MPI2_RAID_ACTION_START_RAID_FUNCTION,
116 Mpi2RaidActionStartRaidFunction_t,
117 MPI2_POINTER pMpi2RaidActionStartRaidFunction_t;
119 /* defines for the RAIDFunction field */
120 #define MPI2_RAID_ACTION_START_BACKGROUND_INIT (0x00)
121 #define MPI2_RAID_ACTION_START_ONLINE_CAP_EXPANSION (0x01)
122 #define MPI2_RAID_ACTION_START_CONSISTENCY_CHECK (0x02)
124 /* defines for the Flags field */
125 #define MPI2_RAID_ACTION_START_NEW (0x00)
126 #define MPI2_RAID_ACTION_START_RESUME (0x01)
128 /* ActionDataWord for MPI2_RAID_ACTION_STOP_RAID_FUNCTION Action */
129 typedef struct _MPI2_RAID_ACTION_STOP_RAID_FUNCTION
131 U8 RAIDFunction; /* 0x00 */
133 U16 Reserved1; /* 0x02 */
134 } MPI2_RAID_ACTION_STOP_RAID_FUNCTION,
135 MPI2_POINTER PTR_MPI2_RAID_ACTION_STOP_RAID_FUNCTION,
136 Mpi2RaidActionStopRaidFunction_t,
137 MPI2_POINTER pMpi2RaidActionStopRaidFunction_t;
139 /* defines for the RAIDFunction field */
140 #define MPI2_RAID_ACTION_STOP_BACKGROUND_INIT (0x00)
141 #define MPI2_RAID_ACTION_STOP_ONLINE_CAP_EXPANSION (0x01)
142 #define MPI2_RAID_ACTION_STOP_CONSISTENCY_CHECK (0x02)
144 /* defines for the Flags field */
145 #define MPI2_RAID_ACTION_STOP_ABORT (0x00)
146 #define MPI2_RAID_ACTION_STOP_PAUSE (0x01)
148 /* ActionDataWord for MPI2_RAID_ACTION_CREATE_HOT_SPARE Action */
149 typedef struct _MPI2_RAID_ACTION_HOT_SPARE
151 U8 HotSparePool; /* 0x00 */
152 U8 Reserved1; /* 0x01 */
153 U16 DevHandle; /* 0x02 */
154 } MPI2_RAID_ACTION_HOT_SPARE, MPI2_POINTER PTR_MPI2_RAID_ACTION_HOT_SPARE,
155 Mpi2RaidActionHotSpare_t, MPI2_POINTER pMpi2RaidActionHotSpare_t;
157 /* ActionDataWord for MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE Action */
158 typedef struct _MPI2_RAID_ACTION_FW_UPDATE_MODE
161 U8 DeviceFirmwareUpdateModeTimeout; /* 0x01 */
162 U16 Reserved1; /* 0x02 */
163 } MPI2_RAID_ACTION_FW_UPDATE_MODE,
164 MPI2_POINTER PTR_MPI2_RAID_ACTION_FW_UPDATE_MODE,
165 Mpi2RaidActionFwUpdateMode_t, MPI2_POINTER pMpi2RaidActionFwUpdateMode_t;
167 /* ActionDataWord defines for use with MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE action */
168 #define MPI2_RAID_ACTION_ADATA_DISABLE_FW_UPDATE (0x00)
169 #define MPI2_RAID_ACTION_ADATA_ENABLE_FW_UPDATE (0x01)
171 typedef union _MPI2_RAID_ACTION_DATA
174 MPI2_RAID_ACTION_RATE_DATA Rates;
175 MPI2_RAID_ACTION_START_RAID_FUNCTION StartRaidFunction;
176 MPI2_RAID_ACTION_STOP_RAID_FUNCTION StopRaidFunction;
177 MPI2_RAID_ACTION_HOT_SPARE HotSpare;
178 MPI2_RAID_ACTION_FW_UPDATE_MODE FwUpdateMode;
179 } MPI2_RAID_ACTION_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_DATA,
180 Mpi2RaidActionData_t, MPI2_POINTER pMpi2RaidActionData_t;
183 /* RAID Action Request Message */
184 typedef struct _MPI2_RAID_ACTION_REQUEST
186 U8 Action; /* 0x00 */
187 U8 Reserved1; /* 0x01 */
188 U8 ChainOffset; /* 0x02 */
189 U8 Function; /* 0x03 */
190 U16 VolDevHandle; /* 0x04 */
191 U8 PhysDiskNum; /* 0x06 */
192 U8 MsgFlags; /* 0x07 */
195 U16 Reserved2; /* 0x0A */
196 U32 Reserved3; /* 0x0C */
197 MPI2_RAID_ACTION_DATA ActionDataWord; /* 0x10 */
198 MPI2_SGE_SIMPLE_UNION ActionDataSGE; /* 0x14 */
199 } MPI2_RAID_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_RAID_ACTION_REQUEST,
200 Mpi2RaidActionRequest_t, MPI2_POINTER pMpi2RaidActionRequest_t;
202 /* RAID Action request Action values */
204 #define MPI2_RAID_ACTION_INDICATOR_STRUCT (0x01)
205 #define MPI2_RAID_ACTION_CREATE_VOLUME (0x02)
206 #define MPI2_RAID_ACTION_DELETE_VOLUME (0x03)
207 #define MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES (0x04)
208 #define MPI2_RAID_ACTION_ENABLE_ALL_VOLUMES (0x05)
209 #define MPI2_RAID_ACTION_PHYSDISK_OFFLINE (0x0A)
210 #define MPI2_RAID_ACTION_PHYSDISK_ONLINE (0x0B)
211 #define MPI2_RAID_ACTION_FAIL_PHYSDISK (0x0F)
212 #define MPI2_RAID_ACTION_ACTIVATE_VOLUME (0x11)
213 #define MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE (0x15)
214 #define MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE (0x17)
215 #define MPI2_RAID_ACTION_SET_VOLUME_NAME (0x18)
216 #define MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE (0x19)
217 #define MPI2_RAID_ACTION_ENABLE_FAILED_VOLUME (0x1C)
218 #define MPI2_RAID_ACTION_CREATE_HOT_SPARE (0x1D)
219 #define MPI2_RAID_ACTION_DELETE_HOT_SPARE (0x1E)
220 #define MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED (0x20)
221 #define MPI2_RAID_ACTION_START_RAID_FUNCTION (0x21)
222 #define MPI2_RAID_ACTION_STOP_RAID_FUNCTION (0x22)
223 #define MPI2_RAID_ACTION_COMPATIBILITY_CHECK (0x23)
224 #define MPI2_RAID_ACTION_PHYSDISK_HIDDEN (0x24)
225 #define MPI2_RAID_ACTION_MIN_PRODUCT_SPECIFIC (0x80)
226 #define MPI2_RAID_ACTION_MAX_PRODUCT_SPECIFIC (0xFF)
229 /* RAID Volume Creation Structure */
232 * The following define can be customized for the targeted product.
234 #ifndef MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS
235 #define MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS (1)
238 typedef struct _MPI2_RAID_VOLUME_PHYSDISK
240 U8 RAIDSetNum; /* 0x00 */
241 U8 PhysDiskMap; /* 0x01 */
242 U16 PhysDiskDevHandle; /* 0x02 */
243 } MPI2_RAID_VOLUME_PHYSDISK, MPI2_POINTER PTR_MPI2_RAID_VOLUME_PHYSDISK,
244 Mpi2RaidVolumePhysDisk_t, MPI2_POINTER pMpi2RaidVolumePhysDisk_t;
246 /* defines for the PhysDiskMap field */
247 #define MPI2_RAIDACTION_PHYSDISK_PRIMARY (0x01)
248 #define MPI2_RAIDACTION_PHYSDISK_SECONDARY (0x02)
250 typedef struct _MPI2_RAID_VOLUME_CREATION_STRUCT
252 U8 NumPhysDisks; /* 0x00 */
253 U8 VolumeType; /* 0x01 */
254 U16 Reserved1; /* 0x02 */
255 U32 VolumeCreationFlags; /* 0x04 */
256 U32 VolumeSettings; /* 0x08 */
257 U8 Reserved2; /* 0x0C */
258 U8 ResyncRate; /* 0x0D */
259 U16 DataScrubDuration; /* 0x0E */
260 U64 VolumeMaxLBA; /* 0x10 */
261 U32 StripeSize; /* 0x18 */
262 U8 Name[16]; /* 0x1C */
263 MPI2_RAID_VOLUME_PHYSDISK PhysDisk[MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS];/* 0x2C */
264 } MPI2_RAID_VOLUME_CREATION_STRUCT,
265 MPI2_POINTER PTR_MPI2_RAID_VOLUME_CREATION_STRUCT,
266 Mpi2RaidVolumeCreationStruct_t, MPI2_POINTER pMpi2RaidVolumeCreationStruct_t;
268 /* use MPI2_RAID_VOL_TYPE_ defines from mpi2_cnfg.h for VolumeType */
270 /* defines for the VolumeCreationFlags field */
271 #define MPI2_RAID_VOL_CREATION_DEFAULT_SETTINGS (0x80000000)
272 #define MPI2_RAID_VOL_CREATION_BACKGROUND_INIT (0x00000004) /* MPI 2.0 only */
273 #define MPI2_RAID_VOL_CREATION_LOW_LEVEL_INIT (0x00000002)
274 #define MPI2_RAID_VOL_CREATION_MIGRATE_DATA (0x00000001)
275 /* The following is an obsolete define.
276 * It must be shifted left 24 bits in order to set the proper bit.
278 #define MPI2_RAID_VOL_CREATION_USE_DEFAULT_SETTINGS (0x80)
281 /* RAID Online Capacity Expansion Structure */
283 typedef struct _MPI2_RAID_ONLINE_CAPACITY_EXPANSION
285 U32 Flags; /* 0x00 */
286 U16 DevHandle0; /* 0x04 */
287 U16 Reserved1; /* 0x06 */
288 U16 DevHandle1; /* 0x08 */
289 U16 Reserved2; /* 0x0A */
290 } MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
291 MPI2_POINTER PTR_MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
292 Mpi2RaidOnlineCapacityExpansion_t,
293 MPI2_POINTER pMpi2RaidOnlineCapacityExpansion_t;
296 /* RAID Compatibility Input Structure */
298 typedef struct _MPI2_RAID_COMPATIBILITY_INPUT_STRUCT
300 U16 SourceDevHandle; /* 0x00 */
301 U16 CandidateDevHandle; /* 0x02 */
302 U32 Flags; /* 0x04 */
303 U32 Reserved1; /* 0x08 */
304 U32 Reserved2; /* 0x0C */
305 } MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
306 MPI2_POINTER PTR_MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
307 Mpi2RaidCompatibilityInputStruct_t,
308 MPI2_POINTER pMpi2RaidCompatibilityInputStruct_t;
310 /* defines for RAID Compatibility Structure Flags field */
311 #define MPI2_RAID_COMPAT_SOURCE_IS_VOLUME_FLAG (0x00000002)
312 #define MPI2_RAID_COMPAT_REPORT_SOURCE_INFO_FLAG (0x00000001)
315 /* RAID Volume Indicator Structure */
317 typedef struct _MPI2_RAID_VOL_INDICATOR
319 U64 TotalBlocks; /* 0x00 */
320 U64 BlocksRemaining; /* 0x08 */
321 U32 Flags; /* 0x10 */
322 U32 ElapsedSeconds; /* 0x14 */
323 } MPI2_RAID_VOL_INDICATOR, MPI2_POINTER PTR_MPI2_RAID_VOL_INDICATOR,
324 Mpi2RaidVolIndicator_t, MPI2_POINTER pMpi2RaidVolIndicator_t;
326 /* defines for RAID Volume Indicator Flags field */
327 #define MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID (0x80000000)
329 #define MPI2_RAID_VOL_FLAGS_OP_MASK (0x0000000F)
330 #define MPI2_RAID_VOL_FLAGS_OP_BACKGROUND_INIT (0x00000000)
331 #define MPI2_RAID_VOL_FLAGS_OP_ONLINE_CAP_EXPANSION (0x00000001)
332 #define MPI2_RAID_VOL_FLAGS_OP_CONSISTENCY_CHECK (0x00000002)
333 #define MPI2_RAID_VOL_FLAGS_OP_RESYNC (0x00000003)
334 #define MPI2_RAID_VOL_FLAGS_OP_MDC (0x00000004)
337 /* RAID Compatibility Result Structure */
339 typedef struct _MPI2_RAID_COMPATIBILITY_RESULT_STRUCT
342 U8 Reserved1; /* 0x01 */
343 U16 Reserved2; /* 0x02 */
344 U32 GenericAttributes; /* 0x04 */
345 U32 OEMSpecificAttributes; /* 0x08 */
346 U32 Reserved3; /* 0x0C */
347 U32 Reserved4; /* 0x10 */
348 } MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
349 MPI2_POINTER PTR_MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
350 Mpi2RaidCompatibilityResultStruct_t,
351 MPI2_POINTER pMpi2RaidCompatibilityResultStruct_t;
353 /* defines for RAID Compatibility Result Structure State field */
354 #define MPI2_RAID_COMPAT_STATE_COMPATIBLE (0x00)
355 #define MPI2_RAID_COMPAT_STATE_NOT_COMPATIBLE (0x01)
357 /* defines for RAID Compatibility Result Structure GenericAttributes field */
358 #define MPI2_RAID_COMPAT_GENATTRIB_4K_SECTOR (0x00000010)
360 #define MPI2_RAID_COMPAT_GENATTRIB_MEDIA_MASK (0x0000000C)
361 #define MPI2_RAID_COMPAT_GENATTRIB_SOLID_STATE_DRIVE (0x00000008)
362 #define MPI2_RAID_COMPAT_GENATTRIB_HARD_DISK_DRIVE (0x00000004)
364 #define MPI2_RAID_COMPAT_GENATTRIB_PROTOCOL_MASK (0x00000003)
365 #define MPI2_RAID_COMPAT_GENATTRIB_SAS_PROTOCOL (0x00000002)
366 #define MPI2_RAID_COMPAT_GENATTRIB_SATA_PROTOCOL (0x00000001)
369 /* RAID Action Reply ActionData union */
370 typedef union _MPI2_RAID_ACTION_REPLY_DATA
373 MPI2_RAID_VOL_INDICATOR RaidVolumeIndicator;
377 MPI2_RAID_COMPATIBILITY_RESULT_STRUCT RaidCompatibilityResult;
378 } MPI2_RAID_ACTION_REPLY_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY_DATA,
379 Mpi2RaidActionReplyData_t, MPI2_POINTER pMpi2RaidActionReplyData_t;
381 /* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
384 /* RAID Action Reply Message */
385 typedef struct _MPI2_RAID_ACTION_REPLY
387 U8 Action; /* 0x00 */
388 U8 Reserved1; /* 0x01 */
389 U8 MsgLength; /* 0x02 */
390 U8 Function; /* 0x03 */
391 U16 VolDevHandle; /* 0x04 */
392 U8 PhysDiskNum; /* 0x06 */
393 U8 MsgFlags; /* 0x07 */
396 U16 Reserved2; /* 0x0A */
397 U16 Reserved3; /* 0x0C */
398 U16 IOCStatus; /* 0x0E */
399 U32 IOCLogInfo; /* 0x10 */
400 MPI2_RAID_ACTION_REPLY_DATA ActionData; /* 0x14 */
401 } MPI2_RAID_ACTION_REPLY, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY,
402 Mpi2RaidActionReply_t, MPI2_POINTER pMpi2RaidActionReply_t;