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