MdePkg and MdeModulePkg Pcd: Add the new EFI_GET_PCD_INFO_PROTOCOL and EFI_GET_PCD_INFO_PPI support for PI 1.2.1 compliance.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14866 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 126 insertions, 4 deletions

diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c
index cd8212824f..bc87c4e6a1 100644
--- a/MdePkg/Library/DxePcdLib/DxePcdLib.c
+++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c
@@ -18,17 +18,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include <Protocol/Pcd.h>

 #include <Protocol/PiPcd.h>

+#include <Protocol/PcdInfo.h>

+#include <Protocol/PiPcdInfo.h>

 

 #include <Library/PcdLib.h>

 #include <Library/DebugLib.h>

 #include <Library/UefiBootServicesTableLib.h>

 #include <Library/BaseMemoryLib.h>

 

-PCD_PROTOCOL     *mPcd   = NULL;

-EFI_PCD_PROTOCOL *mPiPcd = NULL;

+PCD_PROTOCOL                *mPcd       = NULL;

+EFI_PCD_PROTOCOL            *mPiPcd     = NULL;

+GET_PCD_INFO_PROTOCOL       *mPcdInfo   = NULL;

+EFI_GET_PCD_INFO_PROTOCOL   *mPiPcdInfo = NULL;

 

 /**

   Retrieves the PI PCD protocol from the handle database.

+

+  @retval EFI_PCD_PROTOCOL * The pointer to the EFI_PCD_PROTOCOL.

 **/

 EFI_PCD_PROTOCOL *

 EFIAPI

@@ -52,6 +58,8 @@ GetPiPcdProtocol (
 

 /**

   Retrieves the PCD protocol from the handle database.

+

+  @retval PCD_PROTOCOL * The pointer to the PCD_PROTOCOL.

 **/

 PCD_PROTOCOL *

 EFIAPI

@@ -73,6 +81,45 @@ GetPcdProtocol (
   return mPcd;

 }

 

+/**

+  Retrieves the PI PCD info protocol from the handle database.

+

+  @retval EFI_GET_PCD_INFO_PROTOCOL * The pointer to the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 Vol 3.

+**/

+EFI_GET_PCD_INFO_PROTOCOL *

+GetPiPcdInfoProtocolPointer (

+  VOID

+  )

+{

+  EFI_STATUS  Status;

+

+  if (mPiPcdInfo == NULL) {

+    Status = gBS->LocateProtocol (&gEfiGetPcdInfoProtocolGuid, NULL, (VOID **)&mPiPcdInfo);

+    ASSERT_EFI_ERROR (Status);

+    ASSERT (mPiPcdInfo != NULL);

+  }

+  return mPiPcdInfo;

+}

+

+/**

+  Retrieves the PCD info protocol from the handle database.

+

+  @retval GET_PCD_INFO_PROTOCOL * The pointer to the GET_PCD_INFO_PROTOCOL.

+**/

+GET_PCD_INFO_PROTOCOL *

+GetPcdInfoProtocolPointer (

+  VOID

+  ) 

+{

+  EFI_STATUS  Status;

+

+  if (mPcdInfo == NULL) {

+    Status = gBS->LocateProtocol (&gGetPcdInfoProtocolGuid, NULL, (VOID **)&mPcdInfo);

+    ASSERT_EFI_ERROR (Status);

+    ASSERT (mPcdInfo != NULL);

+  }

+  return mPcdInfo;

+}

 

 /**

   This function provides a means by which SKU support can be established in the PCD infrastructure.

@@ -1037,5 +1084,78 @@ LibPatchPcdSetPtr (
   return (VOID *) Buffer;

 }

 

+/**

+  Retrieve additional information associated with a PCD token.

+

+  This includes information such as the type of value the TokenNumber is associated with as well as possible

+  human readable name that is associated with the token.

+

+  If TokenNumber is not in the default token space specified, then ASSERT().

 

+  @param[in]    TokenNumber The PCD token number.

+  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.

+                            The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.

+**/

+VOID

+EFIAPI

+LibPcdGetInfo (

+  IN        UINTN           TokenNumber,

+  OUT       PCD_INFO        *PcdInfo

+  )

+{

+  EFI_STATUS Status;

+

+  Status = GetPcdInfoProtocolPointer()->GetInfo (TokenNumber, (EFI_PCD_INFO *) PcdInfo);

+  ASSERT_EFI_ERROR (Status);

+}

+

+/**

+  Retrieve additional information associated with a PCD token.

+

+  This includes information such as the type of value the TokenNumber is associated with as well as possible

+  human readable name that is associated with the token.

+

+  If TokenNumber is not in the token space specified by Guid, then ASSERT().

+

+  @param[in]    Guid        The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]    TokenNumber The PCD token number.

+  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.

+                            The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.

+**/

+VOID

+EFIAPI

+LibPcdGetInfoEx (

+  IN CONST  GUID            *Guid,

+  IN        UINTN           TokenNumber,

+  OUT       PCD_INFO        *PcdInfo

+  )

+{

+  EFI_STATUS Status;

+

+  Status = GetPiPcdInfoProtocolPointer()->GetInfo (Guid, TokenNumber, (EFI_PCD_INFO *) PcdInfo);

+  ASSERT_EFI_ERROR (Status);

+}

+

+/**

+  Retrieve the currently set SKU Id.

+

+  If the sku id got >= PCD_MAX_SKU_ID, then ASSERT().

+

+  @return   The currently set SKU Id. If the platform has not set at a SKU Id, then the

+            default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU

+            Id is returned.

+**/

+UINTN

+EFIAPI

+LibPcdGetSku (

+  VOID

+  )

+{

+  UINTN SkuId;

+

+  SkuId = GetPiPcdInfoProtocolPointer()->GetSku ();

+  ASSERT (SkuId < PCD_MAX_SKU_ID);

+

+  return SkuId;

+}

 

diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.inf b/MdePkg/Library/DxePcdLib/DxePcdLib.inf
index db06967c9a..a520f069bd 100644
--- a/MdePkg/Library/DxePcdLib/DxePcdLib.inf
+++ b/MdePkg/Library/DxePcdLib/DxePcdLib.inf
@@ -1,7 +1,7 @@
 ## @file

 # Instance of PCD Library using PCD Protocol.

 #

-# There are two PCD PPIs as follows:

+# There are two PCD PROTOCOLs as follows:

 #   1) PCD_PROTOCOL

 #      It is EDKII implementation which support Dynamic/DynamicEx Pcds.

 #   2) EFI_PCD_PROTOCOL

@@ -13,7 +13,7 @@
 # This library instance uses the PCD_PROTOCOL to handle dynamic PCD request and use

 # EFI_PCD_PROTOCOL to handle dynamicEx type PCD.

 #

-# Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -54,6 +54,8 @@
 [Protocols]

   gPcdProtocolGuid                              ## CONSUMES

   gEfiPcdProtocolGuid                           ## CONSUMES

+  gGetPcdInfoProtocolGuid                       ## SOMETIMES_CONSUMES

+  gEfiGetPcdInfoProtocolGuid                    ## SOMETIMES_CONSUMES

 

 [Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER]

   gEfiPcdProtocolGuid