iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
PciRootBridgeIo.h File Reference

PCI Root Bridge I/O protocol as defined in the UEFI 2.0 specification. More...

#include <ipxe/efi/Library/BaseLib.h>

Go to the source code of this file.

Data Structures

struct  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
struct  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS
struct  _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
 Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. More...

Defines

#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID
#define EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO   0x0001
#define EFI_PCI_ATTRIBUTE_ISA_IO   0x0002
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO   0x0004
#define EFI_PCI_ATTRIBUTE_VGA_MEMORY   0x0008
#define EFI_PCI_ATTRIBUTE_VGA_IO   0x0010
#define EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO   0x0020
#define EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO   0x0040
#define EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE   0x0080
#define EFI_PCI_ATTRIBUTE_MEMORY_CACHED   0x0800
#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE   0x1000
#define EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000
#define EFI_PCI_ATTRIBUTE_ISA_IO_16   0x10000
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16   0x20000
#define EFI_PCI_ATTRIBUTE_VGA_IO_16   0x40000
#define EFI_PCI_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER   (EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE | EFI_PCI_ATTRIBUTE_MEMORY_CACHED | EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE)
#define EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER   (~EFI_PCI_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER)
#define EFI_PCI_ADDRESS(bus, dev, func, reg)

Typedefs

typedef struct
_EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL 
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINT64 Mask, IN UINT64 Value, IN UINT64 Delay, OUT UINT64 *Result)
 Reads from the I/O space of a PCI Root Bridge.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN OUT VOID *Buffer)
 Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 DestAddress, IN UINT64 SrcAddress, IN UINTN Count)
 Enables a PCI driver to copy one region of PCI root bridge memory space to another region of PCI root bridge memory space.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_PCI_ROOT_BRIDGE_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 required to access system memory from a DMA bus master.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN VOID *Mapping)
 Completes the Map() operation and releases any corresponding resources.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_ALLOCATE_TYPE Type, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT VOID **HostAddress, IN UINT64 Attributes)
 Allocates pages that are suitable for an EfiPciOperationBusMasterCommonBuffer or EfiPciOperationBusMasterCommonBuffer64 mapping.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN UINTN Pages, IN VOID *HostAddress)
 Frees memory that was allocated with AllocateBuffer().
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This)
 Flushes all PCI posted write transactions from a PCI host bridge to system memory.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, OUT UINT64 *Supports, OUT UINT64 *Attributes)
 Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the attributes that a PCI root bridge is currently using.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN UINT64 Attributes, IN OUT UINT64 *ResourceBase, IN OUT UINT64 *ResourceLength)
 Sets attributes for a resource range on a PCI root bridge.
typedef EFI_STATUS(EFIAPIEFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION )(IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, OUT VOID **Resources)
 Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI 2.0 resource descriptors.

Enumerations

enum  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH {
  EfiPciWidthUint8, EfiPciWidthUint16, EfiPciWidthUint32, EfiPciWidthUint64,
  EfiPciWidthFifoUint8, EfiPciWidthFifoUint16, EfiPciWidthFifoUint32, EfiPciWidthFifoUint64,
  EfiPciWidthFillUint8, EfiPciWidthFillUint16, EfiPciWidthFillUint32, EfiPciWidthFillUint64,
  EfiPciWidthMaximum
}
 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH. More...
enum  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION {
  EfiPciOperationBusMasterRead, EfiPciOperationBusMasterWrite, EfiPciOperationBusMasterCommonBuffer, EfiPciOperationBusMasterRead64,
  EfiPciOperationBusMasterWrite64, EfiPciOperationBusMasterCommonBuffer64, EfiPciOperationMaximum
}
 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION. More...

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiPciRootBridgeIoProtocolGuid

Detailed Description

PCI Root Bridge I/O protocol as defined in the UEFI 2.0 specification.

PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O, and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform defferent types of bus mastering DMA.

Copyright (c) 2006 - 2011, 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 PciRootBridgeIo.h.


