mirror of https://github.com/acidanthera/audk.git
Synchronize interface function comment from declaration in library class header file to implementation in library instance.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6952 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
parent
f38fdc7498
commit
518db1d9e0
|
|
@ -26,25 +26,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
VOID *gHobList = NULL;
|
||||
|
||||
/**
|
||||
Entry point to DXE core.
|
||||
The entry point of PE/COFF Image for the DXE Core.
|
||||
|
||||
This function is the entry point to the DXE Foundation. The PEI phase, which executes just before
|
||||
DXE, is responsible for loading and invoking the DXE Foundation in system memory. The only
|
||||
parameter that is passed to the DXE Foundation is HobStart. This parameter is a pointer to the
|
||||
HOB list that describes the system state at the hand-off to the DXE Foundation. At a minimum,
|
||||
this system state must include the following:
|
||||
- PHIT HOB
|
||||
- CPU HOB
|
||||
- Description of system memory
|
||||
- Description of one or more firmware volumes
|
||||
The DXE Foundation is also guaranteed that only one processor is running and that the processor is
|
||||
running with interrupts disabled. The implementation of the DXE Foundation must not make any
|
||||
assumptions about where the DXE Foundation will be loaded or where the stack is located. In
|
||||
general, the DXE Foundation should make as few assumptions about the state of the system as
|
||||
possible. This lack of assumptions will allow the DXE Foundation to be portable to the widest
|
||||
variety of system architectures.
|
||||
|
||||
@param HobStart Pointer of HobList.
|
||||
This function is the entry point for the DXE Core. This function is required
|
||||
to call ProcessModuleEntryPointList() and ProcessModuleEntryPoint() is never
|
||||
expected to return. The DXE Core is responsible for calling ProcessLibraryConstructorList()
|
||||
as soon as the EFI System Table and the image handle for the DXE Core itself have
|
||||
been established.
|
||||
If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
|
||||
|
||||
@param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
|
||||
|
||||
**/
|
||||
VOID
|
||||
|
|
@ -72,9 +63,11 @@ _ModuleEntryPoint (
|
|||
|
||||
|
||||
/**
|
||||
Wrapper of entry point to DXE CORE.
|
||||
Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
|
||||
|
||||
@param HobStart Pointer of HobList.
|
||||
This function is required to call _ModuleEntryPoint() passing in HobStart.
|
||||
|
||||
@param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
|
||||
|
||||
**/
|
||||
VOID
|
||||
|
|
|
|||
|
|
@ -176,6 +176,7 @@ ExtractGuidedSectionRegisterHandlers (
|
|||
of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
||||
is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of
|
||||
type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
|
||||
|
||||
If InputSection is NULL, then ASSERT().
|
||||
If OutputBufferSize is NULL, then ASSERT().
|
||||
If ScratchBufferSize is NULL, then ASSERT().
|
||||
|
|
@ -250,7 +251,8 @@ ExtractGuidedSectionGetInfo (
|
|||
decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
|
||||
then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller
|
||||
allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE
|
||||
bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
|
||||
bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
|
||||
|
||||
If InputSection is NULL, then ASSERT().
|
||||
If OutputBuffer is NULL, then ASSERT().
|
||||
If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
|
||||
|
|
|
|||
|
|
@ -57,11 +57,14 @@ PcdLibConstructor (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which SKU support can be established in the PCD infrastructure.
|
||||
|
||||
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
||||
If SkuId is not less than PCD_MAX_SKU_ID, then ASSERT().
|
||||
|
||||
@param[in] SkuId System SKU ID. The SKU value that will be used when the PCD service will retrieve and
|
||||
set values.
|
||||
|
||||
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
|
||||
set values associated with a PCD token.
|
||||
|
||||
If SkuId >= 0x100, then ASSERT().
|
||||
|
||||
@return Return the SKU ID that just be set.
|
||||
|
||||
|
|
@ -69,7 +72,7 @@ PcdLibConstructor (
|
|||
UINTN
|
||||
EFIAPI
|
||||
LibPcdSetSku (
|
||||
IN UINTN SkuId
|
||||
IN UINTN SkuId
|
||||
)
|
||||
{
|
||||
ASSERT (SkuId < PCD_MAX_SKU_ID);
|
||||
|
|
@ -82,9 +85,11 @@ LibPcdSetSku (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 8-bit value for the token specified by TokenNumber.
|
||||
|
||||
@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.
|
||||
|
||||
@return Returns the 8-bit value for the token specified by TokenNumber.
|
||||
|
||||
|
|
@ -101,9 +106,11 @@ LibPcdGet8 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 16-bit value for the token specified by TokenNumber.
|
||||
|
||||
@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.
|
||||
|
||||
@return Returns the 16-bit value for the token specified by TokenNumber.
|
||||
|
||||
|
|
@ -120,6 +127,8 @@ LibPcdGet16 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 32-bit value for the token specified by TokenNumber.
|
||||
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
|
@ -139,6 +148,8 @@ LibPcdGet32 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 64-bit value for the token specified by TokenNumber.
|
||||
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
|
@ -158,6 +169,8 @@ LibPcdGet64 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the pointer to the buffer of the token specified by TokenNumber.
|
||||
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
|
@ -177,6 +190,8 @@ LibPcdGetPtr (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the Boolean value of the token specified by TokenNumber.
|
||||
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
|
@ -196,7 +211,7 @@ LibPcdGetBool (
|
|||
|
||||
|
||||
/**
|
||||
Returns the size of the token specified by TokenNumber.
|
||||
This function provides a means by which to retrieve the size of a given PCD token.
|
||||
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
||||
|
|
@ -215,7 +230,10 @@ LibPcdGetSize (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 8-bit value for the token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
|
|
@ -239,7 +257,10 @@ LibPcdGetEx8 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 16-bit value for the token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
|
|
@ -288,12 +309,15 @@ LibPcdGetEx32 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the 64-bit value for the token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
||||
@return Return the UINT64.
|
||||
|
||||
|
|
@ -313,12 +337,15 @@ LibPcdGetEx64 (
|
|||
|
||||
|
||||
/**
|
||||
Returns the pointer to the token specified by TokenNumber and Guid.
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the pointer to the buffer of token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
||||
@return Return the VOID* pointer.
|
||||
|
||||
|
|
@ -338,12 +365,15 @@ LibPcdGetExPtr (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve a value for a given PCD token.
|
||||
|
||||
Returns the Boolean value of the token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
||||
@return Return the BOOLEAN.
|
||||
|
||||
|
|
@ -363,12 +393,15 @@ LibPcdGetExBool (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to retrieve the size of a given PCD token.
|
||||
|
||||
Returns the size of the token specified by TokenNumber and Guid.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates
|
||||
which namespace to retrieve a value from.
|
||||
@param[in] TokenNumber The PCD token number to retrieve a current value for.
|
||||
|
||||
@return Return the size.
|
||||
|
||||
|
|
@ -388,12 +421,13 @@ LibPcdGetExSize (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 8-bit value for the token specified by TokenNumber
|
||||
to the value specified by Value. Value is returned.
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 8-bit value to set.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 8-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -417,12 +451,13 @@ LibPcdSet8 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 16-bit value for the token specified by TokenNumber
|
||||
to the value specified by Value. Value is returned.
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 16-bit value to set.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 16-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -446,12 +481,13 @@ LibPcdSet16 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 32-bit value for the token specified by TokenNumber
|
||||
to the value specified by Value. Value is returned.
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 32-bit value to set.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 32-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -460,7 +496,7 @@ UINT32
|
|||
EFIAPI
|
||||
LibPcdSet32 (
|
||||
IN UINTN TokenNumber,
|
||||
IN UINT32 Value
|
||||
IN UINT32 Value
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
@ -474,12 +510,13 @@ LibPcdSet32 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 64-bit value for the token specified by TokenNumber
|
||||
to the value specified by Value. Value is returned.
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 64-bit value to set.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 64-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -488,7 +525,7 @@ UINT64
|
|||
EFIAPI
|
||||
LibPcdSet64 (
|
||||
IN UINTN TokenNumber,
|
||||
IN UINT64 Value
|
||||
IN UINT64 Value
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
@ -503,22 +540,22 @@ LibPcdSet64 (
|
|||
|
||||
|
||||
/**
|
||||
Sets a buffer for the token specified by TokenNumber to
|
||||
the value specified by Buffer and SizeOfBuffer. Buffer to
|
||||
be set is returned. The content of the buffer could be
|
||||
overwritten if a Callback on SET is registered with this
|
||||
TokenNumber.
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
If SizeOfBuffer is greater than the maximum
|
||||
size support by TokenNumber, then set SizeOfBuffer to the
|
||||
maximum size supported by TokenNumber and return NULL to
|
||||
indicate that the set operation was not actually performed.
|
||||
Sets a buffer for the token specified by TokenNumber to the value
|
||||
specified by Buffer and SizeOfBuffer. Buffer is returned.
|
||||
If SizeOfBuffer is greater than the maximum size support by TokenNumber,
|
||||
then set SizeOfBuffer to the maximum size supported by TokenNumber and
|
||||
return NULL to indicate that the set operation was not actually performed.
|
||||
|
||||
If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the
|
||||
maximum size supported by TokenName and NULL must be returned.
|
||||
|
||||
If SizeOfBuffer is NULL, then ASSERT().
|
||||
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
|
||||
In out, returns actual size of buff is set.
|
||||
@param[in] Buffer A pointer to the buffer to set.
|
||||
|
||||
@return Return the pointer for the buffer been set.
|
||||
|
|
@ -552,12 +589,13 @@ LibPcdSetPtr (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the Boolean value for the token specified by TokenNumber
|
||||
to the value specified by Value. Value is returned.
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The boolean value to set.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The boolean value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -581,15 +619,17 @@ LibPcdSetBool (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 8-bit value for the token specified by TokenNumber and
|
||||
Guid to the value specified by Value. Value is returned.
|
||||
If Guid is NULL, then ASSERT().
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 8-bit value to set.
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 8-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -616,15 +656,17 @@ LibPcdSetEx8 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 16-bit value for the token specified by TokenNumber and
|
||||
Guid to the value specified by Value. Value is returned.
|
||||
If Guid is NULL, then ASSERT().
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 16-bit value to set.
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 16-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -651,15 +693,17 @@ LibPcdSetEx16 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 32-bit value for the token specified by TokenNumber and
|
||||
Guid to the value specified by Value. Value is returned.
|
||||
If Guid is NULL, then ASSERT().
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 32-bit value to set.
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 32-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -669,7 +713,7 @@ EFIAPI
|
|||
LibPcdSetEx32 (
|
||||
IN CONST GUID *Guid,
|
||||
IN UINTN TokenNumber,
|
||||
IN UINT32 Value
|
||||
IN UINT32 Value
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
@ -686,14 +730,16 @@ LibPcdSetEx32 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the 64-bit value for the token specified by TokenNumber and
|
||||
Guid to the value specified by Value. Value is returned.
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 64-bit value to set.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The 64-bit value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -703,7 +749,7 @@ EFIAPI
|
|||
LibPcdSetEx64 (
|
||||
IN CONST GUID *Guid,
|
||||
IN UINTN TokenNumber,
|
||||
IN UINT64 Value
|
||||
IN UINT64 Value
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
@ -720,20 +766,23 @@ LibPcdSetEx64 (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets a buffer for the token specified by TokenNumber to the value specified by
|
||||
Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
|
||||
the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size
|
||||
supported by TokenNumber and return NULL to indicate that the set operation
|
||||
was not actually performed.
|
||||
|
||||
If Guid is NULL, then ASSERT().
|
||||
If SizeOfBuffer is NULL, then ASSERT().
|
||||
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
|
||||
In out, returns actual size of buffer is set.
|
||||
@param[in] Buffer A pointer to the buffer to set.
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@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] Buffer A pointer to the buffer to set.
|
||||
|
||||
@return Return the pinter to the buffer been set.
|
||||
|
||||
|
|
@ -769,15 +818,17 @@ LibPcdSetExPtr (
|
|||
|
||||
|
||||
/**
|
||||
This function provides a means by which to set a value for a given PCD token.
|
||||
|
||||
Sets the Boolean value for the token specified by TokenNumber and
|
||||
Guid to the value specified by Value. Value is returned.
|
||||
If Guid is NULL, then ASSERT().
|
||||
If fail to set pcd value, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The Boolean value to set.
|
||||
If Guid is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that
|
||||
designates which namespace to set a value from.
|
||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
||||
@param[in] Value The Boolean value to set.
|
||||
|
||||
@return Return the value been set.
|
||||
|
||||
|
|
@ -804,18 +855,21 @@ LibPcdSetExBool (
|
|||
|
||||
|
||||
/**
|
||||
Set up a notification function that is called when a specified token is set.
|
||||
|
||||
When the token specified by TokenNumber and Guid is set,
|
||||
then notification function specified by NotificationFunction is called.
|
||||
If Guid is NULL, then the default token space is used.
|
||||
If NotificationFunction is NULL, then ASSERT().
|
||||
If fail to set callback function, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
||||
namespace to set a value from. If NULL, then the default
|
||||
token space is used.
|
||||
@param[in] TokenNumber The PCD token number to monitor.
|
||||
@param[in] NotificationFunction The function to call when the token
|
||||
specified by Guid and TokenNumber is set.
|
||||
If NotificationFunction is NULL, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
||||
namespace to set a value from. If NULL, then the default
|
||||
token space is used.
|
||||
@param[in] TokenNumber The PCD token number to monitor.
|
||||
@param[in] NotificationFunction The function to call when the token
|
||||
specified by Guid and TokenNumber is set.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
|
|
@ -840,11 +894,15 @@ LibPcdCallbackOnSet (
|
|||
|
||||
/**
|
||||
Disable a notification function that was established with LibPcdCallbackonSet().
|
||||
If NotificationFunction is NULL, then ASSERT().
|
||||
If fail to cancel callback function, then ASSERT_EFI_ERROR().
|
||||
|
||||
@param[in] Guid Specify the GUID token space.
|
||||
@param[in] TokenNumber Specify the token number.
|
||||
Disable a notification function that was previously established with LibPcdCallbackOnSet().
|
||||
|
||||
If NotificationFunction is NULL, then ASSERT().
|
||||
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
|
||||
and NotificationFunction, then ASSERT().
|
||||
|
||||
@param[in] Guid Specify the GUID token space.
|
||||
@param[in] TokenNumber Specify the token number.
|
||||
@param[in] NotificationFunction The callback function to be unregistered.
|
||||
|
||||
**/
|
||||
|
|
@ -870,13 +928,15 @@ LibPcdCancelCallback (
|
|||
|
||||
|
||||
/**
|
||||
Retrieves the next token in a token space.
|
||||
|
||||
Retrieves the next PCD token number from the token space specified by Guid.
|
||||
If Guid is NULL, then the default token space is used. If TokenNumber is 0,
|
||||
then the first token number is returned. Otherwise, the token number that
|
||||
follows TokenNumber in the token space is returned. If TokenNumber is the last
|
||||
token number in the token space, then 0 is returned. If TokenNumber is not 0 and
|
||||
is not in the token space specified by Guid, then ASSERT().
|
||||
If Fail to get next token, then ASSERT_EFI_ERROR().
|
||||
token number in the token space, then 0 is returned.
|
||||
|
||||
If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates which namespace
|
||||
to set a value from. If NULL, then the default token space is used.
|
||||
|
|
@ -886,11 +946,11 @@ LibPcdCancelCallback (
|
|||
@return The next valid token number.
|
||||
|
||||
**/
|
||||
UINTN
|
||||
UINTN
|
||||
EFIAPI
|
||||
LibPcdGetNextToken (
|
||||
IN CONST GUID *Guid, OPTIONAL
|
||||
IN UINTN TokenNumber
|
||||
IN CONST GUID *Guid, OPTIONAL
|
||||
IN UINTN TokenNumber
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
@ -914,7 +974,8 @@ LibPcdGetNextToken (
|
|||
then NULL is returned.
|
||||
|
||||
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
|
||||
If fail to get next token space, then ASSERT_EFI_ERROR().
|
||||
|
||||
|
||||
|
||||
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
|
||||
to start the search.
|
||||
|
|
@ -939,6 +1000,8 @@ LibPcdGetNextTokenSpace (
|
|||
|
||||
|
||||
/**
|
||||
Sets a value of a patchable PCD entry that is type pointer.
|
||||
|
||||
Sets the PCD entry specified by PatchVariable to the value specified by Buffer
|
||||
and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
|
||||
MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return
|
||||
|
|
@ -954,12 +1017,10 @@ LibPcdGetNextTokenSpace (
|
|||
the target of the set operation.
|
||||
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.
|
||||
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
|
||||
In out, returns actual size of buffer is set.
|
||||
@param[in] Buffer A pointer to the buffer to used to set the target variable.
|
||||
|
||||
|
||||
@return Return the pointer to the buffer been set.
|
||||
@retval NULL If SizeOfBuffer is set to MAX_ADDRESS or larger than MaximumDatumSize,
|
||||
then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.
|
||||
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
|
|
|
|||
|
|
@ -249,9 +249,13 @@ GetPciExpressAddress (
|
|||
}
|
||||
|
||||
/**
|
||||
Register a PCI device so PCI configuration registers may be accessed after
|
||||
Registers a PCI device so PCI configuration registers may be accessed after
|
||||
SetVirtualAddressMap().
|
||||
|
||||
Registers the PCI device specified by Address so all the PCI configuration
|
||||
registers associated with that PCI device may be accessed after SetVirtualAddressMap()
|
||||
is called.
|
||||
|
||||
If Address > 0x0FFFFFFF, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Bus, Device, Function and
|
||||
|
|
@ -1453,7 +1457,7 @@ PciExpressBitFieldAndThenOr32 (
|
|||
@param Size Size in bytes of the transfer.
|
||||
@param Buffer Pointer to a buffer receiving the data read.
|
||||
|
||||
@return Size
|
||||
@return Size read data from StartAddress.
|
||||
|
||||
**/
|
||||
UINTN
|
||||
|
|
@ -1552,7 +1556,7 @@ PciExpressReadBuffer (
|
|||
@param Size Size in bytes of the transfer.
|
||||
@param Buffer Pointer to a buffer containing the data to write.
|
||||
|
||||
@return Size
|
||||
@return Size written to StartAddress.
|
||||
|
||||
**/
|
||||
UINTN
|
||||
|
|
|
|||
Loading…
Reference in New Issue