1 /* 2 * Copyright 2000-2015 Avago Technologies. All rights reserved. 3 * 4 * 5 * Name: mpi2_sas.h 6 * Title: MPI Serial Attached SCSI structures and definitions 7 * Creation Date: February 9, 2007 8 * 9 * mpi2_sas.h Version: 02.00.10 10 * 11 * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25 12 * prefix are for use only on MPI v2.5 products, and must not be used 13 * with MPI v2.0 products. Unless otherwise noted, names beginning with 14 * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products. 15 * 16 * Version History 17 * --------------- 18 * 19 * Date Version Description 20 * -------- -------- ------------------------------------------------------ 21 * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A. 22 * 06-26-07 02.00.01 Added Clear All Persistent Operation to SAS IO Unit 23 * Control Request. 24 * 10-02-08 02.00.02 Added Set IOC Parameter Operation to SAS IO Unit Control 25 * Request. 26 * 10-28-09 02.00.03 Changed the type of SGL in MPI2_SATA_PASSTHROUGH_REQUEST 27 * to MPI2_SGE_IO_UNION since it supports chained SGLs. 28 * 05-12-10 02.00.04 Modified some comments. 29 * 08-11-10 02.00.05 Added NCQ operations to SAS IO Unit Control. 30 * 11-18-11 02.00.06 Incorporating additions for MPI v2.5. 31 * 07-10-12 02.00.07 Added MPI2_SATA_PT_SGE_UNION for use in the SATA 32 * Passthrough Request message. 33 * 08-19-13 02.00.08 Made MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL obsolete 34 * for anything newer than MPI v2.0. 35 * 11-18-14 02.00.09 Updated copyright information. 36 * 03-16-15 02.00.10 Updated for MPI v2.6. 37 * Added MPI2_SATA_PT_REQ_PT_FLAGS_FPDMA. 38 * -------------------------------------------------------------------------- 39 */ 40 41 #ifndef MPI2_SAS_H 42 #define MPI2_SAS_H 43 44 /* 45 *Values for SASStatus. 46 */ 47 #define MPI2_SASSTATUS_SUCCESS (0x00) 48 #define MPI2_SASSTATUS_UNKNOWN_ERROR (0x01) 49 #define MPI2_SASSTATUS_INVALID_FRAME (0x02) 50 #define MPI2_SASSTATUS_UTC_BAD_DEST (0x03) 51 #define MPI2_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 52 #define MPI2_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 53 #define MPI2_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 54 #define MPI2_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 55 #define MPI2_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 56 #define MPI2_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 57 #define MPI2_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 58 #define MPI2_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 59 #define MPI2_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 60 #define MPI2_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 61 #define MPI2_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 62 #define MPI2_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 63 #define MPI2_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 64 #define MPI2_SASSTATUS_DATA_OFFSET_ERROR (0x11) 65 #define MPI2_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 66 #define MPI2_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 67 #define MPI2_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 68 69 /* 70 *Values for the SAS DeviceInfo field used in SAS Device Status Change Event 71 *data and SAS Configuration pages. 72 */ 73 #define MPI2_SAS_DEVICE_INFO_SEP (0x00004000) 74 #define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 75 #define MPI2_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 76 #define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 77 #define MPI2_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 78 #define MPI2_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 79 #define MPI2_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 80 #define MPI2_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 81 #define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 82 #define MPI2_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 83 #define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 84 #define MPI2_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 85 86 #define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 87 #define MPI2_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 88 #define MPI2_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 89 #define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 90 #define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 91 92 /***************************************************************************** 93 * 94 * SAS Messages 95 * 96 *****************************************************************************/ 97 98 /**************************************************************************** 99 * SMP Passthrough messages 100 ****************************************************************************/ 101 102 /*SMP Passthrough Request Message */ 103 typedef struct _MPI2_SMP_PASSTHROUGH_REQUEST { 104 U8 PassthroughFlags; /*0x00 */ 105 U8 PhysicalPort; /*0x01 */ 106 U8 ChainOffset; /*0x02 */ 107 U8 Function; /*0x03 */ 108 U16 RequestDataLength; /*0x04 */ 109 U8 SGLFlags; /*0x06*//*MPI v2.0 only. Reserved on MPI v2.5*/ 110 U8 MsgFlags; /*0x07 */ 111 U8 VP_ID; /*0x08 */ 112 U8 VF_ID; /*0x09 */ 113 U16 Reserved1; /*0x0A */ 114 U32 Reserved2; /*0x0C */ 115 U64 SASAddress; /*0x10 */ 116 U32 Reserved3; /*0x18 */ 117 U32 Reserved4; /*0x1C */ 118 MPI2_SIMPLE_SGE_UNION SGL;/*0x20 */ 119 } MPI2_SMP_PASSTHROUGH_REQUEST, *PTR_MPI2_SMP_PASSTHROUGH_REQUEST, 120 Mpi2SmpPassthroughRequest_t, *pMpi2SmpPassthroughRequest_t; 121 122 /*values for PassthroughFlags field */ 123 #define MPI2_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 124 125 /*MPI v2.0: use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */ 126 127 /*SMP Passthrough Reply Message */ 128 typedef struct _MPI2_SMP_PASSTHROUGH_REPLY { 129 U8 PassthroughFlags; /*0x00 */ 130 U8 PhysicalPort; /*0x01 */ 131 U8 MsgLength; /*0x02 */ 132 U8 Function; /*0x03 */ 133 U16 ResponseDataLength; /*0x04 */ 134 U8 SGLFlags; /*0x06 */ 135 U8 MsgFlags; /*0x07 */ 136 U8 VP_ID; /*0x08 */ 137 U8 VF_ID; /*0x09 */ 138 U16 Reserved1; /*0x0A */ 139 U8 Reserved2; /*0x0C */ 140 U8 SASStatus; /*0x0D */ 141 U16 IOCStatus; /*0x0E */ 142 U32 IOCLogInfo; /*0x10 */ 143 U32 Reserved3; /*0x14 */ 144 U8 ResponseData[4]; /*0x18 */ 145 } MPI2_SMP_PASSTHROUGH_REPLY, *PTR_MPI2_SMP_PASSTHROUGH_REPLY, 146 Mpi2SmpPassthroughReply_t, *pMpi2SmpPassthroughReply_t; 147 148 /*values for PassthroughFlags field */ 149 #define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 150 151 /*values for SASStatus field are at the top of this file */ 152 153 /**************************************************************************** 154 * SATA Passthrough messages 155 ****************************************************************************/ 156 157 typedef union _MPI2_SATA_PT_SGE_UNION { 158 MPI2_SGE_SIMPLE_UNION MpiSimple; /*MPI v2.0 only */ 159 MPI2_SGE_CHAIN_UNION MpiChain; /*MPI v2.0 only */ 160 MPI2_IEEE_SGE_SIMPLE_UNION IeeeSimple; 161 MPI2_IEEE_SGE_CHAIN_UNION IeeeChain; /*MPI v2.0 only */ 162 MPI25_IEEE_SGE_CHAIN64 IeeeChain64; /*MPI v2.5 only */ 163 } MPI2_SATA_PT_SGE_UNION, *PTR_MPI2_SATA_PT_SGE_UNION, 164 Mpi2SataPTSGEUnion_t, *pMpi2SataPTSGEUnion_t; 165 166 /*SATA Passthrough Request Message */ 167 typedef struct _MPI2_SATA_PASSTHROUGH_REQUEST { 168 U16 DevHandle; /*0x00 */ 169 U8 ChainOffset; /*0x02 */ 170 U8 Function; /*0x03 */ 171 U16 PassthroughFlags; /*0x04 */ 172 U8 SGLFlags; /*0x06*//*MPI v2.0 only. Reserved on MPI v2.5*/ 173 U8 MsgFlags; /*0x07 */ 174 U8 VP_ID; /*0x08 */ 175 U8 VF_ID; /*0x09 */ 176 U16 Reserved1; /*0x0A */ 177 U32 Reserved2; /*0x0C */ 178 U32 Reserved3; /*0x10 */ 179 U32 Reserved4; /*0x14 */ 180 U32 DataLength; /*0x18 */ 181 U8 CommandFIS[20]; /*0x1C */ 182 MPI2_SATA_PT_SGE_UNION SGL;/*0x30*//*MPI v2.5: IEEE 64 elements only*/ 183 } MPI2_SATA_PASSTHROUGH_REQUEST, *PTR_MPI2_SATA_PASSTHROUGH_REQUEST, 184 Mpi2SataPassthroughRequest_t, 185 *pMpi2SataPassthroughRequest_t; 186 187 /*values for PassthroughFlags field */ 188 #define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 189 #define MPI2_SATA_PT_REQ_PT_FLAGS_FPDMA (0x0040) 190 #define MPI2_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 191 #define MPI2_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 192 #define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 193 #define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 194 #define MPI2_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 195 196 /*MPI v2.0: use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */ 197 198 /*SATA Passthrough Reply Message */ 199 typedef struct _MPI2_SATA_PASSTHROUGH_REPLY { 200 U16 DevHandle; /*0x00 */ 201 U8 MsgLength; /*0x02 */ 202 U8 Function; /*0x03 */ 203 U16 PassthroughFlags; /*0x04 */ 204 U8 SGLFlags; /*0x06 */ 205 U8 MsgFlags; /*0x07 */ 206 U8 VP_ID; /*0x08 */ 207 U8 VF_ID; /*0x09 */ 208 U16 Reserved1; /*0x0A */ 209 U8 Reserved2; /*0x0C */ 210 U8 SASStatus; /*0x0D */ 211 U16 IOCStatus; /*0x0E */ 212 U32 IOCLogInfo; /*0x10 */ 213 U8 StatusFIS[20]; /*0x14 */ 214 U32 StatusControlRegisters; /*0x28 */ 215 U32 TransferCount; /*0x2C */ 216 } MPI2_SATA_PASSTHROUGH_REPLY, *PTR_MPI2_SATA_PASSTHROUGH_REPLY, 217 Mpi2SataPassthroughReply_t, *pMpi2SataPassthroughReply_t; 218 219 /*values for SASStatus field are at the top of this file */ 220 221 /**************************************************************************** 222 * SAS IO Unit Control messages 223 * (MPI v2.5 and earlier only. 224 * Replaced by IO Unit Control messages in MPI v2.6 and later.) 225 ****************************************************************************/ 226 227 /*SAS IO Unit Control Request Message */ 228 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST { 229 U8 Operation; /*0x00 */ 230 U8 Reserved1; /*0x01 */ 231 U8 ChainOffset; /*0x02 */ 232 U8 Function; /*0x03 */ 233 U16 DevHandle; /*0x04 */ 234 U8 IOCParameter; /*0x06 */ 235 U8 MsgFlags; /*0x07 */ 236 U8 VP_ID; /*0x08 */ 237 U8 VF_ID; /*0x09 */ 238 U16 Reserved3; /*0x0A */ 239 U16 Reserved4; /*0x0C */ 240 U8 PhyNum; /*0x0E */ 241 U8 PrimFlags; /*0x0F */ 242 U32 Primitive; /*0x10 */ 243 U8 LookupMethod; /*0x14 */ 244 U8 Reserved5; /*0x15 */ 245 U16 SlotNumber; /*0x16 */ 246 U64 LookupAddress; /*0x18 */ 247 U32 IOCParameterValue; /*0x20 */ 248 U32 Reserved7; /*0x24 */ 249 U32 Reserved8; /*0x28 */ 250 } MPI2_SAS_IOUNIT_CONTROL_REQUEST, 251 *PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST, 252 Mpi2SasIoUnitControlRequest_t, 253 *pMpi2SasIoUnitControlRequest_t; 254 255 /*values for the Operation field */ 256 #define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 257 #define MPI2_SAS_OP_PHY_LINK_RESET (0x06) 258 #define MPI2_SAS_OP_PHY_HARD_RESET (0x07) 259 #define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 260 #define MPI2_SAS_OP_SEND_PRIMITIVE (0x0A) 261 #define MPI2_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 262 #define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) /* MPI v2.0 only */ 263 #define MPI2_SAS_OP_REMOVE_DEVICE (0x0D) 264 #define MPI2_SAS_OP_LOOKUP_MAPPING (0x0E) 265 #define MPI2_SAS_OP_SET_IOC_PARAMETER (0x0F) 266 #define MPI25_SAS_OP_ENABLE_FP_DEVICE (0x10) 267 #define MPI25_SAS_OP_DISABLE_FP_DEVICE (0x11) 268 #define MPI25_SAS_OP_ENABLE_FP_ALL (0x12) 269 #define MPI25_SAS_OP_DISABLE_FP_ALL (0x13) 270 #define MPI2_SAS_OP_DEV_ENABLE_NCQ (0x14) 271 #define MPI2_SAS_OP_DEV_DISABLE_NCQ (0x15) 272 #define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 273 274 /*values for the PrimFlags field */ 275 #define MPI2_SAS_PRIMFLAGS_SINGLE (0x08) 276 #define MPI2_SAS_PRIMFLAGS_TRIPLE (0x02) 277 #define MPI2_SAS_PRIMFLAGS_REDUNDANT (0x01) 278 279 /*values for the LookupMethod field */ 280 #define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS (0x01) 281 #define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT (0x02) 282 #define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME (0x03) 283 284 /*SAS IO Unit Control Reply Message */ 285 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY { 286 U8 Operation; /*0x00 */ 287 U8 Reserved1; /*0x01 */ 288 U8 MsgLength; /*0x02 */ 289 U8 Function; /*0x03 */ 290 U16 DevHandle; /*0x04 */ 291 U8 IOCParameter; /*0x06 */ 292 U8 MsgFlags; /*0x07 */ 293 U8 VP_ID; /*0x08 */ 294 U8 VF_ID; /*0x09 */ 295 U16 Reserved3; /*0x0A */ 296 U16 Reserved4; /*0x0C */ 297 U16 IOCStatus; /*0x0E */ 298 U32 IOCLogInfo; /*0x10 */ 299 } MPI2_SAS_IOUNIT_CONTROL_REPLY, 300 *PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY, 301 Mpi2SasIoUnitControlReply_t, *pMpi2SasIoUnitControlReply_t; 302 303 #endif 304