Add [in,out] in the @param for PCD header and c file.

Update GetNextToken and GetNextTokenSpaces APIs parameter sequence according to PCD spec.

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

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Pcd.c b/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
index 4e6b11a046c8bd5df628592eeea03c60434045e4..bb17b88e196a87b9d840ae8f75acdfe73544c27a 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
+++ b/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
@@ -467,8 +467,8 @@ DxePcdSetBoolEx (
 EFI_STATUS\r
 EFIAPI\r
 DxeRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   )\r
 {\r
@@ -482,8 +482,8 @@ DxeRegisterCallBackOnSet (
 EFI_STATUS\r
 EFIAPI\r
 DxeUnRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   )\r
 {\r

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Service.h b/EdkModulePkg/Universal/PCD/Dxe/Service.h
index 271d8b32c4e804c5ae31e3e745160d634aa1ca60..67a7435c23288909fc437320249f49113b28022f 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Dxe/Service.h
+++ b/EdkModulePkg/Universal/PCD/Dxe/Service.h
@@ -284,8 +284,8 @@ DxePcdSetBoolEx (
 EFI_STATUS\r
 EFIAPI\r
 DxeRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   )\r
 ;\r
@@ -294,8 +294,8 @@ DxeRegisterCallBackOnSet (
 EFI_STATUS\r
 EFIAPI\r
 DxeUnRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   )\r
 ;\r

diff --git a/EdkModulePkg/Universal/PCD/Pei/Pcd.c b/EdkModulePkg/Universal/PCD/Pei/Pcd.c
index fe2fa85f4470cbf49a937ad4b9b53fb0af08d3ab..40013cf8b538aed32ba0ff7df184e7743d4e1da3 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Pei/Pcd.c
+++ b/EdkModulePkg/Universal/PCD/Pei/Pcd.c
@@ -441,8 +441,8 @@ PeiPcdSetBoolEx (
 EFI_STATUS\r
 EFIAPI\r
 PeiRegisterCallBackOnSet (\r
-  IN  UINTN                       ExTokenNumber,\r
   IN  CONST EFI_GUID              *Guid, OPTIONAL\r
+  IN  UINTN                       ExTokenNumber,\r
   IN  PCD_PPI_CALLBACK            CallBackFunction\r
   )\r
 {\r
@@ -456,8 +456,8 @@ PeiRegisterCallBackOnSet (
 EFI_STATUS\r
 EFIAPI\r
 PcdUnRegisterCallBackOnSet (\r
-  IN  UINTN                       ExTokenNumber,\r
   IN  CONST EFI_GUID              *Guid, OPTIONAL\r
+  IN  UINTN                       ExTokenNumber,\r
   IN  PCD_PPI_CALLBACK            CallBackFunction\r
   )\r
 {\r

diff --git a/EdkModulePkg/Universal/PCD/Pei/Service.h b/EdkModulePkg/Universal/PCD/Pei/Service.h
index 71a3d7b38f3c693bb5a75dc7537352bc0b91417c..39737acb8350b6662cfb61cc8012c4f304e399b4 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Pei/Service.h
+++ b/EdkModulePkg/Universal/PCD/Pei/Service.h
@@ -279,8 +279,8 @@ PeiPcdSetBoolEx (
 EFI_STATUS\r
 EFIAPI\r
 PeiRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PPI_CALLBACK        CallBackFunction\r
   )\r
 ;\r
@@ -289,8 +289,8 @@ PeiRegisterCallBackOnSet (
 EFI_STATUS\r
 EFIAPI\r
 PcdUnRegisterCallBackOnSet (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PPI_CALLBACK        CallBackFunction\r
   )\r
 ;\r

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 4902d2b3de5e8eafe78b46eec312f440d9ffe4cd..a0201049a5b9f932dd006367886f2d955c2bda02 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -624,9 +624,17 @@ LibPcdSetExBool (
   If Guid is NULL, then the default token space is used. \r
   If NotificationFunction is NULL, then ASSERT().\r
 \r
+  This notification function serves two purposes. Firstly, it notifies the module which \r
+  did the registration that the value of this PCD token has been set. Secondly, \r
+  it provides a mechanism for the module which did the registration to intercept \r
+  the set operation and override the value been set if necessary. After the invocation \r
+  of the callback function, TokenData will be used by PCD service PEIM or driver to \r
+  modify the internal data in PCD database. \r
+\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, 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

diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h
index 97d487e249655e3e25ef9bf9cc94e1c7b48bf7c3..d87b351a2852b1335a3d335b568c103513db2a4f 100644 (file)
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -43,7 +43,7 @@ extern EFI_GUID gPcdPpiGuid;
   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
+  @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
 \r
   @retval VOID\r
@@ -63,7 +63,7 @@ VOID
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT8 value.\r
   \r
@@ -82,7 +82,7 @@ UINT8
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT16 value.\r
   \r
@@ -101,7 +101,7 @@ UINT16
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT32 value.\r
   \r
@@ -120,7 +120,7 @@ UINT32
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT64 value.\r
   \r
@@ -141,7 +141,7 @@ UINT64
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The pointer to the buffer to be retrived.\r
   \r
@@ -162,7 +162,7 @@ VOID *
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The Boolean value.\r
   \r
@@ -181,7 +181,7 @@ BOOLEAN
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size of the value for the PCD token.\r
   \r
@@ -202,8 +202,8 @@ UINTN
   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
+  @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
   \r
@@ -225,8 +225,8 @@ UINT8
   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
+  @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
   \r
@@ -248,8 +248,8 @@ UINT16
   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
+  @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
@@ -271,8 +271,8 @@ UINT32
   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
+  @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
   \r
@@ -294,8 +294,8 @@ UINT64
   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
+  @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
   \r
@@ -317,8 +317,8 @@ VOID *
   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
+  @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
   \r
@@ -338,8 +338,8 @@ BOOLEAN
   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
+  @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
   \r
@@ -360,8 +360,8 @@ UINTN
   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
+  @param[in]  TokenNumber The PCD token number. \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
@@ -386,8 +386,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -412,8 +412,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -438,8 +438,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -465,12 +465,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  TokenNumber The PCD token number. \r
-  @param SizeOfBuffer A pointer to the length of the value being set for the PCD token.  \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  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
@@ -496,8 +496,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -522,9 +522,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -550,9 +550,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -578,9 +578,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -606,9 +606,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -634,13 +634,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  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
+  @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  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
@@ -667,9 +667,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -691,10 +691,17 @@ EFI_STATUS
 /**\r
   Callback on SET function prototype definition.\r
 \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
+  This notification function serves two purposes. Firstly, it notifies the module \r
+  which did the registration that the value of this PCD token has been set. Secondly, \r
+  it provides a mechanism for the module which did the registration to intercept the set \r
+  operation and override the value been set if necessary. After the invocation of the \r
+  callback function, TokenData will be used by PCD service PEIM to modify the internal data \r
+  in 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
 \r
   @retval VOID\r
 \r
@@ -713,9 +720,9 @@ VOID
 /**\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
+  @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
                         for the CallBackToken requested.\r
@@ -725,8 +732,8 @@ VOID
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_CALLBACK_ONSET) (\r
-  IN  UINTN                  TokenNumber,\r
   IN  CONST EFI_GUID         *Guid, OPTIONAL\r
+  IN  UINTN                  TokenNumber,\r
   IN  PCD_PPI_CALLBACK       CallBackFunction\r
   );\r
 \r
@@ -735,9 +742,9 @@ EFI_STATUS
 /**\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
+  @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
                         for the CallBackToken requested.\r
@@ -747,8 +754,8 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PPI_CANCEL_CALLBACK) (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PPI_CALLBACK        CallBackFunction\r
   );\r
 \r
@@ -757,12 +764,19 @@ EFI_STATUS
 /**\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
+  @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, an error is \r
+                    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 \r
+                    and there is no valid token number for this token namespace,  *TokenNumber will be \r
+                    assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid \r
+                    token number, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\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
+  @retval EFI_SUCCESS  The PCD service has retrieved the next valid token number. \r
+                        Or the input token number 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
 \r
 **/\r
 typedef \r
@@ -777,17 +791,23 @@ EFI_STATUS
 /**\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
+  @param[in, out]  Guid An indirect pointer to EFI_GUID.  On input it designates a known \r
+                    token namespace from which the search will start. On output, it designates \r
+                    the next valid token namespace on the platform. If the input token namespace \r
+                    does not exist on the platform, an error is returned and the value of *Guid is \r
+                    undefined. If *Guid is NULL, then the GUID of the first token space of the \r
+                    current platform is assigned to *Guid the function return EFI_SUCCESS. \r
+                    If  *Guid is NULL  and there is no namespace exist in the platform other than the default \r
+                    (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. \r
+                    If this input token namespace is the last namespace 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
+  @retval EFI_SUCCESS  The PCD service has retrieved the next valid token namespace. \r
+                        Or the input token namespace is already the last valid token \r
+                        number in the PCD database. In the later case, *Guid is updated \r
+                        with the value of NULL. Or the input token name space is NULL and there \r
+                        is no valid token namespace other than the default namespace (NULL).\r
+  @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h
index 89ffb917d6ca8ee71bff10122ddac0f2c0feec3f..f0710362204ea5501e90a3a22d2240252014ba1a 100644 (file)
--- a/MdePkg/Include/Protocol/Pcd.h
+++ b/MdePkg/Include/Protocol/Pcd.h
@@ -42,7 +42,7 @@ extern EFI_GUID gPcdProtocolGuid;
   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
+  @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
 \r
   @retval VOID\r
@@ -62,7 +62,7 @@ VOID
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT8 value.\r
   \r
@@ -81,7 +81,7 @@ UINT8
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT16 value.\r
   \r
@@ -100,7 +100,7 @@ UINT16
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT32 value.\r
   \r
@@ -119,7 +119,7 @@ UINT32
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The UINT64 value.\r
   \r
@@ -140,7 +140,7 @@ UINT64
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The pointer to the buffer to be retrived.\r
   \r
@@ -161,7 +161,7 @@ VOID *
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The Boolean value.\r
   \r
@@ -180,7 +180,7 @@ BOOLEAN
   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
+  @param[in]  TokenNumber The PCD token number. \r
 \r
   @return The size of the value for the PCD token.\r
   \r
@@ -201,8 +201,8 @@ UINTN
   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
+  @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
   \r
@@ -224,8 +224,8 @@ UINT8
   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
+  @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
   \r
@@ -247,8 +247,8 @@ UINT16
   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
+  @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
@@ -269,8 +269,8 @@ UINT32
   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
+  @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
   \r
@@ -292,8 +292,8 @@ UINT64
   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
+  @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
   \r
@@ -315,8 +315,8 @@ VOID *
   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
+  @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
   \r
@@ -336,8 +336,8 @@ BOOLEAN
   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
+  @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
   \r
@@ -358,8 +358,8 @@ UINTN
   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
+  @param[in]  TokenNumber The PCD token number. \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
@@ -384,8 +384,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -410,8 +410,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -436,8 +436,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -462,12 +462,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  TokenNumber The PCD token number. \r
-  @param SizeOfBuffer A pointer to the length of the value being set for the PCD token.  \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  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
@@ -493,8 +493,8 @@ 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  TokenNumber The PCD token number. \r
-  @param  Value The value to set for the PCD token.\r
+  @param[in]  TokenNumber The PCD token number. \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
@@ -519,9 +519,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -547,9 +547,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -575,9 +575,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -603,9 +603,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -631,13 +631,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  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
+  @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  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
@@ -664,9 +664,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  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
+  @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
 \r
   @retval EFI_SUCCESS  Procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
@@ -688,10 +688,18 @@ EFI_STATUS
 /**\r
   Callback on SET function prototype definition.\r
 \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
+  This notification function serves two purposes. \r
+  Firstly, it notifies the module which did the registration that the value \r
+  of this PCD token has been set. Secondly, it provides a mechanism for the \r
+  module which did the registration to intercept the set operation and override \r
+  the value been set if necessary. After the invocation of the callback function, \r
+  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
 \r
   @retval VOID\r
 \r
@@ -710,9 +718,9 @@ VOID
 /**\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
+  @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
                         for the CallBackToken requested.\r
@@ -722,8 +730,8 @@ VOID
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET) (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   );\r
 \r
@@ -732,9 +740,9 @@ EFI_STATUS
 /**\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
+  @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
                         for the CallBackToken requested.\r
@@ -744,8 +752,8 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK) (\r
-  IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
+  IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
   );\r
 \r
@@ -754,12 +762,19 @@ EFI_STATUS
 /**\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
+  @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 value requested.\r
-  @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.\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
 \r
 **/\r
 typedef \r
@@ -774,23 +789,28 @@ EFI_STATUS
 /**\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
+  @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
 \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
+  @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
+                        in the PCD database. In the later case, *Guid is updated with the value of NULL.\r
+  @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
 \r
 **/\r
 typedef \r
 EFI_STATUS\r
 (EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE) (\r
-  IN      CONST EFI_GUID      **Guid\r
+  IN  OUT    CONST EFI_GUID      **Guid\r
   );\r
 \r
 \r

diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c
index 2747df35c0e17db2ee2a487e86b002a300c3901b..7f502b4253baa91a74542ff3d610ef5c5f8c36a4 100644 (file)
--- a/MdePkg/Library/DxePcdLib/DxePcdLib.c
+++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c
@@ -806,7 +806,7 @@ LibPcdCallbackOnSet (
 \r
   ASSERT (NotificationFunction != NULL);\r
 \r
-  Status = mPcd->CallbackOnSet (TokenNumber, Guid, NotificationFunction);\r
+  Status = mPcd->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -838,7 +838,7 @@ LibPcdCancelCallback (
 \r
   ASSERT (NotificationFunction != NULL);\r
     \r
-  Status = mPcd->CancelCallback (TokenNumber, Guid, NotificationFunction);\r
+  Status = mPcd->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r

diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
index b67d5f4ef21e458806d0a9a1355677a6f3730ebd..f241227fb32eb8fbb8b2bce0b6e5850aa68a5f69 100644 (file)
--- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
+++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
@@ -906,7 +906,7 @@ LibPcdCallbackOnSet (
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
-  Status = PcdPpi->CallbackOnSet (TokenNumber, Guid, NotificationFunction);\r
+  Status = PcdPpi->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -940,7 +940,7 @@ LibPcdCancelCallback (
   PcdPpi = GetPcdPpiPtr ();\r
 \r
 \r
-  Status = PcdPpi->CancelCallback (TokenNumber, Guid, NotificationFunction);\r
+  Status = PcdPpi->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
 \r
   ASSERT_EFI_ERROR (Status);\r
 \r