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