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, 99 insertions, 116 deletions

diff --git a/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c
index 40edda418d..6ee6857857 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c
@@ -1,15 +1,6 @@
 /** @file

   CompareMem() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

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

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -35,17 +32,17 @@
   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.

   @param  Length            Number of bytes to compare.

 

-  @retval 0                 All Length bytes of the two buffers are identical.

+  @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.

 

diff --git a/MdePkg/Library/BaseMemoryLibOptPei/CopyMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/CopyMemWrapper.c
index 42335277a1..831e491b50 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/CopyMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/CopyMemWrapper.c
@@ -1,17 +1,8 @@
 /** @file

   CopyMem() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

-

+  

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -34,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/BaseMemoryLibOptPei/MemLibGuid.c b/MdePkg/Library/BaseMemoryLibOptPei/MemLibGuid.c
index b2aefa9855..92e0c0549f 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/MemLibGuid.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/MemLibGuid.c
@@ -1,17 +1,8 @@
 /** @file

   Implementation of GUID functions.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

-

+  

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -21,17 +12,25 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

+  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

+  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.

 

-#include "MemLibInternals.h"

+**/

 

+#include "MemLibInternals.h"

 

 /**

   Copies a source GUID to a destination GUID.

 

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

 

@@ -64,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().

 

@@ -103,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/BaseMemoryLibOptPei/ScanMem16Wrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem16Wrapper.c
index 3161c91278..e7128e90d4 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/ScanMem16Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem16Wrapper.c
@@ -1,15 +1,6 @@
 /** @file

   ScanMem16() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -36,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/BaseMemoryLibOptPei/ScanMem32Wrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem32Wrapper.c
index 939de99b3d..7683910e80 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/ScanMem32Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem32Wrapper.c
@@ -1,17 +1,7 @@
 /** @file

   ScanMem32() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

-

     BaseMemoryLib

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -21,10 +11,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -36,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/BaseMemoryLibOptPei/ScanMem64Wrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem64Wrapper.c
index 099da5dc04..e3b2688681 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/ScanMem64Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem64Wrapper.c
@@ -1,15 +1,6 @@
 /** @file

   ScanMem64() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -36,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/BaseMemoryLibOptPei/ScanMem8Wrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem8Wrapper.c
index d66b1a2666..d17b3a7943 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/ScanMem8Wrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/ScanMem8Wrapper.c
@@ -1,15 +1,6 @@
 /** @file

   ScanMem8() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -36,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/BaseMemoryLibOptPei/SetMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/SetMemWrapper.c
index 10224f73b8..18fbcdc18a 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/SetMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/SetMemWrapper.c
@@ -1,15 +1,6 @@
 /** @file

   SetMem() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -21,10 +12,16 @@
     PeiMemoryLib

     DxeMemoryLib

 

-**/

-

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -32,11 +29,12 @@
   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/BaseMemoryLibOptPei/ZeroMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/ZeroMemWrapper.c
index 9f027359bb..11187ba13a 100644
--- a/MdePkg/Library/BaseMemoryLibOptPei/ZeroMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibOptPei/ZeroMemWrapper.c
@@ -1,15 +1,6 @@
 /** @file

   ZeroMem() implementation.

 

-  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

-

-  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 following BaseMemoryLib instances contain the same copy of this file:

 

     BaseMemoryLib

@@ -20,11 +11,17 @@
     BaseMemoryLibOptPei

     PeiMemoryLib

     DxeMemoryLib

+    

+  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

+  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.

 

+**/

 

 #include "MemLibInternals.h"

 

@@ -32,6 +29,7 @@
   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().