public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [edk2-staging/UEFI_PCI_ENHANCE-2 PATCH V5] MdePkg/Protocols: New interface, EFI encodings to PCI Plat protocol
@ 2019-12-04 15:54 Javeed, Ashraf
  0 siblings, 0 replies; only message in thread
From: Javeed, Ashraf @ 2019-12-04 15:54 UTC (permalink / raw)
  To: devel; +Cc: Michael D Kinney, Liming Gao, Ray Ni

BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1954

New interface added to PCI Platform Protocol / PCI Override Protocol to
retrieve device-specific platform policy for the following PCI standard
features, like Maximum Payload Size (MPS), Maximum Read Request Size
(MRRS),Extended Tags, Relax Order, No-Snoop, Active State Power Management
(ASPM),Latency Time Reporting (LTR), AtomicOp, Reference Clock
Configuration, Extended SYNCH, PTM support, and Completion Timeout (CTO).
New source files added with enhanced definitions are in:
MdePkg/Include/Protocol/PciPlatform2.h,
MdePkg/Include/Protocol/PciOverride2.h

Signed-off-by: Ashraf Javeed <ashraf.javeed@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
---

In V5: Revised ECR to define new PCI Platform Protocol to support the
PCI Express capability features:-
EFI_PCI_EXPRESS_PLATFORM_PROTOCOL, EFI_PCI_EXPRESS_OVERRIDE_PROTOCOL.
Added new interface -> NotifyDeviceConfiguration
Added new EFI encodings / data types for PCIe features:-
CPM, L1 PM substates.
Enhance the definition of the PCIe feature AtomicOp to support additional
attribute - Egress blocking of the port.

In V4: Redefinition of the existing interfaces in the EFI_PCI_PLATFORM_-
PROTOCOL2, to avoid type casting and to avoid further future change

In V3: License update in the header sections of source files

In V2: Correction made to header sections of source files
---
 MdePkg/Include/Protocol/PciOverride2.h |  12 ++++++------
 MdePkg/Include/Protocol/PciPlatform2.h | 684 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 MdePkg/MdePkg.dec                      |   4 ++--
 3 files changed, 365 insertions(+), 335 deletions(-)

diff --git a/MdePkg/Include/Protocol/PciOverride2.h b/MdePkg/Include/Protocol/PciOverride2.h
index 7e878a4..9dafd28 100644
--- a/MdePkg/Include/Protocol/PciOverride2.h
+++ b/MdePkg/Include/Protocol/PciOverride2.h
@@ -14,24 +14,24 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define _PCI_OVERRIDE2_H_
 
 ///
-/// EFI_PCI_OVERRIDE_PROTOCOL has the same structure with EFI_PCI_PLATFORM_PROTOCOL
+/// EFI_PCI_EXPRESS_OVERRIDE_PROTOCOL has the same structure as of EFI_PCI_EXPRESS_PLATFORM_PROTOCOL
 ///
 #include <Protocol/PciPlatform2.h>
 
 ///
-/// Global ID for the EFI_PCI_OVERRIDE_PROTOCOL
+/// Global ID for the  EFI_PCI_EXPRESS_OVERRIDE_PROTOCOL
 ///
-#define EFI_PCI_OVERRIDE2_GUID \
+#define EFI_PCI_EXPRESS_OVERRIDE_GUID \
   { \
     0xb9d5ea1, 0x66cb, 0x4546, {0xb0, 0xbb, 0x5c, 0x6d, 0xae, 0xd9, 0x42, 0x47} \
   }
 
 ///
-/// Declaration for EFI_PCI_OVERRIDE_PROTOCOL
+/// Declaration for EFI_PCI_EXPRESS_OVERRIDE_PROTOCOL
 ///
-typedef EFI_PCI_PLATFORM_PROTOCOL2 EFI_PCI_OVERRIDE_PROTOCOL2;
+typedef  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL  EFI_PCI_EXPRESS_OVERRIDE_PROTOCOL;
 
 
-extern EFI_GUID   gEfiPciOverrideProtocol2Guid;
+extern EFI_GUID   gEfiPciExpressOverrideProtocolGuid;
 
 #endif
diff --git a/MdePkg/Include/Protocol/PciPlatform2.h b/MdePkg/Include/Protocol/PciPlatform2.h
index 6dcae70..f69fa6e 100644
--- a/MdePkg/Include/Protocol/PciPlatform2.h
+++ b/MdePkg/Include/Protocol/PciPlatform2.h
@@ -14,21 +14,15 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define _PCI_PLATFORM2_H_
 
 ///
-/// This file must be included because the EFI_PCI_PLATFORM_PROTOCOL2 uses
+/// This file must be included because the EFI_PCI_EXPRESS_PLATFORM_PROTOCOL uses
 /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE.
 ///
 #include <Protocol/PciHostBridgeResourceAllocation.h>
 
 ///
-/// This file is included to reuse the existing PCI Platform data structure
-/// definitions of EFI_PCI_EXECUTION_PHASE,EFI_PCI_PLATFORM_POLICY
+/// Global ID for the  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL.
 ///
-#include <Protocol/PciPlatform.h>
-
-///
-/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL2.
-///
-#define EFI_PCI_PLATFORM_PROTOCOL2_GUID \
+#define  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL_GUID \
   { \
     0x787b0367, 0xa945, 0x4d60, {0x8d, 0x34, 0xb9, 0xd1, 0x88, 0xd2, 0xd0, 0xb6} \
   }
@@ -39,429 +33,417 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 /// shall use these versions number to maintain the backward compatibility as
 /// per its specification changes in future.
 ///
