1230920Sken/*-
2237876Sken * Copyright (c) 2011, 2012 LSI Corp.
3230920Sken * All rights reserved.
4230920Sken *
5230920Sken * Redistribution and use in source and binary forms, with or without
6230920Sken * modification, are permitted provided that the following conditions
7230920Sken * are met:
8230920Sken * 1. Redistributions of source code must retain the above copyright
9230920Sken *    notice, this list of conditions and the following disclaimer.
10230920Sken * 2. Redistributions in binary form must reproduce the above copyright
11230920Sken *    notice, this list of conditions and the following disclaimer in the
12230920Sken *    documentation and/or other materials provided with the distribution.
13230920Sken *
14230920Sken * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15230920Sken * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16230920Sken * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17230920Sken * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18230920Sken * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19230920Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20230920Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21230920Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22230920Sken * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23230920Sken * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24230920Sken * SUCH DAMAGE.
25230920Sken *
26230920Sken * LSI MPT-Fusion Host Adapter FreeBSD
27230920Sken *
28230920Sken * $FreeBSD$
29230920Sken */
30230920Sken
31212420Sken/*
32237876Sken *  Copyright (c) 2000-2012 LSI Corporation.
33212420Sken *
34212420Sken *
35212420Sken *           Name:  mpi2_init.h
36212420Sken *          Title:  MPI SCSI initiator mode messages and structures
37212420Sken *  Creation Date:  June 23, 2006
38212420Sken *
39230920Sken *    mpi2_init.h Version:  02.00.11
40212420Sken *
41212420Sken *  Version History
42212420Sken *  ---------------
43212420Sken *
44212420Sken *  Date      Version   Description
45212420Sken *  --------  --------  ------------------------------------------------------
46212420Sken *  04-30-07  02.00.00  Corresponds to Fusion-MPT MPI Specification Rev A.
47212420Sken *  10-31-07  02.00.01  Fixed name for pMpi2SCSITaskManagementRequest_t.
48212420Sken *  12-18-07  02.00.02  Modified Task Management Target Reset Method defines.
49212420Sken *  02-29-08  02.00.03  Added Query Task Set and Query Unit Attention.
50212420Sken *  03-03-08  02.00.04  Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
51212420Sken *  05-21-08  02.00.05  Fixed typo in name of Mpi2SepRequest_t.
52212420Sken *  10-02-08  02.00.06  Removed Untagged and No Disconnect values from SCSI IO
53212420Sken *                      Control field Task Attribute flags.
54212420Sken *                      Moved LUN field defines to mpi2.h becasue they are
55212420Sken *                      common to many structures.
56212420Sken *  05-06-09  02.00.07  Changed task management type of Query Unit Attention to
57212420Sken *                      Query Asynchronous Event.
58212420Sken *                      Defined two new bits in the SlotStatus field of the SCSI
59212420Sken *                      Enclosure Processor Request and Reply.
60212420Sken *  10-28-09  02.00.08  Added defines for decoding the ResponseInfo bytes for
61212420Sken *                      both SCSI IO Error Reply and SCSI Task Management Reply.
62212420Sken *                      Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
63212420Sken *                      Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
64230920Sken *  02-10-10  02.00.09  Removed unused structure that had "#if 0" around it.
65230920Sken *  05-12-10  02.00.10  Added optional vendor-unique region to SCSI IO Request.
66230920Sken *  11-10-10  02.00.11  Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
67212420Sken *  --------------------------------------------------------------------------
68212420Sken */
69212420Sken
70212420Sken#ifndef MPI2_INIT_H
71212420Sken#define MPI2_INIT_H
72212420Sken
73212420Sken/*****************************************************************************
74212420Sken*
75212420Sken*               SCSI Initiator Messages
76212420Sken*
77212420Sken*****************************************************************************/
78212420Sken
79212420Sken/****************************************************************************
80212420Sken*  SCSI IO messages and associated structures
81212420Sken****************************************************************************/
82212420Sken
83212420Skentypedef struct
84212420Sken{
85212420Sken    U8                      CDB[20];                    /* 0x00 */
86212420Sken    U32                     PrimaryReferenceTag;        /* 0x14 */
87212420Sken    U16                     PrimaryApplicationTag;      /* 0x18 */
88212420Sken    U16                     PrimaryApplicationTagMask;  /* 0x1A */
89212420Sken    U32                     TransferLength;             /* 0x1C */
90212420Sken} MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
91212420Sken  Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
92212420Sken
93212420Skentypedef union
94212420Sken{
95212420Sken    U8                      CDB32[32];
96212420Sken    MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
97212420Sken    MPI2_SGE_SIMPLE_UNION   SGE;
98212420Sken} MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
99212420Sken  Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
100212420Sken
101212420Sken/* SCSI IO Request Message */
102212420Skentypedef struct _MPI2_SCSI_IO_REQUEST
103212420Sken{
104212420Sken    U16                     DevHandle;                      /* 0x00 */
105212420Sken    U8                      ChainOffset;                    /* 0x02 */
106212420Sken    U8                      Function;                       /* 0x03 */
107212420Sken    U16                     Reserved1;                      /* 0x04 */
108212420Sken    U8                      Reserved2;                      /* 0x06 */
109212420Sken    U8                      MsgFlags;                       /* 0x07 */
110212420Sken    U8                      VP_ID;                          /* 0x08 */
111212420Sken    U8                      VF_ID;                          /* 0x09 */
112212420Sken    U16                     Reserved3;                      /* 0x0A */
113212420Sken    U32                     SenseBufferLowAddress;          /* 0x0C */
114212420Sken    U16                     SGLFlags;                       /* 0x10 */
115212420Sken    U8                      SenseBufferLength;              /* 0x12 */
116212420Sken    U8                      Reserved4;                      /* 0x13 */
117212420Sken    U8                      SGLOffset0;                     /* 0x14 */
118212420Sken    U8                      SGLOffset1;                     /* 0x15 */
119212420Sken    U8                      SGLOffset2;                     /* 0x16 */
120212420Sken    U8                      SGLOffset3;                     /* 0x17 */
121212420Sken    U32                     SkipCount;                      /* 0x18 */
122212420Sken    U32                     DataLength;                     /* 0x1C */
123212420Sken    U32                     BidirectionalDataLength;        /* 0x20 */
124212420Sken    U16                     IoFlags;                        /* 0x24 */
125212420Sken    U16                     EEDPFlags;                      /* 0x26 */
126212420Sken    U32                     EEDPBlockSize;                  /* 0x28 */
127212420Sken    U32                     SecondaryReferenceTag;          /* 0x2C */
128212420Sken    U16                     SecondaryApplicationTag;        /* 0x30 */
129212420Sken    U16                     ApplicationTagTranslationMask;  /* 0x32 */
130212420Sken    U8                      LUN[8];                         /* 0x34 */
131212420Sken    U32                     Control;                        /* 0x3C */
132212420Sken    MPI2_SCSI_IO_CDB_UNION  CDB;                            /* 0x40 */
133230920Sken
134230920Sken#ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */
135230920Sken    MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion;
136230920Sken#endif
137230920Sken
138212420Sken    MPI2_SGE_IO_UNION       SGL;                            /* 0x60 */
139230920Sken
140212420Sken} MPI2_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI2_SCSI_IO_REQUEST,
141212420Sken  Mpi2SCSIIORequest_t, MPI2_POINTER pMpi2SCSIIORequest_t;
142212420Sken
143212420Sken/* SCSI IO MsgFlags bits */
144212420Sken
145212420Sken/* MsgFlags for SenseBufferAddressSpace */
146212420Sken#define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR        (0x0C)
147212420Sken#define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR      (0x00)
148212420Sken#define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR      (0x04)
149212420Sken#define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR      (0x08)
150212420Sken#define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR   (0x0C)
151212420Sken
152212420Sken/* SCSI IO SGLFlags bits */
153212420Sken
154212420Sken/* base values for Data Location Address Space */
155212420Sken#define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK              (0x0C)
156212420Sken#define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR            (0x00)
157212420Sken#define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR            (0x04)
158212420Sken#define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR            (0x08)
159212420Sken#define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR         (0x0C)
160212420Sken
161212420Sken/* base values for Type */
162212420Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK              (0x03)
163212420Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI               (0x00)
164212420Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32            (0x01)
165212420Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64            (0x02)
166212420Sken
167212420Sken/* shift values for each sub-field */
168212420Sken#define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT             (12)
169212420Sken#define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT             (8)
170212420Sken#define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT             (4)
171212420Sken#define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT             (0)
172212420Sken
173230920Sken/* number of SGLOffset fields */
174230920Sken#define MPI2_SCSIIO_NUM_SGLOFFSETS                  (4)
175230920Sken
176212420Sken/* SCSI IO IoFlags bits */
177212420Sken
178212420Sken/* Large CDB Address Space */
179212420Sken#define MPI2_SCSIIO_CDB_ADDR_MASK                   (0x6000)
180212420Sken#define MPI2_SCSIIO_CDB_ADDR_SYSTEM                 (0x0000)
181212420Sken#define MPI2_SCSIIO_CDB_ADDR_IOCDDR                 (0x2000)
182212420Sken#define MPI2_SCSIIO_CDB_ADDR_IOCPLB                 (0x4000)
183212420Sken#define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA              (0x6000)
184212420Sken
185212420Sken#define MPI2_SCSIIO_IOFLAGS_LARGE_CDB               (0x1000)
186212420Sken#define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL           (0x0800)
187212420Sken#define MPI2_SCSIIO_IOFLAGS_MULTICAST               (0x0400)
188212420Sken#define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
189212420Sken#define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK          (0x01FF)
190212420Sken
191212420Sken/* SCSI IO EEDPFlags bits */
192212420Sken
193212420Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG        (0x8000)
194212420Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG        (0x4000)
195212420Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG        (0x2000)
196212420Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG        (0x1000)
197212420Sken
198212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG          (0x0400)
199212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG          (0x0200)
200212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD           (0x0100)
201212420Sken
202212420Sken#define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG       (0x0008)
203212420Sken
204212420Sken#define MPI2_SCSIIO_EEDPFLAGS_MASK_OP               (0x0007)
205212420Sken#define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP               (0x0000)
206212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP              (0x0001)
207212420Sken#define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP              (0x0002)
208212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP       (0x0003)
209212420Sken#define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP             (0x0004)
210212420Sken#define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP            (0x0006)
211212420Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP        (0x0007)
212212420Sken
213212420Sken/* SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
214212420Sken
215212420Sken/* SCSI IO Control bits */
216212420Sken#define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK      (0xFC000000)
217212420Sken#define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT     (26)
218212420Sken
219212420Sken#define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK  (0x03000000)
220212420Sken#define MPI2_SCSIIO_CONTROL_NODATATRANSFER      (0x00000000)
221212420Sken#define MPI2_SCSIIO_CONTROL_WRITE               (0x01000000)
222212420Sken#define MPI2_SCSIIO_CONTROL_READ                (0x02000000)
223212420Sken#define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL       (0x03000000)
224212420Sken
225212420Sken#define MPI2_SCSIIO_CONTROL_TASKPRI_MASK        (0x00007800)
226212420Sken#define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT       (11)
227212420Sken
228212420Sken#define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK  (0x00000700)
229212420Sken#define MPI2_SCSIIO_CONTROL_SIMPLEQ             (0x00000000)
230212420Sken#define MPI2_SCSIIO_CONTROL_HEADOFQ             (0x00000100)
231212420Sken#define MPI2_SCSIIO_CONTROL_ORDEREDQ            (0x00000200)
232212420Sken#define MPI2_SCSIIO_CONTROL_ACAQ                (0x00000400)
233212420Sken
234212420Sken#define MPI2_SCSIIO_CONTROL_TLR_MASK            (0x000000C0)
235212420Sken#define MPI2_SCSIIO_CONTROL_NO_TLR              (0x00000000)
236212420Sken#define MPI2_SCSIIO_CONTROL_TLR_ON              (0x00000040)
237212420Sken#define MPI2_SCSIIO_CONTROL_TLR_OFF             (0x00000080)
238212420Sken
239212420Sken
240212420Sken/* SCSI IO Error Reply Message */
241212420Skentypedef struct _MPI2_SCSI_IO_REPLY
242212420Sken{
243212420Sken    U16                     DevHandle;                      /* 0x00 */
244212420Sken    U8                      MsgLength;                      /* 0x02 */
245212420Sken    U8                      Function;                       /* 0x03 */
246212420Sken    U16                     Reserved1;                      /* 0x04 */
247212420Sken    U8                      Reserved2;                      /* 0x06 */
248212420Sken    U8                      MsgFlags;                       /* 0x07 */
249212420Sken    U8                      VP_ID;                          /* 0x08 */
250212420Sken    U8                      VF_ID;                          /* 0x09 */
251212420Sken    U16                     Reserved3;                      /* 0x0A */
252212420Sken    U8                      SCSIStatus;                     /* 0x0C */
253212420Sken    U8                      SCSIState;                      /* 0x0D */
254212420Sken    U16                     IOCStatus;                      /* 0x0E */
255212420Sken    U32                     IOCLogInfo;                     /* 0x10 */
256212420Sken    U32                     TransferCount;                  /* 0x14 */
257212420Sken    U32                     SenseCount;                     /* 0x18 */
258212420Sken    U32                     ResponseInfo;                   /* 0x1C */
259212420Sken    U16                     TaskTag;                        /* 0x20 */
260212420Sken    U16                     Reserved4;                      /* 0x22 */
261212420Sken    U32                     BidirectionalTransferCount;     /* 0x24 */
262212420Sken    U32                     Reserved5;                      /* 0x28 */
263212420Sken    U32                     Reserved6;                      /* 0x2C */
264212420Sken} MPI2_SCSI_IO_REPLY, MPI2_POINTER PTR_MPI2_SCSI_IO_REPLY,
265212420Sken  Mpi2SCSIIOReply_t, MPI2_POINTER pMpi2SCSIIOReply_t;
266212420Sken
267212420Sken/* SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
268212420Sken
269212420Sken#define MPI2_SCSI_STATUS_GOOD                   (0x00)
270212420Sken#define MPI2_SCSI_STATUS_CHECK_CONDITION        (0x02)
271212420Sken#define MPI2_SCSI_STATUS_CONDITION_MET          (0x04)
272212420Sken#define MPI2_SCSI_STATUS_BUSY                   (0x08)
273212420Sken#define MPI2_SCSI_STATUS_INTERMEDIATE           (0x10)
274212420Sken#define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET   (0x14)
275212420Sken#define MPI2_SCSI_STATUS_RESERVATION_CONFLICT   (0x18)
276212420Sken#define MPI2_SCSI_STATUS_COMMAND_TERMINATED     (0x22) /* obsolete */
277212420Sken#define MPI2_SCSI_STATUS_TASK_SET_FULL          (0x28)
278212420Sken#define MPI2_SCSI_STATUS_ACA_ACTIVE             (0x30)
279212420Sken#define MPI2_SCSI_STATUS_TASK_ABORTED           (0x40)
280212420Sken
281212420Sken/* SCSI IO Reply SCSIState flags */
282212420Sken
283212420Sken#define MPI2_SCSI_STATE_RESPONSE_INFO_VALID     (0x10)
284212420Sken#define MPI2_SCSI_STATE_TERMINATED              (0x08)
285212420Sken#define MPI2_SCSI_STATE_NO_SCSI_STATUS          (0x04)
286212420Sken#define MPI2_SCSI_STATE_AUTOSENSE_FAILED        (0x02)
287212420Sken#define MPI2_SCSI_STATE_AUTOSENSE_VALID         (0x01)
288212420Sken
289212420Sken/* masks and shifts for the ResponseInfo field */
290212420Sken
291212420Sken#define MPI2_SCSI_RI_MASK_REASONCODE            (0x000000FF)
292212420Sken#define MPI2_SCSI_RI_SHIFT_REASONCODE           (0)
293212420Sken
294212420Sken#define MPI2_SCSI_TASKTAG_UNKNOWN               (0xFFFF)
295212420Sken
296212420Sken
297212420Sken/****************************************************************************
298212420Sken*  SCSI Task Management messages
299212420Sken****************************************************************************/
300212420Sken
301212420Sken/* SCSI Task Management Request Message */
302212420Skentypedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
303212420Sken{
304212420Sken    U16                     DevHandle;                      /* 0x00 */
305212420Sken    U8                      ChainOffset;                    /* 0x02 */
306212420Sken    U8                      Function;                       /* 0x03 */
307212420Sken    U8                      Reserved1;                      /* 0x04 */
308212420Sken    U8                      TaskType;                       /* 0x05 */
309212420Sken    U8                      Reserved2;                      /* 0x06 */
310212420Sken    U8                      MsgFlags;                       /* 0x07 */
311212420Sken    U8                      VP_ID;                          /* 0x08 */
312212420Sken    U8                      VF_ID;                          /* 0x09 */
313212420Sken    U16                     Reserved3;                      /* 0x0A */
314212420Sken    U8                      LUN[8];                         /* 0x0C */
315212420Sken    U32                     Reserved4[7];                   /* 0x14 */
316212420Sken    U16                     TaskMID;                        /* 0x30 */
317212420Sken    U16                     Reserved5;                      /* 0x32 */
318212420Sken} MPI2_SCSI_TASK_MANAGE_REQUEST,
319212420Sken  MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
320212420Sken  Mpi2SCSITaskManagementRequest_t,
321212420Sken  MPI2_POINTER pMpi2SCSITaskManagementRequest_t;
322212420Sken
323212420Sken/* TaskType values */
324212420Sken
325212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK           (0x01)
326212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET        (0x02)
327212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET         (0x03)
328212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET   (0x05)
329212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET       (0x06)
330212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK           (0x07)
331212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA              (0x08)
332212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET         (0x09)
333212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT      (0x0A)
334212420Sken
335212420Sken/* obsolete TaskType name */
336212420Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION   (MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT)
337212420Sken
338212420Sken/* MsgFlags bits */
339212420Sken
340212420Sken#define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET    (0x18)
341212420Sken#define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET           (0x00)
342212420Sken#define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST     (0x08)
343212420Sken#define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET  (0x10)
344212420Sken
345212420Sken#define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU  (0x01)
346212420Sken
347212420Sken
348212420Sken
349212420Sken/* SCSI Task Management Reply Message */
350212420Skentypedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
351212420Sken{
352212420Sken    U16                     DevHandle;                      /* 0x00 */
353212420Sken    U8                      MsgLength;                      /* 0x02 */
354212420Sken    U8                      Function;                       /* 0x03 */
355212420Sken    U8                      ResponseCode;                   /* 0x04 */
356212420Sken    U8                      TaskType;                       /* 0x05 */
357212420Sken    U8                      Reserved1;                      /* 0x06 */
358212420Sken    U8                      MsgFlags;                       /* 0x07 */
359212420Sken    U8                      VP_ID;                          /* 0x08 */
360212420Sken    U8                      VF_ID;                          /* 0x09 */
361212420Sken    U16                     Reserved2;                      /* 0x0A */
362212420Sken    U16                     Reserved3;                      /* 0x0C */
363212420Sken    U16                     IOCStatus;                      /* 0x0E */
364212420Sken    U32                     IOCLogInfo;                     /* 0x10 */
365212420Sken    U32                     TerminationCount;               /* 0x14 */
366212420Sken    U32                     ResponseInfo;                   /* 0x18 */
367212420Sken} MPI2_SCSI_TASK_MANAGE_REPLY,
368212420Sken  MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
369212420Sken  Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
370212420Sken
371212420Sken/* ResponseCode values */
372212420Sken
373212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE               (0x00)
374212420Sken#define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME             (0x02)
375212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED          (0x04)
376212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_FAILED                 (0x05)
377212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED              (0x08)
378212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN            (0x09)
379212420Sken#define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG         (0x0A)
380212420Sken#define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC          (0x80)
381212420Sken
382212420Sken/* masks and shifts for the ResponseInfo field */
383212420Sken
384212420Sken#define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE            (0x000000FF)
385212420Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE           (0)
386212420Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI2                  (0x0000FF00)
387212420Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2                 (8)
388212420Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI1                  (0x00FF0000)
389212420Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1                 (16)
390212420Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI0                  (0xFF000000)
391212420Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0                 (24)
392212420Sken
393212420Sken
394212420Sken/****************************************************************************
395212420Sken*  SCSI Enclosure Processor messages
396212420Sken****************************************************************************/
397212420Sken
398212420Sken/* SCSI Enclosure Processor Request Message */
399212420Skentypedef struct _MPI2_SEP_REQUEST
400212420Sken{
401212420Sken    U16                     DevHandle;          /* 0x00 */
402212420Sken    U8                      ChainOffset;        /* 0x02 */
403212420Sken    U8                      Function;           /* 0x03 */
404212420Sken    U8                      Action;             /* 0x04 */
405212420Sken    U8                      Flags;              /* 0x05 */
406212420Sken    U8                      Reserved1;          /* 0x06 */
407212420Sken    U8                      MsgFlags;           /* 0x07 */
408212420Sken    U8                      VP_ID;              /* 0x08 */
409212420Sken    U8                      VF_ID;              /* 0x09 */
410212420Sken    U16                     Reserved2;          /* 0x0A */
411212420Sken    U32                     SlotStatus;         /* 0x0C */
412212420Sken    U32                     Reserved3;          /* 0x10 */
413212420Sken    U32                     Reserved4;          /* 0x14 */
414212420Sken    U32                     Reserved5;          /* 0x18 */
415212420Sken    U16                     Slot;               /* 0x1C */
416212420Sken    U16                     EnclosureHandle;    /* 0x1E */
417212420Sken} MPI2_SEP_REQUEST, MPI2_POINTER PTR_MPI2_SEP_REQUEST,
418212420Sken  Mpi2SepRequest_t, MPI2_POINTER pMpi2SepRequest_t;
419212420Sken
420212420Sken/* Action defines */
421212420Sken#define MPI2_SEP_REQ_ACTION_WRITE_STATUS                (0x00)
422212420Sken#define MPI2_SEP_REQ_ACTION_READ_STATUS                 (0x01)
423212420Sken
424212420Sken/* Flags defines */
425212420Sken#define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS            (0x00)
426212420Sken#define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS       (0x01)
427212420Sken
428212420Sken/* SlotStatus defines */
429212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE          (0x00040000)
430212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST        (0x00020000)
431212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED         (0x00000200)
432212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE               (0x00000100)
433212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED            (0x00000080)
434212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT         (0x00000040)
435212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY       (0x00000010)
436212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY         (0x00000008)
437212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING          (0x00000004)
438212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY              (0x00000002)
439212420Sken#define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR                (0x00000001)
440212420Sken
441212420Sken
442212420Sken/* SCSI Enclosure Processor Reply Message */
443212420Skentypedef struct _MPI2_SEP_REPLY
444212420Sken{
445212420Sken    U16                     DevHandle;          /* 0x00 */
446212420Sken    U8                      MsgLength;          /* 0x02 */
447212420Sken    U8                      Function;           /* 0x03 */
448212420Sken    U8                      Action;             /* 0x04 */
449212420Sken    U8                      Flags;              /* 0x05 */
450212420Sken    U8                      Reserved1;          /* 0x06 */
451212420Sken    U8                      MsgFlags;           /* 0x07 */
452212420Sken    U8                      VP_ID;              /* 0x08 */
453212420Sken    U8                      VF_ID;              /* 0x09 */
454212420Sken    U16                     Reserved2;          /* 0x0A */
455212420Sken    U16                     Reserved3;          /* 0x0C */
456212420Sken    U16                     IOCStatus;          /* 0x0E */
457212420Sken    U32                     IOCLogInfo;         /* 0x10 */
458212420Sken    U32                     SlotStatus;         /* 0x14 */
459212420Sken    U32                     Reserved4;          /* 0x18 */
460212420Sken    U16                     Slot;               /* 0x1C */
461212420Sken    U16                     EnclosureHandle;    /* 0x1E */
462212420Sken} MPI2_SEP_REPLY, MPI2_POINTER PTR_MPI2_SEP_REPLY,
463212420Sken  Mpi2SepReply_t, MPI2_POINTER pMpi2SepReply_t;
464212420Sken
465212420Sken/* SlotStatus defines */
466212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY          (0x00040000)
467212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST      (0x00020000)
468212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED       (0x00000200)
469212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE             (0x00000100)
470212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED          (0x00000080)
471212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT       (0x00000040)
472212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY     (0x00000010)
473212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY       (0x00000008)
474212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING        (0x00000004)
475212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY            (0x00000002)
476212420Sken#define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR              (0x00000001)
477212420Sken
478212420Sken
479212420Sken#endif
480212420Sken
481212420Sken
482