X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FLibrary%2FPeiPcdLib%2FPeiPcdLib.c;h=2496701862fdb789ad25408547b2b1b63f1ce09f;hb=e46440360e2209c5247d97461f1650ea86f8a191;hp=8ef52055930cde23973a96194943b0c1faefec5b;hpb=3496595d7bafc329cae169f79c450253b32fadd8;p=mirror_edk2.git diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index 8ef5205593..2496701862 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -1,8 +1,8 @@ /** @file Implementation of PcdLib class library for PEI phase. -Copyright (c) 2006, Intel Corporation
-All rights reserved. This program and the accompanying materials +Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -11,281 +11,337 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: PeiPcdLib.c - **/ + +#include + +#include +#include +#include +#include + +#include +#include +#include +#include + /** - The constructor function retrieve the PCD_PPI pointer. + Retrieve the PCD_PPI pointer. - @param[in] VOID + This function is to locate PCD_PPI PPI via PeiService. + If fail to locate PCD_PPI, then ASSERT_EFI_ERROR(). @retval PCD_PPI * The pointer to the PCD_PPI. **/ PCD_PPI * -GetPcdPpiPtr ( +GetPcdPpiPointer ( VOID ) { EFI_STATUS Status; PCD_PPI *PcdPpi; - EFI_PEI_SERVICES **PeiServices; + + Status = PeiServicesLocatePpi (&gPcdPpiGuid, 0, NULL, (VOID **)&PcdPpi); + ASSERT_EFI_ERROR (Status); + return PcdPpi; +} - PeiServices = GetPeiServicesTablePointer (); +/** + Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3. - Status = (**PeiServices).LocatePpi ( - PeiServices, - &gPcdPpiGuid, - 0, - NULL, - (VOID **)&PcdPpi - ); + This function is to locate EFI_PEI_PCD_PPI PPI via PeiService. + If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR(). + + @retval EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI. +**/ +EFI_PEI_PCD_PPI * +GetPiPcdPpiPointer ( + VOID + ) +{ + EFI_STATUS Status; + EFI_PEI_PCD_PPI *PiPcdPpi; + + Status = PeiServicesLocatePpi (&gEfiPeiPcdPpiGuid, 0, NULL, (VOID **)&PiPcdPpi); ASSERT_EFI_ERROR (Status); + + return PiPcdPpi; +} - return PcdPpi; +/** + Retrieve the GET_PCD_INFO_PPI pointer. + + This function is to locate GET_PCD_INFO_PPI PPI via PeiService. + If fail to locate GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR(). + + @retval GET_PCD_INFO_PPI * The pointer to the GET_PCD_INFO_PPI. + +**/ +GET_PCD_INFO_PPI * +GetPcdInfoPpiPointer ( + VOID + ) +{ + EFI_STATUS Status; + GET_PCD_INFO_PPI *PcdInfoPpi; + + Status = PeiServicesLocatePpi (&gGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PcdInfoPpi); + ASSERT_EFI_ERROR (Status); + + return PcdInfoPpi; } +/** + Retrieve the pointer of EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 Vol 3. + + This function is to locate EFI_GET_PCD_INFO_PPI PPI via PeiService. + If fail to locate EFI_GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR(). + @retval EFI_GET_PCD_INFO_PPI * The pointer to the EFI_GET_PCD_INFO_PPI. + +**/ +EFI_GET_PCD_INFO_PPI * +GetPiPcdInfoPpiPointer ( + VOID + ) +{ + EFI_STATUS Status; + EFI_GET_PCD_INFO_PPI *PiPcdInfoPpi; + + Status = PeiServicesLocatePpi (&gEfiGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PiPcdInfoPpi); + ASSERT_EFI_ERROR (Status); + + return PiPcdInfoPpi; +} /** + This function provides a means by which SKU support can be established in the PCD infrastructure. + Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned. - @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and - set values associated with a PCD token. + @param SkuId The SKU value that will be used when the PCD service retrieves + and sets values associated with a PCD token. - @retval SKU_ID Return the SKU ID that just be set. + @return Return the SKU ID that just be set. **/ -SKU_ID +UINTN EFIAPI LibPcdSetSku ( - IN SKU_ID SkuId + IN UINTN SkuId ) { - - GetPcdPpiPtr()->SetSku (SkuId);; - + GetPiPcdPpiPointer()->SetSku (SkuId); + return SkuId; } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 8-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. + @return Returns the 8-bit value for the token specified by TokenNumber. **/ UINT8 EFIAPI LibPcdGet8 ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get8 (TokenNumber); + return (GetPcdPpiPointer ())->Get8 (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 16-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. + @return Returns the 16-bit value for the token specified by TokenNumber. **/ UINT16 EFIAPI LibPcdGet16 ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI *PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get16 (TokenNumber); + return (GetPcdPpiPointer ())->Get16 (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 32-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber. + @return Returns the 32-bit value for the token specified by TokenNumber. **/ UINT32 EFIAPI LibPcdGet32 ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get32 (TokenNumber); + return (GetPcdPpiPointer ())->Get32 (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 64-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber. + @return Returns the 64-bit value for the token specified by TokenNumber. **/ UINT64 EFIAPI LibPcdGet64 ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get64 (TokenNumber); + return (GetPcdPpiPointer ())->Get64 (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the pointer to the buffer of the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval VOID* Returns the pointer to the token specified by TokenNumber. + @return Returns the pointer to the token specified by TokenNumber. **/ VOID * EFIAPI LibPcdGetPtr ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetPtr (TokenNumber); + return (GetPcdPpiPointer ())->GetPtr (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the Boolean value of the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. + @return Returns the Boolean value of the token specified by TokenNumber. **/ BOOLEAN EFIAPI LibPcdGetBool ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetBool (TokenNumber); + return (GetPcdPpiPointer ())->GetBool (TokenNumber); } /** - Returns the size of the token specified by TokenNumber. + This function provides a means by which to retrieve the size of a given PCD token. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINTN Returns the size of the token specified by TokenNumber. + @return Returns the size of the token specified by TokenNumber. **/ UINTN EFIAPI LibPcdGetSize ( - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetSize (TokenNumber); + return (GetPcdPpiPointer ())->GetSize (TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 8-bit value for the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT8 Return the UINT8. + @return Return the UINT8. **/ UINT8 EFIAPI LibPcdGetEx8 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; + ASSERT (Guid != NULL); - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get8Ex (Guid, TokenNumber); + return (GetPiPcdPpiPointer ())->Get8 (Guid, TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 16-bit value for the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT16 Return the UINT16. + @return Return the UINT16. **/ UINT16 EFIAPI LibPcdGetEx16 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - PcdPpi = GetPcdPpiPtr (); + ASSERT (Guid != NULL); - return PcdPpi->Get16Ex (Guid, TokenNumber); + return (GetPiPcdPpiPointer ())->Get16 (Guid, TokenNumber); } @@ -294,164 +350,158 @@ LibPcdGetEx16 ( Returns the 32-bit value for the token specified by TokenNumber and Guid. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT32 Return the UINT32. + @return Return the UINT32. **/ UINT32 EFIAPI LibPcdGetEx32 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; + ASSERT (Guid != NULL); - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get32Ex (Guid, TokenNumber); + return (GetPiPcdPpiPointer ())->Get32 (Guid, TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the 64-bit value for the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINT64 Return the UINT64. + @return Return the UINT64. **/ UINT64 EFIAPI LibPcdGetEx64 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->Get64Ex (Guid, TokenNumber); + ASSERT (Guid != NULL); + return (GetPiPcdPpiPointer ())->Get64 (Guid, TokenNumber); } /** - Returns the pointer to the token specified by TokenNumber and Guid. + This function provides a means by which to retrieve a value for a given PCD token. + + Returns the pointer to the buffer of token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval VOID* Return the VOID* pointer. + @return Return the VOID* pointer. **/ VOID * EFIAPI LibPcdGetExPtr ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; + ASSERT (Guid != NULL); - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetPtrEx (Guid, TokenNumber); + return (GetPiPcdPpiPointer ())->GetPtr (Guid, TokenNumber); } /** + This function provides a means by which to retrieve a value for a given PCD token. + Returns the Boolean value of the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval BOOLEAN Return the BOOLEAN. + @return Return the BOOLEAN. **/ BOOLEAN EFIAPI LibPcdGetExBool ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetBoolEx (Guid, TokenNumber); + ASSERT (Guid != NULL); + return (GetPiPcdPpiPointer ())->GetBool (Guid, TokenNumber); } /** + This function provides a means by which to retrieve the size of a given PCD token. + Returns the size of the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid The pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. - @retval UINTN Return the size. + @return Return the size. **/ UINTN EFIAPI LibPcdGetExSize ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber + IN UINTN TokenNumber ) { - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - return PcdPpi->GetSizeEx (Guid, TokenNumber); + ASSERT (Guid != NULL); + return (GetPiPcdPpiPointer ())->GetSize (Guid, TokenNumber); } +#ifndef DISABLE_NEW_DEPRECATED_INTERFACES /** + This function provides a means by which to set a value for a given PCD token. + Sets the 8-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. - - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 8-bit value to set. - @retval UINT8 Return the value been set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 8-bit value to set. + + @return Return the value that was set. **/ UINT8 EFIAPI LibPcdSet8 ( - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN UINT8 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - - Status = PcdPpi->Set8 (TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPcdPpiPointer ())->Set8 (TokenNumber, Value); return Value; } @@ -459,31 +509,25 @@ LibPcdSet8 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 16-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. - - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 16-bit value to set. - @retval UINT16 Return the value been set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 16-bit value to set. + + @return Return the value that was set. **/ UINT16 EFIAPI LibPcdSet16 ( - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN UINT16 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - - Status = PcdPpi->Set16 (TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPcdPpiPointer ())->Set16 (TokenNumber, Value); return Value; } @@ -491,30 +535,25 @@ LibPcdSet16 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 32-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. - - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 32-bit value to set. - @retval UINT32 Return the value been set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 32-bit value to set. + + @return Return the value that was set. **/ UINT32 EFIAPI LibPcdSet32 ( - IN PCD_TOKEN_NUMBER TokenNumber, - IN UINT32 Value + IN UINTN TokenNumber, + IN UINT32 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - Status = PcdPpi->Set32 (TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPcdPpiPointer ())->Set32 (TokenNumber, Value); return Value; } @@ -522,31 +561,25 @@ LibPcdSet32 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 64-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. - - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 64-bit value to set. - @retval UINT64 Return the value been set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 64-bit value to set. + + @return Return the value that was set. **/ UINT64 EFIAPI LibPcdSet64 ( - IN PCD_TOKEN_NUMBER TokenNumber, - IN UINT64 Value + IN UINTN TokenNumber, + IN UINT64 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - - Status = PcdPpi->Set64 (TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPcdPpiPointer ())->Set64 (TokenNumber, Value); return Value; } @@ -554,65 +587,75 @@ LibPcdSet64 ( /** - Sets a buffer for the token specified by TokenNumber to - the value specified by Value. Value is returned. - If Value is NULL, then ASSERT(). + This function provides a means by which to set a value for a given PCD token. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value A pointer to the buffer to set. + Sets a buffer for the token specified by TokenNumber to the value + specified by Buffer and SizeOfBuffer. Buffer is returned. + If SizeOfBuffer is greater than the maximum size support by TokenNumber, + then set SizeOfBuffer to the maximum size supported by TokenNumber and + return NULL to indicate that the set operation was not actually performed. + + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the + maximum size supported by TokenName and NULL must be returned. + + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to set. - @retval VOID* Return the pointer for the buffer been set. + @return Return the pointer for the buffer been set. **/ VOID * EFIAPI LibPcdSetPtr ( - IN PCD_TOKEN_NUMBER TokenNumber, - IN UINTN SizeOfBuffer, - IN VOID *Buffer + IN UINTN TokenNumber, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer ) { EFI_STATUS Status; - PCD_PPI * PcdPpi; + UINTN InputSizeOfBuffer; - PcdPpi = GetPcdPpiPtr (); + ASSERT (SizeOfBuffer != NULL); + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } - Status = PcdPpi->SetPtr (TokenNumber, SizeOfBuffer, Buffer); - - ASSERT_EFI_ERROR (Status); + InputSizeOfBuffer = *SizeOfBuffer; + Status = (GetPcdPpiPointer ())->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer); + if (EFI_ERROR (Status) && (*SizeOfBuffer < InputSizeOfBuffer)) { + return NULL; + } - return Buffer; + return (VOID *) Buffer; } /** + This function provides a means by which to set a value for a given PCD token. + Sets the Boolean value for the token specified by TokenNumber to the value specified by Value. Value is returned. - - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The boolean value to set. - @retval BOOLEAN Return the value been set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The boolean value to set. + + @return Return the value that was set. **/ BOOLEAN EFIAPI LibPcdSetBool ( - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN BOOLEAN Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); - - - Status = PcdPpi->SetBool (TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPcdPpiPointer ())->SetBool (TokenNumber, Value); return Value; } @@ -620,35 +663,32 @@ LibPcdSetBool ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 8-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. + If Guid is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 8-bit value to set. - @retval UINT8 Return the value been set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 8-bit value to set. + + @return Return the value that was set. **/ UINT8 EFIAPI LibPcdSetEx8 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN UINT8 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); + ASSERT (Guid != NULL); - - Status = PcdPpi->Set8Ex (Guid, TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value); return Value; } @@ -656,35 +696,32 @@ LibPcdSetEx8 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 16-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. + If Guid is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 16-bit value to set. - @retval UINT8 Return the value been set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 16-bit value to set. + + @return Return the value that was set. **/ UINT16 EFIAPI LibPcdSetEx16 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN UINT16 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); + ASSERT (Guid != NULL); - - Status = PcdPpi->Set16Ex (Guid, TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value); return Value; } @@ -692,35 +729,32 @@ LibPcdSetEx16 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 32-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. + If Guid is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 32-bit value to set. - @retval UINT32 Return the value been set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 32-bit value to set. + + @return Return the value that was set. **/ UINT32 EFIAPI LibPcdSetEx32 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, - IN UINT32 Value + IN UINTN TokenNumber, + IN UINT32 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); + ASSERT (Guid != NULL); - - Status = PcdPpi->Set32Ex (Guid, TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value); return Value; } @@ -728,35 +762,32 @@ LibPcdSetEx32 ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the 64-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. + If Guid is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 64-bit value to set. - @retval UINT64 Return the value been set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 64-bit value to set. + + @return Return the value that was set. **/ UINT64 EFIAPI LibPcdSetEx64 ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN UINT64 Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); + ASSERT (Guid != NULL); - - Status = PcdPpi->Set64Ex (Guid, TokenNumber, Value); - - ASSERT_EFI_ERROR (Status); + (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value); return Value; } @@ -764,36 +795,50 @@ LibPcdSetEx64 ( /** - Sets a buffer for the token specified by TokenNumber and - Guid to the value specified by Value. Value is returned. + This function provides a means by which to set a value for a given PCD token. + + Sets a buffer for the token specified by TokenNumber to the value specified by + Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size + supported by TokenNumber and return NULL to indicate that the set operation + was not actually performed. + If Guid is NULL, then ASSERT(). - If Value is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The 8-bit value to set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to set. - @retval VOID * Return the value been set. + @return Return the pinter to the buffer been set. **/ VOID * EFIAPI LibPcdSetExPtr ( - IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, - IN UINTN SizeOfBuffer, - IN VOID *Buffer + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN OUT UINTN *SizeOfBuffer, + IN VOID *Buffer ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; + EFI_STATUS Status; + UINTN InputSizeOfBuffer; - PcdPpi = GetPcdPpiPtr (); + ASSERT (SizeOfBuffer != NULL); + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + ASSERT (Guid != NULL); - Status = PcdPpi->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer); - - ASSERT_EFI_ERROR (Status); + InputSizeOfBuffer = *SizeOfBuffer; + Status = (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer); + if (EFI_ERROR (Status) && (*SizeOfBuffer < InputSizeOfBuffer)) { + return NULL; + } return Buffer; } @@ -801,72 +846,402 @@ LibPcdSetExPtr ( /** + This function provides a means by which to set a value for a given PCD token. + Sets the Boolean value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. + If Guid is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that - designates which namespace to set a value from. - @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The Boolean value to set. - @retval Boolean Return the value been set. + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The Boolean value to set. + + @return Return the value that was set. **/ BOOLEAN EFIAPI LibPcdSetExBool ( IN CONST GUID *Guid, - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN BOOLEAN Value ) { - EFI_STATUS Status; - PCD_PPI * PcdPpi; + ASSERT (Guid != NULL); + + (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value); + + return Value; +} +#endif - PcdPpi = GetPcdPpiPtr (); +/** + This function provides a means by which to set a value for a given PCD token. + Sets the 8-bit value for the token specified by TokenNumber + to the value specified by Value. - Status = PcdPpi->SetBoolEx (Guid, TokenNumber, Value); + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 8-bit value to set. - ASSERT_EFI_ERROR (Status); + @return The status of the set operation. - return Value; +**/ +RETURN_STATUS +EFIAPI +LibPcdSet8S ( + IN UINTN TokenNumber, + IN UINT8 Value + ) +{ + return (GetPcdPpiPointer ())->Set8 (TokenNumber, Value); } +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 16-bit value for the token specified by TokenNumber + to the value specified by Value. + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 16-bit value to set. + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSet16S ( + IN UINTN TokenNumber, + IN UINT16 Value + ) +{ + return (GetPcdPpiPointer ())->Set16 (TokenNumber, Value); +} /** + This function provides a means by which to set a value for a given PCD token. + + Sets the 32-bit value for the token specified by TokenNumber + to the value specified by Value. + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 32-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSet32S ( + IN UINTN TokenNumber, + IN UINT32 Value + ) +{ + return (GetPcdPpiPointer ())->Set32 (TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 64-bit value for the token specified by TokenNumber + to the value specified by Value. + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 64-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSet64S ( + IN UINTN TokenNumber, + IN UINT64 Value + ) +{ + return (GetPcdPpiPointer ())->Set64 (TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets a buffer for the token specified by TokenNumber to the value specified + by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size + support by TokenNumber, then set SizeOfBuffer to the maximum size supported by + TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation + was not actually performed. + + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the + maximum size supported by TokenName and EFI_INVALID_PARAMETER must be returned. + + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetPtrS ( + IN UINTN TokenNumber, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + return (GetPcdPpiPointer ())->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the boolean value for the token specified by TokenNumber + to the value specified by Value. + + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The boolean value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetBoolS ( + IN UINTN TokenNumber, + IN BOOLEAN Value + ) +{ + return (GetPcdPpiPointer ())->SetBool (TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 8-bit value for the token specified by TokenNumber + to the value specified by Value. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 8-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetEx8S ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN UINT8 Value + ) +{ + ASSERT (Guid != NULL); + + return (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 16-bit value for the token specified by TokenNumber + to the value specified by Value. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 16-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetEx16S ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN UINT16 Value + ) +{ + ASSERT (Guid != NULL); + + return (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 32-bit value for the token specified by TokenNumber + to the value specified by Value. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 32-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetEx32S ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN UINT32 Value + ) +{ + ASSERT (Guid != NULL); + + return (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the 64-bit value for the token specified by TokenNumber + to the value specified by Value. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The 64-bit value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetEx64S ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN UINT64 Value + ) +{ + ASSERT (Guid != NULL); + + return (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets a buffer for the token specified by TokenNumber to the value specified by + Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size + support by TokenNumber, then set SizeOfBuffer to the maximum size supported by + TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation + was not actually performed. + + If Guid is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetExPtrS ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN OUT UINTN *SizeOfBuffer, + IN VOID *Buffer + ) +{ + ASSERT (Guid != NULL); + + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + return (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer); +} + +/** + This function provides a means by which to set a value for a given PCD token. + + Sets the boolean value for the token specified by TokenNumber + to the value specified by Value. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in] Value The boolean value to set. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPcdSetExBoolS ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + IN BOOLEAN Value + ) +{ + ASSERT (Guid != NULL); + + return (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value); +} + +/** + Set up a notification function that is called when a specified token is set. + When the token specified by TokenNumber and Guid is set, then notification function specified by NotificationFunction is called. - If Guid is NULL, then the default token space is used. + If Guid is NULL, then the default token space is used. If NotificationFunction is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates which - namespace to set a value from. If NULL, then the default - token space is used. - @param[in] TokenNumber The PCD token number to monitor. - @param[in] NotificationFunction The function to call when the token - specified by Guid and TokenNumber is set. - - @retval VOID + @param[in] Guid The pointer to a 128-bit unique value that + designates which namespace to set a value from. + If NULL, then the default token space is used. + @param[in] TokenNumber The PCD token number to monitor. + @param[in] NotificationFunction The function to call when the token + specified by Guid and TokenNumber is set. **/ VOID EFIAPI LibPcdCallbackOnSet ( IN CONST GUID *Guid, OPTIONAL - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN PCD_CALLBACK NotificationFunction ) { EFI_STATUS Status; - PCD_PPI * PcdPpi; - - PcdPpi = GetPcdPpiPtr (); + ASSERT (NotificationFunction != NULL); - Status = PcdPpi->CallbackOnSet (TokenNumber, Guid, NotificationFunction); + Status = (GetPiPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction); ASSERT_EFI_ERROR (Status); @@ -877,30 +1252,30 @@ LibPcdCallbackOnSet ( /** Disable a notification function that was established with LibPcdCallbackonSet(). + + Disable a notification function that was previously established with LibPcdCallbackOnSet(). If NotificationFunction is NULL, then ASSERT(). - - @param[in] Guid Specify the GUID token space. - @param[in] TokenNumber Specify the token number. + If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, + and NotificationFunction, then ASSERT(). + + @param[in] Guid Specify the GUID token space. + @param[in] TokenNumber Specify the token number. @param[in] NotificationFunction The callback function to be unregistered. - @retval VOID - **/ VOID EFIAPI LibPcdCancelCallback ( IN CONST GUID *Guid, OPTIONAL - IN PCD_TOKEN_NUMBER TokenNumber, + IN UINTN TokenNumber, IN PCD_CALLBACK NotificationFunction ) { EFI_STATUS Status; - PCD_PPI * PcdPpi; - PcdPpi = GetPcdPpiPtr (); + ASSERT (NotificationFunction != NULL); - - Status = PcdPpi->CancelCallback (TokenNumber, Guid, NotificationFunction); + Status = (GetPiPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction); ASSERT_EFI_ERROR (Status); @@ -910,37 +1285,341 @@ LibPcdCancelCallback ( /** + Retrieves the next token in a token space. + Retrieves the next PCD token number from the token space specified by Guid. If Guid is NULL, then the default token space is used. If TokenNumber is 0, then the first token number is returned. Otherwise, the token number that follows TokenNumber in the token space is returned. If TokenNumber is the last - token number in the token space, then 0 is returned. If TokenNumber is not 0 and - is not in the token space specified by Guid, then ASSERT(). + token number in the token space, then 0 is returned. + + If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT(). - @param[in] Pointer to a 128-bit unique value that designates which namespace - to set a value from. If NULL, then the default token space is used. - @param[in] The previous PCD token number. If 0, then retrieves the first PCD - token number. + @param[in] Guid The pointer to a 128-bit unique value that designates which namespace + to set a value from. If NULL, then the default token space is used. + @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD + token number. - @retval PCD_TOKEN_NUMBER The next valid token number. + @return The next valid token number. **/ -PCD_TOKEN_NUMBER +UINTN EFIAPI LibPcdGetNextToken ( - IN CONST GUID *Guid, OPTIONAL - IN PCD_TOKEN_NUMBER TokenNumber + IN CONST GUID *Guid, OPTIONAL + IN UINTN TokenNumber + ) +{ + EFI_STATUS Status; + + Status = (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber); + ASSERT (!EFI_ERROR (Status) || TokenNumber == 0); + + return TokenNumber; +} + + +/** + Used to retrieve the list of available PCD token space GUIDs. + + Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces + in the platform. + If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned. + If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned. + + @param TokenSpaceGuid The pointer to the a PCD token space GUID + + @return The next valid token namespace. + +**/ +GUID * +EFIAPI +LibPcdGetNextTokenSpace ( + IN CONST GUID *TokenSpaceGuid + ) +{ + (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid); + + return (GUID *) TokenSpaceGuid; +} + + + +/** + Sets a value of a patchable PCD entry that is type pointer. + + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[out] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + + @return Return the pointer to the buffer been set. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtr ( + OUT VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return NULL; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + + return (VOID *) Buffer; +} + +/** + Sets a value of a patchable PCD entry that is type pointer. + + Sets the PCD entry specified by PatchVariable to the value specified + by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize, + then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER + to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[out] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPatchPcdSetPtrS ( + OUT VOID *PatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return RETURN_INVALID_PARAMETER; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + + return RETURN_SUCCESS; +} + + +/** + Sets a value and size of a patchable PCD entry that is type pointer. + + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + MaximumDatumSize and NULL must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfPatchVariable is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[out] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + + @return Return the pointer to the buffer been set. + +**/ +VOID * +EFIAPI +LibPatchPcdSetPtrAndSize ( + OUT VOID *PatchVariable, + OUT UINTN *SizeOfPatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfPatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return NULL; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + *SizeOfPatchVariable = *SizeOfBuffer; + + return (VOID *) Buffer; +} + +/** + Sets a value and size of a patchable PCD entry that is type pointer. + + Sets the PCD entry specified by PatchVariable to the value specified + by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize, + then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER + to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned. + + If PatchVariable is NULL, then ASSERT(). + If SizeOfPatchVariable is NULL, then ASSERT(). + If SizeOfBuffer is NULL, then ASSERT(). + If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). + + @param[out] PatchVariable A pointer to the global variable in a module that is + the target of the set operation. + @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable. + @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. + @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to used to set the target variable. + + @return The status of the set operation. + +**/ +RETURN_STATUS +EFIAPI +LibPatchPcdSetPtrAndSizeS ( + OUT VOID *PatchVariable, + OUT UINTN *SizeOfPatchVariable, + IN UINTN MaximumDatumSize, + IN OUT UINTN *SizeOfBuffer, + IN CONST VOID *Buffer + ) +{ + ASSERT (PatchVariable != NULL); + ASSERT (SizeOfPatchVariable != NULL); + ASSERT (SizeOfBuffer != NULL); + + if (*SizeOfBuffer > 0) { + ASSERT (Buffer != NULL); + } + + if ((*SizeOfBuffer > MaximumDatumSize) || + (*SizeOfBuffer == MAX_ADDRESS)) { + *SizeOfBuffer = MaximumDatumSize; + return RETURN_INVALID_PARAMETER; + } + + CopyMem (PatchVariable, Buffer, *SizeOfBuffer); + *SizeOfPatchVariable = *SizeOfBuffer; + + return RETURN_SUCCESS; +} + +/** + Retrieve additional information associated with a PCD token. + + This includes information such as the type of value the TokenNumber is associated with as well as possible + human readable name that is associated with the token. + + If TokenNumber is not in the default token space specified, then ASSERT(). + + @param[in] TokenNumber The PCD token number. + @param[out] PcdInfo The returned information associated with the requested TokenNumber. + The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName. +**/ +VOID +EFIAPI +LibPcdGetInfo ( + IN UINTN TokenNumber, + OUT PCD_INFO *PcdInfo ) { EFI_STATUS Status; - PCD_PPI * PcdPpi; - PcdPpi = GetPcdPpiPtr (); + Status = GetPcdInfoPpiPointer()->GetInfo (TokenNumber, (EFI_PCD_INFO *) PcdInfo); + ASSERT_EFI_ERROR (Status); +} + +/** + Retrieve additional information associated with a PCD token. + This includes information such as the type of value the TokenNumber is associated with as well as possible + human readable name that is associated with the token. - Status = PcdPpi->GetNextToken (Guid, &TokenNumber); + If TokenNumber is not in the token space specified by Guid, then ASSERT(). + + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] TokenNumber The PCD token number. + @param[out] PcdInfo The returned information associated with the requested TokenNumber. + The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName. +**/ +VOID +EFIAPI +LibPcdGetInfoEx ( + IN CONST GUID *Guid, + IN UINTN TokenNumber, + OUT PCD_INFO *PcdInfo + ) +{ + EFI_STATUS Status; + Status = GetPiPcdInfoPpiPointer()->GetInfo (Guid, TokenNumber, (EFI_PCD_INFO *) PcdInfo); ASSERT_EFI_ERROR (Status); +} - return TokenNumber; +/** + Retrieve the currently set SKU Id. + + @return The currently set SKU Id. If the platform has not set at a SKU Id, then the + default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU + Id is returned. +**/ +UINTN +EFIAPI +LibPcdGetSku ( + VOID + ) +{ + return GetPiPcdInfoPpiPointer()->GetSku (); }