/** @file\r
Provides library services to get and set Platform Configuration Database entries.\r
\r
- PCD Library Class provides PCD usage macro interface for all PCD types.\r
- It should be included at any module who use PCD. If module use dynamic/dynamicex\r
- PCD, module should be linked to PEIM/DXE library instance to access that PCD.\r
- If module uses PatchableInModule type PCD, also need library instance produce\r
- LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is\r
- translated to an variable or macro which is auto-generated by build tool in\r
+ PCD Library Class provides a PCD usage macro interface for all PCD types.\r
+ It should be included in any module that uses PCD. If a module uses dynamic/dynamicex\r
+ PCD, module should be linked to a PEIM/DXE library instance to access that PCD.\r
+ If a module uses PatchableInModule type PCD, it also needs the library instance to produce\r
+ LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is\r
+ translated to a variable or macro that is auto-generated by build tool in\r
module's autogen.h/autogen.c.\r
The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are \r
only available prior to ExitBootServices(). If access to PCD values are required \r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 8-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 16-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 32-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 64-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The boolean value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
@param SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
@param Buffer Pointer to the value to set.\r
\r
- @return Value.\r
+ @return Return the pointer to the Buffer that was set.\r
\r
**/\r
#define PatchPcdSetPtr(TokenName, Size, Buffer) \\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 8-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSet8(TokenName, Value) _PCD_SET_MODE_8_##TokenName ((Value))\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 16-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSet16(TokenName, Value) _PCD_SET_MODE_16_##TokenName ((Value))\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 32-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSet32(TokenName, Value) _PCD_SET_MODE_32_##TokenName ((Value))\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 64-bit value to set.\r
\r
- @return Value.\r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSet64(TokenName, Value) _PCD_SET_MODE_64_##TokenName ((Value))\r
@param SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
@param Buffer A pointer to the buffer to set.\r
\r
- @return Buffer.\r
+ @return Return the pointer to the Buffer that was set.\r
\r
**/\r
#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Buffer The Boolean value to set.\r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Value The 8-bit value to set. \r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Value The 16-bit value to set. \r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Value The 32-bit value to set. \r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Value The 64-bit value to set. \r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/\r
#define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
which namespace to retrieve a value from.\r
@param TokenName The name of the PCD token to set the current value for.\r
@param SizeOfBuffer A pointer to the size, in bytes, of Buffer. \r
- @param Value Pointer to the buffer to set.\r
+ @param Buffer Pointer to the buffer to set.\r
\r
- @return Buffer. \r
+ @return Return the pointer to the Buffer that was set.\r
\r
**/\r
#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \\r
@param TokenName The name of the PCD token to set the current value for. \r
@param Value The Boolean value to set.\r
\r
- @return Value. \r
+ @return Return the Value that was set.\r
\r
**/ \r
#define PcdSetExBool(Guid, TokenName, Value) \\r
@param SkuId The SKU value that will be used when the PCD service retrieves and sets values\r
associated with a PCD token.\r
\r
- @return Return the SKU ID that just be set.\r
+ @return Return the SKU ID that was set.\r
\r
**/\r
UINTN\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 8-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT8\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 16-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT16\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 32-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT32\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 64-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT64\r
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
@param[in] Buffer A pointer to the buffer to set.\r
\r
- @return Return the pointer for the buffer been set.\r
+ @return Return the pointer for the Buffer that was set.\r
\r
**/\r
VOID *\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The boolean value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
BOOLEAN\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 8-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT8\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 16-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT16\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 32-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT32\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 64-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
UINT64\r
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
@param[in] Buffer A pointer to the buffer to set.\r
\r
- @return Return the pinter to the buffer been set.\r
+ @return Return the pointer to the Buffer that was set.\r
\r
**/\r
VOID *\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The Boolean value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the Value that was set.\r
\r
**/\r
BOOLEAN\r
/**\r
This notification function serves two purposes.\r
\r
- Firstly, it notifies the module which did the registration that the value of this\r
+ Firstly, it notifies the module that did the registration that the value of this\r
PCD token has been set.\r
- Secondly, it provides a mechanism for the module which did the registration to intercept\r
+ Secondly, it provides a mechanism for the module that did the registration to intercept\r
the set operation and override the value been set if necessary. After the invocation of\r
the callback function, TokenData will be used by PCD service PEIM or driver to modify th\r
internal data in PCD database. \r
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
@param[in] Buffer A pointer to the buffer to used to set the target variable.\r
\r
- @return Return the pointer to the buffer been set.\r
+ @return Return the pointer to the Buffer that was set.\r
\r
**/\r
VOID *\r
projects / mirror_edk2.git / blobdiff