1 /*-
2 * Copyright 2000-2020 Broadcom Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the author nor the names of any co-contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * Broadcom Inc. (LSI) MPT-Fusion Host Adapter FreeBSD
29 *
30 * $FreeBSD$
31 */
32
33 /*
34 * Copyright 2000-2020 Broadcom Inc. All rights reserved.
35 *
36 *
37 * Name: mpi2_raid.h
38 * Title: MPI Integrated RAID messages and structures
39 * Creation Date: April 26, 2007
40 *
41 * mpi2_raid.h Version: 02.00.11
42 *
43 * Version History
44 * ---------------
45 *
46 * Date Version Description
47 * -------- -------- ------------------------------------------------------
48 * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
49 * 08-31-07 02.00.01 Modifications to RAID Action request and reply,
50 * including the Actions and ActionData.
51 * 02-29-08 02.00.02 Added MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD.
52 * 05-21-08 02.00.03 Added MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS so that
53 * the PhysDisk array in MPI2_RAID_VOLUME_CREATION_STRUCT
54 * can be sized by the build environment.
55 * 07-30-09 02.00.04 Added proper define for the Use Default Settings bit of
56 * VolumeCreationFlags and marked the old one as obsolete.
57 * 05-12-10 02.00.05 Added MPI2_RAID_VOL_FLAGS_OP_MDC define.
58 * 08-24-10 02.00.06 Added MPI2_RAID_ACTION_COMPATIBILITY_CHECK along with
59 * related structures and defines.
60 * Added product-specific range to RAID Action values.
61 * 11-18-11 02.00.07 Incorporating additions for MPI v2.5.
62 * 02-06-12 02.00.08 Added MPI2_RAID_ACTION_PHYSDISK_HIDDEN.
63 * 07-26-12 02.00.09 Added ElapsedSeconds field to MPI2_RAID_VOL_INDICATOR.
64 * Added MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID define.
65 * 04-17-13 02.00.10 Added MPI25_RAID_ACTION_ADATA_ALLOW_PI.
66 * 11-18-14 02.00.11 Updated copyright information.
67 * --------------------------------------------------------------------------
68 */
69
70 #ifndef MPI2_RAID_H
71 #define MPI2_RAID_H
72
73 /*****************************************************************************
74 *
75 * Integrated RAID Messages
76 *
77 *****************************************************************************/
78
79 /****************************************************************************
80 * RAID Action messages
81 ****************************************************************************/
82
83 /* ActionDataWord defines for use with MPI2_RAID_ACTION_CREATE_VOLUME action */
84 #define MPI25_RAID_ACTION_ADATA_ALLOW_PI (0x80000000)
85
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)
89
90 /* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
91
92 /* ActionDataWord defines for use with MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES action */
93 #define MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD (0x00000001)
94
95 /* ActionDataWord for MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE Action */
96 typedef struct _MPI2_RAID_ACTION_RATE_DATA
97 {
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;
103
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)
107
108 /* ActionDataWord for MPI2_RAID_ACTION_START_RAID_FUNCTION Action */
109 typedef struct _MPI2_RAID_ACTION_START_RAID_FUNCTION
110 {
111 U8 RAIDFunction; /* 0x00 */
112 U8 Flags; /* 0x01 */
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;
118
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)
123
124 /* defines for the Flags field */
125 #define MPI2_RAID_ACTION_START_NEW (0x00)
126 #define MPI2_RAID_ACTION_START_RESUME (0x01)
127
128 /* ActionDataWord for MPI2_RAID_ACTION_STOP_RAID_FUNCTION Action */
129 typedef struct _MPI2_RAID_ACTION_STOP_RAID_FUNCTION
130 {
131 U8 RAIDFunction; /* 0x00 */
132 U8 Flags; /* 0x01 */
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;
138
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)
143
144 /* defines for the Flags field */
145 #define MPI2_RAID_ACTION_STOP_ABORT (0x00)
146 #define MPI2_RAID_ACTION_STOP_PAUSE (0x01)
147
148 /* ActionDataWord for MPI2_RAID_ACTION_CREATE_HOT_SPARE Action */
149 typedef struct _MPI2_RAID_ACTION_HOT_SPARE
150 {
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;
156
157 /* ActionDataWord for MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE Action */
158 typedef struct _MPI2_RAID_ACTION_FW_UPDATE_MODE
159 {
160 U8 Flags; /* 0x00 */
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;
166
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)
170
171 typedef union _MPI2_RAID_ACTION_DATA
172 {
173 U32 Word;
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;
181
182 /* RAID Action Request Message */
183 typedef struct _MPI2_RAID_ACTION_REQUEST
184 {
185 U8 Action; /* 0x00 */
186 U8 Reserved1; /* 0x01 */
187 U8 ChainOffset; /* 0x02 */
188 U8 Function; /* 0x03 */
189 U16 VolDevHandle; /* 0x04 */
190 U8 PhysDiskNum; /* 0x06 */
191 U8 MsgFlags; /* 0x07 */
192 U8 VP_ID; /* 0x08 */
193 U8 VF_ID; /* 0x09 */
194 U16 Reserved2; /* 0x0A */
195 U32 Reserved3; /* 0x0C */
196 MPI2_RAID_ACTION_DATA ActionDataWord; /* 0x10 */
197 MPI2_SGE_SIMPLE_UNION ActionDataSGE; /* 0x14 */
198 } MPI2_RAID_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_RAID_ACTION_REQUEST,
199 Mpi2RaidActionRequest_t, MPI2_POINTER pMpi2RaidActionRequest_t;
200
201 /* RAID Action request Action values */
202
203 #define MPI2_RAID_ACTION_INDICATOR_STRUCT (0x01)
204 #define MPI2_RAID_ACTION_CREATE_VOLUME (0x02)
205 #define MPI2_RAID_ACTION_DELETE_VOLUME (0x03)
206 #define MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES (0x04)
207 #define MPI2_RAID_ACTION_ENABLE_ALL_VOLUMES (0x05)
208 #define MPI2_RAID_ACTION_PHYSDISK_OFFLINE (0x0A)
209 #define MPI2_RAID_ACTION_PHYSDISK_ONLINE (0x0B)
210 #define MPI2_RAID_ACTION_FAIL_PHYSDISK (0x0F)
211 #define MPI2_RAID_ACTION_ACTIVATE_VOLUME (0x11)
212 #define MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE (0x15)
213 #define MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE (0x17)
214 #define MPI2_RAID_ACTION_SET_VOLUME_NAME (0x18)
215 #define MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE (0x19)
216 #define MPI2_RAID_ACTION_ENABLE_FAILED_VOLUME (0x1C)
217 #define MPI2_RAID_ACTION_CREATE_HOT_SPARE (0x1D)
218 #define MPI2_RAID_ACTION_DELETE_HOT_SPARE (0x1E)
219 #define MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED (0x20)
220 #define MPI2_RAID_ACTION_START_RAID_FUNCTION (0x21)
221 #define MPI2_RAID_ACTION_STOP_RAID_FUNCTION (0x22)
222 #define MPI2_RAID_ACTION_COMPATIBILITY_CHECK (0x23)
223 #define MPI2_RAID_ACTION_PHYSDISK_HIDDEN (0x24)
224 #define MPI2_RAID_ACTION_MIN_PRODUCT_SPECIFIC (0x80)
225 #define MPI2_RAID_ACTION_MAX_PRODUCT_SPECIFIC (0xFF)
226
227 /* RAID Volume Creation Structure */
228
229 /*
230 * The following define can be customized for the targeted product.
231 */
232 #ifndef MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS
233 #define MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS (1)
234 #endif
235
236 typedef struct _MPI2_RAID_VOLUME_PHYSDISK
237 {
238 U8 RAIDSetNum; /* 0x00 */
239 U8 PhysDiskMap; /* 0x01 */
240 U16 PhysDiskDevHandle; /* 0x02 */
241 } MPI2_RAID_VOLUME_PHYSDISK, MPI2_POINTER PTR_MPI2_RAID_VOLUME_PHYSDISK,
242 Mpi2RaidVolumePhysDisk_t, MPI2_POINTER pMpi2RaidVolumePhysDisk_t;
243
244 /* defines for the PhysDiskMap field */
245 #define MPI2_RAIDACTION_PHYSDISK_PRIMARY (0x01)
246 #define MPI2_RAIDACTION_PHYSDISK_SECONDARY (0x02)
247
248 typedef struct _MPI2_RAID_VOLUME_CREATION_STRUCT
249 {
250 U8 NumPhysDisks; /* 0x00 */
251 U8 VolumeType; /* 0x01 */
252 U16 Reserved1; /* 0x02 */
253 U32 VolumeCreationFlags; /* 0x04 */
254 U32 VolumeSettings; /* 0x08 */
255 U8 Reserved2; /* 0x0C */
256 U8 ResyncRate; /* 0x0D */
257 U16 DataScrubDuration; /* 0x0E */
258 U64 VolumeMaxLBA; /* 0x10 */
259 U32 StripeSize; /* 0x18 */
260 U8 Name[16]; /* 0x1C */
261 MPI2_RAID_VOLUME_PHYSDISK PhysDisk[MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS];/* 0x2C */
262 } MPI2_RAID_VOLUME_CREATION_STRUCT,
263 MPI2_POINTER PTR_MPI2_RAID_VOLUME_CREATION_STRUCT,
264 Mpi2RaidVolumeCreationStruct_t, MPI2_POINTER pMpi2RaidVolumeCreationStruct_t;
265
266 /* use MPI2_RAID_VOL_TYPE_ defines from mpi2_cnfg.h for VolumeType */
267
268 /* defines for the VolumeCreationFlags field */
269 #define MPI2_RAID_VOL_CREATION_DEFAULT_SETTINGS (0x80000000)
270 #define MPI2_RAID_VOL_CREATION_BACKGROUND_INIT (0x00000004) /* MPI 2.0 only */
271 #define MPI2_RAID_VOL_CREATION_LOW_LEVEL_INIT (0x00000002)
272 #define MPI2_RAID_VOL_CREATION_MIGRATE_DATA (0x00000001)
273 /* The following is an obsolete define.
274 * It must be shifted left 24 bits in order to set the proper bit.
275 */
276 #define MPI2_RAID_VOL_CREATION_USE_DEFAULT_SETTINGS (0x80)
277
278 /* RAID Online Capacity Expansion Structure */
279
280 typedef struct _MPI2_RAID_ONLINE_CAPACITY_EXPANSION
281 {
282 U32 Flags; /* 0x00 */
283 U16 DevHandle0; /* 0x04 */
284 U16 Reserved1; /* 0x06 */
285 U16 DevHandle1; /* 0x08 */
286 U16 Reserved2; /* 0x0A */
287 } MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
288 MPI2_POINTER PTR_MPI2_RAID_ONLINE_CAPACITY_EXPANSION,
289 Mpi2RaidOnlineCapacityExpansion_t,
290 MPI2_POINTER pMpi2RaidOnlineCapacityExpansion_t;
291
292 /* RAID Compatibility Input Structure */
293
294 typedef struct _MPI2_RAID_COMPATIBILITY_INPUT_STRUCT
295 {
296 U16 SourceDevHandle; /* 0x00 */
297 U16 CandidateDevHandle; /* 0x02 */
298 U32 Flags; /* 0x04 */
299 U32 Reserved1; /* 0x08 */
300 U32 Reserved2; /* 0x0C */
301 } MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
302 MPI2_POINTER PTR_MPI2_RAID_COMPATIBILITY_INPUT_STRUCT,
303 Mpi2RaidCompatibilityInputStruct_t,
304 MPI2_POINTER pMpi2RaidCompatibilityInputStruct_t;
305
306 /* defines for RAID Compatibility Structure Flags field */
307 #define MPI2_RAID_COMPAT_SOURCE_IS_VOLUME_FLAG (0x00000002)
308 #define MPI2_RAID_COMPAT_REPORT_SOURCE_INFO_FLAG (0x00000001)
309
310 /* RAID Volume Indicator Structure */
311
312 typedef struct _MPI2_RAID_VOL_INDICATOR
313 {
314 U64 TotalBlocks; /* 0x00 */
315 U64 BlocksRemaining; /* 0x08 */
316 U32 Flags; /* 0x10 */
317 U32 ElapsedSeconds; /* 0x14 */
318 } MPI2_RAID_VOL_INDICATOR, MPI2_POINTER PTR_MPI2_RAID_VOL_INDICATOR,
319 Mpi2RaidVolIndicator_t, MPI2_POINTER pMpi2RaidVolIndicator_t;
320
321 /* defines for RAID Volume Indicator Flags field */
322 #define MPI2_RAID_VOL_FLAGS_ELAPSED_SECONDS_VALID (0x80000000)
323
324 #define MPI2_RAID_VOL_FLAGS_OP_MASK (0x0000000F)
325 #define MPI2_RAID_VOL_FLAGS_OP_BACKGROUND_INIT (0x00000000)
326 #define MPI2_RAID_VOL_FLAGS_OP_ONLINE_CAP_EXPANSION (0x00000001)
327 #define MPI2_RAID_VOL_FLAGS_OP_CONSISTENCY_CHECK (0x00000002)
328 #define MPI2_RAID_VOL_FLAGS_OP_RESYNC (0x00000003)
329 #define MPI2_RAID_VOL_FLAGS_OP_MDC (0x00000004)
330
331 /* RAID Compatibility Result Structure */
332
333 typedef struct _MPI2_RAID_COMPATIBILITY_RESULT_STRUCT
334 {
335 U8 State; /* 0x00 */
336 U8 Reserved1; /* 0x01 */
337 U16 Reserved2; /* 0x02 */
338 U32 GenericAttributes; /* 0x04 */
339 U32 OEMSpecificAttributes; /* 0x08 */
340 U32 Reserved3; /* 0x0C */
341 U32 Reserved4; /* 0x10 */
342 } MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
343 MPI2_POINTER PTR_MPI2_RAID_COMPATIBILITY_RESULT_STRUCT,
344 Mpi2RaidCompatibilityResultStruct_t,
345 MPI2_POINTER pMpi2RaidCompatibilityResultStruct_t;
346
347 /* defines for RAID Compatibility Result Structure State field */
348 #define MPI2_RAID_COMPAT_STATE_COMPATIBLE (0x00)
349 #define MPI2_RAID_COMPAT_STATE_NOT_COMPATIBLE (0x01)
350
351 /* defines for RAID Compatibility Result Structure GenericAttributes field */
352 #define MPI2_RAID_COMPAT_GENATTRIB_4K_SECTOR (0x00000010)
353
354 #define MPI2_RAID_COMPAT_GENATTRIB_MEDIA_MASK (0x0000000C)
355 #define MPI2_RAID_COMPAT_GENATTRIB_SOLID_STATE_DRIVE (0x00000008)
356 #define MPI2_RAID_COMPAT_GENATTRIB_HARD_DISK_DRIVE (0x00000004)
357
358 #define MPI2_RAID_COMPAT_GENATTRIB_PROTOCOL_MASK (0x00000003)
359 #define MPI2_RAID_COMPAT_GENATTRIB_SAS_PROTOCOL (0x00000002)
360 #define MPI2_RAID_COMPAT_GENATTRIB_SATA_PROTOCOL (0x00000001)
361
362 /* RAID Action Reply ActionData union */
363 typedef union _MPI2_RAID_ACTION_REPLY_DATA
364 {
365 U32 Word[6];
366 MPI2_RAID_VOL_INDICATOR RaidVolumeIndicator;
367 U16 VolDevHandle;
368 U8 VolumeState;
369 U8 PhysDiskNum;
370 MPI2_RAID_COMPATIBILITY_RESULT_STRUCT RaidCompatibilityResult;
371 } MPI2_RAID_ACTION_REPLY_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY_DATA,
372 Mpi2RaidActionReplyData_t, MPI2_POINTER pMpi2RaidActionReplyData_t;
373
374 /* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */
375
376 /* RAID Action Reply Message */
377 typedef struct _MPI2_RAID_ACTION_REPLY
378 {
379 U8 Action; /* 0x00 */
380 U8 Reserved1; /* 0x01 */
381 U8 MsgLength; /* 0x02 */
382 U8 Function; /* 0x03 */
383 U16 VolDevHandle; /* 0x04 */
384 U8 PhysDiskNum; /* 0x06 */
385 U8 MsgFlags; /* 0x07 */
386 U8 VP_ID; /* 0x08 */
387 U8 VF_ID; /* 0x09 */
388 U16 Reserved2; /* 0x0A */
389 U16 Reserved3; /* 0x0C */
390 U16 IOCStatus; /* 0x0E */
391 U32 IOCLogInfo; /* 0x10 */
392 MPI2_RAID_ACTION_REPLY_DATA ActionData; /* 0x14 */
393 } MPI2_RAID_ACTION_REPLY, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY,
394 Mpi2RaidActionReply_t, MPI2_POINTER pMpi2RaidActionReply_t;
395
396 #endif
Cache object: bcb70386f5618fa0bb9bf9dbb2f082f7
|