1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-3-Clause 4 * 5 * Copyright (c) 2000-2010, LSI Logic Corporation and its contributors. 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 are 10 * 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 at minimum a disclaimer 14 * substantially similar to the "NO WARRANTY" disclaimer below 15 * ("Disclaimer") and any redistribution must be conditioned upon including 16 * a substantially similar Disclaimer requirement for further binary 17 * redistribution. 18 * 3. Neither the name of the LSI Logic Corporation nor the names of its 19 * contributors may be used to endorse or promote products derived from 20 * this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT 32 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 * Name: mpi_sas.h 35 * Title: MPI Serial Attached SCSI structures and definitions 36 * Creation Date: August 19, 2004 37 * 38 * mpi_sas.h Version: 01.05.05 39 * 40 * Version History 41 * --------------- 42 * 43 * Date Version Description 44 * -------- -------- ------------------------------------------------------ 45 * 08-19-04 01.05.01 Original release. 46 * 08-30-05 01.05.02 Added DeviceInfo bit for SEP. 47 * Added PrimFlags and Primitive field to SAS IO Unit 48 * Control request, and added a new operation code. 49 * 03-27-06 01.05.03 Added Force Full Discovery, Transmit Port Select Signal, 50 * and Remove Device operations to SAS IO Unit Control. 51 * Added DevHandle field to SAS IO Unit Control request and 52 * reply. 53 * 10-11-06 01.05.04 Fixed the name of a define for Operation field of SAS IO 54 * Unit Control request. 55 * 01-15-08 01.05.05 Added support for MPI_SAS_OP_SET_IOC_PARAMETER, 56 * including adding IOCParameter and IOCParameter value 57 * fields to SAS IO Unit Control Request. 58 * Added MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC define. 59 * -------------------------------------------------------------------------- 60 */ 61 62 #ifndef MPI_SAS_H 63 #define MPI_SAS_H 64 65 /* 66 * Values for SASStatus. 67 */ 68 #define MPI_SASSTATUS_SUCCESS (0x00) 69 #define MPI_SASSTATUS_UNKNOWN_ERROR (0x01) 70 #define MPI_SASSTATUS_INVALID_FRAME (0x02) 71 #define MPI_SASSTATUS_UTC_BAD_DEST (0x03) 72 #define MPI_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 73 #define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 74 #define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 75 #define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 76 #define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 77 #define MPI_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 78 #define MPI_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 79 #define MPI_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 80 #define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 81 #define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 82 #define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 83 #define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 84 #define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 85 #define MPI_SASSTATUS_DATA_OFFSET_ERROR (0x11) 86 #define MPI_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 87 #define MPI_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 88 #define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 89 90 /* 91 * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 92 * data and SAS IO Unit Configuration pages. 93 */ 94 #define MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC (0xF0000000) 95 96 #define MPI_SAS_DEVICE_INFO_SEP (0x00004000) 97 #define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 98 #define MPI_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 99 #define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 100 #define MPI_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 101 #define MPI_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 102 #define MPI_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 103 #define MPI_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 104 #define MPI_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 105 #define MPI_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 106 #define MPI_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 107 #define MPI_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 108 109 #define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 110 #define MPI_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 111 #define MPI_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 112 #define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 113 #define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 114 115 /***************************************************************************** 116 * 117 * S e r i a l A t t a c h e d S C S I M e s s a g e s 118 * 119 *****************************************************************************/ 120 121 /****************************************************************************/ 122 /* Serial Management Protocol Passthrough Request */ 123 /****************************************************************************/ 124 125 typedef struct _MSG_SMP_PASSTHROUGH_REQUEST 126 { 127 U8 PassthroughFlags; /* 00h */ 128 U8 PhysicalPort; /* 01h */ 129 U8 ChainOffset; /* 02h */ 130 U8 Function; /* 03h */ 131 U16 RequestDataLength; /* 04h */ 132 U8 ConnectionRate; /* 06h */ 133 U8 MsgFlags; /* 07h */ 134 U32 MsgContext; /* 08h */ 135 U32 Reserved1; /* 0Ch */ 136 U64 SASAddress; /* 10h */ 137 U32 Reserved2; /* 18h */ 138 U32 Reserved3; /* 1Ch */ 139 SGE_SIMPLE_UNION SGL; /* 20h */ 140 } MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST, 141 SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t; 142 143 /* values for PassthroughFlags field */ 144 #define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 145 146 /* values for ConnectionRate field */ 147 #define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 148 #define MPI_SMP_PT_REQ_CONNECT_RATE_1_5 (0x08) 149 #define MPI_SMP_PT_REQ_CONNECT_RATE_3_0 (0x09) 150 151 /* Serial Management Protocol Passthrough Reply */ 152 typedef struct _MSG_SMP_PASSTHROUGH_REPLY 153 { 154 U8 PassthroughFlags; /* 00h */ 155 U8 PhysicalPort; /* 01h */ 156 U8 MsgLength; /* 02h */ 157 U8 Function; /* 03h */ 158 U16 ResponseDataLength; /* 04h */ 159 U8 Reserved1; /* 06h */ 160 U8 MsgFlags; /* 07h */ 161 U32 MsgContext; /* 08h */ 162 U8 Reserved2; /* 0Ch */ 163 U8 SASStatus; /* 0Dh */ 164 U16 IOCStatus; /* 0Eh */ 165 U32 IOCLogInfo; /* 10h */ 166 U32 Reserved3; /* 14h */ 167 U8 ResponseData[4]; /* 18h */ 168 } MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY, 169 SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t; 170 171 #define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 172 173 /****************************************************************************/ 174 /* SATA Passthrough Request */ 175 /****************************************************************************/ 176 177 typedef struct _MSG_SATA_PASSTHROUGH_REQUEST 178 { 179 U8 TargetID; /* 00h */ 180 U8 Bus; /* 01h */ 181 U8 ChainOffset; /* 02h */ 182 U8 Function; /* 03h */ 183 U16 PassthroughFlags; /* 04h */ 184 U8 ConnectionRate; /* 06h */ 185 U8 MsgFlags; /* 07h */ 186 U32 MsgContext; /* 08h */ 187 U32 Reserved1; /* 0Ch */ 188 U32 Reserved2; /* 10h */ 189 U32 Reserved3; /* 14h */ 190 U32 DataLength; /* 18h */ 191 U8 CommandFIS[20]; /* 1Ch */ 192 SGE_SIMPLE_UNION SGL; /* 30h */ 193 } MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST, 194 SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t; 195 196 /* values for PassthroughFlags field */ 197 #define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE (0x0200) 198 #define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 199 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED (0x0080) 200 #define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040) 201 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 202 #define MPI_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 203 #define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 204 #define MPI_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 205 #define MPI_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 206 207 /* values for ConnectionRate field */ 208 #define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 209 #define MPI_SATA_PT_REQ_CONNECT_RATE_1_5 (0x08) 210 #define MPI_SATA_PT_REQ_CONNECT_RATE_3_0 (0x09) 211 212 /* SATA Passthrough Reply */ 213 typedef struct _MSG_SATA_PASSTHROUGH_REPLY 214 { 215 U8 TargetID; /* 00h */ 216 U8 Bus; /* 01h */ 217 U8 MsgLength; /* 02h */ 218 U8 Function; /* 03h */ 219 U16 PassthroughFlags; /* 04h */ 220 U8 Reserved1; /* 06h */ 221 U8 MsgFlags; /* 07h */ 222 U32 MsgContext; /* 08h */ 223 U8 Reserved2; /* 0Ch */ 224 U8 SASStatus; /* 0Dh */ 225 U16 IOCStatus; /* 0Eh */ 226 U32 IOCLogInfo; /* 10h */ 227 U8 StatusFIS[20]; /* 14h */ 228 U32 StatusControlRegisters; /* 28h */ 229 U32 TransferCount; /* 2Ch */ 230 } MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY, 231 SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t; 232 233 /****************************************************************************/ 234 /* SAS IO Unit Control Request */ 235 /****************************************************************************/ 236 237 typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST 238 { 239 U8 Operation; /* 00h */ 240 U8 Reserved1; /* 01h */ 241 U8 ChainOffset; /* 02h */ 242 U8 Function; /* 03h */ 243 U16 DevHandle; /* 04h */ 244 U8 IOCParameter; /* 06h */ 245 U8 MsgFlags; /* 07h */ 246 U32 MsgContext; /* 08h */ 247 U8 TargetID; /* 0Ch */ 248 U8 Bus; /* 0Dh */ 249 U8 PhyNum; /* 0Eh */ 250 U8 PrimFlags; /* 0Fh */ 251 U32 Primitive; /* 10h */ 252 U64 SASAddress; /* 14h */ 253 U32 IOCParameterValue; /* 1Ch */ 254 } MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST, 255 SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t; 256 257 /* values for the Operation field */ 258 #define MPI_SAS_OP_CLEAR_NOT_PRESENT (0x01) 259 #define MPI_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 260 #define MPI_SAS_OP_PHY_LINK_RESET (0x06) 261 #define MPI_SAS_OP_PHY_HARD_RESET (0x07) 262 #define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 263 #define MPI_SAS_OP_MAP_CURRENT (0x09) 264 #define MPI_SAS_OP_SEND_PRIMITIVE (0x0A) 265 #define MPI_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 266 #define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) 267 #define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE (0x0D) /* obsolete name */ 268 #define MPI_SAS_OP_REMOVE_DEVICE (0x0D) 269 #define MPI_SAS_OP_SET_IOC_PARAMETER (0x0E) 270 #define MPI_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 271 272 /* values for the PrimFlags field */ 273 #define MPI_SAS_PRIMFLAGS_SINGLE (0x08) 274 #define MPI_SAS_PRIMFLAGS_TRIPLE (0x02) 275 #define MPI_SAS_PRIMFLAGS_REDUNDANT (0x01) 276 277 /* SAS IO Unit Control Reply */ 278 typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY 279 { 280 U8 Operation; /* 00h */ 281 U8 Reserved1; /* 01h */ 282 U8 MsgLength; /* 02h */ 283 U8 Function; /* 03h */ 284 U16 DevHandle; /* 04h */ 285 U8 IOCParameter; /* 06h */ 286 U8 MsgFlags; /* 07h */ 287 U32 MsgContext; /* 08h */ 288 U16 Reserved4; /* 0Ch */ 289 U16 IOCStatus; /* 0Eh */ 290 U32 IOCLogInfo; /* 10h */ 291 } MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY, 292 SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t; 293 294 #endif 295