]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiPcdLib/PeiPcdLib.c
Checked in part of MDE library instances following PI and UEFI. It includes:
[mirror_edk2.git] / MdePkg / Library / PeiPcdLib / PeiPcdLib.c
index fca14af8684f3bbba5cb59fa2f5fa4f88e074d36..f686d4e8656505f2e81571fbde4b8479e76bd734 100644 (file)
@@ -17,6 +17,22 @@ Module Name: PeiPcdLib.c
 \r
 \r
 \r
+//\r
+// The package level header files this module uses\r
+//\r
+#include <PiPei.h>\r
+//\r
+// The protocols, PPI and GUID defintions for this module\r
+//\r
+#include <Ppi/Pcd.h>\r
+//\r
+// The Library classes this module consumes\r
+//\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
@@ -25,6 +41,7 @@ Module Name: PeiPcdLib.c
   @retval PCD_PPI * The pointer to the PCD_PPI.\r
 \r
 **/\r
+STATIC\r
 PCD_PPI  *\r
 GetPcdPpiPtr (\r
   VOID\r
@@ -68,6 +85,8 @@ LibPcdSetSku (
   )\r
 {\r
 \r
+  ASSERT (SkuId < 0x100);\r
+\r
   GetPcdPpiPtr()->SetSku (SkuId);;\r
 \r
   return SkuId;\r
@@ -256,6 +275,8 @@ LibPcdGetEx8 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get8Ex (Guid, TokenNumber);\r
@@ -283,6 +304,8 @@ LibPcdGetEx16 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get16Ex (Guid, TokenNumber);\r
@@ -310,6 +333,8 @@ LibPcdGetEx32 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get32Ex (Guid, TokenNumber);\r
@@ -338,6 +363,8 @@ LibPcdGetEx64 (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->Get64Ex (Guid, TokenNumber);\r
@@ -365,6 +392,8 @@ LibPcdGetExPtr (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetPtrEx (Guid, TokenNumber);\r
@@ -392,6 +421,8 @@ LibPcdGetExBool (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetBoolEx (Guid, TokenNumber);\r
@@ -419,6 +450,8 @@ LibPcdGetExSize (
 {\r
   PCD_PPI * PcdPpi;\r
 \r
+  ASSERT (Guid != NULL);\r
+\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   return PcdPpi->GetSizeEx (Guid, TokenNumber);\r
@@ -448,7 +481,6 @@ LibPcdSet8 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set8 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -480,7 +512,6 @@ LibPcdSet16 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set16 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -543,7 +574,6 @@ LibPcdSet64 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->Set64 (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -555,10 +585,20 @@ LibPcdSet64 (
 \r
 /**\r
   Sets a buffer for the token specified by TokenNumber to \r
-  the value specified by Value. Value is returned.\r
-  If Value is NULL, then ASSERT().\r
+  the value specified by Buffer and SizeOfValue.  Buffer to\r
+  be set is returned. The content of the buffer could be \r
+  overwritten if a Callback on SET is registered with this\r
+  TokenNumber.\r
+  \r
+  If SizeOfValue is greater than the maximum \r
+  size support by TokenNumber, then set SizeOfValue to the \r
+  maximum size supported by TokenNumber and return NULL to \r
+  indicate that the set operation was not actually performed. \r
+  \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
 \r
   @retval VOID* Return the pointer for the buffer been set.\r
@@ -567,20 +607,27 @@ LibPcdSet64 (
 VOID *\r
 EFIAPI\r
 LibPcdSetPtr (\r
-  IN UINTN             TokenNumber,\r
-  IN UINTN             SizeOfBuffer,\r
-  IN VOID              *Buffer\r
+  IN      UINTN             TokenNumber,\r
+  IN OUT  UINTN             *SizeOfBuffer,\r
+  IN      VOID              *Buffer\r
   )\r
 {\r
   EFI_STATUS Status;\r
-  PCD_PPI PcdPpi;\r
+  PCD_PPI    *PcdPpi;\r
 \r
-  PcdPpi = GetPcdPpiPtr ();\r
+  ASSERT (SizeOfBuffer != NULL);\r
 \r
+  if (*SizeOfBuffer > 0) {\r
+    ASSERT (Buffer != NULL);\r
+  }\r
 \r
+  PcdPpi = GetPcdPpiPtr ();\r
+  \r
   Status = PcdPpi->SetPtr (TokenNumber, SizeOfBuffer, Buffer);\r
 \r
-  ASSERT_EFI_ERROR (Status);\r
+  if (EFI_ERROR (Status)) {\r
+    return NULL;\r
+  }\r
 \r
   return Buffer;\r
 }\r
@@ -609,7 +656,6 @@ LibPcdSetBool (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-\r
   Status = PcdPpi->SetBool (TokenNumber, Value);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
@@ -645,6 +691,7 @@ LibPcdSetEx8 (
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
+  ASSERT (Guid != NULL);\r
 \r
   Status = PcdPpi->Set8Ex (Guid, TokenNumber, Value);\r
 \r
@@ -681,7 +728,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
@@ -714,7 +761,7 @@ LibPcdSetEx32 (
 {\r
   EFI_STATUS Status;\r
   PCD_PPI * PcdPpi;\r
-\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
@@ -750,7 +797,7 @@ LibPcdSetEx64 (
 {\r
   EFI_STATUS Status;\r
   PCD_PPI * PcdPpi;\r
-\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
@@ -764,36 +811,46 @@ LibPcdSetEx64 (
 \r
 \r
 /**\r
-  Sets a buffer for the token specified by TokenNumber and \r
-  Guid to the value specified by Value. Value is returned.\r
-  If Guid is NULL, then ASSERT().\r
-  If Value is NULL, then ASSERT().\r
+  Sets a buffer for the token specified by TokenNumber to the value specified by \r
+  Buffer and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than \r
+  the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
+  supported by TokenNumber and return NULL to indicate that the set operation \r
+  was not actually performed. \r
+  \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]  Value The 8-bit value to set.\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 value been set.\r
+  @retval VOID * Return the pinter to the buffer been set.\r
 \r
 **/\r
 VOID *\r
 EFIAPI\r
 LibPcdSetExPtr (\r
-  IN CONST GUID        *Guid,\r
-  IN UINTN             TokenNumber,\r
-  IN UINTN             SizeOfBuffer,\r
-  IN VOID              *Buffer\r
+  IN      CONST GUID        *Guid,\r
+  IN      UINTN             TokenNumber,\r
+  IN OUT  UINTN             *SizeOfBuffer,\r
+  IN      VOID              *Buffer\r
   )\r
 {\r
-  EFI_STATUS Status;\r
-  PCD_PPI * PcdPpi;\r
-\r
+  EFI_STATUS      Status;\r
+  PCD_PPI         *PcdPpi;\r
+ ASSERT (SizeOfBuffer != NULL);\r
+  if (*SizeOfBuffer > 0) {\r
+    ASSERT (Buffer != NULL);\r
+  }\r
+  ASSERT (Guid != NULL);\r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
   Status = PcdPpi->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
 \r
-  ASSERT_EFI_ERROR (Status);\r
+  if (EFI_ERROR (Status)) {\r
+    return NULL;\r
+  }\r
 \r
   return Buffer;\r
 }\r
@@ -826,7 +883,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
@@ -866,7 +923,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
@@ -900,7 +957,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
@@ -944,3 +1001,90 @@ LibPcdGetNextToken (
 \r
   return TokenNumber;\r
 }\r
+\r
+\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
+  \r
+  @param[in]  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
+**/\r
+GUID *           \r
+EFIAPI\r
+LibPcdGetNextTokenSpace (\r
+  IN CONST GUID  *Guid\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+  PCD_PPI * PcdPpi;\r
+\r
+  PcdPpi = GetPcdPpiPtr ();\r
+\r
+\r
+  Status = PcdPpi->GetNextTokenSpace (&Guid);\r
+\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  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