1) Fix GCC version EBC interpreter bug.

[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.h

diff --git a/MdeModulePkg/Universal/PCD/Dxe/Service.h b/MdeModulePkg/Universal/PCD/Dxe/Service.h
index 5349be8d927bfa7b60d192090ca7a0355977e3a0..54e38e5599d6e880a2dc7e631487e491c905beb6 100644 (file)
--- a/MdeModulePkg/Universal/PCD/Dxe/Service.h
+++ b/MdeModulePkg/Universal/PCD/Dxe/Service.h
@@ -1,8 +1,8 @@
 /** @file\r
 Private functions used by PCD DXE driver.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+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
 http://opensource.org/licenses/bsd-license.php\r
@@ -18,6 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <PiDxe.h>\r
 #include <Guid/PcdDataBaseHobGuid.h>\r
 #include <Protocol/Pcd.h>\r
+#include <Protocol/PiPcd.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/UefiLib.h>\r
@@ -680,18 +681,28 @@ DxeUnRegisterCallBackOnSet (
   );\r
 \r
 /**\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
+  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 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
+  If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.  \r
+  If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned.  \r
+  The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid.  \r
+  If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned.  \r
+  If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned.  \r
+  If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.\r
+\r
+\r
+  @param[in]      Guid    The 128-bit unique value that designates the namespace from which to retrieve the next token. \r
+                          This is an optional parameter that may be NULL.  If this parameter is NULL, then a request is \r
+                          being made to retrieve tokens from the default token space.\r
+  @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
@@ -707,14 +718,10 @@ DxePcdGetNextToken (
 /**\r
   Get next token space in PCD database according to given token space guid.\r
   \r
-  This routine is enable only when feature flag PCD PcdDxePcdDatabaseTraverseEnabled \r
-  is TRUE.\r
-  \r
   @param Guid            Given token space guid. If NULL, then Guid will be set to \r
                          the first PCD token space in PCD database, If not NULL, then\r
                          Guid will be set to next PCD token space.\r
 \r
-  @retval EFI_UNSUPPORTED If feature flag PCD PcdDxePcdDatabaseTraverseEnabled is FALSE.\r
   @retval EFI_NOT_FOUND   If PCD database has no token space table or can not find given\r
                           token space in PCD database.\r
   @retval EFI_SUCCESS     Success to get next token space guid.\r
@@ -764,6 +771,7 @@ SetValueWorker (
 \r
   @retval EFI_INVALID_PARAMETER  If this PCD type is VPD, VPD PCD can not be set.\r
   @retval EFI_INVALID_PARAMETER  If Size can not be set to size table.\r
+  @retval EFI_INVALID_PARAMETER  If Size of non-Ptr type PCD does not match the size information in PCD database.  \r
   @retval EFI_NOT_FOUND          If value type of PCD entry is intergrate, but not in\r
                                  range of UINT8, UINT16, UINT32, UINT64\r
   @retval EFI_NOT_FOUND          Can not find the PCD type according to token number.                                \r
@@ -1065,3 +1073,4 @@ extern DXE_PCD_DATABASE_INIT gDXEPcdDbInit;
 extern EFI_LOCK mPcdDatabaseLock;\r
 \r
 #endif\r
+\r