/** @file\r
Implementation of PcdLib class library for PEI phase.\r
\r
-Copyright (c) 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials \r
+Copyright (c) 2006 - 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
#include <PiPei.h>\r
\r
#include <Ppi/Pcd.h>\r
+#include <Ppi/PiPcd.h>\r
+#include <Ppi/PcdInfo.h>\r
+#include <Ppi/PiPcdInfo.h>\r
\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
return PcdPpi;\r
}\r
\r
+/**\r
+ Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3.\r
+\r
+ This function is to locate EFI_PEI_PCD_PPI PPI via PeiService. \r
+ If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR().\r
+ \r
+ @retval EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI.\r
+\r
+**/\r
+EFI_PEI_PCD_PPI *\r
+GetPiPcdPpiPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_PEI_PCD_PPI *PiPcdPpi;\r
+ \r
+ Status = PeiServicesLocatePpi (&gEfiPeiPcdPpiGuid, 0, NULL, (VOID **)&PiPcdPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ return PiPcdPpi;\r
+} \r
+\r
+/**\r
+ Retrieve the GET_PCD_INFO_PPI pointer.\r
+\r
+ This function is to locate GET_PCD_INFO_PPI PPI via PeiService. \r
+ If fail to locate GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
+\r
+ @retval GET_PCD_INFO_PPI * The pointer to the GET_PCD_INFO_PPI.\r
+\r
+**/\r
+GET_PCD_INFO_PPI *\r
+GetPcdInfoPpiPointer (\r
+ VOID\r
+ ) \r
+{\r
+ EFI_STATUS Status;\r
+ GET_PCD_INFO_PPI *PcdInfoPpi;\r
+ \r
+ Status = PeiServicesLocatePpi (&gGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PcdInfoPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return PcdInfoPpi;\r
+}\r
+\r
+/**\r
+ Retrieve the pointer of EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 Vol 3.\r
+\r
+ This function is to locate EFI_GET_PCD_INFO_PPI PPI via PeiService. \r
+ If fail to locate EFI_GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
+\r
+ @retval EFI_GET_PCD_INFO_PPI * The pointer to the EFI_GET_PCD_INFO_PPI.\r
+\r
+**/\r
+EFI_GET_PCD_INFO_PPI *\r
+GetPiPcdInfoPpiPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_GET_PCD_INFO_PPI *PiPcdInfoPpi;\r
+ \r
+ Status = PeiServicesLocatePpi (&gEfiGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PiPcdInfoPpi);\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ return PiPcdInfoPpi;\r
+} \r
+\r
/**\r
This function provides a means by which SKU support can be established in the PCD infrastructure.\r
\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r
+ If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
\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
- If SkuId >= 0x100, then ASSERT(). \r
+ @param SkuId The SKU value that will be used when the PCD service retrieves \r
+ and sets values associated with a PCD token.\r
\r
- @return Return the SKU ID that just be set.\r
+ @return Return the SKU ID that just be set.\r
\r
**/\r
UINTN\r
\r
ASSERT (SkuId < PCD_MAX_SKU_ID);\r
\r
- GetPcdPpiPointer()->SetSku (SkuId);\r
-\r
+ GetPiPcdPpiPointer()->SetSku (SkuId);\r
+ \r
return SkuId;\r
}\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
@return Return the UINT8.\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return (GetPcdPpiPointer ())->Get8Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get8 (Guid, TokenNumber);\r
}\r
\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
@return Return the UINT16.\r
\r
\r
ASSERT (Guid != NULL);\r
\r
- return (GetPcdPpiPointer ())->Get16Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get16 (Guid, TokenNumber);\r
}\r
\r
\r
Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
@return Return the UINT32.\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return (GetPcdPpiPointer ())->Get32Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get32 (Guid, TokenNumber);\r
}\r
\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
)\r
{\r
ASSERT (Guid != NULL);\r
- return (GetPcdPpiPointer ())->Get64Ex (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->Get64 (Guid, TokenNumber);\r
}\r
\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return (GetPcdPpiPointer ())->GetPtrEx (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->GetPtr (Guid, TokenNumber);\r
}\r
\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
)\r
{\r
ASSERT (Guid != NULL);\r
- return (GetPcdPpiPointer ())->GetBoolEx (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->GetBool (Guid, TokenNumber);\r
}\r
\r
\r
\r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ @param[in] Guid The pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
)\r
{\r
ASSERT (Guid != NULL);\r
- return (GetPcdPpiPointer ())->GetSizeEx (Guid, TokenNumber);\r
+ return (GetPiPcdPpiPointer ())->GetSize (Guid, TokenNumber);\r
}\r
\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 8-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT8\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 16-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT16\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 32-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT32\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 64-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT64\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The boolean value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
BOOLEAN\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 8-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT8\r
\r
ASSERT (Guid != NULL);\r
\r
- Status = (GetPcdPpiPointer ())->Set8Ex (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->Set8 (Guid, TokenNumber, Value);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 16-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT16\r
{\r
EFI_STATUS Status;\r
ASSERT (Guid != NULL);\r
- Status = (GetPcdPpiPointer ())->Set16Ex (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->Set16 (Guid, TokenNumber, Value);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 32-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT32\r
\r
ASSERT (Guid != NULL);\r
\r
- Status = (GetPcdPpiPointer ())->Set32Ex (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->Set32 (Guid, TokenNumber, Value);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
Guid to the value specified by Value. Value is returned.\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The 64-bit value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
UINT64\r
EFI_STATUS Status;\r
ASSERT (Guid != NULL);\r
\r
- Status = (GetPcdPpiPointer ())->Set64Ex (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->Set64 (Guid, TokenNumber, Value);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
}\r
ASSERT (Guid != NULL);\r
\r
- Status = (GetPcdPpiPointer ())->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+ Status = (GetPiPcdPpiPointer ())->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
\r
if (EFI_ERROR (Status)) {\r
return NULL;\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
@param[in] Value The Boolean value to set.\r
\r
- @return Return the value been set.\r
+ @return Return the value that was set.\r
\r
**/\r
BOOLEAN\r
EFI_STATUS Status;\r
\r
ASSERT (Guid != NULL);\r
- Status = (GetPcdPpiPointer ())->SetBoolEx (Guid, TokenNumber, Value);\r
+ Status = (GetPiPcdPpiPointer ())->SetBool (Guid, TokenNumber, Value);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
\r
When the token specified by TokenNumber and Guid is set, \r
then notification function specified by NotificationFunction is called. \r
- If Guid is NULL, then the default token space is used. \r
- \r
+ If Guid is NULL, then the default token space is used.\r
If NotificationFunction is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which \r
- namespace to set a value from. If NULL, then the default \r
- token space is used.\r
- @param[in] TokenNumber The PCD token number to monitor.\r
+ @param[in] Guid The pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from. \r
+ If NULL, then the default token space is used.\r
+ @param[in] TokenNumber The PCD token number to monitor.\r
@param[in] NotificationFunction The function to call when the token \r
specified by Guid and TokenNumber is set.\r
\r
{\r
EFI_STATUS Status;\r
\r
- Status = (GetPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
+ ASSERT (NotificationFunction != NULL);\r
+\r
+ Status = (GetPiPcdPpiPointer ())->CallbackOnSet (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
/**\r
Disable a notification function that was established with LibPcdCallbackonSet().\r
\r
- Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
- \r
+ Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
If NotificationFunction is NULL, then ASSERT().\r
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
and NotificationFunction, then ASSERT().\r
\r
- @param[in] Guid Specify the GUID token space.\r
- @param[in] TokenNumber Specify the token number.\r
+ @param[in] Guid Specify the GUID token space.\r
+ @param[in] TokenNumber Specify the token number.\r
@param[in] NotificationFunction The callback function to be unregistered.\r
\r
**/\r
{\r
EFI_STATUS Status;\r
\r
- Status = (GetPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
+ ASSERT (NotificationFunction != NULL);\r
+\r
+ Status = (GetPiPcdPpiPointer ())->CancelCallback (Guid, TokenNumber, (EFI_PEI_PCD_PPI_CALLBACK) NotificationFunction);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
\r
If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which namespace \r
+ @param[in] Guid The pointer to a 128-bit unique value that designates which namespace \r
to set a value from. If NULL, then the default token space is used.\r
@param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD \r
token number.\r
IN UINTN TokenNumber\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- Status = (GetPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
+ EFI_STATUS Status;\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ Status = (GetPiPcdPpiPointer ())->GetNextToken (Guid, &TokenNumber);\r
+ ASSERT (!EFI_ERROR (Status) || TokenNumber == 0);\r
\r
return TokenNumber;\r
}\r
/**\r
Used to retrieve the list of available PCD token space GUIDs.\r
\r
- Retrieves the next PCD token space from a token space specified by Guid.\r
- Guid of NULL is reserved to mark the default local token namespace on the current\r
- platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
- current platform is returned. If Guid is the last non-local token space, \r
- then NULL is returned. \r
-\r
- If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
+ Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+ in the platform.\r
+ If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
+ If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace \r
- to start the search.\r
+ @param TokenSpaceGuid The pointer to the a PCD token space GUID\r
\r
@return The next valid token namespace.\r
\r
**/\r
-GUID * \r
+GUID *\r
EFIAPI\r
LibPcdGetNextTokenSpace (\r
IN CONST GUID *TokenSpaceGuid\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- Status = (GetPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ (GetPiPcdPpiPointer ())->GetNextTokenSpace (&TokenSpaceGuid);\r
\r
return (GUID *) TokenSpaceGuid;\r
}\r
return (VOID *) Buffer;\r
}\r
\r
+/**\r
+ Retrieve additional information associated with a PCD token.\r
+\r
+ This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+ human readable name that is associated with the token.\r
+\r
+ If TokenNumber is not in the default token space specified, then ASSERT().\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r
+ The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+**/\r
+VOID\r
+EFIAPI\r
+LibPcdGetInfo (\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = GetPcdInfoPpiPointer()->GetInfo (TokenNumber, (EFI_PCD_INFO *) PcdInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+}\r
+\r
+/**\r
+ Retrieve additional information associated with a PCD token.\r
+\r
+ This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+ human readable name that is associated with the token.\r
+\r
+ If TokenNumber is not in the token space specified by Guid, then ASSERT().\r
\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[out] PcdInfo The returned information associated with the requested TokenNumber.\r
+ The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+**/\r
+VOID\r
+EFIAPI\r
+LibPcdGetInfoEx (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = GetPiPcdInfoPpiPointer()->GetInfo (Guid, TokenNumber, (EFI_PCD_INFO *) PcdInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+}\r
+\r
+/**\r
+ Retrieve the currently set SKU Id.\r
+\r
+ If the sku id got >= PCD_MAX_SKU_ID, then ASSERT().\r
+\r
+ @return The currently set SKU Id. If the platform has not set at a SKU Id, then the\r
+ default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r
+ Id is returned.\r
+**/\r
+UINTN\r
+EFIAPI\r
+LibPcdGetSku (\r
+ VOID\r
+ )\r
+{\r
+ UINTN SkuId;\r
+\r
+ SkuId = GetPiPcdInfoPpiPointer()->GetSku ();\r
+ ASSERT (SkuId < PCD_MAX_SKU_ID);\r
+\r
+ return SkuId;\r
+}\r
projects / mirror_edk2.git / blobdiff