Code scrub:

[mirror_edk2.git] / MdePkg / Library / BaseIoLibIntrinsic / IoLibIcc.c

diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c
index d12ce3de90b8530a27fd99e3eb375f3721b130bd..c83fe8838de5f181a6b80681282b1cb09359fd5f 100644 (file)
--- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c
+++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c
@@ -13,9 +13,6 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
 #include "BaseIoLibIntrinsicInternal.h"\r
 \r
 /**\r
@@ -29,7 +26,7 @@
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Address.\r
 \r
 **/\r
 UINT8\r
@@ -52,6 +49,10 @@ MmioRead8 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return The value written to the Mmio. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          Mmio.\r
 \r
 **/\r
 UINT8\r
@@ -75,7 +76,7 @@ MmioWrite8 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Address.\r
 \r
 **/\r
 UINT16\r
@@ -99,6 +100,10 @@ MmioRead16 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return The value written to the Mmio. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          Mmio.\r
 \r
 **/\r
 UINT16\r
@@ -123,7 +128,7 @@ MmioWrite16 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Address.\r
 \r
 **/\r
 UINT32\r
@@ -147,6 +152,10 @@ MmioRead32 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return The value written to the Mmio. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          Mmio.\r
 \r
 **/\r
 UINT32\r
@@ -171,7 +180,7 @@ MmioWrite32 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Address.\r
 \r
 **/\r
 UINT64\r
@@ -196,6 +205,9 @@ MmioRead64 (
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
 \r
+  @return The value written to the Mmio. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          Mmio.\r
 **/\r
 UINT64\r
 EFIAPI\r
@@ -221,7 +233,7 @@ MmioWrite64 (
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Port.\r
 \r
 **/\r
 UINT8\r
@@ -253,7 +265,9 @@ IoRead8 (
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          I/O port.\r
 \r
 **/\r
 UINT8\r
@@ -282,7 +296,7 @@ IoWrite8 (
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Port.\r
 \r
 **/\r
 UINT16\r
@@ -316,7 +330,9 @@ IoRead16 (
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          I/O port.\r
 \r
 **/\r
 UINT16\r
@@ -351,7 +367,7 @@ IoWrite16 (
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read.\r
+  @return The value read from Port.\r
 \r
 **/\r
 UINT32\r
@@ -385,7 +401,9 @@ IoRead32 (
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port. It equals to the input\r
+          Value instead of the actual value read back from the\r
+          I/O port.\r
 \r
 **/\r
 UINT32\r