MdePkg and MdeModulePkg Pcd: Implement PCD Driver for External PCD Database and SKU...

[mirror_edk2.git] / MdePkg / Library / PeiPcdLib / PeiPcdLib.c

diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
index 057a95716559ed5797bf7492e768b1b76b01c2b8..0a7efdb44ec2160ff628985ff6cd06cef53c4091 100644 (file)
--- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
+++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
@@ -1,8 +1,8 @@
 /** @file\r
 Implementation of PcdLib class library for PEI phase.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials                          \r
+Copyright (c) 2006 - 2013, 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
 http://opensource.org/licenses/bsd-license.php                                            \r
@@ -78,8 +78,8 @@ GetPiPcdPpiPointer (
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.\r
   If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
 \r
-  @param  SkuId   The SKU value that will be used when the PCD service retrieves and sets values\r
-                  associated with a PCD token.\r
+  @param  SkuId   The SKU value that will be used when the PCD service retrieves \r
+                  and sets values associated with a PCD token.\r
 \r
   @return  Return the SKU ID that just be set.\r
 \r
@@ -252,7 +252,7 @@ LibPcdGetSize (
   \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         The 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
@@ -268,7 +268,7 @@ LibPcdGetEx8 (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPiPcdPpiPointer ())->GetEx8 (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get8 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -280,7 +280,7 @@ LibPcdGetEx8 (
   \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         The 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
@@ -297,7 +297,7 @@ LibPcdGetEx16 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPiPcdPpiPointer ())->GetEx16 (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get16 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -306,7 +306,7 @@ LibPcdGetEx16 (
   Returns the 32-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
+  @param[in]  Guid         The 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
@@ -322,7 +322,7 @@ LibPcdGetEx32 (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPiPcdPpiPointer ())->GetEx32 (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get32 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -335,7 +335,7 @@ LibPcdGetEx32 (
   \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          The 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
@@ -350,7 +350,7 @@ LibPcdGetEx64 (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPiPcdPpiPointer ())->GetEx64 (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get64 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -362,7 +362,7 @@ LibPcdGetEx64 (
   \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          The 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
@@ -378,7 +378,7 @@ LibPcdGetExPtr (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPiPcdPpiPointer ())->GetExPtr (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetPtr (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -390,7 +390,7 @@ LibPcdGetExPtr (
   \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          The 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
@@ -405,7 +405,7 @@ LibPcdGetExBool (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPiPcdPpiPointer ())->GetExBool (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetBool (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -417,7 +417,7 @@ LibPcdGetExBool (
   \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          The 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
@@ -432,7 +432,7 @@ LibPcdGetExSize (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPiPcdPpiPointer ())->GetExSize (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetSize (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -446,7 +446,7 @@ LibPcdGetExSize (
   @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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -476,7 +476,7 @@ LibPcdSet8 (
   @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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -506,7 +506,7 @@ LibPcdSet16 (
   @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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -536,7 +536,7 @@ LibPcdSet32 (
   @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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -615,7 +615,7 @@ LibPcdSetPtr (
   @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
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -644,12 +644,12 @@ LibPcdSetBool (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The 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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -664,7 +664,7 @@ LibPcdSetEx8 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPiPcdPpiPointer ())->SetEx8 (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -681,12 +681,12 @@ LibPcdSetEx8 (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The 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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -699,7 +699,7 @@ LibPcdSetEx16 (
 {\r
   EFI_STATUS Status;\r
   ASSERT (Guid != NULL);\r
-  Status = (GetPiPcdPpiPointer ())->SetEx16 (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -716,12 +716,12 @@ LibPcdSetEx16 (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The 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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -736,7 +736,7 @@ LibPcdSetEx32 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPiPcdPpiPointer ())->SetEx32 (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -752,12 +752,12 @@ 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
+  @param[in]  Guid          The 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
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -771,7 +771,7 @@ LibPcdSetEx64 (
   EFI_STATUS Status;\r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPiPcdPpiPointer ())->SetEx64 (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -793,7 +793,7 @@ LibPcdSetEx64 (
   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
+  @param[in]  Guid              The 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
@@ -818,7 +818,7 @@ LibPcdSetExPtr (
   }\r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPiPcdPpiPointer ())->SetExPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+  Status = (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
 \r
   if (EFI_ERROR (Status)) {\r
     return NULL;\r
@@ -837,12 +837,12 @@ LibPcdSetExPtr (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The 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
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -856,7 +856,7 @@ LibPcdSetExBool (
   EFI_STATUS Status;\r
 \r
   ASSERT (Guid != NULL);\r
-  Status = (GetPiPcdPpiPointer ())->SetExBool (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -873,9 +873,9 @@ LibPcdSetExBool (
   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]  Guid                  The pointer to a 128-bit unique value that \r
+                                    designates which namespace to set a value from.  \r
+                                    If NULL, then the default 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
@@ -947,7 +947,7 @@ LibPcdCancelCallback (
   \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        The 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
@@ -962,11 +962,7 @@ LibPcdGetNextToken (
   IN UINTN                    TokenNumber\r
   )\r
 {\r
-  EFI_STATUS Status;\r
-\r
-  Status = (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
-\r
-  ASSERT_EFI_ERROR (Status);\r
+  (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
 \r
   return TokenNumber;\r
 }\r
@@ -980,7 +976,7 @@ LibPcdGetNextToken (
   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
-  @param  TokenSpaceGuid  Pointer to the a PCD token space GUID\r
+  @param  TokenSpaceGuid  The pointer to the a PCD token space GUID\r
 \r
   @return The next valid token namespace.\r
 \r
@@ -991,11 +987,7 @@ LibPcdGetNextTokenSpace (
   IN CONST GUID  *TokenSpaceGuid\r
   )\r
 {\r
-  EFI_STATUS Status;\r
-\r
-  Status = (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
-\r
-  ASSERT_EFI_ERROR (Status);\r
+  (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
 \r
   return (GUID *) TokenSpaceGuid;\r
 }\r