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