#include <PiPei.h>
#include <Ppi/Pcd.h>
#include <Ppi/PiPcd.h>
#include <Ppi/PcdInfo.h>
#include <Ppi/PiPcdInfo.h>
#include <Library/PeiServicesLib.h>
#include <Library/PcdLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>

Functions
PCD_PPI *	GetPcdPpiPointer (VOID)

EFI_PEI_PCD_PPI *	GetPiPcdPpiPointer (VOID)

GET_PCD_INFO_PPI *	GetPcdInfoPpiPointer (VOID)

EFI_GET_PCD_INFO_PPI *	GetPiPcdInfoPpiPointer (VOID)

UINTN EFIAPI	LibPcdSetSku (IN UINTN SkuId)

UINT8 EFIAPI	LibPcdGet8 (IN UINTN TokenNumber)

UINT16 EFIAPI	LibPcdGet16 (IN UINTN TokenNumber)

UINT32 EFIAPI	LibPcdGet32 (IN UINTN TokenNumber)

UINT64 EFIAPI	LibPcdGet64 (IN UINTN TokenNumber)

VOID *EFIAPI	LibPcdGetPtr (IN UINTN TokenNumber)

BOOLEAN EFIAPI	LibPcdGetBool (IN UINTN TokenNumber)

UINTN EFIAPI	LibPcdGetSize (IN UINTN TokenNumber)

UINT8 EFIAPI	LibPcdGetEx8 (IN CONST GUID *Guid, IN UINTN TokenNumber)

UINT16 EFIAPI	LibPcdGetEx16 (IN CONST GUID *Guid, IN UINTN TokenNumber)

UINT32 EFIAPI	LibPcdGetEx32 (IN CONST GUID *Guid, IN UINTN TokenNumber)

UINT64 EFIAPI	LibPcdGetEx64 (IN CONST GUID *Guid, IN UINTN TokenNumber)

VOID *EFIAPI	LibPcdGetExPtr (IN CONST GUID *Guid, IN UINTN TokenNumber)

BOOLEAN EFIAPI	LibPcdGetExBool (IN CONST GUID *Guid, IN UINTN TokenNumber)

UINTN EFIAPI	LibPcdGetExSize (IN CONST GUID *Guid, IN UINTN TokenNumber)

RETURN_STATUS EFIAPI	LibPcdSet8S (IN UINTN TokenNumber, IN UINT8 Value)

RETURN_STATUS EFIAPI	LibPcdSet16S (IN UINTN TokenNumber, IN UINT16 Value)

RETURN_STATUS EFIAPI	LibPcdSet32S (IN UINTN TokenNumber, IN UINT32 Value)

RETURN_STATUS EFIAPI	LibPcdSet64S (IN UINTN TokenNumber, IN UINT64 Value)

RETURN_STATUS EFIAPI	LibPcdSetPtrS (IN UINTN TokenNumber, IN OUT UINTN SizeOfBuffer, IN CONST VOID Buffer)

RETURN_STATUS EFIAPI	LibPcdSetBoolS (IN UINTN TokenNumber, IN BOOLEAN Value)

RETURN_STATUS EFIAPI	LibPcdSetEx8S (IN CONST GUID *Guid, IN UINTN TokenNumber, IN UINT8 Value)

RETURN_STATUS EFIAPI	LibPcdSetEx16S (IN CONST GUID *Guid, IN UINTN TokenNumber, IN UINT16 Value)

RETURN_STATUS EFIAPI	LibPcdSetEx32S (IN CONST GUID *Guid, IN UINTN TokenNumber, IN UINT32 Value)

RETURN_STATUS EFIAPI	LibPcdSetEx64S (IN CONST GUID *Guid, IN UINTN TokenNumber, IN UINT64 Value)

RETURN_STATUS EFIAPI	LibPcdSetExPtrS (IN CONST GUID Guid, IN UINTN TokenNumber, IN OUT UINTN SizeOfBuffer, IN VOID *Buffer)

RETURN_STATUS EFIAPI	LibPcdSetExBoolS (IN CONST GUID *Guid, IN UINTN TokenNumber, IN BOOLEAN Value)

VOID EFIAPI	LibPcdCallbackOnSet (IN CONST GUID *Guid OPTIONAL, IN UINTN TokenNumber, IN PCD_CALLBACK NotificationFunction)

VOID EFIAPI	LibPcdCancelCallback (IN CONST GUID *Guid OPTIONAL, IN UINTN TokenNumber, IN PCD_CALLBACK NotificationFunction)

