Clean up comments

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9759 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 29 insertions, 27 deletions

diff --git a/MdePkg/Include/Protocol/CpuIo2.h b/MdePkg/Include/Protocol/CpuIo2.h
index 78b3eb6..2bda51c 100644
--- a/MdePkg/Include/Protocol/CpuIo2.h
+++ b/MdePkg/Include/Protocol/CpuIo2.h
@@ -59,41 +59,43 @@ typedef enum {
 /**

   Enables a driver to access registers in the PI CPU I/O space. 

 

-  The Io.Read() and Io.Write() functions enable a driver to access PCI controller registers in 

-  the PI CPU I/O space. 

-

-  The I/O operations are carried out exactly as requested. The caller is responsible for satisfying any 

-  alignment and I/O width restrictions that a PI System on a platform might require. For example on 

-  some platforms, width requests of EfiCpuIoWidthUint64 do not work. Misaligned buffers, on 

-  the other hand, will be handled by the driver.

+  The Io.Read() and Io.Write() functions enable a driver to access PCI controller 

+  registers in the PI CPU I/O space. 

+

+  The I/O operations are carried out exactly as requested. The caller is responsible 

+  for satisfying any alignment and I/O width restrictions that a PI System on a 

+  platform might require. For example on some platforms, width requests of 

+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will 

+  be handled by the driver.

   

   If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, 

-  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the 

-  Count operations that is performed.

+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for 

+  each of the Count operations that is performed.

   

   If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, 

   EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is 

-  incremented for each of the Count operations that is performed. The read or write operation is 

-  performed Count times on the same Address.

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times on the same Address.

   

   If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, 

   EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is 

-  incremented for each of the Count operations that is performed. The read or write operation is 

-  performed Count times from the first element of Buffer.

-

-  @param[in]       This         A pointer to the EFI_CPU_IO2_PROTOCOL instance.

-  @param[in]       Width        Signifies the width of the I/O or Memory operation.

-  @param[in]       Address      The base address of the I/O operation. The caller is responsible

-                                for aligning the Address if required. 

-  @param[in]       Count        The number of I/O operations to perform. The number of bytes moved

-                                is Width size * Count, starting at Address.

-  @param[in, out]  Buffer       For read operations, the destination buffer to store the results.

-                                For write operations, the source buffer from which to write data.

-

-  @retval EFI_SUCCESS           The data was read from or written to the EFI system.

-  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.

-  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.

-                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times from the first element of Buffer.

+

+  @param[in]       This     A pointer to the EFI_CPU_IO2_PROTOCOL instance.

+  @param[in]       Width    Signifies the width of the I/O or Memory operation.

+  @param[in]       Address  The base address of the I/O operation. 

+  @param[in]       Count    The number of I/O operations to perform. The number 

+                            of bytes moved is Width size * Count, starting at Address.

+  @param[in, out]  Buffer   For read operations, the destination buffer to store the results.

+                            For write operations, the source buffer from which to write data.

+

+  @retval EFI_SUCCESS            The data was read from or written to the PI system.

+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.

+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.

+  @retval EFI_UNSUPPORTED        The Buffer is not aligned for the given Width.

+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, 

+                                 and Count is not valid for this PI system.

 

 **/

 typedef