Linux Audio

Check our new training course

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