-enum EfiPciPlatformProtocolVersion {
-  EFI_PCI_PLATFORM_PROTOCOL_MAJOR_VERSION = 1,
-  EFI_PCI_PLATFORM_PROTOCOL_MINOR_VERSION = 1
+enum EfiPciExpressPlatformProtocolVersion {
+   EFI_PCI_EXPRESS_PLATFORM_PROTOCOL_MAJOR_VERSION = 1,
+   EFI_PCI_EXPRESS_PLATFORM_PROTOCOL_MINOR_VERSION = 1
 };
 
 ///
-/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL2.
+/// Forward declaration for EFI_PCI_EXPRESS_PLATFORM_PROTOCOL.
 ///
-typedef struct _EFI_PCI_PLATFORM_PROTOCOL2 EFI_PCI_PLATFORM_PROTOCOL2;
+typedef struct _EFI_PCI_EXPRESS_PLATFORM_PROTOCOL  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL;
 
 ///
 /// Related Definitions
 ///
 
 ///
-/// Following are the data types for EFI_PCI_PLATYFORM_EXTENDED_POLICY
+/// EFI encoding used in notification to the platform, for any of the PCI Express
+/// capabilites features state, to indicate that its is not a supported feature,
+/// or its present state is unknown
+///
+#define EFI_PCI_EXPRESS_NOT_APPLICABLE  0xFF
+
+///
+/// Following are the data types for EFI_PCI_EXPRESS_PLATFORM_POLICY
 /// each for the PCI standard feature and its corresponding bitmask
 /// representing the valid combinations of PCI attributes
 ///
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature Maximum Payload Size (MPS). Refer to PCI Base Specification
-/// 4, (chapter 7.5.3.4) on how to translate the below EFI encodings as per the
-/// PCI hardware terminology. If this data member value is returned as 0 than
-/// there is no platform policy to override, this feature would be enabled as
+/// compliant feature PCIe device Maximum Payload Size (MPS). Refer to PCI Express
+/// Base Specification 4 (chapter 7.5.3.4), on how to translate the below EFI
+/// encodings as per the PCI hardware terminology. If this data member value is 0
+/// than there is no platform policy to override, this feature would be enabled as
 /// per its PCI specification based on the device capabilities. Below is it
 /// data type and the macro definitions which the driver uses for interpreting
 /// the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_MAX_PAYLOAD_SIZE;
+typedef UINT8 EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE;
 
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_AUTO   0x00  //No request for override
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_128B   0x01  //set to default 128B
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_256B   0x02  //set to 256B if applicable
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_512B   0x03  //set to 512B if applicable
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_1024B  0x04  //set to 1024B if applicable
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_2048B  0x05  //set to 2048B if applicable
-#define EFI_PCI_CONF_MAX_PAYLOAD_SIZE_4096B  0x06  //set to 4096B if applicable
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_AUTO   0x00  //No request for override
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_128B   0x01  //set to default 128B
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_256B   0x02  //set to 256B if applicable
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_512B   0x03  //set to 512B if applicable
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_1024B  0x04  //set to 1024B if applicable
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_2048B  0x05  //set to 2048B if applicable
+#define EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE_4096B  0x06  //set to 4096B if applicable
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature Maximum Read Request Size (MRRS). Refer to PCI Base
-/// Specification 4, (chapter 7.5.3.4) on how to translate the below EFI
+/// compliant feature Maximum Read Request Size (MRRS). Refer to PCI Express Base
+/// Specification 4 (chapter 7.5.3.4), on how to translate the below EFI
 /// encodings as per the PCI hardware terminology. If this data member value
 /// is returned as 0 than there is no platform policy to override, this feature
 /// would be enabled as per its PCI specification based on the device capabilities.
 /// Below is it data type and the macro definitions which the driver uses for
 /// interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_MAX_READ_REQ_SIZE;
+typedef UINT8 EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE;
 
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_AUTO  0x00  //No request for override
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_128B  0x01  //set to default 128B
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_256B  0x02  //set to 256B if applicable
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_512B  0x03  //set to 512B if applicable
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_1024B 0x04  //set to 1024B if applicable
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_2048B 0x05  //set to 2048B if applicable
-#define EFI_PCI_CONF_MAX_READ_REQ_SIZE_4096B 0x06  //set to 4096B if applicable
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_AUTO  0x00  //No request for override
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_128B  0x01  //set to default 128B
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_256B  0x02  //set to 256B if applicable
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_512B  0x03  //set to 512B if applicable
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_1024B 0x04  //set to 1024B if applicable
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_2048B 0x05  //set to 2048B if applicable
+#define EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE_4096B 0x06  //set to 4096B if applicable
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature Extended Tags. Refer to PCI Base Specification
-/// 4, (chapter 7.5.3.4) on how to translate the below EFI encodings as per the
+/// compliant feature Extended Tags. Refer to PCI Express Base Specification
+/// 4 (chapter 7.5.3.4), on how to translate the below EFI encodings as per the
 /// PCI hardware terminology. If this data member value is returned as 0 than
 /// there is no platform policy to override, this feature would be enabled as
 /// per its PCI specification based on the device capabilities. Below is it
 /// data type and the macro definitions which the driver uses for interpreting
 /// the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_EXTENDED_TAG;
+typedef UINT8 EFI_PCI_EXPRESS_EXTENDED_TAG;
 
-#define EFI_PCI_CONF_EXTENDED_TAG_AUTO   0x00  //No request for override
-#define EFI_PCI_CONF_EXTENDED_TAG_5BIT   0x01  //set to default 5-bit
-#define EFI_PCI_CONF_EXTENDED_TAG_8BIT   0x02  //set to 8-bit if applicable
-#define EFI_PCI_CONF_EXTENDED_TAG_10BIT  0x03  //set to 10-bit if applicable
+#define EFI_PCI_EXPRESS_EXTENDED_TAG_AUTO   0x00  //No request for override
+#define EFI_PCI_EXPRESS_EXTENDED_TAG_5BIT   0x01  //set to default 5-bit
+#define EFI_PCI_EXPRESS_EXTENDED_TAG_8BIT   0x02  //set to 8-bit if applicable
+#define EFI_PCI_EXPRESS_EXTENDED_TAG_10BIT  0x03  //set to 10-bit if applicable
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature PCIe link's Active State Power Mgmt (ASPM). Refer to PCI Base
-/// Specification 4, (chapter 7.5.3.7) on how to translate the below EFI
-/// encodings as per the PCI hardware terminology. If this data member value
-/// is returned as 0 than there is no platform policy to override, this feature
-/// would be enabled as per its PCI specification based on the device capabilities.
+/// compliant feature PCIe link's Active State Power Mgmt (ASPM).
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.7), on how to
+/// translate the below EFI encodings as per the PCI hardware terminology.
+/// If this data member value is returned as 0 than there is no platform policy
+/// to override, this feature would be enabled as per its PCI specification based
+/// on the device capabilities.
 /// Below is it data type and the macro definitions which the driver uses for
 /// interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_ASPM_SUPPORT;
+typedef UINT8 EFI_PCI_EXPRESS_ASPM_SUPPORT;
 