Define Documentation

Value:
{ \
    0x2f707ebb, 0x4a1a, 0x11d4, {0x9a, 0x38, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

Definition at line 26 of file PciRootBridgeIo.h.

Definition at line 93 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_ISA_IO   0x0002

Definition at line 94 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO   0x0004

Definition at line 95 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_VGA_MEMORY   0x0008

Definition at line 96 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_VGA_IO   0x0010

Definition at line 97 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO   0x0020

Definition at line 98 of file PciRootBridgeIo.h.

Definition at line 99 of file PciRootBridgeIo.h.

Definition at line 100 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_MEMORY_CACHED   0x0800

Definition at line 101 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE   0x1000

Definition at line 102 of file PciRootBridgeIo.h.

Definition at line 103 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_ISA_IO_16   0x10000

Definition at line 104 of file PciRootBridgeIo.h.

Definition at line 105 of file PciRootBridgeIo.h.

#define EFI_PCI_ATTRIBUTE_VGA_IO_16   0x40000

Definition at line 106 of file PciRootBridgeIo.h.

Definition at line 108 of file PciRootBridgeIo.h.

Definition at line 110 of file PciRootBridgeIo.h.

#define EFI_PCI_ADDRESS (   bus,
  dev,
  func,
  reg 
)
Value:
(UINT64) ( \
  (((UINTN) bus) << 24) | \
  (((UINTN) dev) << 16) | \
  (((UINTN) func) << 8) | \
  (((UINTN) (reg)) < 256 ? ((UINTN) (reg)) : (UINT64) (LShiftU64 ((UINT64) (reg), 32))))

Definition at line 112 of file PciRootBridgeIo.h.

Referenced by efipci_address().


Typedef Documentation

Definition at line 31 of file PciRootBridgeIo.h.

Reads from the I/O space of a PCI Root Bridge.

Returns when either the polling exit criteria is satisfied or after a defined duration.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
WidthSignifies the width of the memory or I/O operations.
AddressThe base address of the memory or I/O operations.
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_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 147 of file PciRootBridgeIo.h.

Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
WidthSignifies the width of the memory operations.
AddressThe base address of the memory operations.
CountThe number of memory 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 root bridge.
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 174 of file PciRootBridgeIo.h.

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

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
WidthSignifies the width of the memory operations.
DestAddressThe destination address of the memory operation.
SrcAddressThe source address of the memory operation.
CountThe number of memory operations to perform.
Return values:
EFI_SUCCESSThe data was copied from one memory region to another memory region.
EFI_INVALID_PARAMETERWidth is invalid for this PCI root bridge.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Definition at line 210 of file PciRootBridgeIo.h.

Provides the PCI controller-specific addresses required to access system memory from a DMA bus master.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
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 240 of file PciRootBridgeIo.h.

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

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
MappingThe mapping value returned from Map().
Return values:
EFI_SUCCESSThe range was unmapped.
EFI_INVALID_PARAMETERMapping is not a value that was returned by Map().
EFI_DEVICE_ERRORThe data was not committed to the target system memory.

Definition at line 262 of file PciRootBridgeIo.h.

Allocates pages that are suitable for an EfiPciOperationBusMasterCommonBuffer or EfiPciOperationBusMasterCommonBuffer64 mapping.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
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 289 of file PciRootBridgeIo.h.

Frees memory that was allocated with AllocateBuffer().

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
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 312 of file PciRootBridgeIo.h.

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

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
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 331 of file PciRootBridgeIo.h.

Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the attributes that a PCI root bridge is currently using.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
SupportsA pointer to the mask of attributes that this PCI root bridge supports setting with SetAttributes().
AttributesA pointer to the mask of attributes that this PCI root bridge is currently using.
Return values:
EFI_SUCCESSIf Supports is not NULL, then the attributes that the PCI root bridge supports is returned in Supports. If Attributes is not NULL, then the attributes that the PCI root bridge is currently using is returned in Attributes.
EFI_INVALID_PARAMETERBoth Supports and Attributes are NULL.

Definition at line 355 of file PciRootBridgeIo.h.

Sets attributes for a resource range on a PCI root bridge.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
AttributesThe mask of attributes to set.
ResourceBaseA pointer to the base address of the resource range to be modified by the attributes specified by Attributes.
ResourceLengthA 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 ResourceBase and ResourceLength were set on the PCI root bridge, and the actual resource range is returned in ResuourceBase and ResourceLength.
EFI_UNSUPPORTEDA bit is set in Attributes that is not supported by the PCI Root Bridge.
EFI_OUT_OF_RESOURCESThere are not enough resources to set the attributes on the resource range specified by BaseAddress and Length.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 384 of file PciRootBridgeIo.h.

Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI 2.0 resource descriptors.

Parameters:
ThisA pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
ResourcesA pointer to the ACPI 2.0 resource descriptors that describe the current configuration of this PCI root bridge.
Return values:
EFI_SUCCESSThe current configuration of this PCI root bridge was returned in Resources.
EFI_UNSUPPORTEDThe current configuration of this PCI root bridge could not be retrieved.

Definition at line 407 of file PciRootBridgeIo.h.


Enumeration Type Documentation

EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH.

Enumerator:
EfiPciWidthUint8 
EfiPciWidthUint16 
EfiPciWidthUint32 
EfiPciWidthUint64 
EfiPciWidthFifoUint8 
EfiPciWidthFifoUint16 
EfiPciWidthFifoUint32 
EfiPciWidthFifoUint64 
EfiPciWidthFillUint8 
EfiPciWidthFillUint16 
EfiPciWidthFillUint32 
EfiPciWidthFillUint64 
EfiPciWidthMaximum 

Definition at line 38 of file PciRootBridgeIo.h.

EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION.

Enumerator:
EfiPciOperationBusMasterRead 

A read operation from system memory by a bus master that is not capable of producing PCI dual address cycles.

EfiPciOperationBusMasterWrite 

A write operation from system memory by a bus master that is not capable of producing PCI dual address cycles.

EfiPciOperationBusMasterCommonBuffer 

Provides both read and write access to system memory by both the processor and a bus master that is not capable of producing PCI dual address cycles.

EfiPciOperationBusMasterRead64 

A read operation from system memory by a bus master that is capable of producing PCI dual address cycles.

EfiPciOperationBusMasterWrite64 

A write operation to system memory by a bus master that is capable of producing PCI dual address cycles.

EfiPciOperationBusMasterCommonBuffer64 

Provides both read and write access to system memory by both the processor and a bus master that is capable of producing PCI dual address cycles.

EfiPciOperationMaximum 

Definition at line 59 of file PciRootBridgeIo.h.

             {
  ///
  /// A read operation from system memory by a bus master that is not capable of producing
  /// PCI dual address cycles.
  ///
  EfiPciOperationBusMasterRead,
  ///
  /// A write operation from system memory by a bus master that is not capable of producing
  /// PCI dual address cycles.
  ///
  EfiPciOperationBusMasterWrite,
  ///
  /// Provides both read and write access to system memory by both the processor and a bus
  /// master that is not capable of producing PCI dual address cycles.
  ///
  EfiPciOperationBusMasterCommonBuffer,
  ///
  /// A read operation from system memory by a bus master that is capable of producing PCI
  /// dual address cycles.
  ///
  EfiPciOperationBusMasterRead64,
  ///
  /// A write operation to system memory by a bus master that is capable of producing PCI
  /// dual address cycles.
  ///
  EfiPciOperationBusMasterWrite64,
  ///
  /// Provides both read and write access to system memory by both the processor and a bus
  /// master that is capable of producing PCI dual address cycles.
  ///
  EfiPciOperationBusMasterCommonBuffer64,
  EfiPciOperationMaximum
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION;

Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation