Synchronize function comment in MdePkg\Library\BaseMemoryLib.h,CacheMaintenanceLib.h with the c file instance of this functions.

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

2 files changed, 19 insertions, 8 deletions

diff --git a/MdePkg/Include/Library/BaseMemoryLib.h b/MdePkg/Include/Library/BaseMemoryLib.h
index 973bc2b635..0247ddbb2d 100644
--- a/MdePkg/Include/Library/BaseMemoryLib.h
+++ b/MdePkg/Include/Library/BaseMemoryLib.h
@@ -1,11 +1,11 @@
 /** @file

   Provides copy memory, fill memory, zero memory, and GUID functions.

    

-  The Base Memory Library provides optimized implementions for common memory-based operations. 

+  The Base Memory Library provides optimized implementations for common memory-based operations. 

   These functions should be used in place of coding your own loops to do equivalent common functions. 

   This allows optimized library implementations to help increase performance. 

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -25,6 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns

   DestinationBuffer.  The implementation must be reentrant, and it must handle the case

   where SourceBuffer overlaps DestinationBuffer.

+  

   If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().

   If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().

 

@@ -47,6 +48,7 @@ CopyMem (
   Fills a target buffer with a byte value, and returns the target buffer.

 

   This function fills Length bytes of Buffer with Value, and returns Buffer.

+  

   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

 

   @param  Buffer    Memory to set.

@@ -149,6 +151,7 @@ SetMem64 (
   Fills a target buffer with zeros, and returns the target buffer.

 

   This function fills Length bytes of Buffer with zeros, and returns Buffer.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

 

@@ -172,6 +175,7 @@ ZeroMem (
   If all Length bytes of the two buffers are identical, then 0 is returned.  Otherwise, the

   value returned is the first mismatched byte in SourceBuffer subtracted from the first

   mismatched byte in DestinationBuffer.

+  

   If Length > 0 and DestinationBuffer is NULL, then ASSERT().

   If Length > 0 and SourceBuffer is NULL, then ASSERT().

   If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().

@@ -184,7 +188,7 @@ ZeroMem (
   @return 0                 All Length bytes of the two buffers are identical.

   @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first

                             mismatched byte in DestinationBuffer.

-

+                            

 **/

 INTN

 EFIAPI

@@ -202,6 +206,7 @@ CompareMem (
   address to the highest address for an 8-bit value that matches Value.  If a match is found,

   then a pointer to the matching byte in the target buffer is returned.  If no match is found,

   then NULL is returned.  If Length is 0, then NULL is returned.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

 

@@ -228,6 +233,7 @@ ScanMem8 (
   address to the highest address for a 16-bit value that matches Value.  If a match is found,

   then a pointer to the matching byte in the target buffer is returned.  If no match is found,

   then NULL is returned.  If Length is 0, then NULL is returned.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Buffer is not aligned on a 16-bit boundary, then ASSERT().

   If Length is not aligned on a 16-bit boundary, then ASSERT().

@@ -256,6 +262,7 @@ ScanMem16 (
   address to the highest address for a 32-bit value that matches Value.  If a match is found,

   then a pointer to the matching byte in the target buffer is returned.  If no match is found,

   then NULL is returned.  If Length is 0, then NULL is returned.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Buffer is not aligned on a 32-bit boundary, then ASSERT().

   If Length is not aligned on a 32-bit boundary, then ASSERT().

@@ -284,6 +291,7 @@ ScanMem32 (
   address to the highest address for a 64-bit value that matches Value.  If a match is found,

   then a pointer to the matching byte in the target buffer is returned.  If no match is found,

   then NULL is returned.  If Length is 0, then NULL is returned.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Buffer is not aligned on a 64-bit boundary, then ASSERT().

   If Length is not aligned on a 64-bit boundary, then ASSERT().

@@ -309,6 +317,7 @@ ScanMem64 (
 

   This function copies the contents of the 128-bit GUID specified by SourceGuid to

   DestinationGuid, and returns DestinationGuid.

+  

   If DestinationGuid is NULL, then ASSERT().

   If SourceGuid is NULL, then ASSERT().

 

@@ -330,6 +339,7 @@ CopyGuid (
 

   This function compares Guid1 to Guid2.  If the GUIDs are identical then TRUE is returned.

   If there are any bit differences in the two GUIDs, then FALSE is returned.

+  

   If Guid1 is NULL, then ASSERT().

   If Guid2 is NULL, then ASSERT().

 

@@ -356,6 +366,7 @@ CompareGuid (
   GUID value that matches Guid.  If a match is found, then a pointer to the matching

   GUID in the target buffer is returned.  If no match is found, then NULL is returned.

   If Length is 0, then NULL is returned.

+  

   If Length > 0 and Buffer is NULL, then ASSERT().

   If Buffer is not aligned on a 32-bit boundary, then ASSERT().

   If Length is not aligned on a 128-bit boundary, then ASSERT().

diff --git a/MdePkg/Include/Library/CacheMaintenanceLib.h b/MdePkg/Include/Library/CacheMaintenanceLib.h
index a5c690f804..247c702962 100644
--- a/MdePkg/Include/Library/CacheMaintenanceLib.h
+++ b/MdePkg/Include/Library/CacheMaintenanceLib.h
@@ -4,7 +4,7 @@
   The Cache Maintenance Library provides abstractions for basic processor cache operations.

   It removes the need to use assembly in C code.

     

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -54,7 +54,7 @@ InvalidateInstructionCache (
 

   @param  Length  The number of bytes to invalidate from the instruction cache.

 

-  @return Address

+  @return Address.

 

 **/

 VOID *

@@ -103,7 +103,7 @@ WriteBackInvalidateDataCache (
   @param  Length  The number of bytes to write back and invalidate from the

                   data cache.

 

-  @return Address

+  @return Address of cache invalidation.

 

 **/

 VOID *

@@ -151,7 +151,7 @@ WriteBackDataCache (
                   mode, then Address is a virtual address.

   @param  Length  The number of bytes to write back from the data cache.

 

-  @return Address

+  @return Address of cache written in main memory.

 

 **/

 VOID *

@@ -202,7 +202,7 @@ InvalidateDataCache (
                   then Address is a virtual address.

   @param  Length  The number of bytes to invalidate from the data cache.

 

-  @return Address

+  @return Address.

 

 **/

 VOID *