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