/** @file\r
- Device IO protocol as defined in the EFI 1.0 specification.\r
+ Device IO protocol as defined in the EFI 1.10 specification.\r
\r
Device IO is used to abstract hardware access to devices. It includes\r
memory mapped IO, IO, PCI Config space, and DMA.\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
- Module Name: DeviceIo.h\r
-\r
**/\r
\r
#ifndef __DEVICE_IO_H__\r
\r
typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;\r
\r
+//\r
+// Protocol GUID name defined in EFI1.1.\r
+// \r
+#define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID\r
+\r
+//\r
+// Protocol defined in EFI1.1.\r
+// \r
+typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE;\r
+\r
typedef enum {\r
IO_UINT8,\r
IO_UINT16,\r
@param Count The number of I/O operations to perform.\r
@param Buffer For read operations, the destination buffer to store the results. For write\r
operations, the source buffer to write data from. \r
- \r
+\r
@retval EFI_SUCCESS The data was read from or written to the device.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r
@retval EFI_INVALID_PARAMETER Width is invalid.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DEVICE_IO) (\r
+(EFIAPI *EFI_DEVICE_IO)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN EFI_IO_WIDTH Width,\r
IN UINT64 Address,\r
is going to be returned. \r
@param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress.\r
Memory for the Device Path is allocated from the pool. \r
- \r
+\r
@retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r
@retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PCI_DEVICE_PATH) (\r
+(EFIAPI *EFI_PCI_DEVICE_PATH)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN UINT64 PciAddress,\r
IN OUT EFI_DEVICE_PATH_PROTOCOL **PciDevicePath\r
@param DeviceAddress The resulting map address for the bus master device to use to access the\r
hosts HostAddress.\r
@param Mapping A resulting value to pass to Unmap().\r
- \r
+\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IO_MAP) (\r
+(EFIAPI *EFI_IO_MAP)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN EFI_IO_OPERATION_TYPE Operation,\r
IN EFI_PHYSICAL_ADDRESS *HostAddress,\r
\r
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
@param Mapping A resulting value to pass to Unmap().\r
- \r
+\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IO_UNMAP) (\r
+(EFIAPI *EFI_IO_UNMAP)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN VOID *Mapping\r
);\r
EfiRuntimeServicesData.\r
@param Pages The number of pages to allocate.\r
@param HostAddress A pointer to store the base address of the allocated range. \r
- \r
+\r
@retval EFI_SUCCESS The requested memory pages were allocated.\r
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.\r
@retval EFI_INVALID_PARAMETER The requested memory type is invalid.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IO_ALLOCATE_BUFFER) (\r
+(EFIAPI *EFI_IO_ALLOCATE_BUFFER)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN EFI_ALLOCATE_TYPE Type,\r
IN EFI_MEMORY_TYPE MemoryType,\r
Flushes any posted write data to the device.\r
\r
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
- \r
+\r
@retval EFI_SUCCESS The buffers were flushed.\r
@retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error. \r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IO_FLUSH) (\r
+(EFIAPI *EFI_IO_FLUSH)(\r
IN EFI_DEVICE_IO_PROTOCOL *This\r
);\r
\r
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. \r
@param Pages The number of pages to free.\r
@param HostAddress The base address of the range to free.\r
- \r
+\r
@retval EFI_SUCCESS The requested memory pages were allocated.\r
@retval EFI_NOT_FOUND The requested memory pages were not allocated with\r
AllocateBuffer(). \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IO_FREE_BUFFER) (\r
+(EFIAPI *EFI_IO_FREE_BUFFER)(\r
IN EFI_DEVICE_IO_PROTOCOL *This,\r
IN UINTN Pages,\r
IN EFI_PHYSICAL_ADDRESS HostAddress\r
);\r
\r
+/**\r
+ @par Protocol Description:\r
+ This protocol provides the basic Memory, I/O, and PCI interfaces that \r
+ are used to abstract accesses to devices.\r
+\r
+ @param Mem \r
+ Allows reads and writes to memory mapped I/O space.\r
+\r
+ @param Io \r
+ Allows reads and writes to I/O space.\r
+\r
+ @param Pci \r
+ Allows reads and writes to PCI configuration space.\r
+\r
+ @param Map \r
+ Provides the device specific addresses needed to access system memory for DMA. \r
+\r
+ @param PciDevicePath \r
+ Provides an EFI Device Path for a PCI device with the given PCI\r
+ configuration space address.\r
+\r
+ @param Unmap \r
+ Releases any resources allocated by Map(). \r
+\r
+ @param AllocateBuffer \r
+ Allocates pages that are suitable for a common buffer mapping. \r
+\r
+ @param Flush \r
+ Flushes any posted write data to the device. \r
+\r
+ @param FreeBuffer \r
+ Free pages that were allocated with AllocateBuffer(). \r
+\r
+**/ \r
struct _EFI_DEVICE_IO_PROTOCOL {\r
EFI_IO_ACCESS Mem;\r
EFI_IO_ACCESS Io;\r
projects / mirror_edk2.git / blobdiff