MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC

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

diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h
index 31b413301aa774f76f03027d2ca3c1e9511761f3..03b02fd936ebb2b3b08fa932260c798df8c61425 100644 (file)
--- a/MdePkg/Include/Protocol/Pcd.h
+++ b/MdePkg/Include/Protocol/Pcd.h
@@ -6,7 +6,7 @@
   The interfaces in dynamic type PCD do not require the token space guid as parameter,\r
   but interfaces in 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
@@ -766,7 +766,7 @@ EFI_STATUS
   Retrieves the next valid token number in a given namespace.  \r
   \r
   This is useful since the PCD infrastructure contains a sparse list of token numbers, \r
-  and one cannot know without examination or by deduction what token numbers are valid in the database. \r
+  and one cannot a priori know what token numbers are valid in the database.\r
   \r
   If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.  \r
   If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.  \r
@@ -784,10 +784,8 @@ EFI_STATUS
   @param[in,out]  TokenNumber \r
                           A pointer to the PCD token number to use to find the subsequent token number.  \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
+  @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
@@ -802,22 +800,17 @@ EFI_STATUS
 /**\r
   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) token namespace, *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
-                        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
+  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 namespace\r
+                            from which the search will start. On output, it designates the next valid token\r
+                            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