EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Enumerations | Variables

MdePkg/Include/Protocol/PciIo.h File Reference

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

Defines

#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)

Typedefs

typedef struct _EFI_PCI_IO_PROTOCOL EFI_PCI_IO_PROTOCOL
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)
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)
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)
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)
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)
typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_UNMAP )(IN EFI_PCI_IO_PROTOCOL *This, IN VOID *Mapping)
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)
typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_FREE_BUFFER )(IN EFI_PCI_IO_PROTOCOL *This, IN UINTN Pages, IN VOID *HostAddress)
typedef EFI_STATUS(EFIAPI * EFI_PCI_IO_PROTOCOL_FLUSH )(IN EFI_PCI_IO_PROTOCOL *This)
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)
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)
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)
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)

Enumerations

enum  EFI_PCI_IO_PROTOCOL_WIDTH {
  EfiPciIoWidthUint8 = 0, EfiPciIoWidthUint16, EfiPciIoWidthUint32, EfiPciIoWidthUint64,
  EfiPciIoWidthFifoUint8, EfiPciIoWidthFifoUint16, EfiPciIoWidthFifoUint32, EfiPciIoWidthFifoUint64,
  EfiPciIoWidthFillUint8, EfiPciIoWidthFillUint16, EfiPciIoWidthFillUint32, EfiPciIoWidthFillUint64,
  EfiPciIoWidthMaximum, EfiPciIoWidthUint8 = 0, EfiPciIoWidthUint16, EfiPciIoWidthUint32,
  EfiPciIoWidthUint64, EfiPciIoWidthFifoUint8, EfiPciIoWidthFifoUint16, EfiPciIoWidthFifoUint32,
  EfiPciIoWidthFifoUint64, EfiPciIoWidthFillUint8, EfiPciIoWidthFillUint16, EfiPciIoWidthFillUint32,
  EfiPciIoWidthFillUint64, EfiPciIoWidthMaximum
}
enum  EFI_PCI_IO_PROTOCOL_OPERATION {
  EfiPciIoOperationBusMasterRead, EfiPciIoOperationBusMasterWrite, EfiPciIoOperationBusMasterCommonBuffer, EfiPciIoOperationMaximum,
  EfiPciIoOperationBusMasterRead, EfiPciIoOperationBusMasterWrite, EfiPciIoOperationBusMasterCommonBuffer, EfiPciIoOperationMaximum
}
enum  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION {
  EfiPciIoAttributeOperationGet, EfiPciIoAttributeOperationSet, EfiPciIoAttributeOperationEnable, EfiPciIoAttributeOperationDisable,
  EfiPciIoAttributeOperationSupported, EfiPciIoAttributeOperationMaximum, EfiPciIoAttributeOperationGet, EfiPciIoAttributeOperationSet,
  EfiPciIoAttributeOperationEnable, EfiPciIoAttributeOperationDisable, EfiPciIoAttributeOperationSupported, EfiPciIoAttributeOperationMaximum
}

Variables

EFI_GUID gEfiPciIoProtocolGuid

Detailed Description

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 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file PciIo.h.


Define Documentation

#define EFI_PCI_DEVICE_ENABLE   (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER)

Definition at line 75 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER   0x0400

Enable the DMA bit in the PCI Config Header.

Definition at line 65 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000

Clear for PCI controllers that can not genrate a DAC.

Definition at line 70 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE   0x2000

Clear for an add-in PCI Device.

Definition at line 68 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM   0x4000

Clear for a physical PCI Option ROM accessed through ROM BAR.

Definition at line 69 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO   0x0020

I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)

Definition at line 60 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO   0x0040

I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)

Definition at line 61 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_IO   0x0100

Enable the I/O decode bit in the PCI Config Header.

Definition at line 63 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_ISA_IO   0x0002

I/O cycles 0x0100-0x03FF or greater (10 bit decode)

Definition at line 56 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16   0x10000

I/O cycles 0x0100-0x03FF or greater (16 bit decode)

Definition at line 71 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO   0x0001

I/O cycles 0x0000-0x00FF (10 bit decode)

Definition at line 55 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_MASK   0x077f

All the following I/O and Memory cycles.

