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