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