MdePkg/Library/BaseMemoryLibOptDxe/ScanMem8Wrapper.c

   1 /** @file
   2   ScanMem8() implementation.
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   The following BaseMemoryLib instances share the same version of this file:
  14
  15     BaseMemoryLib
  16     BaseMemoryLibMmx
  17     BaseMemoryLibSse2
  18     BaseMemoryLibRepStr
  19     PeiMemoryLib
  20     DxeMemoryLib
  21
  22 **/
  23
  24
  25
  26
  27 #include "MemLibInternals.h"
  28
  29 /**
  30   Scans a target buffer for an 8-bit value, and returns a pointer to the matching 8-bit value
  31   in the target buffer.
  32
  33   This function searches target the buffer specified by Buffer and Length from the lowest
  34   address to the highest address for an 8-bit value that matches Value.  If a match is found,
  35   then a pointer to the matching byte in the target buffer is returned.  If no match is found,
  36   then NULL is returned.  If Length is 0, then NULL is returned.
  37   If Length > 0 and Buffer is NULL, then ASSERT().
  38   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
  39
  40   @param  Buffer      Pointer to the target buffer to scan.
  41   @param  Length      Number of bytes in Buffer to scan.
  42   @param  Value       Value to search for in the target buffer.
  43
  44   @return A pointer to the matching byte in the target buffer or NULL otherwise.
  45
  46 **/
  47 VOID *
  48 EFIAPI
  49 ScanMem8 (
  50   IN CONST VOID  *Buffer,
  51   IN UINTN       Length,
  52   IN UINT8       Value
  53   )
  54 {
  55   if (0 == Length) {
  56     return NULL;
  57   }
  58   ASSERT (Buffer != NULL);
  59   ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)Buffer));
  60
  61   return (VOID*)InternalMemScanMem8 (Buffer, Length, Value);
  62 }