- Generated on Fri Nov 15 2024 18:01:36 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
Go to the source code of this file.
Data Structures | |
| struct | EFI_PCI_IO_PROTOCOL_ACCESS |
| struct | EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS |
| struct | _EFI_PCI_IO_PROTOCOL |
Macros | |
| #define | EFI_PCI_IO_PROTOCOL_GUID |
| #define | EFI_PCI_IO_PASS_THROUGH_BAR 0xff |
| Special BAR that passes a memory or I/O cycle through unchanged. | |
| #define | EFI_PCI_IO_ATTRIBUTE_MASK 0x077f |
| All the following I/O and Memory cycles. | |
| #define | EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 |
| I/O cycles 0x0000-0x00FF (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 |
| I/O cycles 0x0100-0x03FF or greater (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 |
| I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 |
| MEM cycles 0xA0000-0xBFFFF (24 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 |
| I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 |
| I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 |
| I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 |
| Map a memory range so writes are combined. | |
| #define | EFI_PCI_IO_ATTRIBUTE_IO 0x0100 |
| Enable the I/O decode bit in the PCI Config Header. | |
| #define | EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 |
| Enable the Memory decode bit in the PCI Config Header. | |
| #define | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 |
| Enable the DMA bit in the PCI Config Header. | |
| #define | EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 |
| Map a memory range so all r/w accesses are cached. | |
| #define | EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 |
| Disable a memory range. | |
| #define | EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 |
| Clear for an add-in PCI Device. | |
| #define | EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 |
| Clear for a physical PCI Option ROM accessed through ROM BAR. | |
| #define | EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 |
| Clear for PCI controllers that can not genrate a DAC. | |
| #define | EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 |
| I/O cycles 0x0100-0x03FF or greater (16 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 |
| I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode) | |
| #define | EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000 |
| I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode) | |
| #define | EFI_PCI_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER) |
| #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) |
Enumerations | |
| enum | EFI_PCI_IO_PROTOCOL_WIDTH { EfiPciIoWidthUint8 = 0 , EfiPciIoWidthUint16 , EfiPciIoWidthUint32 , EfiPciIoWidthUint64 , EfiPciIoWidthFifoUint8 , EfiPciIoWidthFifoUint16 , EfiPciIoWidthFifoUint32 , EfiPciIoWidthFifoUint64 , EfiPciIoWidthFillUint8 , EfiPciIoWidthFillUint16 , EfiPciIoWidthFillUint32 , EfiPciIoWidthFillUint64 , EfiPciIoWidthMaximum } |
| enum | EFI_PCI_IO_PROTOCOL_OPERATION { EfiPciIoOperationBusMasterRead , EfiPciIoOperationBusMasterWrite , EfiPciIoOperationBusMasterCommonBuffer , EfiPciIoOperationMaximum } |
| enum | EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION { EfiPciIoAttributeOperationGet , EfiPciIoAttributeOperationSet , EfiPciIoAttributeOperationEnable , EfiPciIoAttributeOperationDisable , EfiPciIoAttributeOperationSupported , EfiPciIoAttributeOperationMaximum } |
Variables | |
| EFI_GUID | gEfiPciIoProtocolGuid |
EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration, and DMA interfaces that a driver uses to access its PCI controller.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file PciIo.h.
| #define EFI_PCI_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER) |
| #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 |
| #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 |
| #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 |
| #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 |
| #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 |
| #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 |
| #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 |
| #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 |
| #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 |
| #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 |
| #define EFI_PCI_IO_ATTRIBUTE_MASK 0x077f |
| #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 |
| #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 |
| #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 |
| #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 |
| #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 |
| #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000 |
| #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 |
| #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 |
| #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 |
| #define EFI_PCI_IO_PASS_THROUGH_BAR 0xff |
| #define EFI_PCI_IO_PROTOCOL_GUID |
| #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) |
| typedef struct _EFI_PCI_IO_PROTOCOL EFI_PCI_IO_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_ALLOCATE_TYPE Type, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, OUT VOID **HostAddress, IN UINT64 Attributes) |
Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer or EfiPciOperationBusMasterCommonBuffer64 mapping.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Type | This parameter is not used and must be ignored. |
| MemoryType | The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData. |
| Pages | The number of pages to allocate. |
| HostAddress | A pointer to store the base system memory address of the allocated range. |
| Attributes | The requested bit mask of attributes for the allocated range. |
| EFI_SUCCESS | The requested memory pages were allocated. |
| EFI_UNSUPPORTED | Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_OUT_OF_RESOURCES | The memory pages could not be allocated. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_ATTRIBUTES) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation, IN UINT64 Attributes, OUT UINT64 *Result OPTIONAL) |
Performs an operation on the attributes that this PCI controller supports. The operations include getting the set of supported attributes, retrieving the current attributes, setting the current attributes, enabling attributes, and disabling attributes.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Operation | The operation to perform on the attributes for this PCI controller. |
| Attributes | The mask of attributes that are used for Set, Enable, and Disable operations. |
| Result | A pointer to the result mask of attributes that are returned for the Get and Supported operations. |
| EFI_SUCCESS | The operation on the PCI controller's attributes was completed. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_UNSUPPORTED | one or more of the bits set in Attributes are not supported by this PCI controller or one of its parent bridges when Operation is Set, Enable or Disable. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_CONFIG) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_WIDTH Width, IN UINT32 Offset, IN UINTN Count, IN OUT VOID *Buffer) |
Enable a PCI driver to access PCI controller registers in PCI configuration space.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Width | Signifies the width of the memory operations. |
| Offset | The offset within the PCI configuration space for the PCI controller. |
| Count | The number of PCI configuration operations to perform. |
| Buffer | For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. |
| EFI_SUCCESS | The data was read from or written to the PCI controller. |
| EFI_UNSUPPORTED | The address range specified by Offset, Width, and Count is not valid for the PCI configuration header of the PCI controller. |
| EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
| EFI_INVALID_PARAMETER | Buffer is NULL or Width is invalid. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_COPY_MEM) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_WIDTH Width, IN UINT8 DestBarIndex, IN UINT64 DestOffset, IN UINT8 SrcBarIndex, IN UINT64 SrcOffset, IN UINTN Count) |
Enables a PCI driver to copy one region of PCI memory space to another region of PCI memory space.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Width | Signifies the width of the memory operations. |
| DestBarIndex | The BAR index in the standard PCI Configuration header to use as the base address for the memory operation to perform. |
| DestOffset | The destination offset within the BAR specified by DestBarIndex to start the memory writes for the copy operation. |
| SrcBarIndex | The BAR index in the standard PCI Configuration header to use as the base address for the memory operation to perform. |
| SrcOffset | The source offset within the BAR specified by SrcBarIndex to start the memory reads for the copy operation. |
| Count | The number of memory operations to perform. Bytes moved is Width size * Count, starting at DestOffset and SrcOffset. |
| EFI_SUCCESS | The data was copied from one memory region to another memory region. |
| EFI_UNSUPPORTED | DestBarIndex not valid for this PCI controller. |
| EFI_UNSUPPORTED | SrcBarIndex not valid for this PCI controller. |
| EFI_UNSUPPORTED | The address range specified by DestOffset, Width, and Count is not valid for the PCI BAR specified by DestBarIndex. |
| EFI_UNSUPPORTED | The address range specified by SrcOffset, Width, and Count is not valid for the PCI BAR specified by SrcBarIndex. |
| EFI_INVALID_PARAMETER | Width is invalid. |
| EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_FLUSH) (IN EFI_PCI_IO_PROTOCOL *This) |
Flushes all PCI posted write transactions from a PCI host bridge to system memory.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| EFI_SUCCESS | The PCI posted write transactions were flushed from the PCI host bridge to system memory. |
| EFI_DEVICE_ERROR | The PCI posted write transactions were not flushed from the PCI host bridge due to a hardware error. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_FREE_BUFFER) (IN EFI_PCI_IO_PROTOCOL *This, IN UINTN Pages, IN VOID *HostAddress) |
Frees memory that was allocated with AllocateBuffer().
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Pages | The number of pages to free. |
| HostAddress | The base system memory address of the allocated range. |
| EFI_SUCCESS | The requested memory pages were freed. |
| EFI_INVALID_PARAMETER | The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer(). |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES) (IN EFI_PCI_IO_PROTOCOL *This, IN UINT8 BarIndex, OUT UINT64 *Supports OPTIONAL, OUT VOID **Resources OPTIONAL) |
Gets the attributes that this PCI controller supports setting on a BAR using SetBarAttributes(), and retrieves the list of resource descriptors for a BAR.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| BarIndex | The BAR index of the standard PCI Configuration header to use as the base address for resource range. The legal range for this field is 0..5. |
| Supports | A pointer to the mask of attributes that this PCI controller supports setting for this BAR with SetBarAttributes(). |
| Resources | A pointer to the resource descriptors that describe the current configuration of this BAR of the PCI controller. |
| EFI_SUCCESS | If Supports is not NULL, then the attributes that the PCI controller supports are returned in Supports. If Resources is not NULL, then the resource descriptors that the PCI controller is currently using are returned in Resources. |
| EFI_INVALID_PARAMETER | Both Supports and Attributes are NULL. |
| EFI_UNSUPPORTED | BarIndex not valid for this PCI controller. |
| EFI_OUT_OF_RESOURCES | There are not enough resources available to allocate Resources. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_GET_LOCATION) (IN EFI_PCI_IO_PROTOCOL *This, OUT UINTN *SegmentNumber, OUT UINTN *BusNumber, OUT UINTN *DeviceNumber, OUT UINTN *FunctionNumber) |
Retrieves this PCI controller's current PCI bus number, device number, and function number.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| SegmentNumber | The PCI controller's current PCI segment number. |
| BusNumber | The PCI controller's current PCI bus number. |
| DeviceNumber | The PCI controller's current PCI device number. |
| FunctionNumber | The PCI controller's current PCI function number. |
| EFI_SUCCESS | The PCI controller location was returned. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_IO_MEM) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_WIDTH Width, IN UINT8 BarIndex, IN UINT64 Offset, IN UINTN Count, IN OUT VOID *Buffer) |
Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Width | Signifies the width of the memory or I/O operations. |
| BarIndex | The BAR index of the standard PCI Configuration header to use as the base address for the memory or I/O operation to perform. |
| Offset | The offset within the selected BAR to start the memory or I/O operation. |
| Count | The number of memory or I/O operations to perform. |
| Buffer | For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. |
| EFI_SUCCESS | The data was read from or written to the PCI controller. |
| EFI_UNSUPPORTED | BarIndex not valid for this PCI controller. |
| EFI_UNSUPPORTED | The address range specified by Offset, Width, and Count is not valid for the PCI BAR specified by BarIndex. |
| EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_MAP) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_OPERATION Operation, IN VOID *HostAddress, IN OUT UINTN *NumberOfBytes, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, OUT VOID **Mapping) |
Provides the PCI controller-specific addresses needed to access system memory.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Operation | Indicates if the bus master is going to read or write to system memory. |
| HostAddress | The system memory address to map to the PCI controller. |
| NumberOfBytes | On input the number of bytes to map. On output the number of bytes that were mapped. |
| DeviceAddress | The resulting map address for the bus master PCI controller to use to access the hosts HostAddress. |
| Mapping | A resulting value to pass to Unmap(). |
| EFI_SUCCESS | The range was mapped for the returned NumberOfBytes. |
| EFI_UNSUPPORTED | The HostAddress cannot be mapped as a common buffer. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
| EFI_DEVICE_ERROR | The system hardware could not map the requested address. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_POLL_IO_MEM) (IN EFI_PCI_IO_PROTOCOL *This, IN EFI_PCI_IO_PROTOCOL_WIDTH Width, IN UINT8 BarIndex, IN UINT64 Offset, IN UINT64 Mask, IN UINT64 Value, IN UINT64 Delay, OUT UINT64 *Result) |
Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is satisfied or after a defined duration.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Width | Signifies the width of the memory or I/O operations. |
| BarIndex | The BAR index of the standard PCI Configuration header to use as the base address for the memory operation to perform. |
| Offset | The offset within the selected BAR to start the memory operation. |
| Mask | Mask used for the polling criteria. |
| Value | The comparison value used for the polling exit criteria. |
| Delay | The number of 100 ns units to poll. |
| Result | Pointer to the last value read from the memory location. |
| EFI_SUCCESS | The last data returned from the access matched the poll exit criteria. |
| EFI_UNSUPPORTED | BarIndex not valid for this PCI controller. |
| EFI_UNSUPPORTED | Offset is not valid for the BarIndex of this PCI controller. |
| EFI_TIMEOUT | Delay expired before a match occurred. |
| EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES) (IN EFI_PCI_IO_PROTOCOL *This, IN UINT64 Attributes, IN UINT8 BarIndex, IN OUT UINT64 *Offset, IN OUT UINT64 *Length) |
Sets the attributes for a range of a BAR on a PCI controller.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Attributes | The mask of attributes to set for the resource range specified by BarIndex, Offset, and Length. |
| BarIndex | The BAR index of the standard PCI Configuration header to use as the base address for resource range. The legal range for this field is 0..5. |
| Offset | A pointer to the BAR relative base address of the resource range to be modified by the attributes specified by Attributes. |
| Length | A pointer to the length of the resource range to be modified by the attributes specified by Attributes. |
| EFI_SUCCESS | The set of attributes specified by Attributes for the resource range specified by BarIndex, Offset, and Length were set on the PCI controller, and the actual resource range is returned in Offset and Length. |
| EFI_INVALID_PARAMETER | Offset or Length is NULL. |
| EFI_UNSUPPORTED | BarIndex not valid for this PCI controller. |
| EFI_OUT_OF_RESOURCES | There are not enough resources to set the attributes on the resource range specified by BarIndex, Offset, and Length. |
| typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_UNMAP) (IN EFI_PCI_IO_PROTOCOL *This, IN VOID *Mapping) |
Completes the Map() operation and releases any corresponding resources.
| This | A pointer to the EFI_PCI_IO_PROTOCOL instance. |
| Mapping | The mapping value returned from Map(). |
| EFI_SUCCESS | The range was unmapped. |
| EFI_DEVICE_ERROR | The data was not committed to the target system memory. |
EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION
EFI_PCI_IO_PROTOCOL_OPERATION
1.9.6