]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiPcdLib/PeiPcdLib.c
Fix function comment to follows doxygen format.
[mirror_edk2.git] / MdePkg / Library / PeiPcdLib / PeiPcdLib.c
index 57fa8211562240f0d2c63a8bd2bb60be1ca1173c..1695ca561d0fd76d887e12d3e76771d9c73a3d70 100644 (file)
@@ -11,17 +11,24 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
 \r
-Module Name: PeiPcdLib.c\r
-\r
 **/\r
 \r
 \r
 \r
+\r
+#include <PiPei.h>\r
+\r
+#include <Ppi/Pcd.h>\r
+\r
+#include <Library/PeiServicesLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PeiServicesTablePointerLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+\r
 /**\r
   The constructor function retrieve the PCD_PPI pointer.\r
 \r
-  @param[in] VOID\r
-  \r
   @retval PCD_PPI * The pointer to the PCD_PPI.\r
 \r
 **/\r
@@ -32,26 +39,13 @@ GetPcdPpiPtr (
 {\r
   EFI_STATUS        Status;\r
   PCD_PPI           *PcdPpi;\r
-  EFI_PEI_SERVICES  **PeiServices;\r
-\r
-\r
-  PeiServices = GetPeiServicesTablePointer ();\r
-\r
-  Status = (**PeiServices).LocatePpi (\r
-                             PeiServices,\r
-                             &gPcdPpiGuid,\r
-                             0,\r
-                             NULL,\r
-                             (VOID **)&PcdPpi\r
-                             );\r
-\r
+  \r
+  Status = PeiServicesLocatePpi (&gPcdPpiGuid, 0, NULL, (VOID **)&PcdPpi);\r
   ASSERT_EFI_ERROR (Status);\r
 \r
   return PcdPpi;\r
 }\r
 \r
-\r
-\r
 /**\r
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.\r
 \r
@@ -80,7 +74,7 @@ LibPcdSetSku (
 /**\r
   Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
@@ -103,7 +97,7 @@ LibPcdGet8 (
 /**\r
   Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
@@ -258,6 +252,8 @@ LibPcdGetEx8 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get8Ex (Guid, TokenNumber);\r
@@ -285,6 +281,8 @@ LibPcdGetEx16 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get16Ex (Guid, TokenNumber);\r
@@ -312,6 +310,8 @@ LibPcdGetEx32 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get32Ex (Guid, TokenNumber);\r
@@ -340,6 +340,8 @@ LibPcdGetEx64 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get64Ex (Guid, TokenNumber);\r
@@ -367,6 +369,8 @@ LibPcdGetExPtr (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetPtrEx (Guid, TokenNumber);\r
@@ -394,6 +398,8 @@ LibPcdGetExBool (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetBoolEx (Guid, TokenNumber);\r
@@ -421,6 +427,8 @@ LibPcdGetExSize (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetSizeEx (Guid, TokenNumber);\r
@@ -450,7 +458,6 @@ LibPcdSet8 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set8 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -482,7 +489,6 @@ LibPcdSet16 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set16 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -545,7 +551,6 @@ LibPcdSet64 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set64 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -569,9 +574,9 @@ LibPcdSet64 (
   \r
   If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
   \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]  Value A pointer to the buffer to set.\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 pointer for the buffer been set.\r
 \r
@@ -586,7 +591,6 @@ LibPcdSetPtr (
 {\r
   EFI_STATUS Status;\r
   PCD_PPI    *PcdPpi;\r
-  UINTN      Size;\r
 \r
   ASSERT (SizeOfBuffer != NULL);\r
 \r
@@ -596,17 +600,12 @@ LibPcdSetPtr (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
   \r
-  Size = LibPcdGetSize (TokenNumber);\r
-  \r
-  if (*SizeOfBuffer > Size) {\r
-    *SizeOfBuffer = Size;\r
+  Status = PcdPpi->SetPtr (TokenNumber, SizeOfBuffer, Buffer);\r
+\r
+  if (EFI_ERROR (Status)) {\r
     return NULL;\r
   }\r
 \r
-  Status = PcdPpi->SetPtr (TokenNumber, *SizeOfBuffer, Buffer);\r
-\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
   return Buffer;\r
 }\r
 \r
@@ -634,7 +633,6 @@ LibPcdSetBool (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->SetBool (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -670,6 +668,7 @@ LibPcdSetEx8 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
+  ASSERT (Guid != NULL);\r
 \r
   Status = PcdPpi->Set8Ex (Guid, TokenNumber, Value);\r
 \r
@@ -706,7 +705,7 @@ LibPcdSetEx16 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
+  ASSERT (Guid != NULL);\r
   Status = PcdPpi->Set16Ex (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -739,7 +738,7 @@ LibPcdSetEx32 (
 {\r
   EFI_STATUS Status;\r
   PCD_PPI * PcdPpi;\r
-\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
@@ -775,7 +774,7 @@ LibPcdSetEx64 (
 {\r
   EFI_STATUS Status;\r
   PCD_PPI * PcdPpi;\r
-\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
@@ -817,24 +816,19 @@ LibPcdSetExPtr (
 {\r
   EFI_STATUS      Status;\r
   PCD_PPI         *PcdPpi;\r
-  UINTN           Size;\r
-\r
+ ASSERT (SizeOfBuffer != NULL);\r
   if (*SizeOfBuffer > 0) {\r
     ASSERT (Buffer != NULL);\r
   }\r
-\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-  Size = LibPcdGetExSize (Guid, TokenNumber);\r
-  if (*SizeOfBuffer > Size) {\r
-    *SizeOfBuffer = Size;\r
+  Status = PcdPpi->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+\r
+  if (EFI_ERROR (Status)) {\r
     return NULL;\r
   }\r
 \r
-  Status = PcdPpi->SetPtrEx (Guid, TokenNumber, *SizeOfBuffer, Buffer);\r
-\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
   return Buffer;\r
 }\r
 \r
@@ -866,7 +860,7 @@ LibPcdSetExBool (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
+  ASSERT (Guid != NULL);\r
   Status = PcdPpi->SetBoolEx (Guid, TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -906,7 +900,7 @@ LibPcdCallbackOnSet (
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
-  Status = PcdPpi->CallbackOnSet (TokenNumber, Guid, NotificationFunction);\r
+  Status = PcdPpi->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -940,7 +934,7 @@ LibPcdCancelCallback (
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
-  Status = PcdPpi->CancelCallback (TokenNumber, Guid, NotificationFunction);\r
+  Status = PcdPpi->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -957,10 +951,10 @@ LibPcdCancelCallback (
   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and \r
   is not in the token space specified by Guid, then ASSERT().\r
 \r
-  @param[in]  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]  The previous PCD token number.  If 0, then retrieves the first PCD \r
-              token number.\r
+  @param[in]  Guid          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
 \r
   @retval UINTN            The next valid token number.\r
 \r
@@ -997,8 +991,8 @@ LibPcdGetNextToken (
 \r
 \r
   \r
-  @param[in]  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
@@ -1022,3 +1016,52 @@ LibPcdGetNextTokenSpace (
   return (GUID *)Guid;\r
 }\r
 \r
+\r
+\r
+/**\r
+  Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
+  and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than \r
+  MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \r
+  NULL to indicate that the set operation was not actually performed.  \r
+  If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \r
+  MaximumDatumSize and NULL must be returned.\r
+  \r
+  If PatchVariable is NULL, then ASSERT().\r
+  If SizeOfValue is NULL, then ASSERT().\r
+  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+\r
+  @param[in] PatchVariable      A pointer to the global variable in a module that is \r
+                                the target of the set operation.\r
+  @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.\r
+  @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\r
+  @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtr (\r
+  IN        VOID        *PatchVariable,\r
+  IN        UINTN       MaximumDatumSize,\r
+  IN OUT    UINTN       *SizeOfBuffer,\r
+  IN CONST  VOID        *Buffer\r
+  )\r
+{\r
+  ASSERT (PatchVariable != NULL);\r
+  ASSERT (SizeOfBuffer  != NULL);\r
+  \r
+  if (*SizeOfBuffer > 0) {\r
+    ASSERT (Buffer != NULL);\r
+  }\r
+\r
+  if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+      (*SizeOfBuffer == MAX_ADDRESS)) {\r
+    *SizeOfBuffer = MaximumDatumSize;\r
+    return NULL;\r
+  }\r
+    \r
+  CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+  \r
+  return (VOID *) Buffer;\r
+}\r
+\r
+\r