]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/PCD/Dxe/Service.h
MdeModulePkg: INF/DEC file updates to EDK II packages
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.h
index 5602a728681f82913bb6e22254566a173cf334b6..55717dc98281eab6733510dbaa3f356acd3f5105 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
 Private functions used by PCD DXE driver.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -17,8 +17,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <PiDxe.h>\r
 #include <Guid/PcdDataBaseHobGuid.h>\r
+#include <Guid/PcdDataBaseSignatureGuid.h>\r
 #include <Protocol/Pcd.h>\r
 #include <Protocol/PiPcd.h>\r
+#include <Protocol/PcdInfo.h>\r
+#include <Protocol/PiPcdInfo.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/UefiLib.h>\r
@@ -30,6 +33,74 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/UefiRuntimeServicesTableLib.h>\r
 \r
+//\r
+// Please make sure the PCD Serivce DXE Version is consistent with\r
+// the version of the generated DXE PCD Database by build tool.\r
+//\r
+#define PCD_SERVICE_DXE_VERSION      4\r
+\r
+//\r
+// PCD_DXE_SERVICE_DRIVER_VERSION is defined in Autogen.h.\r
+//\r
+#if (PCD_SERVICE_DXE_VERSION != PCD_DXE_SERVICE_DRIVER_VERSION)\r
+  #error "Please make sure the version of PCD DXE Service and the generated PCD DXE Database match."\r
+#endif\r
+\r
+/**\r
+  Retrieve additional information associated with a PCD token in the default token space.\r
+\r
+  This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+  human readable name that is associated with the token.\r
+\r
+  @param[in]    TokenNumber The PCD token number.\r
+  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.\r
+                            The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+\r
+  @retval  EFI_SUCCESS      The PCD information was returned successfully.\r
+  @retval  EFI_NOT_FOUND    The PCD service could not find the requested token number.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DxeGetPcdInfoGetInfo (\r
+  IN        UINTN           TokenNumber,\r
+  OUT       EFI_PCD_INFO    *PcdInfo\r
+  );\r
+\r
+/**\r
+  Retrieve additional information associated with a PCD token.\r
+\r
+  This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+  human readable name that is associated with the token.\r
+\r
+  @param[in]    Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]    TokenNumber The PCD token number.\r
+  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.\r
+                            The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+\r
+  @retval  EFI_SUCCESS      The PCD information was returned successfully.\r
+  @retval  EFI_NOT_FOUND    The PCD service could not find the requested token number.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DxeGetPcdInfoGetInfoEx (\r
+  IN CONST  EFI_GUID        *Guid,\r
+  IN        UINTN           TokenNumber,\r
+  OUT       EFI_PCD_INFO    *PcdInfo\r
+  );\r
+\r
+/**\r
+  Retrieve the currently set SKU Id.\r
+\r
+  @return   The currently set SKU Id. If the platform has not set at a SKU Id, then the\r
+            default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r
+            Id is returned.\r
+**/\r
+UINTN\r
+EFIAPI\r
+DxeGetPcdInfoGetSku (\r
+  VOID\r
+  );\r
+\r
 //\r
 // Protocol Interface function declaration.\r
 //\r
