mpi_sas.h revision 170251
1/* $FreeBSD: head/sys/dev/mpt/mpilib/mpi_sas.h 170251 2007-06-03 22:58:27Z scottl $ */ 2/*- 3 * Copyright (c) 2000-2005, 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.04 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 * -------------------------------------------------------------------------- 54 */ 55 56#ifndef MPI_SAS_H 57#define MPI_SAS_H 58 59 60/* 61 * Values for SASStatus. 62 */ 63#define MPI_SASSTATUS_SUCCESS (0x00) 64#define MPI_SASSTATUS_UNKNOWN_ERROR (0x01) 65#define MPI_SASSTATUS_INVALID_FRAME (0x02) 66#define MPI_SASSTATUS_UTC_BAD_DEST (0x03) 67#define MPI_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 68#define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 69#define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 70#define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 71#define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 72#define MPI_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 73#define MPI_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 74#define MPI_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 75#define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 76#define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 77#define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 78#define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 79#define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 80#define MPI_SASSTATUS_DATA_OFFSET_ERROR (0x11) 81#define MPI_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 82#define MPI_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 83#define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 84 85 86/* 87 * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 88 * data and SAS IO Unit Configuration pages. 89 */ 90#define MPI_SAS_DEVICE_INFO_SEP (0x00004000) 91#define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 92#define MPI_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 93#define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 94#define MPI_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 95#define MPI_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 96#define MPI_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 97#define MPI_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 98#define MPI_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 99#define MPI_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 100#define MPI_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 101#define MPI_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 102 103#define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 104#define MPI_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 105#define MPI_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 106#define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 107#define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 108 109 110 111/***************************************************************************** 112* 113* 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 114* 115*****************************************************************************/ 116 117/****************************************************************************/ 118/* Serial Management Protocol Passthrough Request */ 119/****************************************************************************/ 120 121typedef struct _MSG_SMP_PASSTHROUGH_REQUEST 122{ 123 U8 PassthroughFlags; /* 00h */ 124 U8 PhysicalPort; /* 01h */ 125 U8 ChainOffset; /* 02h */ 126 U8 Function; /* 03h */ 127 U16 RequestDataLength; /* 04h */ 128 U8 ConnectionRate; /* 06h */ 129 U8 MsgFlags; /* 07h */ 130 U32 MsgContext; /* 08h */ 131 U32 Reserved1; /* 0Ch */ 132 U64 SASAddress; /* 10h */ 133 U32 Reserved2; /* 18h */ 134 U32 Reserved3; /* 1Ch */ 135 SGE_SIMPLE_UNION SGL; /* 20h */ 136} MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST, 137 SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t; 138 139/* values for PassthroughFlags field */ 140#define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 141 142/* values for ConnectionRate field */ 143#define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 144#define MPI_SMP_PT_REQ_CONNECT_RATE_1_5 (0x08) 145#define MPI_SMP_PT_REQ_CONNECT_RATE_3_0 (0x09) 146 147 148/* Serial Management Protocol Passthrough Reply */ 149typedef struct _MSG_SMP_PASSTHROUGH_REPLY 150{ 151 U8 PassthroughFlags; /* 00h */ 152 U8 PhysicalPort; /* 01h */ 153 U8 MsgLength; /* 02h */ 154 U8 Function; /* 03h */ 155 U16 ResponseDataLength; /* 04h */ 156 U8 Reserved1; /* 06h */ 157 U8 MsgFlags; /* 07h */ 158 U32 MsgContext; /* 08h */ 159 U8 Reserved2; /* 0Ch */ 160 U8 SASStatus; /* 0Dh */ 161 U16 IOCStatus; /* 0Eh */ 162 U32 IOCLogInfo; /* 10h */ 163 U32 Reserved3; /* 14h */ 164 U8 ResponseData[4]; /* 18h */ 165} MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY, 166 SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t; 167 168#define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 169 170 171/****************************************************************************/ 172/* SATA Passthrough Request */ 173/****************************************************************************/ 174 175typedef struct _MSG_SATA_PASSTHROUGH_REQUEST 176{ 177 U8 TargetID; /* 00h */ 178 U8 Bus; /* 01h */ 179 U8 ChainOffset; /* 02h */ 180 U8 Function; /* 03h */ 181 U16 PassthroughFlags; /* 04h */ 182 U8 ConnectionRate; /* 06h */ 183 U8 MsgFlags; /* 07h */ 184 U32 MsgContext; /* 08h */ 185 U32 Reserved1; /* 0Ch */ 186 U32 Reserved2; /* 10h */ 187 U32 Reserved3; /* 14h */ 188 U32 DataLength; /* 18h */ 189 U8 CommandFIS[20]; /* 1Ch */ 190 SGE_SIMPLE_UNION SGL; /* 30h */ 191} MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST, 192 SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t; 193 194/* values for PassthroughFlags field */ 195#define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE (0x0200) 196#define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 197#define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED (0x0080) 198#define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040) 199#define MPI_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 200#define MPI_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 201#define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 202#define MPI_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 203#define MPI_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 204 205/* values for ConnectionRate field */ 206#define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 207#define MPI_SATA_PT_REQ_CONNECT_RATE_1_5 (0x08) 208#define MPI_SATA_PT_REQ_CONNECT_RATE_3_0 (0x09) 209 210 211/* SATA Passthrough Reply */ 212typedef 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 234 235/****************************************************************************/ 236/* SAS IO Unit Control Request */ 237/****************************************************************************/ 238 239typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST 240{ 241 U8 Operation; /* 00h */ 242 U8 Reserved1; /* 01h */ 243 U8 ChainOffset; /* 02h */ 244 U8 Function; /* 03h */ 245 U16 DevHandle; /* 04h */ 246 U8 Reserved3; /* 06h */ 247 U8 MsgFlags; /* 07h */ 248 U32 MsgContext; /* 08h */ 249 U8 TargetID; /* 0Ch */ 250 U8 Bus; /* 0Dh */ 251 U8 PhyNum; /* 0Eh */ 252 U8 PrimFlags; /* 0Fh */ 253 U32 Primitive; /* 10h */ 254 U64 SASAddress; /* 14h */ 255 U32 Reserved4; /* 1Ch */ 256} MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST, 257 SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t; 258 259/* values for the Operation field */ 260#define MPI_SAS_OP_CLEAR_NOT_PRESENT (0x01) 261#define MPI_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 262#define MPI_SAS_OP_PHY_LINK_RESET (0x06) 263#define MPI_SAS_OP_PHY_HARD_RESET (0x07) 264#define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 265#define MPI_SAS_OP_MAP_CURRENT (0x09) 266#define MPI_SAS_OP_SEND_PRIMITIVE (0x0A) 267#define MPI_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 268#define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) 269#define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE (0x0D) /* obsolete name */ 270#define MPI_SAS_OP_REMOVE_DEVICE (0x0D) 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 278/* SAS IO Unit Control Reply */ 279typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY 280{ 281 U8 Operation; /* 00h */ 282 U8 Reserved1; /* 01h */ 283 U8 MsgLength; /* 02h */ 284 U8 Function; /* 03h */ 285 U16 DevHandle; /* 04h */ 286 U8 Reserved3; /* 06h */ 287 U8 MsgFlags; /* 07h */ 288 U32 MsgContext; /* 08h */ 289 U16 Reserved4; /* 0Ch */ 290 U16 IOCStatus; /* 0Eh */ 291 U32 IOCLogInfo; /* 10h */ 292} MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY, 293 SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t; 294 295#endif 296 297 298