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