/** @file\r
Implementation of PcdLib class library for PEI phase.\r
\r
-Copyright (c) 2006, Intel Corporation<BR>\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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
-Module Name: PeiPcdLib.c\r
-\r
**/\r
\r
+#include <PiPei.h>\r
+\r
+#include <Ppi/Pcd.h>\r
+#include <Ppi/PiPcd.h>\r
+#include <Ppi/PcdInfo.h>\r
+#include <Ppi/PiPcdInfo.h>\r
\r
+#include <Library/PeiServicesLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
\r
/**\r
- The constructor function retrieve the PCD_PPI pointer.\r
+ Retrieve the PCD_PPI pointer.\r
+\r
+ This function is to locate PCD_PPI PPI via PeiService.\r
+ If fail to locate PCD_PPI, then ASSERT_EFI_ERROR().\r
\r
- @param[in] VOID\r
- \r
@retval PCD_PPI * The pointer to the PCD_PPI.\r
\r
**/\r
PCD_PPI *\r
-GetPcdPpiPtr (\r
+GetPcdPpiPointer (\r
VOID\r
- ) \r
+ )\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI *PcdPpi;\r
- EFI_PEI_SERVICES **PeiServices;\r
+ EFI_STATUS Status;\r
+ PCD_PPI *PcdPpi;\r
\r
+ Status = PeiServicesLocatePpi (&gPcdPpiGuid, 0, NULL, (VOID **)&PcdPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return PcdPpi;\r
+}\r
+\r
+/**\r
+ Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3.\r
\r
- PeiServices = GetPeiServicesTablePointer ();\r
+ This function is to locate EFI_PEI_PCD_PPI PPI via PeiService.\r
+ If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR().\r
\r
- Status = (**PeiServices).LocatePpi (\r
- PeiServices,\r
- &gPcdPpiGuid,\r
- 0,\r
- NULL,\r
- (VOID **)&PcdPpi\r
- );\r
+ @retval EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI.\r
\r
+**/\r
+EFI_PEI_PCD_PPI *\r
+GetPiPcdPpiPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_PEI_PCD_PPI *PiPcdPpi;\r
+\r
+ Status = PeiServicesLocatePpi (&gEfiPeiPcdPpiGuid, 0, NULL, (VOID **)&PiPcdPpi);\r
ASSERT_EFI_ERROR (Status);\r
\r
- return PcdPpi;\r
+ return PiPcdPpi;\r
+}\r
+\r
+/**\r
+ Retrieve the GET_PCD_INFO_PPI pointer.\r
+\r
+ This function is to locate GET_PCD_INFO_PPI PPI via PeiService.\r
+ If fail to locate GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
+\r
+ @retval GET_PCD_INFO_PPI * The pointer to the GET_PCD_INFO_PPI.\r
+\r
+**/\r
+GET_PCD_INFO_PPI *\r
+GetPcdInfoPpiPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ GET_PCD_INFO_PPI *PcdInfoPpi;\r
+\r
+ Status = PeiServicesLocatePpi (&gGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PcdInfoPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return PcdInfoPpi;\r
}\r
\r
+/**\r
+ Retrieve the pointer of EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 Vol 3.\r
\r
+ This function is to locate EFI_GET_PCD_INFO_PPI PPI via PeiService.\r
+ If fail to locate EFI_GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
+\r
+ @retval EFI_GET_PCD_INFO_PPI * The pointer to the EFI_GET_PCD_INFO_PPI.\r
+\r
+**/\r
+EFI_GET_PCD_INFO_PPI *\r
+GetPiPcdInfoPpiPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_GET_PCD_INFO_PPI *PiPcdInfoPpi;\r
+\r
+ Status = PeiServicesLocatePpi (&gEfiGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PiPcdInfoPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return PiPcdInfoPpi;\r
+}\r
\r
/**\r
+ This function provides a means by which SKU support can be established in the PCD infrastructure.\r
+\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\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
+ @param SkuId The SKU value that will be used when the PCD service retrieves\r
+ and sets values associated with a PCD token.\r
\r
- @retval SKU_ID Return the SKU ID that just be set.\r
+ @return Return the SKU ID that just be set.\r
\r
**/\r
UINTN\r
IN UINTN SkuId\r
)\r
{\r
-\r
- GetPcdPpiPtr()->SetSku (SkuId);;\r
+ GetPiPcdPpiPointer ()->SetSku (SkuId);\r
\r
return SkuId;\r
}\r
\r
-\r
-\r
/**\r
- Returns the 8-bit value for the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
+ Returns the 8-bit value for the token specified by TokenNumber.\r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
+ @return Returns the 8-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT8\r
EFIAPI\r
LibPcdGet8 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get8 (TokenNumber);\r
+ return (GetPcdPpiPointer ())->Get8 (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
- Returns the 16-bit value for the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ Returns the 16-bit value for the token specified by TokenNumber.\r
\r
- @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+\r
+ @return Returns the 16-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT16\r
EFIAPI\r
LibPcdGet16 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI *PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get16 (TokenNumber);\r
+ return (GetPcdPpiPointer ())->Get16 (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
- Returns the 32-bit value for the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
+ Returns the 32-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r
+ @return Returns the 32-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT32\r
EFIAPI\r
LibPcdGet32 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get32 (TokenNumber);\r
+ return (GetPcdPpiPointer ())->Get32 (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the 64-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r
+ @return Returns the 64-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT64\r
EFIAPI\r
LibPcdGet64 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get64 (TokenNumber);\r
+ return (GetPcdPpiPointer ())->Get64 (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the pointer to the buffer of the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval VOID* Returns the pointer to the token specified by TokenNumber.\r
+ @return Returns the pointer to the token specified by TokenNumber.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdGetPtr (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->GetPtr (TokenNumber);\r
+ return (GetPcdPpiPointer ())->GetPtr (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
- Returns the Boolean value of the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
+ Returns the Boolean value of the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r
+ @return Returns the Boolean value of the token specified by TokenNumber.\r
\r
**/\r
-BOOLEAN \r
+BOOLEAN\r
EFIAPI\r
LibPcdGetBool (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->GetBool (TokenNumber);\r
+ return (GetPcdPpiPointer ())->GetBool (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
- Returns the size of the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve the size of a given PCD token.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINTN Returns the size of the token specified by TokenNumber. \r
+ @return Returns the size of the token specified by TokenNumber.\r
\r
**/\r
UINTN\r
EFIAPI\r
LibPcdGetSize (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->GetSize (TokenNumber);\r
+ return (GetPcdPpiPointer ())->GetSize (TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the 8-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Return the UINT8.\r
+ @return Return the UINT8.\r
\r
**/\r
UINT8\r
EFIAPI\r
LibPcdGetEx8 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
+ ASSERT (Guid != NULL);\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get8Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get8 (Guid, TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the 16-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ If Guid is NULL, then ASSERT().\r
\r
- @retval UINT16 Return the UINT16.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+\r
+ @return Return the UINT16.\r
\r
**/\r
UINT16\r
EFIAPI\r
LibPcdGetEx16 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (Guid != NULL);\r
\r
- return PcdPpi->Get16Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get16 (Guid, TokenNumber);\r
}\r
\r
-\r
-\r
/**\r
Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Return the UINT32.\r
+ @return Return the UINT32.\r
\r
**/\r
UINT32\r
EFIAPI\r
LibPcdGetEx32 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (Guid != NULL);\r
\r
- return PcdPpi->Get32Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get32 (Guid, TokenNumber);\r
}\r
\r
-\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the 64-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT64 Return the UINT64.\r
+ @return Return the UINT64.\r
\r
**/\r
UINT64\r
EFIAPI\r
LibPcdGetEx64 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->Get64Ex (Guid, TokenNumber);\r
+ ASSERT (Guid != NULL);\r
+ return (GetPiPcdPpiPointer ())->Get64 (Guid, TokenNumber);\r
}\r
\r
+/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
\r
+ Returns the pointer to the buffer of token specified by TokenNumber and Guid.\r
\r
-/**\r
- Returns the pointer to the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval VOID* Return the VOID* pointer.\r
+ @return Return the VOID* pointer.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdGetExPtr (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (Guid != NULL);\r
\r
- return PcdPpi->GetPtrEx (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->GetPtr (Guid, TokenNumber);\r
}\r
\r
+/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
\r
+ Returns the Boolean value of the token specified by TokenNumber and Guid.\r
\r
-/**\r
- Returns the Boolean value of the token specified by TokenNumber and Guid. \r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval BOOLEAN Return the BOOLEAN.\r
+ @return Return the BOOLEAN.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
LibPcdGetExBool (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->GetBoolEx (Guid, TokenNumber);\r
+ ASSERT (Guid != NULL);\r
+ return (GetPiPcdPpiPointer ())->GetBool (Guid, TokenNumber);\r
}\r
\r
+/**\r
+ This function provides a means by which to retrieve the size of a given PCD token.\r
\r
+ Returns the size of the token specified by TokenNumber and Guid.\r
\r
-/**\r
- Returns the size of the token specified by TokenNumber and Guid. \r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINTN Return the size.\r
+ @return Return the size.\r
\r
**/\r
UINTN\r
EFIAPI\r
LibPcdGetExSize (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- return PcdPpi->GetSizeEx (Guid, TokenNumber);\r
+ ASSERT (Guid != NULL);\r
+ return (GetPiPcdPpiPointer ())->GetSize (Guid, TokenNumber);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the 8-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
-/**\r
- Sets the 8-bit value for the token specified by TokenNumber \r
- to the value specified by Value. Value is returned.\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 8-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 8-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT8\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet8 (\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
+LibPcdSet8S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ return (GetPcdPpiPointer ())->Set8 (TokenNumber, Value);\r
+}\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the 16-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
- Status = PcdPpi->Set8 (TokenNumber, Value);\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 16-bit value to set.\r
\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- return Value;\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet16S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ )\r
+{\r
+ return (GetPcdPpiPointer ())->Set16 (TokenNumber, Value);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the 32-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
-/**\r
- Sets the 16-bit value for the token specified by TokenNumber \r
- to the value specified by Value. Value is returned.\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 16-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 32-bit value to set.\r
\r
- @retval UINT16 Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT16\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet16 (\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
+LibPcdSet32S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ return (GetPcdPpiPointer ())->Set32 (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ Sets the 64-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 64-bit value to set.\r
\r
- Status = PcdPpi->Set16 (TokenNumber, Value);\r
+ @return The status of the set operation.\r
\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- return Value;\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet64S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ return (GetPcdPpiPointer ())->Set64 (TokenNumber, Value);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets a buffer for the token specified by TokenNumber to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation\r
+ was not actually performed.\r
\r
-/**\r
- Sets the 32-bit value for the token specified by TokenNumber \r
- to the value specified by Value. Value is returned.\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 32-bit value to set.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the\r
+ maximum size supported by TokenName and EFI_INVALID_PARAMETER must be returned.\r
+\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
- @retval UINT32 Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT32\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet32 (\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+LibPcdSetPtrS (\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- Status = PcdPpi->Set32 (TokenNumber, Value);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
- return Value;\r
+ return (GetPcdPpiPointer ())->SetPtr (TokenNumber, SizeOfBuffer, (VOID *)Buffer);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the boolean value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
-/**\r
- Sets the 64-bit value for the token specified by TokenNumber \r
- to the value specified by Value. Value is returned.\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 64-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The boolean value to set.\r
\r
- @retval UINT64 Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT64\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet64 (\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+LibPcdSetBoolS (\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ return (GetPcdPpiPointer ())->SetBool (TokenNumber, Value);\r
+}\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the 8-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
- Status = PcdPpi->Set64 (TokenNumber, Value);\r
+ If Guid is NULL, then ASSERT().\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 8-bit value to set.\r
\r
- return Value;\r
-}\r
+ @return The status of the set operation.\r
\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx8S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
\r
+ return (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value);\r
+}\r
\r
/**\r
- Sets a buffer for the token specified by TokenNumber to \r
- the value specified by Buffer and SizeOfValue. Buffer to\r
- be set is returned. The content of the buffer could be \r
- overwritten if a Callback on SET is registered with this\r
- TokenNumber.\r
- \r
- If SizeOfValue is greater than the maximum \r
- size support by TokenNumber, then set SizeOfValue to the \r
- maximum size supported by TokenNumber and return NULL to \r
- indicate that the set operation was not actually performed. \r
- \r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.\r
- @param[in] Value A pointer to the buffer to set.\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- @retval VOID* Return the pointer for the buffer been set.\r
+ Sets the 16-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 16-bit value to set.\r
+\r
+ @return The status of the set operation.\r
\r
**/\r
-VOID *\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetPtr (\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+LibPcdSetEx16S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI *PcdPpi;\r
- UINTN Size;\r
+ ASSERT (Guid != NULL);\r
\r
- if (*SizeOfBuffer > 0) {\r
- ASSERT (Buffer != NULL);\r
- }\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
- \r
- Size = LibPcdGetSize (TokenNumber);\r
- \r
- if (*SizeOfBuffer > Size) {\r
- *SizeOfBuffer = Size;\r
- return NULL;\r
- }\r
-\r
- Status = PcdPpi->SetPtr (TokenNumber, *SizeOfBuffer, Buffer);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Buffer;\r
+ return (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 32-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
+ If Guid is NULL, then ASSERT().\r
\r
-/**\r
- Sets the Boolean value for the token specified by TokenNumber \r
- to the value specified by Value. Value is returned.\r
- \r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The boolean value to set.\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 32-bit value to set.\r
\r
- @retval BOOLEAN Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-BOOLEAN\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetBool (\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
+LibPcdSetEx32S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ ASSERT (Guid != NULL);\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ return (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value);\r
+}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- Status = PcdPpi->SetBool (TokenNumber, Value);\r
+ Sets the 64-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ If Guid is NULL, then ASSERT().\r
\r
- return Value;\r
-}\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 64-bit value to set.\r
\r
+ @return The status of the set operation.\r
\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx64S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ return (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value);\r
+}\r
\r
/**\r
- Sets the 8-bit value for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets a buffer for the token specified by TokenNumber to the value specified by\r
+ Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation\r
+ was not actually performed.\r
+\r
If Guid is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 8-bit value to set.\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT8\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx8 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
+LibPcdSetExPtrS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
+ ASSERT (Guid != NULL);\r
\r
- Status = PcdPpi->Set8Ex (Guid, TokenNumber, Value);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
- return Value;\r
+ return (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
+ Sets the boolean value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
\r
-/**\r
- Sets the 16-bit value for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
If Guid is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 16-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The boolean value to set.\r
+\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT16\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx16 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
+LibPcdSetExBoolS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ ASSERT (Guid != NULL);\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ return (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value);\r
+}\r
\r
+/**\r
+ Set up a notification function that is called when a specified token is set.\r
\r
- Status = PcdPpi->Set16Ex (Guid, TokenNumber, Value);\r
+ When the token specified by TokenNumber and Guid is set,\r
+ then notification function specified by NotificationFunction is called.\r
+ If Guid is NULL, then the default token space is used.\r
+ If NotificationFunction is NULL, then ASSERT().\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
+ If NULL, then the default token space is used.\r
+ @param[in] TokenNumber The PCD token number to monitor.\r
+ @param[in] NotificationFunction The function to call when the token\r
+ specified by Guid and TokenNumber is set.\r
\r
- return Value;\r
-}\r
+**/\r
+VOID\r
+EFIAPI\r
+LibPcdCallbackOnSet (\r
+ IN CONST GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_CALLBACK NotificationFunction\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ ASSERT (NotificationFunction != NULL);\r
+\r
+ Status = (GetPiPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK)NotificationFunction);\r
\r
+ ASSERT_EFI_ERROR (Status);\r
\r
+ return;\r
+}\r
\r
/**\r
- Sets the 32-bit value for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
- If Guid is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 32-bit value to set.\r
+ Disable a notification function that was established with LibPcdCallbackonSet().\r
\r
- @retval UINT32 Return the value been set.\r
+ Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
+ If NotificationFunction is NULL, then ASSERT().\r
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,\r
+ and NotificationFunction, then ASSERT().\r
+\r
+ @param[in] Guid Specify the GUID token space.\r
+ @param[in] TokenNumber Specify the token number.\r
+ @param[in] NotificationFunction The callback function to be unregistered.\r
\r
**/\r
-UINT32\r
+VOID\r
EFIAPI\r
-LibPcdSetEx32 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+LibPcdCancelCallback (\r
+ IN CONST GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_CALLBACK NotificationFunction\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ EFI_STATUS Status;\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (NotificationFunction != NULL);\r
\r
-\r
- Status = PcdPpi->Set32Ex (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK)NotificationFunction);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
- return Value;\r
+ return;\r
}\r
\r
+/**\r
+ Retrieves the next token in a token space.\r
\r
+ Retrieves the next PCD token number from the token space specified by Guid.\r
+ If Guid is NULL, then the default token space is used. If TokenNumber is 0,\r
+ then the first token number is returned. Otherwise, the token number that\r
+ follows TokenNumber in the token space is returned. If TokenNumber is the last\r
+ token number in the token space, then 0 is returned.\r
\r
-/**\r
- Sets the 64-bit value for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
- If Guid is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 64-bit value to set.\r
+ If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
\r
- @retval UINT64 Return the value been set.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates which namespace\r
+ to set a value from. If NULL, then the default token space is used.\r
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD\r
+ token number.\r
+\r
+ @return The next valid token number.\r
\r
**/\r
-UINT64\r
+UINTN\r
EFIAPI\r
-LibPcdSetEx64 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+LibPcdGetNextToken (\r
+ IN CONST GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ EFI_STATUS Status;\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ Status = (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
+ ASSERT (!EFI_ERROR (Status) || TokenNumber == 0);\r
\r
+ return TokenNumber;\r
+}\r
\r
- Status = PcdPpi->Set64Ex (Guid, TokenNumber, Value);\r
+/**\r
+ Used to retrieve the list of available PCD token space GUIDs.\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+ in the platform.\r
+ If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
+ If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
\r
- return Value;\r
-}\r
+ @param TokenSpaceGuid The pointer to the a PCD token space GUID\r
\r
+ @return The next valid token namespace.\r
\r
+**/\r
+GUID *\r
+EFIAPI\r
+LibPcdGetNextTokenSpace (\r
+ IN CONST GUID *TokenSpaceGuid\r
+ )\r
+{\r
+ (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
+\r
+ return (GUID *)TokenSpaceGuid;\r
+}\r
\r
/**\r
- Sets a buffer for the token specified by TokenNumber to the value specified by \r
- Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
- the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
- supported by TokenNumber and return NULL to indicate that the set operation \r
- was not actually performed. \r
- \r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
- @param[in] Buffer A pointer to the buffer to set.\r
+ Sets a value of a patchable PCD entry that is type pointer.\r
\r
- @retval VOID * Return the pinter to the buffer been set.\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer\r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than\r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return\r
+ NULL to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and NULL must be returned.\r
+\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
+\r
+ @return Return the pointer to the buffer been set.\r
\r
**/\r
VOID *\r
EFIAPI\r
-LibPcdSetExPtr (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+LibPatchPcdSetPtr (\r
+ OUT VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI *PcdPpi;\r
- UINTN Size;\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
if (*SizeOfBuffer > 0) {\r
ASSERT (Buffer != NULL);\r
}\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
- Size = LibPcdGetExSize (Guid, TokenNumber);\r
- if (*SizeOfBuffer > Size) {\r
- *SizeOfBuffer = Size;\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS))\r
+ {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
return NULL;\r
}\r
\r
- Status = PcdPpi->SetPtrEx (Guid, TokenNumber, *SizeOfBuffer, Buffer);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
\r
- return Buffer;\r
+ return (VOID *)Buffer;\r
}\r
\r
+/**\r
+ Sets a value of a patchable PCD entry that is type pointer.\r
\r
+ Sets the PCD entry specified by PatchVariable to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.\r
\r
-/**\r
- Sets the Boolean value for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
- If Guid is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The Boolean value to set.\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
\r
- @retval Boolean Return the value been set.\r
+ @return The status of the set operation.\r
\r
**/\r
-BOOLEAN\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetExBool (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
+LibPatchPcdSetPtrS (\r
+ OUT VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
- PcdPpi = GetPcdPpiPtr ();\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS))\r
+ {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
\r
- Status = PcdPpi->SetBoolEx (Guid, TokenNumber, Value);\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Value;\r
+ return RETURN_SUCCESS;\r
}\r
\r
+/**\r
+ Sets a value and size of a patchable PCD entry that is type pointer.\r
\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer\r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than\r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return\r
+ NULL to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and NULL must be returned.\r
\r
-/**\r
- When the token specified by TokenNumber and Guid is set, \r
- then notification function specified by NotificationFunction is called. \r
- If Guid is NULL, then the default token space is used. \r
- If NotificationFunction is NULL, then ASSERT().\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which \r
- namespace to set a value from. If NULL, then the default \r
- token space is used.\r
- @param[in] TokenNumber The PCD token number to monitor.\r
- @param[in] NotificationFunction The function to call when the token \r
- specified by Guid and TokenNumber is set.\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
\r
- @retval VOID\r
+ @return Return the pointer to the buffer been set.\r
\r
**/\r
-VOID\r
+VOID *\r
EFIAPI\r
-LibPcdCallbackOnSet (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_CALLBACK NotificationFunction\r
+LibPatchPcdSetPtrAndSize (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
- Status = PcdPpi->CallbackOnSet (TokenNumber, Guid, NotificationFunction);\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS))\r
+ {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return NULL;\r
+ }\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
\r
- return;\r
+ return (VOID *)Buffer;\r
}\r
\r
+/**\r
+ Sets a value and size of a patchable PCD entry that is type pointer.\r
\r
+ Sets the PCD entry specified by PatchVariable to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.\r
\r
-/**\r
- Disable a notification function that was established with LibPcdCallbackonSet().\r
- If NotificationFunction is NULL, then ASSERT().\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] Guid Specify the GUID token space.\r
- @param[in] TokenNumber Specify the token number.\r
- @param[in] NotificationFunction The callback function to be unregistered.\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
\r
- @retval VOID\r
+ @return The status of the set operation.\r
\r
**/\r
-VOID\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdCancelCallback (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_CALLBACK NotificationFunction\r
+LibPatchPcdSetPtrAndSizeS (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
- Status = PcdPpi->CancelCallback (TokenNumber, Guid, NotificationFunction);\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS))\r
+ {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
\r
- return;\r
+ return RETURN_SUCCESS;\r
}\r
\r
-\r
-\r
/**\r
- Retrieves the next PCD token number from the token space specified by Guid. \r
- If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r
- then the first token number is returned. Otherwise, the token number that \r
- follows TokenNumber in the token space is returned. If TokenNumber is the last \r
- token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r
- is not in the token space specified by Guid, then ASSERT().\r
+ Retrieve additional information associated with a PCD token.\r
\r
- @param[in] Pointer to a 128-bit unique value that designates which namespace \r
- to set a value from. If NULL, then the default token space is used.\r
- @param[in] The previous PCD token number. If 0, then retrieves the first PCD \r
- token number.\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
- @retval UINTN The next valid token number.\r
+ If TokenNumber is not in the default token space specified, then ASSERT().\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
-UINTN \r
+VOID\r
EFIAPI\r
-LibPcdGetNextToken (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber\r
+LibPcdGetInfo (\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
-\r
- Status = PcdPpi->GetNextToken (Guid, &TokenNumber);\r
+ EFI_STATUS Status;\r
\r
+ Status = GetPcdInfoPpiPointer ()->GetInfo (TokenNumber, (EFI_PCD_INFO *)PcdInfo);\r
ASSERT_EFI_ERROR (Status);\r
-\r
- return TokenNumber;\r
}\r
\r
-\r
/**\r
- Retrieves the next PCD token space from a token space specified by Guid.\r
- Guid of NULL is reserved to mark the default local token namespace on the current\r
- platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
- current platform is returned. If Guid is the last non-local token space, \r
- then NULL is returned. \r
-\r
- If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
+ Retrieve additional information associated with a PCD token.\r
\r
- \r
- @param[in] Pointer to a 128-bit unique value that designates from which namespace \r
- to start the search.\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
- @retval CONST GUID * The next valid token namespace.\r
+ If TokenNumber is not in the token space specified by Guid, then ASSERT().\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
-CONST GUID* \r
+VOID\r
EFIAPI\r
-LibPcdGetNextTokenSpace (\r
- IN CONST GUID *Guid\r
+LibPcdGetInfoEx (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
)\r
{\r
- EFI_STATUS Status;\r
- PCD_PPI * PcdPpi;\r
-\r
- PcdPpi = GetPcdPpiPtr ();\r
-\r
-\r
- Status = PcdPpi->GetNextTokenSpace (&Guid);\r
+ EFI_STATUS Status;\r
\r
+ Status = GetPiPcdInfoPpiPointer ()->GetInfo (Guid, TokenNumber, (EFI_PCD_INFO *)PcdInfo);\r
ASSERT_EFI_ERROR (Status);\r
-\r
- return Guid;\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
+LibPcdGetSku (\r
+ VOID\r
+ )\r
+{\r
+ return GetPiPcdInfoPpiPointer ()->GetSku ();\r
+}\r
projects / mirror_edk2.git / blobdiff