TianoCore EDK2 master
Loading...
Searching...
No Matches
Service.h File Reference

Go to the source code of this file.

Data Structures

struct  EX_PCD_ENTRY_ATTRIBUTE
 

Macros

#define PCD_SERVICE_PEIM_VERSION   7
 

Functions

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 TokenNumber)
 
UINT16 EFIAPI PeiPcdGet16Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
UINT32 EFIAPI PeiPcdGet32Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
UINT64 EFIAPI PeiPcdGet64Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
VOID *EFIAPI PeiPcdGetPtrEx (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
BOOLEAN EFIAPI PeiPcdGetBoolEx (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
UINTN EFIAPI PeiPcdGetSizeEx (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber)
 
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 TokenNumber, IN UINT8 Value)
 
EFI_STATUS EFIAPI PeiPcdSet16Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT16 Value)
 
EFI_STATUS EFIAPI PeiPcdSet32Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT32 Value)
 
EFI_STATUS EFIAPI PeiPcdSet64Ex (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT64 Value)
 
EFI_STATUS EFIAPI PeiPcdSetPtrEx (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN OUT UINTN *SizeOfBuffer, IN VOID *Buffer)
 
EFI_STATUS EFIAPI PeiPcdSetBoolEx (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN BOOLEAN Value)
 
EFI_STATUS EFIAPI PeiRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN TokenNumber, IN PCD_PPI_CALLBACK CallBackFunction)
 
EFI_STATUS EFIAPI PcdUnRegisterCallBackOnSet (IN CONST EFI_GUID *Guid OPTIONAL, IN UINTN TokenNumber, 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)
 
EFI_STATUS PeiGetPcdInfo (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)
 
PEI_PCD_DATABASEGetPcdDatabase (VOID)
 
EFI_STATUS SetValueWorker (IN UINTN TokenNumber, IN VOID *Data, IN UINTN Size)
 
EFI_STATUS SetWorker (IN UINTN TokenNumber, IN VOID *Data, IN OUT UINTN *Size, IN BOOLEAN PtrType)
 
EFI_STATUS ExSetValueWorker (IN UINTN ExTokenNumber, IN CONST EFI_GUID *Guid, IN VOID *Data, IN UINTN Size)
 
EFI_STATUS ExSetWorker (IN UINTN ExTokenNumber, IN CONST EFI_GUID *Guid, IN VOID *Data, IN OUT UINTN *Size, IN BOOLEAN PtrType)
 
VOID * GetWorker (IN UINTN TokenNumber, IN UINTN GetSize)
 
VOID * ExGetWorker (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber, IN UINTN GetSize)
 
UINTN GetExPcdTokenNumber (IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber)
 
EFI_STATUS PeiRegisterCallBackWorker (IN UINTN TokenNumber, IN CONST EFI_GUID *Guid OPTIONAL, IN PCD_PPI_CALLBACK CallBackFunction, IN BOOLEAN Register)
 
PEI_PCD_DATABASEBuildPcdDatabase (IN EFI_PEI_FILE_HANDLE FileHandle)
 
UINTN GetSizeTableIndex (IN UINTN LocalTokenNumberTableIdx, IN PEI_PCD_DATABASE *Database)
 
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)
 

Detailed Description

The internal header file declares the private functions used by PeiPcd driver.

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

Definition in file Service.h.

Macro Definition Documentation

◆ PCD_SERVICE_PEIM_VERSION

#define PCD_SERVICE_PEIM_VERSION   7

Definition at line 34 of file Service.h.

Function Documentation

◆ BuildPcdDatabase()

PEI_PCD_DATABASE * BuildPcdDatabase ( IN EFI_PEI_FILE_HANDLE  FileHandle)

The function builds the PCD database.

Parameters
FileHandleHandle of the file the external PCD database binary located.
Returns
Pointer to PCD database.

Definition at line 422 of file Service.c.

◆ ExGetWorker()

VOID * ExGetWorker ( IN CONST EFI_GUID Guid,
IN UINTN  ExTokenNumber,
IN UINTN  GetSize 
)

Wrapper function for get PCD value for dynamic-ex PCD.

Parameters
GuidToken space guid for dynamic-ex PCD.
ExTokenNumberToken number for dyanmic-ex PCD.
GetSizeThe size of dynamic-ex PCD value.
Returns
PCD entry in PCD database.

Wrapper function for get PCD value for dynamic-ex PCD.

