Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
GET_PCD_INFO_PROTOCOL* GetPcdInfoProtocolPointer | ( | VOID | ) |
Retrieves the PCD info protocol from the handle database.
GET_PCD_INFO_PROTOCOL | * The pointer to the GET_PCD_INFO_PROTOCOL. |
References ASSERT, ASSERT_EFI_ERROR, gBS, gGetPcdInfoProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, NULL, and VOID.
Referenced by LibPcdGetInfo().
PCD_PROTOCOL* EFIAPI GetPcdProtocol | ( | VOID | ) |
Retrieves the PCD protocol from the handle database.
PCD_PROTOCOL | * The pointer to the PCD_PROTOCOL. |
References ASSERT, ASSERT_EFI_ERROR, gBS, gPcdProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, NULL, and VOID.
Referenced by LibPcdGet16(), LibPcdGet32(), LibPcdGet64(), LibPcdGet8(), LibPcdGetBool(), LibPcdGetPtr(), LibPcdGetSize(), LibPcdSet16(), LibPcdSet16S(), LibPcdSet32(), LibPcdSet32S(), LibPcdSet64(), LibPcdSet64S(), LibPcdSet8(), LibPcdSet8S(), LibPcdSetBool(), LibPcdSetBoolS(), LibPcdSetPtr(), LibPcdSetPtrS(), and LibPcdSetSku().
EFI_GET_PCD_INFO_PROTOCOL* GetPiPcdInfoProtocolPointer | ( | VOID | ) |
Retrieves the PI PCD info protocol from the handle database.
EFI_GET_PCD_INFO_PROTOCOL | * The pointer to the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 Vol 3. |
References ASSERT, ASSERT_EFI_ERROR, gBS, gEfiGetPcdInfoProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, NULL, and VOID.
Referenced by LibPcdGetInfoEx(), and LibPcdGetSku().
EFI_PCD_PROTOCOL* EFIAPI GetPiPcdProtocol | ( | VOID | ) |
Retrieves the PI PCD protocol from the handle database.
EFI_PCD_PROTOCOL | * The pointer to the EFI_PCD_PROTOCOL. |
References ASSERT, ASSERT_EFI_ERROR, gBS, gEfiPcdProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, NULL, and VOID.
Referenced by LibPcdCallbackOnSet(), LibPcdCancelCallback(), LibPcdGetEx16(), LibPcdGetEx32(), LibPcdGetEx64(), LibPcdGetEx8(), LibPcdGetExBool(), LibPcdGetExPtr(), LibPcdGetExSize(), LibPcdGetNextToken(), LibPcdGetNextTokenSpace(), LibPcdSetEx16(), LibPcdSetEx16S(), LibPcdSetEx32(), LibPcdSetEx32S(), LibPcdSetEx64(), LibPcdSetEx64S(), LibPcdSetEx8(), LibPcdSetEx8S(), LibPcdSetExBool(), LibPcdSetExBoolS(), LibPcdSetExPtr(), and LibPcdSetExPtrS().
VOID* EFIAPI LibPatchPcdSetPtr | ( | OUT VOID * | PatchVariable, | |
IN UINTN | MaximumDatumSize, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
Sets a value of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return NULL to indicate that the set operation was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.
If PatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[out] | PatchVariable | A pointer to the global variable in a module that is the target of the set operation. |
[in] | MaximumDatumSize | The maximum size allowed for the PCD entry specified by PatchVariable. |
[in,out] | SizeOfBuffer | A pointer to the size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to used to set the target variable. |
References ASSERT, CopyMem(), MAX_ADDRESS, NULL, and VOID.
VOID* EFIAPI LibPatchPcdSetPtrAndSize | ( | OUT VOID * | PatchVariable, | |
OUT UINTN * | SizeOfPatchVariable, | |||
IN UINTN | MaximumDatumSize, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
Sets a value and size of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return NULL to indicate that the set operation was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.
If PatchVariable is NULL, then ASSERT(). If SizeOfPatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[out] | PatchVariable | A pointer to the global variable in a module that is the target of the set operation. |
[out] | SizeOfPatchVariable | A pointer to the size, in bytes, of PatchVariable. |
[in] | MaximumDatumSize | The maximum size allowed for the PCD entry specified by PatchVariable. |
[in,out] | SizeOfBuffer | A pointer to the size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to used to set the target variable. |
References ASSERT, CopyMem(), MAX_ADDRESS, NULL, and VOID.
RETURN_STATUS EFIAPI LibPatchPcdSetPtrAndSizeS | ( | OUT VOID * | PatchVariable, | |
OUT UINTN * | SizeOfPatchVariable, | |||
IN UINTN | MaximumDatumSize, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
Sets a value and size of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER to indicate that the set operation was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.
If PatchVariable is NULL, then ASSERT(). If SizeOfPatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[out] | PatchVariable | A pointer to the global variable in a module that is the target of the set operation. |
[out] | SizeOfPatchVariable | A pointer to the size, in bytes, of PatchVariable. |
[in] | MaximumDatumSize | The maximum size allowed for the PCD entry specified by PatchVariable. |
[in,out] | SizeOfBuffer | A pointer to the size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to used to set the target variable. |
References ASSERT, CopyMem(), MAX_ADDRESS, NULL, RETURN_INVALID_PARAMETER, and RETURN_SUCCESS.
RETURN_STATUS EFIAPI LibPatchPcdSetPtrS | ( | OUT VOID * | PatchVariable, | |
IN UINTN | MaximumDatumSize, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
Sets a value of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER to indicate that the set operation was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.
If PatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[out] | PatchVariable | A pointer to the global variable in a module that is the target of the set operation. |
[in] | MaximumDatumSize | The maximum size allowed for the PCD entry specified by PatchVariable. |
[in,out] | SizeOfBuffer | A pointer to the size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to used to set the target variable. |
References ASSERT, CopyMem(), MAX_ADDRESS, NULL, RETURN_INVALID_PARAMETER, and RETURN_SUCCESS.
VOID EFIAPI LibPcdCallbackOnSet | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN PCD_CALLBACK | NotificationFunction | |||
) |
Set up a notification function that is called when a specified token is set.
When the token specified by TokenNumber and Guid is set, then notification function specified by NotificationFunction is called. If Guid is NULL, then the default token space is used. If NotificationFunction is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. If NULL, then the default token space is used. |
[in] | TokenNumber | The PCD token number to monitor. |
[in] | NotificationFunction | The function to call when the token specified by Guid and TokenNumber is set. |
References ASSERT, ASSERT_EFI_ERROR, _EFI_PCD_PROTOCOL::CallbackOnSet, GetPiPcdProtocol(), and NULL.
VOID EFIAPI LibPcdCancelCallback | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN PCD_CALLBACK | NotificationFunction | |||
) |
Disable a notification function that was established with LibPcdCallbackonSet().
Disable a notification function that was previously established with LibPcdCallbackOnSet(). If NotificationFunction is NULL, then ASSERT(). If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, and NotificationFunction, then ASSERT().
[in] | Guid | Specify the GUID token space. |
[in] | TokenNumber | Specify the token number. |
[in] | NotificationFunction | The callback function to be unregistered. |
References ASSERT, ASSERT_EFI_ERROR, _EFI_PCD_PROTOCOL::CancelCallback, GetPiPcdProtocol(), and NULL.
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 16-bit value for the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References PCD_PROTOCOL::Get16, and GetPcdProtocol().
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 32-bit value for the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References PCD_PROTOCOL::Get32, and GetPcdProtocol().
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 64-bit value for the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References PCD_PROTOCOL::Get64, and GetPcdProtocol().
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 8-bit value for the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References PCD_PROTOCOL::Get8, and GetPcdProtocol().
This function provides a means by which to retrieve a value for a given PCD token.
Returns the Boolean value of the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References PCD_PROTOCOL::GetBool, and GetPcdProtocol().
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 16-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, _EFI_PCD_PROTOCOL::Get16, GetPiPcdProtocol(), and NULL.
Returns the 32-bit value for the token specified by TokenNumber and Guid. If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, _EFI_PCD_PROTOCOL::Get32, GetPiPcdProtocol(), and NULL.
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 64-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, _EFI_PCD_PROTOCOL::Get64, GetPiPcdProtocol(), and NULL.
This function provides a means by which to retrieve a value for a given PCD token.
Returns the 8-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, _EFI_PCD_PROTOCOL::Get8, GetPiPcdProtocol(), and NULL.
This function provides a means by which to retrieve a value for a given PCD token.
Returns the Boolean value of the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, _EFI_PCD_PROTOCOL::GetBool, GetPiPcdProtocol(), and NULL.
This function provides a means by which to retrieve a value for a given PCD token.
Returns the pointer to the buffer of token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, GetPiPcdProtocol(), _EFI_PCD_PROTOCOL::GetPtr, and NULL.
This function provides a means by which to retrieve the size of a given PCD token.
Returns the size of the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to retrieve a value from. |
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References ASSERT, GetPiPcdProtocol(), _EFI_PCD_PROTOCOL::GetSize, and NULL.
Retrieve additional information associated with a PCD token.
This includes information such as the type of value the TokenNumber is associated with as well as possible human readable name that is associated with the token.
If TokenNumber is not in the default token space specified, then ASSERT().
[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. |
References ASSERT_EFI_ERROR, _GET_PCD_INFO_PROTOCOL::GetInfo, and GetPcdInfoProtocolPointer().
Retrieve additional information associated with a PCD token.
This includes information such as the type of value the TokenNumber is associated with as well as possible human readable name that is associated with the token.
If TokenNumber is not in the token space specified by Guid, then ASSERT().
[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. |
References ASSERT_EFI_ERROR, _EFI_GET_PCD_INFO_PROTOCOL::GetInfo, and GetPiPcdInfoProtocolPointer().
Retrieves the next token in a token space.
Retrieves the next PCD token number from the token space specified by Guid. If Guid is NULL, then the default token space is used. If TokenNumber is 0, then the first token number is returned. Otherwise, the token number that follows TokenNumber in the token space is returned. If TokenNumber is the last token number in the token space, then 0 is returned.
If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. If NULL, then the default token space is used. |
[in] | TokenNumber | The previous PCD token number. If 0, then retrieves the first PCD token number. |
References ASSERT, EFI_ERROR, _EFI_PCD_PROTOCOL::GetNextToken, and GetPiPcdProtocol().
Used to retrieve the list of available PCD token space GUIDs.
Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces in the platform. If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned. If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
TokenSpaceGuid | The pointer to the a PCD token space GUID. |
References _EFI_PCD_PROTOCOL::GetNextTokenSpace, and GetPiPcdProtocol().
VOID* EFIAPI LibPcdGetPtr | ( | IN UINTN | TokenNumber | ) |
This function provides a means by which to retrieve a value for a given PCD token.
Returns the pointer to the buffer of the token specified by TokenNumber.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References GetPcdProtocol(), and PCD_PROTOCOL::GetPtr.
UINTN EFIAPI LibPcdGetSize | ( | IN UINTN | TokenNumber | ) |
This function provides a means by which to retrieve the size of a given PCD token.
[in] | TokenNumber | The PCD token number to retrieve a current value for. |
References GetPcdProtocol(), and PCD_PROTOCOL::GetSize.
UINTN EFIAPI LibPcdGetSku | ( | VOID | ) |
Retrieve the currently set SKU Id.
If the sku id got >= PCD_MAX_SKU_ID, then ASSERT().
References ASSERT, GetPiPcdInfoProtocolPointer(), _EFI_GET_PCD_INFO_PROTOCOL::GetSku, and PCD_MAX_SKU_ID.
This function provides a means by which to set a value for a given PCD token.
Sets the 16-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 16-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set16.
RETURN_STATUS EFIAPI LibPcdSet16S | ( | IN UINTN | TokenNumber, | |
IN UINT16 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 16-bit value for the token specified by TokenNumber to the value specified by Value.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 16-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set16.
This function provides a means by which to set a value for a given PCD token.
Sets the 32-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 32-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set32.
RETURN_STATUS EFIAPI LibPcdSet32S | ( | IN UINTN | TokenNumber, | |
IN UINT32 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 32-bit value for the token specified by TokenNumber to the value specified by Value.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 32-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set32.
This function provides a means by which to set a value for a given PCD token.
Sets the 64-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 64-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set64.
RETURN_STATUS EFIAPI LibPcdSet64S | ( | IN UINTN | TokenNumber, | |
IN UINT64 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 64-bit value for the token specified by TokenNumber to the value specified by Value.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 64-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set64.
This function provides a means by which to set a value for a given PCD token.
Sets the 8-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 8-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set8.
RETURN_STATUS EFIAPI LibPcdSet8S | ( | IN UINTN | TokenNumber, | |
IN UINT8 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 8-bit value for the token specified by TokenNumber to the value specified by Value.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 8-bit value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::Set8.
This function provides a means by which to set a value for a given PCD token.
Sets the Boolean value for the token specified by TokenNumber to the value specified by Value. Value is returned.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The boolean value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::SetBool.
RETURN_STATUS EFIAPI LibPcdSetBoolS | ( | IN UINTN | TokenNumber, | |
IN BOOLEAN | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the boolean value for the token specified by TokenNumber to the value specified by Value.
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The boolean value to set. |
References GetPcdProtocol(), and PCD_PROTOCOL::SetBool.
This function provides a means by which to set a value for a given PCD token.
Sets the 16-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 16-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set16.
RETURN_STATUS EFIAPI LibPcdSetEx16S | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN UINT16 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 16-bit value for the token specified by TokenNumber to the value specified by Value.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 16-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set16.
This function provides a means by which to set a value for a given PCD token.
Sets the 32-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 32-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set32.
RETURN_STATUS EFIAPI LibPcdSetEx32S | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN UINT32 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 32-bit value for the token specified by TokenNumber to the value specified by Value.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 32-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set32.
This function provides a means by which to set a value for a given PCD token.
Sets the 64-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 64-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set64.
RETURN_STATUS EFIAPI LibPcdSetEx64S | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN UINT64 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 64-bit value for the token specified by TokenNumber to the value specified by Value.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 64-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set64.
This function provides a means by which to set a value for a given PCD token.
Sets the 8-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 8-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set8.
RETURN_STATUS EFIAPI LibPcdSetEx8S | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN UINT8 | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the 8-bit value for the token specified by TokenNumber to the value specified by Value.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The 8-bit value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::Set8.
This function provides a means by which to set a value for a given PCD token.
Sets the Boolean value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The Boolean value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::SetBool.
RETURN_STATUS EFIAPI LibPcdSetExBoolS | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN BOOLEAN | Value | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets the boolean value for the token specified by TokenNumber to the value specified by Value.
If Guid is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in] | Value | The boolean value to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::SetBool.
VOID* EFIAPI LibPcdSetExPtr | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN VOID * | Buffer | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets a buffer for the token specified by TokenNumber to the value specified by Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size supported by TokenNumber and return NULL to indicate that the set operation was not actually performed.
If Guid is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[in] | Guid | The pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in,out] | SizeOfBuffer | The size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to set. |
References ASSERT, EFI_ERROR, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::SetPtr.
RETURN_STATUS EFIAPI LibPcdSetExPtrS | ( | IN CONST GUID * | Guid, | |
IN UINTN | TokenNumber, | |||
IN OUT UINTN * | SizeOfBuffer, | |||
IN VOID * | Buffer | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets a buffer for the token specified by TokenNumber to the value specified by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size supported by TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation was not actually performed.
If Guid is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[in] | Guid | Pointer to a 128-bit unique value that designates which namespace to set a value from. |
[in] | TokenNumber | The PCD token number to set a current value for. |
[in,out] | SizeOfBuffer | The size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to set. |
References ASSERT, GetPiPcdProtocol(), NULL, and _EFI_PCD_PROTOCOL::SetPtr.
VOID* EFIAPI LibPcdSetPtr | ( | IN UINTN | TokenNumber, | |
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets a buffer for the token specified by TokenNumber to the value specified by Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size supported by TokenNumber and return NULL to indicate that the set operation was not actually performed.
If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by TokenName and NULL must be returned.
If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[in] | TokenNumber | The PCD token number to set a current value for. |
[in,out] | SizeOfBuffer | The size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to set. |
References ASSERT, EFI_ERROR, GetPcdProtocol(), NULL, PCD_PROTOCOL::SetPtr, and VOID.
RETURN_STATUS EFIAPI LibPcdSetPtrS | ( | IN UINTN | TokenNumber, | |
IN OUT UINTN * | SizeOfBuffer, | |||
IN CONST VOID * | Buffer | |||
) |
This function provides a means by which to set a value for a given PCD token.
Sets a buffer for the token specified by TokenNumber to the value specified by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size supported by TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation was not actually performed.
If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by TokenName and EFI_INVALID_PARAMETER must be returned.
If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
[in] | TokenNumber | The PCD token number to set a current value for. |
[in,out] | SizeOfBuffer | The size, in bytes, of Buffer. |
[in] | Buffer | A pointer to the buffer to set. |
References ASSERT, GetPcdProtocol(), NULL, PCD_PROTOCOL::SetPtr, and VOID.
UINTN EFIAPI LibPcdSetSku | ( | IN UINTN | SkuId | ) |
This function provides a means by which SKU support can be established in the PCD infrastructure.
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned. If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
SkuId | The SKU value that will be used when the PCD service retrieves and sets values associated with a PCD token. |
References ASSERT, GetPcdProtocol(), PCD_MAX_SKU_ID, and PCD_PROTOCOL::SetSku.
PCD_PROTOCOL* mPcd = NULL |
GET_PCD_INFO_PROTOCOL* mPcdInfo = NULL |
EFI_PCD_PROTOCOL* mPiPcd = NULL |
EFI_GET_PCD_INFO_PROTOCOL* mPiPcdInfo = NULL |