1265236Sken/*- 2283661Sslm * Copyright (c) 2012-2015 LSI Corp. 3299263Sslm * Copyright (c) 2013-2016 Avago Technologies 4265236Sken * All rights reserved. 5265236Sken * 6265236Sken * Redistribution and use in source and binary forms, with or without 7265236Sken * modification, are permitted provided that the following conditions 8265236Sken * are met: 9265236Sken * 1. Redistributions of source code must retain the above copyright 10265236Sken * notice, this list of conditions and the following disclaimer. 11265236Sken * 2. Redistributions in binary form must reproduce the above copyright 12265236Sken * notice, this list of conditions and the following disclaimer in the 13265236Sken * documentation and/or other materials provided with the distribution. 14265236Sken * 3. Neither the name of the author nor the names of any co-contributors 15265236Sken * may be used to endorse or promote products derived from this software 16265236Sken * without specific prior written permission. 17265236Sken * 18265236Sken * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19265236Sken * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20265236Sken * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21265236Sken * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22265236Sken * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23265236Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24265236Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25265236Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26265236Sken * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27265236Sken * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28265236Sken * SUCH DAMAGE. 29265236Sken * 30283661Sslm * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD 31265236Sken * 32265236Sken * $FreeBSD: stable/11/sys/dev/mpr/mpi/mpi2_init.h 319435 2017-06-01 15:39:09Z slm $ 33265236Sken */ 34265236Sken 35265236Sken/* 36283661Sslm * Copyright (c) 2000-2015 LSI Corporation. 37299263Sslm * Copyright (c) 2013-2016 Avago Technologies 38299263Sslm * All rights reserved. 39265236Sken * 40265236Sken * 41265236Sken * Name: mpi2_init.h 42265236Sken * Title: MPI SCSI initiator mode messages and structures 43265236Sken * Creation Date: June 23, 2006 44265236Sken * 45319435Sslm * mpi2_init.h Version: 02.00.21 46265236Sken * 47265236Sken * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25 48265236Sken * prefix are for use only on MPI v2.5 products, and must not be used 49265236Sken * with MPI v2.0 products. Unless otherwise noted, names beginning with 50265236Sken * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products. 51265236Sken * 52265236Sken * Version History 53265236Sken * --------------- 54265236Sken * 55265236Sken * Date Version Description 56265236Sken * -------- -------- ------------------------------------------------------ 57265236Sken * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A. 58265236Sken * 10-31-07 02.00.01 Fixed name for pMpi2SCSITaskManagementRequest_t. 59265236Sken * 12-18-07 02.00.02 Modified Task Management Target Reset Method defines. 60265236Sken * 02-29-08 02.00.03 Added Query Task Set and Query Unit Attention. 61265236Sken * 03-03-08 02.00.04 Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY. 62265236Sken * 05-21-08 02.00.05 Fixed typo in name of Mpi2SepRequest_t. 63265236Sken * 10-02-08 02.00.06 Removed Untagged and No Disconnect values from SCSI IO 64265236Sken * Control field Task Attribute flags. 65319435Sslm * Moved LUN field defines to mpi2.h because they are 66265236Sken * common to many structures. 67265236Sken * 05-06-09 02.00.07 Changed task management type of Query Unit Attention to 68265236Sken * Query Asynchronous Event. 69265236Sken * Defined two new bits in the SlotStatus field of the SCSI 70265236Sken * Enclosure Processor Request and Reply. 71265236Sken * 10-28-09 02.00.08 Added defines for decoding the ResponseInfo bytes for 72265236Sken * both SCSI IO Error Reply and SCSI Task Management Reply. 73265236Sken * Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY. 74265236Sken * Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define. 75265236Sken * 02-10-10 02.00.09 Removed unused structure that had "#if 0" around it. 76265236Sken * 05-12-10 02.00.10 Added optional vendor-unique region to SCSI IO Request. 77265236Sken * 11-10-10 02.00.11 Added MPI2_SCSIIO_NUM_SGLOFFSETS define. 78265236Sken * 11-18-11 02.00.12 Incorporating additions for MPI v2.5. 79265236Sken * 02-06-12 02.00.13 Added alternate defines for Task Priority / Command 80265236Sken * Priority to match SAM-4. 81265236Sken * Added EEDPErrorOffset to MPI2_SCSI_IO_REPLY. 82265236Sken * 07-10-12 02.00.14 Added MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION. 83265236Sken * 04-09-13 02.00.15 Added SCSIStatusQualifier field to MPI2_SCSI_IO_REPLY, 84265236Sken * replacing the Reserved4 field. 85299263Sslm * 11-18-14 02.00.16 Updated copyright information. 86299263Sslm * 03-16-15 02.00.17 Updated for MPI v2.6. 87299263Sslm * Added MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH. 88299263Sslm * Added MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF and 89299263Sslm * MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF. 90299263Sslm * 08-26-15 02.00.18 Added SCSITASKMGMT_MSGFLAGS for Target Reset. 91299263Sslm * 12-18-15 02.00.19 Added EEDPObservedValue added to SCSI IO Reply message. 92299263Sslm * 01-04-16 02.00.20 Modified EEDP reported values in SCSI IO Reply message. 93319435Sslm * 01-21-16 02.00.21 Modified MPI26_SCSITASKMGMT_MSGFLAGS_PCIE* defines to 94319435Sslm * be unique within first 32 characters. 95265236Sken * -------------------------------------------------------------------------- 96265236Sken */ 97265236Sken 98265236Sken#ifndef MPI2_INIT_H 99265236Sken#define MPI2_INIT_H 100265236Sken 101265236Sken/***************************************************************************** 102265236Sken* 103265236Sken* SCSI Initiator Messages 104265236Sken* 105265236Sken*****************************************************************************/ 106265236Sken 107265236Sken/**************************************************************************** 108265236Sken* SCSI IO messages and associated structures 109265236Sken****************************************************************************/ 110265236Sken 111265236Skentypedef struct _MPI2_SCSI_IO_CDB_EEDP32 112265236Sken{ 113265236Sken U8 CDB[20]; /* 0x00 */ 114265236Sken U32 PrimaryReferenceTag; /* 0x14 */ 115265236Sken U16 PrimaryApplicationTag; /* 0x18 */ 116265236Sken U16 PrimaryApplicationTagMask; /* 0x1A */ 117265236Sken U32 TransferLength; /* 0x1C */ 118265236Sken} MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32, 119265236Sken Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t; 120265236Sken 121265236Sken/* MPI v2.0 CDB field */ 122265236Skentypedef union _MPI2_SCSI_IO_CDB_UNION 123265236Sken{ 124265236Sken U8 CDB32[32]; 125265236Sken MPI2_SCSI_IO_CDB_EEDP32 EEDP32; 126265236Sken MPI2_SGE_SIMPLE_UNION SGE; 127265236Sken} MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION, 128265236Sken Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t; 129265236Sken 130265236Sken/* MPI v2.0 SCSI IO Request Message */ 131265236Skentypedef struct _MPI2_SCSI_IO_REQUEST 132265236Sken{ 133265236Sken U16 DevHandle; /* 0x00 */ 134265236Sken U8 ChainOffset; /* 0x02 */ 135265236Sken U8 Function; /* 0x03 */ 136265236Sken U16 Reserved1; /* 0x04 */ 137265236Sken U8 Reserved2; /* 0x06 */ 138265236Sken U8 MsgFlags; /* 0x07 */ 139265236Sken U8 VP_ID; /* 0x08 */ 140265236Sken U8 VF_ID; /* 0x09 */ 141265236Sken U16 Reserved3; /* 0x0A */ 142265236Sken U32 SenseBufferLowAddress; /* 0x0C */ 143265236Sken U16 SGLFlags; /* 0x10 */ 144265236Sken U8 SenseBufferLength; /* 0x12 */ 145265236Sken U8 Reserved4; /* 0x13 */ 146265236Sken U8 SGLOffset0; /* 0x14 */ 147265236Sken U8 SGLOffset1; /* 0x15 */ 148265236Sken U8 SGLOffset2; /* 0x16 */ 149265236Sken U8 SGLOffset3; /* 0x17 */ 150265236Sken U32 SkipCount; /* 0x18 */ 151265236Sken U32 DataLength; /* 0x1C */ 152265236Sken U32 BidirectionalDataLength; /* 0x20 */ 153265236Sken U16 IoFlags; /* 0x24 */ 154265236Sken U16 EEDPFlags; /* 0x26 */ 155265236Sken U32 EEDPBlockSize; /* 0x28 */ 156265236Sken U32 SecondaryReferenceTag; /* 0x2C */ 157265236Sken U16 SecondaryApplicationTag; /* 0x30 */ 158265236Sken U16 ApplicationTagTranslationMask; /* 0x32 */ 159265236Sken U8 LUN[8]; /* 0x34 */ 160265236Sken U32 Control; /* 0x3C */ 161265236Sken MPI2_SCSI_IO_CDB_UNION CDB; /* 0x40 */ 162265236Sken 163265236Sken#ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */ 164265236Sken MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion; 165265236Sken#endif 166265236Sken 167265236Sken MPI2_SGE_IO_UNION SGL; /* 0x60 */ 168265236Sken 169265236Sken} MPI2_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI2_SCSI_IO_REQUEST, 170265236Sken Mpi2SCSIIORequest_t, MPI2_POINTER pMpi2SCSIIORequest_t; 171265236Sken 172265236Sken/* SCSI IO MsgFlags bits */ 173265236Sken 174265236Sken/* MsgFlags for SenseBufferAddressSpace */ 175265236Sken#define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR (0x0C) 176265236Sken#define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR (0x00) 177265236Sken#define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR (0x04) 178299263Sslm#define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR (0x08) /* for MPI v2.5 and earlier only */ 179299263Sslm#define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR (0x0C) /* for MPI v2.5 and earlier only */ 180299263Sslm#define MPI26_SCSIIO_MSGFLAGS_IOCCTL_SENSE_ADDR (0x08) /* for MPI v2.6 only */ 181265236Sken 182265236Sken/* SCSI IO SGLFlags bits */ 183265236Sken 184265236Sken/* base values for Data Location Address Space */ 185265236Sken#define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK (0x0C) 186265236Sken#define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR (0x00) 187265236Sken#define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR (0x04) 188265236Sken#define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR (0x08) 189265236Sken#define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR (0x0C) 190265236Sken 191265236Sken/* base values for Type */ 192265236Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK (0x03) 193265236Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI (0x00) 194265236Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32 (0x01) 195265236Sken#define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64 (0x02) 196265236Sken 197265236Sken/* shift values for each sub-field */ 198265236Sken#define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT (12) 199265236Sken#define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT (8) 200265236Sken#define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT (4) 201265236Sken#define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT (0) 202265236Sken 203265236Sken/* number of SGLOffset fields */ 204265236Sken#define MPI2_SCSIIO_NUM_SGLOFFSETS (4) 205265236Sken 206265236Sken/* SCSI IO IoFlags bits */ 207265236Sken 208265236Sken/* Large CDB Address Space */ 209265236Sken#define MPI2_SCSIIO_CDB_ADDR_MASK (0x6000) 210265236Sken#define MPI2_SCSIIO_CDB_ADDR_SYSTEM (0x0000) 211265236Sken#define MPI2_SCSIIO_CDB_ADDR_IOCDDR (0x2000) 212265236Sken#define MPI2_SCSIIO_CDB_ADDR_IOCPLB (0x4000) 213265236Sken#define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA (0x6000) 214265236Sken 215265236Sken#define MPI2_SCSIIO_IOFLAGS_LARGE_CDB (0x1000) 216265236Sken#define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800) 217265236Sken#define MPI2_SCSIIO_IOFLAGS_MULTICAST (0x0400) 218265236Sken#define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200) 219265236Sken#define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF) 220265236Sken 221265236Sken/* SCSI IO EEDPFlags bits */ 222265236Sken 223265236Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000) 224265236Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG (0x4000) 225265236Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG (0x2000) 226265236Sken#define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG (0x1000) 227265236Sken 228265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG (0x0400) 229265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG (0x0200) 230265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD (0x0100) 231265236Sken 232265236Sken#define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG (0x0008) 233265236Sken 234265236Sken#define MPI2_SCSIIO_EEDPFLAGS_MASK_OP (0x0007) 235265236Sken#define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP (0x0000) 236265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP (0x0001) 237265236Sken#define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP (0x0002) 238265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP (0x0003) 239265236Sken#define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP (0x0004) 240265236Sken#define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP (0x0006) 241265236Sken#define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP (0x0007) 242265236Sken 243265236Sken/* SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */ 244265236Sken 245265236Sken/* SCSI IO Control bits */ 246265236Sken#define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK (0xFC000000) 247265236Sken#define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT (26) 248265236Sken 249265236Sken#define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK (0x03000000) 250265236Sken#define MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION (24) 251265236Sken#define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000) 252265236Sken#define MPI2_SCSIIO_CONTROL_WRITE (0x01000000) 253265236Sken#define MPI2_SCSIIO_CONTROL_READ (0x02000000) 254265236Sken#define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000) 255265236Sken 256265236Sken#define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800) 257265236Sken#define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11) 258265236Sken/* alternate name for the previous field; called Command Priority in SAM-4 */ 259265236Sken#define MPI2_SCSIIO_CONTROL_CMDPRI_MASK (0x00007800) 260265236Sken#define MPI2_SCSIIO_CONTROL_CMDPRI_SHIFT (11) 261265236Sken 262265236Sken#define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700) 263265236Sken#define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000) 264265236Sken#define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100) 265265236Sken#define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200) 266265236Sken#define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400) 267265236Sken 268265236Sken#define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0) 269265236Sken#define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000) 270265236Sken#define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040) 271265236Sken#define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080) 272265236Sken 273265236Sken 274265236Sken/* MPI v2.5 CDB field */ 275265236Skentypedef union _MPI25_SCSI_IO_CDB_UNION 276265236Sken{ 277265236Sken U8 CDB32[32]; 278265236Sken MPI2_SCSI_IO_CDB_EEDP32 EEDP32; 279265236Sken MPI2_IEEE_SGE_SIMPLE64 SGE; 280265236Sken} MPI25_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI25_SCSI_IO_CDB_UNION, 281265236Sken Mpi25ScsiIoCdb_t, MPI2_POINTER pMpi25ScsiIoCdb_t; 282265236Sken 283299263Sslm/* MPI v2.5/2.6 SCSI IO Request Message */ 284265236Skentypedef struct _MPI25_SCSI_IO_REQUEST 285265236Sken{ 286265236Sken U16 DevHandle; /* 0x00 */ 287265236Sken U8 ChainOffset; /* 0x02 */ 288265236Sken U8 Function; /* 0x03 */ 289265236Sken U16 Reserved1; /* 0x04 */ 290265236Sken U8 Reserved2; /* 0x06 */ 291265236Sken U8 MsgFlags; /* 0x07 */ 292265236Sken U8 VP_ID; /* 0x08 */ 293265236Sken U8 VF_ID; /* 0x09 */ 294265236Sken U16 Reserved3; /* 0x0A */ 295265236Sken U32 SenseBufferLowAddress; /* 0x0C */ 296265236Sken U8 DMAFlags; /* 0x10 */ 297265236Sken U8 Reserved5; /* 0x11 */ 298265236Sken U8 SenseBufferLength; /* 0x12 */ 299265236Sken U8 Reserved4; /* 0x13 */ 300265236Sken U8 SGLOffset0; /* 0x14 */ 301265236Sken U8 SGLOffset1; /* 0x15 */ 302265236Sken U8 SGLOffset2; /* 0x16 */ 303265236Sken U8 SGLOffset3; /* 0x17 */ 304265236Sken U32 SkipCount; /* 0x18 */ 305265236Sken U32 DataLength; /* 0x1C */ 306265236Sken U32 BidirectionalDataLength; /* 0x20 */ 307265236Sken U16 IoFlags; /* 0x24 */ 308265236Sken U16 EEDPFlags; /* 0x26 */ 309265236Sken U16 EEDPBlockSize; /* 0x28 */ 310265236Sken U16 Reserved6; /* 0x2A */ 311265236Sken U32 SecondaryReferenceTag; /* 0x2C */ 312265236Sken U16 SecondaryApplicationTag; /* 0x30 */ 313265236Sken U16 ApplicationTagTranslationMask; /* 0x32 */ 314265236Sken U8 LUN[8]; /* 0x34 */ 315265236Sken U32 Control; /* 0x3C */ 316265236Sken MPI25_SCSI_IO_CDB_UNION CDB; /* 0x40 */ 317265236Sken 318265236Sken#ifdef MPI25_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */ 319265236Sken MPI25_SCSI_IO_VENDOR_UNIQUE VendorRegion; 320265236Sken#endif 321265236Sken 322265236Sken MPI25_SGE_IO_UNION SGL; /* 0x60 */ 323265236Sken 324265236Sken} MPI25_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI25_SCSI_IO_REQUEST, 325265236Sken Mpi25SCSIIORequest_t, MPI2_POINTER pMpi25SCSIIORequest_t; 326265236Sken 327265236Sken/* use MPI2_SCSIIO_MSGFLAGS_ defines for the MsgFlags field */ 328265236Sken 329265236Sken/* Defines for the DMAFlags field 330265236Sken * Each setting affects 4 SGLS, from SGL0 to SGL3. 331265236Sken * D = Data 332265236Sken * C = Cache DIF 333265236Sken * I = Interleaved 334265236Sken * H = Host DIF 335265236Sken */ 336265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_MASK (0x0F) 337265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_D (0x00) 338265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_C (0x01) 339265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_I (0x02) 340265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_C (0x03) 341265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_I (0x04) 342265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_D_I_I (0x05) 343265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_C (0x06) 344265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_I (0x07) 345265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_C_I_I (0x08) 346265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_I_I_I (0x09) 347265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_D (0x0A) 348265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_C (0x0B) 349265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_I (0x0C) 350265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_C (0x0D) 351265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_I (0x0E) 352265236Sken#define MPI25_SCSIIO_DMAFLAGS_OP_D_H_I_I (0x0F) 353265236Sken 354265236Sken/* number of SGLOffset fields */ 355265236Sken#define MPI25_SCSIIO_NUM_SGLOFFSETS (4) 356265236Sken 357265236Sken/* defines for the IoFlags field */ 358265236Sken#define MPI25_SCSIIO_IOFLAGS_IO_PATH_MASK (0xC000) 359265236Sken#define MPI25_SCSIIO_IOFLAGS_NORMAL_PATH (0x0000) 360265236Sken#define MPI25_SCSIIO_IOFLAGS_FAST_PATH (0x4000) 361265236Sken 362299263Sslm#define MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH (0x2000) /* MPI v2.6 and later */ 363265236Sken#define MPI25_SCSIIO_IOFLAGS_LARGE_CDB (0x1000) 364265236Sken#define MPI25_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800) 365299263Sslm#define MPI26_SCSIIO_IOFLAGS_PORT_REQUEST (0x0400) /* MPI v2.6 and later; IOC use only */ 366265236Sken#define MPI25_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF) 367265236Sken 368265236Sken/* MPI v2.5 defines for the EEDPFlags bits */ 369265236Sken/* use MPI2_SCSIIO_EEDPFLAGS_ defines for the other EEDPFlags bits */ 370265236Sken#define MPI25_SCSIIO_EEDPFLAGS_ESCAPE_MODE_MASK (0x00C0) 371265236Sken#define MPI25_SCSIIO_EEDPFLAGS_COMPATIBLE_MODE (0x0000) 372265236Sken#define MPI25_SCSIIO_EEDPFLAGS_DO_NOT_DISABLE_MODE (0x0040) 373265236Sken#define MPI25_SCSIIO_EEDPFLAGS_APPTAG_DISABLE_MODE (0x0080) 374265236Sken#define MPI25_SCSIIO_EEDPFLAGS_APPTAG_REFTAG_DISABLE_MODE (0x00C0) 375265236Sken 376265236Sken#define MPI25_SCSIIO_EEDPFLAGS_HOST_GUARD_METHOD_MASK (0x0030) 377265236Sken#define MPI25_SCSIIO_EEDPFLAGS_T10_CRC_HOST_GUARD (0x0000) 378265236Sken#define MPI25_SCSIIO_EEDPFLAGS_IP_CHKSUM_HOST_GUARD (0x0010) 379265236Sken 380265236Sken/* use MPI2_LUN_ defines from mpi2.h for the LUN field */ 381265236Sken 382265236Sken/* use MPI2_SCSIIO_CONTROL_ defines for the Control field */ 383265236Sken 384265236Sken 385265236Sken/* NOTE: The SCSI IO Reply is nearly the same for MPI 2.0 and MPI 2.5, so 386265236Sken * MPI2_SCSI_IO_REPLY is used for both. 387265236Sken */ 388265236Sken 389265236Sken/* SCSI IO Error Reply Message */ 390265236Skentypedef struct _MPI2_SCSI_IO_REPLY 391265236Sken{ 392265236Sken U16 DevHandle; /* 0x00 */ 393265236Sken U8 MsgLength; /* 0x02 */ 394265236Sken U8 Function; /* 0x03 */ 395265236Sken U16 Reserved1; /* 0x04 */ 396265236Sken U8 Reserved2; /* 0x06 */ 397265236Sken U8 MsgFlags; /* 0x07 */ 398265236Sken U8 VP_ID; /* 0x08 */ 399265236Sken U8 VF_ID; /* 0x09 */ 400265236Sken U16 Reserved3; /* 0x0A */ 401265236Sken U8 SCSIStatus; /* 0x0C */ 402265236Sken U8 SCSIState; /* 0x0D */ 403265236Sken U16 IOCStatus; /* 0x0E */ 404265236Sken U32 IOCLogInfo; /* 0x10 */ 405265236Sken U32 TransferCount; /* 0x14 */ 406265236Sken U32 SenseCount; /* 0x18 */ 407265236Sken U32 ResponseInfo; /* 0x1C */ 408265236Sken U16 TaskTag; /* 0x20 */ 409265236Sken U16 SCSIStatusQualifier; /* 0x22 */ 410265236Sken U32 BidirectionalTransferCount; /* 0x24 */ 411299263Sslm U32 EEDPErrorOffset; /* 0x28 */ /* MPI 2.5+ only; Reserved in MPI 2.0 */ 412299263Sslm U16 EEDPObservedAppTag; /* 0x2C */ /* MPI 2.5+ only; Reserved in MPI 2.0 */ 413299263Sslm U16 EEDPObservedGuard; /* 0x2E */ /* MPI 2.5+ only; Reserved in MPI 2.0 */ 414299263Sslm U32 EEDPObservedRefTag; /* 0x30 */ /* MPI 2.5+ only; Reserved in MPI 2.0 */ 415265236Sken} MPI2_SCSI_IO_REPLY, MPI2_POINTER PTR_MPI2_SCSI_IO_REPLY, 416265236Sken Mpi2SCSIIOReply_t, MPI2_POINTER pMpi2SCSIIOReply_t; 417265236Sken 418299263Sslm/* SCSI IO Reply MsgFlags bits */ 419299263Sslm#define MPI26_SCSIIO_REPLY_MSGFLAGS_REFTAG_OBSERVED_VALID (0x01) 420299263Sslm#define MPI26_SCSIIO_REPLY_MSGFLAGS_GUARD_OBSERVED_VALID (0x02) 421299263Sslm#define MPI26_SCSIIO_REPLY_MSGFLAGS_APPTAG_OBSERVED_VALID (0x04) 422299263Sslm 423299263Sslm 424265236Sken/* SCSI IO Reply SCSIStatus values (SAM-4 status codes) */ 425265236Sken 426265236Sken#define MPI2_SCSI_STATUS_GOOD (0x00) 427265236Sken#define MPI2_SCSI_STATUS_CHECK_CONDITION (0x02) 428265236Sken#define MPI2_SCSI_STATUS_CONDITION_MET (0x04) 429265236Sken#define MPI2_SCSI_STATUS_BUSY (0x08) 430265236Sken#define MPI2_SCSI_STATUS_INTERMEDIATE (0x10) 431265236Sken#define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET (0x14) 432265236Sken#define MPI2_SCSI_STATUS_RESERVATION_CONFLICT (0x18) 433265236Sken#define MPI2_SCSI_STATUS_COMMAND_TERMINATED (0x22) /* obsolete */ 434265236Sken#define MPI2_SCSI_STATUS_TASK_SET_FULL (0x28) 435265236Sken#define MPI2_SCSI_STATUS_ACA_ACTIVE (0x30) 436265236Sken#define MPI2_SCSI_STATUS_TASK_ABORTED (0x40) 437265236Sken 438265236Sken/* SCSI IO Reply SCSIState flags */ 439265236Sken 440265236Sken#define MPI2_SCSI_STATE_RESPONSE_INFO_VALID (0x10) 441265236Sken#define MPI2_SCSI_STATE_TERMINATED (0x08) 442265236Sken#define MPI2_SCSI_STATE_NO_SCSI_STATUS (0x04) 443265236Sken#define MPI2_SCSI_STATE_AUTOSENSE_FAILED (0x02) 444265236Sken#define MPI2_SCSI_STATE_AUTOSENSE_VALID (0x01) 445265236Sken 446265236Sken/* masks and shifts for the ResponseInfo field */ 447265236Sken 448265236Sken#define MPI2_SCSI_RI_MASK_REASONCODE (0x000000FF) 449265236Sken#define MPI2_SCSI_RI_SHIFT_REASONCODE (0) 450265236Sken 451265236Sken#define MPI2_SCSI_TASKTAG_UNKNOWN (0xFFFF) 452265236Sken 453265236Sken 454265236Sken/**************************************************************************** 455265236Sken* SCSI Task Management messages 456265236Sken****************************************************************************/ 457265236Sken 458265236Sken/* SCSI Task Management Request Message */ 459265236Skentypedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST 460265236Sken{ 461265236Sken U16 DevHandle; /* 0x00 */ 462265236Sken U8 ChainOffset; /* 0x02 */ 463265236Sken U8 Function; /* 0x03 */ 464265236Sken U8 Reserved1; /* 0x04 */ 465265236Sken U8 TaskType; /* 0x05 */ 466265236Sken U8 Reserved2; /* 0x06 */ 467265236Sken U8 MsgFlags; /* 0x07 */ 468265236Sken U8 VP_ID; /* 0x08 */ 469265236Sken U8 VF_ID; /* 0x09 */ 470265236Sken U16 Reserved3; /* 0x0A */ 471265236Sken U8 LUN[8]; /* 0x0C */ 472265236Sken U32 Reserved4[7]; /* 0x14 */ 473265236Sken U16 TaskMID; /* 0x30 */ 474265236Sken U16 Reserved5; /* 0x32 */ 475265236Sken} MPI2_SCSI_TASK_MANAGE_REQUEST, 476265236Sken MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REQUEST, 477265236Sken Mpi2SCSITaskManagementRequest_t, 478265236Sken MPI2_POINTER pMpi2SCSITaskManagementRequest_t; 479265236Sken 480265236Sken/* TaskType values */ 481265236Sken 482265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK (0x01) 483265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET (0x02) 484265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET (0x03) 485265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET (0x05) 486265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET (0x06) 487265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK (0x07) 488265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA (0x08) 489265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET (0x09) 490265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT (0x0A) 491265236Sken 492265236Sken/* obsolete TaskType name */ 493265236Sken#define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION (MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT) 494265236Sken 495265236Sken/* MsgFlags bits */ 496319435Sslm#define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET (0x18) 497319435Sslm#define MPI26_SCSITASKMGMT_MSGFLAGS_HOT_RESET_PCIE (0x00) 498319435Sslm#define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET (0x00) 499299263Sslm#define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU (0x01) 500319435Sslm#define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST (0x08) 501319435Sslm#define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET (0x10) 502319435Sslm#define MPI26_SCSITASKMGMT_MSGFLAGS_PROTOCOL_LVL_RST_PCIE (0x18) 503265236Sken 504265236Sken 505265236Sken/* SCSI Task Management Reply Message */ 506265236Skentypedef struct _MPI2_SCSI_TASK_MANAGE_REPLY 507265236Sken{ 508265236Sken U16 DevHandle; /* 0x00 */ 509265236Sken U8 MsgLength; /* 0x02 */ 510265236Sken U8 Function; /* 0x03 */ 511265236Sken U8 ResponseCode; /* 0x04 */ 512265236Sken U8 TaskType; /* 0x05 */ 513265236Sken U8 Reserved1; /* 0x06 */ 514265236Sken U8 MsgFlags; /* 0x07 */ 515265236Sken U8 VP_ID; /* 0x08 */ 516265236Sken U8 VF_ID; /* 0x09 */ 517265236Sken U16 Reserved2; /* 0x0A */ 518265236Sken U16 Reserved3; /* 0x0C */ 519265236Sken U16 IOCStatus; /* 0x0E */ 520265236Sken U32 IOCLogInfo; /* 0x10 */ 521265236Sken U32 TerminationCount; /* 0x14 */ 522265236Sken U32 ResponseInfo; /* 0x18 */ 523265236Sken} MPI2_SCSI_TASK_MANAGE_REPLY, 524265236Sken MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY, 525265236Sken Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t; 526265236Sken 527265236Sken/* ResponseCode values */ 528265236Sken 529265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE (0x00) 530265236Sken#define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME (0x02) 531265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED (0x04) 532265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_FAILED (0x05) 533265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED (0x08) 534265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN (0x09) 535265236Sken#define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG (0x0A) 536265236Sken#define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC (0x80) 537265236Sken 538265236Sken/* masks and shifts for the ResponseInfo field */ 539265236Sken 540265236Sken#define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE (0x000000FF) 541265236Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE (0) 542265236Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI2 (0x0000FF00) 543265236Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2 (8) 544265236Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI1 (0x00FF0000) 545265236Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1 (16) 546265236Sken#define MPI2_SCSITASKMGMT_RI_MASK_ARI0 (0xFF000000) 547265236Sken#define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0 (24) 548265236Sken 549265236Sken 550265236Sken/**************************************************************************** 551265236Sken* SCSI Enclosure Processor messages 552265236Sken****************************************************************************/ 553265236Sken 554265236Sken/* SCSI Enclosure Processor Request Message */ 555265236Skentypedef struct _MPI2_SEP_REQUEST 556265236Sken{ 557265236Sken U16 DevHandle; /* 0x00 */ 558265236Sken U8 ChainOffset; /* 0x02 */ 559265236Sken U8 Function; /* 0x03 */ 560265236Sken U8 Action; /* 0x04 */ 561265236Sken U8 Flags; /* 0x05 */ 562265236Sken U8 Reserved1; /* 0x06 */ 563265236Sken U8 MsgFlags; /* 0x07 */ 564265236Sken U8 VP_ID; /* 0x08 */ 565265236Sken U8 VF_ID; /* 0x09 */ 566265236Sken U16 Reserved2; /* 0x0A */ 567265236Sken U32 SlotStatus; /* 0x0C */ 568265236Sken U32 Reserved3; /* 0x10 */ 569265236Sken U32 Reserved4; /* 0x14 */ 570265236Sken U32 Reserved5; /* 0x18 */ 571265236Sken U16 Slot; /* 0x1C */ 572265236Sken U16 EnclosureHandle; /* 0x1E */ 573265236Sken} MPI2_SEP_REQUEST, MPI2_POINTER PTR_MPI2_SEP_REQUEST, 574265236Sken Mpi2SepRequest_t, MPI2_POINTER pMpi2SepRequest_t; 575265236Sken 576265236Sken/* Action defines */ 577265236Sken#define MPI2_SEP_REQ_ACTION_WRITE_STATUS (0x00) 578265236Sken#define MPI2_SEP_REQ_ACTION_READ_STATUS (0x01) 579265236Sken 580265236Sken/* Flags defines */ 581265236Sken#define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS (0x00) 582265236Sken#define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS (0x01) 583265236Sken 584265236Sken/* SlotStatus defines */ 585299263Sslm#define MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF (0x00080000) /* MPI v2.6 and newer */ 586265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE (0x00040000) 587265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000) 588265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED (0x00000200) 589265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE (0x00000100) 590265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED (0x00000080) 591265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT (0x00000040) 592265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY (0x00000010) 593265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY (0x00000008) 594265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING (0x00000004) 595265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY (0x00000002) 596265236Sken#define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR (0x00000001) 597265236Sken 598265236Sken 599265236Sken/* SCSI Enclosure Processor Reply Message */ 600265236Skentypedef struct _MPI2_SEP_REPLY 601265236Sken{ 602265236Sken U16 DevHandle; /* 0x00 */ 603265236Sken U8 MsgLength; /* 0x02 */ 604265236Sken U8 Function; /* 0x03 */ 605265236Sken U8 Action; /* 0x04 */ 606265236Sken U8 Flags; /* 0x05 */ 607265236Sken U8 Reserved1; /* 0x06 */ 608265236Sken U8 MsgFlags; /* 0x07 */ 609265236Sken U8 VP_ID; /* 0x08 */ 610265236Sken U8 VF_ID; /* 0x09 */ 611265236Sken U16 Reserved2; /* 0x0A */ 612265236Sken U16 Reserved3; /* 0x0C */ 613265236Sken U16 IOCStatus; /* 0x0E */ 614265236Sken U32 IOCLogInfo; /* 0x10 */ 615265236Sken U32 SlotStatus; /* 0x14 */ 616265236Sken U32 Reserved4; /* 0x18 */ 617265236Sken U16 Slot; /* 0x1C */ 618265236Sken U16 EnclosureHandle; /* 0x1E */ 619265236Sken} MPI2_SEP_REPLY, MPI2_POINTER PTR_MPI2_SEP_REPLY, 620265236Sken Mpi2SepReply_t, MPI2_POINTER pMpi2SepReply_t; 621265236Sken 622265236Sken/* SlotStatus defines */ 623299263Sslm#define MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF (0x00080000) /* MPI v2.6 and newer */ 624265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY (0x00040000) 625265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST (0x00020000) 626265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED (0x00000200) 627265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE (0x00000100) 628265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED (0x00000080) 629265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT (0x00000040) 630265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY (0x00000010) 631265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY (0x00000008) 632265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING (0x00000004) 633265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY (0x00000002) 634265236Sken#define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR (0x00000001) 635265236Sken 636265236Sken 637265236Sken#endif 638265236Sken 639265236Sken 640