Parameters
GuidToken space guid for dynamic-ex PCD.
ExTokenNumberToken number for dynamic-ex PCD.
GetSizeThe size of dynamic-ex PCD value.
Returns
PCD entry in PCD database.

Definition at line 1299 of file Service.c.

◆ ExSetValueWorker()

EFI_STATUS ExSetValueWorker ( IN UINTN  ExTokenNumber,
IN CONST EFI_GUID Guid,
IN VOID *  Data,
IN UINTN  Size 
)

Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.

Parameters
ExTokenNumberToken number for dynamic-ex PCD.
GuidToken space guid for dynamic-ex PCD.
DataValue want to be set.
SetSizeThe size of value.
Returns
status of ExSetWorker().

Definition at line 1320 of file Service.c.

◆ ExSetWorker()

EFI_STATUS ExSetWorker ( IN UINTN  ExTokenNumber,
IN CONST EFI_GUID Guid,
IN VOID *  Data,
IN OUT UINTN Size,
IN BOOLEAN  PtrType 
)

Set value for a dynamic PCD entry.

This routine find the local token number according to dynamic-ex PCD's token space guid and token number firstly, and invoke callback function if this PCD entry registered callback function. Finally, invoken general SetWorker to set PCD value.

Parameters
ExTokenNumberDynamic-ex PCD token number.
GuidToken space guid for dynamic-ex PCD.
DataPCD value want to be set
SetSizeSize of value.
PtrTypeIf TRUE, this PCD entry is pointer type. If FALSE, this PCD entry is not pointer type.
Returns
status of SetWorker().

Set value for a dynamic-ex PCD entry.

This routine find the local token number according to dynamic-ex PCD's token space guid and token number firstly, and invoke callback function if this PCD entry registered callback function. Finally, invoken general SetWorker to set PCD value.

Parameters
ExTokenNumberDynamic-ex PCD token number.
GuidToken space guid for dynamic-ex PCD.
DataPCD value want to be set
SetSizeSize of value.
PtrTypeIf TRUE, this PCD entry is pointer type. If FALSE, this PCD entry is not pointer type.
Returns
status of SetWorker().

Definition at line 1349 of file Service.c.

◆ GetExPcdTokenNumber()

UINTN GetExPcdTokenNumber ( IN CONST EFI_GUID Guid,
IN UINTN  ExTokenNumber 
)

Get Token Number according to dynamic-ex PCD's {token space guid:token number}

A dynamic-ex type PCD, developer must provide pair of token space guid: token number in DEC file. PCD database maintain a mapping table that translate pair of {token space guid: token number} to Token Number.

Parameters
GuidToken space guid for dynamic-ex PCD entry.
ExTokenNumberToken number for dynamic-ex PCD.
Returns
Token Number for dynamic-ex PCD.

Get Token Number according to dynamic-ex PCD's {token space guid:token number}

A dynamic-ex type PCD, developer must provide pair of token space guid: token number in DEC file. PCD database maintain a mapping table that translate pair of {token space guid: token number} to Token Number.

Parameters
GuidToken space guid for dynamic-ex PCD entry.
ExTokenNumberDynamic-ex PCD token number.
Returns
Token Number for dynamic-ex PCD.

Definition at line 976 of file Service.c.

◆ GetPcdDatabase()

PEI_PCD_DATABASE * GetPcdDatabase ( VOID  )

Get PCD database from GUID HOB in PEI phase.

Returns
Pointer to PCD database.

Definition at line 1020 of file Service.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 specificed size. The max size of this PCD's value is described in PCD's definition in DEC file.

Parameters
LocalTokenNumberTableIdxIndex of PCD token number in PCD token table
MaxSizeMaxmium size of PCD's value
DatabasePcd database in PEI phase.
Returns
PCD value's size for POINTER type PCD.

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
LocalTokenNumberTableIdxIndex of PCD token number in PCD token table
MaxSizeMaximum size of PCD's value
DatabasePcd database in PEI phase.
Returns
PCD value's size for POINTER type PCD.

Definition at line 1652 of file Pcd.c.

◆ GetSizeTableIndex()

UINTN GetSizeTableIndex ( IN UINTN  LocalTokenNumberTableIdx,
IN PEI_PCD_DATABASE Database 
)

Get index of PCD entry in size table.

Parameters
LocalTokenNumberTableIdxIndex of this PCD in local token number table.
DatabasePointer to PCD database.
Returns
index of PCD entry in size table.

