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