/** @file\r
Declaration of internal functions for Base Memory Library.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+ 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
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
- The following BaseMemoryLib instances contain the same copy of this file:\r
-\r
- BaseMemoryLib\r
- BaseMemoryLibMmx\r
- BaseMemoryLibSse2\r
- BaseMemoryLibRepStr\r
- BaseMemoryLibOptDxe\r
- BaseMemoryLibOptPei\r
- PeiMemoryLib\r
- DxeMemoryLib\r
-\r
**/\r
\r
#ifndef __MEM_LIB_INTERNALS__\r
#define __MEM_LIB_INTERNALS__\r
\r
-\r
#include <PiPei.h>\r
\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
\r
/**\r
- Copy Length bytes from Source to Destination.\r
+ Copies a source buffer to a destination buffer, and returns the destination buffer.\r
\r
- @param DestinationBuffer Target of copy\r
- @param SourceBuffer Place to copy from\r
- @param Length Number of bytes to copy\r
+ This function wraps the (*PeiServices)->CopyMem ().\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 Destination\r
+ @return DestinationBuffer.\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemCopyMem (\r
- OUT VOID *DestinationBuffer,\r
- IN CONST VOID *SourceBuffer,\r
+ OUT VOID *Destination,\r
+ IN CONST VOID *Source,\r
IN UINTN Length\r
);\r
\r
/**\r
- Set Buffer to Value for Size bytes.\r
+ Fills a target buffer with a byte value, and returns the target buffer.\r
\r
- @param Buffer Memory to set.\r
- @param Length Number of bytes to set\r
- @param Value Value of the set operation.\r
+ This function wraps the (*PeiServices)->SetMem ().\r
+ \r
+ @param Buffer Memory to set.\r
+ @param Size Number of bytes to set.\r
+ @param Value Value of the set operation.\r
\r
- @return Buffer\r
+ @return Buffer.\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem (\r
OUT VOID *Buffer,\r
- IN UINTN Length,\r
+ IN UINTN Size,\r
IN UINT8 Value\r
);\r
\r
Fills a target buffer with a 16-bit value, and returns the target buffer.\r
\r
@param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
+ @param Length Count of 16-bit value to fill.\r
@param Value Value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
Fills a target buffer with a 32-bit value, and returns the target buffer.\r
\r
@param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
+ @param Length Count of 32-bit value to fill.\r
@param Value Value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
Fills a target buffer with a 64-bit value, and returns the target buffer.\r
\r
@param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
+ @param Length Count of 64-bit value to fill.\r
@param Value Value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
@param Length Length of DestinationBuffer and SourceBuffer memory\r
regions to compare. Must be non-zero.\r
\r
- @retval 0 if MemOne == MemTwo\r
+ @return 0 All Length bytes of the two buffers are identical.\r
+ @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first\r
+ mismatched byte in DestinationBuffer.\r
\r
**/\r
INTN\r
matching 8-bit value in the target buffer.\r
\r
@param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan. Must be non-zero.\r
+ @param Length Count of 8-bit value to scan. Must be non-zero.\r
@param Value Value to search for in the target buffer.\r
\r
@return Pointer to the first occurrence or NULL if not found.\r
matching 16-bit value in the target buffer.\r
\r
@param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan. Must be non-zero.\r
+ @param Length Count of 16-bit value to scan. Must be non-zero.\r
@param Value Value to search for in the target buffer.\r
\r
@return Pointer to the first occurrence or NULL if not found.\r
matching 32-bit value in the target buffer.\r
\r
@param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan. Must be non-zero.\r
+ @param Length Count of 32-bit value to scan. Must be non-zero.\r
@param Value Value to search for in the target buffer.\r
\r
@return Pointer to the first occurrence or NULL if not found.\r
matching 64-bit value in the target buffer.\r
\r
@param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan. Must be non-zero.\r
+ @param Length Count of 64-bit value to scan. Must be non-zero.\r
@param Value Value to search for in the target buffer.\r
\r
@return Pointer to the first occurrence or NULL if not found.\r
projects / mirror_edk2.git / blobdiff