xref: /freebsd/sys/dev/mps/mpi/mpi2_init.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006-2015 LSI Corp.
5  * Copyright (c) 2013-2015 Avago Technologies
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
30  */
31 
32 /*
33  *  Copyright (c) 2006-2015 LSI Corporation.
34  *  Copyright (c) 2013-2015 Avago Technologies
35  *
36  *
37  *           Name:  mpi2_init.h
38  *          Title:  MPI SCSI initiator mode messages and structures
39  *  Creation Date:  June 23, 2006
40  *
41  *    mpi2_init.h Version:  02.00.11
42  *
43  *  Version History
44  *  ---------------
45  *
46  *  Date      Version   Description
47  *  --------  --------  ------------------------------------------------------
48  *  04-30-07  02.00.00  Corresponds to Fusion-MPT MPI Specification Rev A.
49  *  10-31-07  02.00.01  Fixed name for pMpi2SCSITaskManagementRequest_t.
50  *  12-18-07  02.00.02  Modified Task Management Target Reset Method defines.
51  *  02-29-08  02.00.03  Added Query Task Set and Query Unit Attention.
52  *  03-03-08  02.00.04  Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
53  *  05-21-08  02.00.05  Fixed typo in name of Mpi2SepRequest_t.
54  *  10-02-08  02.00.06  Removed Untagged and No Disconnect values from SCSI IO
55  *                      Control field Task Attribute flags.
56  *                      Moved LUN field defines to mpi2.h because they are
57  *                      common to many structures.
58  *  05-06-09  02.00.07  Changed task management type of Query Unit Attention to
59  *                      Query Asynchronous Event.
60  *                      Defined two new bits in the SlotStatus field of the SCSI
61  *                      Enclosure Processor Request and Reply.
62  *  10-28-09  02.00.08  Added defines for decoding the ResponseInfo bytes for
63  *                      both SCSI IO Error Reply and SCSI Task Management Reply.
64  *                      Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
65  *                      Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
66  *  02-10-10  02.00.09  Removed unused structure that had "#if 0" around it.
67  *  05-12-10  02.00.10  Added optional vendor-unique region to SCSI IO Request.
68  *  11-10-10  02.00.11  Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
69  *  --------------------------------------------------------------------------
70  */
71 
72 #ifndef MPI2_INIT_H
73 #define MPI2_INIT_H
74 
75 /*****************************************************************************
76 *
77 *               SCSI Initiator Messages
78 *
79 *****************************************************************************/
80 
81 /****************************************************************************
82 *  SCSI IO messages and associated structures
83 ****************************************************************************/
84 
85 typedef struct
86 {
87     U8                      CDB[20];                    /* 0x00 */
88     U32                     PrimaryReferenceTag;        /* 0x14 */
89     U16                     PrimaryApplicationTag;      /* 0x18 */
90     U16                     PrimaryApplicationTagMask;  /* 0x1A */
91     U32                     TransferLength;             /* 0x1C */
92 } MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
93   Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
94 
95 typedef union
96 {
97     U8                      CDB32[32];
98     MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
99     MPI2_SGE_SIMPLE_UNION   SGE;
100 } MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
101   Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
102 
103 /* SCSI IO Request Message */
104 typedef struct _MPI2_SCSI_IO_REQUEST
105 {
106     U16                     DevHandle;                      /* 0x00 */
107     U8                      ChainOffset;                    /* 0x02 */
108     U8                      Function;                       /* 0x03 */
109     U16                     Reserved1;                      /* 0x04 */
110     U8                      Reserved2;                      /* 0x06 */
111     U8                      MsgFlags;                       /* 0x07 */
112     U8                      VP_ID;                          /* 0x08 */
113     U8                      VF_ID;                          /* 0x09 */
114     U16                     Reserved3;                      /* 0x0A */
115     U32                     SenseBufferLowAddress;          /* 0x0C */
116     U16                     SGLFlags;                       /* 0x10 */
117     U8                      SenseBufferLength;              /* 0x12 */
118     U8                      Reserved4;                      /* 0x13 */
119     U8                      SGLOffset0;                     /* 0x14 */
120     U8                      SGLOffset1;                     /* 0x15 */
121     U8                      SGLOffset2;                     /* 0x16 */
122     U8                      SGLOffset3;                     /* 0x17 */
123     U32                     SkipCount;                      /* 0x18 */
124     U32                     DataLength;                     /* 0x1C */
125     U32                     BidirectionalDataLength;        /* 0x20 */
126     U16                     IoFlags;                        /* 0x24 */
127     U16                     EEDPFlags;                      /* 0x26 */
128     U32                     EEDPBlockSize;                  /* 0x28 */
129     U32                     SecondaryReferenceTag;          /* 0x2C */
130     U16                     SecondaryApplicationTag;        /* 0x30 */
131     U16                     ApplicationTagTranslationMask;  /* 0x32 */
132     U8                      LUN[8];                         /* 0x34 */
133     U32                     Control;                        /* 0x3C */
134     MPI2_SCSI_IO_CDB_UNION  CDB;                            /* 0x40 */
135 
136 #ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */
137     MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion;
138 #endif
139 
140     MPI2_SGE_IO_UNION       SGL;                            /* 0x60 */
141 
142 } MPI2_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI2_SCSI_IO_REQUEST,
143   Mpi2SCSIIORequest_t, MPI2_POINTER pMpi2SCSIIORequest_t;
144 
145 /* SCSI IO MsgFlags bits */
146 
147 /* MsgFlags for SenseBufferAddressSpace */
148 #define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR        (0x0C)
149 #define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR      (0x00)
150 #define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR      (0x04)
151 #define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR      (0x08)
152 #define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR   (0x0C)
153 
154 /* SCSI IO SGLFlags bits */
155 
156 /* base values for Data Location Address Space */
157 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK              (0x0C)
158 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR            (0x00)
159 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR            (0x04)
160 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR            (0x08)
161 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR         (0x0C)
162 
163 /* base values for Type */
164 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK              (0x03)
165 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI               (0x00)
166 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32            (0x01)
167 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64            (0x02)
168 
169 /* shift values for each sub-field */
170 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT             (12)
171 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT             (8)
172 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT             (4)
173 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT             (0)
174 
175 /* number of SGLOffset fields */
176 #define MPI2_SCSIIO_NUM_SGLOFFSETS                  (4)
177 
178 /* SCSI IO IoFlags bits */
179 
180 /* Large CDB Address Space */
181 #define MPI2_SCSIIO_CDB_ADDR_MASK                   (0x6000)
182 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM                 (0x0000)
183 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR                 (0x2000)
184 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB                 (0x4000)
185 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA              (0x6000)
186 
187 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB               (0x1000)
188 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL           (0x0800)
189 #define MPI2_SCSIIO_IOFLAGS_MULTICAST               (0x0400)
190 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
191 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK          (0x01FF)
192 
193 /* SCSI IO EEDPFlags bits */
194 
195 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG        (0x8000)
196 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG        (0x4000)
197 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG        (0x2000)
198 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG        (0x1000)
199 
200 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG          (0x0400)
201 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG          (0x0200)
202 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD           (0x0100)
203 
204 #define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG       (0x0008)
205 
206 #define MPI2_SCSIIO_EEDPFLAGS_MASK_OP               (0x0007)
207 #define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP               (0x0000)
208 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP              (0x0001)
209 #define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP              (0x0002)
210 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP       (0x0003)
211 #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP             (0x0004)
212 #define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP            (0x0006)
213 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP        (0x0007)
214 
215 /* SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
216 
217 /* SCSI IO Control bits */
218 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK      (0xFC000000)
219 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT     (26)
220 
221 #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK  (0x03000000)
222 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER      (0x00000000)
223 #define MPI2_SCSIIO_CONTROL_WRITE               (0x01000000)
224 #define MPI2_SCSIIO_CONTROL_READ                (0x02000000)
225 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL       (0x03000000)
226 
227 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK        (0x00007800)
228 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT       (11)
229 
230 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK  (0x00000700)
231 #define MPI2_SCSIIO_CONTROL_SIMPLEQ             (0x00000000)
232 #define MPI2_SCSIIO_CONTROL_HEADOFQ             (0x00000100)
233 #define MPI2_SCSIIO_CONTROL_ORDEREDQ            (0x00000200)
234 #define MPI2_SCSIIO_CONTROL_ACAQ                (0x00000400)
235 
236 #define MPI2_SCSIIO_CONTROL_TLR_MASK            (0x000000C0)
237 #define MPI2_SCSIIO_CONTROL_NO_TLR              (0x00000000)
238 #define MPI2_SCSIIO_CONTROL_TLR_ON              (0x00000040)
239 #define MPI2_SCSIIO_CONTROL_TLR_OFF             (0x00000080)
240 
241 /* SCSI IO Error Reply Message */
242 typedef struct _MPI2_SCSI_IO_REPLY
243 {
244     U16                     DevHandle;                      /* 0x00 */
245     U8                      MsgLength;                      /* 0x02 */
246     U8                      Function;                       /* 0x03 */
247     U16                     Reserved1;                      /* 0x04 */
248     U8                      Reserved2;                      /* 0x06 */
249     U8                      MsgFlags;                       /* 0x07 */
250     U8                      VP_ID;                          /* 0x08 */
251     U8                      VF_ID;                          /* 0x09 */
252     U16                     Reserved3;                      /* 0x0A */
253     U8                      SCSIStatus;                     /* 0x0C */
254     U8                      SCSIState;                      /* 0x0D */
255     U16                     IOCStatus;                      /* 0x0E */
256     U32                     IOCLogInfo;                     /* 0x10 */
257     U32                     TransferCount;                  /* 0x14 */
258     U32                     SenseCount;                     /* 0x18 */
259     U32                     ResponseInfo;                   /* 0x1C */
260     U16                     TaskTag;                        /* 0x20 */
261     U16                     Reserved4;                      /* 0x22 */
262     U32                     BidirectionalTransferCount;     /* 0x24 */
263     U32                     Reserved5;                      /* 0x28 */
264     U32                     Reserved6;                      /* 0x2C */
265 } MPI2_SCSI_IO_REPLY, MPI2_POINTER PTR_MPI2_SCSI_IO_REPLY,
266   Mpi2SCSIIOReply_t, MPI2_POINTER pMpi2SCSIIOReply_t;
267 
268 /* SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
269 
270 #define MPI2_SCSI_STATUS_GOOD                   (0x00)
271 #define MPI2_SCSI_STATUS_CHECK_CONDITION        (0x02)
272 #define MPI2_SCSI_STATUS_CONDITION_MET          (0x04)
273 #define MPI2_SCSI_STATUS_BUSY                   (0x08)
274 #define MPI2_SCSI_STATUS_INTERMEDIATE           (0x10)
275 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET   (0x14)
276 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT   (0x18)
277 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED     (0x22) /* obsolete */
278 #define MPI2_SCSI_STATUS_TASK_SET_FULL          (0x28)
279 #define MPI2_SCSI_STATUS_ACA_ACTIVE             (0x30)
280 #define MPI2_SCSI_STATUS_TASK_ABORTED           (0x40)
281 
282 /* SCSI IO Reply SCSIState flags */
283 
284 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID     (0x10)
285 #define MPI2_SCSI_STATE_TERMINATED              (0x08)
286 #define MPI2_SCSI_STATE_NO_SCSI_STATUS          (0x04)
287 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED        (0x02)
288 #define MPI2_SCSI_STATE_AUTOSENSE_VALID         (0x01)
289 
290 /* masks and shifts for the ResponseInfo field */
291 
292 #define MPI2_SCSI_RI_MASK_REASONCODE            (0x000000FF)
293 #define MPI2_SCSI_RI_SHIFT_REASONCODE           (0)
294 
295 #define MPI2_SCSI_TASKTAG_UNKNOWN               (0xFFFF)
296 
297 /****************************************************************************
298 *  SCSI Task Management messages
299 ****************************************************************************/
300 
301 /* SCSI Task Management Request Message */
302 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
303 {
304     U16                     DevHandle;                      /* 0x00 */
305     U8                      ChainOffset;                    /* 0x02 */
306     U8                      Function;                       /* 0x03 */
307     U8                      Reserved1;                      /* 0x04 */
308     U8                      TaskType;                       /* 0x05 */
309     U8                      Reserved2;                      /* 0x06 */
310     U8                      MsgFlags;                       /* 0x07 */
311     U8                      VP_ID;                          /* 0x08 */
312     U8                      VF_ID;                          /* 0x09 */
313     U16                     Reserved3;                      /* 0x0A */
314     U8                      LUN[8];                         /* 0x0C */
315     U32                     Reserved4[7];                   /* 0x14 */
316     U16                     TaskMID;                        /* 0x30 */
317     U16                     Reserved5;                      /* 0x32 */
318 } MPI2_SCSI_TASK_MANAGE_REQUEST,
319   MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
320   Mpi2SCSITaskManagementRequest_t,
321   MPI2_POINTER pMpi2SCSITaskManagementRequest_t;
322 
323 /* TaskType values */
324 
325 #define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK           (0x01)
326 #define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET        (0x02)
327 #define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET         (0x03)
328 #define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET   (0x05)
329 #define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET       (0x06)
330 #define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK           (0x07)
331 #define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA              (0x08)
332 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET         (0x09)
333 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT      (0x0A)
334 
335 /* obsolete TaskType name */
336 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION   (MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT)
337 
338 /* MsgFlags bits */
339 
340 #define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET    (0x18)
341 #define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET           (0x00)
342 #define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST     (0x08)
343 #define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET  (0x10)
344 
345 #define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU  (0x01)
346 
347 /* SCSI Task Management Reply Message */
348 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
349 {
350     U16                     DevHandle;                      /* 0x00 */
351     U8                      MsgLength;                      /* 0x02 */
352     U8                      Function;                       /* 0x03 */
353     U8                      ResponseCode;                   /* 0x04 */
354     U8                      TaskType;                       /* 0x05 */
355     U8                      Reserved1;                      /* 0x06 */
356     U8                      MsgFlags;                       /* 0x07 */
357     U8                      VP_ID;                          /* 0x08 */
358     U8                      VF_ID;                          /* 0x09 */
359     U16                     Reserved2;                      /* 0x0A */
360     U16                     Reserved3;                      /* 0x0C */
361     U16                     IOCStatus;                      /* 0x0E */
362     U32                     IOCLogInfo;                     /* 0x10 */
363     U32                     TerminationCount;               /* 0x14 */
364     U32                     ResponseInfo;                   /* 0x18 */
365 } MPI2_SCSI_TASK_MANAGE_REPLY,
366   MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
367   Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
368 
369 /* ResponseCode values */
370 
371 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE               (0x00)
372 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME             (0x02)
373 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED          (0x04)
374 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED                 (0x05)
375 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED              (0x08)
376 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN            (0x09)
377 #define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG         (0x0A)
378 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC          (0x80)
379 
380 /* masks and shifts for the ResponseInfo field */
381 
382 #define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE            (0x000000FF)
383 #define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE           (0)
384 #define MPI2_SCSITASKMGMT_RI_MASK_ARI2                  (0x0000FF00)
385 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2                 (8)
386 #define MPI2_SCSITASKMGMT_RI_MASK_ARI1                  (0x00FF0000)
387 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1                 (16)
388 #define MPI2_SCSITASKMGMT_RI_MASK_ARI0                  (0xFF000000)
389 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0                 (24)
390 
391 /****************************************************************************
392 *  SCSI Enclosure Processor messages
393 ****************************************************************************/
394 
395 /* SCSI Enclosure Processor Request Message */
396 typedef struct _MPI2_SEP_REQUEST
397 {
398     U16                     DevHandle;          /* 0x00 */
399     U8                      ChainOffset;        /* 0x02 */
400     U8                      Function;           /* 0x03 */
401     U8                      Action;             /* 0x04 */
402     U8                      Flags;              /* 0x05 */
403     U8                      Reserved1;          /* 0x06 */
404     U8                      MsgFlags;           /* 0x07 */
405     U8                      VP_ID;              /* 0x08 */
406     U8                      VF_ID;              /* 0x09 */
407     U16                     Reserved2;          /* 0x0A */
408     U32                     SlotStatus;         /* 0x0C */
409     U32                     Reserved3;          /* 0x10 */
410     U32                     Reserved4;          /* 0x14 */
411     U32                     Reserved5;          /* 0x18 */
412     U16                     Slot;               /* 0x1C */
413     U16                     EnclosureHandle;    /* 0x1E */
414 } MPI2_SEP_REQUEST, MPI2_POINTER PTR_MPI2_SEP_REQUEST,
415   Mpi2SepRequest_t, MPI2_POINTER pMpi2SepRequest_t;
416 
417 /* Action defines */
418 #define MPI2_SEP_REQ_ACTION_WRITE_STATUS                (0x00)
419 #define MPI2_SEP_REQ_ACTION_READ_STATUS                 (0x01)
420 
421 /* Flags defines */
422 #define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS            (0x00)
423 #define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS       (0x01)
424 
425 /* SlotStatus defines */
426 #define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE          (0x00040000)
427 #define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST        (0x00020000)
428 #define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED         (0x00000200)
429 #define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE               (0x00000100)
430 #define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED            (0x00000080)
431 #define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT         (0x00000040)
432 #define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY       (0x00000010)
433 #define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY         (0x00000008)
434 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING          (0x00000004)
435 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY              (0x00000002)
436 #define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR                (0x00000001)
437 
438 /* SCSI Enclosure Processor Reply Message */
439 typedef struct _MPI2_SEP_REPLY
440 {
441     U16                     DevHandle;          /* 0x00 */
442     U8                      MsgLength;          /* 0x02 */
443     U8                      Function;           /* 0x03 */
444     U8                      Action;             /* 0x04 */
445     U8                      Flags;              /* 0x05 */
446     U8                      Reserved1;          /* 0x06 */
447     U8                      MsgFlags;           /* 0x07 */
448     U8                      VP_ID;              /* 0x08 */
449     U8                      VF_ID;              /* 0x09 */
450     U16                     Reserved2;          /* 0x0A */
451     U16                     Reserved3;          /* 0x0C */
452     U16                     IOCStatus;          /* 0x0E */
453     U32                     IOCLogInfo;         /* 0x10 */
454     U32                     SlotStatus;         /* 0x14 */
455     U32                     Reserved4;          /* 0x18 */
456     U16                     Slot;               /* 0x1C */
457     U16                     EnclosureHandle;    /* 0x1E */
458 } MPI2_SEP_REPLY, MPI2_POINTER PTR_MPI2_SEP_REPLY,
459   Mpi2SepReply_t, MPI2_POINTER pMpi2SepReply_t;
460 
461 /* SlotStatus defines */
462 #define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY          (0x00040000)
463 #define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST      (0x00020000)
464 #define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED       (0x00000200)
465 #define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE             (0x00000100)
466 #define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED          (0x00000080)
467 #define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT       (0x00000040)
468 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY     (0x00000010)
469 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY       (0x00000008)
470 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING        (0x00000004)
471 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY            (0x00000002)
472 #define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR              (0x00000001)
473 
474 #endif
475