CodeReview for MdePkg/BaseMemoryXXX libraries. Refine file description, function...

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

/** @file\r
  SetMem() implementation.\r
\r
  The following BaseMemoryLib instances contain the same copy of this file:\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    BaseMemoryLibOptDxe\r
    BaseMemoryLibOptPei\r
    PeiMemoryLib\r
    DxeMemoryLib\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
**/\r
\r
\r
\r
\r
#include "MemLibInternals.h"\r
\r
/**\r
  Fills a target buffer with a byte value, and returns the target buffer.\r
\r
  This function fills Length bytes of Buffer with Value, and returns Buffer.\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
  @param  Buffer    Memory to set.\r
  @param  Length    Number of bytes to set.\r
  @param  Value     Value of the set operation.\r
\r
  @return Buffer.\r
\r
**/\r
VOID *\r
EFIAPI\r
SetMem (\r
  OUT VOID  *Buffer,\r
  IN UINTN  Length,\r
  IN UINT8  Value\r
  )\r
{\r
  if (Length == 0) {\r
    return Buffer;\r
  }\r
\r
  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)Buffer));\r
\r
  return InternalMemSetMem (Buffer, Length, Value);\r
}\r