UINTN EFIAPI	LibPcdGetNextToken (IN CONST GUID *Guid OPTIONAL, IN UINTN TokenNumber)

GUID *EFIAPI	LibPcdGetNextTokenSpace (IN CONST GUID *TokenSpaceGuid)

VOID *EFIAPI	LibPatchPcdSetPtr (OUT VOID PatchVariable, IN UINTN MaximumDatumSize, IN OUT UINTN SizeOfBuffer, IN CONST VOID *Buffer)

RETURN_STATUS EFIAPI	LibPatchPcdSetPtrS (OUT VOID PatchVariable, IN UINTN MaximumDatumSize, IN OUT UINTN SizeOfBuffer, IN CONST VOID *Buffer)

VOID *EFIAPI	LibPatchPcdSetPtrAndSize (OUT VOID PatchVariable, OUT UINTN SizeOfPatchVariable, IN UINTN MaximumDatumSize, IN OUT UINTN SizeOfBuffer, IN CONST VOID Buffer)

RETURN_STATUS EFIAPI	LibPatchPcdSetPtrAndSizeS (OUT VOID PatchVariable, OUT UINTN SizeOfPatchVariable, IN UINTN MaximumDatumSize, IN OUT UINTN SizeOfBuffer, IN CONST VOID Buffer)

VOID EFIAPI	LibPcdGetInfo (IN UINTN TokenNumber, OUT PCD_INFO *PcdInfo)

VOID EFIAPI	LibPcdGetInfoEx (IN CONST GUID Guid, IN UINTN TokenNumber, OUT PCD_INFO PcdInfo)

UINTN EFIAPI	LibPcdGetSku (VOID)

Detailed Description

Implementation of PcdLib class library for PEI phase.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PeiPcdLib.c.

Function Documentation

◆ GetPcdInfoPpiPointer()

GET_PCD_INFO_PPI * GetPcdInfoPpiPointer ( VOID )

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().

Return values

GET_PCD_INFO_PPI * The pointer to the GET_PCD_INFO_PPI.

Definition at line 78 of file PeiPcdLib.c.

◆ GetPcdPpiPointer()

PCD_PPI * GetPcdPpiPointer ( VOID )

Retrieve the PCD_PPI pointer.

This function is to locate PCD_PPI PPI via PeiService. If fail to locate PCD_PPI, then ASSERT_EFI_ERROR().

Return values

PCD_PPI * The pointer to the PCD_PPI.

Definition at line 32 of file PeiPcdLib.c.

◆ GetPiPcdInfoPpiPointer()

EFI_GET_PCD_INFO_PPI * GetPiPcdInfoPpiPointer ( VOID )

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().

Return values

EFI_GET_PCD_INFO_PPI * The pointer to the EFI_GET_PCD_INFO_PPI.

Definition at line 101 of file PeiPcdLib.c.

◆ GetPiPcdPpiPointer()

EFI_PEI_PCD_PPI * GetPiPcdPpiPointer ( VOID )

Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3.

This function is to locate EFI_PEI_PCD_PPI PPI via PeiService. If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR().

Return values

EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI.

Definition at line 55 of file PeiPcdLib.c.

◆ LibPatchPcdSetPtr()

