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

9 files changed, 45 insertions, 53 deletions

diff --git a/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c
index 287b84c0dc..052851e7c0 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c
@@ -11,20 +11,17 @@
     PeiMemoryLib

     DxeMemoryLib

 

-  Copyright (c) 2006, 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

-  http://opensource.org/licenses/bsd-license.php

+Copyright (c) 2006, Intel Corporation

+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

+http://opensource.org/licenses/bsd-license.php

 

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -34,11 +31,11 @@
   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(). 

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

-

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

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

 

   @param  DestinationBuffer Pointer to the destination buffer to compare.

   @param  SourceBuffer      Pointer to the source buffer to compare.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/CopyMemWrapper.c b/MdePkg/Library/BaseMemoryLibSse2/CopyMemWrapper.c
index 1cccde8ed8..831e491b50 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/CopyMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/CopyMemWrapper.c
@@ -2,6 +2,7 @@
   CopyMem() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+  

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,9 +23,6 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -33,8 +31,9 @@
   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(). 

+  

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

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

 

   @param  DestinationBuffer   Pointer to the destination buffer of the memory copy.

   @param  SourceBuffer        Pointer to the source buffer of the memory copy.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/MemLibGuid.c b/MdePkg/Library/BaseMemoryLibSse2/MemLibGuid.c
index c5429d47b3..92e0c0549f 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/MemLibGuid.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/MemLibGuid.c
@@ -2,6 +2,7 @@
   Implementation of GUID functions.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+  

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,7 +23,6 @@
 

 **/

 

-

 #include "MemLibInternals.h"

 

 /**

@@ -30,6 +30,7 @@
 

   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().

 

@@ -62,6 +63,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().

 

@@ -101,10 +103,11 @@ 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().

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

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

 

   @param  Buffer  Pointer to the target buffer to scan.

   @param  Length  Number of bytes in Buffer to scan.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/ScanMem16Wrapper.c b/MdePkg/Library/BaseMemoryLibSse2/ScanMem16Wrapper.c
index 4146dc5a1b..e7128e90d4 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/ScanMem16Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/ScanMem16Wrapper.c
@@ -2,6 +2,7 @@
   ScanMem16() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,9 +23,6 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -35,10 +33,11 @@
   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().

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

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

 

   @param  Buffer      Pointer to the target buffer to scan.

   @param  Length      Number of bytes in Buffer to scan.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/ScanMem32Wrapper.c b/MdePkg/Library/BaseMemoryLibSse2/ScanMem32Wrapper.c
index 28a8342f7f..7683910e80 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/ScanMem32Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/ScanMem32Wrapper.c
@@ -11,7 +11,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,9 +22,6 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -35,10 +32,11 @@
   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().

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

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

 

   @param  Buffer      Pointer to the target buffer to scan.

   @param  Length      Number of bytes in Buffer to scan.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/ScanMem64Wrapper.c b/MdePkg/Library/BaseMemoryLibSse2/ScanMem64Wrapper.c
index 51e5ef4682..e3b2688681 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/ScanMem64Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/ScanMem64Wrapper.c
@@ -2,6 +2,7 @@
   ScanMem64() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,9 +23,6 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -35,10 +33,11 @@
   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().

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

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

 

   @param  Buffer      Pointer to the target buffer to scan.

   @param  Length      Number of bytes in Buffer to scan.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/ScanMem8Wrapper.c b/MdePkg/Library/BaseMemoryLibSse2/ScanMem8Wrapper.c
index 16fda04d74..d17b3a7943 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/ScanMem8Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/ScanMem8Wrapper.c
@@ -2,6 +2,7 @@
   ScanMem8() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,9 +23,6 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

@@ -35,8 +33,9 @@
   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(). 

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

 

   @param  Buffer      Pointer to the target buffer to scan.

   @param  Length      Number of bytes in Buffer to scan.

diff --git a/MdePkg/Library/BaseMemoryLibSse2/SetMemWrapper.c b/MdePkg/Library/BaseMemoryLibSse2/SetMemWrapper.c
index b507c691f4..18fbcdc18a 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/SetMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/SetMemWrapper.c
@@ -2,6 +2,7 @@
   SetMem() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -11,7 +12,7 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+  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

@@ -22,20 +23,18 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

   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(). 

+  

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

 

   @param  Buffer    Memory to set.

   @param  Length    Number of bytes to set.

-  @param  Value     Value of the set operation.

+  @param  Value     Value with which to fill Length bytes of Buffer.

 

   @return Buffer.

 

diff --git a/MdePkg/Library/BaseMemoryLibSse2/ZeroMemWrapper.c b/MdePkg/Library/BaseMemoryLibSse2/ZeroMemWrapper.c
index 6d8207a002..5f8df5b619 100644
--- a/MdePkg/Library/BaseMemoryLibSse2/ZeroMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibSse2/ZeroMemWrapper.c
@@ -2,6 +2,7 @@
   ZeroMem() implementation.

 

   The following BaseMemoryLib instances contain the same copy of this file:

+

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -10,8 +11,8 @@
     BaseMemoryLibOptPei

     PeiMemoryLib

     DxeMemoryLib

-

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

+    

+  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

@@ -22,15 +23,13 @@
 

 **/

 

-

-

-

 #include "MemLibInternals.h"

 

 /**

   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().