-#define EFI_PCI_CONF_ASPM_AUTO           0x00  //No request for override
-#define EFI_PCI_CONF_ASPM_DISABLE        0x01  //set to default disable state
-#define EFI_PCI_CONF_ASPM_L0s_SUPPORT    0x02  //set to L0s state
-#define EFI_PCI_CONF_ASPM_L1_SUPPORT     0x03  //set to L1 state
-#define EFI_PCI_CONF_ASPM_L0S_L1_SUPPORT 0x04  //set to L0s and L1 state
+#define EFI_PCI_EXPRESS_ASPM_AUTO           0x00  //No request for override
+#define EFI_PCI_EXPRESS_ASPM_DISABLE        0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_ASPM_L0s_SUPPORT    0x02  //set to L0s state
+#define EFI_PCI_EXPRESS_ASPM_L1_SUPPORT     0x03  //set to L1 state
+#define EFI_PCI_EXPRESS_ASPM_L0S_L1_SUPPORT 0x04  //set to L0s and L1 state
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature PCIe Device's Relax Ordering enable/disable. Refer to PCI Base
-/// Specification 4, (chapter 7.5.3.4) on how to translate the below EFI
-/// encodings as per the PCI hardware terminology. If this data member value
-/// is returned as 0 than there is no platform policy to override, this feature
-/// would be enabled as per its PCI specification based on the device capabilities.
+/// compliant feature PCIe Device's Relax Ordering enable/disable.
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.4), on how to
+/// translate the below EFI encodings as per the PCI hardware terminology.
+/// If this data member value is returned as 0 than there is no platform policy
+/// to override, this feature would be enabled as per its PCI specification based
+/// on the device capabilities.
 /// Below is it data type and the macro definitions which the driver uses for
 /// interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_RELAX_ORDER;
+typedef UINT8 EFI_PCI_EXPRESS_RELAX_ORDER;
 
-#define EFI_PCI_CONF_RO_AUTO     0x00  //No request for override
-#define EFI_PCI_CONF_RO_DISABLE  0x01  //set to default disable state
-#define EFI_PCI_CONF_RO_ENABLE   0x02  //set to enable state
+#define EFI_PCI_EXPRESS_RO_AUTO     0x00  //No request for override
+#define EFI_PCI_EXPRESS_RO_DISABLE  0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_RO_ENABLE   0x02  //set to enable state
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature PCIe Device's No-Snoop enable/disable. Refer to PCI Base
-/// Specification 4, (chapter 7.5.3.4) on how to translate the below EFI
-/// encodings as per the PCI hardware terminology. If this data member value
-/// is returned as 0 than there is no platform policy to override, this feature
-/// would be enabled as per its PCI specification based on the device capabilities.
+/// compliant feature PCIe Device's No-Snoop enable/disable.
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.4), on how to
+/// translate the below EFI encodings as per the PCI hardware terminology.
+/// If this data member value is returned as 0 than there is no platform policy
+/// to override, this feature would be enabled as per its PCI specification based
+/// on the device capabilities.
 /// Below is it data type and the macro definitions which the driver uses for
 /// interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_NO_SNOOP;
+typedef UINT8 EFI_PCI_EXPRESS_NO_SNOOP;
 
-#define EFI_PCI_CONF_NS_AUTO     0x00  //No request for override
-#define EFI_PCI_CONF_NS_DISABLE  0x01  //set to default disable state
-#define EFI_PCI_CONF_NS_ENABLE   0x02  //set to enable state
+#define EFI_PCI_EXPRESS_NS_AUTO     0x00  //No request for override
+#define EFI_PCI_EXPRESS_NS_DISABLE  0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_NS_ENABLE   0x02  //set to enable state
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
 /// compliant feature PCIe link's Clock configuration is common or discrete.
-/// Refer to PCI Base Specification 4, (chapter 7.5.3.7) on how to translate the
-/// below EFI encodings as per the PCI hardware terminology. If this data member
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.7), on how to translate
+/// the below EFI encodings as per the PCI hardware terminology. If this data member
 /// value is returned as 0 than there is no platform policy to override, this
 /// feature would be enabled as per its PCI specification based on the device
 /// capabilities. Below is its data type and the macro definitions which the
 /// driver uses for interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_COMMON_CLOCK_CFG;
+typedef UINT8 EFI_PCI_EXPRESS_COMMON_CLOCK_CFG;
 
-#define EFI_PCI_CONF_CLK_CFG_AUTO    0x00   //No request for override
-#define EFI_PCI_CONF_CLK_CFG_ASYNCH  0x01   //set to default asynchronous clock
-#define EFI_PCI_CONF_CLK_CFG_COMMON  0x02   //set to common clock
+#define EFI_PCI_EXPRESS_CLK_CFG_AUTO    0x00   //No request for override
+#define EFI_PCI_EXPRESS_CLK_CFG_ASYNCH  0x01   //set to default asynchronous clock
+#define EFI_PCI_EXPRESS_CLK_CFG_COMMON  0x02   //set to common clock
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
 /// compliant feature PCIe link's Extended Synch enable or disable.
-/// Refer to PCI Base Specification 4, (chapter 7.5.3.7) on how to translate the
-/// below EFI encodings as per the PCI hardware terminology. If this data member
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.7), on how to translate
+/// the below EFI encodings as per the PCI hardware terminology. If this data member
 /// value is returned as 0 than there is no platform policy to override, this
 /// feature would be enabled as per its PCI specification based on the device
 /// capabilities. Below is its data type and the macro definitions which the
 /// driver uses for interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_EXTENDED_SYNCH;
+typedef UINT8 EFI_PCI_EXPRESS_EXTENDED_SYNCH;
 
-#define EFI_PCI_CONF_EXT_SYNCH_AUTO    0x00  //No request for override
-#define EFI_PCI_CONF_EXT_SYNCH_DISABLE 0x01  //set to default disable state
-#define EFI_PCI_CONF_EXT_SYNCH_ENABLE  0x02  //set to enable state
+#define EFI_PCI_EXPRESS_EXT_SYNCH_AUTO    0x00  //No request for override
+#define EFI_PCI_EXPRESS_EXT_SYNCH_DISABLE 0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_EXT_SYNCH_ENABLE  0x02  //set to enable state
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
-/// compliant feature PCIe Device's AtomicOp Requester enable or disable.
-/// Refer to PCI Base Specification 4, (chapter 7.5.3.16) on how to translate the
-/// below EFI encodings as per the PCI hardware terminology. If this data member
-/// value is returned as 0 than there is no platform policy to override, this
-/// feature would be enabled as per its PCI specification based on the device
-/// capabilities. Below is its data type and the macro definitions which the
-/// driver uses for interpreting the platform policy.
-///
-typedef UINT8 EFI_PCI_CONF_ATOMIC_OP;
-
-#define EFI_PCI_CONF_ATOMIC_OP_AUTO    0x00  //No request for override
-#define EFI_PCI_CONF_ATOMIC_OP_DISABLE 0x01  //set to default disable state
-#define EFI_PCI_CONF_ATOMIC_OP_ENABLE  0x02  //set to enable state
+/// compliant feature PCIe Device's AtomicOp Requester enable or disable, as well
+/// as its Egress blocking based on the port's routing capability.
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.16), on how to translate
+/// the given data structure as per the PCI hardware terminology.
+/// If the data member "Override" value is 0 than there is no platform policy to
+/// override, other data members value has to be ignored. If 1 than other data
+/// members will be used as per the device capabilities. Below is its data type
+/// definitions which the driver uses for interpreting the platform policy.
+///
+typedef struct _EFI_PCI_EXPRESS_ATOMIC_OP EFI_PCI_EXPRESS_ATOMIC_OP;
+
+struct _EFI_PCI_EXPRESS_ATOMIC_OP {
+  //
+  // set to indicate the platform request for override based on below data member
+  // bit fields; clear bit indicates no platform request for override, ignore
+  // the other data member bit fields. Ignored when passed as input parameters.
+  //
+  UINT8 Override:1;
+  //
+  // set to enable the device as the requester for AtomicOp; clear bit to force
+  // default disable state
+  //
+  UINT8 Enable_AtomicOpRequester:1;
+  //
+  // set to enable the AtomicOp Egress blocking on this port based on its routing
+  // capabilitity; clear bit to force default disable state
+  //
+  UINT8 Enable_AtomicOpEgressBlocking:1;
+  //
+  // the remaining bits are unused for this feature
+  //
+  UINT8 Reserved:5;
+};
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
 /// compliant feature PCIe Device's LTR Mechanism enable/disable.
