Refine SMM USB Dispatch Protocol definition.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / CpuIo.h

diff --git a/IntelFrameworkPkg/Include/Protocol/CpuIo.h b/IntelFrameworkPkg/Include/Protocol/CpuIo.h
index 6ea196a54f24618bde30dcd8b116d789891f9df8..39cead97807d17583d4bbc417d7e9418d7d8b312 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/CpuIo.h
+++ b/IntelFrameworkPkg/Include/Protocol/CpuIo.h
@@ -2,7 +2,7 @@
   This code abstracts the CPU IO Protocol which installed by some platform or chipset-specific \r
   PEIM that abstracts the processor-visible I/O operations.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -11,8 +11,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:  CpuIO.h\r
-\r
   @par Revision Reference:\r
   CPU IO Protocol is defined in Framework of EFI CPU IO Protocol Spec\r
   Version 0.9\r
@@ -31,11 +29,9 @@
 \r
 typedef struct _EFI_CPU_IO_PROTOCOL EFI_CPU_IO_PROTOCOL;\r
 \r
-//\r
-// *******************************************************\r
-// EFI_CPU_IO_PROTOCOL_WIDTH\r
-// *******************************************************\r
-//\r
+///\r
+/// Enumeration that defines the width of the I/O operation.\r
+///\r
 typedef enum {\r
   EfiCpuIoWidthUint8,\r
   EfiCpuIoWidthUint16,\r
@@ -52,11 +48,6 @@ typedef enum {
   EfiCpuIoWidthMaximum\r
 } EFI_CPU_IO_PROTOCOL_WIDTH;\r
 \r
-//\r
-// *******************************************************\r
-// EFI_CPU_IO_PROTOCOL_IO_MEM\r
-// *******************************************************\r
-//\r
 /**\r
   Enables a driver to access memory-mapped registers in the EFI system memory space.\r
   Or, Enables a driver to access registers in the EFI CPU I/O space.\r
@@ -78,48 +69,39 @@ typedef enum {
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_CPU_IO_PROTOCOL_IO_MEM)(\r
-  IN EFI_CPU_IO_PROTOCOL                *This,\r
-  IN  EFI_CPU_IO_PROTOCOL_WIDTH         Width,\r
-  IN  UINT64                            Address,\r
-  IN  UINTN                             Count,\r
-  IN  OUT VOID                          *Buffer\r
+  IN     EFI_CPU_IO_PROTOCOL               *This,\r
+  IN     EFI_CPU_IO_PROTOCOL_WIDTH         Width,\r
+  IN     UINT64                            Address,\r
+  IN     UINTN                             Count,\r
+  IN OUT VOID                              *Buffer\r
   );\r
 \r
-//\r
-// *******************************************************\r
-// EFI_CPU_IO_PROTOCOL_ACCESS\r
-// *******************************************************\r
-//\r
+///\r
+/// Servies for read and write accesses.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// This service provides the various modalities of memory and I/O read.\r
+  ///\r
   EFI_CPU_IO_PROTOCOL_IO_MEM  Read;\r
+  ///\r
+  /// This service provides the various modalities of memory and I/O write.\r
+  ///\r
   EFI_CPU_IO_PROTOCOL_IO_MEM  Write;\r
 } EFI_CPU_IO_PROTOCOL_ACCESS;\r
 \r
-//\r
-// *******************************************************\r
-// EFI_CPU_IO_PROTOCOL\r
-// *******************************************************\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  Provides the basic memory and I/O interfaces that are used to abstract\r
-  accesses to devices in a system.\r
-\r
-  @param Mem.Read\r
-  Allows reads from memory-mapped I/O space.\r
-\r
-  @param Mem.Write\r
-  Allows writes to memory-mapped I/O space.\r
-\r
-  @param Io.Read\r
-  Allows reads from I/O space.\r
-\r
-  @param Io.Write\r
-  Allows writes to I/O space.\r
-\r
-**/\r
+///\r
+/// Provides the basic memory and I/O interfaces that are used to abstract\r
+/// accesses to devices in a system.\r
+///\r
 struct _EFI_CPU_IO_PROTOCOL {\r
+  ///\r
+  /// Enables a driver to access memory-mapped registers in the EFI system memory space.\r
+  ///\r
   EFI_CPU_IO_PROTOCOL_ACCESS  Mem;\r
+  ///\r
+  /// Enables a driver to access registers in the EFI CPU I/O space.\r
+  ///\r
   EFI_CPU_IO_PROTOCOL_ACCESS  Io;\r
 };\r
 \r