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