tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-19 19:54:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Comments synchronized with library class

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7525 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2009-02-13 09:05:43 +00:00
parent b677694d2e
commit c00bdbb14a
2 changed files with 49 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
MdePkg/Library/DxePcdLib/DxePcdLib.c
View File

@ -60,13 +60,12 @@ PcdLibConstructor (
This function provides a means by which SKU support can be established in the PCD infrastructure. 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. 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().
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and @param SkuId The SKU value that will be used when the PCD service retrieves and sets values
set values associated with a PCD token. associated with a PCD token.
If SkuId >= 0x100, then ASSERT(). @return Return the SKU ID that just be set.
@return Return the SKU ID that just be set.
**/ **/
UINTN UINTN
@ -236,9 +235,9 @@ LibPcdGetSize (
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT8. @return Return the UINT8.
@ -263,9 +262,9 @@ LibPcdGetEx8 (
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT16. @return Return the UINT16.
@ -287,9 +286,9 @@ LibPcdGetEx16 (
Returns the 32-bit value for the token specified by TokenNumber and Guid. Returns the 32-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT32. @return Return the UINT32.
@ -860,13 +859,12 @@ LibPcdSetExBool (
When the token specified by TokenNumber and Guid is set, When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called. then notification function specified by NotificationFunction is called.
If Guid is NULL, then the default token space is used. If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT(). If NotificationFunction is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates which @param[in] Guid Pointer to a 128-bit unique value that designates which
namespace to set a value from. If NULL, then the default namespace to set a value from. If NULL, then the default
token space is used. token space is used.
@param[in] TokenNumber The PCD token number to monitor. @param[in] TokenNumber The PCD token number to monitor.
@param[in] NotificationFunction The function to call when the token @param[in] NotificationFunction The function to call when the token
specified by Guid and TokenNumber is set. specified by Guid and TokenNumber is set.
@ -896,13 +894,12 @@ LibPcdCallbackOnSet (
Disable a notification function that was established with LibPcdCallbackonSet(). Disable a notification function that was established with LibPcdCallbackonSet().
Disable a notification function that was previously established with LibPcdCallbackOnSet(). Disable a notification function that was previously established with LibPcdCallbackOnSet().
If NotificationFunction is NULL, then ASSERT(). If NotificationFunction is NULL, then ASSERT().
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
and NotificationFunction, then ASSERT(). and NotificationFunction, then ASSERT().
@param[in] Guid Specify the GUID token space. @param[in] Guid Specify the GUID token space.
@param[in] TokenNumber Specify the token number. @param[in] TokenNumber Specify the token number.
@param[in] NotificationFunction The callback function to be unregistered. @param[in] NotificationFunction The callback function to be unregistered.
**/ **/
@ -967,18 +964,12 @@ LibPcdGetNextToken (
/** /**
Used to retrieve the list of available PCD token space GUIDs. Used to retrieve the list of available PCD token space GUIDs.
Retrieves the next PCD token space from a token space specified by Guid. Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces
Guid of NULL is reserved to mark the default local token namespace on the current in the platform.
platform. If Guid is NULL, then the GUID of the first non-local token space of the If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.
current platform is returned. If Guid is the last non-local token space, If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
then NULL is returned.
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT(). @param TokenSpaceGuid Pointer to the a PCD token space GUID
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
to start the search.
@return The next valid token namespace. @return The next valid token namespace.

41
MdePkg/Library/PeiPcdLib/PeiPcdLib.c
View File

@ -52,13 +52,12 @@ GetPcdPpiPointer (
This function provides a means by which SKU support can be established in the PCD infrastructure. 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. 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().
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and @param SkuId The SKU value that will be used when the PCD service retrieves and sets values
set values associated with a PCD token. associated with a PCD token.
If SkuId >= 0x100, then ASSERT(). @return Return the SKU ID that just be set.
@return Return the SKU ID that just be set.
**/ **/
UINTN UINTN
@ -229,9 +228,9 @@ LibPcdGetSize (
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT8. @return Return the UINT8.
@ -257,9 +256,9 @@ LibPcdGetEx8 (
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT16. @return Return the UINT16.
@ -283,9 +282,9 @@ LibPcdGetEx16 (
Returns the 32-bit value for the token specified by TokenNumber and Guid. Returns the 32-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT32. @return Return the UINT32.
@ -848,13 +847,12 @@ LibPcdSetExBool (
When the token specified by TokenNumber and Guid is set, When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called. then notification function specified by NotificationFunction is called.
If Guid is NULL, then the default token space is used. If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT(). If NotificationFunction is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates which @param[in] Guid Pointer to a 128-bit unique value that designates which
namespace to set a value from. If NULL, then the default namespace to set a value from. If NULL, then the default
token space is used. token space is used.
@param[in] TokenNumber The PCD token number to monitor. @param[in] TokenNumber The PCD token number to monitor.
@param[in] NotificationFunction The function to call when the token @param[in] NotificationFunction The function to call when the token
specified by Guid and TokenNumber is set. specified by Guid and TokenNumber is set.
@ -884,13 +882,12 @@ LibPcdCallbackOnSet (
Disable a notification function that was established with LibPcdCallbackonSet(). Disable a notification function that was established with LibPcdCallbackonSet().
Disable a notification function that was previously established with LibPcdCallbackOnSet(). Disable a notification function that was previously established with LibPcdCallbackOnSet().
If NotificationFunction is NULL, then ASSERT(). If NotificationFunction is NULL, then ASSERT().
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
and NotificationFunction, then ASSERT(). and NotificationFunction, then ASSERT().
@param[in] Guid Specify the GUID token space. @param[in] Guid Specify the GUID token space.
@param[in] TokenNumber Specify the token number. @param[in] TokenNumber Specify the token number.
@param[in] NotificationFunction The callback function to be unregistered. @param[in] NotificationFunction The callback function to be unregistered.
**/ **/