tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update function comments 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6922 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
tding1 2008-12-08 09:47:28 +00:00
parent 354aa8a288
commit 596cecff81
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c
View File

@ -248,6 +248,8 @@ IoWrite8 (
This function must guarantee that all I/O read and write operations are This function must guarantee that all I/O read and write operations are
serialized. 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(). If 16-bit I/O port operations are not supported, then ASSERT().
@param Port The I/O port to read. @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 and returns Value. This function must guarantee that all I/O read and write
operations are serialized. 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(). If 16-bit I/O port operations are not supported, then ASSERT().
@param Port The I/O port to write. @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. 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 This function must guarantee that all I/O read and write operations are
serialized. 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(). 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 and returns Value. This function must guarantee that all I/O read and write
operations are serialized. 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(). If 32-bit I/O port operations are not supported, then ASSERT().
@param Port The I/O port to write. @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 This function must guarantee that all I/O read and write operations are
serialized. 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(). If 64-bit I/O port operations are not supported, then ASSERT().
@param Port The I/O port to read. @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 and returns Value. This function must guarantee that all I/O read and write
operations are serialized. 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(). If 64-bit I/O port operations are not supported, then ASSERT().
@param Port The I/O port to write. @param Port The I/O port to write.
@ -462,6 +474,8 @@ MmioWrite8 (
returned. This function must guarantee that all MMIO read and write returned. This function must guarantee that all MMIO read and write
operations are serialized. 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(). If 16-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to read. @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 by Value and returns Value. This function must guarantee that all MMIO read
and write operations are serialized. 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(). If 16-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to write. @param Address The MMIO register to write.
@ -516,6 +532,8 @@ MmioWrite16 (
returned. This function must guarantee that all MMIO read and write returned. This function must guarantee that all MMIO read and write
operations are serialized. 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(). If 32-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to read. @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 by Value and returns Value. This function must guarantee that all MMIO read
and write operations are serialized. 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(). If 32-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to write. @param Address The MMIO register to write.
@ -570,6 +590,8 @@ MmioWrite32 (
returned. This function must guarantee that all MMIO read and write returned. This function must guarantee that all MMIO read and write
operations are serialized. 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(). If 64-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to read. @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 by Value and returns Value. This function must guarantee that all MMIO read
and write operations are serialized. 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(). If 64-bit MMIO register operations are not supported, then ASSERT().
@param Address The MMIO register to write. @param Address The MMIO register to write.

4
IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLibMmioBuffer.c
View File

@ -10,6 +10,8 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 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 greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
If Length is not aligned on a 16-bit boundary, 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(). If Buffer is not aligned on a 16-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied from. @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 greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
If Length is not aligned on a 64-bit boundary, 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(). If Buffer is not aligned on a 64-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied from. @param StartAddress Starting address for the MMIO region to be copied from.