Minor grammatical work--mostly adding periods. Items with ONLY period added did...

[mirror_edk2.git] / MdePkg / Library / BaseMemoryLibOptPei / ScanMem8Wrapper.c

/** @file\r
  ScanMem8() and ScanMemN() implementation.\r
\r
  The following BaseMemoryLib instances contain the same copy of this file:\r
\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    BaseMemoryLibOptDxe\r
    BaseMemoryLibOptPei\r
    PeiMemoryLib\r
    UefiMemoryLib\r
\r
  Copyright (c) 2006 - 2010, 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
  Scans a target buffer for an 8-bit value, and returns a pointer to the matching 8-bit value\r
  in the target buffer.\r
\r
  This function searches the target buffer specified by Buffer and Length from the lowest\r
  address to the highest address for an 8-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
  \r
  If Length > 0 and Buffer is NULL, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
  @param  Buffer      The pointer to the target buffer to scan.\r
  @param  Length      The number of bytes in Buffer to scan.\r
  @param  Value       The 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
ScanMem8 (\r
  IN CONST VOID  *Buffer,\r
  IN UINTN       Length,\r
  IN UINT8       Value\r
  )\r
{\r
  if (Length == 0) {\r
    return NULL;\r
  }\r
  ASSERT (Buffer != NULL);\r
  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)Buffer));\r
 \r
  return (VOID*)InternalMemScanMem8 (Buffer, Length, Value);\r
}\r
\r
/**\r
  Scans a target buffer for a UINTN sized value, and returns a pointer to the matching \r
  UINTN sized value in the target buffer.\r
\r
  This function searches the target buffer specified by Buffer and Length from the lowest\r
  address to the highest address for a UINTN sized 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
  \r
  If Length > 0 and Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
  If Length is not aligned on a UINTN boundary, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
  @param  Buffer      The pointer to the target buffer to scan.\r
  @param  Length      The number of bytes in Buffer to scan.\r
  @param  Value       The 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
ScanMemN (\r
  IN CONST VOID  *Buffer,\r
  IN UINTN       Length,\r
  IN UINTN       Value\r
  )\r
{\r
  if (sizeof (UINTN) == sizeof (UINT64)) {\r
    return ScanMem64 (Buffer, Length, (UINT64)Value);\r
  } else {\r
    return ScanMem32 (Buffer, Length, (UINT32)Value);\r
  }\r
}\r
\r