@@ -699,7 +770,7 @@ DxeUnRegisterCallBackOnSet (
   @param[in]      Guid    The 128-bit unique value that designates the namespace from which to retrieve the next token. \r
                           This is an optional parameter that may be NULL.  If this parameter is NULL, then a request is \r
                           being made to retrieve tokens from the default token space.\r
-  @param[in,out]  TokenNumber \r
+  @param[in, out] TokenNumber \r
                           A pointer to the PCD token number to use to find the subsequent token number.  \r
 \r
   @retval EFI_SUCCESS   The PCD service retrieved the next valid token number. Or the input token number \r
@@ -718,14 +789,10 @@ DxePcdGetNextToken (
 /**\r
   Get next token space in PCD database according to given token space guid.\r
   \r
-  This routine is enable only when feature flag PCD PcdDxePcdDatabaseTraverseEnabled \r
-  is TRUE.\r
-  \r
   @param Guid            Given token space guid. If NULL, then Guid will be set to \r
                          the first PCD token space in PCD database, If not NULL, then\r
                          Guid will be set to next PCD token space.\r
 \r
-  @retval EFI_UNSUPPORTED If feature flag PCD PcdDxePcdDatabaseTraverseEnabled is FALSE.\r
   @retval EFI_NOT_FOUND   If PCD database has no token space table or can not find given\r
                           token space in PCD database.\r
   @retval EFI_SUCCESS     Success to get next token space guid.\r
@@ -747,6 +814,27 @@ typedef struct {
 // Internal Functions\r
 //\r
 \r
+/**\r
+  Retrieve additional information associated with a PCD token.\r
+\r
+  This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+  human readable name that is associated with the token.\r
+\r
+  @param[in]    Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]    TokenNumber The PCD token number.\r
+  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.\r
+                            The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName. \r
+\r
+  @retval  EFI_SUCCESS      The PCD information was returned successfully\r
+  @retval  EFI_NOT_FOUND    The PCD service could not find the requested token number.\r
+**/\r
+EFI_STATUS\r
+DxeGetPcdInfo (\r
+  IN CONST  EFI_GUID        *Guid,\r
+  IN        UINTN           TokenNumber,\r
+  OUT       EFI_PCD_INFO    *PcdInfo\r
+  );\r
+\r
 /**\r
   Wrapper function for setting non-pointer type value for a PCD entry.\r
 \r
@@ -986,16 +1074,16 @@ BuildPcdDxeDataBase (
   );\r
 \r
 /**\r
-  Get local token number according to dynamic-ex PCD's {token space guid:token number}\r
+  Get Token Number according to dynamic-ex PCD's {token space guid:token number}\r
 \r
   A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r
   in DEC file. PCD database maintain a mapping table that translate pair of {token\r
-  space guid: token number} to local token number.\r
+  space guid: token number} to Token Number.\r
   \r
   @param Guid            Token space guid for dynamic-ex PCD entry.\r
   @param ExTokenNumber   Dynamic-ex PCD token number.\r
 \r
-  @return local token number for dynamic-ex PCD.\r
+  @return Token Number for dynamic-ex PCD.\r
 \r
 **/\r
 UINTN\r
@@ -1070,9 +1158,24 @@ SetPtrTypeSize (
   IN    OUT   UINTN             *CurrentSize\r
   );\r
 \r
-extern PCD_DATABASE * mPcdDatabase;\r
+extern  PCD_DATABASE   mPcdDatabase;\r
+\r
+extern  UINT32         mPcdTotalTokenCount; \r
+extern  UINT32         mPeiLocalTokenCount; \r
+extern  UINT32         mDxeLocalTokenCount; \r
+extern  UINT32         mPeiNexTokenCount;   \r
+extern  UINT32         mDxeNexTokenCount;  \r
+extern  UINT32         mPeiExMapppingTableSize;\r
+extern  UINT32         mDxeExMapppingTableSize;\r
+extern  UINT32         mPeiGuidTableSize;\r
+extern  UINT32         mDxeGuidTableSize;\r
+\r
+extern  BOOLEAN        mPeiExMapTableEmpty; \r
+extern  BOOLEAN        mDxeExMapTableEmpty; \r
+extern  BOOLEAN        mPeiDatabaseEmpty;\r
 \r
-extern DXE_PCD_DATABASE_INIT gDXEPcdDbInit;\r
+extern  EFI_GUID     **TmpTokenSpaceBuffer;\r
+extern  UINTN          TmpTokenSpaceBufferCount;\r
 \r
 extern EFI_LOCK mPcdDatabaseLock;\r
 \r