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