From: tding1 <tding1@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Mon, 8 Dec 2008 09:47:28 +0000 (+0000)
Subject: update function comments
X-Git-Tag: edk2-stable201903~19324
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=596cecff81b6a3af9db5f7f5f029a55788977baa

update function comments

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

diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c
index d4768b25f0..ff0e323291 100644
--- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c
+++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c
@@ -248,6 +248,8 @@ IoWrite8 (
   This function must guarantee that all I/O read and write operations are
   serialized.
 
+  If Port is not aligned on a 16-bit boundary, then ASSERT().
+ 
   If 16-bit I/O port operations are not supported, then ASSERT().
 
   @param  Port  The I/O port to read.
@@ -275,6 +277,8 @@ IoRead16 (
   and returns Value. This function must guarantee that all I/O read and write
   operations are serialized.
 
+  If Port is not aligned on a 16-bit boundary, then ASSERT().
+
   If 16-bit I/O port operations are not supported, then ASSERT().
 
   @param  Port  The I/O port to write.
@@ -303,6 +307,8 @@ IoWrite16 (
   Reads the 32-bit I/O port specified by Port. The 32-bit read value is returned.
   This function must guarantee that all I/O read and write operations are
   serialized.
+ 
+  If Port is not aligned on a 32-bit boundary, then ASSERT().
 
   If 32-bit I/O port operations are not supported, then ASSERT().
 
@@ -331,6 +337,8 @@ IoRead32 (
   and returns Value. This function must guarantee that all I/O read and write
   operations are serialized.
 
+  If Port is not aligned on a 32-bit boundary, then ASSERT().
+
   If 32-bit I/O port operations are not supported, then ASSERT().
 
   @param  Port  The I/O port to write.
@@ -360,6 +368,8 @@ IoWrite32 (
   This function must guarantee that all I/O read and write operations are
   serialized.
 
+  If Port is not aligned on a 64-bit boundary, then ASSERT().
+
   If 64-bit I/O port operations are not supported, then ASSERT().
 
   @param  Port  The I/O port to read.
@@ -387,6 +397,8 @@ IoRead64 (
   and returns Value. This function must guarantee that all I/O read and write
   operations are serialized.
 
+  If Port is not aligned on a 64-bit boundary, then ASSERT().
+ 
   If 64-bit I/O port operations are not supported, then ASSERT().
 
   @param  Port  The I/O port to write.
@@ -462,6 +474,8 @@ MmioWrite8 (
   returned. This function must guarantee that all MMIO read and write
   operations are serialized.
 
+  If Address is not aligned on a 16-bit boundary, then ASSERT().
+ 
   If 16-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to read.
@@ -489,6 +503,8 @@ MmioRead16 (
   by Value and returns Value. This function must guarantee that all MMIO read
   and write operations are serialized.
 
+  If Address is not aligned on a 16-bit boundary, then ASSERT().
+ 
   If 16-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to write.
@@ -516,6 +532,8 @@ MmioWrite16 (
   returned. This function must guarantee that all MMIO read and write
   operations are serialized.
 
+  If Address is not aligned on a 32-bit boundary, then ASSERT().
+  
   If 32-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to read.
@@ -543,6 +561,8 @@ MmioRead32 (
   by Value and returns Value. This function must guarantee that all MMIO read
   and write operations are serialized.
 
+  If Address is not aligned on a 32-bit boundary, then ASSERT().
+ 
   If 32-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to write.
@@ -570,6 +590,8 @@ MmioWrite32 (
   returned. This function must guarantee that all MMIO read and write
   operations are serialized.
 
+  If Address is not aligned on a 64-bit boundary, then ASSERT().
+ 
   If 64-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to read.
@@ -597,6 +619,8 @@ MmioRead64 (
   by Value and returns Value. This function must guarantee that all MMIO read
   and write operations are serialized.
 
+  If Address is not aligned on a 64-bit boundary, then ASSERT().
+ 
   If 64-bit MMIO register operations are not supported, then ASSERT().
 
   @param  Address The MMIO register to write.
diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLibMmioBuffer.c b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLibMmioBuffer.c
index f43db07fe6..d59e49cc41 100644
--- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLibMmioBuffer.c
+++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLibMmioBuffer.c
@@ -10,6 +10,8 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
+  Module Name:  IoLibMmioBuffer.c
+
 **/
 
 
@@ -68,6 +70,7 @@ MmioReadBuffer8 (
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 
   If Length is not aligned on a 16-bit boundary, then ASSERT().
+  
   If Buffer is not aligned on a 16-bit boundary, then ASSERT().
 
   @param  StartAddress    Starting address for the MMIO region to be copied from.
@@ -170,6 +173,7 @@ MmioReadBuffer32 (
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 
   If Length is not aligned on a 64-bit boundary, then ASSERT().
+ 
   If Buffer is not aligned on a 64-bit boundary, then ASSERT().
 
   @param  StartAddress    Starting address for the MMIO region to be copied from.