/** @file\r
Implementation of PcdLib class library for DXE phase.\r
\r
-Copyright (c) 2006 - 2008, 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 <PiDxe.h>\r
\r
#include <Protocol/Pcd.h>\r
+#include <Protocol/PiPcd.h>\r
\r
#include <Library/PcdLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
-PCD_PROTOCOL *mPcd = NULL;\r
-\r
+PCD_PROTOCOL *mPcd = NULL;\r
+EFI_PCD_PROTOCOL *mPiPcd = NULL;\r
\r
/**\r
- The constructor function caches the PCD_PROTOCOL pointer.\r
+ Retrieves the PI PCD protocol from the handle database.\r
+**/\r
+EFI_PCD_PROTOCOL *\r
+EFIAPI\r
+GetPiPcdProtocol (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
- @param[in] SystemTable A pointer to the EFI System Table.\r
- \r
- @retval EFI_SUCCESS The constructor always return EFI_SUCCESS.\r
+ if (mPiPcd == NULL) {\r
+ //\r
+ // PI Pcd protocol defined in PI 1.2 vol3 should be installed before the module \r
+ // access DynamicEx type PCD.\r
+ //\r
+ Status = gBS->LocateProtocol (&gEfiPcdProtocolGuid, NULL, (VOID **) &mPiPcd);\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mPiPcd != NULL);\r
+ }\r
+ return mPiPcd;\r
+}\r
\r
+/**\r
+ Retrieves the PCD protocol from the handle database.\r
**/\r
-EFI_STATUS\r
+PCD_PROTOCOL *\r
EFIAPI\r
-PcdLibConstructor (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+GetPcdProtocol (\r
+ VOID\r
)\r
{\r
EFI_STATUS Status;\r
\r
- //\r
- // PCD protocol has not been installed, but a module needs to access a\r
- // dynamic PCD entry.\r
- // \r
- Status = gBS->LocateProtocol (&gPcdProtocolGuid, NULL, (VOID **)&mPcd);\r
- ASSERT_EFI_ERROR (Status);\r
- ASSERT (mPcd!= NULL);\r
-\r
- return Status;\r
+ if (mPcd == NULL) {\r
+ //\r
+ // PCD protocol need to be installed before the module access Dynamic type PCD.\r
+ // But dynamic type PCD is not required in PI 1.2 specification.\r
+ // \r
+ Status = gBS->LocateProtocol (&gPcdProtocolGuid, NULL, (VOID **)&mPcd);\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mPcd != NULL);\r
+ }\r
+ return mPcd;\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 and sets values\r
+ 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
- mPcd->SetSku (SkuId);\r
+ GetPcdProtocol()->SetSku (SkuId);\r
\r
return SkuId;\r
}\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->Get8 (TokenNumber);\r
+ return GetPcdProtocol()->Get8 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->Get16 (TokenNumber);\r
+ return GetPcdProtocol()->Get16 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->Get32 (TokenNumber);\r
+ return GetPcdProtocol()->Get32 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->Get64 (TokenNumber);\r
+ return GetPcdProtocol()->Get64 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->GetPtr (TokenNumber);\r
+ return GetPcdProtocol()->GetPtr (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->GetBool (TokenNumber);\r
+ return GetPcdProtocol()->GetBool (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- return mPcd->GetSize (TokenNumber);\r
+ return GetPcdProtocol()->GetSize (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 UINT8.\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPcd->Get8Ex (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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 mPcd->Get16Ex (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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 mPcd->Get32Ex (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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
ASSERT (Guid != NULL);\r
\r
- return mPcd->Get64Ex (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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 mPcd->GetPtrEx (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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
ASSERT (Guid != NULL);\r
\r
- return mPcd->GetBoolEx (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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
ASSERT (Guid != NULL);\r
\r
- return mPcd->GetSizeEx (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->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
{\r
EFI_STATUS Status;\r
\r
- Status = mPcd->Set8 (TokenNumber, Value);\r
-\r
+ Status = GetPcdProtocol()->Set8 (TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
\r
- Status = mPcd->Set16 (TokenNumber, Value);\r
-\r
+ Status = GetPcdProtocol()->Set16 (TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
{\r
EFI_STATUS Status;\r
- Status = mPcd->Set32 (TokenNumber, Value);\r
-\r
+ \r
+ Status = GetPcdProtocol()->Set32 (TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
{\r
EFI_STATUS Status;\r
\r
- Status = mPcd->Set64 (TokenNumber, Value);\r
-\r
+ Status = GetPcdProtocol()->Set64 (TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\r
ASSERT (Buffer != NULL);\r
}\r
\r
- Status = mPcd->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer);\r
-\r
+ Status = GetPcdProtocol()->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer);\r
if (EFI_ERROR (Status)) {\r
return NULL;\r
}\r
\r
- return (VOID *) Buffer;\r
+ return (VOID *)Buffer;\r
}\r
\r
\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
EFI_STATUS Status;\r
\r
- Status = mPcd->SetBool (TokenNumber, Value);\r
-\r
+ Status = GetPcdProtocol()->SetBool (TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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 = mPcd->Set8Ex (Guid, TokenNumber, Value);\r
-\r
+ Status = GetPiPcdProtocol()->Set8 (Guid, TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
ASSERT (Guid != NULL);\r
\r
- Status = mPcd->Set16Ex (Guid, TokenNumber, Value);\r
-\r
+ Status = GetPiPcdProtocol()->Set16 (Guid, TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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 = mPcd->Set32Ex (Guid, TokenNumber, Value);\r
-\r
+ Status = GetPiPcdProtocol()->Set32 (Guid, TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
\r
ASSERT (Guid != NULL);\r
\r
- Status = mPcd->Set64Ex (Guid, TokenNumber, Value);\r
-\r
+ Status = GetPiPcdProtocol()->Set64 (Guid, TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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
@param[in] Buffer A pointer to the buffer to set.\r
\r
- @return Return the pinter to the buffer been set.\r
+ @return Return the pointer to the buffer been set.\r
\r
**/\r
VOID *\r
ASSERT (Buffer != NULL);\r
}\r
\r
- Status = mPcd->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
-\r
+ Status = GetPiPcdProtocol()->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
if (EFI_ERROR (Status)) {\r
return NULL;\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 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
ASSERT (Guid != NULL);\r
\r
- Status = mPcd->SetBoolEx (Guid, TokenNumber, Value);\r
-\r
+ Status = GetPiPcdProtocol()->SetBool (Guid, TokenNumber, Value);\r
ASSERT_EFI_ERROR (Status);\r
\r
return Value;\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 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] NotificationFunction The function to call when the token \r
specified by Guid and TokenNumber is set.\r
\r
\r
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPcd->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
-\r
+ Status = GetPiPcdProtocol()->CallbackOnSet (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
ASSERT_EFI_ERROR (Status);\r
\r
return;\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
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPcd->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
-\r
+ Status = GetPiPcdProtocol()->CancelCallback (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
ASSERT_EFI_ERROR (Status);\r
\r
return;\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 = mPcd->GetNextToken (Guid, &TokenNumber);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->GetNextToken (Guid, &TokenNumber);\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 = mPcd->GetNextTokenSpace (&TokenSpaceGuid);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->GetNextTokenSpace (&TokenSpaceGuid);\r
\r
- return (GUID *) TokenSpaceGuid;\r
+ return (GUID *)TokenSpaceGuid;\r
}\r
\r
\r