]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Pcd.h
Code have been checked with spec
[mirror_edk2.git] / MdePkg / Include / Protocol / Pcd.h
index 7741df17eab303b83275ce695a319b90e51df21c..40e436434eaf5e0e87df4dd08e61aa7474824a8c 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Platform Configuration Database (PCD) Protocol\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  Pcd.h\r
-\r
 **/\r
 \r
 #ifndef __PCD_H__\r
@@ -43,14 +41,14 @@ extern EFI_GUID gPcdProtocolGuid;
   set for that Id, the results are unpredictable.\r
 \r
   @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
+                    set values associated with a PCD token.\r
 \r
   @retval VOID\r
 \r
 **/\r
 typedef \r
 VOID\r
-(EFIAPI *PCD_PROTOCOL_SET_SKU) (\r
+(EFIAPI *PCD_PROTOCOL_SET_SKU)(\r
   IN  UINTN                  SkuId\r
   );\r
 \r
@@ -69,7 +67,7 @@ VOID
 **/\r
 typedef\r
 UINT8\r
-(EFIAPI *PCD_PROTOCOL_GET8) (\r
+(EFIAPI *PCD_PROTOCOL_GET8)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -88,7 +86,7 @@ UINT8
 **/\r
 typedef\r
 UINT16\r
-(EFIAPI *PCD_PROTOCOL_GET16) (\r
+(EFIAPI *PCD_PROTOCOL_GET16)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -107,7 +105,7 @@ UINT16
 **/\r
 typedef\r
 UINT32\r
-(EFIAPI *PCD_PROTOCOL_GET32) (\r
+(EFIAPI *PCD_PROTOCOL_GET32)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -126,7 +124,7 @@ UINT32
 **/\r
 typedef\r
 UINT64\r
-(EFIAPI *PCD_PROTOCOL_GET64) (\r
+(EFIAPI *PCD_PROTOCOL_GET64)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -147,7 +145,7 @@ UINT64
 **/\r
 typedef\r
 VOID *\r
-(EFIAPI *PCD_PROTOCOL_GET_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_GET_POINTER)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -168,7 +166,7 @@ VOID *
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *PCD_PROTOCOL_GET_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_BOOLEAN)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -187,7 +185,7 @@ BOOLEAN
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *PCD_PROTOCOL_GET_SIZE) (\r
+(EFIAPI *PCD_PROTOCOL_GET_SIZE)(\r
   IN UINTN             TokenNumber\r
   );\r
 \r
@@ -201,7 +199,7 @@ UINTN
   specified by Guid does not exist, the results are \r
   unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size 8-bit value for the PCD token.\r
@@ -209,7 +207,7 @@ UINTN
 **/\r
 typedef\r
 UINT8\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_8) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_8)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -224,7 +222,7 @@ UINT8
   specified by Guid does not exist, the results are \r
   unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size 16-bit value for the PCD token.\r
@@ -232,7 +230,7 @@ UINT8
 **/\r
 typedef\r
 UINT16\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_16) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_16)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -247,14 +245,15 @@ UINT16
   specified by Guid does not exist, the results are \r
   unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size 32-bit value for the PCD token.\r
   \r
-**/typedef\r
+**/\r
+typedef\r
 UINT32\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_32) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_32)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -269,7 +268,7 @@ UINT32
   specified by Guid does not exist, the results are \r
   unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size 64-bit value for the PCD token.\r
@@ -277,7 +276,7 @@ UINT32
 **/\r
 typedef\r
 UINT64\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_64) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_64)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -292,7 +291,7 @@ UINT64
   is returned by this function call.  If the TokenNumber is invalid, \r
   the results are unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The pointer to the buffer to be retrived.\r
@@ -300,7 +299,7 @@ UINT64
 **/\r
 typedef\r
 VOID *\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_POINTER)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -315,7 +314,7 @@ VOID *
   specified by Guid does not exist, the results are \r
   unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size Boolean value for the PCD token.\r
@@ -323,7 +322,7 @@ VOID *
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -336,7 +335,7 @@ BOOLEAN
   Retrieves the current size of a particular PCD token.  \r
   If the TokenNumber is invalid, the results are unpredictable.\r
 \r
-  @param[in]  Guid The token space for the token number.\r
+  @param[in]  Guid        The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size of the value for the PCD token.\r
@@ -344,7 +343,7 @@ BOOLEAN
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_SIZE) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_SIZE)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber\r
   );\r
