Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / DeviceIo.h

diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index 1e52548ac05e0f67ccfebc932bd935452227710f..0bc4394904750d14c878b21a7ff9ff93ad29694c 100644 (file)
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -1,10 +1,10 @@
 /** @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
@@ -13,8 +13,6 @@
   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
@@ -65,7 +63,7 @@ typedef enum {
 **/\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
@@ -94,7 +92,7 @@ typedef struct {
 **/\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
@@ -126,7 +124,7 @@ typedef enum {
 **/\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
@@ -147,7 +145,7 @@ EFI_STATUS
 **/\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
@@ -171,7 +169,7 @@ EFI_STATUS
 **/\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
@@ -190,7 +188,7 @@ EFI_STATUS
 **/\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
@@ -209,12 +207,46 @@ EFI_STATUS
 **/\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