]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiPcdLib/PeiPcdLib.c
1) correct the assert condition for LibPcdSetPtr and LibPcdSetExPtr
[mirror_edk2.git] / MdePkg / Library / PeiPcdLib / PeiPcdLib.c
index 8ef52055930cde23973a96194943b0c1faefec5b..4018e44f702b45514164bbbeb195bcf6dc5711f8 100644 (file)
@@ -61,10 +61,10 @@ GetPcdPpiPtr (
   @retval SKU_ID Return the SKU ID that just be set.\r
 \r
 **/\r
-SKU_ID\r
+UINTN\r
 EFIAPI\r
 LibPcdSetSku (\r
-  IN SKU_ID  SkuId\r
+  IN UINTN  SkuId\r
   )\r
 {\r
 \r
@@ -86,7 +86,7 @@ LibPcdSetSku (
 UINT8\r
 EFIAPI\r
 LibPcdGet8 (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -109,7 +109,7 @@ LibPcdGet8 (
 UINT16\r
 EFIAPI\r
 LibPcdGet16 (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI  *PcdPpi;\r
@@ -132,7 +132,7 @@ LibPcdGet16 (
 UINT32\r
 EFIAPI\r
 LibPcdGet32 (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -155,7 +155,7 @@ LibPcdGet32 (
 UINT64\r
 EFIAPI\r
 LibPcdGet64 (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -178,7 +178,7 @@ LibPcdGet64 (
 VOID *\r
 EFIAPI\r
 LibPcdGetPtr (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -201,7 +201,7 @@ LibPcdGetPtr (
 BOOLEAN \r
 EFIAPI\r
 LibPcdGetBool (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -224,7 +224,7 @@ LibPcdGetBool (
 UINTN\r
 EFIAPI\r
 LibPcdGetSize (\r
-  IN PCD_TOKEN_NUMBER             TokenNumber\r
+  IN UINTN                        TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -251,7 +251,7 @@ UINT8
 EFIAPI\r
 LibPcdGetEx8 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -278,7 +278,7 @@ UINT16
 EFIAPI\r
 LibPcdGetEx16 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -305,7 +305,7 @@ UINT32
 EFIAPI\r
 LibPcdGetEx32 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -333,7 +333,7 @@ UINT64
 EFIAPI\r
 LibPcdGetEx64 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -360,7 +360,7 @@ VOID *
 EFIAPI\r
 LibPcdGetExPtr (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -387,7 +387,7 @@ BOOLEAN
 EFIAPI\r
 LibPcdGetExBool (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -414,7 +414,7 @@ UINTN
 EFIAPI\r
 LibPcdGetExSize (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   PCD_PPI * PcdPpi;\r
@@ -439,7 +439,7 @@ LibPcdGetExSize (
 UINT8\r
 EFIAPI\r
 LibPcdSet8 (\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
   )\r
 {\r
@@ -471,7 +471,7 @@ LibPcdSet8 (
 UINT16\r
 EFIAPI\r
 LibPcdSet16 (\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT16            Value\r
   )\r
 {\r
@@ -503,7 +503,7 @@ LibPcdSet16 (
 UINT32\r
 EFIAPI\r
 LibPcdSet32 (\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT32             Value\r
   )\r
 {\r
@@ -534,7 +534,7 @@ LibPcdSet32 (
 UINT64\r
 EFIAPI\r
 LibPcdSet64 (\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT64             Value\r
   )\r
 {\r
@@ -555,10 +555,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,18 +577,29 @@ LibPcdSet64 (
 VOID *\r
 EFIAPI\r
 LibPcdSetPtr (\r
-  IN PCD_TOKEN_NUMBER  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
+  UINTN      Size;\r
 \r
-  PcdPpi = GetPcdPpiPtr ();\r
+  if (*SizeOfBuffer > 0) {\r
+    ASSERT (Buffer != NULL);\r
+  }\r
 \r
+  PcdPpi = GetPcdPpiPtr ();\r
+  \r
+  Size = LibPcdGetSize (TokenNumber);\r
+  \r
+  if (*SizeOfBuffer > Size) {\r
+    *SizeOfBuffer = Size;\r
+    return NULL;\r
+  }\r
 \r
-  Status = PcdPpi->SetPtr (TokenNumber, SizeOfBuffer, Buffer);\r
+  Status = PcdPpi->SetPtr (TokenNumber, *SizeOfBuffer, Buffer);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -600,7 +621,7 @@ LibPcdSetPtr (
 BOOLEAN\r
 EFIAPI\r
 LibPcdSetBool (\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
   )\r
 {\r
@@ -636,7 +657,7 @@ UINT8
 EFIAPI\r
 LibPcdSetEx8 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
   )\r
 {\r
@@ -672,7 +693,7 @@ UINT16
 EFIAPI\r
 LibPcdSetEx16 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT16            Value\r
   )\r
 {\r
@@ -708,7 +729,7 @@ UINT32
 EFIAPI\r
 LibPcdSetEx32 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT32             Value\r
   )\r
 {\r
@@ -744,7 +765,7 @@ UINT64
 EFIAPI\r
 LibPcdSetEx64 (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN UINT64            Value\r
   )\r
 {\r
@@ -764,34 +785,49 @@ 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 PCD_TOKEN_NUMBER  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
+  EFI_STATUS      Status;\r
+  PCD_PPI         *PcdPpi;\r
+  UINTN           Size;\r
+\r
+  if (*SizeOfBuffer > 0) {\r
+    ASSERT (Buffer != NULL);\r
+  }\r
 \r
   PcdPpi = GetPcdPpiPtr ();\r
 \r
-  Status = PcdPpi->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+  Size = LibPcdGetExSize (Guid, TokenNumber);\r
+  if (*SizeOfBuffer > Size) {\r
+    *SizeOfBuffer = Size;\r
+    return NULL;\r
+  }\r
+\r
+  Status = PcdPpi->SetPtrEx (Guid, TokenNumber, *SizeOfBuffer, Buffer);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -817,7 +853,7 @@ BOOLEAN
 EFIAPI\r
 LibPcdSetExBool (\r
   IN CONST GUID        *Guid,\r
-  IN PCD_TOKEN_NUMBER  TokenNumber,\r
+  IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
   )\r
 {\r
@@ -856,7 +892,7 @@ VOID
 EFIAPI\r
 LibPcdCallbackOnSet (\r
   IN CONST GUID               *Guid,       OPTIONAL\r
-  IN PCD_TOKEN_NUMBER         TokenNumber,\r
+  IN UINTN                    TokenNumber,\r
   IN PCD_CALLBACK             NotificationFunction\r
   )\r
 {\r
@@ -890,7 +926,7 @@ VOID
 EFIAPI\r
 LibPcdCancelCallback (\r
   IN CONST GUID               *Guid,       OPTIONAL\r
-  IN PCD_TOKEN_NUMBER         TokenNumber,\r
+  IN UINTN                    TokenNumber,\r
   IN PCD_CALLBACK             NotificationFunction\r
   )\r
 {\r
@@ -922,14 +958,14 @@ LibPcdCancelCallback (
   @param[in]  The previous PCD token number.  If 0, then retrieves the first PCD \r
               token number.\r
 \r
-  @retval PCD_TOKEN_NUMBER The next valid token number.\r
+  @retval UINTN            The next valid token number.\r
 \r
 **/\r
-PCD_TOKEN_NUMBER           \r
+UINTN                      \r
 EFIAPI\r
 LibPcdGetNextToken (\r
   IN CONST GUID             *Guid, OPTIONAL\r
-  IN       PCD_TOKEN_NUMBER TokenNumber\r
+  IN       UINTN            TokenNumber\r
   )\r
 {\r
   EFI_STATUS Status;\r
@@ -944,3 +980,41 @@ 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
+CONST 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;\r
+}\r
+\r