tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
klu2 2008-12-10 03:04:00 +00:00
parent 9ece9bd35a
commit 0c3437e043
5 changed files with 350 additions and 277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
MdePkg/Library/PeiMemoryLib/MemLibInternals.h
View File

@ -35,38 +35,42 @@
#include <Library/BaseLib.h> #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 This function wraps the gPS->CopyMem ().
@param SourceBuffer Place to copy from
@param Length Number of bytes to copy
@return Destination @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 DestinationBuffer.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
InternalMemCopyMem ( InternalMemCopyMem (
OUT VOID *DestinationBuffer, OUT VOID *Destination,
IN CONST VOID *SourceBuffer, IN CONST VOID *Source,
IN UINTN Length IN UINTN Length
); );
/** /**
Set Buffer to Value for Size bytes. Fills a target buffer with a byte value, and returns the target buffer.
This function wraps the gPS->SetMem ().
@param Buffer Memory to set. @param Buffer Memory to set.
@param Length Number of bytes to set @param Size Number of bytes to set.
@param Value Value of the set operation. @param Value Value of the set operation.
@return Buffer @return Buffer.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
InternalMemSetMem ( InternalMemSetMem (
OUT VOID *Buffer, OUT VOID *Buffer,
IN UINTN Length, IN UINTN Size,
IN UINT8 Value IN UINT8 Value
); );

124
MdePkg/Library/PeiPcdLib/PeiPcdLib.c
View File

@ -49,11 +49,14 @@ GetPcdPpiPointer (
} }
/** /**
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned. This function provides a means by which SKU support can be established in the PCD infrastructure.
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 Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
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. @return Return the SKU ID that just be set.
@ -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. 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.
@ -94,6 +99,8 @@ 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. 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.
@ -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. Returns the 32-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.
@ -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. Returns the 64-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.
@ -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. 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. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@ -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. Returns the Boolean value of 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.
@ -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. @param[in] TokenNumber The PCD token number to retrieve a current value for.
@ -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. Returns the 8-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
@ -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. Returns the 16-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
@ -285,7 +306,10 @@ 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. 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
@ -309,7 +333,10 @@ 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(). 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
@ -334,7 +361,10 @@ 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. 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
@ -358,7 +388,10 @@ 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. 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
@ -382,9 +415,10 @@ 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 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.
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] 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.
@ -411,9 +445,10 @@ 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 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.
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] 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.
@ -440,9 +475,10 @@ 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 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.
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] 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.
@ -469,9 +505,10 @@ 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 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.
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] 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.
@ -498,22 +535,22 @@ LibPcdSet64 (
/** /**
Sets a buffer for the token specified by TokenNumber to This function provides a means by which to set a value for a given PCD token.
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.
If SizeOfBuffer is greater than the maximum Sets a buffer for the token specified by TokenNumber to the value
size support by TokenNumber, then set SizeOfBuffer to the specified by Buffer and SizeOfBuffer. Buffer is returned.
maximum size supported by TokenNumber and return NULL to If SizeOfBuffer is greater than the maximum size support by TokenNumber,
indicate that the set operation was not actually performed. 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(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
@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.
In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to set. @param[in] Buffer A pointer to the buffer to set.
@return Return the pointer for the buffer been set. @return Return the pointer for the buffer been set.
@ -547,9 +584,10 @@ 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 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.
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] 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.
@ -576,10 +614,12 @@ 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 Sets the 8-bit value for the token specified by TokenNumber and
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().
If fail to set pcd value, then ASSERT_EFI_ERROR().
@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.
@ -611,10 +651,12 @@ 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 Sets the 16-bit value for the token specified by TokenNumber and
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().
If fail to set pcd value, then ASSERT_EFI_ERROR().
@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.
@ -644,10 +686,12 @@ 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 Sets the 32-bit value for the token specified by TokenNumber and
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().
If fail to set pcd value, then ASSERT_EFI_ERROR().
@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.
@ -679,10 +723,11 @@ 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 Sets the 64-bit value for the token specified by TokenNumber and
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().
If fail to set pcd value, then ASSERT_EFI_ERROR().
@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.
@ -713,19 +758,22 @@ 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 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 Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size 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 supported by TokenNumber and return NULL to indicate that the set operation
was not actually performed. 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(). If SizeOfBuffer > 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.
In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to set. @param[in] Buffer A pointer to the buffer to set.
@return Return the pinter to the buffer been set. @return Return the pinter to the buffer been set.
@ -759,10 +807,12 @@ 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 Sets the Boolean value for the token specified by TokenNumber and
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().
If fail to set pcd value, then ASSERT_EFI_ERROR().
@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.
@ -793,11 +843,14 @@ 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, When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called. then notification function specified by NotificationFunction is called.
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().
If fail to set callback, then ASSERT_EFI_ERROR().
@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.
@ -827,8 +880,12 @@ LibPcdCallbackOnSet (
/** /**
Disable a notification function that was established with 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 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] Guid Specify the GUID token space.
@param[in] TokenNumber Specify the token number. @param[in] TokenNumber Specify the token number.
@ -855,13 +912,15 @@ LibPcdCancelCallback (
/** /**
Retrieves the next token in a token space.
Retrieves the next PCD token number from the token space specified by Guid. 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, 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 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 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 token number in the token space, then 0 is returned.
is not in the token space specified by Guid, then ASSERT().
If fail to get token in given token space, then ASSERT_EFI_ERROR(). 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 @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. to set a value from. If NULL, then the default token space is used.
@ -896,7 +955,6 @@ LibPcdGetNextToken (
platform. If Guid is NULL, then the GUID of the first non-local token space of the 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, current platform is returned. If Guid is the last non-local token space,
then NULL is returned. 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(). If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().

18
MdePkg/Library/PeiPciLibPciCfg2/PciLib.c
View File

@ -170,7 +170,7 @@ PciRegisterForRuntimeAccess (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@return The value read from the PCI configuration register. @return The read value from the PCI configuration register.
**/ **/
UINT8 UINT8
@ -195,7 +195,7 @@ PciRead8 (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@param Data The value to write. @param Value The value to write.
@return The value written to the PCI configuration register. @return The value written to the PCI configuration register.
@ -204,12 +204,12 @@ UINT8
EFIAPI EFIAPI
PciWrite8 ( PciWrite8 (
IN UINTN Address, IN UINTN Address,
IN UINT8 Data IN UINT8 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 0); ASSERT_INVALID_PCI_ADDRESS (Address, 0);
return (UINT8) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Data); return (UINT8) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Value);
} }
/** /**
@ -550,12 +550,12 @@ UINT16
EFIAPI EFIAPI
PciWrite16 ( PciWrite16 (
IN UINTN Address, IN UINTN Address,
IN UINT16 Data IN UINT16 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 1); ASSERT_INVALID_PCI_ADDRESS (Address, 1);
return (UINT16) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Data); return (UINT16) PeiPciLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Value);
} }
/** /**
@ -904,12 +904,12 @@ UINT32
EFIAPI EFIAPI
PciWrite32 ( PciWrite32 (
IN UINTN Address, IN UINTN Address,
IN UINT32 Data IN UINT32 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 3); 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 Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write. @param Buffer Pointer to a buffer containing the data to write.
@return Size @return Size written to StartAddress.
**/ **/
UINTN UINTN

