4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Device IO protocol as defined in the EFI 1.10 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Device IO is used to abstract hardware access to devices. It includes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync memory mapped IO, IO, PCI Config space, and DMA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2009, 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 0xaf6ac311, 0x84c3, 0x11d2, {0x8e, 0x3c, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Protocol GUID name defined in EFI1.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Protocol defined in EFI1.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Device IO Access Width
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Below enumerations are added in "Extensible Firmware Interface Specification,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Version 1.10, Specification Update, Version 001".
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enables a driver to access device registers in the appropriate memory or I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width Signifies the width of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of 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. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Width is MMIO_COPY_UINT8, MMIO_COPY_UINT16,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MMIO_COPY_UINT32, or MMIO_COPY_UINT64, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer is interpreted as a base address of an I/O operation such as Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was read from or written to the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Width is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides an EFI Device Path for a PCI device with the given PCI configuration space address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PciAddress The PCI configuration space address of the device whose Device Path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is going to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Memory for the Device Path is allocated from the pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A read operation from system memory by a bus master.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A write operation to system memory by a bus master.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Provides both read and write access to system memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// by both the processor and a bus master. The buffer is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// coherent from both the processor's and the bus master's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// point of view.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the device-specific addresses needed to access system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE 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 device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfBytes On input, the number of bytes to map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes that were mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddress The resulting map address for the bus master device to use to access the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 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_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Operation or HostAddress is undefined.
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_DEVICE_IO_INTERFACE instance.
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_DEVICE_ERROR The system hardware could not map the requested address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates pages that are suitable for an EFIBusMasterCommonBuffer mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type allocation to perform.
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 address of the allocated range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested memory pages were allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The requested memory type is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The requested HostAddress is not supported on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Flushes any posted write data to the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The buffers were flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees pages that were allocated with AllocateBuffer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages The number of pages to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HostAddress The base address of the range to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested memory pages were allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The requested memory pages were not allocated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocateBuffer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER HostAddress is not page aligned or Pages is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol provides the basic Memory, I/O, and PCI interfaces that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// are used to abstract accesses to devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allows reads and writes to memory mapped I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allows reads and writes to I/O space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allows reads and writes to PCI configuration space.