2 * Copyright (c) 2000-2008 LSI Corporation.
6 * Title: MPI SCSI initiator mode messages and structures
7 * Creation Date: June 23, 2006
9 * mpi2_init.h Version: 02.00.06
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 becasue they are
25 * common to many structures.
26 * --------------------------------------------------------------------------
32 /*****************************************************************************
34 * SCSI Initiator Messages
36 *****************************************************************************/
38 /****************************************************************************
39 * SCSI IO messages and associated structures
40 ****************************************************************************/
44 U8 CDB[20]; /* 0x00 */
45 U32 PrimaryReferenceTag; /* 0x14 */
46 U16 PrimaryApplicationTag; /* 0x18 */
47 U16 PrimaryApplicationTagMask; /* 0x1A */
48 U32 TransferLength; /* 0x1C */
49 } MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
50 Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
52 /* TBD: I don't think this is needed for MPI2/Gen2 */
56 U8 CDB[16]; /* 0x00 */
57 U32 DataLength; /* 0x10 */
58 U32 PrimaryReferenceTag; /* 0x14 */
59 U16 PrimaryApplicationTag; /* 0x18 */
60 U16 PrimaryApplicationTagMask; /* 0x1A */
61 U32 TransferLength; /* 0x1C */
62 } MPI2_SCSI_IO32_CDB_EEDP16, MPI2_POINTER PTR_MPI2_SCSI_IO32_CDB_EEDP16,
63 Mpi2ScsiIo32CdbEedp16_t, MPI2_POINTER pMpi2ScsiIo32CdbEedp16_t;
69 MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
70 MPI2_SGE_SIMPLE_UNION SGE;
71 } MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
72 Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
74 /* SCSI IO Request Message */
75 typedef struct _MPI2_SCSI_IO_REQUEST
77 U16 DevHandle; /* 0x00 */
78 U8 ChainOffset; /* 0x02 */
79 U8 Function; /* 0x03 */
80 U16 Reserved1; /* 0x04 */
81 U8 Reserved2; /* 0x06 */
82 U8 MsgFlags; /* 0x07 */
85 U16 Reserved3; /* 0x0A */
86 U32 SenseBufferLowAddress; /* 0x0C */
87 U16 SGLFlags; /* 0x10 */
88 U8 SenseBufferLength; /* 0x12 */
89 U8 Reserved4; /* 0x13 */
90 U8 SGLOffset0; /* 0x14 */
91 U8 SGLOffset1; /* 0x15 */
92 U8 SGLOffset2; /* 0x16 */
93 U8 SGLOffset3; /* 0x17 */
94 U32 SkipCount; /* 0x18 */
95 U32 DataLength; /* 0x1C */
96 U32 BidirectionalDataLength; /* 0x20 */
97 U16 IoFlags; /* 0x24 */
98 U16 EEDPFlags; /* 0x26 */
99 U32 EEDPBlockSize; /* 0x28 */
100 U32 SecondaryReferenceTag; /* 0x2C */
101 U16 SecondaryApplicationTag; /* 0x30 */
102 U16 ApplicationTagTranslationMask; /* 0x32 */
103 U8 LUN[8]; /* 0x34 */
104 U32 Control; /* 0x3C */
105 MPI2_SCSI_IO_CDB_UNION CDB; /* 0x40 */
106 MPI2_SGE_IO_UNION SGL; /* 0x60 */
107 } MPI2_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI2_SCSI_IO_REQUEST,
108 Mpi2SCSIIORequest_t, MPI2_POINTER pMpi2SCSIIORequest_t;
110 /* SCSI IO MsgFlags bits */
112 /* MsgFlags for SenseBufferAddressSpace */
113 #define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR (0x0C)
114 #define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR (0x00)
115 #define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR (0x04)
116 #define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR (0x08)
117 #define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR (0x0C)
119 /* SCSI IO SGLFlags bits */
121 /* base values for Data Location Address Space */
122 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK (0x0C)
123 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR (0x00)
124 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR (0x04)
125 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR (0x08)
126 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR (0x0C)
128 /* base values for Type */
129 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK (0x03)
130 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI (0x00)
131 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32 (0x01)
132 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64 (0x02)
134 /* shift values for each sub-field */
135 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT (12)
136 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT (8)
137 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT (4)
138 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT (0)
140 /* SCSI IO IoFlags bits */
142 /* Large CDB Address Space */
143 #define MPI2_SCSIIO_CDB_ADDR_MASK (0x6000)
144 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM (0x0000)
145 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR (0x2000)
146 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB (0x4000)
147 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA (0x6000)
149 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
150 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
151 #define MPI2_SCSIIO_IOFLAGS_MULTICAST (0x0400)
152 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
153 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
155 /* SCSI IO EEDPFlags bits */
157 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000)
158 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG (0x4000)
159 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG (0x2000)
160 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG (0x1000)
162 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG (0x0400)
163 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG (0x0200)
164 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD (0x0100)
166 #define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG (0x0008)
168 #define MPI2_SCSIIO_EEDPFLAGS_MASK_OP (0x0007)
169 #define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP (0x0000)
170 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP (0x0001)
171 #define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP (0x0002)
172 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP (0x0003)
173 #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP (0x0004)
174 #define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP (0x0006)
175 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP (0x0007)
177 /* SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
179 /* SCSI IO Control bits */
180 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK (0xFC000000)
181 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT (26)
183 #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK (0x03000000)
184 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000)
185 #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000)
186 #define MPI2_SCSIIO_CONTROL_READ (0x02000000)
187 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000)
189 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800)
190 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11)
192 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700)
193 #define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000)
194 #define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100)
195 #define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200)
196 #define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400)
198 #define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0)
199 #define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000)
200 #define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040)
201 #define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080)
204 /* SCSI IO Error Reply Message */
205 typedef struct _MPI2_SCSI_IO_REPLY
207 U16 DevHandle; /* 0x00 */
208 U8 MsgLength; /* 0x02 */
209 U8 Function; /* 0x03 */
210 U16 Reserved1; /* 0x04 */
211 U8 Reserved2; /* 0x06 */
212 U8 MsgFlags; /* 0x07 */
215 U16 Reserved3; /* 0x0A */
216 U8 SCSIStatus; /* 0x0C */
217 U8 SCSIState; /* 0x0D */
218 U16 IOCStatus; /* 0x0E */
219 U32 IOCLogInfo; /* 0x10 */
220 U32 TransferCount; /* 0x14 */
221 U32 SenseCount; /* 0x18 */
222 U32 ResponseInfo; /* 0x1C */
223 U16 TaskTag; /* 0x20 */
224 U16 Reserved4; /* 0x22 */
225 U32 BidirectionalTransferCount; /* 0x24 */
226 U32 Reserved5; /* 0x28 */
227 U32 Reserved6; /* 0x2C */
228 } MPI2_SCSI_IO_REPLY, MPI2_POINTER PTR_MPI2_SCSI_IO_REPLY,
229 Mpi2SCSIIOReply_t, MPI2_POINTER pMpi2SCSIIOReply_t;
231 /* SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
233 #define MPI2_SCSI_STATUS_GOOD (0x00)
234 #define MPI2_SCSI_STATUS_CHECK_CONDITION (0x02)
235 #define MPI2_SCSI_STATUS_CONDITION_MET (0x04)
236 #define MPI2_SCSI_STATUS_BUSY (0x08)
237 #define MPI2_SCSI_STATUS_INTERMEDIATE (0x10)
238 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET (0x14)
239 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT (0x18)
240 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED (0x22) /* obsolete */
241 #define MPI2_SCSI_STATUS_TASK_SET_FULL (0x28)
242 #define MPI2_SCSI_STATUS_ACA_ACTIVE (0x30)
243 #define MPI2_SCSI_STATUS_TASK_ABORTED (0x40)
245 /* SCSI IO Reply SCSIState flags */
247 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID (0x10)
248 #define MPI2_SCSI_STATE_TERMINATED (0x08)
249 #define MPI2_SCSI_STATE_NO_SCSI_STATUS (0x04)
250 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED (0x02)
251 #define MPI2_SCSI_STATE_AUTOSENSE_VALID (0x01)
253 #define MPI2_SCSI_TASKTAG_UNKNOWN (0xFFFF)
256 /****************************************************************************
257 * SCSI Task Management messages
258 ****************************************************************************/
260 /* SCSI Task Management Request Message */
261 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
263 U16 DevHandle; /* 0x00 */
264 U8 ChainOffset; /* 0x02 */
265 U8 Function; /* 0x03 */
266 U8 Reserved1; /* 0x04 */
267 U8 TaskType; /* 0x05 */
268 U8 Reserved2; /* 0x06 */
269 U8 MsgFlags; /* 0x07 */
272 U16 Reserved3; /* 0x0A */
273 U8 LUN[8]; /* 0x0C */
274 U32 Reserved4[7]; /* 0x14 */
275 U16 TaskMID; /* 0x30 */
276 U16 Reserved5; /* 0x32 */
277 } MPI2_SCSI_TASK_MANAGE_REQUEST,
278 MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
279 Mpi2SCSITaskManagementRequest_t,
280 MPI2_POINTER pMpi2SCSITaskManagementRequest_t;
282 /* TaskType values */
284 #define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK (0x01)
285 #define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET (0x02)
286 #define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET (0x03)
287 #define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET (0x05)
288 #define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET (0x06)
289 #define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK (0x07)
290 #define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA (0x08)
291 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET (0x09)
292 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION (0x0A)
296 #define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET (0x18)
297 #define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET (0x00)
298 #define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST (0x08)
299 #define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET (0x10)
301 #define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU (0x01)
305 /* SCSI Task Management Reply Message */
306 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
308 U16 DevHandle; /* 0x00 */
309 U8 MsgLength; /* 0x02 */
310 U8 Function; /* 0x03 */
311 U8 ResponseCode; /* 0x04 */
312 U8 TaskType; /* 0x05 */
313 U8 Reserved1; /* 0x06 */
314 U8 MsgFlags; /* 0x07 */
317 U16 Reserved2; /* 0x0A */
318 U16 Reserved3; /* 0x0C */
319 U16 IOCStatus; /* 0x0E */
320 U32 IOCLogInfo; /* 0x10 */
321 U32 TerminationCount; /* 0x14 */
322 } MPI2_SCSI_TASK_MANAGE_REPLY,
323 MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
324 Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
326 /* ResponseCode values */
328 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE (0x00)
329 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME (0x02)
330 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED (0x04)
331 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED (0x05)
332 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED (0x08)
333 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN (0x09)
334 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC (0x80)
337 /****************************************************************************
338 * SCSI Enclosure Processor messages
339 ****************************************************************************/
341 /* SCSI Enclosure Processor Request Message */
342 typedef struct _MPI2_SEP_REQUEST
344 U16 DevHandle; /* 0x00 */
345 U8 ChainOffset; /* 0x02 */
346 U8 Function; /* 0x03 */
347 U8 Action; /* 0x04 */
349 U8 Reserved1; /* 0x06 */
350 U8 MsgFlags; /* 0x07 */
353 U16 Reserved2; /* 0x0A */
354 U32 SlotStatus; /* 0x0C */
355 U32 Reserved3; /* 0x10 */
356 U32 Reserved4; /* 0x14 */
357 U32 Reserved5; /* 0x18 */
359 U16 EnclosureHandle; /* 0x1E */
360 } MPI2_SEP_REQUEST, MPI2_POINTER PTR_MPI2_SEP_REQUEST,
361 Mpi2SepRequest_t, MPI2_POINTER pMpi2SepRequest_t;
364 #define MPI2_SEP_REQ_ACTION_WRITE_STATUS (0x00)
365 #define MPI2_SEP_REQ_ACTION_READ_STATUS (0x01)
368 #define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS (0x00)
369 #define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS (0x01)
371 /* SlotStatus defines */
372 #define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE (0x00040000)
373 #define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000)
374 #define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED (0x00000200)
375 #define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE (0x00000100)
376 #define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED (0x00000080)
377 #define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT (0x00000040)
378 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING (0x00000004)
379 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY (0x00000002)
380 #define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR (0x00000001)
383 /* SCSI Enclosure Processor Reply Message */
384 typedef struct _MPI2_SEP_REPLY
386 U16 DevHandle; /* 0x00 */
387 U8 MsgLength; /* 0x02 */
388 U8 Function; /* 0x03 */
389 U8 Action; /* 0x04 */
391 U8 Reserved1; /* 0x06 */
392 U8 MsgFlags; /* 0x07 */
395 U16 Reserved2; /* 0x0A */
396 U16 Reserved3; /* 0x0C */
397 U16 IOCStatus; /* 0x0E */
398 U32 IOCLogInfo; /* 0x10 */
399 U32 SlotStatus; /* 0x14 */
400 U32 Reserved4; /* 0x18 */
402 U16 EnclosureHandle; /* 0x1E */
403 } MPI2_SEP_REPLY, MPI2_POINTER PTR_MPI2_SEP_REPLY,
404 Mpi2SepReply_t, MPI2_POINTER pMpi2SepReply_t;
406 /* SlotStatus defines */
407 #define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY (0x00040000)
408 #define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000)
409 #define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED (0x00000200)
410 #define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE (0x00000100)
411 #define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED (0x00000080)
412 #define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT (0x00000040)
413 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING (0x00000004)
414 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY (0x00000002)
415 #define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR (0x00000001)