MdePkg: Add two PcdApi for Patch VOID* PCD set operation.

Two new APIs LibPatchPcdSetPtrAndSize() and LibPatchPcdSetPtrAndSizeS()
are added to catch the size of the updated VOID* PCD value buffer, then
PcdGetSize() API can return the actual size.

Update three PcdLib instances to implement these two APIs.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18269 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 115 insertions, 4 deletions

diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
index 3d7139682a..53e8ad6c00 100644
--- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
+++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
@@ -1363,7 +1363,7 @@ LibPcdGetNextTokenSpace (
   If SizeOfBuffer is NULL, then ASSERT().

   If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

 

-  @param[in] PatchVariable      A pointer to the global variable in a module that is 

+  @param[out] PatchVariable     A pointer to the global variable in a module that is 

                                 the target of the set operation.

   @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.

   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.

@@ -1375,7 +1375,7 @@ LibPcdGetNextTokenSpace (
 VOID *

 EFIAPI

 LibPatchPcdSetPtr (

-  IN        VOID        *PatchVariable,

+  OUT       VOID        *PatchVariable,

   IN        UINTN       MaximumDatumSize,

   IN OUT    UINTN       *SizeOfBuffer,

   IN CONST  VOID        *Buffer

@@ -1413,7 +1413,7 @@ LibPatchPcdSetPtr (
   If SizeOfBuffer is NULL, then ASSERT().

   If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

 

-  @param[in] PatchVariable      A pointer to the global variable in a module that is

+  @param[out] PatchVariable     A pointer to the global variable in a module that is

                                 the target of the set operation.

   @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.

   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.

@@ -1425,7 +1425,7 @@ LibPatchPcdSetPtr (
 RETURN_STATUS

 EFIAPI

 LibPatchPcdSetPtrS (

-  IN       VOID     *PatchVariable,

+  OUT      VOID     *PatchVariable,

   IN       UINTN    MaximumDatumSize,

   IN OUT   UINTN    *SizeOfBuffer,

   IN CONST VOID     *Buffer

@@ -1449,6 +1449,117 @@ LibPatchPcdSetPtrS (
   return RETURN_SUCCESS;

 }

 

+

+/**

+  Sets a value and size of a patchable PCD entry that is type pointer.

+  

+  Sets the PCD entry specified by PatchVariable to the value specified by Buffer 

+  and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than 

+  MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return 

+  NULL to indicate that the set operation was not actually performed.  

+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to 

+  MaximumDatumSize and NULL must be returned.

+  

+  If PatchVariable is NULL, then ASSERT().

+  If SizeOfPatchVariable is NULL, then ASSERT().

+  If SizeOfBuffer is NULL, then ASSERT().

+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

+

+  @param[out] PatchVariable     A pointer to the global variable in a module that is 

+                                the target of the set operation.

+  @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.

+  @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.

+  @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.

+  @param[in] Buffer             A pointer to the buffer to used to set the target variable.

+  

+  @return Return the pointer to the buffer been set.

+

+**/

+VOID *

+EFIAPI

+LibPatchPcdSetPtrAndSize (

+  OUT       VOID        *PatchVariable,

+  OUT       UINTN       *SizeOfPatchVariable,

+  IN        UINTN       MaximumDatumSize,

+  IN OUT    UINTN       *SizeOfBuffer,

+  IN CONST  VOID        *Buffer

+  )

+{

+  ASSERT (PatchVariable != NULL);

+  ASSERT (SizeOfPatchVariable != NULL);

+  ASSERT (SizeOfBuffer  != NULL);

+  

+  if (*SizeOfBuffer > 0) {

+    ASSERT (Buffer != NULL);

+  }

+

+  if ((*SizeOfBuffer > MaximumDatumSize) ||

+      (*SizeOfBuffer == MAX_ADDRESS)) {

+    *SizeOfBuffer = MaximumDatumSize;

+    return NULL;

+  }

+    

+  CopyMem (PatchVariable, Buffer, *SizeOfBuffer);

+  *SizeOfPatchVariable = *SizeOfBuffer;

+  

+  return (VOID *) Buffer;

+}

+

+/**

+  Sets a value and size of a patchable PCD entry that is type pointer.

+

+  Sets the PCD entry specified by PatchVariable to the value specified

+  by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,

+  then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER

+  to indicate that the set operation was not actually performed.

+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to

+  MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.

+

+  If PatchVariable is NULL, then ASSERT().

+  If SizeOfPatchVariable is NULL, then ASSERT().

+  If SizeOfBuffer is NULL, then ASSERT().

+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

+

+  @param[out] PatchVariable     A pointer to the global variable in a module that is

+                                the target of the set operation.

+  @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.

+  @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.

+  @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.

+  @param[in] Buffer             A pointer to the buffer to used to set the target variable.

+  

+  @return The status of the set operation.

+

+**/

+RETURN_STATUS

+EFIAPI

+LibPatchPcdSetPtrAndSizeS (

+  OUT      VOID     *PatchVariable,

+  OUT      UINTN    *SizeOfPatchVariable,

+  IN       UINTN    MaximumDatumSize,

+  IN OUT   UINTN    *SizeOfBuffer,

+  IN CONST VOID     *Buffer

+  )

+{

+  ASSERT (PatchVariable != NULL);

+  ASSERT (SizeOfPatchVariable != NULL);

+  ASSERT (SizeOfBuffer  != NULL);

+  

+  if (*SizeOfBuffer > 0) {

+    ASSERT (Buffer != NULL);

+  }

+

+  if ((*SizeOfBuffer > MaximumDatumSize) ||

+      (*SizeOfBuffer == MAX_ADDRESS)) {

+    *SizeOfBuffer = MaximumDatumSize;

+    return RETURN_INVALID_PARAMETER;

+  }

+

+  CopyMem (PatchVariable, Buffer, *SizeOfBuffer);

+  *SizeOfPatchVariable = *SizeOfBuffer;

+

+  return RETURN_SUCCESS;

+}

+

 /**

   Retrieve additional information associated with a PCD token.