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

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

diff --git a/MdePkg/Include/Ppi/PiPcd.h b/MdePkg/Include/Ppi/PiPcd.h
index 372bb117e9ffa9b31f00957f5a9c5dbbbfc456d7..4698ecc3ada54a793f8351f5ae4eb1ddc4c0419d 100644 (file)
--- a/MdePkg/Include/Ppi/PiPcd.h
+++ b/MdePkg/Include/Ppi/PiPcd.h
@@ -1,19 +1,18 @@
 /** @file\r
-  Platform Configuration Database (PCD) Protocol defined in PI 1.2 Vol3\r
+  Platform Configuration Database (PCD) PPI defined in PI 1.2 Vol3\r
 \r
   A platform database that contains a variety of current platform settings or\r
   directives that can be accessed by a driver or application.\r
-  PI PCD protocol only provide the accessing interfaces for Dynamic-Ex type PCD.\r
+  PI PCD ppi only provide the accessing interfaces for Dynamic-Ex type PCD.\r
 \r
-  Callers to this protocol must be at a TPL_APPLICATION task priority level.\r
   This is the base PCD service API that provides an abstraction for accessing configuration content in\r
   the platform. It a seamless mechanism for extracting information regardless of where the\r
   information is stored (such as in Read-only data, or an EFI Variable).\r
   This protocol allows access to data through size-granular APIs and provides a mechanism for a\r
   firmware component to monitor specific settings and be alerted when a setting is changed.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2009 - 2013, 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
@@ -73,7 +72,7 @@ UINT8
 );\r
 \r
 /**\r
-  Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid,\r
+  Retrieves the current word-sized value for a PCD token number. If the TokenNumber is invalid,\r
   the results are unpredictable.\r
 \r
   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.\r
@@ -375,7 +374,8 @@ EFI_STATUS
   know what token numbers are valid in the database.\r
 \r
   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.\r
-  @param[in]    TokenNumber   The PCD token number.\r
+  @param[in]    TokenNumber   A pointer to the PCD token number to use to find the subsequent token number. To\r
+                              retrieve the "first" token, have the pointer reference a TokenNumber value of 0.\r
 \r
   @retval   EFI_SUCCESS       The PCD service has retrieved the value requested.\r
   @retval   EFI_NOT_FOUND     The PCD service could not find data from the requested token number.\r
@@ -410,19 +410,19 @@ EFI_STATUS
 \r
 typedef struct {\r
   EFI_PEI_PCD_PPI_SET_SKU               SetSku;\r
-  EFI_PEI_PCD_PPI_GET_8                 GetEx8;\r
-  EFI_PEI_PCD_PPI_GET_16                GetEx16;\r
-  EFI_PEI_PCD_PPI_GET_32                GetEx32;\r
-  EFI_PEI_PCD_PPI_GET_64                GetEx64;\r
-  EFI_PEI_PCD_PPI_GET_POINTER           GetExPtr;\r
-  EFI_PEI_PCD_PPI_GET_BOOLEAN           GetExBool;\r
-  EFI_PEI_PCD_PPI_GET_SIZE              GetExSize;\r
-  EFI_PEI_PCD_PPI_SET_8                 SetEx8;\r
-  EFI_PEI_PCD_PPI_SET_16                SetEx16;\r
-  EFI_PEI_PCD_PPI_SET_32                SetEx32;\r
-  EFI_PEI_PCD_PPI_SET_64                SetEx64;\r
-  EFI_PEI_PCD_PPI_SET_POINTER           SetExPtr;\r
-  EFI_PEI_PCD_PPI_SET_BOOLEAN           SetExBool;\r
+  EFI_PEI_PCD_PPI_GET_8                 Get8;\r
+  EFI_PEI_PCD_PPI_GET_16                Get16;\r
+  EFI_PEI_PCD_PPI_GET_32                Get32;\r
+  EFI_PEI_PCD_PPI_GET_64                Get64;\r
+  EFI_PEI_PCD_PPI_GET_POINTER           GetPtr;\r
+  EFI_PEI_PCD_PPI_GET_BOOLEAN           GetBool;\r
+  EFI_PEI_PCD_PPI_GET_SIZE              GetSize;\r
+  EFI_PEI_PCD_PPI_SET_8                 Set8;\r
+  EFI_PEI_PCD_PPI_SET_16                Set16;\r
+  EFI_PEI_PCD_PPI_SET_32                Set32;\r
+  EFI_PEI_PCD_PPI_SET_64                Set64;\r
+  EFI_PEI_PCD_PPI_SET_POINTER           SetPtr;\r
+  EFI_PEI_PCD_PPI_SET_BOOLEAN           SetBool;\r
   EFI_PEI_PCD_PPI_CALLBACK_ON_SET       CallbackOnSet;\r
   EFI_PEI_PCD_PPI_CANCEL_CALLBACK       CancelCallback;\r
   EFI_PEI_PCD_PPI_GET_NEXT_TOKEN        GetNextToken;\r