]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ppi/Pcd.h
Add in function description and comments.
[mirror_edk2.git] / MdePkg / Include / Ppi / Pcd.h
index 2050d659de6258e4517988b48aaae697e81a26d2..97d487e249655e3e25ef9bf9cc94e1c7b48bf7c3 100644 (file)
@@ -24,54 +24,190 @@ extern EFI_GUID gPcdPpiGuid;
 \r
 #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
 \r
+\r
+\r
+/**\r
+  Sets the SKU value for subsequent calls to set or get PCD token values.\r
+\r
+  SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. \r
+  SetSku() is normally called only once by the system.\r
+\r
+  For each item (token), the database can hold a single value that applies to all SKUs, \r
+  or multiple values, where each value is associated with a specific SKU Id. Items with multiple, \r
+  SKU-specific values are called SKU enabled. \r
+  \r
+  The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255.  \r
+  For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the \r
+  single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the \r
+  last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, \r
+  the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been \r
+  set for that Id, the results are unpredictable.\r
+\r
+  @param  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 VOID\r
+\r
+**/\r
 typedef \r
 VOID\r
 (EFIAPI *PCD_PPI_SET_SKU) (\r
   IN  UINTN          SkuId\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 8-bit value for a given PCD token.\r
+\r
+  Retrieves the current byte-sized value for a PCD token number.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+  \r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The UINT8 value.\r
+  \r
+**/\r
 typedef\r
 UINT8\r
 (EFIAPI *PCD_PPI_GET8) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 16-bit value for a given PCD token.\r
+\r
+  Retrieves the current 16-bits value for a PCD token number.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+  \r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The UINT16 value.\r
+  \r
+**/\r
 typedef\r
 UINT16\r
 (EFIAPI *PCD_PPI_GET16) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 32-bit value for a given PCD token.\r
+\r
+  Retrieves the current 32-bits value for a PCD token number.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+  \r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The UINT32 value.\r
+  \r
+**/\r
 typedef\r
 UINT32\r
 (EFIAPI *PCD_PPI_GET32) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 64-bit value for a given PCD token.\r
+\r
+  Retrieves the current 64-bits value for a PCD token number.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+  \r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The UINT64 value.\r
+  \r
+**/\r
 typedef\r
 UINT64\r
 (EFIAPI *PCD_PPI_GET64) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves a pointer to a value for a given PCD token.\r
+\r
+  Retrieves the current pointer to the buffer for a PCD token number.  \r
+  Do not make any assumptions about the alignment of the pointer that \r
+  is returned by this function call.  If the TokenNumber is invalid, \r
+  the results are unpredictable.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The pointer to the buffer to be retrived.\r
+  \r
+**/\r
 typedef\r
 VOID *\r
 (EFIAPI *PCD_PPI_GET_POINTER) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves a Boolean value for a given PCD token.\r
+\r
+  Retrieves the current boolean value for a PCD token number.  \r
+  Do not make any assumptions about the alignment of the pointer that \r
+  is returned by this function call.  If the TokenNumber is invalid, \r
+  the results are unpredictable.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The Boolean value.\r
+  \r
+**/\r
 typedef\r
 BOOLEAN\r
 (EFIAPI *PCD_PPI_GET_BOOLEAN) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves the size of the value for a given PCD token.\r
+\r
+  Retrieves the current size of a particular PCD token.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size of the value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINTN\r
 (EFIAPI *PCD_PPI_GET_SIZE) (\r
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 8-bit value for a given PCD token.\r
+\r
+  Retrieves the 8-bit value of a particular PCD token.  \r
+  If the TokenNumber is invalid or the token space\r
+  specified by Guid does not exist, the results are \r
+  unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size 8-bit value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINT8\r
 (EFIAPI *PCD_PPI_GET_EX_8) (\r
@@ -79,6 +215,22 @@ UINT8
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 16-bit value for a given PCD token.\r
+\r
+  Retrieves the 16-bit value of a particular PCD token.  \r
+  If the TokenNumber is invalid or the token space\r
+  specified by Guid does not exist, the results are \r
+  unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size 16-bit value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINT16\r
 (EFIAPI *PCD_PPI_GET_EX_16) (\r
@@ -86,6 +238,22 @@ UINT16
   IN UINTN              TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 32-bit value for a given PCD token.\r
+\r
+  Retrieves the 32-bit value of a particular PCD token.  \r
+  If the TokenNumber is invalid or the token space\r
+  specified by Guid does not exist, the results are \r
+  unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size 32-bit value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINT32\r
 (EFIAPI *PCD_PPI_GET_EX_32) (\r
@@ -93,6 +261,22 @@ UINT32
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an 64-bit value for a given PCD token.\r
+\r
+  Retrieves the 64-bit value of a particular PCD token.  \r
+  If the TokenNumber is invalid or the token space\r
+  specified by Guid does not exist, the results are \r
+  unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size 64-bit value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINT64\r
 (EFIAPI *PCD_PPI_GET_EX_64) (\r
@@ -100,6 +284,22 @@ UINT64
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves a pointer to a value for a given PCD token.\r
+\r
+  Retrieves the current pointer to the buffer for a PCD token number.  \r
+  Do not make any assumptions about the alignment of the pointer that \r
+  is returned by this function call.  If the TokenNumber is invalid, \r
+  the results are unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The pointer to the buffer to be retrived.\r
+  \r
+**/\r
 typedef\r
 VOID *\r
 (EFIAPI *PCD_PPI_GET_EX_POINTER) (\r
@@ -107,6 +307,22 @@ VOID *
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves an Boolean value for a given PCD token.\r
+\r
+  Retrieves the Boolean value of a particular PCD token.  \r
+  If the TokenNumber is invalid or the token space\r
+  specified by Guid does not exist, the results are \r
+  unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size Boolean value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 BOOLEAN\r
 (EFIAPI *PCD_PPI_GET_EX_BOOLEAN) (\r
@@ -114,6 +330,20 @@ BOOLEAN
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves the size of the value for a given PCD token.\r
+\r
+  Retrieves the current size of a particular PCD token.  \r
+  If the TokenNumber is invalid, the results are unpredictable.\r
+\r
+  @param  Guid The token space for the token number.\r
+  @param  TokenNumber The PCD token number. \r
+\r
+  @return The size of the value for the PCD token.\r
+  \r
+**/\r
 typedef\r
 UINTN\r
 (EFIAPI *PCD_PPI_GET_EX_SIZE) (\r
@@ -121,6 +351,25 @@ UINTN
   IN UINTN             TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 8-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET8) (\r
@@ -128,6 +377,25 @@ EFI_STATUS
   IN UINT8             Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 16-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET16) (\r
@@ -135,6 +403,25 @@ EFI_STATUS
   IN UINT16             Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 32-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET32) (\r
@@ -142,6 +429,25 @@ EFI_STATUS
   IN UINT32            Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 64-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET64) (\r
@@ -149,6 +455,30 @@ EFI_STATUS
   IN UINT64            Value\r
   );\r
 \r
+\r
+\r
+\r
+/**\r
+  Sets a value of a specified size for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param SizeOfBuffer A pointer to the length of the value being set for the PCD token.  \r
+                              On input, if the SizeOfValue is greater than the maximum size supported \r
+                              for this TokenNumber then the output value of SizeOfValue will reflect \r
+                              the maximum size supported for this TokenNumber.\r
+  @param  Buffer The buffer to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_POINTER) (\r
@@ -157,6 +487,25 @@ EFI_STATUS
   IN        VOID              *Buffer\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an Boolean value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_BOOLEAN) (\r
@@ -164,6 +513,26 @@ EFI_STATUS
   IN BOOLEAN           Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 8-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_8) (\r
@@ -172,6 +541,26 @@ EFI_STATUS
   IN UINT8             Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 16-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_16) (\r
@@ -180,6 +569,26 @@ EFI_STATUS
   IN UINT16            Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 32-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_32) (\r
@@ -188,6 +597,26 @@ EFI_STATUS
   IN UINT32            Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an 64-bit value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_64) (\r
@@ -196,6 +625,30 @@ EFI_STATUS
   IN UINT64            Value\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets a value of a specified size for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param SizeOfBuffer A pointer to the length of the value being set for the PCD token.  \r
+                              On input, if the SizeOfValue is greater than the maximum size supported \r
+                              for this TokenNumber then the output value of SizeOfValue will reflect \r
+                              the maximum size supported for this TokenNumber.\r
+  @param  Buffer The buffer to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_POINTER) (\r
@@ -205,6 +658,26 @@ EFI_STATUS
   IN        VOID              *Buffer\r
   );\r
 \r
+\r
+\r
+/**\r
+  Sets an Boolean value for a given PCD token.\r
+\r
+  When the PCD service sets a value, it will check to ensure that the \r
+  size of the value being set is compatible with the Token's existing definition.  \r
+  If it is not, an error will be returned.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Value The value to set for the PCD token.\r
+\r
+  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
+                                  being set was incompatible with a call to this function.  \r
+                                  Use GetSize() to retrieve the size of the target data.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_SET_EX_BOOLEAN) (\r
@@ -213,17 +686,19 @@ EFI_STATUS
   IN BOOLEAN           Value\r
   );\r
 \r
+\r
+\r
 /**\r
   Callback on SET function prototype definition.\r
 \r
-  @param[in]  CallBackGuid The PCD token GUID being set.\r
-  @param[in]  CallBackToken The PCD token number being set.\r
-  @param[in]  TokenData A pointer to the token data being set.\r
-  @param[in]  TokenDataSize The size, in bytes, of the data being set.\r
+  @param  CallBackGuid The PCD token GUID being set.\r
+  @param  CallBackToken The PCD token number being set.\r
+  @param  TokenData A pointer to the token data being set.\r
+  @param  TokenDataSize The size, in bytes, of the data being set.\r
 \r
   @retval VOID\r
 \r
---*/\r
+**/\r
 typedef\r
 VOID\r
 (EFIAPI *PCD_PPI_CALLBACK) (\r
@@ -233,6 +708,20 @@ VOID
   IN      UINTN            TokenDataSize\r
   );\r
 \r
+\r
+\r
+/**\r
+  Specifies a function to be called anytime the value of a designated token is changed.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  CallBackFunction The function prototype called when the value associated with the CallBackToken is set.  \r
+\r
+  @retval EFI_SUCCESS  The PCD service has successfully established a call event \r
+                        for the CallBackToken requested.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_CALLBACK_ONSET) (\r
@@ -241,6 +730,20 @@ EFI_STATUS
   IN  PCD_PPI_CALLBACK       CallBackFunction\r
   );\r
 \r
+\r
+\r
+/**\r
+  Cancels a previously set callback function for a particular PCD token number.\r
+\r
+  @param  TokenNumber The PCD token number. \r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  CallBackFunction The function prototype called when the value associated with the CallBackToken is set.  \r
+\r
+  @retval EFI_SUCCESS  The PCD service has successfully established a call event \r
+                        for the CallBackToken requested.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_CANCEL_CALLBACK) (\r
@@ -249,6 +752,19 @@ EFI_STATUS
   IN  PCD_PPI_CALLBACK        CallBackFunction\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves the next valid PCD token for a given namespace.\r
+\r
+  @param  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param  TokenNumber A pointer to the PCD token number to use to find the subsequent token number.  \r
+                              To retrieve the "first" token, have the pointer reference a TokenNumber value of 0.\r
+\r
+  @retval EFI_SUCCESS  The PCD service retrieved the value requested.\r
+  @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.\r
+\r
+**/\r
 typedef \r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_GET_NEXT_TOKEN) (\r
@@ -256,12 +772,35 @@ EFI_STATUS
   IN OUT  UINTN               *TokenNumber\r
   );\r
 \r
+\r
+\r
+/**\r
+  Retrieves the next valid PCD token namespace for a given namespace.\r
+\r
+  @param  Guid An indirect pointer to EFI_GUID.  On input it designates a known \r
+                    token namespace from which the search will start. On output, \r
+                    it designates the next valid token namespace on the platform. \r
+                    If *Guid is NULL, then the GUID of the first token space of the current platform is returned.\r
+                    If this input token namespace is the last tokenspace on the platform,\r
+                    *Guid will be assigned to NULL and the function return EFI_SUCCESS.\r
+                    If the search cannot locate the input token namespace, an error is returned and \r
+                    the value of *Guid is undefined. \r
+\r
+  @retval EFI_SUCCESS  The PCD service retrieved the value requested.\r
+  @retval EFI_NOT_FOUND The PCD service could not find the input token namespace.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE) (\r
   IN OUT CONST EFI_GUID         **Guid\r
   );\r
 \r
+\r
+\r
+//\r
+// Interface structure for the PCD PPI\r
+//\r
 typedef struct {\r
   PCD_PPI_SET_SKU              SetSku;\r
 \r