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