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