mpi2_sas.h revision 212420
1212420Sken/* $FreeBSD: head/sys/dev/mps/mpi/mpi2_sas.h 212420 2010-09-10 15:03:56Z ken $ */ 2212420Sken/* 3212420Sken * Copyright (c) 2000-2007 LSI Corporation. 4212420Sken * 5212420Sken * 6212420Sken * Name: mpi2_sas.h 7212420Sken * Title: MPI Serial Attached SCSI structures and definitions 8212420Sken * Creation Date: February 9, 2007 9212420Sken * 10212420Sken * mpi2.h Version: 02.00.03 11212420Sken * 12212420Sken * Version History 13212420Sken * --------------- 14212420Sken * 15212420Sken * Date Version Description 16212420Sken * -------- -------- ------------------------------------------------------ 17212420Sken * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A. 18212420Sken * 06-26-07 02.00.01 Added Clear All Persistent Operation to SAS IO Unit 19212420Sken * Control Request. 20212420Sken * 10-02-08 02.00.02 Added Set IOC Parameter Operation to SAS IO Unit Control 21212420Sken * Request. 22212420Sken * 10-28-09 02.00.03 Changed the type of SGL in MPI2_SATA_PASSTHROUGH_REQUEST 23212420Sken * to MPI2_SGE_IO_UNION since it supports chained SGLs. 24212420Sken * -------------------------------------------------------------------------- 25212420Sken */ 26212420Sken 27212420Sken#ifndef MPI2_SAS_H 28212420Sken#define MPI2_SAS_H 29212420Sken 30212420Sken/* 31212420Sken * Values for SASStatus. 32212420Sken */ 33212420Sken#define MPI2_SASSTATUS_SUCCESS (0x00) 34212420Sken#define MPI2_SASSTATUS_UNKNOWN_ERROR (0x01) 35212420Sken#define MPI2_SASSTATUS_INVALID_FRAME (0x02) 36212420Sken#define MPI2_SASSTATUS_UTC_BAD_DEST (0x03) 37212420Sken#define MPI2_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 38212420Sken#define MPI2_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 39212420Sken#define MPI2_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 40212420Sken#define MPI2_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 41212420Sken#define MPI2_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 42212420Sken#define MPI2_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 43212420Sken#define MPI2_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 44212420Sken#define MPI2_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 45212420Sken#define MPI2_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 46212420Sken#define MPI2_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 47212420Sken#define MPI2_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 48212420Sken#define MPI2_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 49212420Sken#define MPI2_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 50212420Sken#define MPI2_SASSTATUS_DATA_OFFSET_ERROR (0x11) 51212420Sken#define MPI2_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 52212420Sken#define MPI2_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 53212420Sken#define MPI2_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 54212420Sken 55212420Sken 56212420Sken/* 57212420Sken * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 58212420Sken * data and SAS Configuration pages. 59212420Sken */ 60212420Sken#define MPI2_SAS_DEVICE_INFO_SEP (0x00004000) 61212420Sken#define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 62212420Sken#define MPI2_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 63212420Sken#define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 64212420Sken#define MPI2_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 65212420Sken#define MPI2_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 66212420Sken#define MPI2_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 67212420Sken#define MPI2_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 68212420Sken#define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 69212420Sken#define MPI2_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 70212420Sken#define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 71212420Sken#define MPI2_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 72212420Sken 73212420Sken#define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 74212420Sken#define MPI2_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 75212420Sken#define MPI2_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 76212420Sken#define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 77212420Sken#define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 78212420Sken 79212420Sken 80212420Sken/***************************************************************************** 81212420Sken* 82212420Sken* SAS Messages 83212420Sken* 84212420Sken*****************************************************************************/ 85212420Sken 86212420Sken/**************************************************************************** 87212420Sken* SMP Passthrough messages 88212420Sken****************************************************************************/ 89212420Sken 90212420Sken/* SMP Passthrough Request Message */ 91212420Skentypedef struct _MPI2_SMP_PASSTHROUGH_REQUEST 92212420Sken{ 93212420Sken U8 PassthroughFlags; /* 0x00 */ 94212420Sken U8 PhysicalPort; /* 0x01 */ 95212420Sken U8 ChainOffset; /* 0x02 */ 96212420Sken U8 Function; /* 0x03 */ 97212420Sken U16 RequestDataLength; /* 0x04 */ 98212420Sken U8 SGLFlags; /* 0x06 */ 99212420Sken U8 MsgFlags; /* 0x07 */ 100212420Sken U8 VP_ID; /* 0x08 */ 101212420Sken U8 VF_ID; /* 0x09 */ 102212420Sken U16 Reserved1; /* 0x0A */ 103212420Sken U32 Reserved2; /* 0x0C */ 104212420Sken U64 SASAddress; /* 0x10 */ 105212420Sken U32 Reserved3; /* 0x18 */ 106212420Sken U32 Reserved4; /* 0x1C */ 107212420Sken MPI2_SIMPLE_SGE_UNION SGL; /* 0x20 */ 108212420Sken} MPI2_SMP_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REQUEST, 109212420Sken Mpi2SmpPassthroughRequest_t, MPI2_POINTER pMpi2SmpPassthroughRequest_t; 110212420Sken 111212420Sken/* values for PassthroughFlags field */ 112212420Sken#define MPI2_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 113212420Sken 114212420Sken/* values for SGLFlags field are in the SGL section of mpi2.h */ 115212420Sken 116212420Sken 117212420Sken/* SMP Passthrough Reply Message */ 118212420Skentypedef struct _MPI2_SMP_PASSTHROUGH_REPLY 119212420Sken{ 120212420Sken U8 PassthroughFlags; /* 0x00 */ 121212420Sken U8 PhysicalPort; /* 0x01 */ 122212420Sken U8 MsgLength; /* 0x02 */ 123212420Sken U8 Function; /* 0x03 */ 124212420Sken U16 ResponseDataLength; /* 0x04 */ 125212420Sken U8 SGLFlags; /* 0x06 */ 126212420Sken U8 MsgFlags; /* 0x07 */ 127212420Sken U8 VP_ID; /* 0x08 */ 128212420Sken U8 VF_ID; /* 0x09 */ 129212420Sken U16 Reserved1; /* 0x0A */ 130212420Sken U8 Reserved2; /* 0x0C */ 131212420Sken U8 SASStatus; /* 0x0D */ 132212420Sken U16 IOCStatus; /* 0x0E */ 133212420Sken U32 IOCLogInfo; /* 0x10 */ 134212420Sken U32 Reserved3; /* 0x14 */ 135212420Sken U8 ResponseData[4]; /* 0x18 */ 136212420Sken} MPI2_SMP_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REPLY, 137212420Sken Mpi2SmpPassthroughReply_t, MPI2_POINTER pMpi2SmpPassthroughReply_t; 138212420Sken 139212420Sken/* values for PassthroughFlags field */ 140212420Sken#define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 141212420Sken 142212420Sken/* values for SASStatus field are at the top of this file */ 143212420Sken 144212420Sken 145212420Sken/**************************************************************************** 146212420Sken* SATA Passthrough messages 147212420Sken****************************************************************************/ 148212420Sken 149212420Sken/* SATA Passthrough Request Message */ 150212420Skentypedef struct _MPI2_SATA_PASSTHROUGH_REQUEST 151212420Sken{ 152212420Sken U16 DevHandle; /* 0x00 */ 153212420Sken U8 ChainOffset; /* 0x02 */ 154212420Sken U8 Function; /* 0x03 */ 155212420Sken U16 PassthroughFlags; /* 0x04 */ 156212420Sken U8 SGLFlags; /* 0x06 */ 157212420Sken U8 MsgFlags; /* 0x07 */ 158212420Sken U8 VP_ID; /* 0x08 */ 159212420Sken U8 VF_ID; /* 0x09 */ 160212420Sken U16 Reserved1; /* 0x0A */ 161212420Sken U32 Reserved2; /* 0x0C */ 162212420Sken U32 Reserved3; /* 0x10 */ 163212420Sken U32 Reserved4; /* 0x14 */ 164212420Sken U32 DataLength; /* 0x18 */ 165212420Sken U8 CommandFIS[20]; /* 0x1C */ 166212420Sken MPI2_SGE_IO_UNION SGL; /* 0x20 */ 167212420Sken} MPI2_SATA_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REQUEST, 168212420Sken Mpi2SataPassthroughRequest_t, MPI2_POINTER pMpi2SataPassthroughRequest_t; 169212420Sken 170212420Sken/* values for PassthroughFlags field */ 171212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 172212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 173212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 174212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 175212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 176212420Sken#define MPI2_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 177212420Sken 178212420Sken/* values for SGLFlags field are in the SGL section of mpi2.h */ 179212420Sken 180212420Sken 181212420Sken/* SATA Passthrough Reply Message */ 182212420Skentypedef struct _MPI2_SATA_PASSTHROUGH_REPLY 183212420Sken{ 184212420Sken U16 DevHandle; /* 0x00 */ 185212420Sken U8 MsgLength; /* 0x02 */ 186212420Sken U8 Function; /* 0x03 */ 187212420Sken U16 PassthroughFlags; /* 0x04 */ 188212420Sken U8 SGLFlags; /* 0x06 */ 189212420Sken U8 MsgFlags; /* 0x07 */ 190212420Sken U8 VP_ID; /* 0x08 */ 191212420Sken U8 VF_ID; /* 0x09 */ 192212420Sken U16 Reserved1; /* 0x0A */ 193212420Sken U8 Reserved2; /* 0x0C */ 194212420Sken U8 SASStatus; /* 0x0D */ 195212420Sken U16 IOCStatus; /* 0x0E */ 196212420Sken U32 IOCLogInfo; /* 0x10 */ 197212420Sken U8 StatusFIS[20]; /* 0x14 */ 198212420Sken U32 StatusControlRegisters; /* 0x28 */ 199212420Sken U32 TransferCount; /* 0x2C */ 200212420Sken} MPI2_SATA_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REPLY, 201212420Sken Mpi2SataPassthroughReply_t, MPI2_POINTER pMpi2SataPassthroughReply_t; 202212420Sken 203212420Sken/* values for SASStatus field are at the top of this file */ 204212420Sken 205212420Sken 206212420Sken/**************************************************************************** 207212420Sken* SAS IO Unit Control messages 208212420Sken****************************************************************************/ 209212420Sken 210212420Sken/* SAS IO Unit Control Request Message */ 211212420Skentypedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST 212212420Sken{ 213212420Sken U8 Operation; /* 0x00 */ 214212420Sken U8 Reserved1; /* 0x01 */ 215212420Sken U8 ChainOffset; /* 0x02 */ 216212420Sken U8 Function; /* 0x03 */ 217212420Sken U16 DevHandle; /* 0x04 */ 218212420Sken U8 IOCParameter; /* 0x06 */ 219212420Sken U8 MsgFlags; /* 0x07 */ 220212420Sken U8 VP_ID; /* 0x08 */ 221212420Sken U8 VF_ID; /* 0x09 */ 222212420Sken U16 Reserved3; /* 0x0A */ 223212420Sken U16 Reserved4; /* 0x0C */ 224212420Sken U8 PhyNum; /* 0x0E */ 225212420Sken U8 PrimFlags; /* 0x0F */ 226212420Sken U32 Primitive; /* 0x10 */ 227212420Sken U8 LookupMethod; /* 0x14 */ 228212420Sken U8 Reserved5; /* 0x15 */ 229212420Sken U16 SlotNumber; /* 0x16 */ 230212420Sken U64 LookupAddress; /* 0x18 */ 231212420Sken U32 IOCParameterValue; /* 0x20 */ 232212420Sken U32 Reserved7; /* 0x24 */ 233212420Sken U32 Reserved8; /* 0x28 */ 234212420Sken} MPI2_SAS_IOUNIT_CONTROL_REQUEST, 235212420Sken MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST, 236212420Sken Mpi2SasIoUnitControlRequest_t, MPI2_POINTER pMpi2SasIoUnitControlRequest_t; 237212420Sken 238212420Sken/* values for the Operation field */ 239212420Sken#define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 240212420Sken#define MPI2_SAS_OP_PHY_LINK_RESET (0x06) 241212420Sken#define MPI2_SAS_OP_PHY_HARD_RESET (0x07) 242212420Sken#define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 243212420Sken#define MPI2_SAS_OP_SEND_PRIMITIVE (0x0A) 244212420Sken#define MPI2_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 245212420Sken#define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) 246212420Sken#define MPI2_SAS_OP_REMOVE_DEVICE (0x0D) 247212420Sken#define MPI2_SAS_OP_LOOKUP_MAPPING (0x0E) 248212420Sken#define MPI2_SAS_OP_SET_IOC_PARAMETER (0x0F) 249212420Sken#define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 250212420Sken 251212420Sken/* values for the PrimFlags field */ 252212420Sken#define MPI2_SAS_PRIMFLAGS_SINGLE (0x08) 253212420Sken#define MPI2_SAS_PRIMFLAGS_TRIPLE (0x02) 254212420Sken#define MPI2_SAS_PRIMFLAGS_REDUNDANT (0x01) 255212420Sken 256212420Sken/* values for the LookupMethod field */ 257212420Sken#define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS (0x01) 258212420Sken#define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT (0x02) 259212420Sken#define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME (0x03) 260212420Sken 261212420Sken 262212420Sken/* SAS IO Unit Control Reply Message */ 263212420Skentypedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY 264212420Sken{ 265212420Sken U8 Operation; /* 0x00 */ 266212420Sken U8 Reserved1; /* 0x01 */ 267212420Sken U8 MsgLength; /* 0x02 */ 268212420Sken U8 Function; /* 0x03 */ 269212420Sken U16 DevHandle; /* 0x04 */ 270212420Sken U8 IOCParameter; /* 0x06 */ 271212420Sken U8 MsgFlags; /* 0x07 */ 272212420Sken U8 VP_ID; /* 0x08 */ 273212420Sken U8 VF_ID; /* 0x09 */ 274212420Sken U16 Reserved3; /* 0x0A */ 275212420Sken U16 Reserved4; /* 0x0C */ 276212420Sken U16 IOCStatus; /* 0x0E */ 277212420Sken U32 IOCLogInfo; /* 0x10 */ 278212420Sken} MPI2_SAS_IOUNIT_CONTROL_REPLY, 279212420Sken MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY, 280212420Sken Mpi2SasIoUnitControlReply_t, MPI2_POINTER pMpi2SasIoUnitControlReply_t; 281212420Sken 282212420Sken 283212420Sken#endif 284212420Sken 285212420Sken 286