Get index of PCD entry in size table.

Parameters
LocalTokenNumberTableIdxIndex of this PCD in local token number table.
DatabasePointer to PCD database in PEI phase.
Returns
index of PCD entry in size table.

Definition at line 1042 of file Service.c.

◆ GetWorker()

VOID * GetWorker ( IN UINTN  TokenNumber,
IN UINTN  GetSize 
)

Get the PCD entry pointer in PCD database.

This routine will visit PCD database to find the PCD entry according to given token number. The given token number is autogened by build tools and it will be translated to local token number. Local token number contains PCD's type and offset of PCD entry in PCD database.

Parameters
TokenNumberToken's number, it is autogened by build tools
GetSizeThe size of token's value
Returns
PCD entry pointer in PCD database

Definition at line 366 of file Service.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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]CallBackFunctionThe function prototype called when the value associated with the CallBackToken is set.
Return values
EFI_SUCCESSThe PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUNDThe PCD service could not find the referenced token number.

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

Parameters
[in]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]CallBackFunctionThe function prototype called when the value associated with the CallBackToken is set.
Return values
EFI_SUCCESSThe PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUNDThe PCD service could not find the referenced token number.

Definition at line 1384 of file Pcd.c.

◆ PeiGetPcdInfo()

EFI_STATUS PeiGetPcdInfo ( 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[out]PcdInfoThe 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_SUCCESSThe PCD information was returned successfully
EFI_NOT_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[out]PcdInfoThe 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_SUCCESSThe PCD information was returned successfully.
EFI_NOT_FOUNDThe PCD service could not find the requested token number.

Definition at line 231 of file Service.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]TokenNumberThe PCD token number.
[out]PcdInfoThe 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_SUCCESSThe PCD information was returned successfully.
EFI_NOT_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[out]PcdInfoThe 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_SUCCESSThe PCD information was returned successfully.
EFI_NOT_FOUNDThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size 16-bit value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size 32-bit value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size 64-bit value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size 8-bit value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size Boolean value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]GuidThe 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]TokenNumberA pointer to the PCD token number to use to find the subsequent token number.
Return values
EFI_SUCCESSThe PCD service has retrieved the next valid token number. Or the input token number is already the last valid token number in the PCD database. In the later case, *TokenNumber is updated with the value of 0.
EFI_NOT_FOUNDIf this input token number and token namespace does not exist on the platform.

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]GuidThe 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]TokenNumberA pointer to the PCD token number to use to find the subsequent token number.
Return values
EFI_SUCCESSThe PCD service has retrieved the next valid token number.
EFI_NOT_FOUNDThe 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.

Parameters
[in,out]GuidAn 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 the input token namespace does not exist on the platform, an error is returned and the value of *Guid is undefined. If *Guid is NULL, then the GUID of the first token space of the current platform is assigned to *Guid the function return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in the platform other than the default (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. If this input token namespace is the last namespace on the platform, *Guid will be assigned to NULL and the function return EFI_SUCCESS.
Return values
EFI_SUCCESSThe PCD service retrieved the next valid token space Guid. Or the input token space Guid is already the last valid token space Guid in the PCD database. In the later case, *Guid is updated with the value of NULL.
EFI_NOT_FOUNDIf the input token namespace does not exist on the platform.

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]GuidAn 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_SUCCESSThe PCD service retrieved the value requested.
EFI_NOT_FOUNDThe 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]TokenNumberThe PCD token number.
Returns
The pointer to the buffer to be retrived.

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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The pointer to the buffer to be retrived.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe 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]GuidThe token space for the token number.
[in]TokenNumberThe PCD token number.
Returns
The size of the value for the PCD token.

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]GuidThe token space for the token number.
[in]ExTokenNumberThe 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]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]ValueThe value to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]TokenNumberThe PCD token number.
[in,out]SizeOfBufferA 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]BufferThe buffer to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in,out]SizeOfBufferA 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]BufferThe buffer to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe PCD service could not find the requested token number.

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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in,out]SizeOfBufferA 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]ValueThe buffer to set for the PCD token.
Return values
EFI_SUCCESSProcedure returned successfully.
EFI_INVALID_PARAMETERThe 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_FOUNDThe 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. The valid SkuId range is 1 to 255. 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]SkuIdThe SKU value that will be used when the PCD service will retrieve and set values associated with a PCD token.

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]SkuIdThe 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]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[in]CallBackFunctionThe function prototype called when the value associated with the CallBackToken is set.
Return values
EFI_SUCCESSThe PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUNDThe PCD service could not find the referenced token number.

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

