/* * Copyright 2000-2020 Broadcom Inc. All rights reserved. * * * Name: mpi2_pci.h * Title: MPI PCIe Attached Devices structures and definitions. * Creation Date: October 9, 2012 * * mpi2_pci.h Version: 02.00.04 * * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25 * prefix are for use only on MPI v2.5 products, and must not be used * with MPI v2.0 products. Unless otherwise noted, names beginning with * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products. * * Version History * --------------- * * Date Version Description * -------- -------- ------------------------------------------------------ * 03-16-15 02.00.00 Initial version. * 02-17-16 02.00.01 Removed AHCI support. * Removed SOP support. * 07-01-16 02.00.02 Added MPI26_NVME_FLAGS_FORCE_ADMIN_ERR_RESP to * NVME Encapsulated Request. * 07-22-18 02.00.03 Updted flags field for NVME Encapsulated req * 12-17-18 02.00.04 Added MPI26_PCIE_DEVINFO_SCSI * Shortten some defines to be compatible with DOS * -------------------------------------------------------------------------- */ #ifndef MPI2_PCI_H #define MPI2_PCI_H /* *Values for the PCIe DeviceInfo field used in PCIe Device Status Change Event *data and PCIe Configuration pages. */ #define MPI26_PCIE_DEVINFO_DIRECT_ATTACH (0x00000010) #define MPI26_PCIE_DEVINFO_MASK_DEVICE_TYPE (0x0000000F) #define MPI26_PCIE_DEVINFO_NO_DEVICE (0x00000000) #define MPI26_PCIE_DEVINFO_PCI_SWITCH (0x00000001) #define MPI26_PCIE_DEVINFO_NVME (0x00000003) #define MPI26_PCIE_DEVINFO_SCSI (0x00000004) /**************************************************************************** * NVMe Encapsulated message ****************************************************************************/ /*NVME Encapsulated Request Message */ typedef struct _MPI26_NVME_ENCAPSULATED_REQUEST { U16 DevHandle; /*0x00 */ U8 ChainOffset; /*0x02 */ U8 Function; /*0x03 */ U16 EncapsulatedCommandLength; /*0x04 */ U8 Reserved1; /*0x06 */ U8 MsgFlags; /*0x07 */ U8 VP_ID; /*0x08 */ U8 VF_ID; /*0x09 */ U16 Reserved2; /*0x0A */ U32 Reserved3; /*0x0C */ U64 ErrorResponseBaseAddress; /*0x10 */ U16 ErrorResponseAllocationLength; /*0x18 */ U16 Flags; /*0x1A */ U32 DataLength; /*0x1C */ U8 NVMe_Command[4]; /*0x20 */ } MPI26_NVME_ENCAPSULATED_REQUEST, *PTR_MPI26_NVME_ENCAPSULATED_REQUEST, Mpi26NVMeEncapsulatedRequest_t, *pMpi26NVMeEncapsulatedRequest_t; /*defines for the Flags field */ #define MPI26_NVME_FLAGS_FORCE_ADMIN_ERR_RESP (0x0020) /*Submission Queue Type*/ #define MPI26_NVME_FLAGS_SUBMISSIONQ_MASK (0x0010) #define MPI26_NVME_FLAGS_SUBMISSIONQ_IO (0x0000) #define MPI26_NVME_FLAGS_SUBMISSIONQ_ADMIN (0x0010) /*Error Response Address Space */ #define MPI26_NVME_FLAGS_ERR_RSP_ADDR_MASK (0x000C) #define MPI26_NVME_FLAGS_ERR_RSP_ADDR_SYSTEM (0x0000) #define MPI26_NVME_FLAGS_ERR_RSP_ADDR_IOCTL (0x0008) /* Data Direction*/ #define MPI26_NVME_FLAGS_DATADIRECTION_MASK (0x0003) #define MPI26_NVME_FLAGS_NODATATRANSFER (0x0000) #define MPI26_NVME_FLAGS_WRITE (0x0001) #define MPI26_NVME_FLAGS_READ (0x0002) #define MPI26_NVME_FLAGS_BIDIRECTIONAL (0x0003) /*NVMe Encapuslated Reply Message */ typedef struct _MPI26_NVME_ENCAPSULATED_ERROR_REPLY { U16 DevHandle; /*0x00 */ U8 MsgLength; /*0x02 */ U8 Function; /*0x03 */ U16 EncapsulatedCommandLength; /*0x04 */ U8 Reserved1; /*0x06 */ U8 MsgFlags; /*0x07 */ U8 VP_ID; /*0x08 */ U8 VF_ID; /*0x09 */ U16 Reserved2; /*0x0A */ U16 Reserved3; /*0x0C */ U16 IOCStatus; /*0x0E */ U32 IOCLogInfo; /*0x10 */ U16 ErrorResponseCount; /*0x14 */ U16 Reserved4; /*0x16 */ } MPI26_NVME_ENCAPSULATED_ERROR_REPLY, *PTR_MPI26_NVME_ENCAPSULATED_ERROR_REPLY, Mpi26NVMeEncapsulatedErrorReply_t, *pMpi26NVMeEncapsulatedErrorReply_t; #endif