-/// Refer to PCI Base Specification 4, (chapter 7.5.3.16) on how to translate the
-/// below EFI encodings as per the PCI hardware terminology. If this data member
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.16), on how to translate
+/// the below EFI encodings as per the PCI hardware terminology. If this data member
 /// value is returned as 0 than there is no platform policy to override, this
 /// feature would be enabled as per its PCI specification based on the device
 /// capabilities. Below is its data type and the macro definitions which the
 /// driver uses for interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_LTR;
+typedef UINT8 EFI_PCI_EXPRESS_LTR;
 
-#define EFI_PCI_CONF_LTR_AUTO    0x00  //No request for override
-#define EFI_PCI_CONF_LTR_DISABLE 0x01  //set to default disable state
-#define EFI_PCI_CONF_LTR_ENABLE  0x02  //set to enable state
+#define EFI_PCI_EXPRESS_LTR_AUTO    0x00  //No request for override
+#define EFI_PCI_EXPRESS_LTR_DISABLE 0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_LTR_ENABLE  0x02  //set to enable state
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
 /// compliant feature PCIe Device's Precision Time Measurement (PTM) enable/disable.
-/// Refer to PCI Base Specification 4, (chapter 7.5.3.16) on how to translate the
+/// Refer to PCI Express Base Specification 4 (chapter 7.5.3.16), on how to translate the
 /// below EFI encodings as per the PCI hardware terminology. If this data member
 /// value is returned as 0 than there is no platform policy to override, this
 /// feature would be enabled as per its PCI specification based on the device
 /// capabilities. Below is its data type and the macro definitions which the
 /// driver uses for interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_PTM;
+typedef UINT8 EFI_PCI_EXPRESS_PTM;
 
-#define EFI_PCI_CONF_PTM_AUTO      0x00  //No request for override
-#define EFI_PCI_CONF_PTM_DISABLE   0x01  //set to default disable state
-#define EFI_PCI_CONF_PTM_ENABLE    0x02  //set to enable state only
-#define EFI_PCI_CONF_PTM_ROOT_SEL  0x02  //set to root select & enable
+#define EFI_PCI_EXPRESS_PTM_AUTO      0x00  //No request for override
+#define EFI_PCI_EXPRESS_PTM_DISABLE   0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_PTM_ENABLE    0x02  //set to enable state only
+#define EFI_PCI_EXPRESS_PTM_ROOT_SEL  0x02  //set to root select & enable
 
 ///
 /// This data type is to retrieve the PCI device platform policy for the PCI-
 /// compliant feature PCIe Device's Completion Timeout (CTO) set to supported ranges
-/// or disable. Refer to PCI Base Specification 4, (chapter 7.5.3.16) on how to
+/// or disable. Refer to PCI Express Base Specification 4 (chapter 7.5.3.16), on how to
 /// translate the below EFI encodings as per the PCI hardware terminology. If this
 /// data member value is returned as 0 than there is no platform policy to override,
 /// this feature would be enabled as per its PCI specification based on the device
 /// capabilities. Below is its data type and the macro definitions which the
 /// driver uses for interpreting the platform policy.
 ///
-typedef UINT8 EFI_PCI_CONF_CTO_SUPPORT;
+typedef UINT8 EFI_PCI_EXPRESS_CTO_SUPPORT;
+
+#define EFI_PCI_EXPRESS_CTO_AUTO        0x00  //No request for override
+#define EFI_PCI_EXPRESS_CTO_DEFAULT     0x01  //set to default range of 5us to 50ms if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_A1    0x02  //set to range of 50us to 100us if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_A2    0x03  //set to range of 1ms to 10ms if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_B1    0x04  //set to range of 16ms to 55ms if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_B2    0x05  //set to range of 65ms to 210ms if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_C1    0x06  //set to range of 260ms to 900ms if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_C2    0x07  //set to range of 1s to 3.5s if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_D1    0x08  //set to range of 4s to 13s if applicable
+#define EFI_PCI_EXPRESS_CTO_RANGE_D2    0x09  //set to range of 17s to 64s if applicable
+#define EFI_PCI_EXPRESS_CTO_DET_DISABLE 0x10  //set to CTO detection disable if applicable
+
+///
+/// This data type is to retrieve the PCI device platform policy for the PCI-
+/// compliant feature PCIe link's Clock Power Management (CPM) enable or disable.
+/// Refer to PCI Express Base Specification 5 (chapter 7.5.3.7), on how to translate
+/// the below EFI encodings as per the PCI hardware terminology. If this data member
+/// value is returned as 0 than there is no platform policy to override, this
+/// feature would be ignored or disabled/enabled, as per its relation with other
+/// components and its capabilities, as defined in its PCI specification. Below
+/// is its data type and the macro definitions which the driver uses for interpreting
+/// the platform policy.
+///
+typedef UINT8 EFI_PCI_EXPRESS_CPM;
 
