1230592Sken/*- 2281564Sslm * Copyright (c) 2007-2015 LSI Corp. 3281564Sslm * Copyright (c) 2013-2015 Avago Technologies 4230592Sken * All rights reserved. 5230592Sken * 6230592Sken * Redistribution and use in source and binary forms, with or without 7230592Sken * modification, are permitted provided that the following conditions 8230592Sken * are met: 9230592Sken * 1. Redistributions of source code must retain the above copyright 10230592Sken * notice, this list of conditions and the following disclaimer. 11230592Sken * 2. Redistributions in binary form must reproduce the above copyright 12230592Sken * notice, this list of conditions and the following disclaimer in the 13230592Sken * documentation and/or other materials provided with the distribution. 14230592Sken * 15230592Sken * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16230592Sken * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17230592Sken * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18230592Sken * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19230592Sken * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20230592Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21230592Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22230592Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23230592Sken * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24230592Sken * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25230592Sken * SUCH DAMAGE. 26230592Sken * 27281564Sslm * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD 28230592Sken * 29230592Sken * $FreeBSD$ 30230592Sken */ 31230592Sken 32212420Sken/* 33281564Sslm * Copyright (c) 2007-2015 LSI Corporation. 34281564Sslm * Copyright (c) 2013-2015 Avago Technologies 35212420Sken * 36212420Sken * 37212420Sken * Name: mpi2_raid.h 38212420Sken * Title: MPI Integrated RAID messages and structures 39212420Sken * Creation Date: April 26, 2007 40212420Sken * 41230592Sken * mpi2_raid.h Version: 02.00.05 42212420Sken * 43212420Sken * Version History 44212420Sken * --------------- 45212420Sken * 46212420Sken * Date Version Description 47212420Sken * -------- -------- ------------------------------------------------------ 48212420Sken * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A. 49212420Sken * 08-31-07 02.00.01 Modifications to RAID Action request and reply, 50212420Sken * including the Actions and ActionData. 51212420Sken * 02-29-08 02.00.02 Added MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD. 52212420Sken * 05-21-08 02.00.03 Added MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS so that 53212420Sken * the PhysDisk array in MPI2_RAID_VOLUME_CREATION_STRUCT 54212420Sken * can be sized by the build environment. 55212420Sken * 07-30-09 02.00.04 Added proper define for the Use Default Settings bit of 56212420Sken * VolumeCreationFlags and marked the old one as obsolete. 57230592Sken * 05-12-10 02.00.05 Added MPI2_RAID_VOL_FLAGS_OP_MDC define. 58212420Sken * -------------------------------------------------------------------------- 59212420Sken */ 60212420Sken 61212420Sken#ifndef MPI2_RAID_H 62212420Sken#define MPI2_RAID_H 63212420Sken 64212420Sken/***************************************************************************** 65212420Sken* 66212420Sken* Integrated RAID Messages 67212420Sken* 68212420Sken*****************************************************************************/ 69212420Sken 70212420Sken/**************************************************************************** 71212420Sken* RAID Action messages 72212420Sken****************************************************************************/ 73212420Sken 74212420Sken/* ActionDataWord defines for use with MPI2_RAID_ACTION_DELETE_VOLUME action */ 75212420Sken#define MPI2_RAID_ACTION_ADATA_KEEP_LBA0 (0x00000000) 76212420Sken#define MPI2_RAID_ACTION_ADATA_ZERO_LBA0 (0x00000001) 77212420Sken 78212420Sken/* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */ 79212420Sken 80212420Sken/* ActionDataWord defines for use with MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES action */ 81212420Sken#define MPI2_RAID_ACTION_ADATA_DISABL_FULL_REBUILD (0x00000001) 82212420Sken 83212420Sken/* ActionDataWord for MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE Action */ 84212420Skentypedef struct _MPI2_RAID_ACTION_RATE_DATA 85212420Sken{ 86212420Sken U8 RateToChange; /* 0x00 */ 87212420Sken U8 RateOrMode; /* 0x01 */ 88212420Sken U16 DataScrubDuration; /* 0x02 */ 89212420Sken} MPI2_RAID_ACTION_RATE_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_RATE_DATA, 90212420Sken Mpi2RaidActionRateData_t, MPI2_POINTER pMpi2RaidActionRateData_t; 91212420Sken 92212420Sken#define MPI2_RAID_ACTION_SET_RATE_RESYNC (0x00) 93212420Sken#define MPI2_RAID_ACTION_SET_RATE_DATA_SCRUB (0x01) 94212420Sken#define MPI2_RAID_ACTION_SET_RATE_POWERSAVE_MODE (0x02) 95212420Sken 96212420Sken/* ActionDataWord for MPI2_RAID_ACTION_START_RAID_FUNCTION Action */ 97212420Skentypedef struct _MPI2_RAID_ACTION_START_RAID_FUNCTION 98212420Sken{ 99212420Sken U8 RAIDFunction; /* 0x00 */ 100212420Sken U8 Flags; /* 0x01 */ 101212420Sken U16 Reserved1; /* 0x02 */ 102212420Sken} MPI2_RAID_ACTION_START_RAID_FUNCTION, 103212420Sken MPI2_POINTER PTR_MPI2_RAID_ACTION_START_RAID_FUNCTION, 104212420Sken Mpi2RaidActionStartRaidFunction_t, 105212420Sken MPI2_POINTER pMpi2RaidActionStartRaidFunction_t; 106212420Sken 107212420Sken/* defines for the RAIDFunction field */ 108212420Sken#define MPI2_RAID_ACTION_START_BACKGROUND_INIT (0x00) 109212420Sken#define MPI2_RAID_ACTION_START_ONLINE_CAP_EXPANSION (0x01) 110212420Sken#define MPI2_RAID_ACTION_START_CONSISTENCY_CHECK (0x02) 111212420Sken 112212420Sken/* defines for the Flags field */ 113212420Sken#define MPI2_RAID_ACTION_START_NEW (0x00) 114212420Sken#define MPI2_RAID_ACTION_START_RESUME (0x01) 115212420Sken 116212420Sken/* ActionDataWord for MPI2_RAID_ACTION_STOP_RAID_FUNCTION Action */ 117212420Skentypedef struct _MPI2_RAID_ACTION_STOP_RAID_FUNCTION 118212420Sken{ 119212420Sken U8 RAIDFunction; /* 0x00 */ 120212420Sken U8 Flags; /* 0x01 */ 121212420Sken U16 Reserved1; /* 0x02 */ 122212420Sken} MPI2_RAID_ACTION_STOP_RAID_FUNCTION, 123212420Sken MPI2_POINTER PTR_MPI2_RAID_ACTION_STOP_RAID_FUNCTION, 124212420Sken Mpi2RaidActionStopRaidFunction_t, 125212420Sken MPI2_POINTER pMpi2RaidActionStopRaidFunction_t; 126212420Sken 127212420Sken/* defines for the RAIDFunction field */ 128212420Sken#define MPI2_RAID_ACTION_STOP_BACKGROUND_INIT (0x00) 129212420Sken#define MPI2_RAID_ACTION_STOP_ONLINE_CAP_EXPANSION (0x01) 130212420Sken#define MPI2_RAID_ACTION_STOP_CONSISTENCY_CHECK (0x02) 131212420Sken 132212420Sken/* defines for the Flags field */ 133212420Sken#define MPI2_RAID_ACTION_STOP_ABORT (0x00) 134212420Sken#define MPI2_RAID_ACTION_STOP_PAUSE (0x01) 135212420Sken 136212420Sken/* ActionDataWord for MPI2_RAID_ACTION_CREATE_HOT_SPARE Action */ 137212420Skentypedef struct _MPI2_RAID_ACTION_HOT_SPARE 138212420Sken{ 139212420Sken U8 HotSparePool; /* 0x00 */ 140212420Sken U8 Reserved1; /* 0x01 */ 141212420Sken U16 DevHandle; /* 0x02 */ 142212420Sken} MPI2_RAID_ACTION_HOT_SPARE, MPI2_POINTER PTR_MPI2_RAID_ACTION_HOT_SPARE, 143212420Sken Mpi2RaidActionHotSpare_t, MPI2_POINTER pMpi2RaidActionHotSpare_t; 144212420Sken 145212420Sken/* ActionDataWord for MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE Action */ 146212420Skentypedef struct _MPI2_RAID_ACTION_FW_UPDATE_MODE 147212420Sken{ 148212420Sken U8 Flags; /* 0x00 */ 149212420Sken U8 DeviceFirmwareUpdateModeTimeout; /* 0x01 */ 150212420Sken U16 Reserved1; /* 0x02 */ 151212420Sken} MPI2_RAID_ACTION_FW_UPDATE_MODE, 152212420Sken MPI2_POINTER PTR_MPI2_RAID_ACTION_FW_UPDATE_MODE, 153212420Sken Mpi2RaidActionFwUpdateMode_t, MPI2_POINTER pMpi2RaidActionFwUpdateMode_t; 154212420Sken 155212420Sken/* ActionDataWord defines for use with MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE action */ 156212420Sken#define MPI2_RAID_ACTION_ADATA_DISABLE_FW_UPDATE (0x00) 157212420Sken#define MPI2_RAID_ACTION_ADATA_ENABLE_FW_UPDATE (0x01) 158212420Sken 159212420Skentypedef union _MPI2_RAID_ACTION_DATA 160212420Sken{ 161212420Sken U32 Word; 162212420Sken MPI2_RAID_ACTION_RATE_DATA Rates; 163212420Sken MPI2_RAID_ACTION_START_RAID_FUNCTION StartRaidFunction; 164212420Sken MPI2_RAID_ACTION_STOP_RAID_FUNCTION StopRaidFunction; 165212420Sken MPI2_RAID_ACTION_HOT_SPARE HotSpare; 166212420Sken MPI2_RAID_ACTION_FW_UPDATE_MODE FwUpdateMode; 167212420Sken} MPI2_RAID_ACTION_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_DATA, 168212420Sken Mpi2RaidActionData_t, MPI2_POINTER pMpi2RaidActionData_t; 169212420Sken 170212420Sken 171212420Sken/* RAID Action Request Message */ 172212420Skentypedef struct _MPI2_RAID_ACTION_REQUEST 173212420Sken{ 174212420Sken U8 Action; /* 0x00 */ 175212420Sken U8 Reserved1; /* 0x01 */ 176212420Sken U8 ChainOffset; /* 0x02 */ 177212420Sken U8 Function; /* 0x03 */ 178212420Sken U16 VolDevHandle; /* 0x04 */ 179212420Sken U8 PhysDiskNum; /* 0x06 */ 180212420Sken U8 MsgFlags; /* 0x07 */ 181212420Sken U8 VP_ID; /* 0x08 */ 182212420Sken U8 VF_ID; /* 0x09 */ 183212420Sken U16 Reserved2; /* 0x0A */ 184212420Sken U32 Reserved3; /* 0x0C */ 185212420Sken MPI2_RAID_ACTION_DATA ActionDataWord; /* 0x10 */ 186212420Sken MPI2_SGE_SIMPLE_UNION ActionDataSGE; /* 0x14 */ 187212420Sken} MPI2_RAID_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_RAID_ACTION_REQUEST, 188212420Sken Mpi2RaidActionRequest_t, MPI2_POINTER pMpi2RaidActionRequest_t; 189212420Sken 190212420Sken/* RAID Action request Action values */ 191212420Sken 192212420Sken#define MPI2_RAID_ACTION_INDICATOR_STRUCT (0x01) 193212420Sken#define MPI2_RAID_ACTION_CREATE_VOLUME (0x02) 194212420Sken#define MPI2_RAID_ACTION_DELETE_VOLUME (0x03) 195212420Sken#define MPI2_RAID_ACTION_DISABLE_ALL_VOLUMES (0x04) 196212420Sken#define MPI2_RAID_ACTION_ENABLE_ALL_VOLUMES (0x05) 197212420Sken#define MPI2_RAID_ACTION_PHYSDISK_OFFLINE (0x0A) 198212420Sken#define MPI2_RAID_ACTION_PHYSDISK_ONLINE (0x0B) 199212420Sken#define MPI2_RAID_ACTION_FAIL_PHYSDISK (0x0F) 200212420Sken#define MPI2_RAID_ACTION_ACTIVATE_VOLUME (0x11) 201212420Sken#define MPI2_RAID_ACTION_DEVICE_FW_UPDATE_MODE (0x15) 202212420Sken#define MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE (0x17) 203212420Sken#define MPI2_RAID_ACTION_SET_VOLUME_NAME (0x18) 204212420Sken#define MPI2_RAID_ACTION_SET_RAID_FUNCTION_RATE (0x19) 205212420Sken#define MPI2_RAID_ACTION_ENABLE_FAILED_VOLUME (0x1C) 206212420Sken#define MPI2_RAID_ACTION_CREATE_HOT_SPARE (0x1D) 207212420Sken#define MPI2_RAID_ACTION_DELETE_HOT_SPARE (0x1E) 208212420Sken#define MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED (0x20) 209212420Sken#define MPI2_RAID_ACTION_START_RAID_FUNCTION (0x21) 210212420Sken#define MPI2_RAID_ACTION_STOP_RAID_FUNCTION (0x22) 211212420Sken 212212420Sken 213212420Sken/* RAID Volume Creation Structure */ 214212420Sken 215212420Sken/* 216212420Sken * The following define can be customized for the targeted product. 217212420Sken */ 218212420Sken#ifndef MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS 219212420Sken#define MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS (1) 220212420Sken#endif 221212420Sken 222212420Skentypedef struct _MPI2_RAID_VOLUME_PHYSDISK 223212420Sken{ 224212420Sken U8 RAIDSetNum; /* 0x00 */ 225212420Sken U8 PhysDiskMap; /* 0x01 */ 226212420Sken U16 PhysDiskDevHandle; /* 0x02 */ 227212420Sken} MPI2_RAID_VOLUME_PHYSDISK, MPI2_POINTER PTR_MPI2_RAID_VOLUME_PHYSDISK, 228212420Sken Mpi2RaidVolumePhysDisk_t, MPI2_POINTER pMpi2RaidVolumePhysDisk_t; 229212420Sken 230212420Sken/* defines for the PhysDiskMap field */ 231212420Sken#define MPI2_RAIDACTION_PHYSDISK_PRIMARY (0x01) 232212420Sken#define MPI2_RAIDACTION_PHYSDISK_SECONDARY (0x02) 233212420Sken 234212420Skentypedef struct _MPI2_RAID_VOLUME_CREATION_STRUCT 235212420Sken{ 236212420Sken U8 NumPhysDisks; /* 0x00 */ 237212420Sken U8 VolumeType; /* 0x01 */ 238212420Sken U16 Reserved1; /* 0x02 */ 239212420Sken U32 VolumeCreationFlags; /* 0x04 */ 240212420Sken U32 VolumeSettings; /* 0x08 */ 241212420Sken U8 Reserved2; /* 0x0C */ 242212420Sken U8 ResyncRate; /* 0x0D */ 243212420Sken U16 DataScrubDuration; /* 0x0E */ 244212420Sken U64 VolumeMaxLBA; /* 0x10 */ 245212420Sken U32 StripeSize; /* 0x18 */ 246212420Sken U8 Name[16]; /* 0x1C */ 247212420Sken MPI2_RAID_VOLUME_PHYSDISK PhysDisk[MPI2_RAID_VOL_CREATION_NUM_PHYSDISKS];/* 0x2C */ 248212420Sken} MPI2_RAID_VOLUME_CREATION_STRUCT, 249212420Sken MPI2_POINTER PTR_MPI2_RAID_VOLUME_CREATION_STRUCT, 250212420Sken Mpi2RaidVolumeCreationStruct_t, MPI2_POINTER pMpi2RaidVolumeCreationStruct_t; 251212420Sken 252212420Sken/* use MPI2_RAID_VOL_TYPE_ defines from mpi2_cnfg.h for VolumeType */ 253212420Sken 254212420Sken/* defines for the VolumeCreationFlags field */ 255212420Sken#define MPI2_RAID_VOL_CREATION_DEFAULT_SETTINGS (0x80000000) 256212420Sken#define MPI2_RAID_VOL_CREATION_BACKGROUND_INIT (0x00000004) 257212420Sken#define MPI2_RAID_VOL_CREATION_LOW_LEVEL_INIT (0x00000002) 258212420Sken#define MPI2_RAID_VOL_CREATION_MIGRATE_DATA (0x00000001) 259212420Sken/* The following is an obsolete define. 260212420Sken * It must be shifted left 24 bits in order to set the proper bit. 261212420Sken */ 262212420Sken#define MPI2_RAID_VOL_CREATION_USE_DEFAULT_SETTINGS (0x80) 263212420Sken 264212420Sken 265212420Sken/* RAID Online Capacity Expansion Structure */ 266212420Sken 267212420Skentypedef struct _MPI2_RAID_ONLINE_CAPACITY_EXPANSION 268212420Sken{ 269212420Sken U32 Flags; /* 0x00 */ 270212420Sken U16 DevHandle0; /* 0x04 */ 271212420Sken U16 Reserved1; /* 0x06 */ 272212420Sken U16 DevHandle1; /* 0x08 */ 273212420Sken U16 Reserved2; /* 0x0A */ 274212420Sken} MPI2_RAID_ONLINE_CAPACITY_EXPANSION, 275212420Sken MPI2_POINTER PTR_MPI2_RAID_ONLINE_CAPACITY_EXPANSION, 276212420Sken Mpi2RaidOnlineCapacityExpansion_t, 277212420Sken MPI2_POINTER pMpi2RaidOnlineCapacityExpansion_t; 278212420Sken 279212420Sken 280212420Sken/* RAID Volume Indicator Structure */ 281212420Sken 282212420Skentypedef struct _MPI2_RAID_VOL_INDICATOR 283212420Sken{ 284212420Sken U64 TotalBlocks; /* 0x00 */ 285212420Sken U64 BlocksRemaining; /* 0x08 */ 286212420Sken U32 Flags; /* 0x10 */ 287212420Sken} MPI2_RAID_VOL_INDICATOR, MPI2_POINTER PTR_MPI2_RAID_VOL_INDICATOR, 288212420Sken Mpi2RaidVolIndicator_t, MPI2_POINTER pMpi2RaidVolIndicator_t; 289212420Sken 290212420Sken/* defines for RAID Volume Indicator Flags field */ 291212420Sken#define MPI2_RAID_VOL_FLAGS_OP_MASK (0x0000000F) 292212420Sken#define MPI2_RAID_VOL_FLAGS_OP_BACKGROUND_INIT (0x00000000) 293212420Sken#define MPI2_RAID_VOL_FLAGS_OP_ONLINE_CAP_EXPANSION (0x00000001) 294212420Sken#define MPI2_RAID_VOL_FLAGS_OP_CONSISTENCY_CHECK (0x00000002) 295212420Sken#define MPI2_RAID_VOL_FLAGS_OP_RESYNC (0x00000003) 296230592Sken#define MPI2_RAID_VOL_FLAGS_OP_MDC (0x00000004) 297212420Sken 298212420Sken 299212420Sken/* RAID Action Reply ActionData union */ 300212420Skentypedef union _MPI2_RAID_ACTION_REPLY_DATA 301212420Sken{ 302212420Sken U32 Word[5]; 303212420Sken MPI2_RAID_VOL_INDICATOR RaidVolumeIndicator; 304212420Sken U16 VolDevHandle; 305212420Sken U8 VolumeState; 306212420Sken U8 PhysDiskNum; 307212420Sken} MPI2_RAID_ACTION_REPLY_DATA, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY_DATA, 308212420Sken Mpi2RaidActionReplyData_t, MPI2_POINTER pMpi2RaidActionReplyData_t; 309212420Sken 310212420Sken/* use MPI2_RAIDVOL0_SETTING_ defines from mpi2_cnfg.h for MPI2_RAID_ACTION_CHANGE_VOL_WRITE_CACHE action */ 311212420Sken 312212420Sken 313212420Sken/* RAID Action Reply Message */ 314212420Skentypedef struct _MPI2_RAID_ACTION_REPLY 315212420Sken{ 316212420Sken U8 Action; /* 0x00 */ 317212420Sken U8 Reserved1; /* 0x01 */ 318212420Sken U8 MsgLength; /* 0x02 */ 319212420Sken U8 Function; /* 0x03 */ 320212420Sken U16 VolDevHandle; /* 0x04 */ 321212420Sken U8 PhysDiskNum; /* 0x06 */ 322212420Sken U8 MsgFlags; /* 0x07 */ 323212420Sken U8 VP_ID; /* 0x08 */ 324212420Sken U8 VF_ID; /* 0x09 */ 325212420Sken U16 Reserved2; /* 0x0A */ 326212420Sken U16 Reserved3; /* 0x0C */ 327212420Sken U16 IOCStatus; /* 0x0E */ 328212420Sken U32 IOCLogInfo; /* 0x10 */ 329212420Sken MPI2_RAID_ACTION_REPLY_DATA ActionData; /* 0x14 */ 330212420Sken} MPI2_RAID_ACTION_REPLY, MPI2_POINTER PTR_MPI2_RAID_ACTION_REPLY, 331212420Sken Mpi2RaidActionReply_t, MPI2_POINTER pMpi2RaidActionReply_t; 332212420Sken 333212420Sken 334212420Sken#endif 335212420Sken 336