#include "Service.h"

Functions
EFI_STATUS EFIAPI	PcdDxeInit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS EFIAPI	DxeGetPcdInfoGetInfo (IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)

EFI_STATUS EFIAPI	DxeGetPcdInfoGetInfoEx (IN CONST EFI_GUID Guid, IN UINTN TokenNumber, OUT EFI_PCD_INFO PcdInfo)

UINTN EFIAPI	DxeGetPcdInfoGetSku (VOID)

VOID EFIAPI	DxePcdSetSku (IN UINTN SkuId)

UINT8 EFIAPI	DxePcdGet8 (IN UINTN TokenNumber)

UINT16 EFIAPI	DxePcdGet16 (IN UINTN TokenNumber)

UINT32 EFIAPI	DxePcdGet32 (IN UINTN TokenNumber)

UINT64 EFIAPI	DxePcdGet64 (IN UINTN TokenNumber)

VOID *EFIAPI	DxePcdGetPtr (IN UINTN TokenNumber)

BOOLEAN EFIAPI	DxePcdGetBool (IN UINTN TokenNumber)

UINTN EFIAPI	DxePcdGetSize (IN UINTN TokenNumber)

UINT8 EFIAPI	DxePcdGet8Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

UINT16 EFIAPI	DxePcdGet16Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

UINT32 EFIAPI	DxePcdGet32Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

UINT64 EFIAPI	DxePcdGet64Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

VOID *EFIAPI	DxePcdGetPtrEx (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

BOOLEAN EFIAPI	DxePcdGetBoolEx (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

UINTN EFIAPI	DxePcdGetSizeEx (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)

EFI_STATUS EFIAPI	DxePcdSet8 (IN UINTN TokenNumber, IN UINT8 Value)

EFI_STATUS EFIAPI	DxePcdSet16 (IN UINTN TokenNumber, IN UINT16 Value)

EFI_STATUS EFIAPI	DxePcdSet32 (IN UINTN TokenNumber, IN UINT32 Value)

EFI_STATUS EFIAPI	DxePcdSet64 (IN UINTN TokenNumber, IN UINT64 Value)

EFI_STATUS EFIAPI	DxePcdSetPtr (IN UINTN TokenNumber, IN OUT UINTN SizeOfBuffer, IN VOID Buffer)

EFI_STATUS EFIAPI	DxePcdSetBool (IN UINTN TokenNumber, IN BOOLEAN Value)

EFI_STATUS EFIAPI	DxePcdSet8Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN UINT8 Value)

EFI_STATUS EFIAPI	DxePcdSet16Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN UINT16 Value)

EFI_STATUS EFIAPI	DxePcdSet32Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN UINT32 Value)

EFI_STATUS EFIAPI	DxePcdSet64Ex (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN UINT64 Value)

EFI_STATUS EFIAPI	DxePcdSetPtrEx (IN CONST EFI_GUID Guid, IN UINTN ExTokenNumber, IN OUT UINTN SizeOfBuffer, IN VOID *Buffer)

EFI_STATUS EFIAPI	DxePcdSetBoolEx (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN BOOLEAN Value)

EFI_STATUS EFIAPI	DxeRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN TokenNumber, IN PCD_PROTOCOL_CALLBACK CallBackFunction)

EFI_STATUS EFIAPI	DxeUnRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN TokenNumber, IN PCD_PROTOCOL_CALLBACK CallBackFunction)

EFI_STATUS EFIAPI	DxePcdGetNextToken (IN CONST EFI_GUID Guid OPTIONAL, IN OUT UINTN TokenNumber)

EFI_GUID **	GetDistinctTokenSpace (IN OUT UINTN ExMapTableSize, IN DYNAMICEX_MAPPING ExMapTable, IN EFI_GUID *GuidTable)

EFI_STATUS EFIAPI	DxePcdGetNextTokenSpace (IN OUT CONST EFI_GUID **Guid)

Variables
EFI_LOCK	mPcdDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY)

PCD_PROTOCOL	mPcdInstance

EFI_PCD_PROTOCOL	mEfiPcdInstance

GET_PCD_INFO_PROTOCOL	mGetPcdInfoInstance

EFI_GET_PCD_INFO_PROTOCOL	mEfiGetPcdInfoInstance

EFI_HANDLE	mPcdHandle = NULL

