Update inappropriate comments.

[mirror_edk2.git] / MdePkg / Library / PeiIoLibCpuIo / IoLib.c

diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
index 5d94b56124a2dbc9c7bb3c7b9b30a7614b797a84..1f50a12404098859f6868e428d6999df6286db93 100644 (file)
--- a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
+++ b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
@@ -1,11 +1,11 @@
 /** @file\r
   I/O Library. The implementations are based on EFI_PEI_SERVICE->CpuIo interface.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
-  http://opensource.org/licenses/bsd-license.php\r
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   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
@@ -31,7 +31,7 @@
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -91,10 +91,11 @@ IoWrite8 (
   serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -124,7 +125,8 @@ IoRead16 (
   operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -160,10 +162,11 @@ IoWrite16 (
   serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -193,7 +196,8 @@ IoRead32 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -229,10 +233,11 @@ IoWrite32 (
   serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -262,6 +267,7 @@ IoRead64 (
   operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
@@ -301,7 +307,7 @@ IoWrite64 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -332,7 +338,8 @@ 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 back to Mmio register.\r
+  @return Value.\r
+\r
 **/\r
 UINT8\r
 EFIAPI\r
@@ -360,10 +367,11 @@ MmioWrite8 (
   operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -394,11 +402,12 @@ MmioRead16 (
   and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \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 back to Mmio register\r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -430,10 +439,11 @@ MmioWrite16 (
   operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -464,11 +474,12 @@ MmioRead32 (
   and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \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 back to Mmio register\r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
@@ -500,10 +511,11 @@ MmioWrite32 (
   operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -534,11 +546,11 @@ MmioRead64 (
   and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \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 back to Mmio register\r
 **/\r
 UINT64\r
 EFIAPI\r