fusion/lsi/mpi_sas.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  *  Copyright (c) 2004-2008 LSI Corporation.
0004  *
0005  *
0006  *           Name:  mpi_sas.h
0007  *          Title:  MPI Serial Attached SCSI structures and definitions
0008  *  Creation Date:  August 19, 2004
0009  *
0010  *    mpi_sas.h Version:  01.05.05
0011  *
0012  *  Version History
0013  *  ---------------
0014  *
0015  *  Date      Version   Description
0016  *  --------  --------  ------------------------------------------------------
0017  *  08-19-04  01.05.01  Original release.
0018  *  08-30-05  01.05.02  Added DeviceInfo bit for SEP.
0019  *                      Added PrimFlags and Primitive field to SAS IO Unit
0020  *                      Control request, and added a new operation code.
0021  *  03-27-06  01.05.03  Added Force Full Discovery, Transmit Port Select Signal,
0022  *                      and Remove Device operations to SAS IO Unit Control.
0023  *                      Added DevHandle field to SAS IO Unit Control request and
0024  *                      reply.
0025  *  10-11-06  01.05.04  Fixed the name of a define for Operation field of SAS IO
0026  *                      Unit Control request.
0027  *  01-15-08  01.05.05  Added support for MPI_SAS_OP_SET_IOC_PARAMETER,
0028  *                      including adding IOCParameter and IOCParameter value
0029  *                      fields to SAS IO Unit Control Request.
0030  *                      Added MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC define.
0031  *  --------------------------------------------------------------------------
0032  */
0033
0034 #ifndef MPI_SAS_H
0035 #define MPI_SAS_H
0036
0037
0038 /*
0039  * Values for SASStatus.
0040  */
0041 #define MPI_SASSTATUS_SUCCESS                           (0x00)
0042 #define MPI_SASSTATUS_UNKNOWN_ERROR                     (0x01)
0043 #define MPI_SASSTATUS_INVALID_FRAME                     (0x02)
0044 #define MPI_SASSTATUS_UTC_BAD_DEST                      (0x03)
0045 #define MPI_SASSTATUS_UTC_BREAK_RECEIVED                (0x04)
0046 #define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED    (0x05)
0047 #define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST            (0x06)
0048 #define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED        (0x07)
0049 #define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY            (0x08)
0050 #define MPI_SASSTATUS_UTC_WRONG_DESTINATION             (0x09)
0051 #define MPI_SASSTATUS_SHORT_INFORMATION_UNIT            (0x0A)
0052 #define MPI_SASSTATUS_LONG_INFORMATION_UNIT             (0x0B)
0053 #define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA     (0x0C)
0054 #define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR     (0x0D)
0055 #define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED             (0x0E)
0056 #define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH        (0x0F)
0057 #define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA           (0x10)
0058 #define MPI_SASSTATUS_DATA_OFFSET_ERROR                 (0x11)
0059 #define MPI_SASSTATUS_SDSF_NAK_RECEIVED                 (0x12)
0060 #define MPI_SASSTATUS_SDSF_CONNECTION_FAILED            (0x13)
0061 #define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT        (0x14)
0062
0063
0064 /*
0065  * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
0066  * data and SAS IO Unit Configuration pages.
0067  */
0068 #define MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC    (0xF0000000)
0069
0070 #define MPI_SAS_DEVICE_INFO_SEP                 (0x00004000)
0071 #define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE        (0x00002000)
0072 #define MPI_SAS_DEVICE_INFO_LSI_DEVICE          (0x00001000)
0073 #define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH       (0x00000800)
0074 #define MPI_SAS_DEVICE_INFO_SSP_TARGET          (0x00000400)
0075 #define MPI_SAS_DEVICE_INFO_STP_TARGET          (0x00000200)
0076 #define MPI_SAS_DEVICE_INFO_SMP_TARGET          (0x00000100)
0077 #define MPI_SAS_DEVICE_INFO_SATA_DEVICE         (0x00000080)
0078 #define MPI_SAS_DEVICE_INFO_SSP_INITIATOR       (0x00000040)
0079 #define MPI_SAS_DEVICE_INFO_STP_INITIATOR       (0x00000020)
0080 #define MPI_SAS_DEVICE_INFO_SMP_INITIATOR       (0x00000010)
0081 #define MPI_SAS_DEVICE_INFO_SATA_HOST           (0x00000008)
0082
0083 #define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE    (0x00000007)
0084 #define MPI_SAS_DEVICE_INFO_NO_DEVICE           (0x00000000)
0085 #define MPI_SAS_DEVICE_INFO_END_DEVICE          (0x00000001)
0086 #define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER       (0x00000002)
0087 #define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER     (0x00000003)
0088
0089
0090
0091 /*****************************************************************************
0092 *
0093 *        S e r i a l    A t t a c h e d    S C S I     M e s s a g e s
0094 *
0095 *****************************************************************************/
0096
0097 /****************************************************************************/
0098 /* Serial Management Protocol Passthrough Request                           */
0099 /****************************************************************************/
0100
0101 typedef struct _MSG_SMP_PASSTHROUGH_REQUEST
0102 {
0103     U8                      PassthroughFlags;   /* 00h */
0104     U8                      PhysicalPort;       /* 01h */
0105     U8                      ChainOffset;        /* 02h */
0106     U8                      Function;           /* 03h */
0107     U16                     RequestDataLength;  /* 04h */
0108     U8                      ConnectionRate;     /* 06h */
0109     U8                      MsgFlags;           /* 07h */
0110     U32                     MsgContext;         /* 08h */
0111     U32                     Reserved1;          /* 0Ch */
0112     U64                     SASAddress;         /* 10h */
0113     U32                     Reserved2;          /* 18h */
0114     U32                     Reserved3;          /* 1Ch */
0115     SGE_SIMPLE_UNION        SGL;                /* 20h */
0116 } MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST,
0117   SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t;
0118
0119 /* values for PassthroughFlags field */
0120 #define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE       (0x80)
0121
0122 /* values for ConnectionRate field */
0123 #define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED  (0x00)
0124 #define MPI_SMP_PT_REQ_CONNECT_RATE_1_5         (0x08)
0125 #define MPI_SMP_PT_REQ_CONNECT_RATE_3_0         (0x09)
0126
0127
0128 /* Serial Management Protocol Passthrough Reply */
0129 typedef struct _MSG_SMP_PASSTHROUGH_REPLY
0130 {
0131     U8                      PassthroughFlags;   /* 00h */
0132     U8                      PhysicalPort;       /* 01h */
0133     U8                      MsgLength;          /* 02h */
0134     U8                      Function;           /* 03h */
0135     U16                     ResponseDataLength; /* 04h */
0136     U8                      Reserved1;          /* 06h */
0137     U8                      MsgFlags;           /* 07h */
0138     U32                     MsgContext;         /* 08h */
0139     U8                      Reserved2;          /* 0Ch */
0140     U8                      SASStatus;          /* 0Dh */
0141     U16                     IOCStatus;          /* 0Eh */
0142     U32                     IOCLogInfo;         /* 10h */
0143     U32                     Reserved3;          /* 14h */
0144     U8                      ResponseData[4];    /* 18h */
0145 } MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY,
0146   SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t;
0147
0148 #define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE     (0x80)
0149
0150
0151 /****************************************************************************/
0152 /* SATA Passthrough Request                                                 */
0153 /****************************************************************************/
0154
0155 typedef struct _MSG_SATA_PASSTHROUGH_REQUEST
0156 {
0157     U8                      TargetID;           /* 00h */
0158     U8                      Bus;                /* 01h */
0159     U8                      ChainOffset;        /* 02h */
0160     U8                      Function;           /* 03h */
0161     U16                     PassthroughFlags;   /* 04h */
0162     U8                      ConnectionRate;     /* 06h */
0163     U8                      MsgFlags;           /* 07h */
0164     U32                     MsgContext;         /* 08h */
0165     U32                     Reserved1;          /* 0Ch */
0166     U32                     Reserved2;          /* 10h */
0167     U32                     Reserved3;          /* 14h */
0168     U32                     DataLength;         /* 18h */
0169     U8                      CommandFIS[20];     /* 1Ch */
0170     SGE_SIMPLE_UNION        SGL;                /* 30h */
0171 } MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST,
0172   SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t;
0173
0174 /* values for PassthroughFlags field */
0175 #define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE   (0x0200)
0176 #define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG   (0x0100)
0177 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED     (0x0080)
0178 #define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040)
0179 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA            (0x0020)
0180 #define MPI_SATA_PT_REQ_PT_FLAGS_PIO            (0x0010)
0181 #define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004)
0182 #define MPI_SATA_PT_REQ_PT_FLAGS_WRITE          (0x0002)
0183 #define MPI_SATA_PT_REQ_PT_FLAGS_READ           (0x0001)
0184
0185 /* values for ConnectionRate field */
0186 #define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00)
0187 #define MPI_SATA_PT_REQ_CONNECT_RATE_1_5        (0x08)
0188 #define MPI_SATA_PT_REQ_CONNECT_RATE_3_0        (0x09)
0189
0190
0191 /* SATA Passthrough Reply */
0192 typedef struct _MSG_SATA_PASSTHROUGH_REPLY
0193 {
0194     U8                      TargetID;           /* 00h */
0195     U8                      Bus;                /* 01h */
0196     U8                      MsgLength;          /* 02h */
0197     U8                      Function;           /* 03h */
0198     U16                     PassthroughFlags;   /* 04h */
0199     U8                      Reserved1;          /* 06h */
0200     U8                      MsgFlags;           /* 07h */
0201     U32                     MsgContext;         /* 08h */
0202     U8                      Reserved2;          /* 0Ch */
0203     U8                      SASStatus;          /* 0Dh */
0204     U16                     IOCStatus;          /* 0Eh */
0205     U32                     IOCLogInfo;         /* 10h */
0206     U8                      StatusFIS[20];      /* 14h */
0207     U32                     StatusControlRegisters; /* 28h */
0208     U32                     TransferCount;      /* 2Ch */
0209 } MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY,
0210   SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t;
0211
0212
0213
0214
0215 /****************************************************************************/
0216 /* SAS IO Unit Control Request                                              */
0217 /****************************************************************************/
0218
0219 typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST
0220 {
0221     U8                      Operation;          /* 00h */
0222     U8                      Reserved1;          /* 01h */
0223     U8                      ChainOffset;        /* 02h */
0224     U8                      Function;           /* 03h */
0225     U16                     DevHandle;          /* 04h */
0226     U8                      IOCParameter;       /* 06h */
0227     U8                      MsgFlags;           /* 07h */
0228     U32                     MsgContext;         /* 08h */
0229     U8                      TargetID;           /* 0Ch */
0230     U8                      Bus;                /* 0Dh */
0231     U8                      PhyNum;             /* 0Eh */
0232     U8                      PrimFlags;          /* 0Fh */
0233     U32                     Primitive;          /* 10h */
0234     U64                     SASAddress;         /* 14h */
0235     U32                     IOCParameterValue;  /* 1Ch */
0236 } MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST,
0237   SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t;
0238
0239 /* values for the Operation field */
0240 #define MPI_SAS_OP_CLEAR_NOT_PRESENT            (0x01)
0241 #define MPI_SAS_OP_CLEAR_ALL_PERSISTENT         (0x02)
0242 #define MPI_SAS_OP_PHY_LINK_RESET               (0x06)
0243 #define MPI_SAS_OP_PHY_HARD_RESET               (0x07)
0244 #define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG          (0x08)
0245 #define MPI_SAS_OP_MAP_CURRENT                  (0x09)
0246 #define MPI_SAS_OP_SEND_PRIMITIVE               (0x0A)
0247 #define MPI_SAS_OP_FORCE_FULL_DISCOVERY         (0x0B)
0248 #define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL  (0x0C)
0249 #define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE       (0x0D)  /* obsolete name */
0250 #define MPI_SAS_OP_REMOVE_DEVICE                (0x0D)
0251 #define MPI_SAS_OP_SET_IOC_PARAMETER            (0x0E)
0252 #define MPI_SAS_OP_PRODUCT_SPECIFIC_MIN         (0x80)
0253
0254 /* values for the PrimFlags field */
0255 #define MPI_SAS_PRIMFLAGS_SINGLE                (0x08)
0256 #define MPI_SAS_PRIMFLAGS_TRIPLE                (0x02)
0257 #define MPI_SAS_PRIMFLAGS_REDUNDANT             (0x01)
0258
0259
0260 /* SAS IO Unit Control Reply */
0261 typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY
0262 {
0263     U8                      Operation;          /* 00h */
0264     U8                      Reserved1;          /* 01h */
0265     U8                      MsgLength;          /* 02h */
0266     U8                      Function;           /* 03h */
0267     U16                     DevHandle;          /* 04h */
0268     U8                      IOCParameter;       /* 06h */
0269     U8                      MsgFlags;           /* 07h */
0270     U32                     MsgContext;         /* 08h */
0271     U16                     Reserved4;          /* 0Ch */
0272     U16                     IOCStatus;          /* 0Eh */
0273     U32                     IOCLogInfo;         /* 10h */
0274 } MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY,
0275   SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t;
0276
0277 #endif
0278
0279