Parameters
[in]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]ExTokenNumberThe PCD token number.
[in]CallBackFunctionThe function prototype called when the value associated with the CallBackToken is set.
Return values
EFI_SUCCESSThe PCD service has successfully established a call event for the CallBackToken requested.
EFI_NOT_FOUNDThe PCD service could not find the referenced token number.

Definition at line 1353 of file Pcd.c.

◆ PeiRegisterCallBackWorker()

EFI_STATUS PeiRegisterCallBackWorker ( IN UINTN  ExTokenNumber,
IN CONST EFI_GUID *Guid  OPTIONAL,
IN PCD_PPI_CALLBACK  CallBackFunction,
IN BOOLEAN  Register 
)

The function registers the CallBackOnSet fucntion according to TokenNumber and EFI_GUID space.

Parameters
TokenNumberThe token number.
GuidThe GUID space.
CallBackFunctionThe Callback function to be registered.
RegisterTo register or unregister the callback function.
Return values
EFI_SUCCESSIf the Callback function is registered.
EFI_NOT_FOUNDIf the PCD Entry is not found according to Token Number and GUID space.
EFI_OUT_OF_RESOURCESIf the callback function can't be registered because there is not free slot left in the CallbackFnTable.

The function registers the CallBackOnSet fucntion according to TokenNumber and EFI_GUID space.

Parameters
ExTokenNumberThe token number.
GuidThe GUID space.
CallBackFunctionThe Callback function to be registered.
RegisterTo register or unregister the callback function.
Return values
EFI_SUCCESSIf the Callback function is registered.
EFI_NOT_FOUNDIf the PCD Entry is not found according to Token Number and GUID space.
EFI_OUT_OF_RESOURCESIf the callback function can't be registered because there is not free slot left in the CallbackFnTable.
EFI_INVALID_PARAMETERIf the callback function want to be de-registered can not be found.

Definition at line 302 of file Service.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 specificed size. The max size of this PCD's value is described in PCD's definition in DEC file.

Parameters
LocalTokenNumberTableIdxIndex of PCD token number in PCD token table
CurrentSizeMaxmium size of PCD's value
DatabasePcd database in PEI phase.
Return values
TRUESuccess to set PCD's value size, which is not exceed maxmium size
FALSEFail to set PCD's value size, which maybe exceed maxmium size

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
LocalTokenNumberTableIdxIndex of PCD token number in PCD token table
CurrentSizeMaximum size of PCD's value
DatabasePcd database in PEI phase.
Return values
TRUESuccess to set PCD's value size, which is not exceed maximum size
FALSEFail to set PCD's value size, which maybe exceed maximum size

Definition at line 1708 of file Pcd.c.

◆ SetValueWorker()

EFI_STATUS SetValueWorker ( IN UINTN  TokenNumber,
IN VOID *  Data,
IN UINTN  Size 
)

Wrapper function for setting non-pointer type value for a PCD entry.

Parameters
TokenNumberPcd token number autogenerated by build tools.
DataValue want to be set for PCD entry
SizeSize of value.
Returns
status of SetWorker.

Definition at line 1082 of file Service.c.

◆ SetWorker()

EFI_STATUS SetWorker ( IN UINTN  TokenNumber,
IN VOID *  Data,
IN OUT UINTN Size,
IN BOOLEAN  PtrType 
)

Set value for an PCD entry

Parameters
TokenNumberPcd token number autogenerated by build tools.
DataValue want to be set for PCD entry
SizeSize of value.
PtrTypeIf TRUE, the type of PCD entry's value is Pointer. If False, the type of PCD entry's value is not Pointer.
Return values
EFI_INVALID_PARAMETERIf this PCD type is VPD, VPD PCD can not be set.
EFI_INVALID_PARAMETERIf Size can not be set to size table.
EFI_INVALID_PARAMETERIf Size of non-Ptr type PCD does not match the size information in PCD database.
EFI_NOT_FOUNDIf value type of PCD entry is intergrate, but not in range of UINT8, UINT16, UINT32, UINT64
EFI_NOT_FOUNDCan not find the PCD type according to token number.

Definition at line 1108 of file Service.c.