From 38bbd3d91c38481d18c1a7e2049473c951ee98ed Mon Sep 17 00:00:00 2001 From: yshang1 Date: Tue, 8 Jul 2008 09:38:43 +0000 Subject: Code scrub: MdePkg/Library/BaseCacheMaintenanceLib MdePkg/Library/BaseDebugLibNull MdePkg/Library/BaseIoLibIntrinsic MdePkg/Library/BaseLib MdePkg/Library/BaseMemoryLib MdePkg/Library/BaseMemoryLibMmx MdePkg/Library/BaseMemoryLibOptDxe MdePkg/Library/BaseMemoryLibOptPei MdePkg/Library/BaseMemoryLibRepStr MdePkg/Library/BaseMemoryLibSse2 MdePkg/Library/BasePeCoffGetEntryPointLib git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5426 6f19259b-4bc3-4df7-8a09-765794883524 --- .../BaseIoLibIntrinsicInternal.h | 6 +-- MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c | 24 +++++++---- MdePkg/Library/BaseIoLibIntrinsic/IoLib.c | 7 +--- MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c | 38 ++++++++++++----- MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c | 44 ++++++++++++++------ MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c | 48 ++++++++++++++-------- .../Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c | 11 ++--- MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c | 31 ++++++++++---- 8 files changed, 139 insertions(+), 70 deletions(-) (limited to 'MdePkg/Library/BaseIoLibIntrinsic') diff --git a/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicInternal.h b/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicInternal.h index 1a8cc27c56..4a29835ea3 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicInternal.h +++ b/MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicInternal.h @@ -1,7 +1,7 @@ /**@file Common header file shared by all source files. - This file includes package header files, library classes and protocol, PPI & GUID definitions. + This file includes package header files, dependent library classes. Copyright (c) 2007, Intel Corporation. All rights reserved. This program and the accompanying materials @@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ -#ifndef __COMMON_HEADER_H_ -#define __COMMON_HEADER_H_ +#ifndef __BASEIOLIB_INTRINSIC_INTERNAL_H_ +#define __BASEIOLIB_INTRINSIC_INTERNAL_H_ diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c index bc5d4aab89..4e5a738155 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c @@ -130,7 +130,8 @@ IoAndThenOr8 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..7. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT8 @@ -410,7 +411,8 @@ IoAndThenOr16 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..15. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT16 @@ -690,7 +692,8 @@ IoAndThenOr32 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..31. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT32 @@ -970,7 +973,8 @@ IoAndThenOr64 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..63. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT64 @@ -1251,7 +1255,8 @@ MmioAndThenOr8 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..7. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT8 @@ -1533,7 +1538,8 @@ MmioAndThenOr16 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..15. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT16 @@ -1815,7 +1821,8 @@ MmioAndThenOr32 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..31. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT32 @@ -2097,7 +2104,8 @@ MmioAndThenOr64 ( @param EndBit The ordinal of the most significant bit in the bit field. Range 0..63. - @return The value read. + @return The value read from I/O port specified by StartBit and + EndBit. **/ UINT64 diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLib.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLib.c index 25efcd2e60..86efa6db6a 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLib.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLib.c @@ -12,9 +12,6 @@ **/ -// -// Include common header file for this module. -// #include "BaseIoLibIntrinsicInternal.h" /** @@ -28,7 +25,7 @@ @param Port The I/O port to read. - @return The value read. + @return Always return zero. **/ UINT64 @@ -53,7 +50,7 @@ IoRead64 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return Always return zero. **/ UINT64 diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c index c28ad56624..db94f0f47e 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c @@ -37,7 +37,7 @@ @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT8 @@ -61,6 +61,9 @@ MmioRead8 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT8 EFIAPI @@ -83,7 +86,7 @@ MmioWrite8 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT16 @@ -108,6 +111,9 @@ MmioRead16 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT16 EFIAPI @@ -131,7 +137,7 @@ MmioWrite16 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT32 @@ -156,6 +162,9 @@ MmioRead32 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT32 EFIAPI @@ -179,7 +188,7 @@ MmioWrite32 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT64 @@ -204,6 +213,9 @@ MmioRead64 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT64 EFIAPI @@ -229,7 +241,7 @@ MmioWrite64 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ __inline__ @@ -257,7 +269,9 @@ IoRead8 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ __inline__ @@ -283,7 +297,7 @@ IoWrite8 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ __inline__ @@ -312,7 +326,9 @@ IoRead16 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ __inline__ @@ -339,7 +355,7 @@ IoWrite16 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ __inline__ @@ -368,7 +384,9 @@ IoRead32 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ __inline__ diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c index d12ce3de90..c83fe8838d 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c @@ -13,9 +13,6 @@ **/ -// -// Include common header file for this module. -// #include "BaseIoLibIntrinsicInternal.h" /** @@ -29,7 +26,7 @@ @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT8 @@ -52,6 +49,10 @@ MmioRead8 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT8 @@ -75,7 +76,7 @@ MmioWrite8 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT16 @@ -99,6 +100,10 @@ MmioRead16 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT16 @@ -123,7 +128,7 @@ MmioWrite16 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT32 @@ -147,6 +152,10 @@ MmioRead32 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT32 @@ -171,7 +180,7 @@ MmioWrite32 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT64 @@ -196,6 +205,9 @@ MmioRead64 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT64 EFIAPI @@ -221,7 +233,7 @@ MmioWrite64 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT8 @@ -253,7 +265,9 @@ IoRead8 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the input + Value instead of the actual value read back from the + I/O port. **/ UINT8 @@ -282,7 +296,7 @@ IoWrite8 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT16 @@ -316,7 +330,9 @@ IoRead16 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the input + Value instead of the actual value read back from the + I/O port. **/ UINT16 @@ -351,7 +367,7 @@ IoWrite16 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT32 @@ -385,7 +401,9 @@ IoRead32 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the input + Value instead of the actual value read back from the + I/O port. **/ UINT32 diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c index 23ca5c68ed..8eec29551f 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c @@ -61,7 +61,7 @@ InternalGetMemoryMapAddress ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT8 @@ -82,7 +82,7 @@ IoRead8 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT16 @@ -103,7 +103,7 @@ IoRead16 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT32 @@ -126,7 +126,7 @@ IoRead32 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT64 @@ -149,7 +149,9 @@ IoRead64 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ UINT8 @@ -172,7 +174,9 @@ IoWrite8 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ UINT16 @@ -195,7 +199,9 @@ IoWrite16 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ UINT32 @@ -220,7 +226,9 @@ IoWrite32 ( @param Port The I/O port to write. @param Value The value to write to the I/O port. - @return The value written the I/O port. + @return The value written to the I/O port. It equals to the + input Value instead of the actual value read back from + the I/O port. **/ UINT64 @@ -243,7 +251,7 @@ IoWrite64 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT8 @@ -272,7 +280,7 @@ MmioRead8 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT16 @@ -306,7 +314,7 @@ MmioRead16 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT32 @@ -340,7 +348,7 @@ MmioRead32 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT64 @@ -376,7 +384,9 @@ MmioRead64 ( @param Address The MMIO register to write. @param Data The value to write to the MMIO register. - @return The value written the memory address. + @return The value written to the Mmio. It equals to the + input Value instead of the actual value read back from + the Mmio. **/ UINT8 @@ -405,7 +415,9 @@ MmioWrite8 ( @param Address The MMIO register to write. @param Data The value to write to the MMIO register. - @return The value written the memory address. + @return The value written to the Mmio. It equals to the + input Value instead of the actual value read back from + the Mmio. **/ UINT16 @@ -439,7 +451,9 @@ MmioWrite16 ( @param Address The MMIO register to write. @param Data The value to write to the MMIO register. - @return The value written the memory address. + @return The value written to the Mmio. It equals to the + input Value instead of the actual value read back from + the Mmio. **/ UINT32 @@ -473,7 +487,9 @@ MmioWrite32 ( @param Address The MMIO register to write. @param Data The value to write to the MMIO register. - @return The value written the memory address. + @return The value written to the Mmio. It equals to the + input Value instead of the actual value read back from + the Mmio. **/ UINT64 diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c index 4569a166e7..20c4693f3a 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c @@ -12,9 +12,6 @@ **/ -// -// Include common header file for this module. -// #include "BaseIoLibIntrinsicInternal.h" /** @@ -32,7 +29,7 @@ @param Length Size in bytes of the copy. @param Buffer Pointer to a system memory buffer receiving the data read. - @return Buffer + @return Buffer contains the data read from Mmio. **/ UINT8 * @@ -76,7 +73,7 @@ MmioReadBuffer8 ( @param Length Size in bytes of the copy. @param Buffer Pointer to a system memory buffer receiving the data read. - @return Buffer + @return Buffer contains the data read from Mmio. **/ UINT16 * @@ -127,7 +124,7 @@ MmioReadBuffer16 ( @param Length Size in bytes of the copy. @param Buffer Pointer to a system memory buffer receiving the data read. - @return Buffer + @return Buffer contains the data read from Mmio. **/ UINT32 * @@ -178,7 +175,7 @@ MmioReadBuffer32 ( @param Length Size in bytes of the copy. @param Buffer Pointer to a system memory buffer receiving the data read. - @return Buffer + @return Buffer contains the data read from Mmio. **/ UINT64 * diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c index 9fec1bcae9..1e903a7e25 100644 --- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c +++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c @@ -63,7 +63,7 @@ void _ReadWriteBarrier (void); @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT8 @@ -119,7 +119,7 @@ IoWrite8 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT16 @@ -177,7 +177,7 @@ IoWrite16 ( @param Port The I/O port to read. - @return The value read. + @return The value read from Port. **/ UINT32 @@ -236,7 +236,7 @@ IoWrite32 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT8 @@ -262,7 +262,11 @@ MmioRead8 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. - + + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. + **/ UINT8 EFIAPI @@ -285,7 +289,7 @@ MmioWrite8 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT16 @@ -312,6 +316,9 @@ MmioRead16 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + + @return The value read from the Mmio after wrote specified + Value. **/ UINT16 @@ -336,7 +343,7 @@ MmioWrite16 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT32 @@ -363,6 +370,10 @@ MmioRead32 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. **/ UINT32 @@ -387,7 +398,7 @@ MmioWrite32 ( @param Address The MMIO register to read. - @return The value read. + @return The value read from Address. **/ UINT64 @@ -415,6 +426,10 @@ MmioRead64 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. + @return The value written to the Mmio. It equals to the input + Value instead of the actual value read back from the + Mmio. + **/ UINT64 EFIAPI -- cgit v1.2.3