Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mpi2_sas.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2010 LSI Corporation.
3  *
4  *
5  * Name: mpi2_sas.h
6  * Title: MPI Serial Attached SCSI structures and definitions
7  * Creation Date: February 9, 2007
8  *
9  * mpi2_sas.h Version: 02.00.05
10  *
11  * Version History
12  * ---------------
13  *
14  * Date Version Description
15  * -------- -------- ------------------------------------------------------
16  * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
17  * 06-26-07 02.00.01 Added Clear All Persistent Operation to SAS IO Unit
18  * Control Request.
19  * 10-02-08 02.00.02 Added Set IOC Parameter Operation to SAS IO Unit Control
20  * Request.
21  * 10-28-09 02.00.03 Changed the type of SGL in MPI2_SATA_PASSTHROUGH_REQUEST
22  * to MPI2_SGE_IO_UNION since it supports chained SGLs.
23  * 05-12-10 02.00.04 Modified some comments.
24  * 08-11-10 02.00.05 Added NCQ operations to SAS IO Unit Control.
25  * --------------------------------------------------------------------------
26  */
27 
28 #ifndef MPI2_SAS_H
29 #define MPI2_SAS_H
30 
31 /*
32  * Values for SASStatus.
33  */
34 #define MPI2_SASSTATUS_SUCCESS (0x00)
35 #define MPI2_SASSTATUS_UNKNOWN_ERROR (0x01)
36 #define MPI2_SASSTATUS_INVALID_FRAME (0x02)
37 #define MPI2_SASSTATUS_UTC_BAD_DEST (0x03)
38 #define MPI2_SASSTATUS_UTC_BREAK_RECEIVED (0x04)
39 #define MPI2_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05)
40 #define MPI2_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06)
41 #define MPI2_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07)
42 #define MPI2_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08)
43 #define MPI2_SASSTATUS_UTC_WRONG_DESTINATION (0x09)
44 #define MPI2_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A)
45 #define MPI2_SASSTATUS_LONG_INFORMATION_UNIT (0x0B)
46 #define MPI2_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C)
47 #define MPI2_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D)
48 #define MPI2_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E)
49 #define MPI2_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F)
50 #define MPI2_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10)
51 #define MPI2_SASSTATUS_DATA_OFFSET_ERROR (0x11)
52 #define MPI2_SASSTATUS_SDSF_NAK_RECEIVED (0x12)
53 #define MPI2_SASSTATUS_SDSF_CONNECTION_FAILED (0x13)
54 #define MPI2_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14)
55 
56 
57 /*
58  * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
59  * data and SAS Configuration pages.
60  */
61 #define MPI2_SAS_DEVICE_INFO_SEP (0x00004000)
62 #define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000)
63 #define MPI2_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000)
64 #define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800)
65 #define MPI2_SAS_DEVICE_INFO_SSP_TARGET (0x00000400)
66 #define MPI2_SAS_DEVICE_INFO_STP_TARGET (0x00000200)
67 #define MPI2_SAS_DEVICE_INFO_SMP_TARGET (0x00000100)
68 #define MPI2_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080)
69 #define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040)
70 #define MPI2_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020)
71 #define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010)
72 #define MPI2_SAS_DEVICE_INFO_SATA_HOST (0x00000008)
73 
74 #define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007)
75 #define MPI2_SAS_DEVICE_INFO_NO_DEVICE (0x00000000)
76 #define MPI2_SAS_DEVICE_INFO_END_DEVICE (0x00000001)
77 #define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002)
78 #define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003)
79 
80 
81 /*****************************************************************************
82 *
83 * SAS Messages
84 *
85 *****************************************************************************/
86 
87 /****************************************************************************
88 * SMP Passthrough messages
89 ****************************************************************************/
90 
91 /* SMP Passthrough Request Message */
92 typedef struct _MPI2_SMP_PASSTHROUGH_REQUEST
93 {
94  U8 PassthroughFlags; /* 0x00 */
95  U8 PhysicalPort; /* 0x01 */
96  U8 ChainOffset; /* 0x02 */
97  U8 Function; /* 0x03 */
98  U16 RequestDataLength; /* 0x04 */
99  U8 SGLFlags; /* 0x06 */
100  U8 MsgFlags; /* 0x07 */
101  U8 VP_ID; /* 0x08 */
102  U8 VF_ID; /* 0x09 */
103  U16 Reserved1; /* 0x0A */
104  U32 Reserved2; /* 0x0C */
105  U64 SASAddress; /* 0x10 */
106  U32 Reserved3; /* 0x18 */
107  U32 Reserved4; /* 0x1C */
108  MPI2_SIMPLE_SGE_UNION SGL; /* 0x20 */
109 } MPI2_SMP_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REQUEST,
110  Mpi2SmpPassthroughRequest_t, MPI2_POINTER pMpi2SmpPassthroughRequest_t;
111 
112 /* values for PassthroughFlags field */
113 #define MPI2_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80)
114 
115 /* use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */
116 
117 
118 /* SMP Passthrough Reply Message */
119 typedef struct _MPI2_SMP_PASSTHROUGH_REPLY
120 {
121  U8 PassthroughFlags; /* 0x00 */
122  U8 PhysicalPort; /* 0x01 */
123  U8 MsgLength; /* 0x02 */
124  U8 Function; /* 0x03 */
125  U16 ResponseDataLength; /* 0x04 */
126  U8 SGLFlags; /* 0x06 */
127  U8 MsgFlags; /* 0x07 */
128  U8 VP_ID; /* 0x08 */
129  U8 VF_ID; /* 0x09 */
130  U16 Reserved1; /* 0x0A */
131  U8 Reserved2; /* 0x0C */
132  U8 SASStatus; /* 0x0D */
133  U16 IOCStatus; /* 0x0E */
134  U32 IOCLogInfo; /* 0x10 */
135  U32 Reserved3; /* 0x14 */
136  U8 ResponseData[4]; /* 0x18 */
137 } MPI2_SMP_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REPLY,
138  Mpi2SmpPassthroughReply_t, MPI2_POINTER pMpi2SmpPassthroughReply_t;
139 
140 /* values for PassthroughFlags field */
141 #define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80)
142 
143 /* values for SASStatus field are at the top of this file */
144 
145 
146 /****************************************************************************
147 * SATA Passthrough messages
148 ****************************************************************************/
149 
150 /* SATA Passthrough Request Message */
151 typedef struct _MPI2_SATA_PASSTHROUGH_REQUEST
152 {
153  U16 DevHandle; /* 0x00 */
154  U8 ChainOffset; /* 0x02 */
155  U8 Function; /* 0x03 */
156  U16 PassthroughFlags; /* 0x04 */
157  U8 SGLFlags; /* 0x06 */
158  U8 MsgFlags; /* 0x07 */
159  U8 VP_ID; /* 0x08 */
160  U8 VF_ID; /* 0x09 */
161  U16 Reserved1; /* 0x0A */
162  U32 Reserved2; /* 0x0C */
163  U32 Reserved3; /* 0x10 */
164  U32 Reserved4; /* 0x14 */
165  U32 DataLength; /* 0x18 */
166  U8 CommandFIS[20]; /* 0x1C */
167  MPI2_SGE_IO_UNION SGL; /* 0x30 */
168 } MPI2_SATA_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REQUEST,
169  Mpi2SataPassthroughRequest_t, MPI2_POINTER pMpi2SataPassthroughRequest_t;
170 
171 /* values for PassthroughFlags field */
172 #define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100)
173 #define MPI2_SATA_PT_REQ_PT_FLAGS_DMA (0x0020)
174 #define MPI2_SATA_PT_REQ_PT_FLAGS_PIO (0x0010)
175 #define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004)
176 #define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002)
177 #define MPI2_SATA_PT_REQ_PT_FLAGS_READ (0x0001)
178 
179 /* use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */
180 
181 
182 /* SATA Passthrough Reply Message */
183 typedef struct _MPI2_SATA_PASSTHROUGH_REPLY
184 {
185  U16 DevHandle; /* 0x00 */
186  U8 MsgLength; /* 0x02 */
187  U8 Function; /* 0x03 */
188  U16 PassthroughFlags; /* 0x04 */
189  U8 SGLFlags; /* 0x06 */
190  U8 MsgFlags; /* 0x07 */
191  U8 VP_ID; /* 0x08 */
192  U8 VF_ID; /* 0x09 */
193  U16 Reserved1; /* 0x0A */
194  U8 Reserved2; /* 0x0C */
195  U8 SASStatus; /* 0x0D */
196  U16 IOCStatus; /* 0x0E */
197  U32 IOCLogInfo; /* 0x10 */
198  U8 StatusFIS[20]; /* 0x14 */
199  U32 StatusControlRegisters; /* 0x28 */
200  U32 TransferCount; /* 0x2C */
201 } MPI2_SATA_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REPLY,
202  Mpi2SataPassthroughReply_t, MPI2_POINTER pMpi2SataPassthroughReply_t;
203 
204 /* values for SASStatus field are at the top of this file */
205 
206 
207 /****************************************************************************
208 * SAS IO Unit Control messages
209 ****************************************************************************/
210 
211 /* SAS IO Unit Control Request Message */
212 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST
213 {
214  U8 Operation; /* 0x00 */
215  U8 Reserved1; /* 0x01 */
216  U8 ChainOffset; /* 0x02 */
217  U8 Function; /* 0x03 */
218  U16 DevHandle; /* 0x04 */
219  U8 IOCParameter; /* 0x06 */
220  U8 MsgFlags; /* 0x07 */
221  U8 VP_ID; /* 0x08 */
222  U8 VF_ID; /* 0x09 */
223  U16 Reserved3; /* 0x0A */
224  U16 Reserved4; /* 0x0C */
225  U8 PhyNum; /* 0x0E */
226  U8 PrimFlags; /* 0x0F */
227  U32 Primitive; /* 0x10 */
228  U8 LookupMethod; /* 0x14 */
229  U8 Reserved5; /* 0x15 */
230  U16 SlotNumber; /* 0x16 */
231  U64 LookupAddress; /* 0x18 */
232  U32 IOCParameterValue; /* 0x20 */
233  U32 Reserved7; /* 0x24 */
234  U32 Reserved8; /* 0x28 */
235 } MPI2_SAS_IOUNIT_CONTROL_REQUEST,
236  MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST,
237  Mpi2SasIoUnitControlRequest_t, MPI2_POINTER pMpi2SasIoUnitControlRequest_t;
238 
239 /* values for the Operation field */
240 #define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT (0x02)
241 #define MPI2_SAS_OP_PHY_LINK_RESET (0x06)
242 #define MPI2_SAS_OP_PHY_HARD_RESET (0x07)
243 #define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08)
244 #define MPI2_SAS_OP_SEND_PRIMITIVE (0x0A)
245 #define MPI2_SAS_OP_FORCE_FULL_DISCOVERY (0x0B)
246 #define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C)
247 #define MPI2_SAS_OP_REMOVE_DEVICE (0x0D)
248 #define MPI2_SAS_OP_LOOKUP_MAPPING (0x0E)
249 #define MPI2_SAS_OP_SET_IOC_PARAMETER (0x0F)
250 #define MPI2_SAS_OP_DEV_ENABLE_NCQ (0x14)
251 #define MPI2_SAS_OP_DEV_DISABLE_NCQ (0x15)
252 #define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80)
253 
254 /* values for the PrimFlags field */
255 #define MPI2_SAS_PRIMFLAGS_SINGLE (0x08)
256 #define MPI2_SAS_PRIMFLAGS_TRIPLE (0x02)
257 #define MPI2_SAS_PRIMFLAGS_REDUNDANT (0x01)
258 
259 /* values for the LookupMethod field */
260 #define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS (0x01)
261 #define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT (0x02)
262 #define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME (0x03)
263 
264 
265 /* SAS IO Unit Control Reply Message */
266 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY
267 {
268  U8 Operation; /* 0x00 */
269  U8 Reserved1; /* 0x01 */
270  U8 MsgLength; /* 0x02 */
271  U8 Function; /* 0x03 */
272  U16 DevHandle; /* 0x04 */
273  U8 IOCParameter; /* 0x06 */
274  U8 MsgFlags; /* 0x07 */
275  U8 VP_ID; /* 0x08 */
276  U8 VF_ID; /* 0x09 */
277  U16 Reserved3; /* 0x0A */
278  U16 Reserved4; /* 0x0C */
279  U16 IOCStatus; /* 0x0E */
280  U32 IOCLogInfo; /* 0x10 */
281 } MPI2_SAS_IOUNIT_CONTROL_REPLY,
282  MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY,
283  Mpi2SasIoUnitControlReply_t, MPI2_POINTER pMpi2SasIoUnitControlReply_t;
284 
285 
286 #endif
287 
288 
Generated on Thu Jan 10 2013 14:22:32 for Linux Kernel by   doxygen 1.8.2