Code scrub:

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

diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c
index 806f44bbe77bea28cab4123ecaea426ca610259e..db94f0f47e657489a18cc52c8bebe01b18abe355 100644 (file)
--- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c
+++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c
@@ -19,10 +19,13 @@
   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:  IoLibGcc.c\r
-\r
 **/\r
 \r
+//\r
+// Include common header file for this module.\r
+//\r
+#include "BaseIoLibIntrinsicInternal.h"\r
+\r
 /**\r
   Reads an 8-bit MMIO register.\r
 \r
@@ -34,7 +37,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
@@ -58,6 +61,9 @@ MmioRead8 (
   @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
 UINT8\r
 EFIAPI\r
@@ -80,7 +86,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
@@ -105,6 +111,9 @@ MmioRead16 (
   @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
 UINT16\r
 EFIAPI\r
@@ -128,7 +137,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
@@ -153,6 +162,9 @@ MmioRead32 (
   @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
 UINT32\r
 EFIAPI\r
@@ -176,7 +188,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
@@ -201,6 +213,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
@@ -226,7 +241,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
 __inline__\r
@@ -254,7 +269,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\r
+          input Value instead of the actual value read back from\r
+          the I/O port.\r
 \r
 **/\r
 __inline__\r
@@ -280,7 +297,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
 __inline__\r
@@ -309,7 +326,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\r
+          input Value instead of the actual value read back from\r
+          the I/O port.\r
 \r
 **/\r
 __inline__\r
@@ -336,7 +355,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
 __inline__\r
@@ -365,7 +384,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\r
+          input Value instead of the actual value read back from\r
+          the I/O port.\r
 \r
 **/\r
 __inline__\r