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

Function headers in .h and .c files synchronized with spec 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6770 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2008-11-28 02:18:02 +00:00
parent 48a59ce09a
commit d5979dc030
2 changed files with 317 additions and 304 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

430
MdePkg/Include/Library/PciSegmentLib.h
View File

@ -117,7 +117,7 @@ PciSegmentRead8 (
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
@param Value The value to write. @param Value The value to write.
@return The parameter of Value. @return The value written to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -205,22 +205,22 @@ PciSegmentAndThenOr8 (
/** /**
Reads a bit field of a PCI configuration register. Reads a bit field of a PCI configuration register.
Reads the bit field in an 8-bit PCI configuration register. Reads the bit field in an 8-bit PCI configuration register. The bit field is
The bit field is specified by the StartBit and the EndBit. specified by the StartBit and the EndBit. The value of the bit field is
The value of the bit field is returned. returned.
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 7, then ASSERT(). If StartBit is greater than 7, then ASSERT().
If EndBit 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Address PCI configuration register to read.
@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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..7.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..7.
@return The value of the bit field. @return The value of the bit field read from the PCI configuration register.
**/ **/
UINT8 UINT8
@ -234,23 +234,24 @@ PciSegmentBitFieldRead8 (
/** /**
Writes a bit field to a PCI configuration register. Writes a bit field to a PCI configuration register.
Writes Value to the bit field of the PCI configuration register. Writes Value to the bit field of the PCI configuration register. The bit
The bit field is specified by the StartBit and the EndBit. field is specified by the StartBit and the EndBit. All other bits in the
All other bits in the destination PCI configuration register are preserved. destination PCI configuration register are preserved. The new value of the
The new value of the 8-bit register is returned. 8-bit register is returned.
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 7, then ASSERT(). If StartBit is greater than 7, then ASSERT().
If EndBit 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..7.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..7.
@param Value New value of the bit field. @param Value New value of the bit field.
@return The new value of the 8-bit register. @return The value written back to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -263,23 +264,29 @@ PciSegmentBitFieldWrite8 (
); );
/** /**
Reads the 8-bit PCI configuration register specified by Address, Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR, and
performs a bitwise inclusive OR between the read result and the value specified by OrData, writes the result back to the bit field in the 8-bit port.
and writes the result to the 8-bit PCI configuration register specified by Address.
Reads the 8-bit PCI configuration register specified by Address, performs a
bitwise inclusive OR between the read result and the value specified by
OrData, and writes the result to the 8-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 any reserved bits in Address are set, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 7, then ASSERT().
If EndBit 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..7.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..7.
@param OrData The value to OR with the read value from the PCI configuration register. @param OrData The value to OR with the PCI configuration register.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -292,29 +299,29 @@ PciSegmentBitFieldOr8 (
); );
/** /**
Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR, Reads a bit field in an 8-bit PCI configuration register, performs a bitwise
and writes the result back to the bit field in the 8-bit port. AND, and writes the result back to the bit field in the 8-bit register.
Reads the 8-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 8-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 8-bit PCI configuration register specified by Address,
performs a bitwise inclusive OR between the read result and the value specified by OrData,
and writes the result to the 8-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 any reserved bits in Address are set, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 7, then ASSERT().
If EndBit 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..7.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..7.
@param AndData The value to AND with the read value from the PCI configuration register. @param AndData The value to AND with the PCI configuration register.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -327,30 +334,32 @@ PciSegmentBitFieldAnd8 (
); );
/** /**
Reads a bit field in an 8-bit PCI configuration register, performs a bitwise AND, Reads a bit field in an 8-bit port, performs a bitwise AND followed by a
and writes the result back to the bit field in the 8-bit register. bitwise inclusive OR, and writes the result back to the bit field in the
8-bit port.
Reads the 8-bit PCI configuration register specified by Address,
performs a bitwise AND between the read result and the value specified by AndData, Reads the 8-bit PCI configuration register specified by Address, performs a
and writes the result to the 8-bit PCI configuration register specified by Address. bitwise AND followed by a bitwise inclusive OR between the read result and
The value written to the PCI configuration register is returned. the value specified by AndData, and writes the result to the 8-bit PCI
This function must guarantee that all PCI read and write operations are serialized. configuration register specified by Address. The value written to the PCI
Extra left bits in AndData are stripped. configuration register is returned. This function must guarantee that all PCI
read and write operations are serialized. Extra left bits in both AndData and
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 7, then ASSERT(). If StartBit is greater than 7, then ASSERT().
If EndBit 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..7.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..7.
@param AndData The value to AND with the read value from the PCI configuration register. @param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the read value from the PCI configuration register. @param OrData The value to OR with the result of the AND operation.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -406,21 +415,24 @@ PciSegmentWrite16 (
); );
/** /**
Performs a bitwise inclusive OR of a 16-bit PCI configuration register with a 16-bit value. Performs a bitwise inclusive OR of a 16-bit PCI configuration register with
a 16-bit value.
Reads the 16-bit PCI configuration register specified by Address, performs a
bitwise inclusive 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.
Reads the 16-bit PCI configuration register specified by Address,
performs a bitwise inclusive 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.
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 16-bit boundary, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Address Address that encodes the PCI Segment, Bus, Device, Function and
@param OrData The value to OR with the PCI configuration register. Register.
@param OrData The value to OR with the PCI configuration register.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT16 UINT16
@ -487,23 +499,23 @@ PciSegmentAndThenOr16 (
/** /**
Reads a bit field of a PCI configuration register. Reads a bit field of a PCI configuration register.
Reads the bit field in a 16-bit PCI configuration register. Reads the bit field in a 16-bit PCI configuration register. The bit field is
The bit field is specified by the StartBit and the EndBit. specified by the StartBit and the EndBit. The value of the bit field is
The value of the bit field is returned. returned.
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 16-bit boundary, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 7, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Address PCI configuration register to read.
@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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..15.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..15.
@return The value of the bit field. @return The value of the bit field read from the PCI configuration register.
**/ **/
UINT16 UINT16
@ -517,25 +529,25 @@ PciSegmentBitFieldRead16 (
/** /**
Writes a bit field to a PCI configuration register. Writes a bit field to a PCI configuration register.
Writes Value to the bit field of the PCI configuration register. Writes Value to the bit field of the PCI configuration register. The bit
The bit field is specified by the StartBit and the EndBit. field is specified by the StartBit and the EndBit. All other bits in the
All other bits in the destination PCI configuration register are preserved. destination PCI configuration register are preserved. The new value of the
The new value of the 16-bit register is returned. 16-bit register is returned.
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 16-bit boundary, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 7, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..15.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..15.
@param Value New value of the bit field. @param Value New value of the bit field.
@return The new value of the 16-bit register. @return The value written back to the PCI configuration register.
**/ **/
UINT16 UINT16
@ -558,14 +570,14 @@ PciSegmentBitFieldWrite16 (
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..15.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..15.
@param OrData The value to OR with the read value from the PCI configuration register. @param OrData The value to OR with the PCI configuration register.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT16 UINT16
@ -614,31 +626,32 @@ PciSegmentBitFieldAnd16 (
); );
/** /**
Reads a bit field in a 16-bit PCI configuration register, performs a bitwise AND, Reads a bit field in a 16-bit port, performs a bitwise AND followed by a
and writes the result back to the bit field in the 16-bit register. bitwise inclusive 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 AND between the read result and the value specified by AndData, Reads the 16-bit PCI configuration register specified by Address, performs a
and writes the result to the 16-bit PCI configuration register specified by Address. bitwise AND followed by a bitwise inclusive OR between the read result and
The value written to the PCI configuration register is returned. the value specified by AndData, and writes the result to the 16-bit PCI
This function must guarantee that all PCI read and write operations are serialized. configuration register specified by Address. The value written to the PCI
Extra left bits in AndData are stripped. configuration register is returned. This function must guarantee that all PCI
read and write operations are serialized. Extra left bits in both AndData and
OrData 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 16-bit boundary, then ASSERT().. If StartBit is greater than 15, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 15, 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..15.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..15.
@param AndData The value to AND with the read value from the PCI configuration register. @param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the read value from the PCI configuration register. @param OrData The value to OR with the result of the AND operation.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT16 UINT16
@ -775,23 +788,23 @@ PciSegmentAndThenOr32 (
/** /**
Reads a bit field of a PCI configuration register. Reads a bit field of a PCI configuration register.
Reads the bit field in a 32-bit PCI configuration register. Reads the bit field in a 32-bit PCI configuration register. The bit field is
The bit field is specified by the StartBit and the EndBit. specified by the StartBit and the EndBit. The value of the bit field is
The value of the bit field is returned. returned.
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 Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 7, 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Address PCI configuration register to read.
@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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..31.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..31.
@return The value of the bit field. @return The value of the bit field read from the PCI configuration register.
**/ **/
UINT32 UINT32
@ -805,25 +818,25 @@ PciSegmentBitFieldRead32 (
/** /**
Writes a bit field to a PCI configuration register. Writes a bit field to a PCI configuration register.
Writes Value to the bit field of the PCI configuration register. Writes Value to the bit field of the PCI configuration register. The bit
The bit field is specified by the StartBit and the EndBit. field is specified by the StartBit and the EndBit. All other bits in the
All other bits in the destination PCI configuration register are preserved. destination PCI configuration register are preserved. The new value of the
The new value of the 32-bit register is returned. 32-bit register is returned.
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 Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 7, 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..31.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..31.
@param Value New value of the bit field. @param Value New value of the bit field.
@return The new value of the 32-bit register. @return The value written back to the PCI configuration register.
**/ **/
UINT32 UINT32
@ -836,24 +849,29 @@ PciSegmentBitFieldWrite32 (
); );
/** /**
Reads the 32-bit PCI configuration register specified by Address, Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR, and
performs a bitwise inclusive OR between the read result and the value specified by OrData, writes the result back to the bit field in the 32-bit port.
and writes the result to the 32-bit PCI configuration register specified by Address.
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 7, then ASSERT().
If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@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.
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.
The ordinal of the most significant bit in a byte is bit 7.
@param OrData The value to OR with the read value from the PCI configuration register.
@return The value written to the PCI configuration register. Reads the 32-bit PCI configuration register specified by Address, performs a
bitwise inclusive OR between the read result and the value specified by
OrData, 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 OrData are stripped.
If any reserved bits in Address are set, 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.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@param OrData The value to OR with the PCI configuration register.
@return The value written back to the PCI configuration register.
**/ **/
UINT32 UINT32
@ -866,30 +884,30 @@ PciSegmentBitFieldOr32 (
); );
/** /**
Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR, Reads a bit field in a 32-bit PCI configuration register, performs a bitwise
and writes the result back to the bit field in the 32-bit port. 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 inclusive OR between the read result and the value specified by OrData,
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 OrData 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 Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 7, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 7, 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..31.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..31.
@param AndData The value to AND with the read value from the PCI configuration register. @param AndData The value to AND with the PCI configuration register.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT32 UINT32
@ -902,31 +920,32 @@ PciSegmentBitFieldAnd32 (
); );
/** /**
Reads a bit field in a 32-bit PCI configuration register, performs a bitwise AND, Reads a bit field in a 32-bit port, performs a bitwise AND followed by a
and writes the result back to the bit field in the 32-bit register. bitwise inclusive OR, and writes the result back to the bit field in the
32-bit port.
Reads the 32-bit PCI configuration register specified by Address,
performs a bitwise AND between the read result and the value specified by AndData, Reads the 32-bit PCI configuration register specified by Address, performs a
and writes the result to the 32-bit PCI configuration register specified by Address. bitwise AND followed by a bitwise inclusive OR between the read result and
The value written to the PCI configuration register is returned. the value specified by AndData, and writes the result to the 32-bit PCI
This function must guarantee that all PCI read and write operations are serialized. configuration register specified by Address. The value written to the PCI
Extra left bits in AndData are stripped. configuration register is returned. This function must guarantee that all PCI
read and write operations are serialized. Extra left bits in both AndData and
OrData 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 7, then ASSERT(). If EndBit is greater than 31, 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 Address that encodes the PCI Segment, Bus, Device, Function, and Register. @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.
The ordinal of the least significant bit in a byte is bit 0. Range 0..31.
@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.
The ordinal of the most significant bit in a byte is bit 7. Range 0..31.
@param AndData The value to AND with the read value from the PCI configuration register. @param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the read value from the PCI configuration register. @param OrData The value to OR with the result of the AND operation.
@return The value written to the PCI configuration register. @return The value written back to the PCI configuration register.
**/ **/
UINT32 UINT32
@ -942,21 +961,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
If any reserved bits in StartAddress are set, then ASSERT(). 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 ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If (StartAddress + Size - 1) > 0x0FFFFFFF, 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
@ -968,19 +990,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,
If any reserved bits in StartAddress are set, then ASSERT(). 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 ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If (StartAddress + Size - 1) > 0x0FFFFFFF, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().
If 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.

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

@ -192,15 +192,13 @@ PciSegmentRegisterForRuntimeAccess (
Reads an 8-bit PCI configuration register. Reads an 8-bit PCI configuration register.
Reads and returns the 8-bit PCI configuration register specified by Address. Reads and returns the 8-bit PCI configuration register specified by Address.
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.
If any reserved bits in Address are set, then ASSERT(). If any reserved bits in Address are set, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @return The 8-bit PCI configuration register specified by Address.
Register.
@return The value read from the PCI configuration register.
**/ **/
UINT8 UINT8
@ -217,15 +215,13 @@ PciSegmentRead8 (
/** /**
Writes an 8-bit PCI configuration register. Writes an 8-bit PCI configuration register.
Writes the 8-bit PCI configuration register specified by Address with the Writes the 8-bit PCI configuration register specified by Address with the value specified by Value.
value specified by Value. Value is returned. This function must guarantee Value is returned. This function must guarantee that all PCI read and write operations are serialized.
that all PCI read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT().
If any reserved bits in Address are set, then ASSERT(). @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
@param Value The value to write.
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
Register.
@param Data The value to write.
@return The value written to the PCI configuration register. @return The value written to the PCI configuration register.
@ -234,32 +230,29 @@ UINT8
EFIAPI EFIAPI
PciSegmentWrite8 ( PciSegmentWrite8 (
IN UINT64 Address, IN UINT64 Address,
IN UINT8 Data IN UINT8 Value
) )
{ {
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 0); ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 0);
return (UINT8) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Data); return (UINT8) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Value);
} }
/** /**
Performs a bitwise inclusive OR of an 8-bit PCI configuration register with Performs a bitwise inclusive OR of an 8-bit PCI configuration register with an 8-bit value.
an 8-bit value.
Reads the 8-bit PCI configuration register specified by Address, performs a
bitwise inclusive OR between the read result and the value specified by
OrData, and writes the result to the 8-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.
Reads the 8-bit PCI configuration register specified by Address,
performs a bitwise inclusive OR between the read result and the value specified by OrData,
and writes the result to the 8-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.
If any reserved bits in Address are set, then ASSERT(). If any reserved bits in Address are set, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register. @param OrData The value to OR with the PCI configuration register.
@param OrData The value to OR with the PCI configuration register.
@return The value written back to the PCI configuration register. @return The value written to the PCI configuration register.
**/ **/
UINT8 UINT8
@ -530,15 +523,14 @@ PciSegmentBitFieldAndThenOr8 (
Reads a 16-bit PCI configuration register. Reads a 16-bit PCI configuration register.
Reads and returns the 16-bit PCI configuration register specified by Address. Reads and returns the 16-bit PCI configuration register specified by Address.
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.
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 16-bit boundary, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @return The 16-bit PCI configuration register specified by Address.
Register.
@return The value read from the PCI configuration register.
**/ **/
UINT16 UINT16
@ -555,29 +547,28 @@ PciSegmentRead16 (
/** /**
Writes a 16-bit PCI configuration register. Writes a 16-bit PCI configuration register.
Writes the 16-bit PCI configuration register specified by Address with the Writes the 16-bit PCI configuration register specified by Address with the value specified by Value.
value specified by Value. Value is returned. This function must guarantee Value is returned. This function must guarantee that all PCI read and write operations are serialized.
that all PCI read and write operations are serialized.
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 16-bit boundary, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register. @param Value The value to write.
@param Data The value to write.
@return The value written to the PCI configuration register. @return The parameter of Value.
**/ **/
UINT16 UINT16
EFIAPI EFIAPI
PciSegmentWrite16 ( PciSegmentWrite16 (
IN UINT64 Address, IN UINT64 Address,
IN UINT16 Data IN UINT16 Value
) )
{ {
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 1); ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 1);
return (UINT16) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Data); return (UINT16) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Value);
} }
/** /**
@ -592,6 +583,7 @@ PciSegmentWrite16 (
are serialized. are serialized.
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 16-bit boundary, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function and
Register. Register.
@ -639,25 +631,24 @@ PciSegmentAnd16 (
} }
/** /**
Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value,
value, followed a bitwise inclusive OR with another 16-bit value. followed a bitwise inclusive OR with another 16-bit value.
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, performs a bitwise AND between the read result and the value specified by AndData,
performs a bitwise inclusive OR between the result of the AND operation and performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,
the value specified by OrData, and writes the result to the 16-bit PCI and writes the result to the 16-bit PCI configuration register specified by Address.
configuration register specified by Address. The value written to the PCI The value written to the PCI configuration register is returned.
configuration register is returned. This function must guarantee that all PCI This function must guarantee that all PCI read and write operations are serialized.
read and write operations are serialized.
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 16-bit boundary, then ASSERT().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register. @param AndData The value to AND with the PCI configuration register.
@param AndData The value to AND with the PCI configuration register. @param OrData The value to OR with the PCI configuration register.
@param OrData The value to OR with the result of the AND operation.
@return The value written back to the PCI configuration register. @return The value written to the PCI configuration register.
**/ **/
UINT16 UINT16
@ -679,6 +670,7 @@ PciSegmentAndThenOr16 (
returned. returned.
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 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -712,6 +704,7 @@ PciSegmentBitFieldRead16 (
16-bit register is returned. 16-bit register is returned.
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 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -742,17 +735,12 @@ PciSegmentBitFieldWrite16 (
} }
/** /**
Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR, and Reads the 16-bit PCI configuration register specified by Address,
writes the result back to the bit field in the 16-bit port. performs a bitwise inclusive 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.
Reads the 16-bit PCI configuration register specified by Address, performs a
bitwise inclusive 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 any reserved bits in Address are set, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -872,15 +860,14 @@ PciSegmentBitFieldAndThenOr16 (
Reads a 32-bit PCI configuration register. Reads a 32-bit PCI configuration register.
Reads and returns the 32-bit PCI configuration register specified by Address. Reads and returns the 32-bit PCI configuration register specified by Address.
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.
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().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register.
@return The value read from the PCI configuration register. @return The 32-bit PCI configuration register specified by Address.
**/ **/
UINT32 UINT32
@ -897,49 +884,46 @@ PciSegmentRead32 (
/** /**
Writes a 32-bit PCI configuration register. Writes a 32-bit PCI configuration register.
Writes the 32-bit PCI configuration register specified by Address with the Writes the 32-bit PCI configuration register specified by Address with the value specified by Value.
value specified by Value. Value is returned. This function must guarantee Value is returned. This function must guarantee that all PCI read and write operations are serialized.
that all PCI read and write operations are serialized.
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().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register. @param Value The value to write.
@param Data The value to write.
@return The value written to the PCI configuration register. @return The parameter of Value.
**/ **/
UINT32 UINT32
EFIAPI EFIAPI
PciSegmentWrite32 ( PciSegmentWrite32 (
IN UINT64 Address, IN UINT64 Address,
IN UINT32 Data IN UINT32 Value
) )
{ {
ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 3); ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 3);
return PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Data); return PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Value);
} }
/** /**
Performs a bitwise inclusive OR of a 32-bit PCI configuration register with Performs a bitwise inclusive OR of a 32-bit PCI configuration register with a 32-bit value.
a 32-bit value.
Reads the 32-bit PCI configuration register specified by Address, performs a
bitwise inclusive OR between the read result and the value specified by
OrData, 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.
Reads the 32-bit PCI configuration register specified by Address,
performs a bitwise inclusive OR between the read result and the value specified by OrData,
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.
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().
@param Address Address that encodes the PCI Segment, Bus, Device, Function and @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register.
Register. @param OrData The value to OR with the PCI configuration register.
@param OrData The value to OR with the PCI configuration register.
@return The value written back to the PCI configuration register. @return The value written to the PCI configuration register.
**/ **/
UINT32 UINT32
@ -1020,6 +1004,7 @@ PciSegmentAndThenOr32 (
returned. returned.
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().
@ -1053,6 +1038,7 @@ PciSegmentBitFieldRead32 (
32-bit register is returned. 32-bit register is returned.
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().
@ -1306,6 +1292,7 @@ PciSegmentReadBuffer (
return ReturnValue; return ReturnValue;
} }
/** /**
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.
@ -1327,7 +1314,7 @@ PciSegmentReadBuffer (
@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