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