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