|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | EFI_IO_ACCESS |
| struct | _EFI_DEVICE_IO_PROTOCOL |
Macros | |
| #define | EFI_DEVICE_IO_PROTOCOL_GUID |
| #define | DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID |
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 |
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 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID |
Protocol GUID name defined in EFI1.1.
| #define EFI_DEVICE_IO_PROTOCOL_GUID |
| 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.
| 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. |
| 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 struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL |
| 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.
| 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. |
| 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.
| This | A pointer to the EFI_DEVICE_IO_INTERFACE instance. |
| 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().
| 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. |
| 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.
| 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(). |
| 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.
| This | A pointer to the EFI_DEVICE_IO_INTERFACE instance. |
| Mapping | A resulting value to pass to Unmap(). |
| 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.
| 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. |
| 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. |
| enum EFI_IO_WIDTH |
| EFI_GUID gEfiDeviceIoProtocolGuid |
1.8.6 
