[mirror_edk2.git] / MdePkg / Include / Library / BaseMemoryLib.h

/** @file\r
  Memory-only library functions with no library constructor/destructor\r
\r
  Copyright (c) 2006, Intel Corporation\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
  Module Name:  BaseMemoryLib.h\r
\r
**/\r
\r
#ifndef __BASE_MEMORY_LIB__\r
#define __BASE_MEMORY_LIB__\r
\r
/**\r
  Copies a source buffer to a destination buffer, and returns the destination buffer.\r
\r
  This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns\r
  DestinationBuffer.  The implementation must be reentrant, and it must handle the case\r
  where SourceBuffer overlaps DestinationBuffer.\r
  If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). \r
  If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT(). \r
\r
  @param  DestinationBuffer   Pointer to the destination buffer of the memory copy.\r
  @param  SourceBuffer        Pointer to the source buffer of the memory copy.\r
  @param  Length              Number of bytes to copy from SourceBuffer to DestinationBuffer.\r
\r
  @return DestinationBuffer.\r
\r
**/\r
VOID *\r
EFIAPI\r
CopyMem (\r
  OUT VOID       *DestinationBuffer,\r
  IN CONST VOID  *SourceBuffer,\r
  IN UINTN       Length\r
  );\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
Commit	Line	Data
	1	/** @file\r
	2	Memory-only library functions with no library constructor/destructor\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	Module Name: BaseMemoryLib.h\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __BASE_MEMORY_LIB__\r
	18	#define __BASE_MEMORY_LIB__\r
	19	\r
	20	/**\r
	21	Copies a source buffer to a destination buffer, and returns the destination buffer.\r
	22	\r
	23	This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns\r
	24	DestinationBuffer. The implementation must be reentrant, and it must handle the case\r
	25	where SourceBuffer overlaps DestinationBuffer.\r
	26	If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). \r
	27	If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT(). \r
	28	\r
	29	@param DestinationBuffer Pointer to the destination buffer of the memory copy.\r
	30	@param SourceBuffer Pointer to the source buffer of the memory copy.\r
	31	@param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.\r
	32	\r
	33	@return DestinationBuffer.\r
	34	\r
	35	**/\r
	36	VOID *\r
	37	EFIAPI\r
	38	CopyMem (\r
	39	OUT VOID *DestinationBuffer,\r
	40	IN CONST VOID *SourceBuffer,\r
	41	IN UINTN Length\r
	42	);\r
	43	\r
	44	/**\r
	45	Fills a target buffer with a byte value, and returns the target buffer.\r
	46	\r
	47	This function fills Length bytes of Buffer with Value, and returns Buffer.\r
	48