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

Refine the comments in PciSegmentLib

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6773 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2008-11-28 06:14:55 +00:00
parent 1a974389fd
commit 34ffd1bbb5
2 changed files with 33 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1198,24 +1198,20 @@ 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 and Reads the range of PCI configuration registers specified by StartAddress
Size into the buffer specified by Buffer. This function only allows the PCI and Size into the buffer specified by Buffer.
configuration registers from a single PCI function to be read. Size is This function only allows the PCI configuration registers from a single PCI function to be read.
returned. When possible 32-bit PCI configuration read cycles are used to read Size is returned.
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 If any reserved bits in StartAddress are set, then ASSERT().
end of the range.
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, @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
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 Size @return The parameter of Size.
**/ **/
UINTN UINTN
@ -1294,23 +1290,18 @@ PciSegmentReadBuffer (
/** /**
Copies the data in a caller supplied buffer to a specified range of PCI Copies the data in a caller supplied buffer to a specified range of PCI configuration space.
configuration space.
Writes the range of PCI configuration registers specified by StartAddress and Writes the range of PCI configuration registers specified by StartAddress
Size from the buffer specified by Buffer. This function only allows the PCI and Size from the buffer specified by Buffer.
configuration registers from a single PCI function to be written. Size is This function only allows the PCI configuration registers from a single PCI function to be written.
returned. When possible 32-bit PCI configuration write cycles are used to Size is returned.
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 If any reserved bits in StartAddress are set, then ASSERT().
and the end of the range.
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, @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
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.

43
MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.c
View File

@ -1302,24 +1302,20 @@ 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 and Reads the range of PCI configuration registers specified by StartAddress
Size into the buffer specified by Buffer. This function only allows the PCI and Size into the buffer specified by Buffer.
configuration registers from a single PCI function to be read. Size is This function only allows the PCI configuration registers from a single PCI function to be read.
returned. When possible 32-bit PCI configuration read cycles are used to read Size is returned.
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 If any reserved bits in StartAddress are set, then ASSERT().
end of the range.
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, @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
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 Size @return The parameter of Size.
**/ **/
UINTN UINTN
@ -1397,27 +1393,22 @@ PciSegmentReadBuffer (
} }
/** /**
Copies the data in a caller supplied buffer to a specified range of PCI Copies the data in a caller supplied buffer to a specified range of PCI configuration space.
configuration space.
Writes the range of PCI configuration registers specified by StartAddress and Writes the range of PCI configuration registers specified by StartAddress
Size from the buffer specified by Buffer. This function only allows the PCI and Size from the buffer specified by Buffer.
configuration registers from a single PCI function to be written. Size is This function only allows the PCI configuration registers from a single PCI function to be written.
returned. When possible 32-bit PCI configuration write cycles are used to Size is returned.
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 If any reserved bits in StartAddress are set, then ASSERT().
and the end of the range.
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, @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.
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.
@return Size @return The parameter of Size.
**/ **/
UINTN UINTN