-#define EFI_PCI_CONF_CTO_AUTO        0x00  //No request for override
-#define EFI_PCI_CONF_CTO_DEFAULT     0x01  //set to default range of 5us to 50ms if applicable
-#define EFI_PCI_CONF_CTO_RANGE_A1    0x02  //set to range of 50us to 100us if applicable
-#define EFI_PCI_CONF_CTO_RANGE_A2    0x03  //set to range of 1ms to 10ms if applicable
-#define EFI_PCI_CONF_CTO_RANGE_B1    0x04  //set to range of 16ms to 55ms if applicable
-#define EFI_PCI_CONF_CTO_RANGE_B2    0x05  //set to range of 65ms to 210ms if applicable
-#define EFI_PCI_CONF_CTO_RANGE_C1    0x06  //set to range of 260ms to 900ms if applicable
-#define EFI_PCI_CONF_CTO_RANGE_C2    0x07  //set to range of 1s to 3.5s if applicable
-#define EFI_PCI_CONF_CTO_RANGE_D1    0x08  //set to range of 4s to 13s if applicable
-#define EFI_PCI_CONF_CTO_RANGE_D2    0x09  //set to range of 17s to 64s if applicable
-#define EFI_PCI_CONF_CTO_DET_DISABLE 0x10  //set to CTO detection disable if applicable
+#define EFI_PCI_EXPRESS_CPM_AUTO    0x00  //No request for override
+#define EFI_PCI_EXPRESS_CPM_DISABLE 0x01  //set to default disable state
+#define EFI_PCI_EXPRESS_CPM_ENABLE  0x02  //set to enable state
+
+///
+/// This data type is to retrieve the PCI device platform policy for the PCI-
+/// compliant feature PCIe link's L1 PM substates.
+/// Refer to PCI Express Base Specification 5 (chapter 7.8.3.3), on how to translate
+/// the given data structure as per the PCI hardware terminology. If the data member
+/// "Override" value is 0 than there is no platform policy to override, other data
+/// members will be ignored; if 1 than other data members are used for this feature,
+/// to align the states based on its capabilities as well as its relationship with
+/// other components in the PCI hierarchy. The platform is expected to return any
+/// combination from the four L1 PM substates.
+/// Below is its data type definitions which the driver uses for interpreting
+/// the platform policy.
+///
+typedef struct _EFI_PCI_EXPRESS_L1PM_SUBSTATES EFI_PCI_EXPRESS_L1PM_SUBSTATES;
+
+struct _EFI_PCI_EXPRESS_L1PM_SUBSTATES {
+  //
+  // set to indicate the platform request to override the L1 PM substates using
+  // the other data member bit fields; bit clear means no request from platform
+  // to override the L1 PM substates for the device. Ignored when passed as input
+  // parameters.
+  //
+  UINT8 Override:1;
+  //
+  // set to enable the PCI-PM L1.2 state; bit clear to force default disable state
+  //
+  UINT8 Enable_Pci_Pm_L1_2:1;
+  //
+  // set to enable the PCI-PM L1.1 state; bit clear to force default disable state
+  //
+  UINT8 Enable_Pci_Pm_L1_1:1;
+  //
+  // set to enable the ASPM L1.2 state; bit clear to force default disable state
+  //
+  UINT8 Enable_Aspm_L1_2:1;
+  //
+  // set to enable the ASPM L1.1 state; bit clear to force default disable state
+  //
+  UINT8 Enable_Aspm_L1_1:1;
+  //
+  // rest of the remaining bits are reserved, not utilized; can be reused in
+  // future to define additional conditions as per PCIe capabilities
+  //
+  UINT8 Reserved:3;
+};
 
 ///
 /// Reserves for future use
 ///
-typedef UINT8 EFI_PCI_CONF_RESERVES;
+typedef UINT8 EFI_PCI_EXPRESS_RESERVES;
 
 ///