UINTN	mVpdBaseAddress = 0

Detailed Description

PCD DXE driver manage all PCD entry initialized in PEI phase and DXE phase, and produce the implementation of native PCD protocol and EFI_PCD_PROTOCOL defined in PI 1.4a Vol3.

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

Definition in file Pcd.c.

Function Documentation

◆ DxeGetPcdInfoGetInfo()

EFI_STATUS EFIAPI DxeGetPcdInfoGetInfo	(	IN UINTN	TokenNumber,
		OUT EFI_PCD_INFO *	PcdInfo
	)

Retrieve additional information associated with a PCD token in the default token space.

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.

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.

Return values

EFI_SUCCESS	The PCD information was returned successfully.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 210 of file Pcd.c.

◆ DxeGetPcdInfoGetInfoEx()

EFI_STATUS EFIAPI DxeGetPcdInfoGetInfoEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	TokenNumber,
		OUT EFI_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.

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.

Return values

EFI_SUCCESS	The PCD information was returned successfully.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 234 of file Pcd.c.

◆ DxeGetPcdInfoGetSku()

UINTN EFIAPI DxeGetPcdInfoGetSku ( 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 252 of file Pcd.c.

◆ DxePcdGet16()

UINT16 EFIAPI DxePcdGet16 ( IN UINTN TokenNumber )

Retrieves an 16-bit value for a given PCD token.

Retrieves the current 16-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The UINT16 value.

Definition at line 365 of file Pcd.c.

◆ DxePcdGet16Ex()

UINT16 EFIAPI DxePcdGet16Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves an 16-bit value for a given PCD token.

Retrieves the 16-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size 16-bit value for the PCD token.

Definition at line 559 of file Pcd.c.

◆ DxePcdGet32()

UINT32 EFIAPI DxePcdGet32 ( IN UINTN TokenNumber )

Retrieves an 32-bit value for a given PCD token.

Retrieves the current 32-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The UINT32 value.

Definition at line 385 of file Pcd.c.

◆ DxePcdGet32Ex()

UINT32 EFIAPI DxePcdGet32Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves an 32-bit value for a given PCD token.

Retrieves the 32-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size 32-bit value for the PCD token.

Definition at line 583 of file Pcd.c.

◆ DxePcdGet64()

UINT64 EFIAPI DxePcdGet64 ( IN UINTN TokenNumber )

Retrieves an 64-bit value for a given PCD token.

Retrieves the current 64-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The UINT64 value.

Definition at line 405 of file Pcd.c.

◆ DxePcdGet64Ex()

UINT64 EFIAPI DxePcdGet64Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves an 64-bit value for a given PCD token.

Retrieves the 64-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size 64-bit value for the PCD token.

Definition at line 607 of file Pcd.c.

◆ DxePcdGet8()

UINT8 EFIAPI DxePcdGet8 ( IN UINTN TokenNumber )

Retrieves an 8-bit value for a given PCD token.

Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The UINT8 value.

Definition at line 345 of file Pcd.c.

◆ DxePcdGet8Ex()

UINT8 EFIAPI DxePcdGet8Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves an 8-bit value for a given PCD token.

Retrieves the 8-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size 8-bit value for the PCD token.

Definition at line 535 of file Pcd.c.

◆ DxePcdGetBool()

BOOLEAN EFIAPI DxePcdGetBool ( IN UINTN TokenNumber )

Retrieves a Boolean value for a given PCD token.

Retrieves the current boolean value for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The Boolean value.

Definition at line 449 of file Pcd.c.

◆ DxePcdGetBoolEx()

BOOLEAN EFIAPI DxePcdGetBoolEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves an Boolean value for a given PCD token.

Retrieves the Boolean value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size Boolean value for the PCD token.

Definition at line 655 of file Pcd.c.

◆ DxePcdGetNextToken()

EFI_STATUS EFIAPI DxePcdGetNextToken	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN OUT UINTN *	TokenNumber
	)

Retrieves the next valid token number in a given namespace.

This is useful since the PCD infrastructure contains a sparse list of token numbers, and one cannot a priori know what token numbers are valid in the database.

If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to retrieve the next token. This is an optional parameter that may be NULL. If this parameter is NULL, then a request is being made to retrieve tokens from the default token space.
[in,out]	TokenNumber	A pointer to the PCD token number to use to find the subsequent token number.