VOID *EFIAPI LibPatchPcdSetPtr	(	OUT VOID *	PatchVariable,
		IN UINTN	MaximumDatumSize,
		IN OUT UINTN *	SizeOfBuffer,
		IN CONST 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. 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().

Parameters

[out]	PatchVariable	A pointer to the global variable in a module that is the target of the set operation.
[in]	MaximumDatumSize	The maximum size allowed for the PCD entry specified by PatchVariable.
[in,out]	SizeOfBuffer	A pointer to the size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to used to set the target variable.

Returns: Return the pointer to the buffer been set.

Definition at line 929 of file PeiPcdLib.c.

◆ LibPatchPcdSetPtrAndSize()

VOID *EFIAPI LibPatchPcdSetPtrAndSize	(	OUT VOID *	PatchVariable,
		OUT UINTN *	SizeOfPatchVariable,
		IN UINTN	MaximumDatumSize,
		IN OUT UINTN *	SizeOfBuffer,
		IN CONST 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. 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().

Parameters

[out]	PatchVariable	A pointer to the global variable in a module that is the target of the set operation.
[out]	SizeOfPatchVariable	A pointer to the size, in bytes, of PatchVariable.
[in]	MaximumDatumSize	The maximum size allowed for the PCD entry specified by PatchVariable.
[in,out]	SizeOfBuffer	A pointer to the size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to used to set the target variable.

Returns: Return the pointer to the buffer been set.

Definition at line 1033 of file PeiPcdLib.c.

◆ LibPatchPcdSetPtrAndSizeS()

RETURN_STATUS EFIAPI LibPatchPcdSetPtrAndSizeS	(	OUT VOID *	PatchVariable,
		OUT UINTN *	SizeOfPatchVariable,
		IN UINTN	MaximumDatumSize,
		IN OUT UINTN *	SizeOfBuffer,
		IN CONST 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().

Parameters

[out]	PatchVariable	A pointer to the global variable in a module that is the target of the set operation.
[out]	SizeOfPatchVariable	A pointer to the size, in bytes, of PatchVariable.
[in]	MaximumDatumSize	The maximum size allowed for the PCD entry specified by PatchVariable.
[in,out]	SizeOfBuffer	A pointer to the size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to used to set the target variable.

Returns: The status of the set operation.

Definition at line 1089 of file PeiPcdLib.c.

◆ LibPatchPcdSetPtrS()

RETURN_STATUS EFIAPI LibPatchPcdSetPtrS	(	OUT VOID *	PatchVariable,
		IN UINTN	MaximumDatumSize,
		IN OUT UINTN *	SizeOfBuffer,
		IN CONST 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().

Parameters

[out]	PatchVariable	A pointer to the global variable in a module that is the target of the set operation.
[in]	MaximumDatumSize	The maximum size allowed for the PCD entry specified by PatchVariable.
[in,out]	SizeOfBuffer	A pointer to the size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to used to set the target variable.

Returns: The status of the set operation.

Definition at line 980 of file PeiPcdLib.c.

◆ LibPcdCallbackOnSet()

VOID EFIAPI LibPcdCallbackOnSet	(	IN CONST GUID *Guid	OPTIONAL,
		IN UINTN	TokenNumber,
		IN PCD_CALLBACK	NotificationFunction
	)

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 NotificationFunction is NULL, then ASSERT().

Parameters

[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.
[in]	TokenNumber	The PCD token number to monitor.
[in]	NotificationFunction	The function to call when the token specified by Guid and TokenNumber is set.

Definition at line 797 of file PeiPcdLib.c.

◆ LibPcdCancelCallback()

VOID EFIAPI LibPcdCancelCallback	(	IN CONST GUID *Guid	OPTIONAL,
		IN UINTN	TokenNumber,
		IN PCD_CALLBACK	NotificationFunction
	)

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(). If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, and NotificationFunction, then ASSERT().

Parameters

[in]	Guid	Specify the GUID token space.
[in]	TokenNumber	Specify the token number.
[in]	NotificationFunction	The callback function to be unregistered.

Definition at line 829 of file PeiPcdLib.c.

◆ LibPcdGet16()

UINT16 EFIAPI LibPcdGet16 ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the 16-bit value for the token specified by TokenNumber.

Definition at line 167 of file PeiPcdLib.c.

◆ LibPcdGet32()

UINT32 EFIAPI LibPcdGet32 ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the 32-bit value for the token specified by TokenNumber.

Definition at line 186 of file PeiPcdLib.c.

◆ LibPcdGet64()

UINT64 EFIAPI LibPcdGet64 ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the 64-bit value for the token specified by TokenNumber.

Definition at line 205 of file PeiPcdLib.c.

◆ LibPcdGet8()

UINT8 EFIAPI LibPcdGet8 ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the 8-bit value for the token specified by TokenNumber.

Definition at line 148 of file PeiPcdLib.c.

◆ LibPcdGetBool()

BOOLEAN EFIAPI LibPcdGetBool ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the Boolean value of the token specified by TokenNumber.

Definition at line 243 of file PeiPcdLib.c.

◆ LibPcdGetEx16()

UINT16 EFIAPI LibPcdGetEx16	(	IN CONST GUID *	Guid,
		IN UINTN	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the UINT16.

Definition at line 309 of file PeiPcdLib.c.

◆ LibPcdGetEx32()

UINT32 EFIAPI LibPcdGetEx32	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber
	)

Returns the 32-bit value for the token specified by TokenNumber and Guid. If Guid is NULL, then ASSERT().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the UINT32.

Definition at line 332 of file PeiPcdLib.c.

◆ LibPcdGetEx64()

UINT64 EFIAPI LibPcdGetEx64	(	IN CONST GUID *	Guid,
		IN UINTN	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the UINT64.

Definition at line 358 of file PeiPcdLib.c.

◆ LibPcdGetEx8()

UINT8 EFIAPI LibPcdGetEx8	(	IN CONST GUID *	Guid,
		IN UINTN	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the UINT8.

Definition at line 283 of file PeiPcdLib.c.

◆ LibPcdGetExBool()

BOOLEAN EFIAPI LibPcdGetExBool	(	IN CONST GUID *	Guid,
		IN UINTN	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the BOOLEAN.

Definition at line 409 of file PeiPcdLib.c.

◆ LibPcdGetExPtr()

VOID *EFIAPI LibPcdGetExPtr	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber
	)

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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the VOID* pointer.

Definition at line 383 of file PeiPcdLib.c.

◆ LibPcdGetExSize()

UINTN EFIAPI LibPcdGetExSize	(	IN CONST GUID *	Guid,
		IN UINTN	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to retrieve a value from.
[in]	TokenNumber	The PCD token number to retrieve a current value for.

Returns: Return the size.

Definition at line 434 of file PeiPcdLib.c.

◆ LibPcdGetInfo()

VOID EFIAPI LibPcdGetInfo	(	IN UINTN	TokenNumber,
		OUT PCD_INFO *	PcdInfo
	)

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().

Parameters

[in]	TokenNumber	The PCD token number.
[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.

Definition at line 1132 of file PeiPcdLib.c.

◆ LibPcdGetInfoEx()

VOID EFIAPI LibPcdGetInfoEx	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		OUT PCD_INFO *	PcdInfo
	)

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 token space specified by Guid, then ASSERT().

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	TokenNumber	The PCD token number.
[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.

Definition at line 1158 of file PeiPcdLib.c.

◆ LibPcdGetNextToken()

UINTN EFIAPI LibPcdGetNextToken	(	IN CONST GUID *Guid	OPTIONAL,
		IN UINTN	TokenNumber
	)

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().

Parameters

[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.
[in]	TokenNumber	The previous PCD token number. If 0, then retrieves the first PCD token number.

Returns: The next valid token number.

Definition at line 867 of file PeiPcdLib.c.

◆ LibPcdGetNextTokenSpace()

GUID *EFIAPI LibPcdGetNextTokenSpace ( IN CONST GUID * TokenSpaceGuid )

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.

Parameters

TokenSpaceGuid The pointer to the a PCD token space GUID

Returns: The next valid token namespace.

Definition at line 895 of file PeiPcdLib.c.

◆ LibPcdGetPtr()

VOID *EFIAPI LibPcdGetPtr ( IN UINTN 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.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the pointer to the token specified by TokenNumber.

Definition at line 224 of file PeiPcdLib.c.

◆ LibPcdGetSize()

UINTN EFIAPI LibPcdGetSize ( IN UINTN TokenNumber )

This function provides a means by which to retrieve the size of a given PCD token.

Parameters

[in] TokenNumber The PCD token number to retrieve a current value for.

Returns: Returns the size of the token specified by TokenNumber.

Definition at line 260 of file PeiPcdLib.c.

◆ LibPcdGetSku()

UINTN EFIAPI LibPcdGetSku ( VOID )

Retrieve the currently set SKU Id.

Returns: 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.

Definition at line 1179 of file PeiPcdLib.c.

◆ LibPcdSet16S()

RETURN_STATUS EFIAPI LibPcdSet16S	(	IN UINTN	TokenNumber,
		IN UINT16	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.

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 16-bit value to set.

Returns: The status of the set operation.

Definition at line 479 of file PeiPcdLib.c.

◆ LibPcdSet32S()

RETURN_STATUS EFIAPI LibPcdSet32S	(	IN UINTN	TokenNumber,
		IN UINT32	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.

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 32-bit value to set.

Returns: The status of the set operation.

Definition at line 501 of file PeiPcdLib.c.

◆ LibPcdSet64S()

RETURN_STATUS EFIAPI LibPcdSet64S	(	IN UINTN	TokenNumber,
		IN UINT64	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.

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 64-bit value to set.

Returns: The status of the set operation.

Definition at line 523 of file PeiPcdLib.c.

◆ LibPcdSet8S()

RETURN_STATUS EFIAPI LibPcdSet8S	(	IN UINTN	TokenNumber,
		IN UINT8	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.

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 8-bit value to set.

Returns: The status of the set operation.

Definition at line 457 of file PeiPcdLib.c.

◆ LibPcdSetBoolS()

RETURN_STATUS EFIAPI LibPcdSetBoolS	(	IN UINTN	TokenNumber,
		IN BOOLEAN	Value
	)

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.

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The boolean value to set.

Returns: The status of the set operation.

Definition at line 584 of file PeiPcdLib.c.

◆ LibPcdSetEx16S()

RETURN_STATUS EFIAPI LibPcdSetEx16S	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN UINT16	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 16-bit value to set.

Returns: The status of the set operation.

Definition at line 639 of file PeiPcdLib.c.

◆ LibPcdSetEx32S()

RETURN_STATUS EFIAPI LibPcdSetEx32S	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN UINT32	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 32-bit value to set.

Returns: The status of the set operation.

Definition at line 668 of file PeiPcdLib.c.

◆ LibPcdSetEx64S()

RETURN_STATUS EFIAPI LibPcdSetEx64S	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN UINT64	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 64-bit value to set.

Returns: The status of the set operation.

Definition at line 697 of file PeiPcdLib.c.

◆ LibPcdSetEx8S()

RETURN_STATUS EFIAPI LibPcdSetEx8S	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN UINT8	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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The 8-bit value to set.

Returns: The status of the set operation.

Definition at line 610 of file PeiPcdLib.c.

◆ LibPcdSetExBoolS()

RETURN_STATUS EFIAPI LibPcdSetExBoolS	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN BOOLEAN	Value
	)

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().

Parameters

[in]	Guid	The pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in]	Value	The boolean value to set.

Returns: The status of the set operation.

Definition at line 768 of file PeiPcdLib.c.

◆ LibPcdSetExPtrS()

RETURN_STATUS EFIAPI LibPcdSetExPtrS	(	IN CONST GUID *	Guid,
		IN UINTN	TokenNumber,
		IN OUT UINTN *	SizeOfBuffer,
		IN VOID *	Buffer
	)

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().

Parameters

[in]	Guid	Pointer to a 128-bit unique value that designates which namespace to set a value from.
[in]	TokenNumber	The PCD token number to set a current value for.
[in,out]	SizeOfBuffer	The size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to set.

Returns: The status of the set operation.

Definition at line 732 of file PeiPcdLib.c.

◆ LibPcdSetPtrS()

RETURN_STATUS EFIAPI LibPcdSetPtrS	(	IN UINTN	TokenNumber,
		IN OUT UINTN *	SizeOfBuffer,
		IN CONST VOID *	Buffer
	)

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().

Parameters

[in]	TokenNumber	The PCD token number to set a current value for.
[in,out]	SizeOfBuffer	The size, in bytes, of Buffer.
[in]	Buffer	A pointer to the buffer to set.

Returns: The status of the set operation.

Definition at line 555 of file PeiPcdLib.c.

◆ LibPcdSetSku()

UINTN EFIAPI LibPcdSetSku ( IN UINTN SkuId )

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.

Parameters

SkuId The SKU value that will be used when the PCD service retrieves and sets values associated with a PCD token.

Returns: Return the SKU ID that just be set.

Definition at line 127 of file PeiPcdLib.c.

Functions

Detailed Description

Function Documentation

◆ GetPcdInfoPpiPointer()

◆ GetPcdPpiPointer()

◆ GetPiPcdInfoPpiPointer()

◆ GetPiPcdPpiPointer()

◆ LibPatchPcdSetPtr()

◆ LibPatchPcdSetPtrAndSize()

◆ LibPatchPcdSetPtrAndSizeS()

◆ LibPatchPcdSetPtrS()

◆ LibPcdCallbackOnSet()

◆ LibPcdCancelCallback()

◆ LibPcdGet16()

◆ LibPcdGet32()

◆ LibPcdGet64()

◆ LibPcdGet8()

◆ LibPcdGetBool()

◆ LibPcdGetEx16()

◆ LibPcdGetEx32()

◆ LibPcdGetEx64()

◆ LibPcdGetEx8()

◆ LibPcdGetExBool()

◆ LibPcdGetExPtr()

◆ LibPcdGetExSize()

◆ LibPcdGetInfo()

◆ LibPcdGetInfoEx()

◆ LibPcdGetNextToken()

◆ LibPcdGetNextTokenSpace()

◆ LibPcdGetPtr()

◆ LibPcdGetSize()

◆ LibPcdGetSku()

◆ LibPcdSet16S()

◆ LibPcdSet32S()

◆ LibPcdSet64S()

◆ LibPcdSet8S()

◆ LibPcdSetBoolS()

◆ LibPcdSetEx16S()

◆ LibPcdSetEx32S()

◆ LibPcdSetEx64S()

◆ LibPcdSetEx8S()

◆ LibPcdSetExBoolS()

◆ LibPcdSetExPtrS()

◆ LibPcdSetPtrS()

◆ LibPcdSetSku()