@@ -359,7 +358,7 @@ UINTN
   If it is not, an error will be returned.\r
 \r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -370,7 +369,7 @@ UINTN
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET8) (\r
+(EFIAPI *PCD_PROTOCOL_SET8)(\r
   IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
   );\r
@@ -385,7 +384,7 @@ EFI_STATUS
   If it is not, an error will be returned.\r
 \r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -396,7 +395,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET16) (\r
+(EFIAPI *PCD_PROTOCOL_SET16)(\r
   IN UINTN              TokenNumber,\r
   IN UINT16             Value\r
   );\r
@@ -411,7 +410,7 @@ EFI_STATUS
   If it is not, an error will be returned.\r
 \r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -422,7 +421,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET32) (\r
+(EFIAPI *PCD_PROTOCOL_SET32)(\r
   IN UINTN              TokenNumber,\r
   IN UINT32             Value\r
   );\r
@@ -437,7 +436,7 @@ EFI_STATUS
   If it is not, an error will be returned.\r
 \r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -448,7 +447,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET64) (\r
+(EFIAPI *PCD_PROTOCOL_SET64)(\r
   IN UINTN             TokenNumber,\r
   IN UINT64            Value\r
   );\r
@@ -462,12 +461,12 @@ EFI_STATUS
   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[in]  TokenNumber The PCD token number. \r
+  @param[in]      TokenNumber  The PCD token number. \r
   @param[in, out] 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[in]  Buffer The buffer to 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[in]      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
@@ -478,7 +477,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_SET_POINTER)(\r
   IN      UINTN             TokenNumber,\r
   IN OUT  UINTN             *SizeOfBuffer,\r
   IN      VOID              *Buffer\r
@@ -494,7 +493,7 @@ EFI_STATUS
   If it is not, an error will be returned.\r
 \r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -505,7 +504,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN)(\r
   IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
   );\r
@@ -519,9 +518,9 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -532,7 +531,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_8) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_8)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
@@ -547,9 +546,9 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -560,7 +559,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_16) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_16)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT16            Value\r
@@ -575,9 +574,9 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -588,7 +587,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_32) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_32)(\r
   IN CONST EFI_GUID     *Guid,\r
   IN UINTN              TokenNumber,\r
   IN UINT32             Value\r
@@ -603,9 +602,9 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -616,7 +615,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_64) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_64)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT64            Value\r
@@ -631,13 +630,13 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
-  @param[in]  TokenNumber The PCD token number. \r
+  @param[in]  Guid            The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  TokenNumber     The PCD token number. \r
   @param[in, out] 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[in]  Buffer The buffer to set for the PCD token.\r
+  @param[in]  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
@@ -648,11 +647,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER) (\r
-  IN      CONST EFI_GUID    *Guid,\r
-  IN      UINTN             TokenNumber,\r
-  IN OUT  UINTN             *SizeOfBuffer,\r
-  IN      VOID              *Buffer\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER)(\r
+  IN CONST EFI_GUID          *Guid,\r
+  IN       UINTN             TokenNumber,\r
+  IN OUT   UINTN             *SizeOfBuffer,\r
+  IN       VOID              *Buffer\r
   );\r
 \r
 \r