Return values

EFI_SUCCESS	The PCD service has retrieved the next valid token number.
EFI_NOT_FOUND	The PCD service could not find data from the requested token number.

Definition at line 1142 of file Pcd.c.

◆ DxePcdGetNextTokenSpace()

EFI_STATUS EFIAPI DxePcdGetNextTokenSpace ( IN OUT CONST EFI_GUID ** Guid )

Retrieves the next valid PCD token namespace for a given namespace.

Gets the next valid token namespace for a given namespace. This is useful to traverse the valid token namespaces on a platform.

Parameters

[in,out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid token namespace on the platform. If *Guid is NULL, then the GUID of the first token space of the current platform is returned. If the search cannot locate the next valid token namespace, an error is returned and the value of *Guid is undefined.

Return values

EFI_SUCCESS	The PCD service retrieved the value requested.
EFI_NOT_FOUND	The PCD service could not find the next valid token namespace.

Definition at line 1298 of file Pcd.c.

◆ DxePcdGetPtr()

VOID *EFIAPI DxePcdGetPtr ( IN UINTN TokenNumber )

Retrieves a pointer to a value for a given PCD token.

Retrieves the current pointer to the buffer for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The pointer to the buffer to be retrived.

Definition at line 427 of file Pcd.c.

◆ DxePcdGetPtrEx()

VOID *EFIAPI DxePcdGetPtrEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves a pointer to a value for a given PCD token.

Retrieves the current pointer to the buffer for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The pointer to the buffer to be retrived.

Definition at line 631 of file Pcd.c.

◆ DxePcdGetSize()

UINTN EFIAPI DxePcdGetSize ( IN UINTN TokenNumber )

Retrieves the size of the value for a given PCD token.

Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in] TokenNumber The PCD token number.

Returns: The size of the value for the PCD token.

Definition at line 469 of file Pcd.c.

◆ DxePcdGetSizeEx()

UINTN EFIAPI DxePcdGetSizeEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber
	)

Retrieves the size of the value for a given PCD token.

Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable.

Parameters

[in]	Guid	The token space for the token number.
[in]	ExTokenNumber	The PCD token number.

Returns: The size of the value for the PCD token.

Definition at line 677 of file Pcd.c.

◆ DxePcdSet16()

EFI_STATUS EFIAPI DxePcdSet16	(	IN UINTN	TokenNumber,
		IN UINT16	Value
	)

Sets an 16-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 731 of file Pcd.c.

◆ DxePcdSet16Ex()

EFI_STATUS EFIAPI DxePcdSet16Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN UINT16	Value
	)

Sets an 16-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 901 of file Pcd.c.

◆ DxePcdSet32()

EFI_STATUS EFIAPI DxePcdSet32	(	IN UINTN	TokenNumber,
		IN UINT32	Value
	)

Sets an 32-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 758 of file Pcd.c.

◆ DxePcdSet32Ex()

EFI_STATUS EFIAPI DxePcdSet32Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN UINT32	Value
	)

Sets an 32-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 937 of file Pcd.c.

◆ DxePcdSet64()

EFI_STATUS EFIAPI DxePcdSet64	(	IN UINTN	TokenNumber,
		IN UINT64	Value
	)

Sets an 64-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 785 of file Pcd.c.

◆ DxePcdSet64Ex()

EFI_STATUS EFIAPI DxePcdSet64Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN UINT64	Value
	)

Sets an 64-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 966 of file Pcd.c.

◆ DxePcdSet8()

EFI_STATUS EFIAPI DxePcdSet8	(	IN UINTN	TokenNumber,
		IN UINT8	Value
	)

Sets an 8-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 704 of file Pcd.c.

◆ DxePcdSet8Ex()

EFI_STATUS EFIAPI DxePcdSet8Ex	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN UINT8	Value
	)

Sets an 8-bit value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 872 of file Pcd.c.

◆ DxePcdSetBool()

EFI_STATUS EFIAPI DxePcdSetBool	(	IN UINTN	TokenNumber,
		IN BOOLEAN	Value
	)

Sets an Boolean value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 844 of file Pcd.c.

◆ DxePcdSetBoolEx()

EFI_STATUS EFIAPI DxePcdSetBoolEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN BOOLEAN	Value
	)

