Add function header and pass ECC tools

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5443 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 653 insertions, 12 deletions

diff --git a/MdeModulePkg/Universal/PCD/Dxe/Service.h b/MdeModulePkg/Universal/PCD/Dxe/Service.h
index 3d6e3ed034..4b56e43071 100644
--- a/MdeModulePkg/Universal/PCD/Dxe/Service.h
+++ b/MdeModulePkg/Universal/PCD/Dxe/Service.h
@@ -15,8 +15,8 @@ Module Name: Service.h
 

 **/

 

-#ifndef _SERVICE_H

-#define _SERVICE_H

+#ifndef _PCD_DXE_SERVICE_H_

+#define _PCD_DXE_SERVICE_H_

 

 #include <PiDxe.h>

 #include <Protocol/Pcd.h>

@@ -48,6 +48,29 @@ Module Name: Service.h
 //

 // Protocol Interface function declaration.

 //

+/**

+  Sets the SKU value for subsequent calls to set or get PCD token values.

+

+  SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. 

+  SetSku() is normally called only once by the system.

+

+  For each item (token), the database can hold a single value that applies to all SKUs, 

+  or multiple values, where each value is associated with a specific SKU Id. Items with multiple, 

+  SKU-specific values are called SKU enabled. 

+  

+  The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255.  

+  For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the 

+  single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the 

+  last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, 

+  the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been 

+  set for that Id, the results are unpredictable.

+

+  @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and 

+              set values associated with a PCD token.

+

+  @retval VOID

+

+**/

 VOID

 EFIAPI

 DxePcdSetSku (

@@ -55,7 +78,17 @@ DxePcdSetSku (
   )

 ;

 

+/**

+  Retrieves an 8-bit value for a given PCD token.

+

+  Retrieves the current byte-sized value for a PCD token number.  

+  If the TokenNumber is invalid, the results are unpredictable.

+  

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The UINT8 value.

+  

+**/

 UINT8

 EFIAPI

 DxePcdGet8 (

@@ -63,7 +96,17 @@ DxePcdGet8 (
   )

 ;

 

+/**

+  Retrieves an 16-bit value for a given PCD token.

 

+  Retrieves the current 16-bits value for a PCD token number.  

+  If the TokenNumber is invalid, the results are unpredictable.

+  

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The UINT16 value.

+  

+**/

 UINT16

 EFIAPI

 DxePcdGet16 (

@@ -71,7 +114,17 @@ DxePcdGet16 (
   )

 ;

 

+/**

+  Retrieves an 32-bit value for a given PCD token.

 

+  Retrieves the current 32-bits value for a PCD token number.  

+  If the TokenNumber is invalid, the results are unpredictable.

+  

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The UINT32 value.

+  

+**/

 UINT32

 EFIAPI

 DxePcdGet32 (

@@ -79,7 +132,17 @@ DxePcdGet32 (
   )

 ;

 

+/**

+  Retrieves an 64-bit value for a given PCD token.

+

+  Retrieves the current 64-bits value for a PCD token number.  

+  If the TokenNumber is invalid, the results are unpredictable.

+  

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The UINT64 value.

+  

+**/

 UINT64

 EFIAPI

 DxePcdGet64 (

@@ -87,7 +150,19 @@ DxePcdGet64 (
   )

 ;

 

+/**

+  Retrieves a pointer to a value for a given PCD token.

+

+  Retrieves the current pointer to the buffer for a PCD token number.  

+  Do not make any assumptions about the alignment of the pointer that 

+  is returned by this function call.  If the TokenNumber is invalid, 

+  the results are unpredictable.

 

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The pointer to the buffer to be retrived.

+  

+**/

 VOID *

 EFIAPI

 DxePcdGetPtr (

@@ -95,7 +170,19 @@ DxePcdGetPtr (
   )

 ;

 

+/**

+  Retrieves a Boolean value for a given PCD token.

+

+  Retrieves the current boolean value for a PCD token number.  

+  Do not make any assumptions about the alignment of the pointer that 

+  is returned by this function call.  If the TokenNumber is invalid, 

+  the results are unpredictable.

+

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The Boolean value.

+  

+**/

 BOOLEAN

 EFIAPI

 DxePcdGetBool (

@@ -103,7 +190,17 @@ DxePcdGetBool (
   )

 ;

 

+/**

+  Retrieves the size of the value for a given PCD token.

+

+  Retrieves the current size of a particular PCD token.  

+  If the TokenNumber is invalid, the results are unpredictable.

+

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The size of the value for the PCD token.

+  

+**/

 UINTN

 EFIAPI

 DxePcdGetSize (

@@ -111,7 +208,20 @@ DxePcdGetSize (
   )

 ;

 

+/**

+  Retrieves an 8-bit value for a given PCD token.

+

+  Retrieves the 8-bit value of a particular PCD token.  

+  If the TokenNumber is invalid or the token space

+  specified by Guid does not exist, the results are 

+  unpredictable.

 

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The size 8-bit value for the PCD token.

+  

+**/

 UINT8

 EFIAPI

 DxePcdGet8Ex (

@@ -120,7 +230,20 @@ DxePcdGet8Ex (
   )

 ;

 

+/**

+  Retrieves an 16-bit value for a given PCD token.

+

+  Retrieves the 16-bit value of a particular PCD token.  

+  If the TokenNumber is invalid or the token space

+  specified by Guid does not exist, the results are 

+  unpredictable.

+

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The size 16-bit value for the PCD token.

+  

+**/

 UINT16

 EFIAPI

 DxePcdGet16Ex (

@@ -129,7 +252,20 @@ DxePcdGet16Ex (
   )

 ;

 

+/**

+  Retrieves an 32-bit value for a given PCD token.

+

+  Retrieves the 32-bit value of a particular PCD token.  

+  If the TokenNumber is invalid or the token space

+  specified by Guid does not exist, the results are 

+  unpredictable.

+

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The size 32-bit value for the PCD token.

+  

+**/

 UINT32

 EFIAPI

 DxePcdGet32Ex (

@@ -138,8 +274,20 @@ DxePcdGet32Ex (
   )

 ;

 

+/**

+  Retrieves an 64-bit value for a given PCD token.

+

+  Retrieves the 64-bit value of a particular PCD token.  

+  If the TokenNumber is invalid or the token space

+  specified by Guid does not exist, the results are 

+  unpredictable.

 

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The size 64-bit value for the PCD token.

+  

+**/

 UINT64

 EFIAPI

 DxePcdGet64Ex (

@@ -148,8 +296,20 @@ DxePcdGet64Ex (
   )

 ;

 

+/**

+  Retrieves a pointer to a value for a given PCD token.

+

+  Retrieves the current pointer to the buffer for a PCD token number.  

+  Do not make any assumptions about the alignment of the pointer that 

+  is returned by this function call.  If the TokenNumber is invalid, 

+  the results are unpredictable.

 

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

 

+  @return The pointer to the buffer to be retrived.

+  

+**/

 VOID *

 EFIAPI

 DxePcdGetPtrEx (

@@ -158,7 +318,20 @@ DxePcdGetPtrEx (
   )

 ;

 

+/**

+  Retrieves an Boolean value for a given PCD token.

+

+  Retrieves the Boolean value of a particular PCD token.  

+  If the TokenNumber is invalid or the token space

+  specified by Guid does not exist, the results are 

+  unpredictable.

 

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The size Boolean value for the PCD token.

+  

+**/

 BOOLEAN

 EFIAPI

 DxePcdGetBoolEx (

@@ -167,7 +340,18 @@ DxePcdGetBoolEx (
   )

 ;

 

+/**

+  Retrieves the size of the value for a given PCD token.

+

+  Retrieves the current size of a particular PCD token.  

+  If the TokenNumber is invalid, the results are unpredictable.

 

+  @param[in]  Guid The token space for the token number.

+  @param[in]  TokenNumber The PCD token number. 

+

+  @return The size of the value for the PCD token.

+  

+**/

 UINTN

 EFIAPI

 DxePcdGetSizeEx (

@@ -176,7 +360,23 @@ DxePcdGetSizeEx (
   )

 ;

 

+/**

+  Sets an 8-bit value for a given PCD token.

 

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet8 (

@@ -185,7 +385,23 @@ DxePcdSet8 (
   )

 ;

 

+/**

+  Sets an 16-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet16 (

@@ -194,7 +410,23 @@ DxePcdSet16 (
   )

 ;

 

+/**

+  Sets an 32-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet32 (

@@ -203,7 +435,23 @@ DxePcdSet32 (
   )

 ;

 

+/**

+  Sets an 64-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

 

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet64 (

@@ -213,16 +461,53 @@ DxePcdSet64 (
 ;

 

 

+/**

+  Sets a value of a specified size for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.  

+                              On input, if the SizeOfValue is greater than the maximum size supported 

+                              for this TokenNumber then the output value of SizeOfValue will reflect 

+                              the maximum size supported for this TokenNumber.

+  @param[in]  Buffer The buffer to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSetPtr (

   IN        UINTN             TokenNumber,

-  IN        UINTN             *SizeOfBuffer,

+  IN OUT    UINTN             *SizeOfBuffer,

   IN        VOID              *Buffer

   )

 ;

 

+/**

+  Sets an Boolean value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSetBool (

@@ -232,6 +517,24 @@ DxePcdSetBool (
 ;

 

 

+/**

+  Sets an 8-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet8Ex (

@@ -241,7 +544,24 @@ DxePcdSet8Ex (
   )

 ;

 

+/**

+  Sets an 16-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet16Ex (

@@ -251,7 +571,24 @@ DxePcdSet16Ex (
   )

 ;

 

+/**

+  Sets an 32-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

 

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet32Ex (

@@ -261,7 +598,24 @@ DxePcdSet32Ex (
   )

 ;

 

+/**

+  Sets an 64-bit value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSet64Ex (

@@ -271,7 +625,28 @@ DxePcdSet64Ex (
   )

 ;

 

-

+/**

+  Sets a value of a specified size for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.  

+                              On input, if the SizeOfValue is greater than the maximum size supported 

+                              for this TokenNumber then the output value of SizeOfValue will reflect 

+                              the maximum size supported for this TokenNumber.

+  @param[in]  Buffer The buffer to set for the PCD token.

+

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSetPtrEx (

@@ -282,7 +657,24 @@ DxePcdSetPtrEx (
   )

 ;

 

+/**

+  Sets an Boolean value for a given PCD token.

+

+  When the PCD service sets a value, it will check to ensure that the 

+  size of the value being set is compatible with the Token's existing definition.  

+  If it is not, an error will be returned.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  Value The value to set for the PCD token.

 

+  @retval EFI_SUCCESS  Procedure returned successfully.

+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data 

+                                  being set was incompatible with a call to this function.  

+                                  Use GetSize() to retrieve the size of the target data.

+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.

+  

+**/

 EFI_STATUS

 EFIAPI

 DxePcdSetBoolEx (

@@ -292,8 +684,18 @@ DxePcdSetBoolEx (
   )

 ;

 

+/**

+  Specifies a function to be called anytime the value of a designated token is changed.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  CallBackFunction The function prototype called when the value associated with the CallBackToken is set.  

 

+  @retval EFI_SUCCESS  The PCD service has successfully established a call event 

+                        for the CallBackToken requested.

+  @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.

 

+**/

 EFI_STATUS

 EFIAPI

 DxeRegisterCallBackOnSet (

@@ -303,7 +705,18 @@ DxeRegisterCallBackOnSet (
   )

 ;

 

+/**

+  Cancels a previously set callback function for a particular PCD token number.

+

+  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in]  TokenNumber The PCD token number. 

+  @param[in]  CallBackFunction The function prototype called when the value associated with the CallBackToken is set.  

+

+  @retval EFI_SUCCESS  The PCD service has successfully established a call event 

+                        for the CallBackToken requested.

+  @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.

 

+**/

 EFI_STATUS

 EFIAPI

 DxeUnRegisterCallBackOnSet (

@@ -313,7 +726,24 @@ DxeUnRegisterCallBackOnSet (
   )

 ;

 

+/**

+  Retrieves the next valid PCD token for a given namespace.

+

+  @param[in]      Guid          The 128-bit unique value that designates the namespace from which to extract the value.

+  @param[in, out]  TokenNumber   A pointer to the PCD token number to use to find the subsequent token number.  

+                                If the input token namespace or token number does not exist on the platform, 

+                                an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, 

+                                have the pointer reference a TokenNumber value of 0. If the input token number is 0 and 

+                                there is no valid token number for this token namespace,  *TokenNumber will be assigned to 

+                                0 and the function return EFI_SUCCESS. If the token number is the last valid token number, 

+                                *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.

+

+  @retval EFI_SUCCESS  The PCD service retrieved the next valid token number. Or the input token number 

+                        is already the last valid token number in the PCD database. 

+                        In the later case, *TokenNumber is updated with the value of 0.

+  @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.

 

+**/

 EFI_STATUS

 EFIAPI

 DxePcdGetNextToken (

@@ -322,8 +752,21 @@ DxePcdGetNextToken (
   )

 ;

 

-

-

+/**

+  Get next token space in PCD database according to given token space guid.

+  

+  This routine is enable only when feature flag PCD PcdDxePcdDatabaseTraverseEnabled 

+  is TRUE.

+  

+  @param Guid            Given token space guid. If NULL, then Guid will be set to 

+                         the first PCD token space in PCD database, If not NULL, then

+                         Guid will be set to next PCD token space.

+

+  @retval EFI_UNSUPPORTED If feature flag PCD PcdDxePcdDatabaseTraverseEnabled is FALSE.

+  @retval EFI_NOT_FOUND   If PCD database has no token space table or can not find given

+                          token space in PCD database.

+  @retval EFI_SUCCESS     Success to get next token space guid.

+**/

 EFI_STATUS

 EFIAPI

 DxePcdGetNextTokenSpace (

@@ -331,7 +774,6 @@ DxePcdGetNextTokenSpace (
   )

 ;

 

-

 typedef struct {

   LIST_ENTRY              Node;

   PCD_PROTOCOL_CALLBACK   CallbackFn;

@@ -343,6 +785,16 @@ typedef struct {
 // Internal Functions

 //

 

+/**

+  Wrapper function for setting non-pointer type value for a PCD entry.

+

+  @param TokenNumber     Pcd token number autogenerated by build tools.

+  @param Data            Value want to be set for PCD entry

+  @param Size            Size of value.

+

+  @return status of SetWorker.

+

+**/

 EFI_STATUS

 SetValueWorker (

   IN UINTN                   TokenNumber,

@@ -351,6 +803,21 @@ SetValueWorker (
   )

 ;

 

+/**

+  Set value for an PCD entry

+

+  @param TokenNumber     Pcd token number autogenerated by build tools.

+  @param Data            Value want to be set for PCD entry

+  @param Size            Size of value.

+  @param PtrType         If TRUE, the type of PCD entry's value is Pointer.

+                         If False, the type of PCD entry's value is not Pointer.

+

+  @retval EFI_INVALID_PARAMETER  If this PCD type is VPD, VPD PCD can not be set.

+  @retval EFI_INVALID_PARAMETER  If Size can not be set to size table.

+  @retval EFI_NOT_FOUND          If value type of PCD entry is intergrate, but not in

+                                 range of UINT8, UINT16, UINT32, UINT64

+  @retval EFI_NOT_FOUND          Can not find the PCD type according to token number.                                

+**/

 EFI_STATUS

 SetWorker (

   IN          UINTN                     TokenNumber,

@@ -360,7 +827,17 @@ SetWorker (
   )

 ;

 

+/**

+  Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.

+

+  @param ExTokenNumber   Token number for dynamic-ex PCD.

+  @param Guid            Token space guid for dynamic-ex PCD.

+  @param Data            Value want to be set.

+  @param SetSize         The size of value.

 

+  @return status of ExSetWorker().

+

+**/

 EFI_STATUS

 ExSetValueWorker (

   IN          UINTN                ExTokenNumber,

@@ -370,8 +847,24 @@ ExSetValueWorker (
   )

 ;

 

+/**

+  Set value for a dynamic PCD entry.

+  

+  This routine find the local token number according to dynamic-ex PCD's token 

+  space guid and token number firstly, and invoke callback function if this PCD

+  entry registered callback function. Finally, invoken general SetWorker to set

+  PCD value.

+  

+  @param ExTokenNumber   Dynamic-ex PCD token number.

+  @param Guid            Token space guid for dynamic-ex PCD.

+  @param Data            PCD value want to be set

+  @param SetSize         Size of value.

+  @param PtrType         If TRUE, this PCD entry is pointer type.

+                         If FALSE, this PCD entry is not pointer type.

+

+  @return status of SetWorker().

 

-

+**/

 EFI_STATUS

 ExSetWorker (

   IN      UINTN                ExTokenNumber,

@@ -382,7 +875,20 @@ ExSetWorker (
   )

 ;

 

+/**

+  Get the PCD entry pointer in PCD database.

+  

+  This routine will visit PCD database to find the PCD entry according to given

+  token number. The given token number is autogened by build tools and it will be 

+  translated to local token number. Local token number contains PCD's type and 

+  offset of PCD entry in PCD database.

+

+  @param TokenNumber     Token's number, it is autogened by build tools

+  @param GetSize         The size of token's value

 

+  @return PCD entry pointer in PCD database

+

+**/

 VOID *

 GetWorker (

   IN UINTN             TokenNumber,

@@ -390,6 +896,16 @@ GetWorker (
   )

 ;

 

+/**

+  Wrapper function for get PCD value for dynamic-ex PCD.

+

+  @param Guid            Token space guid for dynamic-ex PCD.

+  @param ExTokenNumber   Token number for dyanmic-ex PCD.

+  @param GetSize         The size of dynamic-ex PCD value.

+

+  @return PCD entry in PCD database.

+

+**/

 VOID *

 ExGetWorker (

   IN CONST EFI_GUID         *Guid,

@@ -398,6 +914,17 @@ ExGetWorker (
   )

 ;

 

+/**

+  Find the local token number according to system SKU ID.

+

+  @param LocalTokenNumber PCD token number

+  @param Size             The size of PCD entry.

+  @param IsPeiDb          If TRUE, the PCD entry is initialized in PEI phase.

+                          If False, the PCD entry is initialized in DXE phase.

+

+  @return Token number according to system SKU ID.

+

+**/

 UINT32

 GetSkuEnabledTokenNumber (

   UINT32 LocalTokenNumber,

@@ -406,6 +933,16 @@ GetSkuEnabledTokenNumber (
   )

 ;

 

+/**

+  Get Variable which contains HII type PCD entry.

+

+  @param VariableGuid    Variable's guid

+  @param VariableName    Variable's unicode name string

+  @param VariableData    Variable's data pointer, 

+  @param VariableSize    Variable's size.

+

+  @return the status of gRT->GetVariable

+**/

 EFI_STATUS

 GetHiiVariable (

   IN  EFI_GUID      *VariableGuid,

@@ -415,6 +952,21 @@ GetHiiVariable (
   )

 ;

 

+/**

+  Set value for HII-type PCD.

+

+  A HII-type PCD's value is stored in a variable. Setting/Getting the value of 

+  HII-type PCD is to visit this variable.

+  

+  @param VariableGuid    Guid of variable which stored value of a HII-type PCD.

+  @param VariableName    Unicode name of variable which stored value of a HII-type PCD.

+  @param Data            Value want to be set.

+  @param DataSize        Size of value

+  @param Offset          Value offset of HII-type PCD in variable.

+

+  @return status of GetVariable()/SetVariable().

+

+**/

 EFI_STATUS

 SetHiiVariable (

   IN  EFI_GUID     *VariableGuid,

@@ -425,26 +977,76 @@ SetHiiVariable (
   )

 ;

 

+/**

+  Register the callback function for a PCD entry.

+

+  This routine will register a callback function to a PCD entry by given token number

+  and token space guid.

+  

+  @param TokenNumber        PCD token's number, it is autogened by build tools.

+  @param Guid               PCD token space's guid, 

+                            if not NULL, this PCD is dynamicEx type PCD.

+  @param CallBackFunction   Callback function pointer

+

+  @return EFI_SUCCESS Always success for registering callback function.

+

+**/

 EFI_STATUS

 DxeRegisterCallBackWorker (

   IN  UINTN                   TokenNumber,

   IN  CONST EFI_GUID          *Guid, OPTIONAL

   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction

-);

+  )

+;

+

+/**

+  UnRegister the callback function for a PCD entry.

 

+  This routine will unregister a callback function to a PCD entry by given token number

+  and token space guid.

+

+  @param TokenNumber        PCD token's number, it is autogened by build tools.

+  @param Guid               PCD token space's guid.

+                            if not NULL, this PCD is dynamicEx type PCD.

+  @param CallBackFunction   Callback function pointer

+

+  @retval EFI_SUCCESS               Callback function is success to be unregister.

+  @retval EFI_INVALID_PARAMETER     Can not find the PCD entry by given token number.

+**/

 EFI_STATUS

 DxeUnRegisterCallBackWorker (

   IN  UINTN                   TokenNumber,

   IN  CONST EFI_GUID          *Guid, OPTIONAL

   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction

-);

+  )

+;

 

+/**

+  Initialize the PCD database in DXE phase.

+  

+  PCD database in DXE phase also contains PCD database in PEI phase which is copied

+  from GUID Hob.

+

+**/

 VOID

 BuildPcdDxeDataBase (

   VOID

-);

+  )

+;

 

+/**

+  Get local token number according to dynamic-ex PCD's {token space guid:token number}

 

+  A dynamic-ex type PCD, developer must provide pair of token space guid: token number

+  in DEC file. PCD database maintain a mapping table that translate pair of {token

+  space guid: token number} to local token number.

+  

+  @param Guid            Token space guid for dynamic-ex PCD entry.

+  @param ExTokenNumber   EDES_TODO: Add parameter description

+

+  @return local token number for dynamic-ex PCD.

+

+**/

 UINTN

 GetExPcdTokenNumber (

   IN CONST EFI_GUID             *Guid,

@@ -452,8 +1054,31 @@ GetExPcdTokenNumber (
   )

 ;

 

+/**

+  Get next token number in given token space.

+  

+  This routine is used for dynamicEx type PCD. It will firstly scan token space

+  table to get token space according to given token space guid. Then scan given 

+  token number in found token space, if found, then return next token number in 

+  this token space.

+

+  @param Guid            Token space guid. Next token number will be scaned in 

+                         this token space.

+  @param TokenNumber     Token number. 

+                         If PCD_INVALID_TOKEN_NUMBER, return first token number in 

+                         token space table.

+                         If not PCD_INVALID_TOKEN_NUMBER, return next token number

+                         in token space table.

+  @param GuidTable       Token space guid table. It will be used for scan token space

+                         by given token space guid.

+  @param SizeOfGuidTable The size of guid table.

+  @param ExMapTable      DynamicEx token number mapping table.

+  @param SizeOfExMapTable The size of dynamicEx token number mapping table.

+

+  @retval EFI_NOT_FOUND  Can not given token space or token number.

+  @retval EFI_SUCCESS    Success to get next token number.

 

-

+**/

 EFI_STATUS

 ExGetNextTokeNumber (

   IN      CONST EFI_GUID    *Guid,

@@ -465,7 +1090,15 @@ ExGetNextTokeNumber (
   )

 ;

 

+/**

+  Get size of POINTER type PCD value.

 

+  @param LocalTokenNumberTableIdx Index of local token number in local token number table.

+  @param MaxSize                  Maxmium size of POINTER type PCD value.

+

+  @return size of POINTER type PCD value.

+

+**/

 UINTN

 GetPtrTypeSize (

   IN    UINTN             LocalTokenNumberTableIdx,

@@ -473,8 +1106,16 @@ GetPtrTypeSize (
   )

 ;

 

+/**

+  Set size of POINTER type PCD value. The size should not exceed the maxmium size

+  of this PCD value.

 

+  @param LocalTokenNumberTableIdx Index of local token number in local token number table.

+  @param CurrentSize              Size of POINTER type PCD value.

 

+  @retval TRUE  Success to set size of PCD value.

+  @retval FALSE Fail to set size of PCD value.

+**/

 BOOLEAN

 SetPtrTypeSize (

   IN          UINTN             LocalTokenNumberTableIdx,