/** @file\r
-PCD Library Class Interface Declarations\r
+ Provides library services to get and set Platform Configuration Database entries.\r
\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. 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
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ PCD Library Class provides PCD usage macro interface for all PCD types.\r
+ It should be included at any module who use PCD. If module use dynamic/dynamicex\r
+ PCD, module should be linked to PEIM/DXE library instance to access that PCD.\r
+ If module uses PatchableInModule type PCD, also need library instance produce\r
+ LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is\r
+ translated to an variable or macro which is auto-generated by build tool in\r
+ module's autogen.h/autogen.c.\r
\r
+Copyright (c) 2006 - 2008, Intel Corporation\r
+All rights reserved. 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
\r
-Module Name: PcdLib.h\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __PCD_LIB_H__\r
#define __PCD_LIB_H__\r
\r
-#include <Common/Pcd.h>\r
+#define PCD_MAX_SKU_ID 0x100\r
\r
+#define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r
\r
-#define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r
\r
-\r
-//\r
-// Feature Flag is in the form of a global constant\r
-//\r
-#define FeaturePcdGet(TokenName) _gPcd_FixedAtBuild_##TokenName\r
+///\r
+/// Feature Flag is in the form of a global constant\r
+///\r
+#define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
\r
\r
//\r
// Fixed is fixed at build time\r
//\r
-#define FixedPcdGet8(TokenName) _gPcd_FixedAtBuild_##TokenName\r
-#define FixedPcdGet16(TokenName) _gPcd_FixedAtBuild_##TokenName\r
-#define FixedPcdGet32(TokenName) _gPcd_FixedAtBuild_##TokenName\r
-#define FixedPcdGet64(TokenName) _gPcd_FixedAtBuild_##TokenName\r
-#define FixedPcdGetBool(TokenName) _gPcd_FixedAtBuild_##TokenName\r
+#define FixedPcdGet8(TokenName) _PCD_VALUE_##TokenName\r
+#define FixedPcdGet16(TokenName) _PCD_VALUE_##TokenName\r
+#define FixedPcdGet32(TokenName) _PCD_VALUE_##TokenName\r
+#define FixedPcdGet64(TokenName) _PCD_VALUE_##TokenName\r
+#define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName\r
\r
\r
-//\r
-// BugBug: This works for strings, but not constants.\r
-//\r
-#define FixedPcdGetPtr(TokenName) ((VOID *)_gPcd_FixedAtBuild_##TokenName)\r
+#define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName)\r
\r
\r
//\r
// (Binary) Patch is in the form of a global variable\r
//\r
-#define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName\r
-#define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName\r
-#define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName\r
-#define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName\r
-#define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName\r
-#define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)\r
-\r
-#define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r
-#define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r
-#define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r
-#define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r
-#define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r
-#define PatchPcdSetPtr(TokenName, Value, Size) CopyMem (_gPcd_BinaryPatch_##TokenName, Value, Size)\r
+#define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)\r
+\r
+#define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
+#define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
+#define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
+#define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
+#define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
+#define PatchPcdSetPtr(TokenName, Size, Buffer) \\r
+ LibPatchPcdSetPtr ( \\r
+ _gPcd_BinaryPatch_##TokenName, \\r
+ (UINTN)_PCD_PATCHABLE_##TokenName##_SIZE, \\r
+ (Size), \\r
+ (Buffer) \\r
+ )\r
\r
//\r
// Dynamic is via the protocol with only the TokenNumber as argument\r
// It can also be Patch or Fixed type based on a build option\r
//\r
-#define PcdGet8(TokenName) _PCD_MODE_8_##TokenName\r
-#define PcdGet16(TokenName) _PCD_MODE_16_##TokenName\r
-#define PcdGet32(TokenName) _PCD_MODE_32_##TokenName\r
-#define PcdGet64(TokenName) _PCD_MODE_64_##TokenName\r
-#define PcdGetPtr(TokenName) _PCD_MODE_PTR_##TokenName\r
-#define PcdGetBool(TokenName) _PCD_MODE_BOOL_##TokenName\r
-\r
+#define PcdGet8(TokenName) _PCD_GET_MODE_8_##TokenName\r
+#define PcdGet16(TokenName) _PCD_GET_MODE_16_##TokenName\r
+#define PcdGet32(TokenName) _PCD_GET_MODE_32_##TokenName\r
+#define PcdGet64(TokenName) _PCD_GET_MODE_64_##TokenName\r
+#define PcdGetPtr(TokenName) _PCD_GET_MODE_PTR_##TokenName\r
+#define PcdGetBool(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
\r
//\r
-// Dynamic Ex is to support binary distribution\r
+// Dynamic Set\r
//\r
-#define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 (Guid, _PCD_TOKEN_##TokenName)\r
-#define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 (Guid, _PCD_TOKEN_##TokenName)\r
-#define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 (Guid, _PCD_TOKEN_##TokenName)\r
-#define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 (Guid, _PCD_TOKEN_##TokenName)\r
-#define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr (Guid, _PCD_TOKEN_##TokenName)\r
-#define PcdGetExBool(Guid, TokenName) LibPcdGetExBool (Guid, _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdSet8(TokenName, Value) _PCD_SET_MODE_8_##TokenName ((Value))\r
+#define PcdSet16(TokenName, Value) _PCD_SET_MODE_16_##TokenName ((Value))\r
+#define PcdSet32(TokenName, Value) _PCD_SET_MODE_32_##TokenName ((Value))\r
+#define PcdSet64(TokenName, Value) _PCD_SET_MODE_64_##TokenName ((Value))\r
+#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \\r
+ _PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer))\r
+#define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))\r
\r
//\r
-// Dynamic Set\r
+// Dynamic Ex is to support binary distribution\r
//\r
-#define PcdSet8(TokenName, Value) LibPcdSet8 (_PCD_TOKEN_##TokenName, Value)\r
-#define PcdSet16(TokenName, Value) LibPcdSet16 (_PCD_TOKEN_##TokenName, Value)\r
-#define PcdSet32(TokenName, Value) LibPcdSet32 (_PCD_TOKEN_##TokenName, Value)\r
-#define PcdSet64(TokenName, Value) LibPcdSet64 (_PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetPtr(TokenName, Value) LibPcdSetPtr (_PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetBool(TokenName, Value) LibPcdSetBool(_PCD_TOKEN_##TokenName, Value)\r
-\r
+#define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 ((Guid), _PCD_TOKEN_##TokenName)\r
+#define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 ((Guid), _PCD_TOKEN_##TokenName)\r
+#define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 ((Guid), _PCD_TOKEN_##TokenName)\r
+#define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 ((Guid), _PCD_TOKEN_##TokenName)\r
+#define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr ((Guid), _PCD_TOKEN_##TokenName)\r
+#define PcdGetExBool(Guid, TokenName) LibPcdGetExBool ((Guid), _PCD_TOKEN_##TokenName)\r
\r
//\r
// Dynamic Set Ex\r
//\r
-#define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 (Guid, _PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 (Guid, _PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 (Guid, _PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 (Guid, _PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetExPtr(Guid, TokenName, Value) LibPcdSetExPtr (Guid, _PCD_TOKEN_##TokenName, Value)\r
-#define PcdSetExBool(Guid, TokenName, Value) LibPcdSetExBool(Guid, _PCD_TOKEN_##TokenName, Value)\r
+#define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
+#define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
+#define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
+#define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
+#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \\r
+ LibPcdSetExPtr ((Guid), _PCD_TOKEN_##TokenName, (SizeOfBuffer), (Buffer))\r
+#define PcdSetExBool(Guid, TokenName, Value) \\r
+ LibPcdSetExBool((Guid), _PCD_TOKEN_##TokenName, (Value))\r
\r
\r
/**\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\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
+ set values associated with a PCD token.\r
\r
- @retval SKU_ID Return the SKU ID that just be set.\r
+ @return 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
\r
/**\r
Returns the 8-bit value for the token specified by TokenNumber. \r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
+ @return Returns the 8-bit value for the token specified by TokenNumber. \r
\r
**/\r
UINT8\r
EFIAPI\r
LibPcdGet8 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
/**\r
Returns the 16-bit value for the token specified by TokenNumber. \r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
+ @return Returns the 16-bit value for the token specified by TokenNumber. \r
\r
**/\r
UINT16\r
EFIAPI\r
LibPcdGet16 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r
+ @return Returns the 32-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT32\r
EFIAPI\r
LibPcdGet32 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r
+ @return Returns the 64-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT64\r
EFIAPI\r
LibPcdGet64 (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval VOID* Returns the pointer to the token specified by TokenNumber.\r
+ @return Returns the pointer to the token specified by TokenNumber.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdGetPtr (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r
+ @return Returns the Boolean value of the token specified by TokenNumber. \r
\r
**/\r
BOOLEAN \r
EFIAPI\r
LibPcdGetBool (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINTN Returns the size of the token specified by TokenNumber. \r
+ @return Returns the size of the token specified by TokenNumber. \r
\r
**/\r
UINTN\r
EFIAPI\r
LibPcdGetSize (\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Return the UINT8.\r
+ @return Return the UINT8.\r
\r
**/\r
UINT8\r
EFIAPI\r
LibPcdGetEx8 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT16 Return the UINT16.\r
+ @return Return the UINT16.\r
\r
**/\r
UINT16\r
EFIAPI\r
LibPcdGetEx16 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Return the UINT32.\r
+ @return Return the UINT32.\r
\r
**/\r
UINT32\r
EFIAPI\r
LibPcdGetEx32 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
Returns the 64-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 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
- @retval UINT64 Return the UINT64.\r
+ @return Return the UINT64.\r
\r
**/\r
UINT64\r
EFIAPI\r
LibPcdGetEx64 (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
Returns the pointer to the buffer of 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 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
- @retval VOID* Return the VOID* pointer.\r
+ @return Return the VOID* pointer.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdGetExPtr (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
Returns the Boolean value of 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 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
- @retval BOOLEAN Return the BOOLEAN.\r
+ @return Return the BOOLEAN.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
LibPcdGetExBool (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
Returns the size of 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 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
- @retval UINTN Return the size.\r
+ @return Return the size.\r
\r
**/\r
UINTN\r
EFIAPI\r
LibPcdGetExSize (\r
IN CONST GUID *Guid,\r
- IN PCD_TOKEN_NUMBER TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\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
- @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] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 8-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT8\r
EFIAPI\r
LibPcdSet8 (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN UINT8 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
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 16-bit value to set.\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
- @retval UINT16 Return the value been set.\r
+ @return Return the value been set.\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
Sets the 32-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\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
+ @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
- @retval UINT32 Return the value been set.\r
+ @return Return the value been set.\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
Sets the 64-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\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
+ @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
- @retval UINT64 Return the value been set.\r
+ @return Return the value been set.\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
+ Sets a buffer for the token specified by TokenNumber to the value \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
+\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
+ 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] Value A pointer to the buffer to set.\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 Value A pointer to the buffer to set.\r
\r
- @retval VOID* Return the pointer for the buffer been set.\r
+ @return Return the pointer for the buffer been set.\r
\r
**/\r
VOID*\r
EFIAPI\r
LibPcdSetPtr (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
- IN UINTN SizeOfBuffer,\r
- IN CONST VOID *Value\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\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
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The boolean value to set.\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
- @retval BOOLEAN Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
LibPcdSetBool (\r
- IN PCD_TOKEN_NUMBER TokenNumber,\r
+ IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
);\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
- 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] 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
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT8\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
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
- 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
+ @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 16-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT16\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
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
- 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
+ @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 32-bit value to set.\r
\r
- @retval UINT32 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT32\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
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
- 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
+ @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 64-bit value to set.\r
\r
- @retval UINT64 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT64\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
- Sets a buffer for the token specified by TokenNumber and \r
- Guid to the value specified by Value. Value is returned.\r
+ Sets a buffer for the token specified by TokenNumber to the value specified by \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
+ \r
If Guid is NULL, then ASSERT().\r
- If Value 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] Value The 8-bit value to set.\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
- @retval VOID * Return the value been set.\r
+ @return 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 CONST VOID *Value\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
);\r
\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
- 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
+ @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 Boolean value to set.\r
\r
- @retval Boolean Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
BOOLEAN\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
If Guid is NULL, then the default token space is used. \r
If NotificationFunction is NULL, then ASSERT().\r
\r
- @param[in] CallBackGuid The PCD token GUID being set.\r
- @param[in] CallBackToken The PCD token number being set.\r
- @param[in] TokenData A pointer to the token data being set.\r
- @param[in] TokenDataSize The size, in bytes, of the data being set.\r
+ This notification function serves two purposes. Firstly, it notifies the module which \r
+ did the registration that the value of this PCD token has been set. Secondly, \r
+ it provides a mechanism for the module which did the registration to intercept \r
+ the set operation and override the value been set if necessary. After the invocation \r
+ of the callback function, TokenData will be used by PCD service PEIM or driver to \r
+ modify the internal data in PCD database. \r
\r
- @retval VOID\r
+\r
+ @param[in] CallBackGuid The PCD token GUID being set.\r
+ @param[in] CallBackToken The PCD token number being set.\r
+ @param[in, out] TokenData A pointer to the token data being set.\r
+ @param[in] TokenDataSize The size, in bytes, of the data being set.\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *PCD_CALLBACK) (\r
+(EFIAPI *PCD_CALLBACK)(\r
IN CONST GUID *CallBackGuid, OPTIONAL\r
- IN PCD_TOKEN_NUMBER CallBackToken,\r
+ IN UINTN CallBackToken,\r
IN OUT VOID *TokenData,\r
IN UINTN TokenDataSize\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] NotificationFunction The function to call when the token \r
- specified by Guid and TokenNumber is set.\r
-\r
- @retval VOID\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] NotificationFunction The function to call when the token \r
+ specified by Guid and TokenNumber is set.\r
\r
**/\r
VOID\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
Disable a notification function that was established with LibPcdCallbackonSet().\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
- @retval VOID\r
-\r
**/\r
VOID\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
token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r
is not in the token space specified by Guid, then ASSERT().\r
\r
- @param[in] 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] The previous PCD token number. If 0, then retrieves the first PCD \r
- token number.\r
+ @param[in] Guid 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
\r
- @retval PCD_TOKEN_NUMBER The next valid token number.\r
+ @return 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
+\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] Guid Pointer to a 128-bit unique value that designates from which namespace \r
+ to start the search.\r
+\r
+ @return The next valid token namespace.\r
+\r
+**/\r
+GUID * \r
+EFIAPI\r
+LibPcdGetNextTokenSpace (\r
+ IN CONST GUID *Guid\r
+ );\r
+\r
+\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 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
+ 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 Return the pinter to the buffer been set.\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
#endif\r
projects / mirror_edk2.git / blobdiff