Sets an Boolean value for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in]	Value	The value to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 1029 of file Pcd.c.

◆ DxePcdSetPtr()

EFI_STATUS EFIAPI DxePcdSetPtr	(	IN UINTN	TokenNumber,
		IN OUT UINTN *	SizeOfBuffer,
		IN VOID *	Buffer
	)

Sets a value of a specified size for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	TokenNumber	The PCD token number.
[in,out]	SizeOfBuffer	A pointer to the length of the value being set for the PCD token. On input, if the SizeOfValue is greater than the maximum size supported for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber.
[in]	Buffer	The buffer to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 816 of file Pcd.c.

◆ DxePcdSetPtrEx()

EFI_STATUS EFIAPI DxePcdSetPtrEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN OUT UINTN *	SizeOfBuffer,
		IN VOID *	Buffer
	)

Sets a value of a specified size for a given PCD token.

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	ExTokenNumber	The PCD token number.
[in,out]	SizeOfBuffer	A pointer to the length of the value being set for the PCD token. On input, if the SizeOfValue is greater than the maximum size supported for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber.
[in]	Buffer	The buffer to set for the PCD token.

Return values

EFI_SUCCESS	Procedure returned successfully.
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 999 of file Pcd.c.

◆ DxePcdSetSku()

VOID EFIAPI DxePcdSetSku ( IN UINTN SkuId )

Sets the SKU value for subsequent calls to set or get PCD token values.

SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. SetSku() is normally called only once by the system.

For each item (token), the database can hold a single value that applies to all SKUs, or multiple values, where each value is associated with a specific SKU Id. Items with multiple, SKU-specific values are called SKU enabled.

The SKU Id of zero is reserved as a default. For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been set for that Id, the results are unpredictable.

Parameters

[in] SkuId The SKU value that will be used when the PCD service will retrieve and set values associated with a PCD token.

Definition at line 282 of file Pcd.c.

◆ DxeRegisterCallBackOnSet()

EFI_STATUS EFIAPI DxeRegisterCallBackOnSet	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN UINTN	TokenNumber,
		IN PCD_PROTOCOL_CALLBACK	CallBackFunction
	)

Specifies a function to be called anytime the value of a designated token is changed.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	TokenNumber	The PCD token number.
[in]	CallBackFunction	The function prototype called when the value associated with the CallBackToken is set.

Return values

EFI_SUCCESS	The PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUND	The PCD service could not find the referenced token number.

Definition at line 1052 of file Pcd.c.

◆ DxeUnRegisterCallBackOnSet()

EFI_STATUS EFIAPI DxeUnRegisterCallBackOnSet	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN UINTN	TokenNumber,
		IN PCD_PROTOCOL_CALLBACK	CallBackFunction
	)

Cancels a previously set callback function for a particular PCD token number.

Parameters

[in]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	TokenNumber	The PCD token number.
[in]	CallBackFunction	The function prototype called when the value associated with the CallBackToken is set.

Return values

EFI_SUCCESS	The PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUND	The PCD service could not find the referenced token number.

Definition at line 1090 of file Pcd.c.

◆ GetDistinctTokenSpace()

EFI_GUID ** GetDistinctTokenSpace	(	IN OUT UINTN *	ExMapTableSize,
		IN DYNAMICEX_MAPPING *	ExMapTable,
		IN EFI_GUID *	GuidTable
	)

Get all token space guid table which is different with given token space guid.

Parameters

ExMapTableSize	The size of ExMapTable in item
ExMapTable	Token space guid table that want to be scaned.
GuidTable	Guid table

Returns: all token space guid table which is different with given token space guid.

Definition at line 1234 of file Pcd.c.

◆ PcdDxeInit()

EFI_STATUS EFIAPI PcdDxeInit	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Main entry for PCD DXE driver.

This routine initialize the PCD database and install PCD_PROTOCOL.

Parameters

ImageHandle	Image handle for PCD DXE driver.
SystemTable	Pointer to SystemTable.

Returns: Status of gBS->InstallProtocolInterface()

Definition at line 121 of file Pcd.c.

Variable Documentation

◆ mEfiGetPcdInfoInstance

EFI_GET_PCD_INFO_PROTOCOL mEfiGetPcdInfoInstance

Initial value:

= {
  DxeGetPcdInfoGetInfoEx,
  DxeGetPcdInfoGetSku
}

Instance of EFI_GET_PCD_INFO_PROTOCOL which is defined in PI 1.2.1 Vol 3. This PPI instance only support dyanmicEx type PCD.

Definition at line 100 of file Pcd.c.

◆ mEfiPcdInstance

EFI_PCD_PROTOCOL mEfiPcdInstance

Initial value:

= {
  DxePcdSetSku,
  DxePcdGet8Ex,
  DxePcdGet16Ex,
  DxePcdGet32Ex,
  DxePcdGet64Ex,
  DxePcdGetPtrEx,
  DxePcdGetBoolEx,
  DxePcdGetSizeEx,
  DxePcdSet8Ex,
  DxePcdSet16Ex,
  DxePcdSet32Ex,
  DxePcdSet64Ex,
  DxePcdSetPtrEx,
  DxePcdSetBoolEx,
  (EFI_PCD_PROTOCOL_CALLBACK_ON_SET)DxeRegisterCallBackOnSet,
  (EFI_PCD_PROTOCOL_CANCEL_CALLBACK)DxeUnRegisterCallBackOnSet,
  DxePcdGetNextToken,
  DxePcdGetNextTokenSpace
}

EFI_PCD_PROTOCOL is defined in PI 1.2 Vol 3 which only support dynamicEx type PCD.

Definition at line 65 of file Pcd.c.

◆ mGetPcdInfoInstance

GET_PCD_INFO_PROTOCOL mGetPcdInfoInstance

Initial value:

= {
  DxeGetPcdInfoGetInfo,
  DxeGetPcdInfoGetInfoEx,
  DxeGetPcdInfoGetSku
}

Instance of GET_PCD_INFO_PROTOCOL protocol is EDKII native implementation. This protocol instance support dynamic and dynamicEx type PCDs.

Definition at line 90 of file Pcd.c.

◆ mPcdDatabaseLock

EFI_LOCK mPcdDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY)

PCD database lock.

Definition at line 16 of file Pcd.c.

◆ mPcdHandle

EFI_HANDLE mPcdHandle = NULL

Definition at line 105 of file Pcd.c.

◆ mPcdInstance

PCD_PROTOCOL mPcdInstance

PCD_PROTOCOL the EDKII native implementation which support dynamic type and dynamicEx type PCDs.

Definition at line 22 of file Pcd.c.

◆ mVpdBaseAddress

UINTN mVpdBaseAddress = 0

Definition at line 106 of file Pcd.c.

Functions

Variables

Detailed Description

Function Documentation

◆ DxeGetPcdInfoGetInfo()

◆ DxeGetPcdInfoGetInfoEx()

◆ DxeGetPcdInfoGetSku()

◆ DxePcdGet16()

◆ DxePcdGet16Ex()

◆ DxePcdGet32()

◆ DxePcdGet32Ex()

◆ DxePcdGet64()

◆ DxePcdGet64Ex()

◆ DxePcdGet8()

◆ DxePcdGet8Ex()

◆ DxePcdGetBool()

◆ DxePcdGetBoolEx()

◆ DxePcdGetNextToken()

◆ DxePcdGetNextTokenSpace()

◆ DxePcdGetPtr()

◆ DxePcdGetPtrEx()

◆ DxePcdGetSize()

◆ DxePcdGetSizeEx()

◆ DxePcdSet16()

◆ DxePcdSet16Ex()

◆ DxePcdSet32()

◆ DxePcdSet32Ex()

◆ DxePcdSet64()

◆ DxePcdSet64Ex()

◆ DxePcdSet8()

◆ DxePcdSet8Ex()

◆ DxePcdSetBool()

◆ DxePcdSetBoolEx()

◆ DxePcdSetPtr()

◆ DxePcdSetPtrEx()

◆ DxePcdSetSku()

◆ DxeRegisterCallBackOnSet()

◆ DxeUnRegisterCallBackOnSet()

◆ GetDistinctTokenSpace()

◆ PcdDxeInit()

Variable Documentation

◆ mEfiGetPcdInfoInstance

◆ mEfiPcdInstance

◆ mGetPcdInfoInstance

◆ mPcdDatabaseLock

◆ mPcdHandle

◆ mPcdInstance

◆ mVpdBaseAddress