Clean up format of comments

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

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index 31e90d0be84a631d7b50637cea48a17b9db8d6cc..28bbb5f34a0285c9febeced2989ec707ccf1a32c 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -25,9 +25,7 @@
 typedef struct _EFI_PEI_CPU_IO_PPI  EFI_PEI_CPU_IO_PPI;\r
 \r
 ///\r
-/// *******************************************************\r
 /// EFI_PEI_CPU_IO_PPI_WIDTH\r
-/// *******************************************************\r
 ///\r
 typedef enum {\r
   EfiPeiCpuIoWidthUint8,\r
@@ -48,43 +46,41 @@ typedef enum {
 /**\r
   Memory-based access services and I/O-based access services.\r
 \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
+  @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[in, 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
+  @retval EFI_SUCCESS            The function completed successfully.\r
+  @retval EFI_NOT_YET_AVAILABLE  The service has not been installed.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM)(\r
-  IN  CONST EFI_PEI_SERVICES            **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI          *This,\r
-  IN  EFI_PEI_CPU_IO_PPI_WIDTH          Width,\r
-  IN  UINT64                            Address,\r
-  IN  UINTN                             Count,\r
-  IN  OUT VOID                          *Buffer\r
+  IN     CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN     CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN     EFI_PEI_CPU_IO_PPI_WIDTH  Width,\r
+  IN     UINT64                    Address,\r
+  IN     UINTN                     Count,\r
+  IN OUT VOID                      *Buffer\r
   );\r
 \r
 ///\r
-/// *******************************************************\r
 /// EFI_PEI_CPU_IO_PPI_ACCESS\r
-/// *******************************************************\r
 ///\r
 typedef struct {\r
   ///\r
   /// This service provides the various modalities of memory and I/O read.\r
   ///\r
-  EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
+  EFI_PEI_CPU_IO_PPI_IO_MEM  Read;\r
   ///\r
   /// This service provides the various modalities of memory and I/O write.\r
   ///\r
-  EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
+  EFI_PEI_CPU_IO_PPI_IO_MEM  Write;\r
 } EFI_PEI_CPU_IO_PPI_ACCESS;\r
 \r
 /**\r
@@ -95,15 +91,15 @@ typedef struct {
   @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
+  @return  An 8-bit value returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -114,15 +110,15 @@ UINT8
   @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
+  @return  A 16-bit value returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -133,15 +129,15 @@ UINT16
   @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
+  @return  A 32-bit value returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -152,15 +148,15 @@ UINT32
   @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
+  @return  A 64-bit value returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -176,10 +172,10 @@ UINT64
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT8                         Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT8                     Data\r
   );\r
 \r
 /**\r
@@ -195,10 +191,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT16                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT16                    Data\r
   );\r
 \r
 /**\r
@@ -214,10 +210,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT32                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT32                    Data\r
   );\r
 \r
 /**\r
@@ -233,10 +229,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT64                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT64                    Data\r
   );\r
 \r
 /**\r
@@ -247,15 +243,15 @@ VOID
   @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
+  @return  An 8-bit value returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -266,15 +262,15 @@ UINT8
   @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
+  @return  A 16-bit value returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -285,15 +281,15 @@ UINT16
   @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
+  @return  A 32-bit value returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -304,15 +300,15 @@ UINT32
   @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
+  @return  A 64-bit value returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address\r
   );\r
 \r
 /**\r
@@ -328,10 +324,10 @@ UINT64
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT8                         Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT8                     Data\r
   );\r
 \r
 /**\r
@@ -347,10 +343,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT16                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT16                    Data\r
   );\r
 \r
 /**\r
@@ -366,10 +362,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT32                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT32                    Data\r
   );\r
 \r
 /**\r
@@ -385,10 +381,10 @@ VOID
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64)(\r
-  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
-  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                        Address,\r
-  IN  UINT64                        Data\r
+  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI  *This,\r
+  IN  UINT64                    Address,\r
+  IN  UINT64                    Data\r
   );\r
 \r
 ///\r