MdePkg and MdeModulePkg Pcd: Implement PCD Driver for External PCD Database and SKU...

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

diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h
index da250a59ed648b3f4e462493189e59a2e19ca7d8..79e9c3e971ce4b2731030c5cd7ae89db8935783b 100644 (file)
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -6,7 +6,7 @@
   The interfaces for dynamic type PCD do not require the token space guid as parameter,\r
   but interfaces for dynamic-ex type PCD require token space guid as parameter.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -775,10 +775,8 @@ EFI_STATUS
                                is being made to retrieve tokens from the default token space.\r
   @param[in, out]  TokenNumber A pointer to the PCD token number to use to find the subsequent token number.\r
                    \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
+  @retval EFI_SUCCESS   The PCD service has retrieved the next valid token number.\r
+  @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.\r
 \r
 **/\r
 typedef \r
@@ -793,25 +791,17 @@ EFI_STATUS
 /**\r
   Retrieves the next valid PCD token namespace for a given namespace.\r
 \r
-  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
-\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.\r
-\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
+  Gets the next valid token namespace for a given namespace. This is useful to traverse the valid\r
+  token namespaces on a platform.\r
+\r
+  @param[in, out]   Guid    An indirect pointer to EFI_GUID. On input it designates a known token\r
+                            namespace from which the search will start. On output, it designates the next valid\r
+                            token namespace on the platform. If *Guid is NULL, then the GUID of the first token\r
+                            space of the current platform is returned. If the search cannot locate the next valid\r
+                            token namespace, an error is returned and 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 next valid token namespace.\r
 \r
 **/\r
 typedef\r