}\r
\r
/**\r
+ This function provides a means by which SKU support can be established in the PCD infrastructure.\r
+\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r
- If SkuId not less than PCD_MAX_SKU_ID, then ASSERT().\r
- \r
- @param[in] SkuId System sku id. The SKU value that will be used when the PCD service will retrieve and \r
- set values.\r
+\r
+ @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and \r
+ set values associated with a PCD token.\r
+ \r
+ If SkuId >= 0x100, then ASSERT(). \r
\r
@return Return the SKU ID that just be set.\r
\r
UINTN\r
EFIAPI\r
LibPcdSetSku (\r
- IN UINTN SkuId\r
+ IN UINTN SkuId\r
)\r
{\r
\r
\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
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
UINT8\r
EFIAPI\r
LibPcdGet8 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->Get8 (TokenNumber);\r
\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
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\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
\r
UINT16\r
EFIAPI\r
LibPcdGet16 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->Get16 (TokenNumber);\r
\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
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
UINT32\r
EFIAPI\r
LibPcdGet32 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->Get32 (TokenNumber);\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\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
UINT64\r
EFIAPI\r
LibPcdGet64 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->Get64 (TokenNumber);\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\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
VOID *\r
EFIAPI\r
LibPcdGetPtr (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->GetPtr (TokenNumber);\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. \r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
BOOLEAN \r
EFIAPI\r
LibPcdGetBool (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->GetBool (TokenNumber);\r
\r
\r
/**\r
- Returns the size of the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve the size of a given PCD token.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
UINTN\r
EFIAPI\r
LibPcdGetSize (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return (GetPcdPpiPointer ())->GetSize (TokenNumber);\r
\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 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
\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 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
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\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
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\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
@return Return the UINT64.\r
\r
\r
\r
/**\r
- Returns the pointer to the token specified by TokenNumber and Guid.\r
+ This function provides a means by which to retrieve a value for a given PCD token.\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
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\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
@return Return the VOID* pointer.\r
\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
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\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
@return Return the BOOLEAN.\r
\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
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\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
@return Return the size.\r
\r
\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 \r
to the value specified by Value. Value is returned.\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\r
\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
+ @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
\r
\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
to the value specified by Value. Value is returned.\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\r
\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
+ @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
\r
\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
to the value specified by Value. Value is returned.\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\r
\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
+ @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
\r
EFIAPI\r
LibPcdSet32 (\r
IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+ IN UINT32 Value\r
)\r
{\r
EFI_STATUS Status;\r
\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
to the value specified by Value. Value is returned.\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\r
\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
+ @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
\r
EFIAPI\r
LibPcdSet64 (\r
IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+ IN UINT64 Value\r
)\r
{\r
EFI_STATUS Status;\r
\r
\r
/**\r
- Sets a buffer for the token specified by TokenNumber to \r
- the value specified by Buffer and SizeOfBuffer. Buffer to\r
- be set is returned. The content of the buffer could be \r
- overwritten if a Callback on SET is registered with this\r
- TokenNumber.\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- If SizeOfBuffer is greater than the maximum \r
- size support by TokenNumber, then set SizeOfBuffer to the \r
- maximum size supported by TokenNumber and return NULL to \r
- indicate that the set operation was not actually performed. \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
+ maximum size supported by TokenName and NULL must be returned.\r
\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\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
- In out, returns actual size of buffer is set.\r
- @param[in] Buffer A pointer to the buffer to set.\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
@return Return the pointer for the buffer been set.\r
\r
VOID *\r
EFIAPI\r
LibPcdSetPtr (\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN CONST VOID *Buffer\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
EFI_STATUS Status;\r
\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
to the value specified by Value. Value is returned.\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The boolean value to set.\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
\r
\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
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\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] Value The 8-bit value to set.\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
@return Return the value been set.\r
\r
\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
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\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] Value The 16-bit value to set.\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
@return Return the value been set.\r
\r
\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
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\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] Value The 32-bit value to set.\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
@return Return the value been set.\r
\r
LibPcdSetEx32 (\r
IN CONST GUID *Guid,\r
IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+ IN UINT32 Value\r
)\r
{\r
EFI_STATUS Status;\r
\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
Guid to the value specified by Value. Value is returned.\r
If Guid is NULL, then ASSERT().\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\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] Value The 64-bit value to set.\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
@return Return the value been set.\r
\r
\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
was not actually performed. \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
- 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
- In out, returns actual size of buffer is set.\r
- @param[in] Buffer A pointer to the buffer to set.\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
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
@return Return the pinter to the buffer been set.\r
\r
\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
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
- If fail to set pcd value, then ASSERT_EFI_ERROR().\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] Value The Boolean value to set.\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
\r
@return Return the value been set.\r
\r
\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
If Guid is NULL, then the default token space is used. \r
+ \r
If NotificationFunction is NULL, then ASSERT().\r
- If fail to set callback, then ASSERT_EFI_ERROR().\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
- specified by Guid and TokenNumber is set.\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
+ 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
+ specified by Guid and TokenNumber is set.\r
\r
**/\r
VOID\r
\r
/**\r
Disable a notification function that was established with LibPcdCallbackonSet().\r
+ \r
+ Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
+ \r
If NotificationFunction is NULL, then ASSERT().\r
- If fail to cancel callback, then ASSERT_EFI_ERROR().\r
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
+ and NotificationFunction, then ASSERT().\r
\r
- @param[in] Guid Specify the GUID token space.\r
- @param[in] TokenNumber Specify the token number.\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
\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. If TokenNumber is not 0 and \r
- is not in the token space specified by Guid, then ASSERT().\r
- If fail to get token in given token space, then ASSERT_EFI_ERROR().\r
+ token number in the token space, then 0 is returned. \r
\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
- token number.\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
+ 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
+ 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
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber\r
)\r
{\r
EFI_STATUS Status;\r
platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
current platform is returned. If Guid is the last non-local token space, \r
then NULL is returned. \r
- If fail to get next token space, then ASSERT_EFI_ERROR().\r
- \r
+\r
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
\r
\r
projects / mirror_edk2.git / blobdiff