remove unnecessary comments introduced by tools from MdePkg. The regular express...

[mirror_edk2.git] / MdePkg / Library / BaseMemoryLib / ScanMem64Wrapper.c

/** @file\r
  ScanMem64() implementation.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\r
  All rights reserved. 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
  The following BaseMemoryLib instances share the same version of this file:\r
\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    PeiMemoryLib\r
    DxeMemoryLib\r
\r
**/\r
\r
\r
\r
\r
#include "MemLibInternals.h"\r
\r
/**\r
  Scans a target buffer for a 64-bit value, and returns a pointer to the matching 64-bit value\r
  in the target buffer.\r
\r
  This function searches target the buffer specified by Buffer and Length from the lowest\r
  address to the highest address for a 64-bit value that matches Value.  If a match is found,\r
  then a pointer to the matching byte in the target buffer is returned.  If no match is found,\r
  then NULL is returned.  If Length is 0, then NULL is returned.\r
  If Length > 0 and Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
  If Length is not aligned on a 64-bit boundary, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
  @param  Buffer      Pointer to the target buffer to scan.\r
  @param  Length      Number of bytes in Buffer to scan.\r
  @param  Value       Value to search for in the target buffer.\r
\r
  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
\r
**/\r
VOID *\r
EFIAPI\r
ScanMem64 (\r
  IN CONST VOID  *Buffer,\r
  IN UINTN       Length,\r
  IN UINT64      Value\r
  )\r
{\r
  if (0 == Length) {\r
    return NULL;\r
  }\r
\r
  ASSERT (Buffer != NULL);\r
  ASSERT (0 == ((UINTN)Buffer & (sizeof (Value) - 1)));\r
  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)Buffer));\r
  ASSERT (0 == (Length & (sizeof (Value) - 1)));\r
\r
  return (VOID*)InternalMemScanMem64 (Buffer, Length / sizeof (Value), Value);\r
}\r