/** @file\r
-Private functions used by PCD PEIM.\r
+ The internal header file declares the private functions used by PeiPcd driver.\r
\r
-Copyright (c) 2006, Intel Corporation\r
-All rights reserved. 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
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-\r
-Module Name: Service.h\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
-#ifndef _SERVICE_H\r
-#define _SERVICE_H\r
+#ifndef _PEI_PCD_SERVICE_H_\r
+#define _PEI_PCD_SERVICE_H_\r
\r
#include <PiPei.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Ppi/Pcd.h>\r
+#include <Ppi/PiPcd.h>\r
+#include <Ppi/PcdInfo.h>\r
+#include <Ppi/PiPcdInfo.h>\r
+#include <Guid/PcdDataBaseHobGuid.h>\r
+#include <Guid/PcdDataBaseSignatureGuid.h>\r
+#include <Guid/VariableFormat.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
-#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/BaseMemoryLib.h>\r
-\r
+#include <Library/MemoryAllocationLib.h>\r
\r
//\r
// Please make sure the PCD Serivce PEIM Version is consistent with\r
-// the version of PCD Database generation tool\r
+// the version of the generated PEIM PCD Database by build tool.\r
//\r
-#define PCD_SERVICE_PEIM_VERSION 2\r
+#define PCD_SERVICE_PEIM_VERSION 7\r
\r
//\r
-// PCD_PEI_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
-// and generated by PCD Database generation tool.\r
+// PCD_PEI_SERVICE_DRIVER_VERSION is defined in Autogen.h.\r
//\r
-//#if (PCD_SERVICE_PEIM_VERSION != PCD_PEI_SERVICE_DRIVER_AUTOGEN_VERSION )\r
-// #error "Please make sure the version of PCD Service PEIM and PCD PEI Database Generation Tool matches"\r
-//#endif\r
+#if (PCD_SERVICE_PEIM_VERSION != PCD_PEI_SERVICE_DRIVER_VERSION)\r
+ #error "Please make sure the version of PCD PEIM Service and the generated PCD PEI 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
+PeiGetPcdInfoGetInfo (\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
+PeiGetPcdInfoGetInfoEx (\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
+PeiGetPcdInfoGetSku (\r
+ VOID\r
+ );\r
\r
//\r
// PPI Interface Implementation Declaration.\r
//\r
+\r
+/**\r
+ Sets the SKU value for subsequent calls to set or get PCD token values.\r
+\r
+ SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values.\r
+ SetSku() is normally called only once by the system.\r
+\r
+ For each item (token), the database can hold a single value that applies to all SKUs,\r
+ or multiple values, where each value is associated with a specific SKU Id. Items with multiple,\r
+ SKU-specific values are called SKU enabled.\r
+\r
+ The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255.\r
+ For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the\r
+ single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the\r
+ last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token,\r
+ the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been\r
+ set for that Id, the results are unpredictable.\r
+\r
+ @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and\r
+ set values associated with a PCD token.\r
+\r
+**/\r
VOID\r
EFIAPI\r
PeiPcdSetSku (\r
- IN UINTN SkuId\r
- )\r
-;\r
+ IN UINTN SkuId\r
+ );\r
+\r
+/**\r
+ Retrieves an 8-bit value for a given PCD token.\r
+\r
+ Retrieves the current byte-sized value for a PCD token number.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The UINT8 value.\r
+\r
+**/\r
UINT8\r
EFIAPI\r
PeiPcdGet8 (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 16-bit value for a given PCD token.\r
\r
+ Retrieves the current 16-bits value for a PCD token number.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The UINT16 value.\r
+\r
+**/\r
UINT16\r
EFIAPI\r
PeiPcdGet16 (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
\r
+/**\r
+ Retrieves an 32-bit value for a given PCD token.\r
\r
+ Retrieves the current 32-bits value for a PCD token number.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The UINT32 value.\r
+\r
+**/\r
UINT32\r
EFIAPI\r
PeiPcdGet32 (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 64-bit value for a given PCD token.\r
+\r
+ Retrieves the current 64-bits value for a PCD token number.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The UINT64 value.\r
+\r
+**/\r
UINT64\r
EFIAPI\r
PeiPcdGet64 (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves a pointer to a value for a given PCD token.\r
\r
+ Retrieves the current pointer to the buffer for a PCD token number.\r
+ Do not make any assumptions about the alignment of the pointer that\r
+ is returned by this function call. If the TokenNumber is invalid,\r
+ the results are unpredictable.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The pointer to the buffer to be retrived.\r
+\r
+**/\r
VOID *\r
EFIAPI\r
PeiPcdGetPtr (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
\r
+/**\r
+ Retrieves a Boolean value for a given PCD token.\r
\r
+ Retrieves the current boolean value for a PCD token number.\r
+ Do not make any assumptions about the alignment of the pointer that\r
+ is returned by this function call. If the TokenNumber is invalid,\r
+ the results are unpredictable.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The Boolean value.\r
+\r
+**/\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBool (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves the size of the value for a given PCD token.\r
+\r
+ Retrieves the current size of a particular PCD token.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The size of the value for the PCD token.\r
\r
+**/\r
UINTN\r
EFIAPI\r
PeiPcdGetSize (\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 8-bit value for a given PCD token.\r
+\r
+ Retrieves the 8-bit value of a particular PCD token.\r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are\r
+ unpredictable.\r
\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The size 8-bit value for the PCD token.\r
+\r
+**/\r
UINT8\r
EFIAPI\r
PeiPcdGet8Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 16-bit value for a given PCD token.\r
\r
+ Retrieves the 16-bit value of a particular PCD token.\r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are\r
+ unpredictable.\r
\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The size 16-bit value for the PCD token.\r
+\r
+**/\r
UINT16\r
EFIAPI\r
PeiPcdGet16Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 32-bit value for a given PCD token.\r
+\r
+ Retrieves the 32-bit value of a particular PCD token.\r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are\r
+ unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The size 32-bit value for the PCD token.\r
+\r
+**/\r
UINT32\r
EFIAPI\r
PeiPcdGet32Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an 64-bit value for a given PCD token.\r
\r
+ Retrieves the 64-bit value of a particular PCD token.\r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are\r
+ unpredictable.\r
\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The size 64-bit value for the PCD token.\r
+\r
+**/\r
UINT64\r
EFIAPI\r
PeiPcdGet64Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
\r
+/**\r
+ Retrieves a pointer to a value for a given PCD token.\r
\r
+ Retrieves the current pointer to the buffer for a PCD token number.\r
+ Do not make any assumptions about the alignment of the pointer that\r
+ is returned by this function call. If the TokenNumber is invalid,\r
+ the results are unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The pointer to the buffer to be retrived.\r
+\r
+**/\r
VOID *\r
EFIAPI\r
PeiPcdGetPtrEx (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves an Boolean value for a given PCD token.\r
+\r
+ Retrieves the Boolean value of a particular PCD token.\r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are\r
+ unpredictable.\r
\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
\r
+ @return The size Boolean value for the PCD token.\r
+\r
+**/\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBoolEx (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves the size of the value for a given PCD token.\r
\r
+ Retrieves the current size of a particular PCD token.\r
+ If the TokenNumber is invalid, the results are unpredictable.\r
\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] TokenNumber The PCD token number.\r
+\r
+ @return The size of the value for the PCD token.\r
+\r
+**/\r
UINTN\r
EFIAPI\r
PeiPcdGetSizeEx (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
\r
+/**\r
+ Sets an 8-bit value for a given PCD token.\r
\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8 (\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ );\r
+\r
+/**\r
+ Sets an 16-bit value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16 (\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ );\r
+\r
+/**\r
+ Sets an 32-bit value for a given PCD token.\r
\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32 (\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ );\r
\r
+/**\r
+ Sets an 64-bit value for a given PCD token.\r
\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64 (\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ );\r
+\r
+/**\r
+ Sets a value of a specified size for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.\r
+ On input, if the SizeOfValue is greater than the maximum size supported\r
+ for this TokenNumber then the output value of SizeOfValue will reflect\r
+ the maximum size supported for this TokenNumber.\r
+ @param[in] Buffer The buffer to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtr (\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
+ );\r
+\r
+/**\r
+ Sets an Boolean value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\r
\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBool (\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ );\r
+\r
+/**\r
+ Sets an 8-bit value for a given PCD token.\r
\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ );\r
\r
+/**\r
+ Sets an 16-bit value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ );\r
+\r
+/**\r
+ Sets an 32-bit value for a given PCD token.\r
\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in] Value The value to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ );\r
+\r
+/**\r
+ Sets an 64-bit value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in] Value The value to set for the PCD token.\r
\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64Ex (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
- )\r
-;\r
-\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ );\r
+\r
+/**\r
+ Sets a value of a specified size for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.\r
+ On input, if the SizeOfValue is greater than the maximum size supported\r
+ for this TokenNumber then the output value of SizeOfValue will reflect\r
+ the maximum size supported for this TokenNumber.\r
+ @param[in] Buffer The buffer to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtrEx (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
+ );\r
+\r
+/**\r
+ Sets an Boolean value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the\r
+ size of the value being set is compatible with the Token's existing definition.\r
+ If it is not, an error will be returned.\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[in] Value The value to set for the PCD token.\r
\r
+ @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data\r
+ being set was incompatible with a call to this function.\r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBoolEx (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ );\r
+\r
+/**\r
+ Specifies a function to be called anytime the value of a designated token is changed.\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[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set.\r
\r
+ @retval EFI_SUCCESS The PCD service has successfully established a call event\r
+ for the CallBackToken requested.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiRegisterCallBackOnSet (\r
- IN CONST EFI_GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_PPI_CALLBACK CallBackFunction\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_PPI_CALLBACK CallBackFunction\r
+ );\r
\r
+/**\r
+ Cancels a previously set callback function for a particular PCD token number.\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 [in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set.\r
+\r
+ @retval EFI_SUCCESS The PCD service has successfully established a call event\r
+ for the CallBackToken requested.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PcdUnRegisterCallBackOnSet (\r
- IN CONST EFI_GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_PPI_CALLBACK CallBackFunction\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_PPI_CALLBACK CallBackFunction\r
+ );\r
\r
+/**\r
+ Retrieves the next valid token number in a given namespace.\r
\r
+ This is useful since the PCD infrastructure contains a sparse list of token numbers,\r
+ and one cannot a priori know what token numbers are valid in the database.\r
+\r
+ If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.\r
+ If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.\r
+ If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.\r
+ If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned.\r
+ The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid.\r
+ If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned.\r
+ If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned.\r
+ If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.\r
+\r
+\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ This is an optional parameter that may be NULL. If this parameter is NULL, then a request\r
+ is being made to retrieve tokens from the default token space.\r
+ @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.\r
+\r
+ @retval EFI_SUCCESS The PCD service has retrieved the next valid token number.\r
+ Or the input token number is already the last valid token number in the PCD database.\r
+ In the later case, *TokenNumber is updated with the value of 0.\r
+ @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdGetNextToken (\r
- IN CONST EFI_GUID *Guid, OPTIONAL\r
- IN OUT UINTN *TokenNumber\r
- )\r
-;\r
-\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN OUT UINTN *TokenNumber\r
+ );\r
+\r
+/**\r
+ Retrieves the next valid PCD token namespace for a given namespace.\r
+\r
+ @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates\r
+ a known token namespace from which the search will start. On output,\r
+ it designates the next valid token namespace on the platform. If the input\r
+ token namespace does not exist on the platform, an error is returned and\r
+ the value of *Guid is undefined. If *Guid is NULL, then the GUID of the\r
+ first token space of the current platform is assigned to *Guid the function\r
+ return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in\r
+ the platform other than the default (NULL) tokennamespace, *Guid is unchanged\r
+ and the function return EFI_SUCCESS. If this input token namespace is the last\r
+ namespace on the platform, *Guid will be assigned to NULL and the function return\r
+ EFI_SUCCESS.\r
+\r
+ @retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid.\r
+ Or the input token space Guid is already the last valid token space Guid\r
+ in the PCD database. In the later case, *Guid is updated with the value of NULL.\r
+ @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiPcdGetNextTokenSpace (\r
- IN CONST EFI_GUID **Guid\r
- )\r
-;\r
+ IN OUT CONST EFI_GUID **Guid\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
+PeiGetPcdInfo (\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ OUT EFI_PCD_INFO *PcdInfo\r
+ );\r
\r
/* Internal Function definitions */\r
\r
+/**\r
+ Get PCD database from GUID HOB in PEI phase.\r
+\r
+ @return Pointer to PCD database.\r
+\r
+**/\r
PEI_PCD_DATABASE *\r
GetPcdDatabase (\r
VOID\r
- )\r
-;\r
+ );\r
\r
+/**\r
+ Wrapper function for setting non-pointer type value for a PCD entry.\r
\r
-EFI_STATUS\r
-SetValueWorker (\r
- IN UINTN TokenNumber,\r
- IN VOID *Data,\r
- IN UINTN Size\r
- )\r
-;\r
+ @param TokenNumber Pcd token number autogenerated by build tools.\r
+ @param Data Value want to be set for PCD entry\r
+ @param Size Size of value.\r
\r
+ @return status of SetWorker.\r
\r
+**/\r
+EFI_STATUS\r
+SetValueWorker (\r
+ IN UINTN TokenNumber,\r
+ IN VOID *Data,\r
+ IN UINTN Size\r
+ );\r
+\r
+/**\r
+ Set value for an PCD entry\r
+\r
+ @param TokenNumber Pcd token number autogenerated by build tools.\r
+ @param Data Value want to be set for PCD entry\r
+ @param Size Size of value.\r
+ @param PtrType If TRUE, the type of PCD entry's value is Pointer.\r
+ If False, the type of PCD entry's value is not Pointer.\r
+\r
+ @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.\r
+ @retval EFI_INVALID_PARAMETER If Size can not be set to size table.\r
+ @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.\r
+ @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in\r
+ range of UINT8, UINT16, UINT32, UINT64\r
+ @retval EFI_NOT_FOUND Can not find the PCD type according to token number.\r
+**/\r
EFI_STATUS\r
SetWorker (\r
- IN UINTN TokenNumber,\r
- IN VOID *Data,\r
- IN OUT UINTN *Size,\r
- IN BOOLEAN PtrType\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN VOID *Data,\r
+ IN OUT UINTN *Size,\r
+ IN BOOLEAN PtrType\r
+ );\r
\r
+/**\r
+ Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
\r
+ @param ExTokenNumber Token number for dynamic-ex PCD.\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param Data Value want to be set.\r
+ @param SetSize The size of value.\r
+\r
+ @return status of ExSetWorker().\r
+\r
+**/\r
EFI_STATUS\r
ExSetValueWorker (\r
- IN UINTN ExTokenNumber,\r
- IN CONST EFI_GUID *Guid,\r
- IN VOID *Data,\r
- IN UINTN Size\r
- )\r
-;\r
+ IN UINTN ExTokenNumber,\r
+ IN CONST EFI_GUID *Guid,\r
+ IN VOID *Data,\r
+ IN UINTN Size\r
+ );\r
\r
+/**\r
+ Set value for a dynamic PCD entry.\r
\r
+ This routine find the local token number according to dynamic-ex PCD's token\r
+ space guid and token number firstly, and invoke callback function if this PCD\r
+ entry registered callback function. Finally, invoken general SetWorker to set\r
+ PCD value.\r
\r
+ @param ExTokenNumber Dynamic-ex PCD token number.\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param Data PCD value want to be set\r
+ @param SetSize Size of value.\r
+ @param PtrType If TRUE, this PCD entry is pointer type.\r
+ If FALSE, this PCD entry is not pointer type.\r
+\r
+ @return status of SetWorker().\r
+\r
+**/\r
EFI_STATUS\r
ExSetWorker (\r
- IN UINTN ExTokenNumber,\r
- IN CONST EFI_GUID *Guid,\r
- IN VOID *Data,\r
- IN OUT UINTN *Size,\r
- IN BOOLEAN PtrType\r
- )\r
-;\r
+ IN UINTN ExTokenNumber,\r
+ IN CONST EFI_GUID *Guid,\r
+ IN VOID *Data,\r
+ IN OUT UINTN *Size,\r
+ IN BOOLEAN PtrType\r
+ );\r
\r
+/**\r
+ Get the PCD entry pointer in PCD database.\r
\r
+ This routine will visit PCD database to find the PCD entry according to given\r
+ token number. The given token number is autogened by build tools and it will be\r
+ translated to local token number. Local token number contains PCD's type and\r
+ offset of PCD entry in PCD database.\r
\r
+ @param TokenNumber Token's number, it is autogened by build tools\r
+ @param GetSize The size of token's value\r
+\r
+ @return PCD entry pointer in PCD database\r
+\r
+**/\r
VOID *\r
GetWorker (\r
- IN UINTN TokenNumber,\r
- IN UINTN GetSize\r
- )\r
-;\r
+ IN UINTN TokenNumber,\r
+ IN UINTN GetSize\r
+ );\r
\r
+/**\r
+ Wrapper function for get PCD value for dynamic-ex PCD.\r
\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param ExTokenNumber Token number for dyanmic-ex PCD.\r
+ @param GetSize The size of dynamic-ex PCD value.\r
\r
+ @return PCD entry in PCD database.\r
+\r
+**/\r
VOID *\r
ExGetWorker (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN ExTokenNumber,\r
- IN UINTN GetSize\r
- )\r
-;\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN ExTokenNumber,\r
+ IN UINTN GetSize\r
+ );\r
\r
typedef struct {\r
- UINTN TokenNumber;\r
- UINTN Size;\r
- UINT32 LocalTokenNumberAlias;\r
+ UINTN TokenNumber;\r
+ UINTN Size;\r
+ UINT32 LocalTokenNumberAlias;\r
} EX_PCD_ENTRY_ATTRIBUTE;\r
\r
+/**\r
+ Get Token Number according to dynamic-ex PCD's {token space guid:token number}\r
\r
-UINTN\r
-GetExPcdTokenNumber (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN ExTokenNumber\r
- )\r
-;\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 Token Number.\r
\r
+ @param Guid Token space guid for dynamic-ex PCD entry.\r
+ @param ExTokenNumber Token number for dynamic-ex PCD.\r
\r
+ @return Token Number for dynamic-ex PCD.\r
\r
+**/\r
+UINTN\r
+GetExPcdTokenNumber (\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN ExTokenNumber\r
+ );\r
+\r
+/**\r
+ The function registers the CallBackOnSet fucntion\r
+ according to TokenNumber and EFI_GUID space.\r
+\r
+ @param TokenNumber The token number.\r
+ @param Guid The GUID space.\r
+ @param CallBackFunction The Callback function to be registered.\r
+ @param Register To register or unregister the callback function.\r
+\r
+ @retval EFI_SUCCESS If the Callback function is registered.\r
+ @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r
+ @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free\r
+ slot left in the CallbackFnTable.\r
+**/\r
EFI_STATUS\r
PeiRegisterCallBackWorker (\r
- IN UINTN TokenNumber,\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN PCD_PPI_CALLBACK CallBackFunction,\r
- IN BOOLEAN Register\r
-);\r
+ IN UINTN TokenNumber,\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN PCD_PPI_CALLBACK CallBackFunction,\r
+ IN BOOLEAN Register\r
+ );\r
\r
+/**\r
+ The function builds the PCD database.\r
\r
+ @param FileHandle Handle of the file the external PCD database binary located.\r
\r
+ @return Pointer to PCD database.\r
\r
-VOID\r
+**/\r
+PEI_PCD_DATABASE *\r
BuildPcdDatabase (\r
- VOID\r
- )\r
-;\r
+ IN EFI_PEI_FILE_HANDLE FileHandle\r
+ );\r
\r
-SKU_ID *\r
-GetSkuIdArray (\r
- IN UINTN LocalTokenNumberTableIdx,\r
- IN PEI_PCD_DATABASE *Database\r
- )\r
-;\r
+/**\r
+ Get index of PCD entry in size table.\r
\r
+ @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r
+ @param Database Pointer to PCD database.\r
+\r
+ @return index of PCD entry in size table.\r
+\r
+**/\r
UINTN\r
GetSizeTableIndex (\r
IN UINTN LocalTokenNumberTableIdx,\r
IN PEI_PCD_DATABASE *Database\r
- )\r
-;\r
+ );\r
\r
+/**\r
+ Get PCD value's size for POINTER type PCD.\r
+\r
+ The POINTER type PCD's value will be stored into a buffer in specificed size.\r
+ The max size of this PCD's value is described in PCD's definition in DEC file.\r
+\r
+ @param LocalTokenNumberTableIdx Index of PCD token number in PCD token table\r
+ @param MaxSize Maxmium size of PCD's value\r
+ @param Database Pcd database in PEI phase.\r
+\r
+ @return PCD value's size for POINTER type PCD.\r
+\r
+**/\r
UINTN\r
GetPtrTypeSize (\r
IN UINTN LocalTokenNumberTableIdx,\r
OUT UINTN *MaxSize,\r
IN PEI_PCD_DATABASE *Database\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Set PCD value's size for POINTER type PCD.\r
\r
+ The POINTER type PCD's value will be stored into a buffer in specificed size.\r
+ The max size of this PCD's value is described in PCD's definition in DEC file.\r
\r
+ @param LocalTokenNumberTableIdx Index of PCD token number in PCD token table\r
+ @param CurrentSize Maxmium size of PCD's value\r
+ @param Database Pcd database in PEI phase.\r
\r
+ @retval TRUE Success to set PCD's value size, which is not exceed maxmium size\r
+ @retval FALSE Fail to set PCD's value size, which maybe exceed maxmium size\r
+\r
+**/\r
BOOLEAN\r
SetPtrTypeSize (\r
IN UINTN LocalTokenNumberTableIdx,\r
IN OUT UINTN *CurrentSize,\r
IN PEI_PCD_DATABASE *Database\r
- )\r
-;\r
-\r
-\r
-extern EFI_GUID gPcdDataBaseHobGuid;\r
-\r
-extern EFI_GUID gPcdPeiCallbackFnTableHobGuid;\r
-\r
-extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit;\r
+ );\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff