--- /dev/null
+/** @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
+\r
+\r
+Module Name: PeiPcdLib.c\r
+\r
+**/\r
+\r
+\r
+\r
+/**\r
+ The constructor function retrieve the PCD_PPI pointer.\r
+\r
+ @param[in] VOID\r
+ \r
+ @retval PCD_PPI * The pointer to the PCD_PPI.\r
+\r
+**/\r
+STATIC\r
+PCD_PPI *\r
+GetPcdPpiPtr (\r
+ VOID\r
+ ) \r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI *PcdPpi;\r
+ EFI_PEI_SERVICES **PeiServices;\r
+\r
+\r
+ PeiServices = GetPeiServicesTablePointer ();\r
+\r
+ Status = (**PeiServices).LocatePpi (\r
+ PeiServices,\r
+ &gPcdPpiGuid,\r
+ 0,\r
+ NULL,\r
+ (VOID **)&PcdPpi\r
+ );\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return PcdPpi;\r
+}\r
+\r
+\r
+\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
+\r
+ @retval SKU_ID Return the SKU ID that just be set.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+LibPcdSetSku (\r
+ IN UINTN SkuId\r
+ )\r
+{\r
+\r
+ ASSERT (SkuId < 0x100);\r
+\r
+ GetPcdPpiPtr()->SetSku (SkuId);;\r
+\r
+ return SkuId;\r
+}\r
+\r
+\r
+\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
+\r
+ @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
+\r
+**/\r
+UINT8\r
+EFIAPI\r
+LibPcdGet8 (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get8 (TokenNumber);\r
+}\r
+\r
+\r
+\r
+/**\r
+ Returns the 16-bit value for the token specified by TokenNumber. \r
+\r
+ @param[in] The PCD token number to retrieve a current value for.\r
+\r
+ @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+LibPcdGet16 (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI *PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get16 (TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+LibPcdGet32 (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get32 (TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+**/\r
+UINT64\r
+EFIAPI\r
+LibPcdGet64 (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get64 (TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPcdGetPtr (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetPtr (TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+**/\r
+BOOLEAN \r
+EFIAPI\r
+LibPcdGetBool (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetBool (TokenNumber);\r
+}\r
+\r
+\r
+\r
+/**\r
+ Returns the size of the token specified by TokenNumber. \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
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+LibPcdGetSize (\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetSize (TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+ @retval UINT8 Return the UINT8.\r
+\r
+**/\r
+UINT8\r
+EFIAPI\r
+LibPcdGetEx8 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get8Ex (Guid, TokenNumber);\r
+}\r
+\r
+\r
+\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
+\r
+ @retval UINT16 Return the UINT16.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+LibPcdGetEx16 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get16Ex (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
+\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
+\r
+ @retval UINT32 Return the UINT32.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+LibPcdGetEx32 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get32Ex (Guid, TokenNumber);\r
+}\r
+\r
+\r
+\r
+\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
+\r
+ @retval UINT64 Return the UINT64.\r
+\r
+**/\r
+UINT64\r
+EFIAPI\r
+LibPcdGetEx64 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->Get64Ex (Guid, TokenNumber);\r
+}\r
+\r
+\r
+\r
+/**\r
+ Returns the pointer to 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
+\r
+ @retval VOID* Return the VOID* pointer.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPcdGetExPtr (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetPtrEx (Guid, TokenNumber);\r
+}\r
+\r
+\r
+\r
+/**\r
+ Returns the Boolean value of 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
+\r
+ @retval BOOLEAN Return the BOOLEAN.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+LibPcdGetExBool (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetBoolEx (Guid, TokenNumber);\r
+}\r
+\r
+\r
+\r
+/**\r
+ Returns the size of 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
+\r
+ @retval UINTN Return the size.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+LibPcdGetExSize (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ PCD_PPI * PcdPpi;\r
+\r
+ ASSERT (Guid != NULL);\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ return PcdPpi->GetSizeEx (Guid, TokenNumber);\r
+}\r
+\r
+\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
+\r
+ @retval UINT8 Return the value been set.\r
+\r
+**/\r
+UINT8\r
+EFIAPI\r
+LibPcdSet8 (\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->Set8 (TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ return Value;\r
+}\r
+\r
+\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
+\r
+ @retval UINT16 Return the value been set.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+LibPcdSet16 (\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->Set16 (TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ return Value;\r
+}\r
+\r
+\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
+\r
+ @retval UINT32 Return the value been set.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+LibPcdSet32 (\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->Set32 (TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\r
+\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
+\r
+ @retval UINT64 Return the value been set.\r
+\r
+**/\r
+UINT64\r
+EFIAPI\r
+LibPcdSet64 (\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->Set64 (TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\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
+\r
+ @retval VOID* Return the pointer for the buffer been set.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPcdSetPtr (\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
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+ \r
+ Status = PcdPpi->SetPtr (TokenNumber, SizeOfBuffer, Buffer);\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ return Buffer;\r
+}\r
+\r
+\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
+\r
+ @retval BOOLEAN Return the value been set.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+LibPcdSetBool (\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->SetBool (TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\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
+ 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
+\r
+ @retval UINT8 Return the value been set.\r
+\r
+**/\r
+UINT8\r
+EFIAPI\r
+LibPcdSetEx8 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\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
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\r
+\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
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+LibPcdSetEx16 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ ASSERT (Guid != NULL);\r
+ Status = PcdPpi->Set16Ex (Guid, TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\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
+\r
+ @retval UINT32 Return the value been set.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+LibPcdSetEx32 (\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
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->Set32Ex (Guid, TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\r
+\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
+\r
+ @retval UINT64 Return the value been set.\r
+\r
+**/\r
+UINT64\r
+EFIAPI\r
+LibPcdSetEx64 (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+ ASSERT (Guid != NULL);\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->Set64Ex (Guid, TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\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
+\r
+ @retval VOID * Return the pinter 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
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI *PcdPpi;\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+ ASSERT (Guid != NULL);\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ Status = PcdPpi->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ return Buffer;\r
+}\r
+\r
+\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
+\r
+ @retval Boolean Return the value been set.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+LibPcdSetExBool (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+ ASSERT (Guid != NULL);\r
+ Status = PcdPpi->SetBoolEx (Guid, TokenNumber, Value);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Value;\r
+}\r
+\r
+\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
+\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
+\r
+ @retval VOID\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
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return;\r
+}\r
+\r
+\r
+\r
+/**\r
+ Disable a notification function that was established with LibPcdCallbackonSet().\r
+ If NotificationFunction 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
+\r
+ @retval VOID\r
+\r
+**/\r
+VOID\r
+EFIAPI\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
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return;\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
+\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
+\r
+ @retval UINTN The next valid token number.\r
+\r
+**/\r
+UINTN \r
+EFIAPI\r
+LibPcdGetNextToken (\r
+ IN CONST GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->GetNextToken (Guid, &TokenNumber);\r
+\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
+\r
+ \r
+ @param[in] Pointer to a 128-bit unique value that designates from which namespace \r
+ to start the search.\r
+\r
+ @retval CONST GUID * The next valid token namespace.\r
+\r
+**/\r
+GUID * \r
+EFIAPI\r
+LibPcdGetNextTokenSpace (\r
+ IN CONST GUID *Guid\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_PPI * PcdPpi;\r
+\r
+ PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+ Status = PcdPpi->GetNextTokenSpace (&Guid);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return (GUID *)Guid;\r
+}\r
+\r
+\r
+\r
+/**\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
+ and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
+ MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \r
+ NULL to indicate that the set operation was not actually performed. \r
+ If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \r
+ MaximumDatumSize and NULL must be returned.\r
+ \r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfValue is NULL, then ASSERT().\r
+ If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[in] 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
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtr (\r
+ IN VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ \r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return NULL;\r
+ }\r
+ \r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ \r
+ return (VOID *) Buffer;\r
+}\r
+\r
+\r
projects / mirror_edk2.git / blobdiff