MdePkg/Library/BaseMemoryLib/ZeroMemWrapper.c

   1 /** @file
   2   ZeroMem() 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   Module Name:  ZeroMemWrapper.c
  14
  15   The following BaseMemoryLib instances share the same version of this file:
  16
  17     BaseMemoryLib
  18     BaseMemoryLibMmx
  19     BaseMemoryLibSse2
  20     BaseMemoryLibRepStr
  21     PeiMemoryLib
  22     DxeMemoryLib
  23
  24 **/
  25
  26 //
  27 // Include common header file for this module.
  28 //
  29 #include "CommonHeader.h"
  30
  31 #include "MemLibInternals.h"
  32
  33 /**
  34   Fills a target buffer with zeros, and returns the target buffer.
  35
  36   This function fills Length bytes of Buffer with zeros, and returns Buffer.
  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 fill with zeros.
  41   @param  Length      Number of bytes in Buffer to fill with zeros.
  42
  43   @return Buffer.
  44
  45 **/
  46 VOID *
  47 EFIAPI
  48 ZeroMem (
  49   OUT VOID  *Buffer,
  50   IN UINTN  Length
  51   )
  52 {
  53   ASSERT (!(Buffer == NULL && Length > 0));
  54   ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
  55   return InternalMemZeroMem (Buffer, Length);
  56 }