Fix some unicode characters in source file.

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

diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index 7b79d2355f13e7b423a445d1954c5eba79b91343..99a48cdccbf5249e15389e82a9e8249b1d22009e 100644 (file)
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -4,7 +4,7 @@
   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 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
@@ -35,15 +35,22 @@ typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;
 /// \r
 typedef EFI_DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_INTERFACE;\r
 \r
+///\r
+/// Device IO Access Width \r
+///\r
 typedef enum {\r
-  IO_UINT8,\r
-  IO_UINT16,\r
-  IO_UINT32,\r
-  IO_UINT64,\r
-  MMIO_COPY_UINT8,\r
-  MMIO_COPY_UINT16,\r
-  MMIO_COPY_UINT32,\r
-  MMIO_COPY_UINT64\r
+  IO_UINT8  = 0,\r
+  IO_UINT16 = 1,\r
+  IO_UINT32 = 2,\r
+  IO_UINT64 = 3,\r
+  //\r
+  // Below enumerations are added in "Extensible Firmware Interface Specification, \r
+  // Version 1.10, Specification Update, Version 001".\r
+  //\r
+  MMIO_COPY_UINT8  = 4,\r
+  MMIO_COPY_UINT16 = 5,\r
+  MMIO_COPY_UINT32 = 6,\r
+  MMIO_COPY_UINT64 = 7\r
 } EFI_IO_WIDTH;\r
 \r
 /**                                                                 \r
@@ -54,7 +61,10 @@ typedef enum {
   @param  Address               The base address of the I/O operations. \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
+                                operations, the source buffer to write data from. If\r
+                                Width is MMIO_COPY_UINT8, MMIO_COPY_UINT16,\r
+                                MMIO_COPY_UINT32, or MMIO_COPY_UINT64, then\r
+                                Buffer is interpreted as a base address of an I/O operation such as Address. \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
@@ -99,8 +109,22 @@ EFI_STATUS
   );\r
 \r
 typedef enum {\r
+  ///\r
+  /// A read operation from system memory by a bus master.\r
+  ///\r
   EfiBusMasterRead,\r
+\r
+  ///\r
+  /// A write operation to system memory by a bus master.\r
+  ///\r
   EfiBusMasterWrite,\r
+  \r
+  ///\r
+  /// Provides both read and write access to system memory\r
+  /// by both the processor and a bus master. The buffer is\r
+  /// coherent from both the processor's and the bus master's\r
+  /// point of view.\r
+  ///\r
   EfiBusMasterCommonBuffer\r
 } EFI_IO_OPERATION_TYPE;\r
 \r
@@ -110,7 +134,8 @@ typedef enum {
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
   @param  Operation             Indicates if the bus master is going to read or write to system memory.\r
   @param  HostAddress           The system memory address to map to the device.\r
-  @param  NumberOfBytes         On input the number of bytes to map.\r
+  @param  NumberOfBytes         On input, the number of bytes to map.\r
+                                On output, the number of bytes that were mapped.\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
@@ -213,43 +238,22 @@ EFI_STATUS
   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
+///\r
+/// This protocol provides the basic Memory, I/O, and PCI interfaces that \r
+/// are used to abstract accesses to devices.\r
+///\r
 struct _EFI_DEVICE_IO_PROTOCOL {\r
+  ///\r
+  /// Allows reads and writes to memory mapped I/O space.\r
+  ///\r
   EFI_IO_ACCESS           Mem;\r
+  ///\r
+  /// Allows reads and writes to I/O space.\r
+  ///\r
   EFI_IO_ACCESS           Io;\r
+  ///\r
+  /// Allows reads and writes to PCI configuration space.\r
+  ///\r
   EFI_IO_ACCESS           Pci;\r
   EFI_IO_MAP              Map;\r
   EFI_PCI_DEVICE_PATH     PciDevicePath;\r