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