MdePkg/Include/Protocol/DeviceIo.h File Reference


Data Structures

struct  EFI_IO_ACCESS
struct  _EFI_DEVICE_IO_PROTOCOL

Defines

#define EFI_DEVICE_IO_PROTOCOL_GUID
#define DEVICE_IO_PROTOCOL   EFI_DEVICE_IO_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_DEVICE_IO_PROTOCOL 
EFI_DEVICE_IO_PROTOCOL
typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE
typedef EFI_STATUS(EFIAPIEFI_DEVICE_IO )(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_IO_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN OUT VOID *Buffer)
typedef EFI_STATUS(EFIAPIEFI_PCI_DEVICE_PATH )(IN EFI_DEVICE_IO_PROTOCOL *This, IN UINT64 PciAddress, IN OUT EFI_DEVICE_PATH_PROTOCOL **PciDevicePath)
typedef EFI_STATUS(EFIAPIEFI_IO_MAP )(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_IO_OPERATION_TYPE Operation, IN EFI_PHYSICAL_ADDRESS *HostAddress, IN OUT UINTN *NumberOfBytes, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, OUT VOID **Mapping)
typedef EFI_STATUS(EFIAPIEFI_IO_UNMAP )(IN EFI_DEVICE_IO_PROTOCOL *This, IN VOID *Mapping)
typedef EFI_STATUS(EFIAPIEFI_IO_ALLOCATE_BUFFER )(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_ALLOCATE_TYPE Type, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT EFI_PHYSICAL_ADDRESS *HostAddress)
typedef EFI_STATUS(EFIAPIEFI_IO_FLUSH )(IN EFI_DEVICE_IO_PROTOCOL *This)
typedef EFI_STATUS(EFIAPIEFI_IO_FREE_BUFFER )(IN EFI_DEVICE_IO_PROTOCOL *This, IN UINTN Pages, IN EFI_PHYSICAL_ADDRESS HostAddress)

Enumerations

enum  EFI_IO_WIDTH {
  IO_UINT8 = 0, IO_UINT16 = 1, IO_UINT32 = 2, IO_UINT64 = 3,
  MMIO_COPY_UINT8 = 4, MMIO_COPY_UINT16 = 5, MMIO_COPY_UINT32 = 6, MMIO_COPY_UINT64 = 7
}
enum  EFI_IO_OPERATION_TYPE { EfiBusMasterRead, EfiBusMasterWrite, EfiBusMasterCommonBuffer }

Variables

EFI_GUID gEfiDeviceIoProtocolGuid

Detailed Description

Device IO protocol as defined in the EFI 1.10 specification.

Device IO is used to abstract hardware access to devices. It includes memory mapped IO, IO, PCI Config space, and DMA.

Copyright (c) 2006 - 2009, 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.


Define Documentation

#define DEVICE_IO_PROTOCOL   EFI_DEVICE_IO_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

#define EFI_DEVICE_IO_PROTOCOL_GUID

Value:

{ \
    0xaf6ac311, 0x84c3, 0x11d2, {0x8e, 0x3c, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_DEVICE_IO)(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_IO_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN OUT VOID *Buffer)

Enables a driver to access device registers in the appropriate memory or I/O space.

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
Width Signifies the width of the I/O operations.
Address The base address of the I/O operations.
Count The number of 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. If Width is MMIO_COPY_UINT8, MMIO_COPY_UINT16, MMIO_COPY_UINT32, or MMIO_COPY_UINT64, then Buffer is interpreted as a base address of an I/O operation such as Address.
Return values:
EFI_SUCCESS The data was read from or written to the device.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER Width is invalid.

Protocol defined in EFI1.1.

typedef EFI_STATUS(EFIAPI * EFI_IO_ALLOCATE_BUFFER)(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_ALLOCATE_TYPE Type, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT EFI_PHYSICAL_ADDRESS *HostAddress)

Allocates pages that are suitable for an EFIBusMasterCommonBuffer mapping.

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
Type The type allocation to perform.
MemoryType The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
Pages The number of pages to allocate.
HostAddress A pointer to store the base address of the allocated range.
Return values:
EFI_SUCCESS The requested memory pages were allocated.
EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
EFI_INVALID_PARAMETER The requested memory type is invalid.
EFI_UNSUPPORTED The requested HostAddress is not supported on this platform.

typedef EFI_STATUS(EFIAPI * EFI_IO_FLUSH)(IN EFI_DEVICE_IO_PROTOCOL *This)

Flushes any posted write data to the device.

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
Return values:
EFI_SUCCESS The buffers were flushed.
EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.

typedef EFI_STATUS(EFIAPI * EFI_IO_FREE_BUFFER)(IN EFI_DEVICE_IO_PROTOCOL *This, IN UINTN Pages, IN EFI_PHYSICAL_ADDRESS HostAddress)

Frees pages that were allocated with AllocateBuffer().

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
Pages The number of pages to free.
HostAddress The base address of the range to free.
Return values:
EFI_SUCCESS The requested memory pages were allocated.
EFI_NOT_FOUND The requested memory pages were not allocated with AllocateBuffer().
EFI_INVALID_PARAMETER HostAddress is not page aligned or Pages is invalid.

typedef EFI_STATUS(EFIAPI * EFI_IO_MAP)(IN EFI_DEVICE_IO_PROTOCOL *This, IN EFI_IO_OPERATION_TYPE Operation, IN EFI_PHYSICAL_ADDRESS *HostAddress, IN OUT UINTN *NumberOfBytes, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, OUT VOID **Mapping)

Provides the device-specific addresses needed to access system memory.

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE 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 device.
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 device to use to access the hosts HostAddress.
Mapping A resulting value to pass to Unmap().
Return values:
EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
EFI_INVALID_PARAMETER The Operation or HostAddress is undefined.
EFI_DEVICE_ERROR The system hardware could not map the requested address.

typedef EFI_STATUS(EFIAPI * EFI_IO_UNMAP)(IN EFI_DEVICE_IO_PROTOCOL *This, IN VOID *Mapping)

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

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
Mapping A resulting value to pass to Unmap().
Return values:
EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
EFI_DEVICE_ERROR The system hardware could not map the requested address.

typedef EFI_STATUS(EFIAPI * EFI_PCI_DEVICE_PATH)(IN EFI_DEVICE_IO_PROTOCOL *This, IN UINT64 PciAddress, IN OUT EFI_DEVICE_PATH_PROTOCOL **PciDevicePath)

Provides an EFI Device Path for a PCI device with the given PCI configuration space address.

Parameters:
This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
PciAddress The PCI configuration space address of the device whose Device Path is going to be returned.
PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress. Memory for the Device Path is allocated from the pool.
Return values:
EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.


Enumeration Type Documentation

Enumerator:
EfiBusMasterRead  A read operation from system memory by a bus master.
EfiBusMasterWrite  A write operation to system memory by a bus master.
EfiBusMasterCommonBuffer  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.

Device IO Access Width

Enumerator:
IO_UINT8 
IO_UINT16 
IO_UINT32 
IO_UINT64 
MMIO_COPY_UINT8 
MMIO_COPY_UINT16 
MMIO_COPY_UINT32 
MMIO_COPY_UINT64 


Variable Documentation


Generated on Thu Sep 24 23:14:19 2015 for MdePkg[ALL] by  doxygen 1.5.7.1