X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FLibrary%2FBaseMemoryLibRepStr%2FCompareMemWrapper.c;h=031b7fcec6456ad767d735d05b4ab9f71a632611;hb=38bbd3d91c38481d18c1a7e2049473c951ee98ed;hp=c8199d8dc31cb2badd25ee641ade2fb443fddf91;hpb=24de7645e857287d096b058f7a64fb7f618c0194;p=mirror_edk2.git

diff --git a/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c
index c8199d8dc3..031b7fcec6 100644
--- a/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-  Module Name:  CompareMemWrapper.c
-
   The following BaseMemoryLib instances share the same version of this file:
 
     BaseMemoryLib
@@ -19,49 +17,54 @@
     BaseMemoryLibSse2
     BaseMemoryLibRepStr
     PeiMemoryLib
-    UefiMemoryLib
+    DxeMemoryLib
 
 **/
 
+//
+// Include common header file for this module.
+//
+
+
 #include "MemLibInternals.h"
 
 /**
-  Compares two memory buffers of a given length.
+  Compares the contents of two buffers.
 
-  This function compares Length bytes of SourceBuffer to Length bytes of
-  DestinationBuffer. 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.
+  This function compares Length bytes of SourceBuffer to Length bytes of DestinationBuffer.
+  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 and Length > 0, then ASSERT().
+  If Length > 0 and SourceBuffer is NULL and Length > 0, 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 DestinationBuffer is NULL and Length > 0, then ASSERT().
-  If SourceBuffer is NULL and Length > 0, 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 First memory buffer
-  @param  SourceBuffer      Second memory buffer
-  @param  Length            Length of DestinationBuffer and SourceBuffer memory
-                            regions to compare
+  @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         if DestinationBuffer == SourceBuffer
-  @retval Non-zero  if DestinationBuffer != SourceBuffer
+  @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
 CompareMem (
-  IN      CONST VOID                *DestinationBuffer,
-  IN      CONST VOID                *SourceBuffer,
-  IN      UINTN                     Length
+  IN CONST VOID  *DestinationBuffer,
+  IN CONST VOID  *SourceBuffer,
+  IN UINTN       Length
   )
 {
-  ASSERT (DestinationBuffer != NULL);
-  ASSERT (SourceBuffer != NULL);
-  ASSERT (Length <= MAX_ADDRESS - (UINTN)DestinationBuffer + 1);
-  ASSERT (Length <= MAX_ADDRESS - (UINTN)SourceBuffer + 1);
-  if (Length == 0) {
+  if (0 == Length) {
     return 0;
   }
+  ASSERT (DestinationBuffer != NULL);
+  ASSERT (SourceBuffer != NULL);
+  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)DestinationBuffer));
+  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)SourceBuffer));
+
   return InternalMemCompareMem (DestinationBuffer, SourceBuffer, Length);
 }