MdePkg/Library/UefiMemoryLib/MemLibInternals.h

   1 /** @file
   2   Declaration of internal functions for Base Memory Library.
   3
   4   Copyright (c) 2006 - 2008, 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 contain the same copy of this file:
  14
  15     BaseMemoryLib
  16     BaseMemoryLibMmx
  17     BaseMemoryLibSse2
  18     BaseMemoryLibRepStr
  19     BaseMemoryLibOptDxe
  20     BaseMemoryLibOptPei
  21     PeiMemoryLib
  22     DxeMemoryLib
  23
  24 **/
  25
  26 #ifndef __MEM_LIB_INTERNALS__
  27 #define __MEM_LIB_INTERNALS__
  28
  29
  30 #include <Uefi.h>
  31
  32
  33 #include <Library/BaseMemoryLib.h>
  34 #include <Library/DebugLib.h>
  35 #include <Library/UefiBootServicesTableLib.h>
  36 #include <Library/BaseLib.h>
  37
  38 /**
  39   Copies a source buffer to a destination buffer, and returns the destination buffer.
  40
  41   This function wraps the gBS->CopyMem().
  42
  43   @param  DestinationBuffer   Pointer to the destination buffer of the memory copy.
  44   @param  SourceBuffer        Pointer to the source buffer of the memory copy.
  45   @param  Length              Number of bytes to copy from SourceBuffer to DestinationBuffer.
  46
  47   @return DestinationBuffer.
  48
  49 **/
  50 VOID *
  51 EFIAPI
  52 InternalMemCopyMem (
  53   OUT     VOID                      *Destination,
  54   IN      CONST VOID                *Source,
  55   IN      UINTN                     Length
  56   );
  57
  58 /**
  59   Fills a target buffer with a byte value, and returns the target buffer.
  60
  61   This function wraps the gBS->SetMem().
  62
  63   @param  Buffer    Memory to set.
  64   @param  Size      Number of bytes to set.
  65   @param  Value     Value of the set operation.
  66
  67   @return Buffer.
  68
  69 **/
  70 VOID *
  71 EFIAPI
  72 InternalMemSetMem (
  73   OUT     VOID                      *Buffer,
  74   IN      UINTN                     Size,
  75   IN      UINT8                     Value
  76   );
  77
  78 /**
  79   Fills a target buffer with a 16-bit value, and returns the target buffer.
  80
  81   @param  Buffer  Pointer to the target buffer to fill.
  82   @param  Length  Number of bytes in Buffer to fill.
  83   @param  Value   Value with which to fill Length bytes of Buffer.
  84
  85   @return Buffer
  86
  87 **/
  88 VOID *
  89 EFIAPI
  90 InternalMemSetMem16 (
  91   OUT     VOID                      *Buffer,
  92   IN      UINTN                     Length,
  93   IN      UINT16                    Value
  94   );
  95
  96 /**
  97   Fills a target buffer with a 32-bit value, and returns the target buffer.
  98
  99   @param  Buffer  Pointer to the target buffer to fill.
 100   @param  Length  Number of bytes in Buffer to fill.
 101   @param  Value   Value with which to fill Length bytes of Buffer.
 102
 103   @return Buffer
 104
 105 **/
 106 VOID *
 107 EFIAPI
 108 InternalMemSetMem32 (
 109   OUT     VOID                      *Buffer,
 110   IN      UINTN                     Length,
 111   IN      UINT32                    Value
 112   );
 113
 114 /**
 115   Fills a target buffer with a 64-bit value, and returns the target buffer.
 116
 117   @param  Buffer  Pointer to the target buffer to fill.
 118   @param  Length  Number of bytes in Buffer to fill.
 119   @param  Value   Value with which to fill Length bytes of Buffer.
 120
 121   @return Buffer
 122
 123 **/
 124 VOID *
 125 EFIAPI
 126 InternalMemSetMem64 (
 127   OUT     VOID                      *Buffer,
 128   IN      UINTN                     Length,
 129   IN      UINT64                    Value
 130   );
 131
 132 /**
 133   Set Buffer to 0 for Size bytes.
 134
 135   @param  Buffer Memory to set.
 136   @param  Length Number of bytes to set
 137
 138   @return Buffer
 139
 140 **/
 141 VOID *
 142 EFIAPI
 143 InternalMemZeroMem (
 144   OUT     VOID                      *Buffer,
 145   IN      UINTN                     Length
 146   );
 147
 148 /**
 149   Compares two memory buffers of a given length.
 150
 151   @param  DestinationBuffer First memory buffer
 152   @param  SourceBuffer      Second memory buffer
 153   @param  Length            Length of DestinationBuffer and SourceBuffer memory
 154                             regions to compare. Must be non-zero.
 155
 156   @return 0                 All Length bytes of the two buffers are identical.
 157   @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first
 158                             mismatched byte in DestinationBuffer.
 159
 160 **/
 161 INTN
 162 EFIAPI
 163 InternalMemCompareMem (
 164   IN      CONST VOID                *DestinationBuffer,
 165   IN      CONST VOID                *SourceBuffer,
 166   IN      UINTN                     Length
 167   );
 168
 169 /**
 170   Scans a target buffer for an 8-bit value, and returns a pointer to the
 171   matching 8-bit value in the target buffer.
 172
 173   @param  Buffer  Pointer to the target buffer to scan.
 174   @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
 175   @param  Value   Value to search for in the target buffer.
 176
 177   @return Pointer to the first occurrence or NULL if not found.
 178
 179 **/
 180 CONST VOID *
 181 EFIAPI
 182 InternalMemScanMem8 (
 183   IN      CONST VOID                *Buffer,
 184   IN      UINTN                     Length,
 185   IN      UINT8                     Value
 186   );
 187
 188 /**
 189   Scans a target buffer for a 16-bit value, and returns a pointer to the
 190   matching 16-bit value in the target buffer.
 191
 192   @param  Buffer  Pointer to the target buffer to scan.
 193   @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
 194   @param  Value   Value to search for in the target buffer.
 195
 196   @return Pointer to the first occurrence or NULL if not found.
 197
 198 **/
 199 CONST VOID *
 200 EFIAPI
 201 InternalMemScanMem16 (
 202   IN      CONST VOID                *Buffer,
 203   IN      UINTN                     Length,
 204   IN      UINT16                    Value
 205   );
 206
 207 /**
 208   Scans a target buffer for a 32-bit value, and returns a pointer to the
 209   matching 32-bit value in the target buffer.
 210
 211   @param  Buffer  Pointer to the target buffer to scan.
 212   @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
 213   @param  Value   Value to search for in the target buffer.
 214
 215   @return Pointer to the first occurrence or NULL if not found.
 216
 217 **/
 218 CONST VOID *
 219 EFIAPI
 220 InternalMemScanMem32 (
 221   IN      CONST VOID                *Buffer,
 222   IN      UINTN                     Length,
 223   IN      UINT32                    Value
 224   );
 225
 226 /**
 227   Scans a target buffer for a 64-bit value, and returns a pointer to the
 228   matching 64-bit value in the target buffer.
 229
 230   @param  Buffer  Pointer to the target buffer to scan.
 231   @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
 232   @param  Value   Value to search for in the target buffer.
 233
 234   @return Pointer to the first occurrence or NULL if not found.
 235
 236 **/
 237 CONST VOID *
 238 EFIAPI
 239 InternalMemScanMem64 (
 240   IN      CONST VOID                *Buffer,
 241   IN      UINTN                     Length,
 242   IN      UINT64                    Value
 243   );
 244
 245 #endif