MdePkg/Include/IndustryStandard/PciExpress60.h

/** @file
Support for the PCI Express 6.0 standard.

This header file may not define all structures.  Please extend as required.

Copyright (c) 2024, American Megatrends International LLC. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#pragma once

#include <IndustryStandard/PciExpress50.h>

/// The Physical Layer PCI Express Extended Capability definitions.
///
/// Based on section 7.7.7 of PCI Express Base Specification 6.0.
///@{
#define PCI_EXPRESS_EXTENDED_CAPABILITY_PHYSICAL_LAYER_64_0_ID    0x0031
#define PCI_EXPRESS_EXTENDED_CAPABILITY_PHYSICAL_LAYER_64_0_VER1  0x1

// Register offsets from Physical Layer PCI-E Ext Cap Header
#define PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CAPABILITIES_OFFSET               0x04
#define PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CONTROL_OFFSET                    0x08
#define PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_STATUS_OFFSET                     0x0C
#define PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_LANE_EQUALIZATION_CONTROL_OFFSET  0x10

#define PCI_EXPRESS_EXTENDED_CAPABILITY_DEVICE3_ID    0x002F
#define PCI_EXPRESS_EXTENDED_CAPABILITY_DEVICE3_VER1  0x1

#define EFI_PCIE_CAPABILITY_DEVICE_CAPABILITIES_3_OFFSET  0x04
#define EFI_PCIE_CAPABILITY_DEVICE_CONTROL_3_OFFSET       0x08
#define EFI_PCIE_CAPABILITY_DEVICE_STATUS_3_OFFSET        0x0C

#pragma pack(1)

typedef union {
  struct {
    UINT32    Reserved : 32;               // Reserved bit 0:31
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CAPABILITIES;

typedef union {
  struct {
    UINT32    Reserved : 32;               // Reserved bit 0:31
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CONTROL;

typedef union {
  struct {
    UINT32    EqualizationComplete      : 1;  // bit 0
    UINT32    EqualizationPhase1Success : 1;  // bit 1
    UINT32    EqualizationPhase2Success : 1;  // bit 2
    UINT32    EqualizationPhase3Success : 1;  // bit 3
    UINT32    LinkEqualizationRequest   : 1;  // bit 4
    UINT32    TransmitterPrecodingOn    : 1;  // bit 5
    UINT32    TransmitterPrecodeRequest : 1;  // bit 6
    UINT32    NoEqualizationNeededRcvd  : 1;  // bit 7
    UINT32    Reserved                  : 24; // Reserved bit 8:31
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_STATUS;

typedef union {
  struct {
    UINT8    DownstreamPortTransmitterPreset : 4; // bit 0..3
    UINT8    UpstreamPortTransmitterPreset   : 4; // bit 4..7
  } Bits;
  UINT8    Uint8;
} PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_LANE_EQUALIZATION_CONTROL;

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER                         Header;
  PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CAPABILITIES                 Capablities;
  PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_CONTROL                      Control;
  PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_STATUS                       Status;
  PCI_EXPRESS_REG_PHYSICAL_LAYER_64_0_LANE_EQUALIZATION_CONTROL    LaneEqualizationControl[1];
} PCI_EXPRESS_EXTENDED_CAPABILITIES_PHYSICAL_LAYER_64_0;
///@}

typedef union {
  struct {
    UINT32    DmwrRequestRouting        :   1;  // bit 0
    UINT32    FourteenBitTagCompleter   :   1;  // bit 1
    UINT32    FourteenBitTagRequester   :   1;  // bit 2
    UINT32    ReceiverL0p               :   1;  // bit 3
    UINT32    PortL0pExitLatencyLatency :   3;  // bit 4..6
    UINT32    RetimerL0pExit            :   3;  // bit 7..9
    UINT32    Reserved                  :   22; // bit 10..31
  } Bits;
  UINT32    Uint32;
} PCI_REG_PCIE_DEVICE_CAPABILITY3;

typedef union {
  struct {
    UINT32    DmwrRequesterEnable           :   1;  // bit 0
    UINT32    DmwrEgressBlocking            :   1;  // bit 1
    UINT32    FourteenBitTagRequesterEnable :   1;  // bit 2
    UINT32    L0pEnable                     :   1;  // bit 3
    UINT32    TargetLinkWidth               :   3;  // bit 4..6
    UINT32    Reserved                      :   25; // bit 7..31
  } Bits;
  UINT32    Uint32;
} PCI_REG_PCIE_DEVICE_CONTROL3;

typedef union {
  struct {
    UINT32    InitialLinkWidth   :   3;  // bit 0..2
    UINT32    SegmentCaptured    :   1;  // bit 3
    UINT32    RemoteL0pSupported :   1;  // bit 4
    UINT32    Reserved           :   27; // bit 5..31
  } Bits;
  UINT32    Uint32;
} PCI_REG_PCIE_DEVICE_STATUS3;

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER    Header;
  PCI_REG_PCIE_DEVICE_CAPABILITY3             Capabilities;
  PCI_REG_PCIE_DEVICE_CONTROL3                Control;
  PCI_REG_PCIE_DEVICE_STATUS3                 Status;
} PCI_EXPRESS_EXTENDED_CAPABILITIES_DEVICE3;

/// The Data Object Exchange definitions
/// Based on section 6.30 of PCI Express Base Specification 6.4.
///@{

#define PCI_EXPRESS_EXTENDED_CAPABILITY_DATA_OBJECT_EXCHANGE_ID  0x002E

typedef struct {
  UINT16    VendorId;
  UINT8     DataObjectType;
  UINT8     Reserved;
  UINT32    Length       : 18; // Units of DWORDs (UINT32s); 0 -> 2^18 DWORDs.
  UINT32    ConnectionId : 12;
} PCI_EXPRESS_DOE_DATA_OBJECT_HEADER;

typedef struct {
  UINT8     Index;
  UINT8     DoeDiscoveryVersion;
  UINT16    Reserved;
} PCI_EXPRESS_DOE_DATA_OBJECT_DISCOVERY_REQUEST;

typedef struct {
  UINT16    VendorId;
  UINT8     DataObjectType;
  UINT8     NextIndex;
  UINT32    MaxDataObjectLength : 18;
  UINT32    AdditionalInfo      : 14;
} PCI_EXPRESS_DOE_DATA_OBJECT_DISCOVERY_RESPONSE;

typedef union {
  struct {
    UINT32    InterruptSupport          : 1;
    UINT32    InterruptMessageNumber    : 11;
    UINT32    AttentionMechanismSupport : 1;
    UINT32    AsyncMessageSupport       : 1;
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_DOE_CAPABILITIES_REGISTER;

typedef union {
  struct {
    UINT32    Abort              : 1;
    UINT32    InterruptEnable    : 1;
    UINT32    AttentionNotNeeded : 1;
    UINT32    AsyncMessageEnable : 1;
    UINT32    Reserved           : 27;
    UINT32    Go                 : 1;
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_DOE_CONTROL_REGISTER;

typedef union {
  struct {
    UINT32    Busy               : 1;
    UINT32    InterruptStatus    : 1;
    UINT32    Error              : 1;
    UINT32    AsyncMessageStatus : 1;
    UINT32    AtAttention        : 1;
    UINT32    Reserved           : 26;
    UINT32    DataObjectReady    : 1;
  } Bits;
  UINT32    Uint32;
} PCI_EXPRESS_DOE_STATUS_REGISTER;

typedef struct {
  UINT32    DataMailbox;
} PCI_EXPRESS_DOE_WRITE_DATA_MAILBOX_REGISTER;

typedef struct {
  UINT32    DataMailbox;
} PCI_EXPRESS_DOE_READ_DATA_MAILBOX_REGISTER;

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER       Header;
  PCI_EXPRESS_DOE_CAPABILITIES_REGISTER          Capabilities;
  PCI_EXPRESS_DOE_CONTROL_REGISTER               Control;
  PCI_EXPRESS_DOE_STATUS_REGISTER                Status;
  PCI_EXPRESS_DOE_WRITE_DATA_MAILBOX_REGISTER    WriteDataMailbox;
  PCI_EXPRESS_DOE_READ_DATA_MAILBOX_REGISTER     ReadDataMailbox;
} PCI_EXPRESS_DOE_EXTENDED_CAPABILITY;

///@}

#pragma pack()

/// Flit Logging Extended Capability Structure
///
/// Based on section 7.7.8 of PCI Express Base Specification 6.0
///@{
#define PCI_EXPRESS_EXTENDED_CAPABILITY_FLIT_LOGGING_ID    0x0032
#define PCI_EXPRESS_EXTENDED_CAPABILITY_FLIT_LOGGING_VER1  0x1

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER    Header;
  UINT32                                      FlitLoggingCapabilities;
  UINT32                                      FlitLoggingControl;
  UINT32                                      FlitLoggingStatus;
  UINT32                                      FlitMask;
  UINT32                                      FlitErrorData1;
  UINT32                                      FlitErrorData2;
  UINT32                                      FlitErrorData3;
} PCI_EXPRESS_EXTENDED_CAPABILITIES_FLIT_LOGGING;
///@}

/// Data Object Exchange Extended Capability Structure
///
/// Based on section 7.9.24 of PCI Express Base Specification 6.0
///@{
#define PCI_EXPRESS_EXTENDED_CAPABILITY_DATA_OBJECT_EXCHANGE_ID    0x002E
#define PCI_EXPRESS_EXTENDED_CAPABILITY_DATA_OBJECT_EXCHANGE_VER1  0x1

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER    Header;
  UINT32                                      DoeCapabilities;
  UINT16                                      DoeControl;
  UINT16                                      DoeStatus;
  UINT32                                      UncorrectableErrorMask;
  UINT32                                      UncorrectableErrorSeverity;
  UINT32                                      CorrectableErrorMask;
  UINT32                                      DoeSendObjectControl;
} PCI_EXPRESS_EXTENDED_CAPABILITIES_DATA_OBJECT_EXCHANGE;
///@}

/// Integrity Data Encryption Extended Capability Structure
///
/// Based on section 7.9.26 of PCI Express Base Specification 6.0
///@{
#define PCI_EXPRESS_EXTENDED_CAPABILITY_INTEGRITY_DATA_ENCRYPTION_ID    0x0030
#define PCI_EXPRESS_EXTENDED_CAPABILITY_INTEGRITY_DATA_ENCRYPTION_VER1  0x1

typedef struct {
  PCI_EXPRESS_EXTENDED_CAPABILITIES_HEADER    Header;
  UINT32                                      IdeCapabilities;
  UINT32                                      IdeControl;
  UINT32                                      IdeStatus;
  UINT32                                      IdeSendMcCapabilities;
  UINT32                                      IdeSendMcControl;
  UINT32                                      IdeSendMcStatus;
} PCI_EXPRESS_EXTENDED_CAPABILITIES_INTEGRITY_DATA_ENCRYPTION;
///@}

#pragma pack()