-/// The EFI_PCI_PLATYFORM_EXTENDED_POLICY is altogether 128-byte size, with each
+/// The EFI_PCI_EXPRESS_PLATFORM_POLICY is altogether 128-byte size, with each
 /// byte field representing one PCI standerd feature defined in the PCI Express Base
 /// Specification 4.0, version 1.0.
 ///
 typedef struct {
-  EFI_PCI_CONF_MAX_PAYLOAD_SIZE  DeviceCtlMPS;
-  EFI_PCI_CONF_MAX_READ_REQ_SIZE DeviceCtlMRRS;
-  EFI_PCI_CONF_EXTENDED_TAG      DeviceCtlExtTag;
-  EFI_PCI_CONF_RELAX_ORDER       DeviceCtlRelaxOrder;
-  EFI_PCI_CONF_NO_SNOOP          DeviceCtlNoSnoop;
-  EFI_PCI_CONF_ASPM_SUPPORT      LinkCtlASPMState;
-  EFI_PCI_CONF_COMMON_CLOCK_CFG  LinkCtlCommonClkCfg;
-  EFI_PCI_CONF_EXTENDED_SYNCH    LinkCtlExtSynch;
-  EFI_PCI_CONF_ATOMIC_OP         DeviceCtl2AtomicOp;
-  EFI_PCI_CONF_LTR               DeviceCtl2LTR;
-  EFI_PCI_CONF_PTM               PTMControl;
-  EFI_PCI_CONF_CTO_SUPPORT       CTOsupport;
-  EFI_PCI_CONF_RESERVES          Reserves[116];
-} EFI_PCI_PLATFORM_EXTENDED_POLICY;
+  EFI_PCI_EXPRESS_MAX_PAYLOAD_SIZE  DeviceCtlMPS;
+  EFI_PCI_EXPRESS_MAX_READ_REQ_SIZE DeviceCtlMRRS;
+  EFI_PCI_EXPRESS_EXTENDED_TAG      DeviceCtlExtTag;
+  EFI_PCI_EXPRESS_RELAX_ORDER       DeviceCtlRelaxOrder;
+  EFI_PCI_EXPRESS_NO_SNOOP          DeviceCtlNoSnoop;
+  EFI_PCI_EXPRESS_ASPM_SUPPORT      LinkCtlASPMState;
+  EFI_PCI_EXPRESS_COMMON_CLOCK_CFG  LinkCtlCommonClkCfg;
+  EFI_PCI_EXPRESS_EXTENDED_SYNCH    LinkCtlExtSynch;
+  EFI_PCI_EXPRESS_ATOMIC_OP         DeviceCtl2AtomicOp;
+  EFI_PCI_EXPRESS_LTR               DeviceCtl2LTR;
+  EFI_PCI_EXPRESS_PTM               PTMControl;
+  EFI_PCI_EXPRESS_CTO_SUPPORT       CTOsupport;
+  EFI_PCI_EXPRESS_CPM               LinkCtlCPM;
+  EFI_PCI_EXPRESS_L1PM_SUBSTATES    L1PMSubstates;
+  EFI_PCI_EXPRESS_RESERVES          Reserves[114];
+} EFI_PCI_EXPRESS_PLATFORM_POLICY;
+
+///
+/// The EFI_PCI_EXPRESS_DEVICE_CONFIGURATION is an alias of the data type of
+/// EFI_PCI_EXPRESS_PLATFORM_POLICY, used in returning the PCI feature's definite
+/// configuration states, of a device to the platform, through the
+/// NotifyDeviceConfiguration interface method.
+/// The EFI encoded macros like EFI_PCI_EXPRESS_*_AUTO, with the value 0 will not
+/// be used to report the PCI feature definite state; similarly for the data type
+/// of DeviceCtl2AtomicOp and L1PMSubstates, its data member "Override" will not
+/// be used. For any device's PCI features that are not supported, or its state
+/// is unknown, it will be returned as EFI_PCI_EXPRESS_NOT_APPLICABLE.
+///
+typedef EFI_PCI_EXPRESS_PLATFORM_POLICY EFI_PCI_EXPRESS_DEVICE_CONFIGURATION;
 
 /**
-  The notification from the PCI bus enumerator to the platform that it is
-  about to enter a certain phase during the enumeration process.
-
-  The PlatformNotify() function can be used to notify the platform driver so that
-  it can perform platform-specific actions. No specific actions are required.
-  Eight notification points are defined at this time. More synchronization points
-  may be added as required in the future. The PCI bus driver calls the platform driver
-  twice for every Phase-once before the PCI Host Bridge Resource Allocation Protocol
-  driver is notified, and once after the PCI Host Bridge Resource Allocation Protocol
-  driver has been notified.
-  This member function may not perform any error checking on the input parameters. It
-  also does not return any error codes. If this member function detects any error condition,
-  it needs to handle those errors on its own because there is no way to surface any
-  errors to the caller.
-
-  @param[in] This           The pointer to the EFI_PCI_PLATFORM_PROTOCOL2 instance.
-  @param[in] HostBridge     The handle of the host bridge controller.
-  @param[in] Phase          The phase of the PCI bus enumeration.
-  @param[in] ExecPhase      Defines the execution phase of the PCI chipset driver.
-
-  @retval EFI_SUCCESS   The function completed successfully.
+  Interface to retrieve the PCI device-specific platform policies to override
+  the PCI Express feature capabilities, of an PCI device.
 
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY2)(
-  IN EFI_PCI_PLATFORM_PROTOCOL2                       *This,
-  IN EFI_HANDLE                                       HostBridge,
-  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE    Phase,
-  IN EFI_PCI_EXECUTION_PHASE                          ExecPhase
-  );
-
-/**
-  The notification from the PCI bus enumerator to the platform for each PCI
-  controller at several predefined points during PCI controller initialization.
-
-  The PlatformPrepController() function can be used to notify the platform driver so that
-  it can perform platform-specific actions. No specific actions are required.
-  Several notification points are defined at this time. More synchronization points may be
-  added as required in the future. The PCI bus driver calls the platform driver twice for
-  every PCI controller-once before the PCI Host Bridge Resource Allocation Protocol driver
-  is notified, and once after the PCI Host Bridge Resource Allocation Protocol driver has
-  been notified.
-  This member function may not perform any error checking on the input parameters. It also
-  does not return any error codes. If this member function detects any error condition, it
-  needs to handle those errors on its own because there is no way to surface any errors to
-  the caller.
-
-  @param[in] This           The pointer to the EFI_PCI_PLATFORM_PROTOCOL2 instance.
-  @param[in] HostBridge     The associated PCI host bridge handle.
-  @param[in] RootBridge     The associated PCI root bridge handle.
-  @param[in] PciAddress     The address of the PCI device on the PCI bus.
-  @param[in] Phase          The phase of the PCI controller enumeration.
-  @param[in] ExecPhase      Defines the execution phase of the PCI chipset driver.
-
-  @retval EFI_SUCCESS   The function completed successfully.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER2)(
-  IN EFI_PCI_PLATFORM_PROTOCOL2                     *This,
-  IN EFI_HANDLE                                     HostBridge,
-  IN EFI_HANDLE                                     RootBridge,
-  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS    PciAddress,
-  IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE   Phase,
-  IN EFI_PCI_EXECUTION_PHASE                        ExecPhase
-  );
-
-/**
-  Retrieves the platform policy regarding enumeration.
-
-  The GetPlatformPolicy() function retrieves the platform policy regarding PCI
-  enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol
-  driver can call this member function to retrieve the policy.
+  The consumer driver(s), like PCI Bus driver and PCI Host Bridge Resource Allocation
+  Protocol drivers; can call this member function to retrieve the platform policies
+  specific to PCI device, related to its PCI-Express capabilities. The producer of
+  this protocol is platform whom shall provide the device-specific pilicies to
+  override its PCIe features.
 
-  @param[in]  This        The pointer to the EFI_PCI_PLATFORM_PROTOCOL2 instance.
-  @param[out] PciPolicy   The platform policy with respect to VGA and ISA aliasing.
-
-  @retval EFI_SUCCESS             The function completed successfully.
-  @retval EFI_INVALID_PARAMETER   PciPolicy is NULL.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PCI_PLATFORM_GET_PLATFORM_POLICY2)(
-  IN  CONST EFI_PCI_PLATFORM_PROTOCOL2  *This,
-  OUT       EFI_PCI_PLATFORM_POLICY     *PciPolicy
-  );
-
-/**
-  Gets the PCI device's option ROM from a platform-specific location.
-
-  The GetPciRom() function gets the PCI device's option ROM from a platform-specific location.
-  The option ROM will be loaded into memory. This member function is used to return an image
-  that is packaged as a PCI 2.2 option ROM. The image may contain both legacy and EFI option
-  ROMs. See the UEFI 2.0 Specification for details. This member function can be used to return
-  option ROM images for embedded controllers. Option ROMs for embedded controllers are typically
-  stored in platform-specific storage, and this member function can retrieve it from that storage
-  and return it to the PCI bus driver. The PCI bus driver will call this member function before
-  scanning the ROM that is attached to any controller, which allows a platform to specify a ROM
-  image that is different from the ROM image on a PCI card.
-
-  @param[in]  This        The pointer to the EFI_PCI_PLATFORM_PROTOCOL2 instance.
-  @param[in]  PciHandle   The handle of the PCI device.
-  @param[out] RomImage    If the call succeeds, the pointer to the pointer to the option ROM image.
-                          Otherwise, this field is undefined. The memory for RomImage is allocated
-                          by EFI_PCI_PLATFORM_PROTOCOL2.GetPciRom() using the EFI Boot Service AllocatePool().
-                          It is the caller's responsibility to free the memory using the EFI Boot Service
-                          FreePool(), when the caller is done with the option ROM.
-  @param[out] RomSize     If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
-                          this field is undefined.
-
-  @retval EFI_SUCCESS            The option ROM was available for this device and loaded into memory.
-  @retval EFI_NOT_FOUND          No option ROM was available for this device.
-  @retval EFI_OUT_OF_RESOURCES   No memory was available to load the option ROM.
-  @retval EFI_DEVICE_ERROR       An error occurred in obtaining the option ROM.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PCI_PLATFORM_GET_PCI_ROM2)(
-  IN  CONST EFI_PCI_PLATFORM_PROTOCOL2  *This,
-  IN        EFI_HANDLE                  PciHandle,
-  OUT       VOID                        **RomImage,
-  OUT       UINTN                       *RomSize
-  );
-
-/**
-  Retrieves the PCI device-specific platform policy regarding enumeration.
-
-  The PCI Bus driver and PCI Host Bridge Resource Allocation Protocol drivers
-  can call this member function to retrieve the platform policies specific to
-  PCI device, regarding the PCI enumeration.
-
-  The GetDevicePolicy() function retrieves the platform policy for a particular
-  component regarding PCI enumeration. The PCI bus driver and the PCI Host Bridge
-  Resource Allocation Protocol driver can call this member function to retrieve
-  the policy.
-  The existing GetPlatformPolicy() member function is used by the PCI Bus driver
-  to program the legacy ranges, the data that is returned by that member function
-  determines the supported attributes that are returned by the
-  EFI_PCI_IO_PROTOCOL.Attributes() function.
   The GetDevicePolicy() member function is meant to return data about other PCI
   compliant features which would be supported by the PCI Bus driver in future;
   like for example the MPS, MRRS, Extended Tag, ASPM, etc. The details about
-  this PCI features can be obtained from the PCI Base Specification 4.x. The
-  EFI encodings for these feature are defined in the
-  EFI_PCI_PLATFORM_EXTENDED_POLICY, see the Related Definition section for this.
-  This member function will use the associated EFI handle of the PCI IO Protocol
-  to determine the physical PCI device within the chipset, to return its
-  device-specific platform policies. It is caller's responsibility to allocate
-  the buffer and pass its pointer to this member function, to get its device-
-  specific policy data.
-
-  @param[in]  This          Pointer to the EFI_PCI_PLATFORM_PROTOCOL2 instance.
-  @param[in]  PciDevice     The associated PCI IO Protocol handle of the PCI
-                            device. Type EFI_HANDLE is defined in
-                            InstallProtocolInterface() in the UEFI 2.1
-                            Specification
-  @param[in]  PciExtPolicy  The pointer to platform policy with respect to other
-                            PCI features like, the MPS, MRRS, etc. Type
-                            EFI_PCI_PLATFORM_EXTENDED_POLICY is defined in
-                            "Related Definitions" above.
+  this PCI features can be obtained from the PCI Express Base Specification (Rev.4
+  or 5). The EFI encodings for these features are defined in the EFI_PCI_EXPRESS
+  _PLATFORM_POLICY, see the Related Definition section for this. This member function
+  will use the associated EFI handle of the root bridge instance and the PCI address
+  of type EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS to determine the physical
+  PCI device within the chipset, to return its device-specific platform policies.
+  It is caller's responsibility to allocate the buffer and pass its pointer of
+  type EFI_PCI_EXPRESS_PLATFORM_POLICY to this member function, to get its device
+  -specific policy data. On input, it uses the EFI_PCI_EXPRESS_NOT_APPLICABLE to
+  initialize those data members which the consumer do not intend to configure.
+
+  At the system-level, the producer and consumer drivers of the platform need
+  to use the designated bitwise PCD for each of the PCIe features defined here
+  in order to synchronize on which PCIe features to be initialized by the consumer
+  for which the producer can provide its device-specific overrides. The designated
+  bit value of the PCD if 1 indicates that the consumer can configure that PCIe
+  feature for which it can expect the corresponding device-specific platform policy
+  provided in the associated data members of the EFI_PCI_EXPRESS_PLATFORM_POLICY.
+  The PCD bit value 0 indicates that the platform does not want that corresponding
+  PCIe feature to be configured by the consumer driver. At a device-level, the
+  platform can use the EFI_PCI_EXPRESS_PLATFORM_POLICY data member(s) to input
+  the PCIe features values equivalent to its hardware default state as defined in
+  the PCI Express Base Specification, in order to skip its initialization.
+
+  @param[in]      This          Pointer to the  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL instance.
+  @param[in]      RootBridge    EFI handle of associated root bridge to the PCI device
+  @param[in]      PciDevice     PCI device address of type
+                                EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
+  @param[in,out]  PciExPolicy   The pointer to platform policy with respect to other
+                                PCI features like, the MPS, MRRS, etc. Type
+                                EFI_PCI_EXPRESS_PLATFORM_POLICY is defined in
+                                "Related Definitions" above.
 
 
   @retval EFI_SUCCESS            The function completed successfully, may returns
@@ -474,51 +456,99 @@ EFI_STATUS
  **/
 typedef
 EFI_STATUS
