4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and DMA interfaces that a driver uses to access its PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global ID for the PCI I/O Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_PCI_IO_PROTOCOL EFI_PCI_IO_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_PCI_IO_PROTOCOL_WIDTH
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Complete PCI address generater
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_PASS_THROUGH_BAR 0xff ///< Special BAR that passes a memory or I/O cycle through unchanged
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_MASK 0x077f ///< All the following I/O and Memory cycles
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 ///< I/O cycles 0x0000-0x00FF (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 ///< I/O cycles 0x0100-0x03FF or greater (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 ///< I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 ///< MEM cycles 0xA0000-0xBFFFF (24 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 ///< I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 ///< I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 ///< I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 ///< Map a memory range so writes are combined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 ///< Enable the I/O decode bit in the PCI Config Header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 ///< Enable the Memory decode bit in the PCI Config Header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 ///< Enable the DMA bit in the PCI Config Header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 ///< Map a memory range so all r/w accesses are cached
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 ///< Disable a memory range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 ///< Clear for an add-in PCI Device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 ///< Clear for a physical PCI Option ROM accessed through ROM BAR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 ///< Clear for PCI controllers that can not genrate a DAC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 ///< I/O cycles 0x0100-0x03FF or greater (16 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 ///< I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000 ///< I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_PCI_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_VGA_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY | EFI_PCI_IO_ATTRIBUTE_VGA_IO | EFI_PCI_IO_ATTRIBUTE_IO)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_PCI_IO_PROTOCOL_OPERATION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A read operation from system memory by a bus master.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A write operation from system memory by a bus master.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Provides both read and write access to system memory by both the processor and a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// bus master. The buffer is coherent from both the processor's and the bus master's point of view.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// *******************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Retrieve the PCI controller's current attributes, and return them in Result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set the PCI controller's current attributes to Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Enable the attributes specified by the bits that are set in Attributes for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Disable the attributes specified by the bits that are set in Attributes for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Retrieve the PCI controller's supported attributes, and return them in Result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync satisfied or after a defined duration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width Signifies the width of the memory or I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BarIndex The BAR index of the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for the memory operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset The offset within the selected BAR to start the memory operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Mask Mask used for the polling criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The comparison value used for the polling exit criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Delay The number of 100 ns units to poll.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Result Pointer to the last value read from the memory location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Offset is not valid for the BarIndex of this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT Delay expired before a match occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width Signifies the width of the memory or I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BarIndex The BAR index of the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for the memory or I/O operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset The offset within the selected BAR to start the memory or I/O operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of memory or I/O operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer For read operations, the destination buffer to store the results. For write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operations, the source buffer to write data from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was read from or written to the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync valid for the PCI BAR specified by BarIndex.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Read PCI controller registers in the PCI memory or I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Write PCI controller registers in the PCI memory or I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enable a PCI driver to access PCI controller registers in PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width Signifies the width of the memory operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset The offset within the PCI configuration space for the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of PCI configuration operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer For read operations, the destination buffer to store the results. For write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operations, the source buffer to write data from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was read from or written to the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync valid for the PCI configuration header of the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Read PCI controller registers in PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Write PCI controller registers in PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enables a PCI driver to copy one region of PCI memory space to another region of PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync memory space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width Signifies the width of the memory operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestBarIndex The BAR index in the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for the memory operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestOffset The destination offset within the BAR specified by DestBarIndex to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync start the memory writes for the copy operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcBarIndex The BAR index in the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for the memory operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcOffset The source offset within the BAR specified by SrcBarIndex to start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory reads for the copy operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of memory operations to perform. Bytes moved is Width
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size * Count, starting at DestOffset and SrcOffset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was copied from one memory region to another memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED DestBarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED SrcBarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The address range specified by DestOffset, Width, and Count
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not valid for the PCI BAR specified by DestBarIndex.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The address range specified by SrcOffset, Width, and Count is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not valid for the PCI BAR specified by SrcBarIndex.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Width is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the PCI controller-specific addresses needed to access system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Operation Indicates if the bus master is going to read or write to system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HostAddress The system memory address to map to the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfBytes On input the number of bytes to map. On output the number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that were mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddress The resulting map address for the bus master PCI controller to use to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync access the hosts HostAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Mapping A resulting value to pass to Unmap().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Completes the Map() operation and releases any corresponding resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Mapping The mapping value returned from Map().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The range was unmapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type This parameter is not used and must be ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryType The type of memory to allocate, EfiBootServicesData or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiRuntimeServicesData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages The number of pages to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HostAddress A pointer to store the base system memory address of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The requested bit mask of attributes for the allocated range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested memory pages were allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MEMORY_WRITE_COMBINE and MEMORY_CACHED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees memory that was allocated with AllocateBuffer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages The number of pages to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HostAddress The base system memory address of the allocated range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested memory pages were freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was not allocated with AllocateBuffer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Flushes all PCI posted write transactions from a PCI host bridge to system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bridge to system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync host bridge due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves this PCI controller's current PCI bus number, device number, and function number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SegmentNumber The PCI controller's current PCI segment number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BusNumber The PCI controller's current PCI bus number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceNumber The PCI controller's current PCI device number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FunctionNumber The PCI controller's current PCI function number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCI controller location was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Performs an operation on the attributes that this PCI controller supports. The operations include
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync getting the set of supported attributes, retrieving the current attributes, setting the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes, enabling attributes, and disabling attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Operation The operation to perform on the attributes for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The mask of attributes that are used for Set, Enable, and Disable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Result A pointer to the result mask of attributes that are returned for the Get
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Supported operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation on the PCI controller's attributes was completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED one or more of the bits set in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attributes are not supported by this PCI controller or one of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync its parent bridges when Operation is Set, Enable or Disable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the attributes that this PCI controller supports setting on a BAR using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SetBarAttributes(), and retrieves the list of resource descriptors for a BAR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BarIndex The BAR index of the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for resource range. The legal range for this field is 0..5.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Supports A pointer to the mask of attributes that this PCI controller supports
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync setting for this BAR with SetBarAttributes().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Resources A pointer to the ACPI 2.0 resource descriptors that describe the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration of this BAR of the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller supports are returned in Supports. If Resources
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not NULL, then the ACPI 2.0 resource descriptors that the PCI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller is currently using are returned in Resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the attributes for a range of a BAR on a PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The mask of attributes to set for the resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BarIndex, Offset, and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BarIndex The BAR index of the standard PCI Configuration header to use as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync base address for resource range. The legal range for this field is 0..5.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset A pointer to the BAR relative base address of the resource range to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync modified by the attributes specified by Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length A pointer to the length of the resource range to be modified by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes specified by Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range specified by BarIndex, Offset, and Length were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set on the PCI controller, and the actual resource range is returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Offset and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Offset or Length is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BarIndex, Offset, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and DMA interfaces used to abstract accesses to PCI controllers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A device driver that wishes to manage a PCI controller in a system will have to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER AllocateBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES GetBarAttributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES SetBarAttributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the ROM image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// for allocating memory for the ROM image, and copying the contents of the ROM to memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The contents of this buffer are either from the PCI option ROM that can be accessed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// through the ROM BAR of the PCI controller, or it is from a platform-specific location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Attributes() function can be used to determine from which of these two sources
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the RomImage buffer was initialized.