Fix formatting

[mirror_edk2.git] / MdePkg / Include / Ppi / CpuIo.h

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index 5cb767a02f16a40c393146e259efef0d0d35087a..31e90d0be84a631d7b50637cea48a17b9db8d6cc 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -1,8 +1,8 @@
 /** @file\r
-  This PPI provides a set of memory- and I/O-based services. \r
+  This PPI provides a set of memory and I/O-based services. \r
   The perspective of the services is that of the processor, not the bus or system.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2010, 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
@@ -19,8 +19,6 @@
 #ifndef __PEI_CPUIO_PPI_H__\r
 #define __PEI_CPUIO_PPI_H__\r
 \r
-#include <Pi/PiPeiCis.h>\r
-\r
 #define EFI_PEI_CPU_IO_PPI_INSTALLED_GUID \\r
   { 0xe6af1f7b, 0xfc3f, 0x46da, {0xa8, 0x28, 0xa3, 0xb4, 0x57, 0xa4, 0x42, 0x82 } }\r
 \r
@@ -50,13 +48,13 @@ typedef enum {
 /**\r
   Memory-based access services and I/O-based access services.\r
 \r
-  @param  PeiServices           An indirect pointer to the PEI Services Table\r
-                                published by the PEI Foundation.\r
-  @param  This                  Pointer to local data for the interface.\r
-  @param  Width                 The width of the access. Enumerated in bytes.\r
-  @param  Address               The physical address of the access.\r
-  @param  Count                 The number of accesses to perform.\r
-  @param  Buffer                A pointer to the buffer of data.\r
+  @param[in]  PeiServices  An indirect pointer to the PEI Services Table\r
+                           published by the PEI Foundation.\r
+  @param[in]  This         Pointer to local data for the interface.\r
+  @param[in]  Width        The width of the access. Enumerated in bytes.\r
+  @param[in]  Address      The physical address of the access.\r
+  @param[in]  Count        The number of accesses to perform.\r
+  @param[out] Buffer       A pointer to the buffer of data.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
@@ -92,9 +90,10 @@ typedef struct {
 /**\r
   8-bit I/O read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return An 8-bit value returned from the I/O space.\r
 \r
@@ -110,9 +109,10 @@ UINT8
 /**\r
   16-bit I/O read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 16-bit value returned from the I/O space.\r
 \r
@@ -128,9 +128,10 @@ UINT16
 /**\r
   32-bit I/O read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 32-bit value returned from the I/O space.\r
 \r
@@ -146,9 +147,10 @@ UINT32
 /**\r
   64-bit I/O read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 64-bit value returned from the I/O space.\r
 \r
@@ -164,10 +166,11 @@ UINT64
 /**\r
   8-bit I/O write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -182,10 +185,11 @@ VOID
 /**\r
   16-bit I/O write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -200,10 +204,11 @@ VOID
 /**\r
   32-bit I/O write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -218,10 +223,11 @@ VOID
 /**\r
   64-bit I/O write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -236,9 +242,10 @@ VOID
 /**\r
   8-bit memory read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return An 8-bit value returned from the memory space.\r
 \r
@@ -254,9 +261,10 @@ UINT8
 /**\r
   16-bit memory read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 16-bit value returned from the memory space.\r
 \r
@@ -272,9 +280,10 @@ UINT16
 /**\r
   32-bit memory read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 32-bit value returned from the memory space.\r
 \r
@@ -290,9 +299,10 @@ UINT32
 /**\r
   64-bit memory read operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
 \r
   @return A 64-bit value returned from the memory space.\r
 \r
@@ -308,10 +318,11 @@ UINT64
 /**\r
   8-bit memory write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -326,10 +337,11 @@ VOID
 /**\r
   16-bit memory write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -344,10 +356,11 @@ VOID
 /**\r
   32-bit memory write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -362,10 +375,11 @@ VOID
 /**\r
   64-bit memory write operations.\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Address        The physical address of the access.\r
-  @param  Data           The data to write.\r
+  @param[in] PeiServices  An indirect pointer to the PEI Services Table published \r
+                          by the PEI Foundation.\r
+  @param[in] This         Pointer to local data for the interface.\r
+  @param[in] Address      The physical address of the access.\r
+  @param[in] Data         The data to write.\r
 \r
 **/\r
 typedef\r
@@ -382,8 +396,14 @@ VOID
 /// The perspective of the services is that of the processor, not the bus or system.\r
 ///\r
 struct _EFI_PEI_CPU_IO_PPI {\r
-  EFI_PEI_CPU_IO_PPI_ACCESS       Mem;      ///< Collection of memory-access services.\r
-  EFI_PEI_CPU_IO_PPI_ACCESS       Io;       ///< Collection of I/O-access services.\r
+  ///\r
+  /// Collection of memory-access services.\r
+  ///\r
+  EFI_PEI_CPU_IO_PPI_ACCESS       Mem;\r
+  ///\r
+  /// Collection of I/O-access services.\r
+  ///\r
+  EFI_PEI_CPU_IO_PPI_ACCESS       Io;\r
 \r
   EFI_PEI_CPU_IO_PPI_IO_READ8     IoRead8;\r
   EFI_PEI_CPU_IO_PPI_IO_READ16    IoRead16;\r