-(EFIAPI * EFI_PCI_PLATFORM_GET_DEVICE_POLICY) (
-  IN   CONST EFI_PCI_PLATFORM_PROTOCOL2   *This,
-  IN   EFI_HANDLE                         PciDevice,
-  OUT  EFI_PCI_PLATFORM_EXTENDED_POLICY   *PciExtPolicy
+(EFIAPI * EFI_PCI_EXPRESS_PLATFORM_GET_DEVICE_POLICY) (
+  IN CONST  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL             *This,
+  IN        EFI_HANDLE                                    RootBridge,
+  IN        EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS   PciDevice,
+  IN OUT    EFI_PCI_EXPRESS_PLATFORM_POLICY               *PciExPolicy
 );
 
+/**
+  Notifies the platform about the PCI device current configuration state w.r.t.
+  its PCIe capabilites.
+
+  The PCI Bus driver or PCI Host Bridge Resource Allocation Protocol drivers
+  can call this member function to notfy the present PCIe configuration state
+  of the PCI device, to the platform. This is expected to be invoked after the
+  completion of the PCI enumeration phase.
+
+  The NotifyDeviceConfiguration() member function is meant to provide configured
+  data, to the platform about the PCIe features which would be supported by the
+  PCI Bus driver in future; like for example the MPS, MRRS, Extended Tag, ASPM,
+  etc. The details about this PCI features can be obtained from the PCI Express
+  Base Specification.
+
+  The EFI encodings and data types used to report out the present configuration
+  state, are same as those that were used by the platform to return the device-specific
+  platform policies, in the EFI_PCI_EXPRESS_PLATFORM_POLICY (see the "Related
+  Definition" section for this). The difference is that it should return the actual
+  state in the EFI_PCI_EXPRESS_DEVICE_CONFIGURATION; without any macros corresponding
+  to EFI_PCI_EXPRESS_*_AUTO, and for the data types of DeviceCtl2AtomicOp and
+  L1PMSubstates, its corresponding data member "Override" bit field value shall be
+  ignored, will not be applicable. Note that, if the notifying driver does not
+  support any PCIe feature than it shall return its corresponding value as
+  EFI_PCI_EXPRESS_NOT_APPLICABLE. This is true for all those PCIe features that
+  will be disabled using its designated PCD bit fields masks at system-level.
+
+  This member function will use the associated EFI handle of the PCI IO Protocol
+  to address the physical PCI device within the chipset. It is caller's
+  responsibility to allocate the buffer and pass its pointer to this member
+  function.
+
+  @param[in]  This                      Pointer to the  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL instance.
+  @param[in]  PciDevice                 The associated PCI IO Protocol handle of the PCI
+                                        device. Type EFI_HANDLE is defined in
+                                        InstallProtocolInterface() in the UEFI 2.1
+                                        Specification
+  @param[in] PciExDeviceConfiguration   The pointer to device configuration state with respect
+                                        to other PCI features like, the MPS, MRRS, etc. Type
+                                        EFI_PCI_EXPRESS_DEVICE_CONFIGURATION is an alias to
+                                        EFI_PCI_EXPRESS_PLATFORM_POLICY, as defined in
+                                        "Related Definitions" above.
+
+
+  @retval EFI_SUCCESS             This function completed successfully, the platform
+                                  was able to identify the PCI device successfully
+  @retval EFI_INVALID_PARAMETER   Platform was not able to identify the PCI device;
+                                  or its device-specific policy provided was not
+                                  correct, or was not expected. There is no gaurantee
+                                  that the caller is expected to take any action
+                                  on this return value
+
+ **/
+typedef
+EFI_STATUS
+(EFIAPI* EFI_PCI_EXPRESS_NOTIFY_DEVICE_CONFIGURATION) (
+  IN CONST  EFI_PCI_EXPRESS_PLATFORM_PROTOCOL     *This,
+  IN        EFI_HANDLE                            PciDevice,
+  IN        EFI_PCI_EXPRESS_DEVICE_CONFIGURATION  *PciExDeviceConfiguration
+  );
+
 ///
 /// This protocol provides the interface between the PCI bus driver/PCI Host
 /// Bridge Resource Allocation driver and a platform-specific driver to describe
 /// the unique features of a platform.
 ///
-struct _EFI_PCI_PLATFORM_PROTOCOL2 {
-  ///
-  /// The notification from the PCI bus enumerator to the platform that it is about to
-  /// enter a certain phase during the enumeration process.
-  ///
-  EFI_PCI_PLATFORM_PHASE_NOTIFY2            PlatformNotify;
+struct _EFI_PCI_EXPRESS_PLATFORM_PROTOCOL {
   ///
-  /// The notification from the PCI bus enumerator to the platform for each PCI
-  /// controller at several predefined points during PCI controller initialization.
+  /// The major version of this PCIe Platform Protocol
   ///
-  EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER2   PlatformPrepController;
+  UINT8                                            MajorVersion;
   ///
-  /// Retrieves the platform policy regarding enumeration.
+  /// The minor version of this PCIe Platform Protocol
   ///
-  EFI_PCI_PLATFORM_GET_PLATFORM_POLICY2     GetPlatformPolicy;
+  UINT8                                            MinorVersion;
   ///
-  /// Gets the PCI device's option ROM from a platform-specific location.
+  /// Retrieves the PCIe device-specific platform policy regarding enumeration.
   ///
-  EFI_PCI_PLATFORM_GET_PCI_ROM2             GetPciRom;
+  EFI_PCI_EXPRESS_PLATFORM_GET_DEVICE_POLICY       GetDevicePolicy;
   ///
-  /// Retrieves the PCI device-specific platform policy regarding enumeration.
+  /// Informs the platform about the PCIe capabilities programmed, based on the
+  /// present state of the PCI device
   ///
-  EFI_PCI_PLATFORM_GET_DEVICE_POLICY        GetDevicePolicy;
-  ///
-  /// The major version of this PCI Platform Protocol
-  ///
-  UINT8                                     MajorVersion;
-  ///
-  /// The minor version of this PCI Platform Protocol
-  ///
-  UINT8                                     MinorVersion;
-
+  EFI_PCI_EXPRESS_NOTIFY_DEVICE_CONFIGURATION    NotifyDeviceConfiguration;
 };
 
-extern EFI_GUID   gEfiPciPlatformProtocol2Guid;
+extern EFI_GUID   gEfiPciExpressPlatformProtocolGuid;
 
 #endif
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 2167d99..0ef1cab 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -1017,10 +1017,10 @@
   gEfiPciOverrideProtocolGuid    = { 0xb5b35764, 0x460c, 0x4a06, {0x99, 0xfc, 0x77, 0xa1, 0x7c, 0x1b, 0x5c, 0xeb }}
 
   ## Include/Protocol/PciPlatform2.h
-  gEfiPciPlatformProtocol2Guid    = { 0x787b0367, 0xa945, 0x4d60, { 0x8d, 0x34, 0xb9, 0xd1, 0x88, 0xd2, 0xd0, 0xb6 }}
+  gEfiPciExpressPlatformProtocolGuid    = { 0x787b0367, 0xa945, 0x4d60, { 0x8d, 0x34, 0xb9, 0xd1, 0x88, 0xd2, 0xd0, 0xb6 }}
 
   ## Include/Protocol/PciOverride2.h
-  gEfiPciOverrideProtocol2Guid    = { 0xb9d5ea1, 0x66cb, 0x4546, { 0xb0, 0xbb, 0x5c, 0x6d, 0xae, 0xd9, 0x42, 0x47 }}
+  gEfiPciExpressOverrideProtocolGuid    = { 0xb9d5ea1, 0x66cb, 0x4546, { 0xb0, 0xbb, 0x5c, 0x6d, 0xae, 0xd9, 0x42, 0x47 }}
 
   ## Include/Protocol/PciEnumerationComplete.h
   gEfiPciEnumerationCompleteProtocolGuid    = { 0x30cfe3e7, 0x3de1, 0x4586, {0xbe, 0x20, 0xde, 0xab, 0xa1, 0xb3, 0xb7, 0x93}}
-- 
2.21.0.windows.1


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2019-12-04 15:55 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-12-04 15:54 [edk2-staging/UEFI_PCI_ENHANCE-2 PATCH V5] MdePkg/Protocols: New interface, EFI encodings to PCI Plat protocol Javeed, Ashraf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox