| /** @file |
| Provides services to access PCI Configuration Space. |
| |
| These functions perform PCI configuration cycles using the default PCI configuration |
| access method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, |
| or it may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some |
| alternate access method. Modules will typically use the PCI Library for its PCI configuration |
| accesses. However, if a module requires a mix of PCI access methods, the PCI CF8 Library or |
| PCI Express Library may be used in conjunction with the PCI Library. The functionality of |
| these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use |
| explicit access methods. |
| |
| Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> |
| SPDX-License-Identifier: BSD-2-Clause-Patent |
| |
| **/ |
| |
| #ifndef __PCI_LIB_H__ |
| #define __PCI_LIB_H__ |
| |
| /** |
| Macro that converts PCI Bus, PCI Device, PCI Function and PCI Register to an |
| address that can be passed to the PCI Library functions. |
| |
| @param Bus PCI Bus number. Range 0..255. |
| @param Device PCI Device number. Range 0..31. |
| @param Function PCI Function number. Range 0..7. |
| @param Register PCI Register number. Range 0..255 for PCI. Range 0..4095 |
| for PCI Express. |
| |
| @return The encoded PCI address. |
| |
| **/ |
| #define PCI_LIB_ADDRESS(Bus,Device,Function,Register) \ |
| (((Register) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20)) |
| |
| /** |
| Registers a PCI device so PCI configuration registers may be accessed after |
| SetVirtualAddressMap(). |
| |
| Registers the PCI device specified by Address so all the PCI configuration registers |
| associated with that PCI device may be accessed after SetVirtualAddressMap() is called. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| |
| @retval RETURN_SUCCESS The PCI device was registered for runtime access. |
| @retval RETURN_UNSUPPORTED An attempt was made to call this function |
| after ExitBootServices(). |
| @retval RETURN_UNSUPPORTED The resources required to access the PCI device |
| at runtime could not be mapped. |
| @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to |
| complete the registration. |
| |
| **/ |
| RETURN_STATUS |
| EFIAPI |
| PciRegisterForRuntimeAccess ( |
| IN UINTN Address |
| ); |
| |
| /** |
| Reads an 8-bit PCI configuration register. |
| |
| Reads and returns the 8-bit PCI configuration register specified by Address. |
| This function must guarantee that all PCI read and write operations are |
| serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| |
| @return The read value from the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciRead8 ( |
| IN UINTN Address |
| ); |
| |
| /** |
| Writes an 8-bit PCI configuration register. |
| |
| Writes the 8-bit PCI configuration register specified by Address with the |
| value specified by Value. Value is returned. This function must guarantee |
| that all PCI read and write operations are serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param Value The value to write. |
| |
| @return The value written to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciWrite8 ( |
| IN UINTN Address, |
| IN UINT8 Value |
| ); |
| |
| /** |
| Performs a bitwise OR of an 8-bit PCI configuration register with |
| an 8-bit value. |
| |
| Reads the 8-bit PCI configuration register specified by Address, performs a |
| bitwise OR between the read result and the value specified by |
| OrData, and writes the result to the 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 Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param OrData The value to OR with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciOr8 ( |
| IN UINTN Address, |
| IN UINT8 OrData |
| ); |
| |
| /** |
| Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit |
| value. |
| |
| 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. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciAnd8 ( |
| IN UINTN Address, |
| IN UINT8 AndData |
| ); |
| |
| /** |
| Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit |
| value, followed by a bitwise OR with another 8-bit value. |
| |
| Reads the 8-bit PCI configuration register specified by Address, performs a |
| bitwise AND between the read result and the value specified by AndData, |
| performs a bitwise OR between the result of the AND operation 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 Address > 0x0FFFFFFF, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND 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. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciAndThenOr8 ( |
| IN UINTN Address, |
| IN UINT8 AndData, |
| IN UINT8 OrData |
| ); |
| |
| /** |
| Reads a bit field of a PCI configuration register. |
| |
| Reads the bit field in an 8-bit PCI configuration register. The bit field is |
| specified by the StartBit and the EndBit. The value of the bit field is |
| returned. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If StartBit is greater than 7, then ASSERT(). |
| If EndBit is greater than 7, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| |
| @param Address PCI configuration register to read. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..7. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..7. |
| |
| @return The value of the bit field read from the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciBitFieldRead8 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit |
| ); |
| |
| /** |
| Writes a bit field to a PCI configuration register. |
| |
| Writes Value to the bit field of the PCI configuration register. The bit |
| field is specified by the StartBit and the EndBit. All other bits in the |
| destination PCI configuration register are preserved. The new value of the |
| 8-bit register is returned. |
| |
| If Address > 0x0FFFFFFF, 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 Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..7. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..7. |
| @param Value New value of the bit field. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciBitFieldWrite8 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT8 Value |
| ); |
| |
| /** |
| Reads a bit field in an 8-bit PCI configuration, performs a bitwise 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 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 Address > 0x0FFFFFFF, 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 OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..7. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..7. |
| @param OrData The value to OR with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciBitFieldOr8 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT8 OrData |
| ); |
| |
| /** |
| Reads a bit field in an 8-bit PCI configuration register, performs a bitwise |
| 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. |
| |
| If Address > 0x0FFFFFFF, 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 AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..7. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..7. |
| @param AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciBitFieldAnd8 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT8 AndData |
| ); |
| |
| /** |
| Reads a bit field in an 8-bit port, performs a bitwise AND followed by a |
| bitwise 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 followed by a bitwise OR 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 both AndData and |
| OrData are stripped. |
| |
| If Address > 0x0FFFFFFF, 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 AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..7. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..7. |
| @param AndData The value to AND 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. |
| |
| **/ |
| UINT8 |
| EFIAPI |
| PciBitFieldAndThenOr8 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT8 AndData, |
| IN UINT8 OrData |
| ); |
| |
| /** |
| Reads a 16-bit PCI configuration register. |
| |
| Reads and returns the 16-bit PCI configuration register specified by Address. |
| This function must guarantee that all PCI read and write operations are |
| serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| |
| @return The read value from the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciRead16 ( |
| IN UINTN Address |
| ); |
| |
| /** |
| Writes a 16-bit PCI configuration register. |
| |
| Writes the 16-bit PCI configuration register specified by Address with the |
| value specified by Value. Value is returned. This function must guarantee |
| that all PCI read and write operations are serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param Value The value to write. |
| |
| @return The value written to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciWrite16 ( |
| IN UINTN Address, |
| IN UINT16 Value |
| ); |
| |
| /** |
| Performs a bitwise 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 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 Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param OrData The value to OR with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciOr16 ( |
| IN UINTN Address, |
| IN UINT16 OrData |
| ); |
| |
| /** |
| Performs a bitwise AND 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 AND between the read result and the value specified by AndData, and |
| writes the result to the 16-bit PCI configuration register specified by |
| Address. The value written to the PCI configuration register is returned. |
| This function must guarantee that all PCI read and write operations are |
| serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciAnd16 ( |
| IN UINTN Address, |
| IN UINT16 AndData |
| ); |
| |
| /** |
| Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit |
| value, followed a bitwise OR with another 16-bit value. |
| |
| Reads the 16-bit PCI configuration register specified by Address, performs a |
| bitwise AND between the read result and the value specified by AndData, |
| performs a bitwise OR between the result of the AND operation 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 Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND 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. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciAndThenOr16 ( |
| IN UINTN Address, |
| IN UINT16 AndData, |
| IN UINT16 OrData |
| ); |
| |
| /** |
| Reads a bit field of a PCI configuration register. |
| |
| Reads the bit field in a 16-bit PCI configuration register. The bit field is |
| specified by the StartBit and the EndBit. The value of the bit field is |
| returned. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| If StartBit is greater than 15, then ASSERT(). |
| If EndBit is greater than 15, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| |
| @param Address PCI configuration register to read. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..15. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..15. |
| |
| @return The value of the bit field read from the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciBitFieldRead16 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit |
| ); |
| |
| /** |
| Writes a bit field to a PCI configuration register. |
| |
| Writes Value to the bit field of the PCI configuration register. The bit |
| field is specified by the StartBit and the EndBit. All other bits in the |
| destination PCI configuration register are preserved. The new value of the |
| 16-bit register is returned. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| If StartBit is greater than 15, then ASSERT(). |
| If EndBit is greater than 15, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..15. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..15. |
| @param Value New value of the bit field. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciBitFieldWrite16 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT16 Value |
| ); |
| |
| /** |
| Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR, and |
| writes the result back to the bit field in the 16-bit port. |
| |
| Reads the 16-bit PCI configuration register specified by Address, performs a |
| bitwise OR between the read result and the value specified by |
| OrData, and writes the result to the 16-bit PCI configuration register |
| specified by Address. The value written to the PCI configuration register is |
| returned. This function must guarantee that all PCI read and write operations |
| are serialized. Extra left bits in OrData are stripped. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| If StartBit is greater than 15, then ASSERT(). |
| If EndBit is greater than 15, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..15. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..15. |
| @param OrData The value to OR with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciBitFieldOr16 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT16 OrData |
| ); |
| |
| /** |
| Reads a bit field in a 16-bit PCI configuration register, performs a bitwise |
| AND, and writes the result back to the bit field in the 16-bit register. |
| |
| Reads the 16-bit PCI configuration register specified by Address, performs a |
| bitwise AND between the read result and the value specified by AndData, and |
| writes the result to the 16-bit PCI configuration register specified by |
| Address. The value written to the PCI configuration register is returned. |
| This function must guarantee that all PCI read and write operations are |
| serialized. Extra left bits in AndData are stripped. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| If StartBit is greater than 15, then ASSERT(). |
| If EndBit is greater than 15, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..15. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..15. |
| @param AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciBitFieldAnd16 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT16 AndData |
| ); |
| |
| /** |
| Reads a bit field in a 16-bit port, performs a bitwise AND followed by a |
| bitwise OR, and writes the result back to the bit field in the |
| 16-bit port. |
| |
| Reads the 16-bit PCI configuration register specified by Address, performs a |
| bitwise AND followed by a bitwise OR between the read result and |
| the value specified by AndData, and writes the result to the 16-bit PCI |
| configuration register specified by Address. The value written to the PCI |
| configuration register is returned. This function must guarantee that all PCI |
| read and write operations are serialized. Extra left bits in both AndData and |
| OrData are stripped. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 16-bit boundary, then ASSERT(). |
| If StartBit is greater than 15, then ASSERT(). |
| If EndBit is greater than 15, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| |
| @param Address PCI configuration register to write. |
| @param StartBit The ordinal of the least significant bit in the bit field. |
| Range 0..15. |
| @param EndBit The ordinal of the most significant bit in the bit field. |
| Range 0..15. |
| @param AndData The value to AND with the PCI configuration register. |
| @param OrData The value to OR with the result of the AND operation. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT16 |
| EFIAPI |
| PciBitFieldAndThenOr16 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT16 AndData, |
| IN UINT16 OrData |
| ); |
| |
| /** |
| Reads a 32-bit PCI configuration register. |
| |
| Reads and returns the 32-bit PCI configuration register specified by Address. |
| This function must guarantee that all PCI read and write operations are |
| serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| |
| @return The read value from the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciRead32 ( |
| IN UINTN Address |
| ); |
| |
| /** |
| Writes a 32-bit PCI configuration register. |
| |
| Writes the 32-bit PCI configuration register specified by Address with the |
| value specified by Value. Value is returned. This function must guarantee |
| that all PCI read and write operations are serialized. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param Value The value to write. |
| |
| @return The value written to the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciWrite32 ( |
| IN UINTN Address, |
| IN UINT32 Value |
| ); |
| |
| /** |
| Performs a bitwise OR of a 32-bit PCI configuration register with |
| a 32-bit value. |
| |
| Reads the 32-bit PCI configuration register specified by Address, performs a |
| bitwise OR between the read result and the value specified by |
| OrData, and writes the result to the 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 Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param OrData The value to OR with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciOr32 ( |
| IN UINTN Address, |
| IN UINT32 OrData |
| ); |
| |
| /** |
| Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit |
| value. |
| |
| 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. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciAnd32 ( |
| IN UINTN Address, |
| IN UINT32 AndData |
| ); |
| |
| /** |
| Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit |
| value, followed a bitwise OR with another 32-bit value. |
| |
| Reads the 32-bit PCI configuration register specified by Address, performs a |
| bitwise AND between the read result and the value specified by AndData, |
| performs a bitwise OR between the result of the AND operation 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 Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| |
| @param Address Address that encodes the PCI Bus, Device, Function and |
| Register. |
| @param AndData The value to AND 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. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciAndThenOr32 ( |
| IN UINTN Address, |
| IN UINT32 AndData, |
| IN UINT32 OrData |
| ); |
| |
| /** |
| Reads a bit field of a PCI configuration register. |
| |
| Reads the bit field in a 32-bit PCI configuration register. The bit field is |
| specified by the StartBit and the EndBit. The value of the bit field is |
| returned. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| If StartBit is greater than 31, then ASSERT(). |
| If EndBit is greater than 31, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| |
| @param Address PCI configuration register to read. |
| @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. |
| |
| @return The value of the bit field read from the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciBitFieldRead32 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit |
| ); |
| |
| /** |
| Writes a bit field to a PCI configuration register. |
| |
| Writes Value to the bit field of the PCI configuration register. The bit |
| field is specified by the StartBit and the EndBit. All other bits in the |
| destination PCI configuration register are preserved. The new value of the |
| 32-bit register is returned. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| If StartBit is greater than 31, then ASSERT(). |
| If EndBit is greater than 31, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If Value is larger than the bitmask value range specified by StartBit and EndBit, 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 Value New value of the bit field. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciBitFieldWrite32 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT32 Value |
| ); |
| |
| /** |
| Reads a bit field in a 32-bit PCI configuration, performs a bitwise 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 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 Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| If StartBit is greater than 31, then ASSERT(). |
| If EndBit is greater than 31, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If OrData is larger than the bitmask value range specified by StartBit and EndBit, 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 |
| EFIAPI |
| PciBitFieldOr32 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT32 OrData |
| ); |
| |
| /** |
| Reads a bit field in a 32-bit PCI configuration register, performs a bitwise |
| AND, and writes the result back to the bit field in the 32-bit register. |
| |
| Reads the 32-bit PCI configuration register specified by Address, performs a |
| bitwise AND between the read result and the value specified by AndData, and |
| writes the result to the 32-bit PCI configuration register specified by |
| Address. The value written to the PCI configuration register is returned. |
| This function must guarantee that all PCI read and write operations are |
| serialized. Extra left bits in AndData are stripped. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| If StartBit is greater than 31, then ASSERT(). |
| If EndBit is greater than 31, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If AndData is larger than the bitmask value range specified by StartBit and EndBit, 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 AndData The value to AND with the PCI configuration register. |
| |
| @return The value written back to the PCI configuration register. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciBitFieldAnd32 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT32 AndData |
| ); |
| |
| /** |
| Reads a bit field in a 32-bit port, performs a bitwise AND followed by a |
| bitwise 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 followed by a bitwise OR 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 both AndData and |
| OrData are stripped. |
| |
| If Address > 0x0FFFFFFF, then ASSERT(). |
| If Address is not aligned on a 32-bit boundary, then ASSERT(). |
| If StartBit is greater than 31, then ASSERT(). |
| If EndBit is greater than 31, then ASSERT(). |
| If EndBit is less than StartBit, then ASSERT(). |
| If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). |
| If OrData is larger than the bitmask value range specified by StartBit and EndBit, 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 AndData The value to AND 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. |
| |
| **/ |
| UINT32 |
| EFIAPI |
| PciBitFieldAndThenOr32 ( |
| IN UINTN Address, |
| IN UINTN StartBit, |
| IN UINTN EndBit, |
| IN UINT32 AndData, |
| IN UINT32 OrData |
| ); |
| |
| /** |
| Reads a range of PCI configuration registers into a caller supplied buffer. |
| |
| Reads the range of PCI configuration registers specified by StartAddress and |
| Size into the buffer specified by Buffer. This function only allows the PCI |
| configuration registers from a single PCI function to be read. Size is |
| returned. When possible 32-bit PCI configuration read cycles are used to read |
| from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit |
| and 16-bit PCI configuration read cycles may be used at the beginning and the |
| end of the range. |
| |
| If StartAddress > 0x0FFFFFFF, then ASSERT(). |
| If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). |
| If Size > 0 and Buffer is NULL, then ASSERT(). |
| |
| @param StartAddress Starting address that encodes the PCI Bus, Device, |
| Function and Register. |
| @param Size Size in bytes of the transfer. |
| @param Buffer Pointer to a buffer receiving the data read. |
| |
| @return Size |
| |
| **/ |
| UINTN |
| EFIAPI |
| PciReadBuffer ( |
| IN UINTN StartAddress, |
| IN UINTN Size, |
| OUT VOID *Buffer |
| ); |
| |
| /** |
| Copies the data in a caller supplied buffer to a specified range of PCI |
| configuration space. |
| |
| Writes the range of PCI configuration registers specified by StartAddress and |
| Size from the buffer specified by Buffer. This function only allows the PCI |
| configuration registers from a single PCI function to be written. Size is |
| returned. When possible 32-bit PCI configuration write cycles are used to |
| write from StartAddress to StartAddress + Size. Due to alignment restrictions, |
| 8-bit and 16-bit PCI configuration write cycles may be used at the beginning |
| and the end of the range. |
| |
| If StartAddress > 0x0FFFFFFF, then ASSERT(). |
| If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). |
| If Size > 0 and Buffer is NULL, then ASSERT(). |
| |
| @param StartAddress Starting address that encodes the PCI Bus, Device, |
| Function and Register. |
| @param Size Size in bytes of the transfer. |
| @param Buffer Pointer to a buffer containing the data to write. |
| |
| @return Size written to StartAddress. |
| |
| **/ |
| UINTN |
| EFIAPI |
| PciWriteBuffer ( |
| IN UINTN StartAddress, |
| IN UINTN Size, |
| IN VOID *Buffer |
| ); |
| |
| #endif |