1154603Smjacob/* $FreeBSD$ */ 2154603Smjacob/*- 3233740Smarius * Copyright (c) 2000-2010, LSI Logic Corporation and its contributors. 4154603Smjacob * All rights reserved. 5154603Smjacob * 6154603Smjacob * Redistribution and use in source and binary forms, with or without 7154603Smjacob * modification, are permitted provided that the following conditions are 8154603Smjacob * met: 9154603Smjacob * 1. Redistributions of source code must retain the above copyright 10154603Smjacob * notice, this list of conditions and the following disclaimer. 11154603Smjacob * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12154603Smjacob * substantially similar to the "NO WARRANTY" disclaimer below 13154603Smjacob * ("Disclaimer") and any redistribution must be conditioned upon including 14154603Smjacob * a substantially similar Disclaimer requirement for further binary 15154603Smjacob * redistribution. 16154603Smjacob * 3. Neither the name of the LSI Logic Corporation nor the names of its 17154603Smjacob * contributors may be used to endorse or promote products derived from 18154603Smjacob * this software without specific prior written permission. 19154603Smjacob * 20154603Smjacob * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21154603Smjacob * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22154603Smjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23154603Smjacob * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24154603Smjacob * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25154603Smjacob * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26154603Smjacob * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27154603Smjacob * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28154603Smjacob * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29154603Smjacob * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT 30154603Smjacob * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31154603Smjacob * 32154603Smjacob * Name: mpi_sas.h 33154603Smjacob * Title: MPI Serial Attached SCSI structures and definitions 34154603Smjacob * Creation Date: August 19, 2004 35154603Smjacob * 36233740Smarius * mpi_sas.h Version: 01.05.05 37154603Smjacob * 38154603Smjacob * Version History 39154603Smjacob * --------------- 40154603Smjacob * 41154603Smjacob * Date Version Description 42154603Smjacob * -------- -------- ------------------------------------------------------ 43154603Smjacob * 08-19-04 01.05.01 Original release. 44156000Smjacob * 08-30-05 01.05.02 Added DeviceInfo bit for SEP. 45156000Smjacob * Added PrimFlags and Primitive field to SAS IO Unit 46156000Smjacob * Control request, and added a new operation code. 47170251Sscottl * 03-27-06 01.05.03 Added Force Full Discovery, Transmit Port Select Signal, 48170251Sscottl * and Remove Device operations to SAS IO Unit Control. 49170251Sscottl * Added DevHandle field to SAS IO Unit Control request and 50170251Sscottl * reply. 51170251Sscottl * 10-11-06 01.05.04 Fixed the name of a define for Operation field of SAS IO 52170251Sscottl * Unit Control request. 53233740Smarius * 01-15-08 01.05.05 Added support for MPI_SAS_OP_SET_IOC_PARAMETER, 54233740Smarius * including adding IOCParameter and IOCParameter value 55233740Smarius * fields to SAS IO Unit Control Request. 56233740Smarius * Added MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC define. 57154603Smjacob * -------------------------------------------------------------------------- 58154603Smjacob */ 59154603Smjacob 60154603Smjacob#ifndef MPI_SAS_H 61154603Smjacob#define MPI_SAS_H 62154603Smjacob 63154603Smjacob 64154603Smjacob/* 65154603Smjacob * Values for SASStatus. 66154603Smjacob */ 67154603Smjacob#define MPI_SASSTATUS_SUCCESS (0x00) 68154603Smjacob#define MPI_SASSTATUS_UNKNOWN_ERROR (0x01) 69154603Smjacob#define MPI_SASSTATUS_INVALID_FRAME (0x02) 70154603Smjacob#define MPI_SASSTATUS_UTC_BAD_DEST (0x03) 71154603Smjacob#define MPI_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 72154603Smjacob#define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 73154603Smjacob#define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 74154603Smjacob#define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 75154603Smjacob#define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 76154603Smjacob#define MPI_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 77154603Smjacob#define MPI_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 78154603Smjacob#define MPI_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 79154603Smjacob#define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 80154603Smjacob#define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 81154603Smjacob#define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 82154603Smjacob#define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 83154603Smjacob#define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 84154603Smjacob#define MPI_SASSTATUS_DATA_OFFSET_ERROR (0x11) 85154603Smjacob#define MPI_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 86154603Smjacob#define MPI_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 87154603Smjacob#define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 88154603Smjacob 89154603Smjacob 90154603Smjacob/* 91154603Smjacob * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 92154603Smjacob * data and SAS IO Unit Configuration pages. 93154603Smjacob */ 94233740Smarius#define MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC (0xF0000000) 95233740Smarius 96156000Smjacob#define MPI_SAS_DEVICE_INFO_SEP (0x00004000) 97154603Smjacob#define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 98154603Smjacob#define MPI_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 99154603Smjacob#define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 100154603Smjacob#define MPI_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 101154603Smjacob#define MPI_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 102154603Smjacob#define MPI_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 103154603Smjacob#define MPI_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 104154603Smjacob#define MPI_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 105154603Smjacob#define MPI_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 106154603Smjacob#define MPI_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 107154603Smjacob#define MPI_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 108154603Smjacob 109154603Smjacob#define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 110154603Smjacob#define MPI_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 111154603Smjacob#define MPI_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 112154603Smjacob#define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 113154603Smjacob#define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 114154603Smjacob 115154603Smjacob 116154603Smjacob 117154603Smjacob/***************************************************************************** 118154603Smjacob* 119154603Smjacob* 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 120154603Smjacob* 121154603Smjacob*****************************************************************************/ 122154603Smjacob 123154603Smjacob/****************************************************************************/ 124154603Smjacob/* Serial Management Protocol Passthrough Request */ 125154603Smjacob/****************************************************************************/ 126154603Smjacob 127154603Smjacobtypedef struct _MSG_SMP_PASSTHROUGH_REQUEST 128154603Smjacob{ 129154603Smjacob U8 PassthroughFlags; /* 00h */ 130154603Smjacob U8 PhysicalPort; /* 01h */ 131154603Smjacob U8 ChainOffset; /* 02h */ 132154603Smjacob U8 Function; /* 03h */ 133154603Smjacob U16 RequestDataLength; /* 04h */ 134154603Smjacob U8 ConnectionRate; /* 06h */ 135154603Smjacob U8 MsgFlags; /* 07h */ 136154603Smjacob U32 MsgContext; /* 08h */ 137154603Smjacob U32 Reserved1; /* 0Ch */ 138154603Smjacob U64 SASAddress; /* 10h */ 139154603Smjacob U32 Reserved2; /* 18h */ 140154603Smjacob U32 Reserved3; /* 1Ch */ 141154603Smjacob SGE_SIMPLE_UNION SGL; /* 20h */ 142154603Smjacob} MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST, 143154603Smjacob SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t; 144154603Smjacob 145154603Smjacob/* values for PassthroughFlags field */ 146154603Smjacob#define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 147154603Smjacob 148154603Smjacob/* values for ConnectionRate field */ 149154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 150154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_1_5 (0x08) 151154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_3_0 (0x09) 152154603Smjacob 153154603Smjacob 154154603Smjacob/* Serial Management Protocol Passthrough Reply */ 155154603Smjacobtypedef struct _MSG_SMP_PASSTHROUGH_REPLY 156154603Smjacob{ 157154603Smjacob U8 PassthroughFlags; /* 00h */ 158154603Smjacob U8 PhysicalPort; /* 01h */ 159154603Smjacob U8 MsgLength; /* 02h */ 160154603Smjacob U8 Function; /* 03h */ 161154603Smjacob U16 ResponseDataLength; /* 04h */ 162154603Smjacob U8 Reserved1; /* 06h */ 163154603Smjacob U8 MsgFlags; /* 07h */ 164154603Smjacob U32 MsgContext; /* 08h */ 165154603Smjacob U8 Reserved2; /* 0Ch */ 166154603Smjacob U8 SASStatus; /* 0Dh */ 167154603Smjacob U16 IOCStatus; /* 0Eh */ 168154603Smjacob U32 IOCLogInfo; /* 10h */ 169154603Smjacob U32 Reserved3; /* 14h */ 170154603Smjacob U8 ResponseData[4]; /* 18h */ 171154603Smjacob} MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY, 172154603Smjacob SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t; 173154603Smjacob 174154603Smjacob#define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 175154603Smjacob 176154603Smjacob 177154603Smjacob/****************************************************************************/ 178154603Smjacob/* SATA Passthrough Request */ 179154603Smjacob/****************************************************************************/ 180154603Smjacob 181154603Smjacobtypedef struct _MSG_SATA_PASSTHROUGH_REQUEST 182154603Smjacob{ 183154603Smjacob U8 TargetID; /* 00h */ 184154603Smjacob U8 Bus; /* 01h */ 185154603Smjacob U8 ChainOffset; /* 02h */ 186154603Smjacob U8 Function; /* 03h */ 187154603Smjacob U16 PassthroughFlags; /* 04h */ 188154603Smjacob U8 ConnectionRate; /* 06h */ 189154603Smjacob U8 MsgFlags; /* 07h */ 190154603Smjacob U32 MsgContext; /* 08h */ 191154603Smjacob U32 Reserved1; /* 0Ch */ 192154603Smjacob U32 Reserved2; /* 10h */ 193154603Smjacob U32 Reserved3; /* 14h */ 194154603Smjacob U32 DataLength; /* 18h */ 195154603Smjacob U8 CommandFIS[20]; /* 1Ch */ 196154603Smjacob SGE_SIMPLE_UNION SGL; /* 30h */ 197154603Smjacob} MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST, 198154603Smjacob SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t; 199154603Smjacob 200154603Smjacob/* values for PassthroughFlags field */ 201154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE (0x0200) 202154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 203154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED (0x0080) 204154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040) 205154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 206154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 207154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 208154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 209154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 210154603Smjacob 211154603Smjacob/* values for ConnectionRate field */ 212154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 213154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_1_5 (0x08) 214154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_3_0 (0x09) 215154603Smjacob 216154603Smjacob 217154603Smjacob/* SATA Passthrough Reply */ 218154603Smjacobtypedef struct _MSG_SATA_PASSTHROUGH_REPLY 219154603Smjacob{ 220154603Smjacob U8 TargetID; /* 00h */ 221154603Smjacob U8 Bus; /* 01h */ 222154603Smjacob U8 MsgLength; /* 02h */ 223154603Smjacob U8 Function; /* 03h */ 224154603Smjacob U16 PassthroughFlags; /* 04h */ 225154603Smjacob U8 Reserved1; /* 06h */ 226154603Smjacob U8 MsgFlags; /* 07h */ 227154603Smjacob U32 MsgContext; /* 08h */ 228154603Smjacob U8 Reserved2; /* 0Ch */ 229154603Smjacob U8 SASStatus; /* 0Dh */ 230154603Smjacob U16 IOCStatus; /* 0Eh */ 231154603Smjacob U32 IOCLogInfo; /* 10h */ 232154603Smjacob U8 StatusFIS[20]; /* 14h */ 233154603Smjacob U32 StatusControlRegisters; /* 28h */ 234154603Smjacob U32 TransferCount; /* 2Ch */ 235154603Smjacob} MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY, 236154603Smjacob SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t; 237154603Smjacob 238154603Smjacob 239154603Smjacob 240154603Smjacob 241154603Smjacob/****************************************************************************/ 242154603Smjacob/* SAS IO Unit Control Request */ 243154603Smjacob/****************************************************************************/ 244154603Smjacob 245154603Smjacobtypedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST 246154603Smjacob{ 247154603Smjacob U8 Operation; /* 00h */ 248154603Smjacob U8 Reserved1; /* 01h */ 249154603Smjacob U8 ChainOffset; /* 02h */ 250154603Smjacob U8 Function; /* 03h */ 251170251Sscottl U16 DevHandle; /* 04h */ 252233740Smarius U8 IOCParameter; /* 06h */ 253154603Smjacob U8 MsgFlags; /* 07h */ 254154603Smjacob U32 MsgContext; /* 08h */ 255154603Smjacob U8 TargetID; /* 0Ch */ 256154603Smjacob U8 Bus; /* 0Dh */ 257154603Smjacob U8 PhyNum; /* 0Eh */ 258156000Smjacob U8 PrimFlags; /* 0Fh */ 259156000Smjacob U32 Primitive; /* 10h */ 260154603Smjacob U64 SASAddress; /* 14h */ 261233740Smarius U32 IOCParameterValue; /* 1Ch */ 262154603Smjacob} MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST, 263154603Smjacob SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t; 264154603Smjacob 265154603Smjacob/* values for the Operation field */ 266170251Sscottl#define MPI_SAS_OP_CLEAR_NOT_PRESENT (0x01) 267170251Sscottl#define MPI_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 268170251Sscottl#define MPI_SAS_OP_PHY_LINK_RESET (0x06) 269170251Sscottl#define MPI_SAS_OP_PHY_HARD_RESET (0x07) 270170251Sscottl#define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 271170251Sscottl#define MPI_SAS_OP_MAP_CURRENT (0x09) 272156000Smjacob#define MPI_SAS_OP_SEND_PRIMITIVE (0x0A) 273170251Sscottl#define MPI_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 274170251Sscottl#define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) 275170251Sscottl#define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE (0x0D) /* obsolete name */ 276170251Sscottl#define MPI_SAS_OP_REMOVE_DEVICE (0x0D) 277233740Smarius#define MPI_SAS_OP_SET_IOC_PARAMETER (0x0E) 278233740Smarius#define MPI_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 279154603Smjacob 280156000Smjacob/* values for the PrimFlags field */ 281156000Smjacob#define MPI_SAS_PRIMFLAGS_SINGLE (0x08) 282156000Smjacob#define MPI_SAS_PRIMFLAGS_TRIPLE (0x02) 283156000Smjacob#define MPI_SAS_PRIMFLAGS_REDUNDANT (0x01) 284154603Smjacob 285156000Smjacob 286154603Smjacob/* SAS IO Unit Control Reply */ 287154603Smjacobtypedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY 288154603Smjacob{ 289154603Smjacob U8 Operation; /* 00h */ 290154603Smjacob U8 Reserved1; /* 01h */ 291154603Smjacob U8 MsgLength; /* 02h */ 292154603Smjacob U8 Function; /* 03h */ 293170251Sscottl U16 DevHandle; /* 04h */ 294233740Smarius U8 IOCParameter; /* 06h */ 295154603Smjacob U8 MsgFlags; /* 07h */ 296154603Smjacob U32 MsgContext; /* 08h */ 297154603Smjacob U16 Reserved4; /* 0Ch */ 298154603Smjacob U16 IOCStatus; /* 0Eh */ 299154603Smjacob U32 IOCLogInfo; /* 10h */ 300154603Smjacob} MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY, 301154603Smjacob SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t; 302154603Smjacob 303154603Smjacob#endif 304156000Smjacob 305156000Smjacob 306