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
+ The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are\r
+ only available prior to ExitBootServices(). If access to PCD values are required\r
at runtime, then their values must be collected prior to ExitBootServices().\r
There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(),\r
PatchPcdGetXX(), and PatchPcdSetXX().\r
\r
-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
- @return The Boolean value for the token. \r
+ @return The Boolean value for the token.\r
\r
**/\r
#define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
- @return A pointer to the buffer. \r
+ @return A pointer to the buffer.\r
\r
**/\r
#define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName)\r
\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
+\r
@return Return the Value that was set.\r
\r
**/\r
/**\r
Sets a pointer to a binary patchable PCD token buffer based on a token name.\r
\r
- Sets the buffer for the token specified by TokenName. Buffer is returned. \r
+ Sets the buffer for the token specified by TokenName. Buffer is returned.\r
If SizeOfBuffer is greater than the maximum size supported by TokenName, then set SizeOfBuffer\r
- to the maximum size supported by TokenName and return NULL to indicate that the set operation \r
- was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be \r
+ to the maximum size supported by TokenName and return NULL to indicate that the set operation\r
+ was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be\r
set to the maximum size supported by TokenName and NULL must be returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
If TokenName is not a patchable in module PCD, then the module will not build.\r
- \r
+\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
- \r
+\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
@param Buffer Pointer to the value to set.\r
)\r
/**\r
Retrieves an 8-bit PCD token value based on a token name.\r
- \r
+\r
Returns the 8-bit value for the token specified by TokenName.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
- \r
+\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 8-bit value for the token specified by TokenName.\r
\r
/**\r
Retrieves the size of the PCD token based on a token name.\r
- \r
+\r
Returns the size of the token specified by TokenName.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
- \r
+\r
@param[in] TokenName The name of the PCD token to retrieve a current value size for.\r
\r
@return Return the size\r
\r
/**\r
Retrieve the size of a given PCD token.\r
- \r
- Returns the size of the token specified by TokenNumber and Guid. \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ Returns the size of the token specified by TokenNumber and Guid.\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value size for.\r
\r
\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
+\r
@return Return the Value that was set.\r
\r
**/\r
/**\r
Sets a pointer to a PCD token buffer based on a token name.\r
\r
- Sets the buffer for the token specified by TokenName. Buffer is returned. \r
- If SizeOfBuffer is greater than the maximum size supported by TokenName, \r
- then set SizeOfBuffer to the maximum size supported by TokenName and return NULL \r
- to indicate that the set operation was not actually performed. If SizeOfBuffer \r
- is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported \r
+ Sets the buffer for the token specified by TokenName. Buffer is returned.\r
+ If SizeOfBuffer is greater than the maximum size supported by TokenName,\r
+ then set SizeOfBuffer to the maximum size supported by TokenName and return NULL\r
+ to indicate that the set operation was not actually performed. If SizeOfBuffer\r
+ is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported\r
by TokenName and NULL must be returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
- \r
+\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
- \r
+\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 Buffer A pointer to the buffer to set.\r
**/\r
#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \\r
_PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer))\r
- \r
+\r
/**\r
Sets a Boolean PCD token value based on a token name.\r
\r
- Sets the Boolean value for the token specified by TokenName. Value is returned. \r
+ Sets the Boolean value for the token specified by TokenName. Value is returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
@param TokenName The name of the PCD token to set the current value for.\r
Returns the token number for the token specified by Guid and TokenName.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return Return the token number.\r
\r
Retrieves an 8-bit PCD token value based on a GUID and a token name.\r
\r
Returns the 8-bit value for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return An 8-bit PCD token value.\r
\r
Retrieves a 16-bit PCD token value based on a GUID and a token name.\r
\r
Returns the 16-bit value for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 16-bit PCD token value.\r
\r
Retrieves a 32-bit PCD token value based on a GUID and a token name.\r
\r
Returns the 32-bit value for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 32-bit PCD token value.\r
\r
Retrieves a 64-bit PCD token value based on a GUID and a token name.\r
\r
Returns the 64-bit value for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 64-bit PCD token value.\r
\r
Retrieves a pointer to a PCD token buffer based on a GUID and a token name.\r
\r
Returns a pointer to the buffer for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A pointer to a PCD token buffer.\r
\r
Retrieves a Boolean PCD token value based on a GUID and a token name.\r
\r
Returns the Boolean value for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
- @param TokenName The name of the PCD token to retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A Boolean PCD token value.\r
\r
Sets an 8-bit PCD token value based on a GUID and a token name.\r
\r
Sets the 8-bit value for the token specified by Guid and TokenName. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 Value The 8-bit value to set. \r
+ @param Value The 8-bit value to set.\r
\r
@return Return the Value that was set.\r
\r
Sets a 16-bit PCD token value based on a GUID and a token name.\r
\r
Sets the 16-bit value for the token specified by Guid and TokenName. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 Value The 16-bit value to set. \r
+ @param Value The 16-bit value to set.\r
\r
@return Return the Value that was set.\r
\r
Sets a 32-bit PCD token value based on a GUID and a token name.\r
\r
Sets the 32-bit value for the token specified by Guid and TokenName. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 Value The 32-bit value to set. \r
+ @param Value The 32-bit value to set.\r
\r
@return Return the Value that was set.\r
\r
Sets a 64-bit PCD token value based on a GUID and a token name.\r
\r
Sets the 64-bit value for the token specified by Guid and TokenName. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 Value The 64-bit value to set. \r
+ @param Value The 64-bit value to set.\r
\r
@return Return the Value that was set.\r
\r
/**\r
Sets a pointer to a PCD token buffer based on a GUID and a token name.\r
\r
- Sets the buffer for the token specified by Guid and TokenName. Buffer is returned. \r
- If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName, \r
- then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return \r
- NULL to indicate that the set operation was not actually performed. If SizeOfBuffer \r
+ Sets the buffer for the token specified by Guid and TokenName. Buffer is returned.\r
+ If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName,\r
+ then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return\r
+ NULL to indicate that the set operation was not actually performed. If SizeOfBuffer\r
is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by\r
Guid and TokenName and NULL must be returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
@param Buffer Pointer to the buffer to set.\r
- \r
+\r
@return Return the pointer to the Buffer that was set.\r
\r
**/\r
/**\r
Sets a Boolean PCD token value based on a GUID and a token name.\r
\r
- Sets the Boolean value for the token specified by Guid and TokenName. Value is returned. \r
- If TokenName is not a valid token in the token space specified by Guid, \r
+ Sets the Boolean value for the token specified by Guid and TokenName. Value is returned.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \r
+ @param Guid Pointer to a 128-bit unique value that designates\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 TokenName The name of the PCD token to set the current value for.\r
@param Value The Boolean value to set.\r
\r
@return Return the Value that was set.\r
\r
-**/ \r
+**/\r
#define PcdSetExBool(Guid, TokenName, Value) \\r
LibPcdSetExBool((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
#endif\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
- Returns the 8-bit value for the token specified by TokenNumber. \r
+\r
+ Returns the 8-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @return Returns the 8-bit value for the token specified by TokenNumber. \r
+ @return Returns the 8-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT8\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
- Returns the 16-bit value for the token specified by TokenNumber. \r
+\r
+ Returns the 16-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @return Returns the 16-bit value for the token specified by TokenNumber. \r
+ @return Returns the 16-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT16\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
- Returns the 32-bit value for the token specified by TokenNumber. \r
+\r
+ Returns the 32-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
+\r
Returns the 64-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
+\r
Returns the pointer to the buffer of the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
- Returns the Boolean value of the token specified by TokenNumber. \r
+\r
+ Returns the Boolean value of the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @return Returns the Boolean value of the token specified by TokenNumber. \r
+ @return Returns the Boolean value of the token specified by TokenNumber.\r
\r
**/\r
-BOOLEAN \r
+BOOLEAN\r
EFIAPI\r
LibPcdGetBool (\r
IN UINTN TokenNumber\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @return Returns the size of the token specified by TokenNumber. \r
+ @return Returns the size of the token specified by TokenNumber.\r
\r
**/\r
UINTN\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
+\r
Returns the 8-bit value for the token specified by TokenNumber and Guid.\r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
This function provides a means by which to retrieve a value for a given PCD token.\r
\r
Returns the 16-bit value for the token specified by TokenNumber and Guid.\r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
+\r
Returns the 64-bit value for the token specified by TokenNumber and Guid.\r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
+\r
Returns the pointer to the buffer of token specified by TokenNumber and Guid.\r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \r
- Returns the Boolean value of the token specified by TokenNumber and Guid. \r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ Returns the Boolean value of the token specified by TokenNumber and Guid.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
\r
/**\r
This function provides a means by which to retrieve the size of a given PCD token.\r
- \r
- Returns the size of the token specified by TokenNumber and Guid. \r
- \r
- If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ Returns the size of the token specified by TokenNumber and Guid.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 8-bit value for the token specified by TokenNumber \r
+\r
+ Sets the 8-bit value for the token specified by TokenNumber\r
to the value specified by Value. Value is returned.\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 16-bit value for the token specified by TokenNumber \r
+\r
+ Sets the 16-bit value for the token specified by TokenNumber\r
to the value specified by Value. Value is returned.\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 32-bit value for the token specified by TokenNumber \r
+\r
+ Sets the 32-bit value for the token specified by TokenNumber\r
to the value specified by Value. Value is returned.\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 64-bit value for the token specified by TokenNumber \r
+\r
+ Sets the 64-bit value for the token specified by TokenNumber\r
to the value specified by Value. Value is returned.\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets a buffer for the token specified by TokenNumber to the value \r
- specified by Buffer and SizeOfBuffer. Buffer is returned. \r
- If SizeOfBuffer is greater than the maximum size support by TokenNumber, \r
- then set SizeOfBuffer to the maximum size supported by TokenNumber and \r
+\r
+ Sets a buffer for the token specified by TokenNumber to the value\r
+ specified by Buffer and SizeOfBuffer. Buffer is returned.\r
+ If SizeOfBuffer is greater than the maximum size support by TokenNumber,\r
+ then set SizeOfBuffer to the maximum size supported by TokenNumber and\r
return NULL to indicate that the set operation was not actually performed.\r
\r
- If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the \r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the\r
maximum size supported by TokenName and NULL must be returned.\r
- \r
+\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
- \r
+\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
@param[in] Buffer A pointer to the buffer to set.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the Boolean value for the token specified by TokenNumber \r
+\r
+ Sets the Boolean value for the token specified by TokenNumber\r
to the value specified by Value. Value is returned.\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 8-bit value for the token specified by TokenNumber and \r
+\r
+ Sets the 8-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\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
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 16-bit value for the token specified by TokenNumber and \r
+\r
+ Sets the 16-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\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
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 32-bit value for the token specified by TokenNumber and \r
+\r
+ Sets the 32-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\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
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the 64-bit value for the token specified by TokenNumber and \r
+\r
+ Sets the 64-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\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
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets a buffer for the token specified by TokenNumber to the value specified by \r
- Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
- the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size \r
- supported by TokenNumber and return NULL to indicate that the set operation \r
+\r
+ Sets a buffer for the token specified by TokenNumber to the value specified by\r
+ Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than\r
+ the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size\r
+ supported by TokenNumber and return NULL to indicate that the set operation\r
was not actually performed.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
- \r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+\r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
- \r
- Sets the Boolean value for the token specified by TokenNumber and \r
+\r
+ Sets the Boolean value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid Pointer to a 128-bit unique value that\r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The Boolean value to set.\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
+ internal data in PCD database.\r
\r
@param[in] CallBackGuid The PCD token GUID being set.\r
@param[in] CallBackToken The PCD token number being set.\r
\r
/**\r
Set up a notification function that is called when a specified token is set.\r
- \r
- When the token specified by TokenNumber and Guid is set, \r
- then notification function specified by NotificationFunction is called. \r
+\r
+ When the token specified by TokenNumber and Guid is set,\r
+ then notification function specified by NotificationFunction is called.\r
If Guid is NULL, then the default token space is used.\r
If NotificationFunction is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which \r
- namespace to set a value from. If NULL, then the default \r
+ @param[in] Guid Pointer to a 128-bit unique value that designates which\r
+ namespace to set a value from. If NULL, then the default\r
token space is used.\r
@param[in] TokenNumber The PCD token number to monitor.\r
- @param[in] NotificationFunction The function to call when the token \r
+ @param[in] NotificationFunction The function to call when the token\r
specified by Guid and TokenNumber is set.\r
\r
**/\r
\r
/**\r
Disable a notification function that was established with LibPcdCallbackonSet().\r
- \r
+\r
Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
If NotificationFunction is NULL, then ASSERT().\r
- If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,\r
and NotificationFunction, then ASSERT().\r
- \r
+\r
@param[in] Guid Specify the GUID token space.\r
@param[in] TokenNumber Specify the token number.\r
@param[in] NotificationFunction The callback function to be unregistered.\r
\r
/**\r
Retrieves the next token in a token space.\r
- \r
- Retrieves the next PCD token number from the token space specified by Guid. \r
- If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r
- then the first token number is returned. Otherwise, the token number that \r
- follows TokenNumber in the token space is returned. If TokenNumber is the last \r
- token number in the token space, then 0 is returned. \r
- \r
+\r
+ Retrieves the next PCD token number from the token space specified by Guid.\r
+ If Guid is NULL, then the default token space is used. If TokenNumber is 0,\r
+ then the first token number is returned. Otherwise, the token number that\r
+ follows TokenNumber in the token space is returned. If TokenNumber is the last\r
+ token number in the token space, then 0 is returned.\r
+\r
If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which namespace \r
+ @param[in] Guid Pointer to a 128-bit unique value that designates which namespace\r
to set a value from. If NULL, then the default token space is used.\r
- @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD \r
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD\r
token number.\r
\r
@return The next valid token number.\r
\r
**/\r
-UINTN \r
+UINTN\r
EFIAPI\r
LibPcdGetNextToken (\r
IN CONST GUID *Guid, OPTIONAL\r
\r
/**\r
Used to retrieve the list of available PCD token space GUIDs.\r
- \r
+\r
Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
in the platform.\r
If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
- \r
+\r
@param TokenSpaceGuid Pointer to the a PCD token space GUID\r
\r
@return The next valid token namespace.\r
\r
/**\r
Sets a value of a patchable PCD entry that is type pointer.\r
- \r
- Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
- and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
- MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
- NULL to indicate that the set operation was not actually performed. \r
- If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
+\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer\r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than\r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return\r
+ NULL to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
MaximumDatumSize and NULL must be returned.\r
- \r
+\r
If PatchVariable is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[out] PatchVariable A pointer to the global variable in a module that is \r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
the target of the set operation.\r
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\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
+\r
@return Return the pointer to the Buffer that was set.\r
\r
**/\r
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\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
+\r
@return The status of the set operation.\r
\r
**/\r
\r
/**\r
Sets a value and size of a patchable PCD entry that is type pointer.\r
- \r
- Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
- and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
- MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
- NULL to indicate that the set operation was not actually performed. \r
- If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
+\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer\r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than\r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return\r
+ NULL to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
MaximumDatumSize and NULL must be returned.\r
- \r
+\r
If PatchVariable is NULL, then ASSERT().\r
If SizeOfPatchVariable is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[out] PatchVariable A pointer to the global variable in a module that is \r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
the target of the set operation.\r
@param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\r
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\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
+\r
@return Return the pointer to the Buffer that was set.\r
\r
**/\r
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\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
+\r
@return The status of the set operation.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff