Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  *  Copyright (c) 2001-2008 LSI Corporation.
0004  *
0005  *
0006  *           Name:  mpi_raid.h
0007  *          Title:  MPI RAID message and structures
0008  *  Creation Date:  February 27, 2001
0009  *
0010  *    mpi_raid.h Version:  01.05.05
0011  *
0012  *  Version History
0013  *  ---------------
0014  *
0015  *  Date      Version   Description
0016  *  --------  --------  ------------------------------------------------------
0017  *  02-27-01  01.01.01  Original release for this file.
0018  *  03-27-01  01.01.02  Added structure offset comments.
0019  *  08-08-01  01.02.01  Original release for v1.2 work.
0020  *  09-28-01  01.02.02  Major rework for MPI v1.2 Integrated RAID changes.
0021  *  10-04-01  01.02.03  Added ActionData defines for
0022  *                      MPI_RAID_ACTION_DELETE_VOLUME action.
0023  *  11-01-01  01.02.04  Added define for MPI_RAID_ACTION_ADATA_DO_NOT_SYNC.
0024  *  03-14-02  01.02.05  Added define for MPI_RAID_ACTION_ADATA_LOW_LEVEL_INIT.
0025  *  05-07-02  01.02.06  Added define for MPI_RAID_ACTION_ACTIVATE_VOLUME,
0026  *                      MPI_RAID_ACTION_INACTIVATE_VOLUME, and
0027  *                      MPI_RAID_ACTION_ADATA_INACTIVATE_ALL.
0028  *  07-12-02  01.02.07  Added structures for Mailbox request and reply.
0029  *  11-15-02  01.02.08  Added missing MsgContext field to MSG_MAILBOX_REQUEST.
0030  *  04-01-03  01.02.09  New action data option flag for
0031  *                      MPI_RAID_ACTION_DELETE_VOLUME.
0032  *  05-11-04  01.03.01  Original release for MPI v1.3.
0033  *  08-19-04  01.05.01  Original release for MPI v1.5.
0034  *  01-15-05  01.05.02  Added defines for the two new RAID Actions for
0035  *                      _SET_RESYNC_RATE and _SET_DATA_SCRUB_RATE.
0036  *  02-28-07  01.05.03  Added new RAID Action, Device FW Update Mode, and
0037  *                      associated defines.
0038  *  08-07-07  01.05.04  Added Disable Full Rebuild bit to the ActionDataWord
0039  *                      for the RAID Action MPI_RAID_ACTION_DISABLE_VOLUME.
0040  *  01-15-08  01.05.05  Added define for MPI_RAID_ACTION_SET_VOLUME_NAME.
0041  *  --------------------------------------------------------------------------
0042  */
0043 
0044 #ifndef MPI_RAID_H
0045 #define MPI_RAID_H
0046 
0047 
0048 /******************************************************************************
0049 *
0050 *        R A I D    M e s s a g e s
0051 *
0052 *******************************************************************************/
0053 
0054 
0055 /****************************************************************************/
0056 /* RAID Action Request                                                      */
0057 /****************************************************************************/
0058 
0059 typedef struct _MSG_RAID_ACTION
0060 {
0061     U8                      Action;             /* 00h */
0062     U8                      Reserved1;          /* 01h */
0063     U8                      ChainOffset;        /* 02h */
0064     U8                      Function;           /* 03h */
0065     U8                      VolumeID;           /* 04h */
0066     U8                      VolumeBus;          /* 05h */
0067     U8                      PhysDiskNum;        /* 06h */
0068     U8                      MsgFlags;           /* 07h */
0069     U32                     MsgContext;         /* 08h */
0070     U32                     Reserved2;          /* 0Ch */
0071     U32                     ActionDataWord;     /* 10h */
0072     SGE_SIMPLE_UNION        ActionDataSGE;      /* 14h */
0073 } MSG_RAID_ACTION_REQUEST, MPI_POINTER PTR_MSG_RAID_ACTION_REQUEST,
0074   MpiRaidActionRequest_t , MPI_POINTER pMpiRaidActionRequest_t;
0075 
0076 
0077 /* RAID Action request Action values */
0078 
0079 #define MPI_RAID_ACTION_STATUS                      (0x00)
0080 #define MPI_RAID_ACTION_INDICATOR_STRUCT            (0x01)
0081 #define MPI_RAID_ACTION_CREATE_VOLUME               (0x02)
0082 #define MPI_RAID_ACTION_DELETE_VOLUME               (0x03)
0083 #define MPI_RAID_ACTION_DISABLE_VOLUME              (0x04)
0084 #define MPI_RAID_ACTION_ENABLE_VOLUME               (0x05)
0085 #define MPI_RAID_ACTION_QUIESCE_PHYS_IO             (0x06)
0086 #define MPI_RAID_ACTION_ENABLE_PHYS_IO              (0x07)
0087 #define MPI_RAID_ACTION_CHANGE_VOLUME_SETTINGS      (0x08)
0088 #define MPI_RAID_ACTION_PHYSDISK_OFFLINE            (0x0A)
0089 #define MPI_RAID_ACTION_PHYSDISK_ONLINE             (0x0B)
0090 #define MPI_RAID_ACTION_CHANGE_PHYSDISK_SETTINGS    (0x0C)
0091 #define MPI_RAID_ACTION_CREATE_PHYSDISK             (0x0D)
0092 #define MPI_RAID_ACTION_DELETE_PHYSDISK             (0x0E)
0093 #define MPI_RAID_ACTION_FAIL_PHYSDISK               (0x0F)
0094 #define MPI_RAID_ACTION_REPLACE_PHYSDISK            (0x10)
0095 #define MPI_RAID_ACTION_ACTIVATE_VOLUME             (0x11)
0096 #define MPI_RAID_ACTION_INACTIVATE_VOLUME           (0x12)
0097 #define MPI_RAID_ACTION_SET_RESYNC_RATE             (0x13)
0098 #define MPI_RAID_ACTION_SET_DATA_SCRUB_RATE         (0x14)
0099 #define MPI_RAID_ACTION_DEVICE_FW_UPDATE_MODE       (0x15)
0100 #define MPI_RAID_ACTION_SET_VOLUME_NAME             (0x16)
0101 
0102 /* ActionDataWord defines for use with MPI_RAID_ACTION_CREATE_VOLUME action */
0103 #define MPI_RAID_ACTION_ADATA_DO_NOT_SYNC           (0x00000001)
0104 #define MPI_RAID_ACTION_ADATA_LOW_LEVEL_INIT        (0x00000002)
0105 
0106 /* ActionDataWord defines for use with MPI_RAID_ACTION_DELETE_VOLUME action */
0107 #define MPI_RAID_ACTION_ADATA_KEEP_PHYS_DISKS       (0x00000000)
0108 #define MPI_RAID_ACTION_ADATA_DEL_PHYS_DISKS        (0x00000001)
0109 
0110 #define MPI_RAID_ACTION_ADATA_KEEP_LBA0             (0x00000000)
0111 #define MPI_RAID_ACTION_ADATA_ZERO_LBA0             (0x00000002)
0112 
0113 /* ActionDataWord defines for use with MPI_RAID_ACTION_DISABLE_VOLUME action */
0114 #define MPI_RAID_ACTION_ADATA_DISABLE_FULL_REBUILD  (0x00000001)
0115 
0116 /* ActionDataWord defines for use with MPI_RAID_ACTION_ACTIVATE_VOLUME action */
0117 #define MPI_RAID_ACTION_ADATA_INACTIVATE_ALL        (0x00000001)
0118 
0119 /* ActionDataWord defines for use with MPI_RAID_ACTION_SET_RESYNC_RATE action */
0120 #define MPI_RAID_ACTION_ADATA_RESYNC_RATE_MASK      (0x000000FF)
0121 
0122 /* ActionDataWord defines for use with MPI_RAID_ACTION_SET_DATA_SCRUB_RATE action */
0123 #define MPI_RAID_ACTION_ADATA_DATA_SCRUB_RATE_MASK  (0x000000FF)
0124 
0125 /* ActionDataWord defines for use with MPI_RAID_ACTION_DEVICE_FW_UPDATE_MODE action */
0126 #define MPI_RAID_ACTION_ADATA_ENABLE_FW_UPDATE          (0x00000001)
0127 #define MPI_RAID_ACTION_ADATA_MASK_FW_UPDATE_TIMEOUT    (0x0000FF00)
0128 #define MPI_RAID_ACTION_ADATA_SHIFT_FW_UPDATE_TIMEOUT   (8)
0129 
0130 
0131 /* RAID Action reply message */
0132 
0133 typedef struct _MSG_RAID_ACTION_REPLY
0134 {
0135     U8                      Action;             /* 00h */
0136     U8                      Reserved;           /* 01h */
0137     U8                      MsgLength;          /* 02h */
0138     U8                      Function;           /* 03h */
0139     U8                      VolumeID;           /* 04h */
0140     U8                      VolumeBus;          /* 05h */
0141     U8                      PhysDiskNum;        /* 06h */
0142     U8                      MsgFlags;           /* 07h */
0143     U32                     MsgContext;         /* 08h */
0144     U16                     ActionStatus;       /* 0Ch */
0145     U16                     IOCStatus;          /* 0Eh */
0146     U32                     IOCLogInfo;         /* 10h */
0147     U32                     VolumeStatus;       /* 14h */
0148     U32                     ActionData;         /* 18h */
0149 } MSG_RAID_ACTION_REPLY, MPI_POINTER PTR_MSG_RAID_ACTION_REPLY,
0150   MpiRaidActionReply_t, MPI_POINTER pMpiRaidActionReply_t;
0151 
0152 
0153 /* RAID Volume reply ActionStatus values */
0154 
0155 #define MPI_RAID_ACTION_ASTATUS_SUCCESS             (0x0000)
0156 #define MPI_RAID_ACTION_ASTATUS_INVALID_ACTION      (0x0001)
0157 #define MPI_RAID_ACTION_ASTATUS_FAILURE             (0x0002)
0158 #define MPI_RAID_ACTION_ASTATUS_IN_PROGRESS         (0x0003)
0159 
0160 
0161 /* RAID Volume reply RAID Volume Indicator structure */
0162 
0163 typedef struct _MPI_RAID_VOL_INDICATOR
0164 {
0165     U64                     TotalBlocks;        /* 00h */
0166     U64                     BlocksRemaining;    /* 08h */
0167 } MPI_RAID_VOL_INDICATOR, MPI_POINTER PTR_MPI_RAID_VOL_INDICATOR,
0168   MpiRaidVolIndicator_t, MPI_POINTER pMpiRaidVolIndicator_t;
0169 
0170 
0171 /****************************************************************************/
0172 /* SCSI IO RAID Passthrough Request                                         */
0173 /****************************************************************************/
0174 
0175 typedef struct _MSG_SCSI_IO_RAID_PT_REQUEST
0176 {
0177     U8                      PhysDiskNum;        /* 00h */
0178     U8                      Reserved1;          /* 01h */
0179     U8                      ChainOffset;        /* 02h */
0180     U8                      Function;           /* 03h */
0181     U8                      CDBLength;          /* 04h */
0182     U8                      SenseBufferLength;  /* 05h */
0183     U8                      Reserved2;          /* 06h */
0184     U8                      MsgFlags;           /* 07h */
0185     U32                     MsgContext;         /* 08h */
0186     U8                      LUN[8];             /* 0Ch */
0187     U32                     Control;            /* 14h */
0188     U8                      CDB[16];            /* 18h */
0189     U32                     DataLength;         /* 28h */
0190     U32                     SenseBufferLowAddr; /* 2Ch */
0191     SGE_IO_UNION            SGL;                /* 30h */
0192 } MSG_SCSI_IO_RAID_PT_REQUEST, MPI_POINTER PTR_MSG_SCSI_IO_RAID_PT_REQUEST,
0193   SCSIIORaidPassthroughRequest_t, MPI_POINTER pSCSIIORaidPassthroughRequest_t;
0194 
0195 
0196 /* SCSI IO RAID Passthrough reply structure */
0197 
0198 typedef struct _MSG_SCSI_IO_RAID_PT_REPLY
0199 {
0200     U8                      PhysDiskNum;        /* 00h */
0201     U8                      Reserved1;          /* 01h */
0202     U8                      MsgLength;          /* 02h */
0203     U8                      Function;           /* 03h */
0204     U8                      CDBLength;          /* 04h */
0205     U8                      SenseBufferLength;  /* 05h */
0206     U8                      Reserved2;          /* 06h */
0207     U8                      MsgFlags;           /* 07h */
0208     U32                     MsgContext;         /* 08h */
0209     U8                      SCSIStatus;         /* 0Ch */
0210     U8                      SCSIState;          /* 0Dh */
0211     U16                     IOCStatus;          /* 0Eh */
0212     U32                     IOCLogInfo;         /* 10h */
0213     U32                     TransferCount;      /* 14h */
0214     U32                     SenseCount;         /* 18h */
0215     U32                     ResponseInfo;       /* 1Ch */
0216 } MSG_SCSI_IO_RAID_PT_REPLY, MPI_POINTER PTR_MSG_SCSI_IO_RAID_PT_REPLY,
0217   SCSIIORaidPassthroughReply_t, MPI_POINTER pSCSIIORaidPassthroughReply_t;
0218 
0219 
0220 /****************************************************************************/
0221 /* Mailbox reqeust structure */
0222 /****************************************************************************/
0223 
0224 typedef struct _MSG_MAILBOX_REQUEST
0225 {
0226     U16                     Reserved1;
0227     U8                      ChainOffset;
0228     U8                      Function;
0229     U16                     Reserved2;
0230     U8                      Reserved3;
0231     U8                      MsgFlags;
0232     U32                     MsgContext;
0233     U8                      Command[10];
0234     U16                     Reserved4;
0235     SGE_IO_UNION            SGL;
0236 } MSG_MAILBOX_REQUEST, MPI_POINTER PTR_MSG_MAILBOX_REQUEST,
0237   MailboxRequest_t, MPI_POINTER pMailboxRequest_t;
0238 
0239 
0240 /* Mailbox reply structure */
0241 typedef struct _MSG_MAILBOX_REPLY
0242 {
0243     U16                     Reserved1;          /* 00h */
0244     U8                      MsgLength;          /* 02h */
0245     U8                      Function;           /* 03h */
0246     U16                     Reserved2;          /* 04h */
0247     U8                      Reserved3;          /* 06h */
0248     U8                      MsgFlags;           /* 07h */
0249     U32                     MsgContext;         /* 08h */
0250     U16                     MailboxStatus;      /* 0Ch */
0251     U16                     IOCStatus;          /* 0Eh */
0252     U32                     IOCLogInfo;         /* 10h */
0253     U32                     Reserved4;          /* 14h */
0254 } MSG_MAILBOX_REPLY, MPI_POINTER PTR_MSG_MAILBOX_REPLY,
0255   MailboxReply_t, MPI_POINTER pMailboxReply_t;
0256 
0257 #endif
0258 
0259 
0260