1 /*
2  * Copyright 2000-2015 Avago Technologies.  All rights reserved.
3  *
4  *
5  *          Name:  mpi2_init.h
6  *         Title:  MPI SCSI initiator mode messages and structures
7  * Creation Date:  June 23, 2006
8  *
9  * mpi2_init.h Version:  02.00.17
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  * 10-31-07  02.00.01  Fixed name for pMpi2SCSITaskManagementRequest_t.
23  * 12-18-07  02.00.02  Modified Task Management Target Reset Method defines.
24  * 02-29-08  02.00.03  Added Query Task Set and Query Unit Attention.
25  * 03-03-08  02.00.04  Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
26  * 05-21-08  02.00.05  Fixed typo in name of Mpi2SepRequest_t.
27  * 10-02-08  02.00.06  Removed Untagged and No Disconnect values from SCSI IO
28  *                     Control field Task Attribute flags.
29  *                     Moved LUN field defines to mpi2.h becasue they are
30  *                     common to many structures.
31  * 05-06-09  02.00.07  Changed task management type of Query Unit Attention to
32  *                     Query Asynchronous Event.
33  *                     Defined two new bits in the SlotStatus field of the SCSI
34  *                     Enclosure Processor Request and Reply.
35  * 10-28-09  02.00.08  Added defines for decoding the ResponseInfo bytes for
36  *                     both SCSI IO Error Reply and SCSI Task Management Reply.
37  *                     Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
38  *                     Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
39  * 02-10-10  02.00.09  Removed unused structure that had "#if 0" around it.
40  * 05-12-10  02.00.10  Added optional vendor-unique region to SCSI IO Request.
41  * 11-10-10  02.00.11  Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
42  * 11-18-11  02.00.12  Incorporating additions for MPI v2.5.
43  * 02-06-12  02.00.13  Added alternate defines for Task Priority / Command
44  *                     Priority to match SAM-4.
45  *                     Added EEDPErrorOffset to MPI2_SCSI_IO_REPLY.
46  * 07-10-12  02.00.14  Added MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION.
47  * 04-09-13  02.00.15  Added SCSIStatusQualifier field to MPI2_SCSI_IO_REPLY,
48  *                     replacing the Reserved4 field.
49  * 11-18-14  02.00.16  Updated copyright information.
50  * 03-xx-15  02.00.17  Updated for MPI v2.6.
51  *                     Added MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF and
52  *                     MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF.
53  * --------------------------------------------------------------------------
54  */
55 
56 #ifndef MPI2_INIT_H
57 #define MPI2_INIT_H
58 
59 /*****************************************************************************
60 *
61 *              SCSI Initiator Messages
62 *
63 *****************************************************************************/
64 
65 /****************************************************************************
66 * SCSI IO messages and associated structures
67 ****************************************************************************/
68 
69 typedef struct _MPI2_SCSI_IO_CDB_EEDP32 {
70 	U8 CDB[20];		/*0x00 */
71 	U32 PrimaryReferenceTag;	/*0x14 */
72 	U16 PrimaryApplicationTag;	/*0x18 */
73 	U16 PrimaryApplicationTagMask;	/*0x1A */
74 	U32 TransferLength;	/*0x1C */
75 } MPI2_SCSI_IO_CDB_EEDP32, *PTR_MPI2_SCSI_IO_CDB_EEDP32,
76 	Mpi2ScsiIoCdbEedp32_t, *pMpi2ScsiIoCdbEedp32_t;
77 
78 /*MPI v2.0 CDB field */
79 typedef union _MPI2_SCSI_IO_CDB_UNION {
80 	U8 CDB32[32];
81 	MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
82 	MPI2_SGE_SIMPLE_UNION SGE;
83 } MPI2_SCSI_IO_CDB_UNION, *PTR_MPI2_SCSI_IO_CDB_UNION,
84 	Mpi2ScsiIoCdb_t, *pMpi2ScsiIoCdb_t;
85 
86 /*MPI v2.0 SCSI IO Request Message */
87 typedef struct _MPI2_SCSI_IO_REQUEST {
88 	U16 DevHandle;		/*0x00 */
89 	U8 ChainOffset;		/*0x02 */
90 	U8 Function;		/*0x03 */
91 	U16 Reserved1;		/*0x04 */
92 	U8 Reserved2;		/*0x06 */
93 	U8 MsgFlags;		/*0x07 */
94 	U8 VP_ID;		/*0x08 */
95 	U8 VF_ID;		/*0x09 */
96 	U16 Reserved3;		/*0x0A */
97 	U32 SenseBufferLowAddress;	/*0x0C */
98 	U16 SGLFlags;		/*0x10 */
99 	U8 SenseBufferLength;	/*0x12 */
100 	U8 Reserved4;		/*0x13 */
101 	U8 SGLOffset0;		/*0x14 */
102 	U8 SGLOffset1;		/*0x15 */
103 	U8 SGLOffset2;		/*0x16 */
104 	U8 SGLOffset3;		/*0x17 */
105 	U32 SkipCount;		/*0x18 */
106 	U32 DataLength;		/*0x1C */
107 	U32 BidirectionalDataLength;	/*0x20 */
108 	U16 IoFlags;		/*0x24 */
109 	U16 EEDPFlags;		/*0x26 */
110 	U32 EEDPBlockSize;	/*0x28 */
111 	U32 SecondaryReferenceTag;	/*0x2C */
112 	U16 SecondaryApplicationTag;	/*0x30 */
113 	U16 ApplicationTagTranslationMask;	/*0x32 */
114 	U8 LUN[8];		/*0x34 */
115 	U32 Control;		/*0x3C */
116 	MPI2_SCSI_IO_CDB_UNION CDB;	/*0x40 */
117 
118 #ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /*typically this is left undefined */
119 	MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion;
120 #endif
121 
122 	MPI2_SGE_IO_UNION SGL;	/*0x60 */
123 
124 } MPI2_SCSI_IO_REQUEST, *PTR_MPI2_SCSI_IO_REQUEST,
125 	Mpi2SCSIIORequest_t, *pMpi2SCSIIORequest_t;
126 
127 /*SCSI IO MsgFlags bits */
128 
129 /*MsgFlags for SenseBufferAddressSpace */
130 #define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR        (0x0C)
131 #define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR      (0x00)
132 #define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR      (0x04)
133 #define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR      (0x08)
134 #define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR   (0x0C)
135 #define MPI26_SCSIIO_MSGFLAGS_IOCCTL_SENSE_ADDR     (0x08)
136 
137 /*SCSI IO SGLFlags bits */
138 
139 /*base values for Data Location Address Space */
140 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK              (0x0C)
141 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR            (0x00)
142 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR            (0x04)
143 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR            (0x08)
144 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR         (0x0C)
145 
146 /*base values for Type */
147 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK              (0x03)
148 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI               (0x00)
149 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32            (0x01)
150 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64            (0x02)
151 
152 /*shift values for each sub-field */
153 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT             (12)
154 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT             (8)
155 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT             (4)
156 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT             (0)
157 
158 /*number of SGLOffset fields */
159 #define MPI2_SCSIIO_NUM_SGLOFFSETS                  (4)
160 
161 /*SCSI IO IoFlags bits */
162 
163 /*Large CDB Address Space */
164 #define MPI2_SCSIIO_CDB_ADDR_MASK                   (0x6000)
165 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM                 (0x0000)
166 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR                 (0x2000)
167 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB                 (0x4000)
168 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA              (0x6000)
169 
170 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB               (0x1000)
171 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL           (0x0800)
172 #define MPI2_SCSIIO_IOFLAGS_MULTICAST               (0x0400)
173 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
174 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK          (0x01FF)
175 
176 /*SCSI IO EEDPFlags bits */
177 
178 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG        (0x8000)
179 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG        (0x4000)
180 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG        (0x2000)
181 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG        (0x1000)
182 
183 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG          (0x0400)
184 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG          (0x0200)
185 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD           (0x0100)
186 
187 #define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG       (0x0008)
188 
189 #define MPI2_SCSIIO_EEDPFLAGS_MASK_OP               (0x0007)
190 #define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP               (0x0000)
191 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP              (0x0001)
192 #define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP              (0x0002)
193 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP       (0x0003)
194 #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP             (0x0004)
195 #define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP            (0x0006)
196 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP        (0x0007)
197 
198 /*SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
199 
200 /*SCSI IO Control bits */
201 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK      (0xFC000000)
202 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT     (26)
203 
204 #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK  (0x03000000)
205 #define MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION (24)
206 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER      (0x00000000)
207 #define MPI2_SCSIIO_CONTROL_WRITE               (0x01000000)
208 #define MPI2_SCSIIO_CONTROL_READ                (0x02000000)
209 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL       (0x03000000)
210 
211 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK        (0x00007800)
212 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT       (11)
213 /*alternate name for the previous field; called Command Priority in SAM-4 */
214 #define MPI2_SCSIIO_CONTROL_CMDPRI_MASK         (0x00007800)
215 #define MPI2_SCSIIO_CONTROL_CMDPRI_SHIFT        (11)
216 
217 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK  (0x00000700)
218 #define MPI2_SCSIIO_CONTROL_SIMPLEQ             (0x00000000)
219 #define MPI2_SCSIIO_CONTROL_HEADOFQ             (0x00000100)
220 #define MPI2_SCSIIO_CONTROL_ORDEREDQ            (0x00000200)
221 #define MPI2_SCSIIO_CONTROL_ACAQ                (0x00000400)
222 
223 #define MPI2_SCSIIO_CONTROL_TLR_MASK            (0x000000C0)
224 #define MPI2_SCSIIO_CONTROL_NO_TLR              (0x00000000)
225 #define MPI2_SCSIIO_CONTROL_TLR_ON              (0x00000040)
226 #define MPI2_SCSIIO_CONTROL_TLR_OFF             (0x00000080)
227 
228 /*MPI v2.5 CDB field */
229 typedef union _MPI25_SCSI_IO_CDB_UNION {
230 	U8 CDB32[32];
231 	MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
232 	MPI2_IEEE_SGE_SIMPLE64 SGE;
233 } MPI25_SCSI_IO_CDB_UNION, *PTR_MPI25_SCSI_IO_CDB_UNION,
234 	Mpi25ScsiIoCdb_t, *pMpi25ScsiIoCdb_t;
235 
236 /*MPI v2.5/2.6 SCSI IO Request Message */
237 typedef struct _MPI25_SCSI_IO_REQUEST {
238 	U16 DevHandle;		/*0x00 */
239 	U8 ChainOffset;		/*0x02 */
240 	U8 Function;		/*0x03 */
241 	U16 Reserved1;		/*0x04 */
242 	U8 Reserved2;		/*0x06 */
243 	U8 MsgFlags;		/*0x07 */
244 	U8 VP_ID;		/*0x08 */
245 	U8 VF_ID;		/*0x09 */
246 	U16 Reserved3;		/*0x0A */
247 	U32 SenseBufferLowAddress;	/*0x0C */
248 	U8 DMAFlags;		/*0x10 */
249 	U8 Reserved5;		/*0x11 */
250 	U8 SenseBufferLength;	/*0x12 */
251 	U8 Reserved4;		/*0x13 */
252 	U8 SGLOffset0;		/*0x14 */
253 	U8 SGLOffset1;		/*0x15 */
254 	U8 SGLOffset2;		/*0x16 */
255 	U8 SGLOffset3;		/*0x17 */
256 	U32 SkipCount;		/*0x18 */
257 	U32 DataLength;		/*0x1C */
258 	U32 BidirectionalDataLength;	/*0x20 */
259 	U16 IoFlags;		/*0x24 */
260 	U16 EEDPFlags;		/*0x26 */
261 	U16 EEDPBlockSize;	/*0x28 */
262 	U16 Reserved6;		/*0x2A */
263 	U32 SecondaryReferenceTag;	/*0x2C */
264 	U16 SecondaryApplicationTag;	/*0x30 */
265 	U16 ApplicationTagTranslationMask;	/*0x32 */
266 	U8 LUN[8];		/*0x34 */
267 	U32 Control;		/*0x3C */
268 	MPI25_SCSI_IO_CDB_UNION CDB;	/*0x40 */
269 
270 #ifdef MPI25_SCSI_IO_VENDOR_UNIQUE_REGION /*typically this is left undefined */
271 	MPI25_SCSI_IO_VENDOR_UNIQUE VendorRegion;
272 #endif
273 
274 	MPI25_SGE_IO_UNION SGL;	/*0x60 */
275 
276 } MPI25_SCSI_IO_REQUEST, *PTR_MPI25_SCSI_IO_REQUEST,
277 	Mpi25SCSIIORequest_t, *pMpi25SCSIIORequest_t;
278 
279 /*use MPI2_SCSIIO_MSGFLAGS_ defines for the MsgFlags field */
280 
281 /*Defines for the DMAFlags field
282  * Each setting affects 4 SGLS, from SGL0 to SGL3.
283  *     D = Data
284  *     C = Cache DIF
285  *     I = Interleaved
286  *     H = Host DIF
287  */
288 #define MPI25_SCSIIO_DMAFLAGS_OP_MASK               (0x0F)
289 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_D            (0x00)
290 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_C            (0x01)
291 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_I            (0x02)
292 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_C            (0x03)
293 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_I            (0x04)
294 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_I_I            (0x05)
295 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_C            (0x06)
296 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_I            (0x07)
297 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_I_I            (0x08)
298 #define MPI25_SCSIIO_DMAFLAGS_OP_D_I_I_I            (0x09)
299 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_D            (0x0A)
300 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_C            (0x0B)
301 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_I            (0x0C)
302 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_C            (0x0D)
303 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_I            (0x0E)
304 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_I_I            (0x0F)
305 
306 /*number of SGLOffset fields */
307 #define MPI25_SCSIIO_NUM_SGLOFFSETS                 (4)
308 
309 /*defines for the IoFlags field */
310 #define MPI25_SCSIIO_IOFLAGS_IO_PATH_MASK               (0xC000)
311 #define MPI25_SCSIIO_IOFLAGS_NORMAL_PATH                (0x0000)
312 #define MPI25_SCSIIO_IOFLAGS_FAST_PATH                  (0x4000)
313 
314 #define MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH         (0x2000)
315 #define MPI25_SCSIIO_IOFLAGS_LARGE_CDB                  (0x1000)
316 #define MPI25_SCSIIO_IOFLAGS_BIDIRECTIONAL              (0x0800)
317 #define MPI26_SCSIIO_IOFLAGS_PORT_REQUEST               (0x0400)
318 #define MPI25_SCSIIO_IOFLAGS_CDBLENGTH_MASK             (0x01FF)
319 
320 /*MPI v2.5 defines for the EEDPFlags bits */
321 /*use MPI2_SCSIIO_EEDPFLAGS_ defines for the other EEDPFlags bits */
322 #define MPI25_SCSIIO_EEDPFLAGS_ESCAPE_MODE_MASK             (0x00C0)
323 #define MPI25_SCSIIO_EEDPFLAGS_COMPATIBLE_MODE              (0x0000)
324 #define MPI25_SCSIIO_EEDPFLAGS_DO_NOT_DISABLE_MODE          (0x0040)
325 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_DISABLE_MODE          (0x0080)
326 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_REFTAG_DISABLE_MODE   (0x00C0)
327 
328 #define MPI25_SCSIIO_EEDPFLAGS_HOST_GUARD_METHOD_MASK       (0x0030)
329 #define MPI25_SCSIIO_EEDPFLAGS_T10_CRC_HOST_GUARD           (0x0000)
330 #define MPI25_SCSIIO_EEDPFLAGS_IP_CHKSUM_HOST_GUARD         (0x0010)
331 
332 /*use MPI2_LUN_ defines from mpi2.h for the LUN field */
333 
334 /*use MPI2_SCSIIO_CONTROL_ defines for the Control field */
335 
336 /*NOTE: The SCSI IO Reply is nearly the same for MPI 2.0 and MPI 2.5, so
337  *      MPI2_SCSI_IO_REPLY is used for both.
338  */
339 
340 /*SCSI IO Error Reply Message */
341 typedef struct _MPI2_SCSI_IO_REPLY {
342 	U16 DevHandle;		/*0x00 */
343 	U8 MsgLength;		/*0x02 */
344 	U8 Function;		/*0x03 */
345 	U16 Reserved1;		/*0x04 */
346 	U8 Reserved2;		/*0x06 */
347 	U8 MsgFlags;		/*0x07 */
348 	U8 VP_ID;		/*0x08 */
349 	U8 VF_ID;		/*0x09 */
350 	U16 Reserved3;		/*0x0A */
351 	U8 SCSIStatus;		/*0x0C */
352 	U8 SCSIState;		/*0x0D */
353 	U16 IOCStatus;		/*0x0E */
354 	U32 IOCLogInfo;		/*0x10 */
355 	U32 TransferCount;	/*0x14 */
356 	U32 SenseCount;		/*0x18 */
357 	U32 ResponseInfo;	/*0x1C */
358 	U16 TaskTag;		/*0x20 */
359 	U16 SCSIStatusQualifier; /* 0x22 */
360 	U32 BidirectionalTransferCount;	/*0x24 */
361 	U32 EEDPErrorOffset;	/*0x28 *//*MPI 2.5 only; Reserved in MPI 2.0*/
362 	U32 Reserved6;		/*0x2C */
363 } MPI2_SCSI_IO_REPLY, *PTR_MPI2_SCSI_IO_REPLY,
364 	Mpi2SCSIIOReply_t, *pMpi2SCSIIOReply_t;
365 
366 /*SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
367 
368 #define MPI2_SCSI_STATUS_GOOD                   (0x00)
369 #define MPI2_SCSI_STATUS_CHECK_CONDITION        (0x02)
370 #define MPI2_SCSI_STATUS_CONDITION_MET          (0x04)
371 #define MPI2_SCSI_STATUS_BUSY                   (0x08)
372 #define MPI2_SCSI_STATUS_INTERMEDIATE           (0x10)
373 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET   (0x14)
374 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT   (0x18)
375 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED     (0x22)	/*obsolete */
376 #define MPI2_SCSI_STATUS_TASK_SET_FULL          (0x28)
377 #define MPI2_SCSI_STATUS_ACA_ACTIVE             (0x30)
378 #define MPI2_SCSI_STATUS_TASK_ABORTED           (0x40)
379 
380 /*SCSI IO Reply SCSIState flags */
381 
382 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID     (0x10)
383 #define MPI2_SCSI_STATE_TERMINATED              (0x08)
384 #define MPI2_SCSI_STATE_NO_SCSI_STATUS          (0x04)
385 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED        (0x02)
386 #define MPI2_SCSI_STATE_AUTOSENSE_VALID         (0x01)
387 
388 /*masks and shifts for the ResponseInfo field */
389 
390 #define MPI2_SCSI_RI_MASK_REASONCODE            (0x000000FF)
391 #define MPI2_SCSI_RI_SHIFT_REASONCODE           (0)
392 
393 #define MPI2_SCSI_TASKTAG_UNKNOWN               (0xFFFF)
394 
395 /****************************************************************************
396 * SCSI Task Management messages
397 ****************************************************************************/
398 
399 /*SCSI Task Management Request Message */
400 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST {
401 	U16 DevHandle;		/*0x00 */
402 	U8 ChainOffset;		/*0x02 */
403 	U8 Function;		/*0x03 */
404 	U8 Reserved1;		/*0x04 */
405 	U8 TaskType;		/*0x05 */
406 	U8 Reserved2;		/*0x06 */
407 	U8 MsgFlags;		/*0x07 */
408 	U8 VP_ID;		/*0x08 */
409 	U8 VF_ID;		/*0x09 */
410 	U16 Reserved3;		/*0x0A */
411 	U8 LUN[8];		/*0x0C */
412 	U32 Reserved4[7];	/*0x14 */
413 	U16 TaskMID;		/*0x30 */
414 	U16 Reserved5;		/*0x32 */
415 } MPI2_SCSI_TASK_MANAGE_REQUEST,
416 	*PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
417 	Mpi2SCSITaskManagementRequest_t,
418 	*pMpi2SCSITaskManagementRequest_t;
419 
420 /*TaskType values */
421 
422 #define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK           (0x01)
423 #define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET        (0x02)
424 #define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET         (0x03)
425 #define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET   (0x05)
426 #define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET       (0x06)
427 #define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK           (0x07)
428 #define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA              (0x08)
429 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET         (0x09)
430 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT      (0x0A)
431 
432 /*obsolete TaskType name */
433 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION \
434 		(MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT)
435 
436 /*MsgFlags bits */
437 
438 #define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET    (0x18)
439 #define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET           (0x00)
440 #define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST     (0x08)
441 #define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET  (0x10)
442 
443 #define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU  (0x01)
444 
445 /*SCSI Task Management Reply Message */
446 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY {
447 	U16 DevHandle;		/*0x00 */
448 	U8 MsgLength;		/*0x02 */
449 	U8 Function;		/*0x03 */
450 	U8 ResponseCode;	/*0x04 */
451 	U8 TaskType;		/*0x05 */
452 	U8 Reserved1;		/*0x06 */
453 	U8 MsgFlags;		/*0x07 */
454 	U8 VP_ID;		/*0x08 */
455 	U8 VF_ID;		/*0x09 */
456 	U16 Reserved2;		/*0x0A */
457 	U16 Reserved3;		/*0x0C */
458 	U16 IOCStatus;		/*0x0E */
459 	U32 IOCLogInfo;		/*0x10 */
460 	U32 TerminationCount;	/*0x14 */
461 	U32 ResponseInfo;	/*0x18 */
462 } MPI2_SCSI_TASK_MANAGE_REPLY,
463 	*PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
464 	Mpi2SCSITaskManagementReply_t, *pMpi2SCSIManagementReply_t;
465 
466 /*ResponseCode values */
467 
468 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE               (0x00)
469 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME             (0x02)
470 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED          (0x04)
471 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED                 (0x05)
472 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED              (0x08)
473 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN            (0x09)
474 #define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG         (0x0A)
475 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC          (0x80)
476 
477 /*masks and shifts for the ResponseInfo field */
478 
479 #define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE            (0x000000FF)
480 #define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE           (0)
481 #define MPI2_SCSITASKMGMT_RI_MASK_ARI2                  (0x0000FF00)
482 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2                 (8)
483 #define MPI2_SCSITASKMGMT_RI_MASK_ARI1                  (0x00FF0000)
484 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1                 (16)
485 #define MPI2_SCSITASKMGMT_RI_MASK_ARI0                  (0xFF000000)
486 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0                 (24)
487 
488 /****************************************************************************
489 * SCSI Enclosure Processor messages
490 ****************************************************************************/
491 
492 /*SCSI Enclosure Processor Request Message */
493 typedef struct _MPI2_SEP_REQUEST {
494 	U16 DevHandle;		/*0x00 */
495 	U8 ChainOffset;		/*0x02 */
496 	U8 Function;		/*0x03 */
497 	U8 Action;		/*0x04 */
498 	U8 Flags;		/*0x05 */
499 	U8 Reserved1;		/*0x06 */
500 	U8 MsgFlags;		/*0x07 */
501 	U8 VP_ID;		/*0x08 */
502 	U8 VF_ID;		/*0x09 */
503 	U16 Reserved2;		/*0x0A */
504 	U32 SlotStatus;		/*0x0C */
505 	U32 Reserved3;		/*0x10 */
506 	U32 Reserved4;		/*0x14 */
507 	U32 Reserved5;		/*0x18 */
508 	U16 Slot;		/*0x1C */
509 	U16 EnclosureHandle;	/*0x1E */
510 } MPI2_SEP_REQUEST, *PTR_MPI2_SEP_REQUEST,
511 	Mpi2SepRequest_t, *pMpi2SepRequest_t;
512 
513 /*Action defines */
514 #define MPI2_SEP_REQ_ACTION_WRITE_STATUS                (0x00)
515 #define MPI2_SEP_REQ_ACTION_READ_STATUS                 (0x01)
516 
517 /*Flags defines */
518 #define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS            (0x00)
519 #define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS       (0x01)
520 
521 /*SlotStatus defines */
522 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF                 (0x00080000)
523 #define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE          (0x00040000)
524 #define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST        (0x00020000)
525 #define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED         (0x00000200)
526 #define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE               (0x00000100)
527 #define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED            (0x00000080)
528 #define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT         (0x00000040)
529 #define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY       (0x00000010)
530 #define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY         (0x00000008)
531 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING          (0x00000004)
532 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY              (0x00000002)
533 #define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR                (0x00000001)
534 
535 /*SCSI Enclosure Processor Reply Message */
536 typedef struct _MPI2_SEP_REPLY {
537 	U16 DevHandle;		/*0x00 */
538 	U8 MsgLength;		/*0x02 */
539 	U8 Function;		/*0x03 */
540 	U8 Action;		/*0x04 */
541 	U8 Flags;		/*0x05 */
542 	U8 Reserved1;		/*0x06 */
543 	U8 MsgFlags;		/*0x07 */
544 	U8 VP_ID;		/*0x08 */
545 	U8 VF_ID;		/*0x09 */
546 	U16 Reserved2;		/*0x0A */
547 	U16 Reserved3;		/*0x0C */
548 	U16 IOCStatus;		/*0x0E */
549 	U32 IOCLogInfo;		/*0x10 */
550 	U32 SlotStatus;		/*0x14 */
551 	U32 Reserved4;		/*0x18 */
552 	U16 Slot;		/*0x1C */
553 	U16 EnclosureHandle;	/*0x1E */
554 } MPI2_SEP_REPLY, *PTR_MPI2_SEP_REPLY,
555 	Mpi2SepReply_t, *pMpi2SepReply_t;
556 
557 /*SlotStatus defines */
558 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF               (0x00080000)
559 #define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY          (0x00040000)
560 #define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST      (0x00020000)
561 #define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED       (0x00000200)
562 #define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE             (0x00000100)
563 #define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED          (0x00000080)
564 #define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT       (0x00000040)
565 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY     (0x00000010)
566 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY       (0x00000008)
567 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING        (0x00000004)
568 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY            (0x00000002)
569 #define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR              (0x00000001)
570 
571 #endif
572