mpi_sas.h revision 154603
1154603Smjacob/* $FreeBSD: head/sys/dev/mpt/mpilib/mpi_sas.h 154603 2006-01-21 00:29:52Z mjacob $ */ 2154603Smjacob/*- 3154603Smjacob * Copyright (c) 2000-2005, 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 * 33154603Smjacob * Name: mpi_sas.h 34154603Smjacob * Title: MPI Serial Attached SCSI structures and definitions 35154603Smjacob * Creation Date: August 19, 2004 36154603Smjacob * 37154603Smjacob * mpi_sas.h Version: 01.05.01 38154603Smjacob * 39154603Smjacob * Version History 40154603Smjacob * --------------- 41154603Smjacob * 42154603Smjacob * Date Version Description 43154603Smjacob * -------- -------- ------------------------------------------------------ 44154603Smjacob * 08-19-04 01.05.01 Original release. 45154603Smjacob * -------------------------------------------------------------------------- 46154603Smjacob */ 47154603Smjacob 48154603Smjacob#ifndef MPI_SAS_H 49154603Smjacob#define MPI_SAS_H 50154603Smjacob 51154603Smjacob 52154603Smjacob/* 53154603Smjacob * Values for SASStatus. 54154603Smjacob */ 55154603Smjacob#define MPI_SASSTATUS_SUCCESS (0x00) 56154603Smjacob#define MPI_SASSTATUS_UNKNOWN_ERROR (0x01) 57154603Smjacob#define MPI_SASSTATUS_INVALID_FRAME (0x02) 58154603Smjacob#define MPI_SASSTATUS_UTC_BAD_DEST (0x03) 59154603Smjacob#define MPI_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 60154603Smjacob#define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 61154603Smjacob#define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 62154603Smjacob#define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 63154603Smjacob#define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 64154603Smjacob#define MPI_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 65154603Smjacob#define MPI_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 66154603Smjacob#define MPI_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 67154603Smjacob#define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 68154603Smjacob#define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 69154603Smjacob#define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 70154603Smjacob#define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 71154603Smjacob#define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 72154603Smjacob#define MPI_SASSTATUS_DATA_OFFSET_ERROR (0x11) 73154603Smjacob#define MPI_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 74154603Smjacob#define MPI_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 75154603Smjacob#define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 76154603Smjacob 77154603Smjacob 78154603Smjacob/* 79154603Smjacob * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 80154603Smjacob * data and SAS IO Unit Configuration pages. 81154603Smjacob */ 82154603Smjacob#define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 83154603Smjacob#define MPI_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 84154603Smjacob#define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 85154603Smjacob#define MPI_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 86154603Smjacob#define MPI_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 87154603Smjacob#define MPI_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 88154603Smjacob#define MPI_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 89154603Smjacob#define MPI_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 90154603Smjacob#define MPI_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 91154603Smjacob#define MPI_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 92154603Smjacob#define MPI_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 93154603Smjacob 94154603Smjacob#define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 95154603Smjacob#define MPI_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 96154603Smjacob#define MPI_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 97154603Smjacob#define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 98154603Smjacob#define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 99154603Smjacob 100154603Smjacob 101154603Smjacob 102154603Smjacob/***************************************************************************** 103154603Smjacob* 104154603Smjacob* 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 105154603Smjacob* 106154603Smjacob*****************************************************************************/ 107154603Smjacob 108154603Smjacob/****************************************************************************/ 109154603Smjacob/* Serial Management Protocol Passthrough Request */ 110154603Smjacob/****************************************************************************/ 111154603Smjacob 112154603Smjacobtypedef struct _MSG_SMP_PASSTHROUGH_REQUEST 113154603Smjacob{ 114154603Smjacob U8 PassthroughFlags; /* 00h */ 115154603Smjacob U8 PhysicalPort; /* 01h */ 116154603Smjacob U8 ChainOffset; /* 02h */ 117154603Smjacob U8 Function; /* 03h */ 118154603Smjacob U16 RequestDataLength; /* 04h */ 119154603Smjacob U8 ConnectionRate; /* 06h */ 120154603Smjacob U8 MsgFlags; /* 07h */ 121154603Smjacob U32 MsgContext; /* 08h */ 122154603Smjacob U32 Reserved1; /* 0Ch */ 123154603Smjacob U64 SASAddress; /* 10h */ 124154603Smjacob U32 Reserved2; /* 18h */ 125154603Smjacob U32 Reserved3; /* 1Ch */ 126154603Smjacob SGE_SIMPLE_UNION SGL; /* 20h */ 127154603Smjacob} MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST, 128154603Smjacob SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t; 129154603Smjacob 130154603Smjacob/* values for PassthroughFlags field */ 131154603Smjacob#define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 132154603Smjacob 133154603Smjacob/* values for ConnectionRate field */ 134154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 135154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_1_5 (0x08) 136154603Smjacob#define MPI_SMP_PT_REQ_CONNECT_RATE_3_0 (0x09) 137154603Smjacob 138154603Smjacob 139154603Smjacob/* Serial Management Protocol Passthrough Reply */ 140154603Smjacobtypedef struct _MSG_SMP_PASSTHROUGH_REPLY 141154603Smjacob{ 142154603Smjacob U8 PassthroughFlags; /* 00h */ 143154603Smjacob U8 PhysicalPort; /* 01h */ 144154603Smjacob U8 MsgLength; /* 02h */ 145154603Smjacob U8 Function; /* 03h */ 146154603Smjacob U16 ResponseDataLength; /* 04h */ 147154603Smjacob U8 Reserved1; /* 06h */ 148154603Smjacob U8 MsgFlags; /* 07h */ 149154603Smjacob U32 MsgContext; /* 08h */ 150154603Smjacob U8 Reserved2; /* 0Ch */ 151154603Smjacob U8 SASStatus; /* 0Dh */ 152154603Smjacob U16 IOCStatus; /* 0Eh */ 153154603Smjacob U32 IOCLogInfo; /* 10h */ 154154603Smjacob U32 Reserved3; /* 14h */ 155154603Smjacob U8 ResponseData[4]; /* 18h */ 156154603Smjacob} MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY, 157154603Smjacob SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t; 158154603Smjacob 159154603Smjacob#define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 160154603Smjacob 161154603Smjacob 162154603Smjacob/****************************************************************************/ 163154603Smjacob/* SATA Passthrough Request */ 164154603Smjacob/****************************************************************************/ 165154603Smjacob 166154603Smjacobtypedef struct _MSG_SATA_PASSTHROUGH_REQUEST 167154603Smjacob{ 168154603Smjacob U8 TargetID; /* 00h */ 169154603Smjacob U8 Bus; /* 01h */ 170154603Smjacob U8 ChainOffset; /* 02h */ 171154603Smjacob U8 Function; /* 03h */ 172154603Smjacob U16 PassthroughFlags; /* 04h */ 173154603Smjacob U8 ConnectionRate; /* 06h */ 174154603Smjacob U8 MsgFlags; /* 07h */ 175154603Smjacob U32 MsgContext; /* 08h */ 176154603Smjacob U32 Reserved1; /* 0Ch */ 177154603Smjacob U32 Reserved2; /* 10h */ 178154603Smjacob U32 Reserved3; /* 14h */ 179154603Smjacob U32 DataLength; /* 18h */ 180154603Smjacob U8 CommandFIS[20]; /* 1Ch */ 181154603Smjacob SGE_SIMPLE_UNION SGL; /* 30h */ 182154603Smjacob} MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST, 183154603Smjacob SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t; 184154603Smjacob 185154603Smjacob/* values for PassthroughFlags field */ 186154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE (0x0200) 187154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 188154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED (0x0080) 189154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040) 190154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 191154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 192154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 193154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 194154603Smjacob#define MPI_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 195154603Smjacob 196154603Smjacob/* values for ConnectionRate field */ 197154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00) 198154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_1_5 (0x08) 199154603Smjacob#define MPI_SATA_PT_REQ_CONNECT_RATE_3_0 (0x09) 200154603Smjacob 201154603Smjacob 202154603Smjacob/* SATA Passthrough Reply */ 203154603Smjacobtypedef struct _MSG_SATA_PASSTHROUGH_REPLY 204154603Smjacob{ 205154603Smjacob U8 TargetID; /* 00h */ 206154603Smjacob U8 Bus; /* 01h */ 207154603Smjacob U8 MsgLength; /* 02h */ 208154603Smjacob U8 Function; /* 03h */ 209154603Smjacob U16 PassthroughFlags; /* 04h */ 210154603Smjacob U8 Reserved1; /* 06h */ 211154603Smjacob U8 MsgFlags; /* 07h */ 212154603Smjacob U32 MsgContext; /* 08h */ 213154603Smjacob U8 Reserved2; /* 0Ch */ 214154603Smjacob U8 SASStatus; /* 0Dh */ 215154603Smjacob U16 IOCStatus; /* 0Eh */ 216154603Smjacob U32 IOCLogInfo; /* 10h */ 217154603Smjacob U8 StatusFIS[20]; /* 14h */ 218154603Smjacob U32 StatusControlRegisters; /* 28h */ 219154603Smjacob U32 TransferCount; /* 2Ch */ 220154603Smjacob} MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY, 221154603Smjacob SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t; 222154603Smjacob 223154603Smjacob 224154603Smjacob 225154603Smjacob 226154603Smjacob/****************************************************************************/ 227154603Smjacob/* SAS IO Unit Control Request */ 228154603Smjacob/****************************************************************************/ 229154603Smjacob 230154603Smjacobtypedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST 231154603Smjacob{ 232154603Smjacob U8 Operation; /* 00h */ 233154603Smjacob U8 Reserved1; /* 01h */ 234154603Smjacob U8 ChainOffset; /* 02h */ 235154603Smjacob U8 Function; /* 03h */ 236154603Smjacob U16 Reserved2; /* 04h */ 237154603Smjacob U8 Reserved3; /* 06h */ 238154603Smjacob U8 MsgFlags; /* 07h */ 239154603Smjacob U32 MsgContext; /* 08h */ 240154603Smjacob U8 TargetID; /* 0Ch */ 241154603Smjacob U8 Bus; /* 0Dh */ 242154603Smjacob U8 PhyNum; /* 0Eh */ 243154603Smjacob U8 Reserved4; /* 0Fh */ 244154603Smjacob U32 Reserved5; /* 10h */ 245154603Smjacob U64 SASAddress; /* 14h */ 246154603Smjacob U32 Reserved6; /* 1Ch */ 247154603Smjacob} MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST, 248154603Smjacob SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t; 249154603Smjacob 250154603Smjacob/* values for the Operation field */ 251154603Smjacob#define MPI_SAS_OP_CLEAR_NOT_PRESENT (0x01) 252154603Smjacob#define MPI_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 253154603Smjacob#define MPI_SAS_OP_PHY_LINK_RESET (0x06) 254154603Smjacob#define MPI_SAS_OP_PHY_HARD_RESET (0x07) 255154603Smjacob#define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 256154603Smjacob#define MPI_SAS_OP_MAP_CURRENT (0x09) 257154603Smjacob 258154603Smjacob 259154603Smjacob/* SAS IO Unit Control Reply */ 260154603Smjacobtypedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY 261154603Smjacob{ 262154603Smjacob U8 Operation; /* 00h */ 263154603Smjacob U8 Reserved1; /* 01h */ 264154603Smjacob U8 MsgLength; /* 02h */ 265154603Smjacob U8 Function; /* 03h */ 266154603Smjacob U16 Reserved2; /* 04h */ 267154603Smjacob U8 Reserved3; /* 06h */ 268154603Smjacob U8 MsgFlags; /* 07h */ 269154603Smjacob U32 MsgContext; /* 08h */ 270154603Smjacob U16 Reserved4; /* 0Ch */ 271154603Smjacob U16 IOCStatus; /* 0Eh */ 272154603Smjacob U32 IOCLogInfo; /* 10h */ 273154603Smjacob} MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY, 274154603Smjacob SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t; 275154603Smjacob 276154603Smjacob#endif 277