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