#include "Service.h"

Functions
VOID EFIAPI	PcdSetNvStoreDefaultIdCallBack (IN CONST EFI_GUID CallBackGuid OPTIONAL, IN UINTN CallBackToken, IN OUT VOID TokenData, IN UINTN TokenDataSize)

EFI_STATUS EFIAPI	EndOfPeiSignalPpiNotifyCallback (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR NotifyDescriptor, IN VOID *Ppi)

EFI_STATUS EFIAPI	PcdPeimInit (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

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

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

UINTN EFIAPI	PeiGetPcdInfoGetSku (VOID)

VOID EFIAPI	PeiPcdSetSku (IN UINTN SkuId)

UINT8 EFIAPI	PeiPcdGet8 (IN UINTN TokenNumber)

UINT16 EFIAPI	PeiPcdGet16 (IN UINTN TokenNumber)

UINT32 EFIAPI	PeiPcdGet32 (IN UINTN TokenNumber)

UINT64 EFIAPI	PeiPcdGet64 (IN UINTN TokenNumber)

VOID *EFIAPI	PeiPcdGetPtr (IN UINTN TokenNumber)

BOOLEAN EFIAPI	PeiPcdGetBool (IN UINTN TokenNumber)

UINTN EFIAPI	PeiPcdGetSize (IN UINTN TokenNumber)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

EFI_STATUS EFIAPI	PeiPcdSetPtrEx (IN CONST EFI_GUID Guid, IN UINTN ExTokenNumber, IN OUT UINTN SizeOfBuffer, IN VOID *Value)

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

EFI_STATUS EFIAPI	PeiRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN ExTokenNumber, IN PCD_PPI_CALLBACK CallBackFunction)

EFI_STATUS EFIAPI	PcdUnRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN ExTokenNumber, IN PCD_PPI_CALLBACK CallBackFunction)

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

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

UINTN	GetPtrTypeSize (IN UINTN LocalTokenNumberTableIdx, OUT UINTN MaxSize, IN PEI_PCD_DATABASE Database)

BOOLEAN	SetPtrTypeSize (IN UINTN LocalTokenNumberTableIdx, IN OUT UINTN CurrentSize, IN PEI_PCD_DATABASE Database)

Variables
PCD_PPI	mPcdPpiInstance

EFI_PEI_PCD_PPI	mEfiPcdPpiInstance

GET_PCD_INFO_PPI	mGetPcdInfoInstance

EFI_GET_PCD_INFO_PPI	mEfiGetPcdInfoInstance

EFI_PEI_PPI_DESCRIPTOR	mPpiList []

EFI_PEI_PPI_DESCRIPTOR	mPpiList2 []

EFI_PEI_NOTIFY_DESCRIPTOR	mEndOfPeiSignalPpiNotifyList []

Detailed Description

All Pcd Ppi services are implemented here.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.
(C) Copyright 2016 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Pcd.c.

Function Documentation

◆ EndOfPeiSignalPpiNotifyCallback()

EFI_STATUS EFIAPI EndOfPeiSignalPpiNotifyCallback	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDescriptor,
		IN VOID *	Ppi
	)

Report Pei PCD database of all SKUs as Guid HOB so that DxePcd can access it.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
NotifyDescriptor	Address of the notification descriptor data structure.
Ppi	Address of the PPI that was installed.

Return values

EFI_SUCCESS Successfully update the Boot records.

Definition at line 242 of file Pcd.c.

◆ GetPtrTypeSize()

UINTN GetPtrTypeSize	(	IN UINTN	LocalTokenNumberTableIdx,
		OUT UINTN *	MaxSize,
		IN PEI_PCD_DATABASE *	Database
	)

Get PCD value's size for POINTER type PCD.

The POINTER type PCD's value will be stored into a buffer in specified size. The max size of this PCD's value is described in PCD's definition in DEC file.

Parameters

LocalTokenNumberTableIdx	Index of PCD token number in PCD token table
MaxSize	Maximum size of PCD's value
Database	Pcd database in PEI phase.

Returns: PCD value's size for POINTER type PCD.

