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