diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-10 03:04:00 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-10 03:04:00 +0000 |
| commit | 0c3437e0437334687bf08557339072ec9d6977e3 (patch) | |
| tree | 1c5f3d520f7c31f48f28528b2f78b198d65dc02b /MdePkg | |
| parent | 9ece9bd35a394cf28c873612b103441104201342 (diff) | |
| download | edk2-platforms-0c3437e0437334687bf08557339072ec9d6977e3.tar.xz | |
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@6949 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
| -rw-r--r-- | MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c | 2 | ||||
| -rw-r--r-- | MdePkg/Library/PeiMemoryLib/MemLibInternals.h | 30 | ||||
| -rw-r--r-- | MdePkg/Library/PeiPcdLib/PeiPcdLib.c | 286 | ||||
| -rw-r--r-- | MdePkg/Library/PeiPciLibPciCfg2/PciLib.c | 18 | ||||
| -rw-r--r-- | MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c | 283 |
5 files changed, 346 insertions, 273 deletions
diff --git a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c index 34d8a47d84..27da96d56b 100644 --- a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c +++ b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
diff --git a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h index 468b464454..e216b9445b 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h +++ b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h @@ -35,38 +35,42 @@ #include <Library/BaseLib.h>
/**
- Copy Length bytes from Source to Destination.
+ Copies a source buffer to a destination buffer, and returns the destination buffer.
- @param DestinationBuffer Target of copy
- @param SourceBuffer Place to copy from
- @param Length Number of bytes to copy
+ This function wraps the gPS->CopyMem ().
+
+ @param DestinationBuffer Pointer to the destination buffer of the memory copy.
+ @param SourceBuffer Pointer to the source buffer of the memory copy.
+ @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.
- @return Destination
+ @return DestinationBuffer.
**/
VOID *
EFIAPI
InternalMemCopyMem (
- OUT VOID *DestinationBuffer,
- IN CONST VOID *SourceBuffer,
+ OUT VOID *Destination,
+ IN CONST VOID *Source,
IN UINTN Length
);
/**
- Set Buffer to Value for Size bytes.
+ Fills a target buffer with a byte value, and returns the target buffer.
- @param Buffer Memory to set.
- @param Length Number of bytes to set
- @param Value Value of the set operation.
+ This function wraps the gPS->SetMem ().
+
+ @param Buffer Memory to set.
+ @param Size Number of bytes to set.
+ @param Value Value of the set operation.
- @return Buffer
+ @return Buffer.
**/
VOID *
EFIAPI
InternalMemSetMem (
OUT VOID *Buffer,
- IN UINTN Length,
+ IN UINTN Size,
IN UINT8 Value
);
diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index ac5bbcf058..7bbb0f8039 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -49,11 +49,14 @@ GetPcdPpiPointer ( }
/**
+ 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 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.
@@ -61,7 +64,7 @@ GetPcdPpiPointer ( UINTN
EFIAPI
LibPcdSetSku (
- IN UINTN SkuId
+ IN UINTN SkuId
)
{
@@ -75,6 +78,8 @@ 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.
@@ -85,7 +90,7 @@ LibPcdSetSku ( UINT8
EFIAPI
LibPcdGet8 (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->Get8 (TokenNumber);
@@ -94,9 +99,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.
@@ -104,7 +111,7 @@ LibPcdGet8 ( UINT16
EFIAPI
LibPcdGet16 (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->Get16 (TokenNumber);
@@ -113,6 +120,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.
@@ -123,7 +132,7 @@ LibPcdGet16 ( UINT32
EFIAPI
LibPcdGet32 (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->Get32 (TokenNumber);
@@ -132,6 +141,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.
@@ -142,7 +153,7 @@ LibPcdGet32 ( UINT64
EFIAPI
LibPcdGet64 (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->Get64 (TokenNumber);
@@ -151,6 +162,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.
@@ -161,7 +174,7 @@ LibPcdGet64 ( VOID *
EFIAPI
LibPcdGetPtr (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->GetPtr (TokenNumber);
@@ -170,6 +183,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.
@@ -180,7 +195,7 @@ LibPcdGetPtr ( BOOLEAN
EFIAPI
LibPcdGetBool (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->GetBool (TokenNumber);
@@ -189,7 +204,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.
@@ -199,7 +214,7 @@ LibPcdGetBool ( UINTN
EFIAPI
LibPcdGetSize (
- IN UINTN TokenNumber
+ IN UINTN TokenNumber
)
{
return (GetPcdPpiPointer ())->GetSize (TokenNumber);
@@ -208,7 +223,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
@@ -233,7 +251,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
@@ -285,12 +306,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.
@@ -309,12 +333,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.
@@ -334,12 +361,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.
@@ -358,12 +388,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.
@@ -382,12 +415,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.
@@ -411,12 +445,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.
@@ -440,12 +475,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.
@@ -454,7 +490,7 @@ UINT32 EFIAPI
LibPcdSet32 (
IN UINTN TokenNumber,
- IN UINT32 Value
+ IN UINT32 Value
)
{
EFI_STATUS Status;
@@ -469,12 +505,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.
@@ -483,7 +520,7 @@ UINT64 EFIAPI
LibPcdSet64 (
IN UINTN TokenNumber,
- IN UINT64 Value
+ IN UINT64 Value
)
{
EFI_STATUS Status;
@@ -498,23 +535,23 @@ 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 buffer is set.
- @param[in] Buffer A pointer to the buffer to set.
+ @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 pointer for the buffer been set.
@@ -522,9 +559,9 @@ LibPcdSet64 ( VOID *
EFIAPI
LibPcdSetPtr (
- IN UINTN TokenNumber,
- IN OUT UINTN *SizeOfBuffer,
- IN CONST VOID *Buffer
+ IN UINTN TokenNumber,
+ IN OUT UINTN *SizeOfBuffer,
+ IN CONST VOID *Buffer
)
{
EFI_STATUS Status;
@@ -547,12 +584,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.
@@ -576,15 +614,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.
+ @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.
@@ -611,15 +651,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.
+ @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.
@@ -644,15 +686,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.
+ @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.
@@ -662,7 +706,7 @@ EFIAPI LibPcdSetEx32 (
IN CONST GUID *Guid,
IN UINTN TokenNumber,
- IN UINT32 Value
+ IN UINT32 Value
)
{
EFI_STATUS Status;
@@ -679,15 +723,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().
- 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 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.
@@ -713,20 +758,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.
@@ -759,15 +807,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.
+ @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.
@@ -793,17 +843,20 @@ 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, 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.
+
+ @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
@@ -827,11 +880,15 @@ LibPcdCallbackOnSet ( /**
Disable a notification function that was established with LibPcdCallbackonSet().
+
+ Disable a notification function that was previously established with LibPcdCallbackOnSet().
+
If NotificationFunction is NULL, then ASSERT().
- If fail to cancel callback, then ASSERT_EFI_ERROR().
+ 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] Guid Specify the GUID token space.
+ @param[in] TokenNumber Specify the token number.
@param[in] NotificationFunction The callback function to be unregistered.
**/
@@ -855,27 +912,29 @@ 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 token in given token space, then ASSERT_EFI_ERROR().
+ token number in the token space, then 0 is returned.
- @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 previous PCD token number. If 0, then retrieves the first PCD
- token number.
+ 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.
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
+ token number.
@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;
@@ -896,8 +955,7 @@ LibPcdGetNextToken ( platform. If Guid is NULL, then the GUID of the first non-local token space of the
current platform is returned. If Guid is the last non-local token space,
then NULL is returned.
- If fail to get next token space, then ASSERT_EFI_ERROR().
-
+
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
diff --git a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c index 0d2ba6cecc..1406813f43 100644 --- a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c +++ b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c @@ -170,7 +170,7 @@ PciRegisterForRuntimeAccess ( @param Address Address that encodes the PCI Bus, Device, Function and
Register.
- @return The value read from the PCI configuration register.
+ @return The read value from the PCI configuration register.
**/
UINT8
@@ -195,7 +195,7 @@ PciRead8 ( @param Address Address that encodes the PCI Bus, Device, Function and
Register.
- @param Data The value to write.
+ @param Value The value to write.
@return The value written to the PCI configuration register.
@@ -204,12 +204,12 @@ UINT8 EFIAPI
PciWrite8 (
IN UINTN Address,
- IN UINT8 Data
+ IN UINT8 Value
)
{
ASSERT_INVALID_PCI_ADDRESS (Address, 0);
- return (UINT8) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Data);
+ return (UINT8) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Value);
}
/**
@@ -550,12 +550,12 @@ UINT16 EFIAPI
PciWrite16 (
IN UINTN Address,
- IN UINT16 Data
+ IN UINT16 Value
)
{
ASSERT_INVALID_PCI_ADDRESS (Address, 1);
- return (UINT16) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Data);
+ return (UINT16) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Value);
}
/**
@@ -904,12 +904,12 @@ UINT32 EFIAPI
PciWrite32 (
IN UINTN Address,
- IN UINT32 Data
+ IN UINT32 Value
)
{
ASSERT_INVALID_PCI_ADDRESS (Address, 3);
- return PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Data);
+ return PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Value);
}
/**
@@ -1328,7 +1328,7 @@ PciReadBuffer ( @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
diff --git a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c index 215fdabc2e..7d59b0a380 100644 --- a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c +++ b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c @@ -204,7 +204,7 @@ PciSegmentRegisterForRuntimeAccess ( UINT8
EFIAPI
PciSegmentRead8 (
- IN UINT64 Address
+ IN UINT64 Address
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 0);
@@ -229,8 +229,8 @@ PciSegmentRead8 ( UINT8
EFIAPI
PciSegmentWrite8 (
- IN UINT64 Address,
- IN UINT8 Value
+ IN UINT64 Address,
+ IN UINT8 Value
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 0);
@@ -258,8 +258,8 @@ PciSegmentWrite8 ( UINT8
EFIAPI
PciSegmentOr8 (
- IN UINT64 Address,
- IN UINT8 OrData
+ IN UINT64 Address,
+ IN UINT8 OrData
)
{
return PciSegmentWrite8 (Address, (UINT8) (PciSegmentRead8 (Address) | OrData));
@@ -284,8 +284,8 @@ PciSegmentOr8 ( UINT8
EFIAPI
PciSegmentAnd8 (
- IN UINT64 Address,
- IN UINT8 AndData
+ IN UINT64 Address,
+ IN UINT8 AndData
)
{
return PciSegmentWrite8 (Address, (UINT8) (PciSegmentRead8 (Address) & AndData));
@@ -314,9 +314,9 @@ PciSegmentAnd8 ( UINT8
EFIAPI
PciSegmentAndThenOr8 (
- IN UINT64 Address,
- IN UINT8 AndData,
- IN UINT8 OrData
+ IN UINT64 Address,
+ IN UINT8 AndData,
+ IN UINT8 OrData
)
{
return PciSegmentWrite8 (Address, (UINT8) ((PciSegmentRead8 (Address) & AndData) | OrData));
@@ -346,9 +346,9 @@ PciSegmentAndThenOr8 ( UINT8
EFIAPI
PciSegmentBitFieldRead8 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit
)
{
return BitFieldRead8 (PciSegmentRead8 (Address), StartBit, EndBit);
@@ -380,10 +380,10 @@ PciSegmentBitFieldRead8 ( UINT8
EFIAPI
PciSegmentBitFieldWrite8 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT8 Value
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT8 Value
)
{
return PciSegmentWrite8 (
@@ -421,10 +421,10 @@ PciSegmentBitFieldWrite8 ( UINT8
EFIAPI
PciSegmentBitFieldOr8 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT8 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT8 OrData
)
{
return PciSegmentWrite8 (
@@ -462,10 +462,10 @@ PciSegmentBitFieldOr8 ( UINT8
EFIAPI
PciSegmentBitFieldAnd8 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT8 AndData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT8 AndData
)
{
return PciSegmentWrite8 (
@@ -506,11 +506,11 @@ PciSegmentBitFieldAnd8 ( UINT8
EFIAPI
PciSegmentBitFieldAndThenOr8 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT8 AndData,
- IN UINT8 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT8 AndData,
+ IN UINT8 OrData
)
{
return PciSegmentWrite8 (
@@ -536,7 +536,7 @@ PciSegmentBitFieldAndThenOr8 ( UINT16
EFIAPI
PciSegmentRead16 (
- IN UINT64 Address
+ IN UINT64 Address
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 1);
@@ -562,8 +562,8 @@ PciSegmentRead16 ( UINT16
EFIAPI
PciSegmentWrite16 (
- IN UINT64 Address,
- IN UINT16 Value
+ IN UINT64 Address,
+ IN UINT16 Value
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 1);
@@ -595,8 +595,8 @@ PciSegmentWrite16 ( UINT16
EFIAPI
PciSegmentOr16 (
- IN UINT64 Address,
- IN UINT16 OrData
+ IN UINT64 Address,
+ IN UINT16 OrData
)
{
return PciSegmentWrite16 (Address, (UINT16) (PciSegmentRead16 (Address) | OrData));
@@ -623,8 +623,8 @@ PciSegmentOr16 ( UINT16
EFIAPI
PciSegmentAnd16 (
- IN UINT64 Address,
- IN UINT16 AndData
+ IN UINT64 Address,
+ IN UINT16 AndData
)
{
return PciSegmentWrite16 (Address, (UINT16) (PciSegmentRead16 (Address) & AndData));
@@ -654,9 +654,9 @@ PciSegmentAnd16 ( UINT16
EFIAPI
PciSegmentAndThenOr16 (
- IN UINT64 Address,
- IN UINT16 AndData,
- IN UINT16 OrData
+ IN UINT64 Address,
+ IN UINT16 AndData,
+ IN UINT16 OrData
)
{
return PciSegmentWrite16 (Address, (UINT16) ((PciSegmentRead16 (Address) & AndData) | OrData));
@@ -687,9 +687,9 @@ PciSegmentAndThenOr16 ( UINT16
EFIAPI
PciSegmentBitFieldRead16 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit
)
{
return BitFieldRead16 (PciSegmentRead16 (Address), StartBit, EndBit);
@@ -722,10 +722,10 @@ PciSegmentBitFieldRead16 ( UINT16
EFIAPI
PciSegmentBitFieldWrite16 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT16 Value
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT16 Value
)
{
return PciSegmentWrite16 (
@@ -758,10 +758,10 @@ PciSegmentBitFieldWrite16 ( UINT16
EFIAPI
PciSegmentBitFieldOr16 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT16 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT16 OrData
)
{
return PciSegmentWrite16 (
@@ -771,38 +771,39 @@ PciSegmentBitFieldOr16 ( }
/**
- Reads a bit field in a 16-bit PCI configuration register, performs a bitwise
- AND, and writes the result back to the bit field in the 16-bit register.
-
- Reads the 16-bit PCI configuration register specified by Address, performs a
- bitwise AND between the read result and the value specified by AndData, and
- writes the result to the 16-bit PCI configuration register specified by
- Address. The value written to the PCI configuration register is returned.
- This function must guarantee that all PCI read and write operations are
- serialized. Extra left bits in AndData are stripped.
+ Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR,
+ and writes the result back to the bit field in the 16-bit port.
+ Reads the 16-bit PCI configuration register specified by Address,
+ performs a bitwise OR between the read result and the value specified by OrData,
+ and writes the result to the 16-bit PCI configuration register specified by Address.
+ The value written to the PCI configuration register is returned.
+ This function must guarantee that all PCI read and write operations are serialized.
+ Extra left bits in OrData are stripped.
+
If any reserved bits in Address are set, then ASSERT().
- If StartBit is greater than 15, then ASSERT().
- If EndBit is greater than 15, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
+ If StartBit is greater than 7, then ASSERT().
+ If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
@param StartBit The ordinal of the least significant bit in the bit field.
- Range 0..15.
+ The ordinal of the least significant bit in a byte is bit 0.
@param EndBit The ordinal of the most significant bit in the bit field.
- Range 0..15.
- @param AndData The value to AND with the PCI configuration register.
+ The ordinal of the most significant bit in a byte is bit 7.
+ @param AndData The value to AND with the read value from the PCI configuration register.
- @return The value written back to the PCI configuration register.
+ @return The value written to the PCI configuration register.
**/
UINT16
EFIAPI
PciSegmentBitFieldAnd16 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT16 AndData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT16 AndData
)
{
return PciSegmentWrite16 (
@@ -843,11 +844,11 @@ PciSegmentBitFieldAnd16 ( UINT16
EFIAPI
PciSegmentBitFieldAndThenOr16 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT16 AndData,
- IN UINT16 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT16 AndData,
+ IN UINT16 OrData
)
{
return PciSegmentWrite16 (
@@ -873,7 +874,7 @@ PciSegmentBitFieldAndThenOr16 ( UINT32
EFIAPI
PciSegmentRead32 (
- IN UINT64 Address
+ IN UINT64 Address
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 3);
@@ -899,8 +900,8 @@ PciSegmentRead32 ( UINT32
EFIAPI
PciSegmentWrite32 (
- IN UINT64 Address,
- IN UINT32 Value
+ IN UINT64 Address,
+ IN UINT32 Value
)
{
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 3);
@@ -929,8 +930,8 @@ PciSegmentWrite32 ( UINT32
EFIAPI
PciSegmentOr32 (
- IN UINT64 Address,
- IN UINT32 OrData
+ IN UINT64 Address,
+ IN UINT32 OrData
)
{
return PciSegmentWrite32 (Address, PciSegmentRead32 (Address) | OrData);
@@ -957,8 +958,8 @@ PciSegmentOr32 ( UINT32
EFIAPI
PciSegmentAnd32 (
- IN UINT64 Address,
- IN UINT32 AndData
+ IN UINT64 Address,
+ IN UINT32 AndData
)
{
return PciSegmentWrite32 (Address, PciSegmentRead32 (Address) & AndData);
@@ -988,9 +989,9 @@ PciSegmentAnd32 ( UINT32
EFIAPI
PciSegmentAndThenOr32 (
- IN UINT64 Address,
- IN UINT32 AndData,
- IN UINT32 OrData
+ IN UINT64 Address,
+ IN UINT32 AndData,
+ IN UINT32 OrData
)
{
return PciSegmentWrite32 (Address, (PciSegmentRead32 (Address) & AndData) | OrData);
@@ -1021,9 +1022,9 @@ PciSegmentAndThenOr32 ( UINT32
EFIAPI
PciSegmentBitFieldRead32 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit
)
{
return BitFieldRead32 (PciSegmentRead32 (Address), StartBit, EndBit);
@@ -1056,10 +1057,10 @@ PciSegmentBitFieldRead32 ( UINT32
EFIAPI
PciSegmentBitFieldWrite32 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT32 Value
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT32 Value
)
{
return PciSegmentWrite32 (
@@ -1097,10 +1098,10 @@ PciSegmentBitFieldWrite32 ( UINT32
EFIAPI
PciSegmentBitFieldOr32 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT32 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT32 OrData
)
{
return PciSegmentWrite32 (
@@ -1113,17 +1114,18 @@ PciSegmentBitFieldOr32 ( Reads a bit field in a 32-bit PCI configuration register, performs a bitwise
AND, and writes the result back to the bit field in the 32-bit register.
- Reads the 32-bit PCI configuration register specified by Address, performs a
- bitwise AND between the read result and the value specified by AndData, and
- writes the result to the 32-bit PCI configuration register specified by
- Address. The value written to the PCI configuration register is returned.
- This function must guarantee that all PCI read and write operations are
- serialized. Extra left bits in AndData are stripped.
-
+
+ Reads the 32-bit PCI configuration register specified by Address, performs a bitwise
+ AND between the read result and the value specified by AndData, and writes the result
+ to the 32-bit PCI configuration register specified by Address. The value written to
+ the PCI configuration register is returned. This function must guarantee that all PCI
+ read and write operations are serialized. Extra left bits in AndData are stripped.
If any reserved bits in Address are set, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+
@param Address PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -1138,10 +1140,10 @@ PciSegmentBitFieldOr32 ( UINT32
EFIAPI
PciSegmentBitFieldAnd32 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT32 AndData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT32 AndData
)
{
return PciSegmentWrite32 (
@@ -1182,11 +1184,11 @@ PciSegmentBitFieldAnd32 ( UINT32
EFIAPI
PciSegmentBitFieldAndThenOr32 (
- IN UINT64 Address,
- IN UINTN StartBit,
- IN UINTN EndBit,
- IN UINT32 AndData,
- IN UINT32 OrData
+ IN UINT64 Address,
+ IN UINTN StartBit,
+ IN UINTN EndBit,
+ IN UINT32 AndData,
+ IN UINT32 OrData
)
{
return PciSegmentWrite32 (
@@ -1198,28 +1200,32 @@ PciSegmentBitFieldAndThenOr32 ( /**
Reads a range of PCI configuration registers into a caller supplied buffer.
- Reads the range of PCI configuration registers specified by StartAddress
- and Size into the buffer specified by Buffer.
- This function only allows the PCI configuration registers from a single PCI function to be read.
- Size is returned.
-
- If any reserved bits in StartAddress are set, then ASSERT().
+ Reads the range of PCI configuration registers specified by StartAddress and
+ Size into the buffer specified by Buffer. This function only allows the PCI
+ configuration registers from a single PCI function to be read. Size is
+ returned. When possible 32-bit PCI configuration read cycles are used to read
+ from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit
+ and 16-bit PCI configuration read cycles may be used at the beginning and the
+ end of the range.
+
+ If StartAddress > 0x0FFFFFFF, then ASSERT().
If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param StartAddress Starting address that encodes the PCI Segment, Bus, Device,
+ Function and Register.
@param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer receiving the data read.
- @return The parameter of Size.
+ @return Size
**/
UINTN
EFIAPI
PciSegmentReadBuffer (
- IN UINT64 StartAddress,
- IN UINTN Size,
- OUT VOID *Buffer
+ IN UINT64 StartAddress,
+ IN UINTN Size,
+ OUT VOID *Buffer
)
{
UINTN ReturnValue;
@@ -1290,18 +1296,23 @@ PciSegmentReadBuffer ( /**
- Copies the data in a caller supplied buffer to a specified range of PCI configuration space.
-
- Writes the range of PCI configuration registers specified by StartAddress
- and Size from the buffer specified by Buffer.
- This function only allows the PCI configuration registers from a single PCI function to be written.
- Size is returned.
-
- If any reserved bits in StartAddress are set, then ASSERT().
+ Copies the data in a caller supplied buffer to a specified range of PCI
+ configuration space.
+
+ Writes the range of PCI configuration registers specified by StartAddress and
+ Size from the buffer specified by Buffer. This function only allows the PCI
+ configuration registers from a single PCI function to be written. Size is
+ returned. When possible 32-bit PCI configuration write cycles are used to
+ write from StartAdress to StartAddress + Size. Due to alignment restrictions,
+ 8-bit and 16-bit PCI configuration write cycles may be used at the beginning
+ and the end of the range.
+
+ If StartAddress > 0x0FFFFFFF, then ASSERT().
If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param StartAddress Starting address that encodes the PCI Segment, Bus, Device,
+ Function and Register.
@param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write.
@@ -1311,9 +1322,9 @@ PciSegmentReadBuffer ( UINTN
EFIAPI
PciSegmentWriteBuffer (
- IN UINT64 StartAddress,
- IN UINTN Size,
- IN VOID *Buffer
+ IN UINT64 StartAddress,
+ IN UINTN Size,
+ IN VOID *Buffer
)
{
UINTN ReturnValue;
|