From: jji4 Date: Fri, 13 Feb 2009 09:03:56 +0000 (+0000) Subject: Comments checked with spec X-Git-Tag: edk2-stable201903~18726 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=b677694d2eb03ec8d3658a710b136563ff74e982;ds=sidebyside Comments checked with spec git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7524 6f19259b-4bc3-4df7-8a09-765794883524 --- diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index 71034716c8..319c751c61 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -780,13 +780,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 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(). - @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and - set values associated with a PCD token. - - If SkuId >= 0x100, then ASSERT(). + @param SkuId The SKU value that will be used when the PCD service retrieves and sets values + associated with a PCD token. - @return Return the SKU ID that just be set. + @return Return the SKU ID that just be set. **/ UINTN @@ -920,9 +919,9 @@ LibPcdGetSize ( If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid Pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @return Return the UINT8. @@ -942,9 +941,9 @@ LibPcdGetEx8 ( If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid Pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @return Return the UINT16. @@ -961,9 +960,9 @@ LibPcdGetEx16 ( Returns the 32-bit value for the token specified by TokenNumber and Guid. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates - which namespace to retrieve a value from. - @param[in] TokenNumber The PCD token number to retrieve a current value for. + @param[in] Guid Pointer to a 128-bit unique value that designates + which namespace to retrieve a value from. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @return Return the UINT32. @@ -1352,18 +1351,14 @@ LibPcdSetExBool ( /** - 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(). - - This notification function serves two purposes. Firstly, it notifies the module which - did the registration that the value of this PCD token has been set. Secondly, - it provides a mechanism for the module which did the registration to intercept - the set operation and override the value been set if necessary. After the invocation - of the callback function, TokenData will be used by PCD service PEIM or driver to - modify the internal data in PCD database. + This notification function serves two purposes. + Firstly, it notifies the module which did the registration that the value of this + PCD token has been set. + Secondly, it provides a mechanism for the module which did the registration to intercept + the set operation and override the value been set if necessary. After the invocation of + the callback function, TokenData will be used by PCD service PEIM or driver to modify th + internal data in PCD database. @param[in] CallBackGuid The PCD token GUID being set. @param[in] CallBackToken The PCD token number being set. @@ -1386,14 +1381,13 @@ VOID 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 Guid is NULL, then the default token space is used. If NotificationFunction is NULL, then ASSERT(). - @param[in] Guid 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. - @param[in] TokenNumber The PCD token number to monitor. + @param[in] Guid 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. + @param[in] TokenNumber The PCD token number to monitor. @param[in] NotificationFunction The function to call when the token specified by Guid and TokenNumber is set. @@ -1410,14 +1404,13 @@ 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 LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, and NotificationFunction, then ASSERT(). - @param[in] Guid Specify the GUID token space. - @param[in] TokenNumber Specify the token number. + @param[in] Guid Specify the GUID token space. + @param[in] TokenNumber Specify the token number. @param[in] NotificationFunction The callback function to be unregistered. **/ @@ -1461,23 +1454,17 @@ LibPcdGetNextToken ( /** Used to retrieve the list of available PCD token space GUIDs. - Retrieves the next PCD token space from a token space specified by Guid. - Guid of NULL is reserved to mark the default local token namespace on the current - platform. If Guid is NULL, then the GUID of the first non-local token space of the - current platform is returned. If Guid is the last non-local token space, - then NULL is returned. - - If Guid is not NULL and is not a valid token space in the current platform, then ASSERT(). - - + 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. - @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace - to start the search. + @param TokenSpaceGuid Pointer to the a PCD token space GUID @return The next valid token namespace. **/ -GUID * +GUID * EFIAPI LibPcdGetNextTokenSpace ( IN CONST GUID *TokenSpaceGuid