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