]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiPcdLib/PeiPcdLib.c
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Library / PeiPcdLib / PeiPcdLib.c
index 7bbb0f8039b208794df850f1711fe46f44111ea8..c81c03e392c5523b404d214250a221aebea8779d 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
 Implementation of PcdLib class library for PEI phase.\r
 \r
-Copyright (c) 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials                          \r
+Copyright (c) 2006 - 2010, 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
@@ -19,6 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <PiPei.h>\r
 \r
 #include <Ppi/Pcd.h>\r
+#include <Ppi/PiPcd.h>\r
 \r
 #include <Library/PeiServicesLib.h>\r
 #include <Library/PcdLib.h>\r
@@ -48,17 +49,39 @@ GetPcdPpiPointer (
   return PcdPpi;\r
 }\r
 \r
+/**\r
+  Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3.\r
+\r
+  This function is to locate EFI_PEI_PCD_PPI PPI via PeiService. \r
+  If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR().\r
+  \r
+  @retval EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI.\r
+\r
+**/\r
+EFI_PEI_PCD_PPI *\r
+GetPiPcdPpiPointer (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS        Status;\r
+  EFI_PEI_PCD_PPI   *PiPcdPpi;\r
+  \r
+  Status = PeiServicesLocatePpi (&gEfiPeiPcdPpiGuid, 0, NULL, (VOID **)&PiPcdPpi);\r
+  ASSERT_EFI_ERROR (Status);\r
+  \r
+  return PiPcdPpi;\r
+}  \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 >= PCD_MAX_SKU_ID, then ASSERT(). \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
+  @param  SkuId   The SKU value that will be used when the PCD service retrieves and sets values\r
+                  associated with a PCD token.\r
 \r
-  @return Return the SKU ID that just be set.\r
+  @return  Return the SKU ID that just be set.\r
 \r
 **/\r
 UINTN\r
@@ -70,8 +93,8 @@ LibPcdSetSku (
 \r
   ASSERT (SkuId < PCD_MAX_SKU_ID);\r
 \r
-  GetPcdPpiPointer()->SetSku (SkuId);\r
-\r
+  GetPiPcdPpiPointer()->SetSku (SkuId);\r
+  \r
   return SkuId;\r
 }\r
 \r
@@ -229,9 +252,9 @@ LibPcdGetSize (
   \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 UINT8.\r
 \r
@@ -245,7 +268,7 @@ LibPcdGetEx8 (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPcdPpiPointer ())->Get8Ex (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get8 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -257,9 +280,9 @@ LibPcdGetEx8 (
   \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 UINT16.\r
 \r
@@ -274,7 +297,7 @@ LibPcdGetEx16 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPcdPpiPointer ())->Get16Ex (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get16 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -283,9 +306,9 @@ 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
-              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 UINT32.\r
 \r
@@ -299,7 +322,7 @@ LibPcdGetEx32 (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPcdPpiPointer ())->Get32Ex (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get32 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -327,7 +350,7 @@ LibPcdGetEx64 (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPcdPpiPointer ())->Get64Ex (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->Get64 (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -355,7 +378,7 @@ LibPcdGetExPtr (
 {\r
   ASSERT (Guid != NULL);\r
 \r
-  return (GetPcdPpiPointer ())->GetPtrEx (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetPtr (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -382,7 +405,7 @@ LibPcdGetExBool (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPcdPpiPointer ())->GetBoolEx (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetBool (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -409,7 +432,7 @@ LibPcdGetExSize (
   )\r
 {\r
   ASSERT (Guid != NULL);\r
-  return (GetPcdPpiPointer ())->GetSizeEx (Guid, TokenNumber);\r
+  return (GetPiPcdPpiPointer ())->GetSize (Guid, TokenNumber);\r
 }\r
 \r
 \r
@@ -641,7 +664,7 @@ LibPcdSetEx8 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPcdPpiPointer ())->Set8Ex (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -676,7 +699,7 @@ LibPcdSetEx16 (
 {\r
   EFI_STATUS Status;\r
   ASSERT (Guid != NULL);\r
-  Status = (GetPcdPpiPointer ())->Set16Ex (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -713,7 +736,7 @@ LibPcdSetEx32 (
 \r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPcdPpiPointer ())->Set32Ex (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -748,7 +771,7 @@ LibPcdSetEx64 (
   EFI_STATUS Status;\r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPcdPpiPointer ())->Set64Ex (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -795,7 +818,7 @@ LibPcdSetExPtr (
   }\r
   ASSERT (Guid != NULL);\r
 \r
-  Status = (GetPcdPpiPointer ())->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+  Status = (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
 \r
   if (EFI_ERROR (Status)) {\r
     return NULL;\r
@@ -833,7 +856,7 @@ LibPcdSetExBool (
   EFI_STATUS Status;\r
 \r
   ASSERT (Guid != NULL);\r
-  Status = (GetPcdPpiPointer ())->SetBoolEx (Guid, TokenNumber, Value);\r
+  Status = (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -847,14 +870,13 @@ LibPcdSetExBool (
   \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 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]  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
@@ -869,7 +891,9 @@ LibPcdCallbackOnSet (
 {\r
   EFI_STATUS Status;\r
 \r
-  Status = (GetPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
+  ASSERT (NotificationFunction != NULL);\r
+\r
+  Status = (GetPiPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -881,14 +905,13 @@ LibPcdCallbackOnSet (
 /**\r
   Disable a notification function that was established with LibPcdCallbackonSet().\r
   \r
-  Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
-  \r
+  Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
   If NotificationFunction is NULL, then ASSERT().\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
@@ -902,7 +925,9 @@ LibPcdCancelCallback (
 {\r
   EFI_STATUS Status;\r
 \r
-  Status = (GetPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
+  ASSERT (NotificationFunction != NULL);\r
+\r
+  Status = (GetPiPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -939,7 +964,7 @@ LibPcdGetNextToken (
 {\r
   EFI_STATUS Status;\r
 \r
-  Status = (GetPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
+  Status = (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -950,23 +975,17 @@ LibPcdGetNextToken (
 /**\r
   Used to retrieve the list of available PCD token space GUIDs.\r
   \r
-  Retrieves the next PCD token space from a token space specified by Guid.\r
-  Guid of NULL is reserved to mark the default local token namespace on the current\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
-\r
-  If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
+  Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+  in the platform.\r
+  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[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
-                    to start the search.\r
+  @param  TokenSpaceGuid  Pointer to the a PCD token space GUID\r
 \r
   @return The next valid token namespace.\r
 \r
 **/\r
-GUID *           \r
+GUID *\r
 EFIAPI\r
 LibPcdGetNextTokenSpace (\r
   IN CONST GUID  *TokenSpaceGuid\r
@@ -974,7 +993,7 @@ LibPcdGetNextTokenSpace (
 {\r
   EFI_STATUS Status;\r
 \r
-  Status = (GetPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
+  Status = (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r