drivers/scsi/mpt3sas/mpi/mpi2_pci.h

   1 /*
   2  * Copyright 2000-2020 Broadcom Inc. All rights reserved.
   3  *
   4  *
   5  *          Name:  mpi2_pci.h
   6  *         Title:  MPI PCIe Attached Devices structures and definitions.
   7  * Creation Date:  October 9, 2012
   8  *
   9  * mpi2_pci.h Version:  02.00.03
  10  *
  11  * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
  12  *       prefix are for use only on MPI v2.5 products, and must not be used
  13  *       with MPI v2.0 products. Unless otherwise noted, names beginning with
  14  *       MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
  15  *
  16  * Version History
  17  * ---------------
  18  *
  19  * Date      Version   Description
  20  * --------  --------  ------------------------------------------------------
  21  * 03-16-15  02.00.00  Initial version.
  22  * 02-17-16  02.00.01  Removed AHCI support.
  23  *                     Removed SOP support.
  24  * 07-01-16  02.00.02  Added MPI26_NVME_FLAGS_FORCE_ADMIN_ERR_RESP to
  25  *                     NVME Encapsulated Request.
  26  * 07-22-18  02.00.03  Updted flags field for NVME Encapsulated req
  27  * --------------------------------------------------------------------------
  28  */
  29
  30 #ifndef MPI2_PCI_H
  31 #define MPI2_PCI_H
  32
  33
  34 /*
  35  *Values for the PCIe DeviceInfo field used in PCIe Device Status Change Event
  36  *data and PCIe Configuration pages.
  37  */
  38 #define MPI26_PCIE_DEVINFO_DIRECT_ATTACH        (0x00000010)
  39
  40 #define MPI26_PCIE_DEVINFO_MASK_DEVICE_TYPE     (0x0000000F)
  41 #define MPI26_PCIE_DEVINFO_NO_DEVICE            (0x00000000)
  42 #define MPI26_PCIE_DEVINFO_PCI_SWITCH           (0x00000001)
  43 #define MPI26_PCIE_DEVINFO_NVME                 (0x00000003)
  44
  45
  46 /****************************************************************************
  47 *  NVMe Encapsulated message
  48 ****************************************************************************/
  49
  50 /*NVME Encapsulated Request Message */
  51 typedef struct _MPI26_NVME_ENCAPSULATED_REQUEST {
  52         U16     DevHandle;                      /*0x00 */
  53         U8      ChainOffset;                    /*0x02 */
  54         U8      Function;                       /*0x03 */
  55         U16     EncapsulatedCommandLength;      /*0x04 */
  56         U8      Reserved1;                      /*0x06 */
  57         U8      MsgFlags;                       /*0x07 */
  58         U8      VP_ID;                          /*0x08 */
  59         U8      VF_ID;                          /*0x09 */
  60         U16     Reserved2;                      /*0x0A */
  61         U32     Reserved3;                      /*0x0C */
  62         U64     ErrorResponseBaseAddress;       /*0x10 */
  63         U16     ErrorResponseAllocationLength;  /*0x18 */
  64         U16     Flags;                          /*0x1A */
  65         U32     DataLength;                     /*0x1C */
  66         U8      NVMe_Command[4];                /*0x20 */
  67
  68 } MPI26_NVME_ENCAPSULATED_REQUEST, *PTR_MPI26_NVME_ENCAPSULATED_REQUEST,
  69         Mpi26NVMeEncapsulatedRequest_t, *pMpi26NVMeEncapsulatedRequest_t;
  70
  71 /*defines for the Flags field */
  72 #define MPI26_NVME_FLAGS_FORCE_ADMIN_ERR_RESP       (0x0020)
  73 /*Submission Queue Type*/
  74 #define MPI26_NVME_FLAGS_SUBMISSIONQ_MASK           (0x0010)
  75 #define MPI26_NVME_FLAGS_SUBMISSIONQ_IO             (0x0000)
  76 #define MPI26_NVME_FLAGS_SUBMISSIONQ_ADMIN          (0x0010)
  77 /*Error Response Address Space */
  78 #define MPI26_NVME_FLAGS_MASK_ERROR_RSP_ADDR        (0x000C)
  79 #define MPI26_NVME_FLAGS_MASK_ERROR_RSP_ADDR_MASK   (0x000C)
  80 #define MPI26_NVME_FLAGS_SYSTEM_RSP_ADDR            (0x0000)
  81 #define MPI26_NVME_FLAGS_IOCCTL_RSP_ADDR            (0x0008)
  82 /* Data Direction*/
  83 #define MPI26_NVME_FLAGS_DATADIRECTION_MASK         (0x0003)
  84 #define MPI26_NVME_FLAGS_NODATATRANSFER             (0x0000)
  85 #define MPI26_NVME_FLAGS_WRITE                      (0x0001)
  86 #define MPI26_NVME_FLAGS_READ                       (0x0002)
  87 #define MPI26_NVME_FLAGS_BIDIRECTIONAL              (0x0003)
  88
  89
  90 /*NVMe Encapuslated Reply Message */
  91 typedef struct _MPI26_NVME_ENCAPSULATED_ERROR_REPLY {
  92         U16     DevHandle;                      /*0x00 */
  93         U8      MsgLength;                      /*0x02 */
  94         U8      Function;                       /*0x03 */
  95         U16     EncapsulatedCommandLength;      /*0x04 */
  96         U8      Reserved1;                      /*0x06 */
  97         U8      MsgFlags;                       /*0x07 */
  98         U8      VP_ID;                          /*0x08 */
  99         U8      VF_ID;                          /*0x09 */
 100         U16     Reserved2;                      /*0x0A */
 101         U16     Reserved3;                      /*0x0C */
 102         U16     IOCStatus;                      /*0x0E */
 103         U32     IOCLogInfo;                     /*0x10 */
 104         U16     ErrorResponseCount;             /*0x14 */
 105         U16     Reserved4;                      /*0x16 */
 106 } MPI26_NVME_ENCAPSULATED_ERROR_REPLY,
 107         *PTR_MPI26_NVME_ENCAPSULATED_ERROR_REPLY,
 108         Mpi26NVMeEncapsulatedErrorReply_t,
 109         *pMpi26NVMeEncapsulatedErrorReply_t;
 110
 111
 112 #endif