mpi2_sas.h revision 225736
1231858Sbz/* $FreeBSD: stable/9/sys/dev/mps/mpi/mpi2_sas.h 212420 2010-09-10 15:03:56Z ken $ */ 2231858Sbz/* 3231858Sbz * Copyright (c) 2000-2007 LSI Corporation. 4231858Sbz * 5231858Sbz * 6231858Sbz * Name: mpi2_sas.h 7231858Sbz * Title: MPI Serial Attached SCSI structures and definitions 8231858Sbz * Creation Date: February 9, 2007 9231858Sbz * 10231858Sbz * mpi2.h Version: 02.00.03 11231858Sbz * 12231858Sbz * Version History 13231858Sbz * --------------- 14231858Sbz * 15231858Sbz * Date Version Description 16231858Sbz * -------- -------- ------------------------------------------------------ 17231858Sbz * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A. 18231858Sbz * 06-26-07 02.00.01 Added Clear All Persistent Operation to SAS IO Unit 19231858Sbz * Control Request. 20231858Sbz * 10-02-08 02.00.02 Added Set IOC Parameter Operation to SAS IO Unit Control 21231858Sbz * Request. 22231858Sbz * 10-28-09 02.00.03 Changed the type of SGL in MPI2_SATA_PASSTHROUGH_REQUEST 23231858Sbz * to MPI2_SGE_IO_UNION since it supports chained SGLs. 24231858Sbz * -------------------------------------------------------------------------- 25231858Sbz */ 26231858Sbz 27231858Sbz#ifndef MPI2_SAS_H 28231858Sbz#define MPI2_SAS_H 29231858Sbz 30231858Sbz/* 31231858Sbz * Values for SASStatus. 32231858Sbz */ 33231858Sbz#define MPI2_SASSTATUS_SUCCESS (0x00) 34231858Sbz#define MPI2_SASSTATUS_UNKNOWN_ERROR (0x01) 35231858Sbz#define MPI2_SASSTATUS_INVALID_FRAME (0x02) 36231858Sbz#define MPI2_SASSTATUS_UTC_BAD_DEST (0x03) 37231858Sbz#define MPI2_SASSTATUS_UTC_BREAK_RECEIVED (0x04) 38231858Sbz#define MPI2_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05) 39231858Sbz#define MPI2_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06) 40231858Sbz#define MPI2_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07) 41231858Sbz#define MPI2_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08) 42231858Sbz#define MPI2_SASSTATUS_UTC_WRONG_DESTINATION (0x09) 43231858Sbz#define MPI2_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A) 44231858Sbz#define MPI2_SASSTATUS_LONG_INFORMATION_UNIT (0x0B) 45231858Sbz#define MPI2_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C) 46231858Sbz#define MPI2_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D) 47231858Sbz#define MPI2_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E) 48231858Sbz#define MPI2_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F) 49231858Sbz#define MPI2_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10) 50231858Sbz#define MPI2_SASSTATUS_DATA_OFFSET_ERROR (0x11) 51231858Sbz#define MPI2_SASSTATUS_SDSF_NAK_RECEIVED (0x12) 52231858Sbz#define MPI2_SASSTATUS_SDSF_CONNECTION_FAILED (0x13) 53231858Sbz#define MPI2_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14) 54231858Sbz 55231858Sbz 56231858Sbz/* 57231858Sbz * Values for the SAS DeviceInfo field used in SAS Device Status Change Event 58231858Sbz * data and SAS Configuration pages. 59231858Sbz */ 60231858Sbz#define MPI2_SAS_DEVICE_INFO_SEP (0x00004000) 61231858Sbz#define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000) 62231858Sbz#define MPI2_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000) 63231858Sbz#define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800) 64231858Sbz#define MPI2_SAS_DEVICE_INFO_SSP_TARGET (0x00000400) 65231858Sbz#define MPI2_SAS_DEVICE_INFO_STP_TARGET (0x00000200) 66231858Sbz#define MPI2_SAS_DEVICE_INFO_SMP_TARGET (0x00000100) 67231858Sbz#define MPI2_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080) 68231858Sbz#define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040) 69231858Sbz#define MPI2_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020) 70231858Sbz#define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010) 71231858Sbz#define MPI2_SAS_DEVICE_INFO_SATA_HOST (0x00000008) 72231858Sbz 73231858Sbz#define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007) 74231858Sbz#define MPI2_SAS_DEVICE_INFO_NO_DEVICE (0x00000000) 75231858Sbz#define MPI2_SAS_DEVICE_INFO_END_DEVICE (0x00000001) 76231858Sbz#define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002) 77231858Sbz#define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003) 78231858Sbz 79231858Sbz 80231858Sbz/***************************************************************************** 81231858Sbz* 82231858Sbz* SAS Messages 83231858Sbz* 84231858Sbz*****************************************************************************/ 85231858Sbz 86231858Sbz/**************************************************************************** 87231858Sbz* SMP Passthrough messages 88231858Sbz****************************************************************************/ 89231858Sbz 90231858Sbz/* SMP Passthrough Request Message */ 91231858Sbztypedef struct _MPI2_SMP_PASSTHROUGH_REQUEST 92231858Sbz{ 93231858Sbz U8 PassthroughFlags; /* 0x00 */ 94231858Sbz U8 PhysicalPort; /* 0x01 */ 95231858Sbz U8 ChainOffset; /* 0x02 */ 96231858Sbz U8 Function; /* 0x03 */ 97231858Sbz U16 RequestDataLength; /* 0x04 */ 98231858Sbz U8 SGLFlags; /* 0x06 */ 99231858Sbz U8 MsgFlags; /* 0x07 */ 100231858Sbz U8 VP_ID; /* 0x08 */ 101231858Sbz U8 VF_ID; /* 0x09 */ 102231858Sbz U16 Reserved1; /* 0x0A */ 103231858Sbz U32 Reserved2; /* 0x0C */ 104231858Sbz U64 SASAddress; /* 0x10 */ 105231858Sbz U32 Reserved3; /* 0x18 */ 106231858Sbz U32 Reserved4; /* 0x1C */ 107231858Sbz MPI2_SIMPLE_SGE_UNION SGL; /* 0x20 */ 108231858Sbz} MPI2_SMP_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REQUEST, 109231858Sbz Mpi2SmpPassthroughRequest_t, MPI2_POINTER pMpi2SmpPassthroughRequest_t; 110231858Sbz 111231858Sbz/* values for PassthroughFlags field */ 112231858Sbz#define MPI2_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80) 113231858Sbz 114231858Sbz/* values for SGLFlags field are in the SGL section of mpi2.h */ 115231858Sbz 116231858Sbz 117231858Sbz/* SMP Passthrough Reply Message */ 118231858Sbztypedef struct _MPI2_SMP_PASSTHROUGH_REPLY 119231858Sbz{ 120231858Sbz U8 PassthroughFlags; /* 0x00 */ 121231858Sbz U8 PhysicalPort; /* 0x01 */ 122231858Sbz U8 MsgLength; /* 0x02 */ 123231858Sbz U8 Function; /* 0x03 */ 124231858Sbz U16 ResponseDataLength; /* 0x04 */ 125231858Sbz U8 SGLFlags; /* 0x06 */ 126231858Sbz U8 MsgFlags; /* 0x07 */ 127231858Sbz U8 VP_ID; /* 0x08 */ 128231858Sbz U8 VF_ID; /* 0x09 */ 129231858Sbz U16 Reserved1; /* 0x0A */ 130231858Sbz U8 Reserved2; /* 0x0C */ 131231858Sbz U8 SASStatus; /* 0x0D */ 132231858Sbz U16 IOCStatus; /* 0x0E */ 133231858Sbz U32 IOCLogInfo; /* 0x10 */ 134231858Sbz U32 Reserved3; /* 0x14 */ 135231858Sbz U8 ResponseData[4]; /* 0x18 */ 136231858Sbz} MPI2_SMP_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REPLY, 137231858Sbz Mpi2SmpPassthroughReply_t, MPI2_POINTER pMpi2SmpPassthroughReply_t; 138231858Sbz 139231858Sbz/* values for PassthroughFlags field */ 140231858Sbz#define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80) 141231858Sbz 142231858Sbz/* values for SASStatus field are at the top of this file */ 143231858Sbz 144231858Sbz 145231858Sbz/**************************************************************************** 146231858Sbz* SATA Passthrough messages 147231858Sbz****************************************************************************/ 148231858Sbz 149231858Sbz/* SATA Passthrough Request Message */ 150231858Sbztypedef struct _MPI2_SATA_PASSTHROUGH_REQUEST 151231858Sbz{ 152231858Sbz U16 DevHandle; /* 0x00 */ 153231858Sbz U8 ChainOffset; /* 0x02 */ 154231858Sbz U8 Function; /* 0x03 */ 155231858Sbz U16 PassthroughFlags; /* 0x04 */ 156231858Sbz U8 SGLFlags; /* 0x06 */ 157231858Sbz U8 MsgFlags; /* 0x07 */ 158231858Sbz U8 VP_ID; /* 0x08 */ 159231858Sbz U8 VF_ID; /* 0x09 */ 160231858Sbz U16 Reserved1; /* 0x0A */ 161231858Sbz U32 Reserved2; /* 0x0C */ 162231858Sbz U32 Reserved3; /* 0x10 */ 163231858Sbz U32 Reserved4; /* 0x14 */ 164231858Sbz U32 DataLength; /* 0x18 */ 165231858Sbz U8 CommandFIS[20]; /* 0x1C */ 166231858Sbz MPI2_SGE_IO_UNION SGL; /* 0x20 */ 167231858Sbz} MPI2_SATA_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REQUEST, 168231858Sbz Mpi2SataPassthroughRequest_t, MPI2_POINTER pMpi2SataPassthroughRequest_t; 169231858Sbz 170231858Sbz/* values for PassthroughFlags field */ 171231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100) 172231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_DMA (0x0020) 173231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_PIO (0x0010) 174231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004) 175231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002) 176231858Sbz#define MPI2_SATA_PT_REQ_PT_FLAGS_READ (0x0001) 177231858Sbz 178231858Sbz/* values for SGLFlags field are in the SGL section of mpi2.h */ 179231858Sbz 180231858Sbz 181231858Sbz/* SATA Passthrough Reply Message */ 182231858Sbztypedef struct _MPI2_SATA_PASSTHROUGH_REPLY 183231858Sbz{ 184231858Sbz U16 DevHandle; /* 0x00 */ 185231858Sbz U8 MsgLength; /* 0x02 */ 186231858Sbz U8 Function; /* 0x03 */ 187231858Sbz U16 PassthroughFlags; /* 0x04 */ 188231858Sbz U8 SGLFlags; /* 0x06 */ 189231858Sbz U8 MsgFlags; /* 0x07 */ 190231858Sbz U8 VP_ID; /* 0x08 */ 191231858Sbz U8 VF_ID; /* 0x09 */ 192231858Sbz U16 Reserved1; /* 0x0A */ 193231858Sbz U8 Reserved2; /* 0x0C */ 194231858Sbz U8 SASStatus; /* 0x0D */ 195231858Sbz U16 IOCStatus; /* 0x0E */ 196231858Sbz U32 IOCLogInfo; /* 0x10 */ 197231858Sbz U8 StatusFIS[20]; /* 0x14 */ 198231858Sbz U32 StatusControlRegisters; /* 0x28 */ 199231858Sbz U32 TransferCount; /* 0x2C */ 200231858Sbz} MPI2_SATA_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REPLY, 201231858Sbz Mpi2SataPassthroughReply_t, MPI2_POINTER pMpi2SataPassthroughReply_t; 202231858Sbz 203231858Sbz/* values for SASStatus field are at the top of this file */ 204231858Sbz 205231858Sbz 206231858Sbz/**************************************************************************** 207231858Sbz* SAS IO Unit Control messages 208231858Sbz****************************************************************************/ 209231858Sbz 210231858Sbz/* SAS IO Unit Control Request Message */ 211231858Sbztypedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST 212231858Sbz{ 213231858Sbz U8 Operation; /* 0x00 */ 214231858Sbz U8 Reserved1; /* 0x01 */ 215231858Sbz U8 ChainOffset; /* 0x02 */ 216231858Sbz U8 Function; /* 0x03 */ 217231858Sbz U16 DevHandle; /* 0x04 */ 218231858Sbz U8 IOCParameter; /* 0x06 */ 219231858Sbz U8 MsgFlags; /* 0x07 */ 220231858Sbz U8 VP_ID; /* 0x08 */ 221231858Sbz U8 VF_ID; /* 0x09 */ 222231858Sbz U16 Reserved3; /* 0x0A */ 223231858Sbz U16 Reserved4; /* 0x0C */ 224231858Sbz U8 PhyNum; /* 0x0E */ 225232114Sbz U8 PrimFlags; /* 0x0F */ 226231858Sbz U32 Primitive; /* 0x10 */ 227231858Sbz U8 LookupMethod; /* 0x14 */ 228231858Sbz U8 Reserved5; /* 0x15 */ 229231858Sbz U16 SlotNumber; /* 0x16 */ 230231858Sbz U64 LookupAddress; /* 0x18 */ 231232114Sbz U32 IOCParameterValue; /* 0x20 */ 232232114Sbz U32 Reserved7; /* 0x24 */ 233231858Sbz U32 Reserved8; /* 0x28 */ 234232114Sbz} MPI2_SAS_IOUNIT_CONTROL_REQUEST, 235231858Sbz MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST, 236231858Sbz Mpi2SasIoUnitControlRequest_t, MPI2_POINTER pMpi2SasIoUnitControlRequest_t; 237231858Sbz 238232114Sbz/* values for the Operation field */ 239231858Sbz#define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT (0x02) 240232114Sbz#define MPI2_SAS_OP_PHY_LINK_RESET (0x06) 241231858Sbz#define MPI2_SAS_OP_PHY_HARD_RESET (0x07) 242232114Sbz#define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08) 243231858Sbz#define MPI2_SAS_OP_SEND_PRIMITIVE (0x0A) 244231858Sbz#define MPI2_SAS_OP_FORCE_FULL_DISCOVERY (0x0B) 245232114Sbz#define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C) 246231858Sbz#define MPI2_SAS_OP_REMOVE_DEVICE (0x0D) 247232114Sbz#define MPI2_SAS_OP_LOOKUP_MAPPING (0x0E) 248231858Sbz#define MPI2_SAS_OP_SET_IOC_PARAMETER (0x0F) 249231858Sbz#define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80) 250232114Sbz 251231858Sbz/* values for the PrimFlags field */ 252232114Sbz#define MPI2_SAS_PRIMFLAGS_SINGLE (0x08) 253231858Sbz#define MPI2_SAS_PRIMFLAGS_TRIPLE (0x02) 254232114Sbz#define MPI2_SAS_PRIMFLAGS_REDUNDANT (0x01) 255231858Sbz 256231858Sbz/* values for the LookupMethod field */ 257231858Sbz#define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS (0x01) 258231858Sbz#define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT (0x02) 259231858Sbz#define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME (0x03) 260231858Sbz 261231858Sbz 262231858Sbz/* SAS IO Unit Control Reply Message */ 263231858Sbztypedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY 264231858Sbz{ 265231858Sbz U8 Operation; /* 0x00 */ 266231858Sbz U8 Reserved1; /* 0x01 */ 267231858Sbz U8 MsgLength; /* 0x02 */ 268231858Sbz U8 Function; /* 0x03 */ 269231858Sbz U16 DevHandle; /* 0x04 */ 270231858Sbz U8 IOCParameter; /* 0x06 */ 271231858Sbz U8 MsgFlags; /* 0x07 */ 272231858Sbz U8 VP_ID; /* 0x08 */ 273231858Sbz U8 VF_ID; /* 0x09 */ 274231858Sbz U16 Reserved3; /* 0x0A */ 275231858Sbz U16 Reserved4; /* 0x0C */ 276231858Sbz U16 IOCStatus; /* 0x0E */ 277231858Sbz U32 IOCLogInfo; /* 0x10 */ 278231858Sbz} MPI2_SAS_IOUNIT_CONTROL_REPLY, 279231858Sbz MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY, 280231858Sbz Mpi2SasIoUnitControlReply_t, MPI2_POINTER pMpi2SasIoUnitControlReply_t; 281231858Sbz 282231858Sbz 283231858Sbz#endif 284231858Sbz 285231858Sbz 286231858Sbz