81
MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c
View File

@ -771,29 +771,30 @@ PciSegmentBitFieldOr16 (
} }
/** /**
Reads a bit field in a 16-bit PCI configuration register, performs a bitwise Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR,
AND, and writes the result back to the bit field in the 16-bit register. 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 Reads the 16-bit PCI configuration register specified by Address,
bitwise AND between the read result and the value specified by AndData, and performs a bitwise OR between the read result and the value specified by OrData,
writes the result to the 16-bit PCI configuration register specified by and writes the result to the 16-bit PCI configuration register specified by Address.
Address. The value written to the PCI configuration register is returned. The value written to the PCI configuration register is returned.
This function must guarantee that all PCI read and write operations are This function must guarantee that all PCI read and write operations are serialized.
serialized. Extra left bits in AndData are stripped. Extra left bits in OrData are stripped.
If any reserved bits in Address are set, then ASSERT(). If any reserved bits in Address are set, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().
If EndBit is greater than 15, 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(). 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. @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. @param EndBit The ordinal of the most significant bit in the bit field.
Range 0..15. The ordinal of the most significant bit in a byte is bit 7.
@param AndData The value to AND with the PCI configuration register. @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 UINT16
@ -1113,18 +1114,19 @@ PciSegmentBitFieldOr32 (
Reads a bit field in a 32-bit PCI configuration register, performs a bitwise 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. 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 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 StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@param Address PCI configuration register to write. @param Address PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field. @param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31. Range 0..31.
@ -1198,20 +1200,24 @@ PciSegmentBitFieldAndThenOr32 (
/** /**
Reads a range of PCI configuration registers into a caller supplied buffer. Reads a range of PCI configuration registers into a caller supplied buffer.
Reads the range of PCI configuration registers specified by StartAddress Reads the range of PCI configuration registers specified by StartAddress and
and Size into the buffer specified by Buffer. Size into the buffer specified by Buffer. This function only allows the PCI
This function only allows the PCI configuration registers from a single PCI function to be read. configuration registers from a single PCI function to be read. Size is
Size is returned. 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 any reserved bits in StartAddress are set, then ASSERT(). If StartAddress > 0x0FFFFFFF, then ASSERT().
If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, 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 Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer receiving the data read. @param Buffer Pointer to a buffer receiving the data read.
@return The parameter of Size. @return Size
**/ **/
UINTN UINTN
@ -1290,18 +1296,23 @@ PciSegmentReadBuffer (
/** /**
Copies the data in a caller supplied buffer to a specified range of PCI configuration space. 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 Writes the range of PCI configuration registers specified by StartAddress and
and Size from the buffer specified by Buffer. Size from the buffer specified by Buffer. This function only allows the PCI
This function only allows the PCI configuration registers from a single PCI function to be written. configuration registers from a single PCI function to be written. Size is
Size is returned. 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 any reserved bits in StartAddress are set, then ASSERT(). If StartAddress > 0x0FFFFFFF, then ASSERT().
If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, 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 Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write. @param Buffer Pointer to a buffer containing the data to write.