Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mpi_sas.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2004-2008 LSI Corporation.
3  *
4  *
5  * Name: mpi_sas.h
6  * Title: MPI Serial Attached SCSI structures and definitions
7  * Creation Date: August 19, 2004
8  *
9  * mpi_sas.h Version: 01.05.05
10  *
11  * Version History
12  * ---------------
13  *
14  * Date Version Description
15  * -------- -------- ------------------------------------------------------
16  * 08-19-04 01.05.01 Original release.
17  * 08-30-05 01.05.02 Added DeviceInfo bit for SEP.
18  * Added PrimFlags and Primitive field to SAS IO Unit
19  * Control request, and added a new operation code.
20  * 03-27-06 01.05.03 Added Force Full Discovery, Transmit Port Select Signal,
21  * and Remove Device operations to SAS IO Unit Control.
22  * Added DevHandle field to SAS IO Unit Control request and
23  * reply.
24  * 10-11-06 01.05.04 Fixed the name of a define for Operation field of SAS IO
25  * Unit Control request.
26  * 01-15-08 01.05.05 Added support for MPI_SAS_OP_SET_IOC_PARAMETER,
27  * including adding IOCParameter and IOCParameter value
28  * fields to SAS IO Unit Control Request.
29  * Added MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC define.
30  * --------------------------------------------------------------------------
31  */
32 
33 #ifndef MPI_SAS_H
34 #define MPI_SAS_H
35 
36 
37 /*
38  * Values for SASStatus.
39  */
40 #define MPI_SASSTATUS_SUCCESS (0x00)
41 #define MPI_SASSTATUS_UNKNOWN_ERROR (0x01)
42 #define MPI_SASSTATUS_INVALID_FRAME (0x02)
43 #define MPI_SASSTATUS_UTC_BAD_DEST (0x03)
44 #define MPI_SASSTATUS_UTC_BREAK_RECEIVED (0x04)
45 #define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED (0x05)
46 #define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST (0x06)
47 #define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED (0x07)
48 #define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY (0x08)
49 #define MPI_SASSTATUS_UTC_WRONG_DESTINATION (0x09)
50 #define MPI_SASSTATUS_SHORT_INFORMATION_UNIT (0x0A)
51 #define MPI_SASSTATUS_LONG_INFORMATION_UNIT (0x0B)
52 #define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA (0x0C)
53 #define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR (0x0D)
54 #define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED (0x0E)
55 #define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH (0x0F)
56 #define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA (0x10)
57 #define MPI_SASSTATUS_DATA_OFFSET_ERROR (0x11)
58 #define MPI_SASSTATUS_SDSF_NAK_RECEIVED (0x12)
59 #define MPI_SASSTATUS_SDSF_CONNECTION_FAILED (0x13)
60 #define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT (0x14)
61 
62 
63 /*
64  * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
65  * data and SAS IO Unit Configuration pages.
66  */
67 #define MPI_SAS_DEVICE_INFO_PRODUCT_SPECIFIC (0xF0000000)
68 
69 #define MPI_SAS_DEVICE_INFO_SEP (0x00004000)
70 #define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE (0x00002000)
71 #define MPI_SAS_DEVICE_INFO_LSI_DEVICE (0x00001000)
72 #define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH (0x00000800)
73 #define MPI_SAS_DEVICE_INFO_SSP_TARGET (0x00000400)
74 #define MPI_SAS_DEVICE_INFO_STP_TARGET (0x00000200)
75 #define MPI_SAS_DEVICE_INFO_SMP_TARGET (0x00000100)
76 #define MPI_SAS_DEVICE_INFO_SATA_DEVICE (0x00000080)
77 #define MPI_SAS_DEVICE_INFO_SSP_INITIATOR (0x00000040)
78 #define MPI_SAS_DEVICE_INFO_STP_INITIATOR (0x00000020)
79 #define MPI_SAS_DEVICE_INFO_SMP_INITIATOR (0x00000010)
80 #define MPI_SAS_DEVICE_INFO_SATA_HOST (0x00000008)
81 
82 #define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007)
83 #define MPI_SAS_DEVICE_INFO_NO_DEVICE (0x00000000)
84 #define MPI_SAS_DEVICE_INFO_END_DEVICE (0x00000001)
85 #define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER (0x00000002)
86 #define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER (0x00000003)
87 
88 
89 
90 /*****************************************************************************
91 *
92 * 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
93 *
94 *****************************************************************************/
95 
96 /****************************************************************************/
97 /* Serial Management Protocol Passthrough Request */
98 /****************************************************************************/
99 
100 typedef struct _MSG_SMP_PASSTHROUGH_REQUEST
101 {
102  U8 PassthroughFlags; /* 00h */
103  U8 PhysicalPort; /* 01h */
104  U8 ChainOffset; /* 02h */
105  U8 Function; /* 03h */
106  U16 RequestDataLength; /* 04h */
107  U8 ConnectionRate; /* 06h */
108  U8 MsgFlags; /* 07h */
109  U32 MsgContext; /* 08h */
110  U32 Reserved1; /* 0Ch */
111  U64 SASAddress; /* 10h */
112  U32 Reserved2; /* 18h */
113  U32 Reserved3; /* 1Ch */
114  SGE_SIMPLE_UNION SGL; /* 20h */
115 } MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST,
116  SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t;
117 
118 /* values for PassthroughFlags field */
119 #define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE (0x80)
120 
121 /* values for ConnectionRate field */
122 #define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00)
123 #define MPI_SMP_PT_REQ_CONNECT_RATE_1_5 (0x08)
124 #define MPI_SMP_PT_REQ_CONNECT_RATE_3_0 (0x09)
125 
126 
127 /* Serial Management Protocol Passthrough Reply */
128 typedef struct _MSG_SMP_PASSTHROUGH_REPLY
129 {
130  U8 PassthroughFlags; /* 00h */
131  U8 PhysicalPort; /* 01h */
132  U8 MsgLength; /* 02h */
133  U8 Function; /* 03h */
134  U16 ResponseDataLength; /* 04h */
135  U8 Reserved1; /* 06h */
136  U8 MsgFlags; /* 07h */
137  U32 MsgContext; /* 08h */
138  U8 Reserved2; /* 0Ch */
139  U8 SASStatus; /* 0Dh */
140  U16 IOCStatus; /* 0Eh */
141  U32 IOCLogInfo; /* 10h */
142  U32 Reserved3; /* 14h */
143  U8 ResponseData[4]; /* 18h */
144 } MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY,
145  SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t;
146 
147 #define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE (0x80)
148 
149 
150 /****************************************************************************/
151 /* SATA Passthrough Request */
152 /****************************************************************************/
153 
154 typedef struct _MSG_SATA_PASSTHROUGH_REQUEST
155 {
156  U8 TargetID; /* 00h */
157  U8 Bus; /* 01h */
158  U8 ChainOffset; /* 02h */
159  U8 Function; /* 03h */
160  U16 PassthroughFlags; /* 04h */
161  U8 ConnectionRate; /* 06h */
162  U8 MsgFlags; /* 07h */
163  U32 MsgContext; /* 08h */
164  U32 Reserved1; /* 0Ch */
165  U32 Reserved2; /* 10h */
166  U32 Reserved3; /* 14h */
167  U32 DataLength; /* 18h */
168  U8 CommandFIS[20]; /* 1Ch */
169  SGE_SIMPLE_UNION SGL; /* 30h */
170 } MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST,
171  SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t;
172 
173 /* values for PassthroughFlags field */
174 #define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE (0x0200)
175 #define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG (0x0100)
176 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED (0x0080)
177 #define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040)
178 #define MPI_SATA_PT_REQ_PT_FLAGS_DMA (0x0020)
179 #define MPI_SATA_PT_REQ_PT_FLAGS_PIO (0x0010)
180 #define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004)
181 #define MPI_SATA_PT_REQ_PT_FLAGS_WRITE (0x0002)
182 #define MPI_SATA_PT_REQ_PT_FLAGS_READ (0x0001)
183 
184 /* values for ConnectionRate field */
185 #define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00)
186 #define MPI_SATA_PT_REQ_CONNECT_RATE_1_5 (0x08)
187 #define MPI_SATA_PT_REQ_CONNECT_RATE_3_0 (0x09)
188 
189 
190 /* SATA Passthrough Reply */
191 typedef struct _MSG_SATA_PASSTHROUGH_REPLY
192 {
193  U8 TargetID; /* 00h */
194  U8 Bus; /* 01h */
195  U8 MsgLength; /* 02h */
196  U8 Function; /* 03h */
197  U16 PassthroughFlags; /* 04h */
198  U8 Reserved1; /* 06h */
199  U8 MsgFlags; /* 07h */
200  U32 MsgContext; /* 08h */
201  U8 Reserved2; /* 0Ch */
202  U8 SASStatus; /* 0Dh */
203  U16 IOCStatus; /* 0Eh */
204  U32 IOCLogInfo; /* 10h */
205  U8 StatusFIS[20]; /* 14h */
206  U32 StatusControlRegisters; /* 28h */
207  U32 TransferCount; /* 2Ch */
208 } MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY,
209  SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t;
210 
211 
212 
213 
214 /****************************************************************************/
215 /* SAS IO Unit Control Request */
216 /****************************************************************************/
217 
218 typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST
219 {
220  U8 Operation; /* 00h */
221  U8 Reserved1; /* 01h */
222  U8 ChainOffset; /* 02h */
223  U8 Function; /* 03h */
224  U16 DevHandle; /* 04h */
225  U8 IOCParameter; /* 06h */
226  U8 MsgFlags; /* 07h */
227  U32 MsgContext; /* 08h */
228  U8 TargetID; /* 0Ch */
229  U8 Bus; /* 0Dh */
230  U8 PhyNum; /* 0Eh */
231  U8 PrimFlags; /* 0Fh */
232  U32 Primitive; /* 10h */
233  U64 SASAddress; /* 14h */
234  U32 IOCParameterValue; /* 1Ch */
235 } MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST,
236  SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t;
237 
238 /* values for the Operation field */
239 #define MPI_SAS_OP_CLEAR_NOT_PRESENT (0x01)
240 #define MPI_SAS_OP_CLEAR_ALL_PERSISTENT (0x02)
241 #define MPI_SAS_OP_PHY_LINK_RESET (0x06)
242 #define MPI_SAS_OP_PHY_HARD_RESET (0x07)
243 #define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG (0x08)
244 #define MPI_SAS_OP_MAP_CURRENT (0x09)
245 #define MPI_SAS_OP_SEND_PRIMITIVE (0x0A)
246 #define MPI_SAS_OP_FORCE_FULL_DISCOVERY (0x0B)
247 #define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C)
248 #define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE (0x0D) /* obsolete name */
249 #define MPI_SAS_OP_REMOVE_DEVICE (0x0D)
250 #define MPI_SAS_OP_SET_IOC_PARAMETER (0x0E)
251 #define MPI_SAS_OP_PRODUCT_SPECIFIC_MIN (0x80)
252 
253 /* values for the PrimFlags field */
254 #define MPI_SAS_PRIMFLAGS_SINGLE (0x08)
255 #define MPI_SAS_PRIMFLAGS_TRIPLE (0x02)
256 #define MPI_SAS_PRIMFLAGS_REDUNDANT (0x01)
257 
258 
259 /* SAS IO Unit Control Reply */
260 typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY
261 {
262  U8 Operation; /* 00h */
263  U8 Reserved1; /* 01h */
264  U8 MsgLength; /* 02h */
265  U8 Function; /* 03h */
266  U16 DevHandle; /* 04h */
267  U8 IOCParameter; /* 06h */
268  U8 MsgFlags; /* 07h */
269  U32 MsgContext; /* 08h */
270  U16 Reserved4; /* 0Ch */
271  U16 IOCStatus; /* 0Eh */
272  U32 IOCLogInfo; /* 10h */
273 } MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY,
274  SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t;
275 
276 #endif
277 
278 
Generated on Thu Jan 10 2013 13:53:11 for Linux Kernel by   doxygen 1.8.2