/** @file\r
Implementation of PcdLib class library for DXE phase.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, 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
\r
#include <Protocol/Pcd.h>\r
#include <Protocol/PiPcd.h>\r
+#include <Protocol/PcdInfo.h>\r
+#include <Protocol/PiPcdInfo.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
-EFI_PCD_PROTOCOL *mPiPcd = NULL;\r
+PCD_PROTOCOL *mPcd = NULL;\r
+EFI_PCD_PROTOCOL *mPiPcd = NULL;\r
+GET_PCD_INFO_PROTOCOL *mPcdInfo = NULL;\r
+EFI_GET_PCD_INFO_PROTOCOL *mPiPcdInfo = NULL;\r
\r
/**\r
- The constructor function caches the PCD_PROTOCOL pointer.\r
+ Retrieves the PI PCD protocol from the handle database.\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
+ @retval EFI_PCD_PROTOCOL * The pointer to the EFI_PCD_PROTOCOL.\r
+**/\r
+EFI_PCD_PROTOCOL *\r
+EFIAPI\r
+GetPiPcdProtocol (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
\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
+ @retval PCD_PROTOCOL * The pointer to the PCD_PROTOCOL.\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 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
- gBS->LocateProtocol (&gPcdProtocolGuid, NULL, (VOID **)&mPcd);\r
- \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
- \r
- ASSERT_EFI_ERROR (Status);\r
- ASSERT (mPiPcd!= NULL);\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
+ Retrieves the PI PCD info protocol from the handle database.\r
+\r
+ @retval EFI_GET_PCD_INFO_PROTOCOL * The pointer to the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 Vol 3.\r
+**/\r
+EFI_GET_PCD_INFO_PROTOCOL *\r
+GetPiPcdInfoProtocolPointer (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
\r
- return Status;\r
+ if (mPiPcdInfo == NULL) {\r
+ Status = gBS->LocateProtocol (&gEfiGetPcdInfoProtocolGuid, NULL, (VOID **)&mPiPcdInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mPiPcdInfo != NULL);\r
+ }\r
+ return mPiPcdInfo;\r
}\r
\r
+/**\r
+ Retrieves the PCD info protocol from the handle database.\r
+\r
+ @retval GET_PCD_INFO_PROTOCOL * The pointer to the GET_PCD_INFO_PROTOCOL.\r
+**/\r
+GET_PCD_INFO_PROTOCOL *\r
+GetPcdInfoProtocolPointer (\r
+ VOID\r
+ ) \r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (mPcdInfo == NULL) {\r
+ Status = gBS->LocateProtocol (&gGetPcdInfoProtocolGuid, NULL, (VOID **)&mPcdInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mPcdInfo != NULL);\r
+ }\r
+ return mPcdInfo;\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 SkuId The SKU value that will be used when the PCD service retrieves and sets values\r
associated with a PCD token.\r
IN UINTN SkuId\r
)\r
{\r
- ASSERT (mPcd != NULL);\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
- ASSERT (mPcd != NULL);\r
- return mPcd->Get8 (TokenNumber);\r
+ return GetPcdProtocol()->Get8 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->Get16 (TokenNumber);\r
+ return GetPcdProtocol()->Get16 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->Get32 (TokenNumber);\r
+ return GetPcdProtocol()->Get32 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->Get64 (TokenNumber);\r
+ return GetPcdProtocol()->Get64 (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->GetPtr (TokenNumber);\r
+ return GetPcdProtocol()->GetPtr (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->GetBool (TokenNumber);\r
+ return GetPcdProtocol()->GetBool (TokenNumber);\r
}\r
\r
\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (mPcd != NULL);\r
- return mPcd->GetSize (TokenNumber);\r
+ return GetPcdProtocol()->GetSize (TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->Get8 (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->Get8 (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->Get16 (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->Get16 (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->Get32 (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->Get32 (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->Get64 (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->Get64 (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->GetPtr (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->GetPtr (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->GetBool (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->GetBool (Guid, TokenNumber);\r
}\r
\r
\r
{\r
ASSERT (Guid != NULL);\r
\r
- return mPiPcd->GetSize (Guid, TokenNumber);\r
+ return GetPiPcdProtocol()->GetSize (Guid, TokenNumber);\r
}\r
\r
\r
\r
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
/**\r
This function provides a means by which to set a value for a given PCD token.\r
\r
Sets the 8-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\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
IN UINT8 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- ASSERT (mPcd != NULL);\r
- Status = mPcd->Set8 (TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPcdProtocol()->Set8 (TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 16-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
- \r
+\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
IN UINT16 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- ASSERT (mPcd != NULL);\r
- Status = mPcd->Set16 (TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPcdProtocol()->Set16 (TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 32-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
- \r
+\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
IN UINT32 Value\r
)\r
{\r
- EFI_STATUS Status;\r
- \r
- ASSERT (mPcd != NULL);\r
- Status = mPcd->Set32 (TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPcdProtocol()->Set32 (TokenNumber, Value);\r
\r
return Value;\r
}\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
IN UINT64 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- ASSERT (mPcd != NULL);\r
- Status = mPcd->Set64 (TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPcdProtocol()->Set64 (TokenNumber, Value);\r
\r
return Value;\r
}\r
specified by Buffer and SizeOfBuffer. Buffer is returned. \r
If SizeOfBuffer is greater than the maximum size support by TokenNumber, \r
then set SizeOfBuffer to the maximum size supported by TokenNumber and \r
- return NULL to indicate that the set operation was not actually performed. \r
+ return NULL to indicate that the set operation was not actually performed.\r
\r
If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the \r
maximum size supported by TokenName and NULL must be returned.\r
)\r
{\r
EFI_STATUS Status;\r
+ UINTN InputSizeOfBuffer;\r
\r
- ASSERT (mPcd != NULL);\r
ASSERT (SizeOfBuffer != NULL);\r
\r
if (*SizeOfBuffer > 0) {\r
ASSERT (Buffer != NULL);\r
}\r
\r
- Status = mPcd->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer);\r
-\r
- if (EFI_ERROR (Status)) {\r
+ InputSizeOfBuffer = *SizeOfBuffer;\r
+ Status = GetPcdProtocol()->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer);\r
+ if (EFI_ERROR (Status) && (*SizeOfBuffer < InputSizeOfBuffer)) {\r
return NULL;\r
}\r
\r
- return (VOID *) Buffer;\r
+ return (VOID *)Buffer;\r
}\r
\r
\r
\r
Sets the Boolean value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\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
IN BOOLEAN Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- ASSERT (mPcd != NULL);\r
- Status = mPcd->SetBool (TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPcdProtocol()->SetBool (TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 8-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
- \r
+\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
IN UINT8 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
ASSERT (Guid != NULL);\r
\r
- Status = mPiPcd->Set8 (Guid, TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->Set8 (Guid, TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 16-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
- \r
+\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
IN UINT16 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
ASSERT (Guid != NULL);\r
\r
- Status = mPiPcd->Set16 (Guid, TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->Set16 (Guid, TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 32-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
- \r
+\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
IN UINT32 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
ASSERT (Guid != NULL);\r
\r
- Status = mPiPcd->Set32 (Guid, TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->Set32 (Guid, TokenNumber, Value);\r
\r
return Value;\r
}\r
\r
Sets the 64-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
+\r
If Guid is NULL, then ASSERT().\r
- \r
+\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
IN UINT64 Value\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
ASSERT (Guid != NULL);\r
\r
- Status = mPiPcd->Set64 (Guid, TokenNumber, Value);\r
-\r
- ASSERT_EFI_ERROR (Status);\r
+ GetPiPcdProtocol()->Set64 (Guid, TokenNumber, Value);\r
\r
return Value;\r
}\r
Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size \r
supported by TokenNumber and return NULL to indicate that the set operation \r
- was not actually performed. \r
+ was not actually performed.\r
\r
If Guid is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\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
)\r
{\r
EFI_STATUS Status;\r
+ UINTN InputSizeOfBuffer;\r
\r
ASSERT (Guid != NULL);\r
\r
ASSERT (Buffer != NULL);\r
}\r
\r
- Status = mPiPcd->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
-\r
- if (EFI_ERROR (Status)) {\r
+ InputSizeOfBuffer = *SizeOfBuffer;\r
+ Status = GetPiPcdProtocol()->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+ if (EFI_ERROR (Status) && (*SizeOfBuffer < InputSizeOfBuffer)) {\r
return NULL;\r
}\r
\r
\r
Sets the Boolean value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
- \r
+\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
IN BOOLEAN Value\r
)\r
{\r
- EFI_STATUS Status;\r
+ ASSERT (Guid != NULL);\r
+\r
+ GetPiPcdProtocol()->SetBool (Guid, TokenNumber, Value);\r
+\r
+ return Value;\r
+}\r
+#endif\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 8-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet8S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ )\r
+{\r
+ return GetPcdProtocol()->Set8 (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 16-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet16S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ )\r
+{\r
+ return GetPcdProtocol()->Set16 (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 32-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet32S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ )\r
+{\r
+ return GetPcdProtocol()->Set32 (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 64-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet64S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ return GetPcdProtocol()->Set64 (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets a buffer for the token specified by TokenNumber to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation\r
+ was not actually performed.\r
+\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the\r
+ maximum size supported by TokenName and EFI_INVALID_PARAMETER must be returned.\r
+\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetPtrS (\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ return GetPcdProtocol()->SetPtr (TokenNumber, SizeOfBuffer, (VOID *) Buffer);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the boolean value for the token specified by TokenNumber\r
+ to the value specified by Value.\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetBoolS (\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ )\r
+{\r
+ return GetPcdProtocol()->SetBool (TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 8-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx8S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ )\r
+{\r
ASSERT (Guid != NULL);\r
\r
- Status = mPiPcd->SetBool (Guid, TokenNumber, Value);\r
+ return GetPiPcdProtocol()->Set8 (Guid, TokenNumber, Value);\r
+}\r
\r
- ASSERT_EFI_ERROR (Status);\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- return Value;\r
+ Sets the 16-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx16S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ return GetPiPcdProtocol()->Set16 (Guid, TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 32-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx32S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ return GetPiPcdProtocol()->Set32 (Guid, TokenNumber, Value);\r
}\r
\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the 64-bit value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx64S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ return GetPiPcdProtocol()->Set64 (Guid, TokenNumber, Value);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets a buffer for the token specified by TokenNumber to the value specified by\r
+ Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return EFI_INVALID_PARAMETER to indicate that the set operation\r
+ was not actually performed.\r
+\r
+ If Guid is NULL, then ASSERT().\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
+ 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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetExPtrS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ return GetPiPcdProtocol()->SetPtr (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
+}\r
+\r
+/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+\r
+ Sets the boolean value for the token specified by TokenNumber\r
+ to the value specified by Value.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetExBoolS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ )\r
+{\r
+ ASSERT (Guid != NULL);\r
+\r
+ return GetPiPcdProtocol()->SetBool (Guid, TokenNumber, Value);\r
+}\r
\r
/**\r
Set up a notification function that is called when a specified token is set.\r
\r
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPiPcd->CallbackOnSet (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
-\r
+ Status = GetPiPcdProtocol()->CallbackOnSet (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
ASSERT_EFI_ERROR (Status);\r
\r
return;\r
\r
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPiPcd->CancelCallback (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
-\r
+ Status = GetPiPcdProtocol()->CancelCallback (Guid, TokenNumber, (EFI_PCD_PROTOCOL_CALLBACK) NotificationFunction);\r
ASSERT_EFI_ERROR (Status);\r
\r
return;\r
IN UINTN TokenNumber\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- Status = mPiPcd->GetNextToken (Guid, &TokenNumber);\r
+ EFI_STATUS Status;\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ Status = GetPiPcdProtocol()->GetNextToken (Guid, &TokenNumber);\r
+ ASSERT (!EFI_ERROR (Status) || TokenNumber == 0);\r
\r
return TokenNumber;\r
}\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 TokenSpaceGuid The pointer to the a PCD token space GUID\r
+ @param TokenSpaceGuid The pointer to the a PCD token space GUID.\r
\r
@return The next valid token namespace.\r
\r
IN CONST GUID *TokenSpaceGuid\r
)\r
{\r
- EFI_STATUS Status;\r
-\r
- Status = mPiPcd->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
If SizeOfBuffer is NULL, then ASSERT().\r
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] PatchVariable A pointer to the global variable in a module that is \r
+ @param[out] PatchVariable A pointer to the global variable in a module that is \r
the target of the set operation.\r
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
VOID *\r
EFIAPI\r
LibPatchPcdSetPtr (\r
- IN VOID *PatchVariable,\r
+ OUT VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ \r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return NULL;\r
+ }\r
+ \r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ \r
+ return (VOID *) Buffer;\r
+}\r
+\r
+/**\r
+ Sets a value of a patchable PCD entry that is type pointer.\r
+\r
+ Sets the PCD entry specified by PatchVariable to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.\r
+\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
+ \r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPatchPcdSetPtrS (\r
+ OUT VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ \r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+\r
+ return RETURN_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Sets a value and size of a patchable PCD entry that is type pointer.\r
+ \r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
+ NULL to indicate that the set operation was not actually performed. \r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
+ MaximumDatumSize and NULL must be returned.\r
+ \r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is \r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
+ \r
+ @return Return the pointer to the buffer been set.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtrAndSize (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
IN UINTN MaximumDatumSize,\r
IN OUT UINTN *SizeOfBuffer,\r
IN CONST VOID *Buffer\r
)\r
{\r
ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
ASSERT (SizeOfBuffer != NULL);\r
\r
if (*SizeOfBuffer > 0) {\r
}\r
\r
CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
\r
return (VOID *) Buffer;\r
}\r
\r
+/**\r
+ Sets a value and size of a patchable PCD entry that is type pointer.\r
+\r
+ Sets the PCD entry specified by PatchVariable to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to\r
+ MaximumDatumSize and RETURN_INVALID_PARAMETER must be returned.\r
+\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
+ \r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPatchPcdSetPtrAndSizeS (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ \r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
+\r
+ return RETURN_SUCCESS;\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 = GetPcdInfoProtocolPointer()->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 = GetPiPcdInfoProtocolPointer()->GetInfo (Guid, TokenNumber, (EFI_PCD_INFO *) PcdInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+}\r
+\r
+/**\r
+ Retrieve the currently set SKU Id.\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
+ return GetPiPcdInfoProtocolPointer()->GetSku ();\r
+}\r
\r
projects / mirror_edk2.git / blobdiff