Definition at line 54 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_MEMORY   0x0200

Enable the Memory decode bit in the PCI Config Header.

Definition at line 64 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED   0x0800

Map a memory range so all r/w accesses are cached.

Definition at line 66 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE   0x1000

Disable a memory range.

Definition at line 67 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE   0x0080

Map a memory range so writes are combined.

Definition at line 62 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_VGA_IO   0x0010

I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)

Definition at line 59 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16   0x40000

I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode)

Definition at line 73 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY   0x0008

MEM cycles 0xA0000-0xBFFFF (24 bit decode)

Definition at line 58 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO   0x0004

I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode)

Definition at line 57 of file PciIo.h.

#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16   0x20000

I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode)

Definition at line 72 of file PciIo.h.

#define EFI_PCI_IO_PASS_THROUGH_BAR   0xff

Special BAR that passes a memory or I/O cycle through unchanged.

Definition at line 53 of file PciIo.h.

#define EFI_PCI_IO_PROTOCOL_GUID
Value:
{ \
    0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a } \
  }

Global ID for the PCI I/O Protocol

Definition at line 22 of file PciIo.h.

#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)

Definition at line 76 of file PciIo.h.


Typedef Documentation

Definition at line 27 of file PciIo.h.

Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer mapping.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
TypeThis parameter is not used and must be ignored.
MemoryTypeThe type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
PagesThe number of pages to allocate.
HostAddressA pointer to store the base system memory address of the allocated range.
AttributesThe requested bit mask of attributes for the allocated range.
Return values:
EFI_SUCCESSThe requested memory pages were allocated.
EFI_UNSUPPORTEDAttributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE and MEMORY_CACHED.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe memory pages could not be allocated.

Definition at line 354 of file PciIo.h.

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.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
OperationThe operation to perform on the attributes for this PCI controller.
AttributesThe mask of attributes that are used for Set, Enable, and Disable operations.
ResultA pointer to the result mask of attributes that are returned for the Get and Supported operations.
Return values:
EFI_SUCCESSThe operation on the PCI controller's attributes was completed.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_UNSUPPORTEDone 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.

Definition at line 444 of file PciIo.h.

Enable a PCI driver to access PCI controller registers in PCI configuration space.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
WidthSignifies the width of the memory operations.
OffsetThe offset within the PCI configuration space for the PCI controller.
CountThe number of PCI configuration operations to perform.
BufferFor read operations, the destination buffer to store the results. For write operations, the source buffer to write data from.
Return values:
EFI_SUCCESSThe data was read from or written to the PCI controller.
EFI_UNSUPPORTEDThe address range specified by Offset, Width, and Count is not valid for the PCI configuration header of the PCI controller.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETERBuffer is NULL or Width is invalid.

Definition at line 226 of file PciIo.h.

Enables a PCI driver to copy one region of PCI memory space to another region of PCI memory space.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
WidthSignifies the width of the memory operations.
DestBarIndexThe BAR index in the standard PCI Configuration header to use as the base address for the memory operation to perform.
DestOffsetThe destination offset within the BAR specified by DestBarIndex to start the memory writes for the copy operation.
SrcBarIndexThe BAR index in the standard PCI Configuration header to use as the base address for the memory operation to perform.
SrcOffsetThe source offset within the BAR specified by SrcBarIndex to start the memory reads for the copy operation.
CountThe number of memory operations to perform. Bytes moved is Width size * Count, starting at DestOffset and SrcOffset.
Return values:
EFI_SUCCESSThe data was copied from one memory region to another memory region.
EFI_UNSUPPORTEDDestBarIndex not valid for this PCI controller.
EFI_UNSUPPORTEDSrcBarIndex not valid for this PCI controller.
EFI_UNSUPPORTEDThe address range specified by DestOffset, Width, and Count is not valid for the PCI BAR specified by DestBarIndex.
EFI_UNSUPPORTEDThe address range specified by SrcOffset, Width, and Count is not valid for the PCI BAR specified by SrcBarIndex.
EFI_INVALID_PARAMETERWidth is invalid.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 275 of file PciIo.h.