Definition at line 1652 of file Pcd.c.

◆ PcdPeimInit()

EFI_STATUS EFIAPI PcdPeimInit	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Main entry for PCD PEIM driver.

This routine initialize the PCD database for PEI phase and install PCD_PPI/EFI_PEI_PCD_PPI.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Returns: Status of install PCD_PPI

Definition at line 342 of file Pcd.c.

◆ PcdSetNvStoreDefaultIdCallBack()

VOID EFIAPI PcdSetNvStoreDefaultIdCallBack	(	IN CONST EFI_GUID *CallBackGuid	OPTIONAL,
		IN UINTN	CallBackToken,
		IN OUT VOID *	TokenData,
		IN UINTN	TokenDataSize
	)

Callback on SET PcdSetNvStoreDefaultId

Once PcdSetNvStoreDefaultId is set, the default NV storage will be found from PcdNvStoreDefaultValueBuffer, and built into VariableHob.

Parameters

[in]	CallBackGuid	The PCD token GUID being set.
[in]	CallBackToken	The PCD token number being set.
[in,out]	TokenData	A pointer to the token data being set.
[in]	TokenDataSize	The size, in bytes, of the data being set.

Definition at line 140 of file Pcd.c.

◆ PcdUnRegisterCallBackOnSet()

EFI_STATUS EFIAPI PcdUnRegisterCallBackOnSet	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN UINTN	ExTokenNumber,
		IN PCD_PPI_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]	ExTokenNumber	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 1384 of file Pcd.c.

◆ PeiGetPcdInfoGetInfo()