@@ -664,9 +663,9 @@ EFI_STATUS
   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[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Value The value to set for the PCD token.\r
+  @param[in]  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
@@ -677,7 +676,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN)(\r
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
@@ -696,21 +695,21 @@ EFI_STATUS
   TokenData will be used by PCD service DXE driver to modify the internal data in \r
   PCD database.\r
 \r
-  @param[in]  CallBackGuid The PCD token GUID being set.\r
-  @param[in]  CallBackToken The PCD token number being set.\r
-  @param[in, out]  TokenData A pointer to the token data being set.\r
-  @param[in]  TokenDataSize The size, in bytes, of the data being set.\r
+  @param[in]  CallBackGuid    The PCD token GUID being set.\r
+  @param[in]  CallBackToken   The PCD token number being set.\r
+  @param[in, out] TokenData   A pointer to the token data being set.\r
+  @param[in]  TokenDataSize   The size, in bytes, of the data being set.\r
 \r
   @retval VOID\r
 \r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *PCD_PROTOCOL_CALLBACK) (\r
-  IN      CONST EFI_GUID   *CallBackGuid, OPTIONAL\r
-  IN      UINTN            CallBackToken,\r
-  IN  OUT VOID             *TokenData,\r
-  IN      UINTN            TokenDataSize\r
+(EFIAPI *PCD_PROTOCOL_CALLBACK)(\r
+  IN CONST EFI_GUID         *CallBackGuid, OPTIONAL\r
+  IN       UINTN            CallBackToken,\r
+  IN OUT   VOID             *TokenData,\r
+  IN       UINTN            TokenDataSize\r
   );\r
 \r
 \r
@@ -718,18 +717,18 @@ VOID
 /**\r
   Specifies a function to be called anytime the value of a designated token is changed.\r
 \r
-  @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
-  @param[in]  CallBackFunction The function prototype called when the value associated with the CallBackToken is set.  \r
+  @param[in]  TokenNumber       The PCD token number. \r
+  @param[in]  Guid              The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  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
+  @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_PROTOCOL_CALLBACK_ONSET) (\r
+(EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET)(\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
@@ -740,18 +739,18 @@ EFI_STATUS
 /**\r
   Cancels a previously set callback function for a particular PCD token number.\r
 \r
-  @param[in]  TokenNumber The PCD token number. \r
-  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in]  TokenNumber      The PCD token number. \r
+  @param[in]  Guid             The 128-bit unique value that designates the namespace from which to extract the value.\r
   @param[in]  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
+  @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_PROTOCOL_CANCEL_CALLBACK) (\r
+(EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK)(\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
@@ -762,16 +761,17 @@ EFI_STATUS
 /**\r
   Retrieves the next valid PCD token for a given namespace.\r
 \r
-  @param[in]  Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
-  @param[in,out]  TokenNumber A pointer to the PCD token number to use to find the subsequent token number.  \r
-                  If the input token namespace or token number does not exist on the platform, \r
-                  an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, \r
-                  have the pointer reference a TokenNumber value of 0. If the input token number is 0 and \r
-                  there is no valid token number for this token namespace,  *TokenNumber will be assigned to \r
-                  0 and the function return EFI_SUCCESS. If the token number is the last valid token number, \r
-                  *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r
-\r
-  @retval EFI_SUCCESS  The PCD service retrieved the next valid token number. Or the input token number \r
+  @param[in]      Guid    The 128-bit unique value that designates the namespace from which to extract the value.\r
+  @param[in,out]  TokenNumber \r
+                          A pointer to the PCD token number to use to find the subsequent token number.  \r
+                          If the input token namespace or token number does not exist on the platform, \r
+                          an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, \r
+                          have the pointer reference a TokenNumber value of 0. If the input token number is 0 and \r
+                          there is no valid token number for this token namespace,  *TokenNumber will be assigned to \r
+                          0 and the function return EFI_SUCCESS. If the token number is the last valid token number, \r
+                          *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r
+\r
+  @retval EFI_SUCCESS   The PCD service retrieved the next valid token number. Or the input token number \r
                         is already the last valid token number in the PCD database. \r
                         In the later case, *TokenNumber is updated with the value of 0.\r
   @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.\r
@@ -779,7 +779,7 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN)(\r
   IN      CONST EFI_GUID      *Guid, OPTIONAL\r
   IN OUT  UINTN               *TokenNumber\r
   );\r
@@ -790,16 +790,16 @@ EFI_STATUS
   Retrieves the next valid PCD token namespace for a given namespace.\r
 \r
   @param[in, out]  Guid An indirect pointer to EFI_GUID.  On input it designates \r
-                    a known token namespace from which the search will start. On output, \r
-                    it designates the next valid token namespace on the platform. If the input \r
-                    token namespace does not exist on the platform, an error is returned and \r
-                    the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r
-                    first token space of the current platform is assigned to *Guid the function \r
-                    return EFI_SUCCESS. If  *Guid is NULL  and there is no namespace exist in \r
-                    the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r
-                    and the function return EFI_SUCCESS. If this input token namespace is the last \r
-                    namespace on the platform, *Guid will be assigned to NULL and the function return \r
-                    EFI_SUCCESS. \r
+                        a known token namespace from which the search will start. On output, \r
+                        it designates the next valid token namespace on the platform. If the input \r
+                        token namespace does not exist on the platform, an error is returned and \r
+                        the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r
+                        first token space of the current platform is assigned to *Guid the function \r
+                        return EFI_SUCCESS. If  *Guid is NULL  and there is no namespace exist in \r
+                        the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r
+                        and the function return EFI_SUCCESS. If this input token namespace is the last \r
+                        namespace on the platform, *Guid will be assigned to NULL and the function return \r
+                        EFI_SUCCESS. \r
 \r
   @retval EFI_SUCCESS  The PCD service retrieved the next valid token space Guid. \r
                         Or the input token space Guid is already the last valid token space Guid \r
@@ -809,15 +809,13 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE) (\r
+(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE)(\r
   IN  OUT    CONST EFI_GUID      **Guid\r
   );\r
 \r
-\r
-\r
-//\r
-// Interface structure for the PCD Protocol\r
-//\r
+///\r
+/// This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+///\r
 typedef struct {\r
   PCD_PROTOCOL_SET_SKU              SetSku;\r
 \r