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, 96 insertions, 89 deletions

diff --git a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c
index 665809bbe1..34d8a47d84 100644
--- a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c
@@ -1,17 +1,7 @@
 /** @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

     BaseMemoryLibMmx

     BaseMemoryLibSse2

@@ -21,6 +11,15 @@
     PeiMemoryLib

     DxeMemoryLib

 

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

+

 **/

 

 #include "MemLibInternals.h"

@@ -32,12 +31,12 @@
   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().

 

-

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

@@ -45,7 +44,7 @@
   @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

diff --git a/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c b/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c
index bda1589728..b7e8d7a651 100644
--- a/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c
@@ -1,15 +1,6 @@
 /** @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

@@ -21,6 +12,15 @@
     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"

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

 

diff --git a/MdePkg/Library/PeiMemoryLib/MemLibGuid.c b/MdePkg/Library/PeiMemoryLib/MemLibGuid.c
index bfa56e25e7..92e0c0549f 100644
--- a/MdePkg/Library/PeiMemoryLib/MemLibGuid.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +12,15 @@
     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"

@@ -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,6 +103,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/Library/PeiMemoryLib/ScanMem16Wrapper.c b/MdePkg/Library/PeiMemoryLib/ScanMem16Wrapper.c
index 33f2bc59df..e7128e90d4 100644
--- a/MdePkg/Library/PeiMemoryLib/ScanMem16Wrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +12,15 @@
     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"

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

diff --git a/MdePkg/Library/PeiMemoryLib/ScanMem32Wrapper.c b/MdePkg/Library/PeiMemoryLib/ScanMem32Wrapper.c
index db05554899..7683910e80 100644
--- a/MdePkg/Library/PeiMemoryLib/ScanMem32Wrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +11,15 @@
     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"

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

diff --git a/MdePkg/Library/PeiMemoryLib/ScanMem64Wrapper.c b/MdePkg/Library/PeiMemoryLib/ScanMem64Wrapper.c
index 51ebd92f87..e3b2688681 100644
--- a/MdePkg/Library/PeiMemoryLib/ScanMem64Wrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +12,15 @@
     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"

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

diff --git a/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c b/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c
index 53ad70a4b8..cb20763b03 100644
--- a/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,8 +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"

 

 /**

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

 

diff --git a/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c b/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c
index 73ad99d879..18fbcdc18a 100644
--- a/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +12,15 @@
     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"

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

 

   @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/PeiMemoryLib/ZeroMemWrapper.c b/MdePkg/Library/PeiMemoryLib/ZeroMemWrapper.c
index 4f1ff33701..5f8df5b619 100644
--- a/MdePkg/Library/PeiMemoryLib/ZeroMemWrapper.c
+++ b/MdePkg/Library/PeiMemoryLib/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,6 +11,15 @@
     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.

 

 **/

 

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