]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePcdLibNull/PcdLib.c
1) Add in support to traverse taken space
[mirror_edk2.git] / MdePkg / Library / BasePcdLibNull / PcdLib.c
index 6c01017024b84103760450c084f1e8b21ef5c252..832100758fc1516f9917ebd61941517ded1b7908 100644 (file)
   @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
-  @retval UINTN Return the SKU ID that just be set.\r
+  @retval SKU_ID Return the SKU ID that just be set.\r
 \r
 **/\r
-UINTN\r
+UINTN           \r
 EFIAPI\r
 LibPcdSetSku (\r
   IN UINTN  SkuId\r
@@ -47,7 +47,7 @@ LibPcdSetSku (
 UINT8\r
 EFIAPI\r
 LibPcdGet8 (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -66,7 +66,7 @@ LibPcdGet8 (
 UINT16\r
 EFIAPI\r
 LibPcdGet16 (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -85,7 +85,7 @@ LibPcdGet16 (
 UINT32\r
 EFIAPI\r
 LibPcdGet32 (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -104,7 +104,7 @@ LibPcdGet32 (
 UINT64\r
 EFIAPI\r
 LibPcdGet64 (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -123,7 +123,7 @@ LibPcdGet64 (
 VOID *\r
 EFIAPI\r
 LibPcdGetPtr (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -142,7 +142,7 @@ LibPcdGetPtr (
 BOOLEAN \r
 EFIAPI\r
 LibPcdGetBool (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -161,7 +161,7 @@ LibPcdGetBool (
 UINTN\r
 EFIAPI\r
 LibPcdGetSize (\r
-  IN UINTN  TokenNumber\r
+  IN UINTN             TokenNumber\r
   )\r
 {\r
   return 0;\r
@@ -434,10 +434,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
@@ -446,15 +456,14 @@ LibPcdSet64 (
 VOID *\r
 EFIAPI\r
 LibPcdSetPtr (\r
-  IN UINTN             TokenNumber,\r
-  IN CONST VOID        *Value\r
+  IN      UINTN             TokenNumber,\r
+  IN OUT  UINTN             *SizeOfBuffer,\r
+  IN      VOID              *Buffer\r
   )\r
 {\r
-  ASSERT (Value != NULL);\r
-  //\r
-  // Remove the CONST\r
-  //\r
-  return (VOID *)Value;\r
+  ASSERT (Buffer != NULL);\r
+\r
+  return Buffer;\r
 }\r
 \r
 \r
@@ -594,34 +603,36 @@ 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 CONST VOID        *Value\r
+  IN      CONST GUID        *Guid,\r
+  IN      UINTN             TokenNumber,\r
+  IN OUT  UINTN             *SizeOfBuffer,\r
+  IN      VOID              *Buffer\r
   )\r
 {\r
-  //\r
-  // Remove the CONST\r
-  //\r
   ASSERT (Guid != NULL);\r
-  ASSERT (Value != NULL);\r
+  ASSERT (Buffer != NULL);\r
 \r
-  return (VOID *)Value;\r
+  return Buffer;\r
 }\r
 \r
 \r
@@ -720,15 +731,43 @@ LibPcdCancelCallback (
   @param[in]  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
+  @retval UINTN            The next valid token number.\r
 \r
 **/\r
-UINTN\r
+UINTN           \r
 EFIAPI\r
 LibPcdGetNextToken (\r
-  IN CONST GUID             *Guid, OPTIONAL\r
-  IN OUT UINTN              *TokenNumber\r
+  IN CONST GUID               *Guid, OPTIONAL\r
+  IN       UINTN              TokenNumber\r
   )\r
 {\r
   return 0;\r
 }\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
+  return NULL;\r
+}\r