tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-31 01:24:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update function header.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5534 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-07-21 07:42:51 +00:00
parent 9199040cb2
commit fb287b565f
1 changed files with 68 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

134
MdePkg/Include/Library/PcdLib.h
View File

@ -1,7 +1,15 @@
/** @file /** @file
PCD Library Class Interface Declarations PCD Library Class provides PCD usage macro interface for all PCD types. It should be
included at any module who use PCD.
Copyright (c) 2006 - 2007, Intel Corporation If module use dynamic/dynamicex PCD, module should be linked to PEIM/DXE library
instance to access that PCD.
If module uses PatchableInModule type PCD, also need library instance produce LibPatchPcdSetPtr()
interface.
For FeatureFlag/Fixed PCD, macro interface is translated to an variable or macro
which is auto-generated by build tool in module's autogen.h/autogen.c
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -113,7 +121,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned. Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token. set values associated with a PCD token.
@retval SKU_ID Return the SKU ID that just be set. @retval SKU_ID Return the SKU ID that just be set.
@ -291,9 +299,9 @@ LibPcdGetEx32 (
Returns the 64-bit value for the token specified by TokenNumber and Guid. Returns the 64-bit value for the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@retval UINT64 Return the UINT64. @retval UINT64 Return the UINT64.
@ -310,9 +318,9 @@ LibPcdGetEx64 (
Returns the pointer to the buffer of token specified by TokenNumber and Guid. Returns the pointer to the buffer of token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@retval VOID* Return the VOID* pointer. @retval VOID* Return the VOID* pointer.
@ -329,9 +337,9 @@ LibPcdGetExPtr (
Returns the Boolean value of the token specified by TokenNumber and Guid. Returns the Boolean value of the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@retval BOOLEAN Return the BOOLEAN. @retval BOOLEAN Return the BOOLEAN.
@ -348,9 +356,9 @@ LibPcdGetExBool (
Returns the size of the token specified by TokenNumber and Guid. Returns the size of the token specified by TokenNumber and Guid.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates @param[in] Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from. which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@retval UINTN Return the size. @retval UINTN Return the size.
@ -367,8 +375,8 @@ LibPcdGetExSize (
Sets the 8-bit value for the token specified by TokenNumber Sets the 8-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned. to the value specified by Value. Value is returned.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set. @param[in] Value The 8-bit value to set.
@retval UINT8 Return the value been set. @retval UINT8 Return the value been set.
@ -385,8 +393,8 @@ LibPcdSet8 (
Sets the 16-bit value for the token specified by TokenNumber Sets the 16-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned. to the value specified by Value. Value is returned.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set. @param[in] Value The 16-bit value to set.
@retval UINT16 Return the value been set. @retval UINT16 Return the value been set.
@ -403,8 +411,8 @@ LibPcdSet16 (
Sets the 32-bit value for the token specified by TokenNumber Sets the 32-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned. to the value specified by Value. Value is returned.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set. @param[in] Value The 32-bit value to set.
@retval UINT32 Return the value been set. @retval UINT32 Return the value been set.
@ -421,8 +429,8 @@ LibPcdSet32 (
Sets the 64-bit value for the token specified by TokenNumber Sets the 64-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned. to the value specified by Value. Value is returned.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set. @param[in] Value The 64-bit value to set.
@retval UINT64 Return the value been set. @retval UINT64 Return the value been set.
@ -468,8 +476,8 @@ LibPcdSetPtr (
Sets the Boolean value for the token specified by TokenNumber Sets the Boolean value for the token specified by TokenNumber
to the value specified by Value. Value is returned. to the value specified by Value. Value is returned.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set. @param[in] Value The boolean value to set.
@retval BOOLEAN Return the value been set. @retval BOOLEAN Return the value been set.
@ -487,10 +495,10 @@ LibPcdSetBool (
Guid to the value specified by Value. Value is returned. Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set. @param[in] Value The 8-bit value to set.
@retval UINT8 Return the value been set. @retval UINT8 Return the value been set.
@ -509,10 +517,10 @@ LibPcdSetEx8 (
Guid to the value specified by Value. Value is returned. Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set. @param[in] Value The 16-bit value to set.
@retval UINT8 Return the value been set. @retval UINT8 Return the value been set.
@ -531,10 +539,10 @@ LibPcdSetEx16 (
Guid to the value specified by Value. Value is returned. Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set. @param[in] Value The 32-bit value to set.
@retval UINT32 Return the value been set. @retval UINT32 Return the value been set.
@ -553,10 +561,10 @@ LibPcdSetEx32 (
Guid to the value specified by Value. Value is returned. Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set. @param[in] Value The 64-bit value to set.
@retval UINT64 Return the value been set. @retval UINT64 Return the value been set.
@ -581,11 +589,11 @@ LibPcdSetEx64 (
If SizeOfValue is NULL, then ASSERT(). If SizeOfValue is NULL, then ASSERT().
If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer. @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set. @param[in] Buffer A pointer to the buffer to set.
@retval VOID * Return the pinter to the buffer been set. @retval VOID * Return the pinter to the buffer been set.
@ -605,10 +613,10 @@ LibPcdSetExPtr (
Guid to the value specified by Value. Value is returned. Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that @param[in] Guid Pointer to a 128-bit unique value that
designates which namespace to set a value from. designates which namespace to set a value from.
@param[in] TokenNumber The PCD token number to set a current value for. @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set. @param[in] Value The Boolean value to set.
@retval Boolean Return the value been set. @retval Boolean Return the value been set.
@ -641,8 +649,6 @@ LibPcdSetExBool (
@param[in, out] TokenData A pointer to the token data being set. @param[in, out] TokenData A pointer to the token data being set.
@param[in] TokenDataSize The size, in bytes, of the data being set. @param[in] TokenDataSize The size, in bytes, of the data being set.
@retval VOID
**/ **/
typedef typedef
VOID VOID
@ -660,14 +666,12 @@ VOID
If Guid is NULL, then the default token space is used. If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT(). If NotificationFunction is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates which @param[in] Guid Pointer to a 128-bit unique value that designates which
namespace to set a value from. If NULL, then the default namespace to set a value from. If NULL, then the default
token space is used. token space is used.
@param[in] TokenNumber The PCD token number to monitor. @param[in] TokenNumber The PCD token number to monitor.
@param[in] NotificationFunction The function to call when the token @param[in] NotificationFunction The function to call when the token
specified by Guid and TokenNumber is set. specified by Guid and TokenNumber is set.
@retval VOID
**/ **/
VOID VOID
@ -682,12 +686,10 @@ LibPcdCallbackOnSet (
/** /**
Disable a notification function that was established with LibPcdCallbackonSet(). Disable a notification function that was established with LibPcdCallbackonSet().
@param[in] Guid Specify the GUID token space. @param[in] Guid Specify the GUID token space.
@param[in] TokenNumber Specify the token number. @param[in] TokenNumber Specify the token number.
@param[in] NotificationFunction The callback function to be unregistered. @param[in] NotificationFunction The callback function to be unregistered.
@retval VOID
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -734,8 +736,8 @@ LibPcdGetNextToken (
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
to start the search. to start the search.
@retval CONST GUID * The next valid token namespace. @retval CONST GUID * The next valid token namespace.