Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / BaseMemoryLibOptDxe / CompareMemWrapper.c

/** @file\r
  CompareMem() implementation.\r
\r
  The following BaseMemoryLib instances contain the same copy of this file:\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    BaseMemoryLibOptDxe\r
    BaseMemoryLibOptPei\r
    PeiMemoryLib\r
    UefiMemoryLib\r
\r
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "MemLibInternals.h"\r
\r
/**\r
  Compares the contents of two buffers.\r
\r
  This function compares Length bytes of SourceBuffer to Length bytes of DestinationBuffer.\r
  If all Length bytes of the two buffers are identical, then 0 is returned.  Otherwise, the\r
  value returned is the first mismatched byte in SourceBuffer subtracted from the first\r
  mismatched byte in DestinationBuffer.\r
  \r
  If Length > 0 and DestinationBuffer is NULL, then ASSERT().\r
  If Length > 0 and SourceBuffer is NULL, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
\r
  @param  DestinationBuffer Pointer to the destination buffer to compare.\r
  @param  SourceBuffer      Pointer to the source buffer to compare.\r
  @param  Length            Number of bytes to compare.\r
\r
  @return 0                 All Length bytes of the two buffers are identical.\r
  @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first\r
                            mismatched byte in DestinationBuffer.\r
                            \r
**/\r
INTN\r
EFIAPI\r
CompareMem (\r
  IN CONST VOID  *DestinationBuffer,\r
  IN CONST VOID  *SourceBuffer,\r
  IN UINTN       Length\r
  )\r
{\r
  if (Length == 0 || DestinationBuffer == SourceBuffer) {\r
    return 0;\r
  }\r
  ASSERT (DestinationBuffer != NULL);\r
  ASSERT (SourceBuffer != NULL);\r
  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)DestinationBuffer));\r
  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)SourceBuffer));\r
\r
  return InternalMemCompareMem (DestinationBuffer, SourceBuffer, Length);\r
}\r