Flushes all PCI posted write transactions from a PCI host bridge to system memory.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
Return values:
EFI_SUCCESSThe PCI posted write transactions were flushed from the PCI host bridge to system memory.
EFI_DEVICE_ERRORThe PCI posted write transactions were not flushed from the PCI host bridge due to a hardware error.

Definition at line 396 of file PciIo.h.

Frees memory that was allocated with AllocateBuffer().

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
PagesThe number of pages to free.
HostAddressThe base system memory address of the allocated range.
Return values:
EFI_SUCCESSThe requested memory pages were freed.
EFI_INVALID_PARAMETERThe memory range specified by HostAddress and Pages was not allocated with AllocateBuffer().

Definition at line 377 of file PciIo.h.

Gets the attributes that this PCI controller supports setting on a BAR using SetBarAttributes(), and retrieves the list of resource descriptors for a BAR.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
BarIndexThe 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.
SupportsA pointer to the mask of attributes that this PCI controller supports setting for this BAR with SetBarAttributes().
ResourcesA pointer to the ACPI 2.0 resource descriptors that describe the current configuration of this BAR of the PCI controller.
Return values:
EFI_SUCCESSIf Supports is not NULL, then the attributes that the PCI controller supports are returned in Supports. If Resources is not NULL, then the ACPI 2.0 resource descriptors that the PCI controller is currently using are returned in Resources.
EFI_INVALID_PARAMETERBoth Supports and Attributes are NULL.
EFI_UNSUPPORTEDBarIndex not valid for this PCI controller.
EFI_OUT_OF_RESOURCESThere are not enough resources available to allocate Resources.

Definition at line 475 of file PciIo.h.

Retrieves this PCI controller's current PCI bus number, device number, and function number.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
SegmentNumberThe PCI controller's current PCI segment number.
BusNumberThe PCI controller's current PCI bus number.
DeviceNumberThe PCI controller's current PCI device number.
FunctionNumberThe PCI controller's current PCI function number.
Return values:
EFI_SUCCESSThe PCI controller location was returned.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 415 of file PciIo.h.

Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
WidthSignifies the width of the memory or I/O operations.
BarIndexThe BAR index of the standard PCI Configuration header to use as the base address for the memory or I/O operation to perform.
OffsetThe offset within the selected BAR to start the memory or I/O operation.
CountThe number of memory or I/O operations to perform.
BufferFor read operations, the destination buffer to store the results. For write operations, the source buffer to write data from.
Return values:
EFI_SUCCESSThe data was read from or written to the PCI controller.
EFI_UNSUPPORTEDBarIndex not valid for this PCI controller.
EFI_UNSUPPORTEDThe address range specified by Offset, Width, and Count is not valid for the PCI BAR specified by BarIndex.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 186 of file PciIo.h.

Provides the PCI controller-specific addresses needed to access system memory.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
OperationIndicates if the bus master is going to read or write to system memory.
HostAddressThe system memory address to map to the PCI controller.
NumberOfBytesOn input the number of bytes to map. On output the number of bytes that were mapped.
DeviceAddressThe resulting map address for the bus master PCI controller to use to access the hosts HostAddress.
MappingA resulting value to pass to Unmap().
Return values:
EFI_SUCCESSThe range was mapped for the returned NumberOfBytes.
EFI_UNSUPPORTEDThe HostAddress cannot be mapped as a common buffer.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_DEVICE_ERRORThe system hardware could not map the requested address.

Definition at line 306 of file PciIo.h.

Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is satisfied or after a defined duration.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
WidthSignifies the width of the memory or I/O operations.
BarIndexThe BAR index of the standard PCI Configuration header to use as the base address for the memory operation to perform.
OffsetThe offset within the selected BAR to start the memory operation.
MaskMask used for the polling criteria.
ValueThe comparison value used for the polling exit criteria.
DelayThe number of 100 ns units to poll.
ResultPointer to the last value read from the memory location.
Return values:
EFI_SUCCESSThe last data returned from the access matched the poll exit criteria.
EFI_UNSUPPORTEDBarIndex not valid for this PCI controller.
EFI_UNSUPPORTEDOffset is not valid for the BarIndex of this PCI controller.
EFI_TIMEOUTDelay expired before a match occurred.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 153 of file PciIo.h.

