Update comments.

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

/** @file\r
  Implementation of the EfiSetMem routine. This function is broken\r
  out into its own source file so that it can be excluded from a\r
  build for a particular platform easily if an optimized version\r
  is desired.\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
  Set Buffer to Value for Size bytes.\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
InternalMemSetMem (\r
  IN      VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT8                     Value\r
  )\r
{\r
  //\r
  // Declare the local variables that actually move the data elements as\r
  // volatile to prevent the optimizer from replacing this function with\r
  // the intrinsic memset()\r
  //\r
  volatile UINT8                    *Pointer;\r
\r
  Pointer = (UINT8*)Buffer;\r
  while (Size-- != 0) {\r
    *(Pointer++) = Value;\r
  }\r
  return Buffer;\r
}\r