EFI_STATUS EFIAPI PeiGetPcdInfoGetInfo	(	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 460 of file Pcd.c.

◆ PeiGetPcdInfoGetInfoEx()

EFI_STATUS EFIAPI PeiGetPcdInfoGetInfoEx	(	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 484 of file Pcd.c.

◆ PeiGetPcdInfoGetSku()

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

◆ PeiPcdGet16()

UINT16 EFIAPI PeiPcdGet16 ( 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 688 of file Pcd.c.

◆ PeiPcdGet16Ex()

UINT16 EFIAPI PeiPcdGet16Ex	(	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 867 of file Pcd.c.

◆ PeiPcdGet32()

UINT32 EFIAPI PeiPcdGet32 ( 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 708 of file Pcd.c.

◆ PeiPcdGet32Ex()

UINT32 EFIAPI PeiPcdGet32Ex	(	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 891 of file Pcd.c.

◆ PeiPcdGet64()

UINT64 EFIAPI PeiPcdGet64 ( 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 728 of file Pcd.c.

◆ PeiPcdGet64Ex()

UINT64 EFIAPI PeiPcdGet64Ex	(	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 915 of file Pcd.c.

◆ PeiPcdGet8()

UINT8 EFIAPI PeiPcdGet8 ( 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 668 of file Pcd.c.

◆ PeiPcdGet8Ex()

UINT8 EFIAPI PeiPcdGet8Ex	(	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 843 of file Pcd.c.

◆ PeiPcdGetBool()

BOOLEAN EFIAPI PeiPcdGetBool ( 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 772 of file Pcd.c.

◆ PeiPcdGetBoolEx()

BOOLEAN EFIAPI PeiPcdGetBoolEx	(	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 963 of file Pcd.c.

◆ PeiPcdGetNextToken()

EFI_STATUS EFIAPI PeiPcdGetNextToken	(	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 extract the value. 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 1428 of file Pcd.c.

◆ PeiPcdGetNextTokenSpace()

EFI_STATUS EFIAPI PeiPcdGetNextTokenSpace ( 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 1551 of file Pcd.c.

◆ PeiPcdGetPtr()

VOID *EFIAPI PeiPcdGetPtr ( 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 retrieved.

Definition at line 750 of file Pcd.c.

◆ PeiPcdGetPtrEx()

VOID *EFIAPI PeiPcdGetPtrEx	(	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 retrieved.

Definition at line 939 of file Pcd.c.

◆ PeiPcdGetSize()

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

◆ PeiPcdGetSizeEx()

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

◆ PeiPcdSet16()

EFI_STATUS EFIAPI PeiPcdSet16	(	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 1039 of file Pcd.c.

◆ PeiPcdSet16Ex()

EFI_STATUS EFIAPI PeiPcdSet16Ex	(	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 1209 of file Pcd.c.

◆ PeiPcdSet32()

EFI_STATUS EFIAPI PeiPcdSet32	(	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 1066 of file Pcd.c.

◆ PeiPcdSet32Ex()

EFI_STATUS EFIAPI PeiPcdSet32Ex	(	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 1238 of file Pcd.c.

◆ PeiPcdSet64()

EFI_STATUS EFIAPI PeiPcdSet64	(	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 1093 of file Pcd.c.

◆ PeiPcdSet64Ex()

EFI_STATUS EFIAPI PeiPcdSet64Ex	(	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 1267 of file Pcd.c.

◆ PeiPcdSet8()

EFI_STATUS EFIAPI PeiPcdSet8	(	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 1012 of file Pcd.c.

◆ PeiPcdSet8Ex()

EFI_STATUS EFIAPI PeiPcdSet8Ex	(	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 1180 of file Pcd.c.

◆ PeiPcdSetBool()

EFI_STATUS EFIAPI PeiPcdSetBool	(	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 1152 of file Pcd.c.

◆ PeiPcdSetBoolEx()

EFI_STATUS EFIAPI PeiPcdSetBoolEx	(	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 1330 of file Pcd.c.

◆ PeiPcdSetPtr()

EFI_STATUS EFIAPI PeiPcdSetPtr	(	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 1124 of file Pcd.c.

◆ PeiPcdSetPtrEx()

EFI_STATUS EFIAPI PeiPcdSetPtrEx	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	ExTokenNumber,
		IN OUT UINTN *	SizeOfBuffer,
		IN VOID *	Value
	)

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]	Value	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 1300 of file Pcd.c.

◆ PeiPcdSetSku()

VOID EFIAPI PeiPcdSetSku ( 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 532 of file Pcd.c.

◆ PeiRegisterCallBackOnSet()

EFI_STATUS EFIAPI PeiRegisterCallBackOnSet	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN UINTN	ExTokenNumber,
		IN PCD_PPI_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]	ExTokenNumber	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 1353 of file Pcd.c.

◆ SetPtrTypeSize()

BOOLEAN SetPtrTypeSize	(	IN UINTN	LocalTokenNumberTableIdx,
		IN OUT UINTN *	CurrentSize,
		IN PEI_PCD_DATABASE *	Database
	)

Set PCD value's size for POINTER type PCD.

The POINTER type PCD's value will be stored into a buffer in specified size. The max size of this PCD's value is described in PCD's definition in DEC file.

Parameters

LocalTokenNumberTableIdx	Index of PCD token number in PCD token table
CurrentSize	Maximum size of PCD's value
Database	Pcd database in PEI phase.

Return values

TRUE	Success to set PCD's value size, which is not exceed maximum size
FALSE	Fail to set PCD's value size, which maybe exceed maximum size

Definition at line 1708 of file Pcd.c.

Variable Documentation

◆ mEfiGetPcdInfoInstance

EFI_GET_PCD_INFO_PPI mEfiGetPcdInfoInstance

Initial value:

= {
  PeiGetPcdInfoGetInfoEx,
  PeiGetPcdInfoGetSku
}

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

Definition at line 95 of file Pcd.c.

◆ mEfiPcdPpiInstance

EFI_PEI_PCD_PPI mEfiPcdPpiInstance

Initial value:

= {
  PeiPcdSetSku,
 
  PeiPcdGet8Ex,
  PeiPcdGet16Ex,
  PeiPcdGet32Ex,
  PeiPcdGet64Ex,
  PeiPcdGetPtrEx,
  PeiPcdGetBoolEx,
  PeiPcdGetSizeEx,
  PeiPcdSet8Ex,
  PeiPcdSet16Ex,
  PeiPcdSet32Ex,
  PeiPcdSet64Ex,
  PeiPcdSetPtrEx,
  PeiPcdSetBoolEx,
  (EFI_PEI_PCD_PPI_CALLBACK_ON_SET)PeiRegisterCallBackOnSet,
  (EFI_PEI_PCD_PPI_CANCEL_CALLBACK)PcdUnRegisterCallBackOnSet,
  PeiPcdGetNextToken,
  PeiPcdGetNextTokenSpace
}

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

Definition at line 59 of file Pcd.c.

◆ mEndOfPeiSignalPpiNotifyList

EFI_PEI_NOTIFY_DESCRIPTOR mEndOfPeiSignalPpiNotifyList[]

Initial value:

= {
  {
    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
    &gEfiEndOfPeiSignalPpiGuid,
    EndOfPeiSignalPpiNotifyCallback
  }
}

Definition at line 321 of file Pcd.c.

◆ mGetPcdInfoInstance

GET_PCD_INFO_PPI mGetPcdInfoInstance

Initial value:

= {
  PeiGetPcdInfoGetInfo,
  PeiGetPcdInfoGetInfoEx,
  PeiGetPcdInfoGetSku
}

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

Definition at line 85 of file Pcd.c.

◆ mPcdPpiInstance

PCD_PPI mPcdPpiInstance

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

Definition at line 16 of file Pcd.c.

◆ mPpiList

EFI_PEI_PPI_DESCRIPTOR mPpiList[]

Initial value:

= {
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI,
    &gPcdPpiGuid,
    &mPcdPpiInstance
  },
  {
    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
    &gEfiPeiPcdPpiGuid,
    &mEfiPcdPpiInstance
  }
}

Definition at line 100 of file Pcd.c.

◆ mPpiList2

EFI_PEI_PPI_DESCRIPTOR mPpiList2[]

Initial value:

= {
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI,
    &gGetPcdInfoPpiGuid,
    &mGetPcdInfoInstance
  },
  {
    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
    &gEfiGetPcdInfoPpiGuid,
    &mEfiGetPcdInfoInstance
  }
}

Definition at line 113 of file Pcd.c.

Functions

Variables

Detailed Description

Function Documentation

◆ EndOfPeiSignalPpiNotifyCallback()

◆ GetPtrTypeSize()

◆ PcdPeimInit()

◆ PcdSetNvStoreDefaultIdCallBack()

◆ PcdUnRegisterCallBackOnSet()

◆ PeiGetPcdInfoGetInfo()

◆ PeiGetPcdInfoGetInfoEx()

◆ PeiGetPcdInfoGetSku()

◆ PeiPcdGet16()

◆ PeiPcdGet16Ex()

◆ PeiPcdGet32()

◆ PeiPcdGet32Ex()

◆ PeiPcdGet64()

◆ PeiPcdGet64Ex()

◆ PeiPcdGet8()

◆ PeiPcdGet8Ex()

◆ PeiPcdGetBool()

◆ PeiPcdGetBoolEx()

◆ PeiPcdGetNextToken()

◆ PeiPcdGetNextTokenSpace()

◆ PeiPcdGetPtr()

◆ PeiPcdGetPtrEx()

◆ PeiPcdGetSize()

◆ PeiPcdGetSizeEx()

◆ PeiPcdSet16()

◆ PeiPcdSet16Ex()

◆ PeiPcdSet32()

◆ PeiPcdSet32Ex()

◆ PeiPcdSet64()

◆ PeiPcdSet64Ex()

◆ PeiPcdSet8()

◆ PeiPcdSet8Ex()

◆ PeiPcdSetBool()

◆ PeiPcdSetBoolEx()

◆ PeiPcdSetPtr()

◆ PeiPcdSetPtrEx()

◆ PeiPcdSetSku()

◆ PeiRegisterCallBackOnSet()

◆ SetPtrTypeSize()

Variable Documentation

◆ mEfiGetPcdInfoInstance

◆ mEfiPcdPpiInstance

◆ mEndOfPeiSignalPpiNotifyList

◆ mGetPcdInfoInstance

◆ mPcdPpiInstance

◆ mPpiList

◆ mPpiList2