Sets the attributes for a range of a BAR on a PCI controller.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
AttributesThe mask of attributes to set for the resource range specified by BarIndex, Offset, and Length.
BarIndexThe 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.
OffsetA pointer to the BAR relative base address of the resource range to be modified by the attributes specified by Attributes.
LengthA pointer to the length of the resource range to be modified by the attributes specified by Attributes.
Return values:
EFI_SUCCESSThe 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_PARAMETEROffset or Length is NULL.
EFI_UNSUPPORTEDBarIndex not valid for this PCI controller.
EFI_OUT_OF_RESOURCESThere are not enough resources to set the attributes on the resource range specified by BarIndex, Offset, and Length.

Definition at line 508 of file PciIo.h.

Completes the Map() operation and releases any corresponding resources.

Parameters:
ThisA pointer to the EFI_PCI_IO_PROTOCOL instance.
MappingThe mapping value returned from Map().
Return values:
EFI_SUCCESSThe range was unmapped.
EFI_DEVICE_ERRORThe data was not committed to the target system memory.

Definition at line 327 of file PciIo.h.


Enumeration Type Documentation

EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION

Enumerator:
EfiPciIoAttributeOperationGet 
EfiPciIoAttributeOperationSet 
EfiPciIoAttributeOperationEnable 
EfiPciIoAttributeOperationDisable 
EfiPciIoAttributeOperationSupported 
EfiPciIoAttributeOperationMaximum 
EfiPciIoAttributeOperationGet 

Retrieve the PCI controller's current attributes, and return them in Result.

EfiPciIoAttributeOperationSet 

Set the PCI controller's current attributes to Attributes.

EfiPciIoAttributeOperationEnable 

Enable the attributes specified by the bits that are set in Attributes for this PCI controller.

EfiPciIoAttributeOperationDisable 

Disable the attributes specified by the bits that are set in Attributes for this PCI controller.

EfiPciIoAttributeOperationSupported 

Retrieve the PCI controller's supported attributes, and return them in Result.

EfiPciIoAttributeOperationMaximum 

Definition at line 105 of file PciIo.h.

EFI_PCI_IO_PROTOCOL_OPERATION

Enumerator:
EfiPciIoOperationBusMasterRead 
EfiPciIoOperationBusMasterWrite 
EfiPciIoOperationBusMasterCommonBuffer 
EfiPciIoOperationMaximum 
EfiPciIoOperationBusMasterRead 

A read operation from system memory by a bus master.

EfiPciIoOperationBusMasterWrite 

A write operation from system memory by a bus master.

EfiPciIoOperationBusMasterCommonBuffer 

Provides both read and write access to system memory by both the processor and a bus master. The buffer is coherent from both the processor's and the bus master's point of view.

EfiPciIoOperationMaximum 

Definition at line 83 of file PciIo.h.

EFI_PCI_IO_PROTOCOL_WIDTH

Enumerator:
EfiPciIoWidthUint8 
EfiPciIoWidthUint16 
EfiPciIoWidthUint32 
EfiPciIoWidthUint64 
EfiPciIoWidthFifoUint8 
EfiPciIoWidthFifoUint16 
EfiPciIoWidthFifoUint32 
EfiPciIoWidthFifoUint64 
EfiPciIoWidthFillUint8 
EfiPciIoWidthFillUint16 
EfiPciIoWidthFillUint32 
EfiPciIoWidthFillUint64 
EfiPciIoWidthMaximum 
EfiPciIoWidthUint8 
EfiPciIoWidthUint16 
EfiPciIoWidthUint32 
EfiPciIoWidthUint64 
EfiPciIoWidthFifoUint8 
EfiPciIoWidthFifoUint16 
EfiPciIoWidthFifoUint32 
EfiPciIoWidthFifoUint64 
EfiPciIoWidthFillUint8 
EfiPciIoWidthFillUint16 
EfiPciIoWidthFillUint32 
EfiPciIoWidthFillUint64 
EfiPciIoWidthMaximum 

Definition at line 34 of file PciIo.h.


Variable Documentation

Definition at line 44 of file AutoGen.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines