WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
\r
-Module Name: DxePcdLib.c\r
-\r
**/\r
\r
+//\r
+// The package level header files this module uses\r
+//\r
+#include <PiDxe.h>\r
+//\r
+// The protocols, PPI and GUID defintions for this module\r
+//\r
+#include <Protocol/Pcd.h>\r
+//\r
+// The Library classes this module consumes\r
+//\r
+#include <Library/PcdLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+\r
+#include "DxePcdLibInternal.h"\r
+\r
static PCD_PROTOCOL *mPcd;\r
\r
/**\r
The constructor function caches the PCD_PROTOCOL pointer.\r
\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \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 SKU_ID Return the SKU ID that just be set.\r
\r
**/\r
-SKU_ID\r
+UINTN\r
EFIAPI\r
LibPcdSetSku (\r
- IN SKU_ID SkuId\r
+ IN UINTN SkuId\r
)\r
{\r
+ ASSERT (SkuId < 0x100);\r
+\r
mPcd->SetSku (SkuId);\r
\r
return SkuId;\r
UINT8\r
EFIAPI\r
LibPcdGet8 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->Get8 (TokenNumber);\r
UINT16\r
EFIAPI\r
LibPcdGet16 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->Get16 (TokenNumber);\r
UINT32\r
EFIAPI\r
LibPcdGet32 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->Get32 (TokenNumber);\r
UINT64\r
EFIAPI\r
LibPcdGet64 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->Get64 (TokenNumber);\r
VOID *\r
EFIAPI\r
LibPcdGetPtr (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->GetPtr (TokenNumber);\r
BOOLEAN \r
EFIAPI\r
LibPcdGetBool (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->GetBool (TokenNumber);\r
UINTN\r
EFIAPI\r
LibPcdGetSize (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
return mPcd->GetSize (TokenNumber);\r
EFIAPI\r
LibPcdGetEx8 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetEx16 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetEx32 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetEx64 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetExPtr (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetExBool (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
EFIAPI\r
LibPcdGetExSize (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
ASSERT (Guid != NULL);\r
UINT8\r
EFIAPI\r
LibPcdSet8 (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT8 Value\r
)\r
{\r
UINT16\r
EFIAPI\r
LibPcdSet16 (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT16 Value\r
)\r
{\r
UINT32\r
EFIAPI\r
LibPcdSet32 (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT32 Value\r
)\r
{\r
UINT64\r
EFIAPI\r
LibPcdSet64 (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT64 Value\r
)\r
{\r
\r
/**\r
Sets a buffer for the token specified by TokenNumber to \r
- the value specified by Value. Value is returned.\r
- If Value is NULL, then ASSERT().\r
+ the value specified by Buffer and SizeOfValue. Buffer to\r
+ be set is returned. The content of the buffer could be \r
+ overwritten if a Callback on SET is registered with this\r
+ TokenNumber.\r
+ \r
+ If SizeOfValue is greater than the maximum \r
+ size support by TokenNumber, then set SizeOfValue to the \r
+ maximum size supported by TokenNumber and return NULL to \r
+ indicate that the set operation was not actually performed. \r
+ \r
+ If SizeOfValue > 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] Value A pointer to the buffer to set.\r
\r
@retval VOID* Return the pointer for the buffer been set.\r
\r
**/\r
+\r
VOID *\r
EFIAPI\r
LibPcdSetPtr (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
- IN UINTN SizeOfBuffer,\r
- IN VOID *Buffer\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
)\r
{\r
EFI_STATUS Status;\r
- \r
- ASSERT (Buffer != NULL);\r
+\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
Status = mPcd->SetPtr (TokenNumber, SizeOfBuffer, Buffer);\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
\r
return Buffer;\r
}\r
BOOLEAN\r
EFIAPI\r
LibPcdSetBool (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
)\r
{\r
EFIAPI\r
LibPcdSetEx8 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT8 Value\r
)\r
{\r
EFIAPI\r
LibPcdSetEx16 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT16 Value\r
)\r
{\r
EFIAPI\r
LibPcdSetEx32 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT32 Value\r
)\r
{\r
EFIAPI\r
LibPcdSetEx64 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT64 Value\r
)\r
{\r
\r
\r
/**\r
- Sets a buffer for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
- If Guid is NULL, then ASSERT().\r
- If Value is NULL, then ASSERT().\r
+ Sets a buffer for the token specified by TokenNumber to the value specified by \r
+ Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
+ the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
+ supported by TokenNumber and return NULL to indicate that the set operation \r
+ was not actually performed. \r
+ \r
+ If SizeOfValue > 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] Value The 8-bit value to set.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
- @retval VOID * Return the value been set.\r
+ @retval VOID * Return the pinter to the buffer been set.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdSetExPtr (\r
- IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
- IN UINTN SizeOfBuffer,\r
- IN VOID *Buffer\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
\r
ASSERT (Guid != NULL);\r
- ASSERT (Buffer != NULL);\r
+\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
\r
Status = mPcd->SetPtrEx (Guid, TokenNumber, SizeOfBuffer, Buffer);\r
\r
- ASSERT_EFI_ERROR (Status);\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
\r
return Buffer;\r
}\r
EFIAPI\r
LibPcdSetExBool (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
)\r
{\r
EFIAPI\r
LibPcdCallbackOnSet (\r
IN CONST GUID *Guid, OPTIONAL\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN PCD_CALLBACK NotificationFunction\r
)\r
{\r
\r
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPcd->CallbackOnSet (TokenNumber, Guid, NotificationFunction);\r
+ Status = mPcd->CallbackOnSet (Guid, TokenNumber, NotificationFunction);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
EFIAPI\r
LibPcdCancelCallback (\r
IN CONST GUID *Guid, OPTIONAL\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN PCD_CALLBACK NotificationFunction\r
)\r
{\r
\r
ASSERT (NotificationFunction != NULL);\r
\r
- Status = mPcd->CancelCallback (TokenNumber, Guid, NotificationFunction);\r
+ Status = mPcd->CancelCallback (Guid, TokenNumber, NotificationFunction);\r
\r
ASSERT_EFI_ERROR (Status);\r
\r
@param[in] The previous PCD token number. If 0, then retrieves the first PCD \r
token number.\r
\r
- @retval PCD_TOKEN_NUMBER The next valid token number.\r
+ @retval UINTN The next valid token number.\r
\r
**/\r
-PCD_TOKEN_NUMBER \r
+UINTN \r
EFIAPI\r
LibPcdGetNextToken (\r
IN CONST GUID *Guid, OPTIONAL\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
)\r
{\r
EFI_STATUS Status;\r
return TokenNumber;\r
}\r
\r
+\r
+\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
+ \r
+ @param[in] Pointer to a 128-bit unique value that designates from which namespace \r
+ to start the search.\r
+\r
+ @retval CONST GUID * The next valid token namespace.\r
+\r
+**/\r
+GUID * \r
+EFIAPI\r
+LibPcdGetNextTokenSpace (\r
+ IN CONST GUID *Guid\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = mPcd->GetNextTokenSpace (&Guid);\r
+\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return (GUID *) Guid;\r
+}\r
+\r
+\r
+/**\r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
+ and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
+ MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \r
+ NULL to indicate that the set operation was not actually performed. \r
+ If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \r
+ MaximumDatumSize and NULL must be returned.\r
+ \r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfValue is NULL, then ASSERT().\r
+ If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[in] 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
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtr (\r
+ IN 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
+\r
projects / mirror_edk2.git / blobdiff