LXR linux/drivers/scsi/mpt3sas/mpi/mpi2

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