Update function header.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5534 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 8db9a0270af5a236af287d303d1b3e3200c865f3..1d409b4773299ca26286a0c534ad0c691a0d3201 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -1,7 +1,15 @@
 /** @file\r
-PCD Library Class Interface Declarations\r
+PCD Library Class provides PCD usage macro interface for all PCD types. It should be \r
+included at any module who use PCD. \r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+If module use dynamic/dynamicex PCD, module should be linked to PEIM/DXE library \r
+instance to access that PCD.\r
+If module uses PatchableInModule type PCD, also need library instance produce LibPatchPcdSetPtr()\r
+interface.\r
+For FeatureFlag/Fixed PCD, macro interface is translated to an variable or macro\r
+which is auto-generated by build tool in module's autogen.h/autogen.c\r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>                                                         \r
 All rights reserved. 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
@@ -113,7 +121,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.\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
+                    set values associated with a PCD token.\r
 \r
   @retval SKU_ID Return the SKU ID that just be set.\r
 \r
@@ -291,9 +299,9 @@ LibPcdGetEx32 (
   Returns the 64-bit value for 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 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
   @retval UINT64 Return the UINT64.\r
 \r
@@ -310,9 +318,9 @@ LibPcdGetEx64 (
   Returns the pointer to the buffer of 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 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
   @retval VOID* Return the VOID* pointer.\r
 \r
@@ -329,9 +337,9 @@ LibPcdGetExPtr (
   Returns the Boolean value 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 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
   @retval BOOLEAN Return the BOOLEAN.\r
 \r
@@ -348,9 +356,9 @@ LibPcdGetExBool (
   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 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
   @retval UINTN Return the size.\r
 \r
@@ -367,8 +375,8 @@ LibPcdGetExSize (
   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
-  @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
   @retval UINT8 Return the value been set.\r
 \r
@@ -385,8 +393,8 @@ LibPcdSet8 (
   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
-  @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
   @retval UINT16 Return the value been set.\r
 \r
@@ -403,8 +411,8 @@ LibPcdSet16 (
   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
-  @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
   @retval UINT32 Return the value been set.\r
 \r
@@ -421,8 +429,8 @@ LibPcdSet32 (
   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
-  @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
   @retval UINT64 Return the value been set.\r
 \r
@@ -468,8 +476,8 @@ LibPcdSetPtr (
   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
-  @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
   @retval BOOLEAN Return the value been set.\r
 \r
@@ -487,10 +495,10 @@ LibPcdSetBool (
   Guid to the value specified by Value. Value is returned.\r
   If Guid 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]  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
   @retval UINT8 Return the value been set.\r
 \r
@@ -509,10 +517,10 @@ LibPcdSetEx8 (
   Guid to the value specified by Value. Value is returned.\r
   If Guid 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]  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
   @retval UINT8 Return the value been set.\r
 \r
@@ -531,10 +539,10 @@ LibPcdSetEx16 (
   Guid to the value specified by Value. Value is returned.\r
   If Guid 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]  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
   @retval UINT32 Return the value been set.\r
 \r
@@ -553,10 +561,10 @@ LibPcdSetEx32 (
   Guid to the value specified by Value. Value is returned.\r
   If Guid 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]  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
   @retval UINT64 Return the value been set.\r
 \r
@@ -581,11 +589,11 @@ LibPcdSetEx64 (
   If SizeOfValue is NULL, then ASSERT().\r
   If SizeOfValue > 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
-  @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
   @retval VOID * Return the pinter to the buffer been set.\r
 \r
@@ -605,10 +613,10 @@ LibPcdSetExPtr (
   Guid to the value specified by Value. Value is returned.\r
   If Guid 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]  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
   @retval Boolean Return the value been set.\r
 \r
@@ -641,8 +649,6 @@ LibPcdSetExBool (
   @param[in, out] TokenData       A pointer to the token data being set.\r
   @param[in]      TokenDataSize   The size, in bytes, of the data being set.\r
 \r
-  @retval VOID\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -660,14 +666,12 @@ VOID
   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
-              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
-  @retval VOID\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
@@ -682,12 +686,10 @@ LibPcdCallbackOnSet (
 /**\r
   Disable a notification function that was established with LibPcdCallbackonSet().\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
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -734,8 +736,8 @@ LibPcdGetNextToken (
 \r
 \r
   \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates from which namespace \r
-              to start the search.\r
+  @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
+                    to start the search.\r
 \r
   @retval CONST GUID *  The next valid token namespace.\r
 \r