1/*- 2 * Copyright 2000-2020 Broadcom Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the author nor the names of any co-contributors 13 * may be used to endorse or promote products derived from this software 14 * without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * Broadcom Inc. (LSI) MPT-Fusion Host Adapter FreeBSD 29 * 30 * $FreeBSD$ 31 */ 32 33/* 34 * Copyright 2000-2020 Broadcom Inc. 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 * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 103 * data and SAS Configuration pages. 104 */ 105#define MPI2_SAS_DEVICE_INFO_SEP (0x00004000) 106#define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 107#define MPI2_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 108#define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 109#define MPI2_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 110#define MPI2_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 111#define MPI2_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 112#define MPI2_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 113#define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 114#define MPI2_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 115#define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 116#define MPI2_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 117 118#define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 119#define MPI2_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 120#define MPI2_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 121#define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 122#define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 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/* SMP Passthrough Reply Message */ 161typedef struct _MPI2_SMP_PASSTHROUGH_REPLY 162{ 163 U8 PassthroughFlags; /* 0x00 */ 164 U8 PhysicalPort; /* 0x01 */ 165 U8 MsgLength; /* 0x02 */ 166 U8 Function; /* 0x03 */ 167 U16 ResponseDataLength; /* 0x04 */ 168 U8 SGLFlags; /* 0x06 */ 169 U8 MsgFlags; /* 0x07 */ 170 U8 VP_ID; /* 0x08 */ 171 U8 VF_ID; /* 0x09 */ 172 U16 Reserved1; /* 0x0A */ 173 U8 Reserved2; /* 0x0C */ 174 U8 SASStatus; /* 0x0D */ 175 U16 IOCStatus; /* 0x0E */ 176 U32 IOCLogInfo; /* 0x10 */ 177 U32 Reserved3; /* 0x14 */ 178 U8 ResponseData[4]; /* 0x18 */ 179} MPI2_SMP_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REPLY, 180 Mpi2SmpPassthroughReply_t, MPI2_POINTER pMpi2SmpPassthroughReply_t; 181 182/* values for PassthroughFlags field */ 183#define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 184 185/* values for SASStatus field are at the top of this file */ 186 187/**************************************************************************** 188* SATA Passthrough messages 189****************************************************************************/ 190 191typedef union _MPI2_SATA_PT_SGE_UNION 192{ 193 MPI2_SGE_SIMPLE_UNION MpiSimple; /* MPI v2.0 only */ 194 MPI2_SGE_CHAIN_UNION MpiChain; /* MPI v2.0 only */ 195 MPI2_IEEE_SGE_SIMPLE_UNION IeeeSimple; 196 MPI2_IEEE_SGE_CHAIN_UNION IeeeChain; /* MPI v2.0 only */ 197 MPI25_IEEE_SGE_CHAIN64 IeeeChain64; /* MPI v2.5 only */ 198} MPI2_SATA_PT_SGE_UNION, MPI2_POINTER PTR_MPI2_SATA_PT_SGE_UNION, 199 Mpi2SataPTSGEUnion_t, MPI2_POINTER pMpi2SataPTSGEUnion_t; 200 201/* SATA Passthrough Request Message */ 202typedef struct _MPI2_SATA_PASSTHROUGH_REQUEST 203{ 204 U16 DevHandle; /* 0x00 */ 205 U8 ChainOffset; /* 0x02 */ 206 U8 Function; /* 0x03 */ 207 U16 PassthroughFlags; /* 0x04 */ 208 U8 SGLFlags; /* 0x06 */ /* MPI v2.0 only. Reserved on MPI v2.5. */ 209 U8 MsgFlags; /* 0x07 */ 210 U8 VP_ID; /* 0x08 */ 211 U8 VF_ID; /* 0x09 */ 212 U16 Reserved1; /* 0x0A */ 213 U32 Reserved2; /* 0x0C */ 214 U32 Reserved3; /* 0x10 */ 215 U32 Reserved4; /* 0x14 */ 216 U32 DataLength; /* 0x18 */ 217 U8 CommandFIS[20]; /* 0x1C */ 218 MPI2_SATA_PT_SGE_UNION SGL; /* 0x30 */ /* MPI v2.5: IEEE 64 elements only */ 219} MPI2_SATA_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REQUEST, 220 Mpi2SataPassthroughRequest_t, MPI2_POINTER pMpi2SataPassthroughRequest_t; 221 222/* values for PassthroughFlags field */ 223#define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 224#define MPI2_SATA_PT_REQ_PT_FLAGS_FPDMA (0x0040) /* MPI v2.6 and newer */ 225#define MPI2_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 226#define MPI2_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 227#define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 228#define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 229#define MPI2_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 230 231/* MPI v2.0: use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */ 232 233/* SATA Passthrough Reply Message */ 234typedef struct _MPI2_SATA_PASSTHROUGH_REPLY 235{ 236 U16 DevHandle; /* 0x00 */ 237 U8 MsgLength; /* 0x02 */ 238 U8 Function; /* 0x03 */ 239 U16 PassthroughFlags; /* 0x04 */ 240 U8 SGLFlags; /* 0x06 */ 241 U8 MsgFlags; /* 0x07 */ 242 U8 VP_ID; /* 0x08 */ 243 U8 VF_ID; /* 0x09 */ 244 U16 Reserved1; /* 0x0A */ 245 U8 Reserved2; /* 0x0C */ 246 U8 SASStatus; /* 0x0D */ 247 U16 IOCStatus; /* 0x0E */ 248 U32 IOCLogInfo; /* 0x10 */ 249 U8 StatusFIS[20]; /* 0x14 */ 250 U32 StatusControlRegisters; /* 0x28 */ 251 U32 TransferCount; /* 0x2C */ 252} MPI2_SATA_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REPLY, 253 Mpi2SataPassthroughReply_t, MPI2_POINTER pMpi2SataPassthroughReply_t; 254 255/* values for SASStatus field are at the top of this file */ 256 257/**************************************************************************** 258* SAS IO Unit Control messages 259* (MPI v2.5 and earlier only. 260* Replaced by IO Unit Control messages in MPI v2.6 and later.) 261****************************************************************************/ 262 263/* SAS IO Unit Control Request Message */ 264typedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST 265{ 266 U8 Operation; /* 0x00 */ 267 U8 Reserved1; /* 0x01 */ 268 U8 ChainOffset; /* 0x02 */ 269 U8 Function; /* 0x03 */ 270 U16 DevHandle; /* 0x04 */ 271 U8 IOCParameter; /* 0x06 */ 272 U8 MsgFlags; /* 0x07 */ 273 U8 VP_ID; /* 0x08 */ 274 U8 VF_ID; /* 0x09 */ 275 U16 Reserved3; /* 0x0A */ 276 U16 Reserved4; /* 0x0C */ 277 U8 PhyNum; /* 0x0E */ 278 U8 PrimFlags; /* 0x0F */ 279 U32 Primitive; /* 0x10 */ 280 U8 LookupMethod; /* 0x14 */ 281 U8 Reserved5; /* 0x15 */ 282 U16 SlotNumber; /* 0x16 */ 283 U64 LookupAddress; /* 0x18 */ 284 U32 IOCParameterValue; /* 0x20 */ 285 U32 Reserved7; /* 0x24 */ 286 U32 Reserved8; /* 0x28 */ 287} MPI2_SAS_IOUNIT_CONTROL_REQUEST, 288 MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST, 289 Mpi2SasIoUnitControlRequest_t, MPI2_POINTER pMpi2SasIoUnitControlRequest_t; 290 291/* values for the Operation field */ 292#define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 293#define MPI2_SAS_OP_PHY_LINK_RESET (0x06) 294#define MPI2_SAS_OP_PHY_HARD_RESET (0x07) 295#define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 296#define MPI2_SAS_OP_SEND_PRIMITIVE (0x0A) 297#define MPI2_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 298#define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) /* MPI v2.0 only */ 299#define MPI2_SAS_OP_REMOVE_DEVICE (0x0D) 300#define MPI2_SAS_OP_LOOKUP_MAPPING (0x0E) 301#define MPI2_SAS_OP_SET_IOC_PARAMETER (0x0F) 302#define MPI25_SAS_OP_ENABLE_FP_DEVICE (0x10) 303#define MPI25_SAS_OP_DISABLE_FP_DEVICE (0x11) 304#define MPI25_SAS_OP_ENABLE_FP_ALL (0x12) 305#define MPI25_SAS_OP_DISABLE_FP_ALL (0x13) 306#define MPI2_SAS_OP_DEV_ENABLE_NCQ (0x14) 307#define MPI2_SAS_OP_DEV_DISABLE_NCQ (0x15) 308#define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 309 310/* values for the PrimFlags field */ 311#define MPI2_SAS_PRIMFLAGS_SINGLE (0x08) 312#define MPI2_SAS_PRIMFLAGS_TRIPLE (0x02) 313#define MPI2_SAS_PRIMFLAGS_REDUNDANT (0x01) 314 315/* values for the LookupMethod field */ 316#define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS (0x01) 317#define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT (0x02) 318#define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME (0x03) 319 320/* SAS IO Unit Control Reply Message */ 321typedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY 322{ 323 U8 Operation; /* 0x00 */ 324 U8 Reserved1; /* 0x01 */ 325 U8 MsgLength; /* 0x02 */ 326 U8 Function; /* 0x03 */ 327 U16 DevHandle; /* 0x04 */ 328 U8 IOCParameter; /* 0x06 */ 329 U8 MsgFlags; /* 0x07 */ 330 U8 VP_ID; /* 0x08 */ 331 U8 VF_ID; /* 0x09 */ 332 U16 Reserved3; /* 0x0A */ 333 U16 Reserved4; /* 0x0C */ 334 U16 IOCStatus; /* 0x0E */ 335 U32 IOCLogInfo; /* 0x10 */ 336} MPI2_SAS_IOUNIT_CONTROL_REPLY, 337 MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY, 338 Mpi2SasIoUnitControlReply_t, MPI2_POINTER pMpi2SasIoUnitControlReply_t; 339 340#endif 341