Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Ppi / Pcd.h

diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h
index 4198e8ed1d52c8becf93316626b37a46136f8d8c..d5cc3b59dbcac3aae07d0dad07c2cd7c4f62f330 100644 (file)
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -193,7 +193,7 @@ UINTN
 \r
 \r
 /**\r
-  Retrieves an 8-bit value for a given PCD token.\r
+  Retrieves an 8-bit value for a given PCD token and token space.\r
 \r
   Retrieves the 8-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -216,7 +216,7 @@ UINT8
 \r
 \r
 /**\r
-  Retrieves an 16-bit value for a given PCD token.\r
+  Retrieves an 16-bit value for a given PCD token and token space.\r
 \r
   Retrieves the 16-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -239,7 +239,7 @@ UINT16
 \r
 \r
 /**\r
-  Retrieves an 32-bit value for a given PCD token.\r
+  Retrieves an 32-bit value for a given PCD token and token space.\r
 \r
   Retrieves the 32-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -262,7 +262,7 @@ UINT32
 \r
 \r
 /**\r
-  Retrieves an 64-bit value for a given PCD token.\r
+  Retrieves an 64-bit value for a given PCD token and token space.\r
 \r
   Retrieves the 64-bit value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -285,7 +285,7 @@ UINT64
 \r
 \r
 /**\r
-  Retrieves a pointer to a value for a given PCD token.\r
+  Retrieves a pointer to a value for a given PCD token and token space.\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
@@ -308,7 +308,7 @@ VOID *
 \r
 \r
 /**\r
-  Retrieves an Boolean value for a given PCD token.\r
+  Retrieves an Boolean value for a given PCD token and token space.\r
 \r
   Retrieves the Boolean value of a particular PCD token.  \r
   If the TokenNumber is invalid or the token space\r
@@ -331,7 +331,7 @@ BOOLEAN
 \r
 \r
 /**\r
-  Retrieves the size of the value for a given PCD token.\r
+  Retrieves the size of the value for a given PCD token and token space.\r
 \r
   Retrieves the current size of a particular PCD token.  \r
   If the TokenNumber is invalid, the results are unpredictable.\r
@@ -819,6 +819,104 @@ EFI_STATUS
 //\r
 // Interface structure for the PCD PPI\r
 //\r
+/**\r
+  @par Ppi Description:\r
+  This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+\r
+  @param SetSku\r
+  Sets the SKU value for subsequent calls to set or get PCD token values.\r
+  \r
+  @param Get8\r
+  Retrieves an 8-bit value for a given PCD token.\r
+\r
+  @param Get16\r
+  Retrieves an 16-bit value for a given PCD token.\r
+\r
+  @param Get32\r
+  Retrieves an 32-bit value for a given PCD token.\r
+\r
+  @param Get64\r
+  Retrieves an 64-bit value for a given PCD token.\r
+\r
+  @param GetPtr\r
+  Retrieves a pointer to a value for a given PCD token.\r
+\r
+  @param GetBool\r
+  Retrieves an Boolean value for a given PCD token.\r
+\r
+  @param GetSize\r
+  Retrieves the size of the value for a given PCD token.\r
+\r
+  @param Get8Ex\r
+  Retrieves an 8-bit value for a given PCD token and token space.\r
+\r
+  @param Get16Ex\r
+  Retrieves an 16-bit value for a given PCD token and token space.\r
+\r
+  @param Get32Ex\r
+  Retrieves an 32-bit value for a given PCD token and token space.\r
+\r
+  @param Get64Ex\r
+  Retrieves an 64-bit value for a given PCD token and token space.\r
+\r
+  @param GetPtrEx\r
+  Retrieves a pointer to a value for a given PCD token and token space.\r
+\r
+  @param GetBoolEx\r
+  Retrieves an Boolean value for a given PCD token and token space.\r
+\r
+  @param GetSizeEx\r
+  Retrieves the size of the value for a given PCD token and token space.\r
+\r
+  @param Set8\r
+  Sets an 8-bit value for a given PCD token.\r
+\r
+  @param Set16\r
+  Sets an 16-bit value for a given PCD token.\r
+\r
+  @param Set32\r
+  Sets an 32-bit value for a given PCD token.\r
+\r
+  @param Set64\r
+  Sets an 64-bit value for a given PCD token.\r
+\r
+  @param SetPtr\r
+  Sets the buffer of a specified size for a given PCD token.\r
+\r
+  @param SetBool\r
+  Sets an Boolean value for a given PCD token.\r
+\r
+  @param Set8Ex\r
+  Sets an 8-bit value for a given PCD token and token space.\r
+\r
+  @param Set16Ex\r
+  Sets an 16-bit value for a given PCD token and token space.\r
+\r
+  @param Set32Ex\r
+  Sets an 32-bit value for a given PCD token and token space.\r
+\r
+  @param Set64Ex\r
+  Sets an 64-bit value for a given PCD token and token space.\r
+\r
+  @param SetPtrEx\r
+  Sets the buffer of a specified size for a given PCD token and token space.\r
+\r
+  @param SetBoolEx\r
+  Sets an Boolean value for a given PCD token and token space.\r
+  \r
+  @param CallbackOnSet\r
+  Specifies a function to be called anytime the value of a designated token is changed.\r
+  \r
+  @param CancelCallback\r
+  Cancels a previously set callback function for a particular PCD token number.\r
+  \r
+  @param GetNextToken\r
+  Retrieves the next valid PCD token for a given namespace.\r
+  \r
+  @param GetNextTokenSpace\r
+  Retrieves the next valid PCD token namespace for a given namespace.\r
+ \r
+**/\r
 typedef struct {\r
   PCD_PPI_SET_SKU              SetSku;\r
 \r