/** @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
+ The following BaseMemoryLib instances contain the same copy of this file:\r
+ BaseMemoryLib\r
+ BaseMemoryLibMmx\r
+ BaseMemoryLibSse2\r
+ BaseMemoryLibRepStr\r
+ BaseMemoryLibOptDxe\r
+ BaseMemoryLibOptPei\r
+\r
+ Copyright (c) 2006 - 2010, 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
+ 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: MemLibInternals.h\r
-\r
- The following BaseMemoryLib instances share the same version of this file:\r
-\r
- BaseMemoryLib\r
- BaseMemoryLibMmx\r
- BaseMemoryLibSse2\r
- BaseMemoryLibRepStr\r
- PeiMemoryLib\r
- UefiMemoryLib\r
-\r
**/\r
\r
#ifndef __MEM_LIB_INTERNALS__\r
#define __MEM_LIB_INTERNALS__\r
\r
+#include <Base.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+\r
/**\r
Copy Length bytes from Source to Destination.\r
\r
- @param Destination Target of copy\r
- @param Source Place to copy from\r
- @param Length Number of bytes to copy\r
+ @param DestinationBuffer Target of copy\r
+ @param SourceBuffer Place to copy from\r
+ @param Length The number of bytes to copy\r
\r
@return Destination\r
\r
/**\r
Set Buffer to Value for Size bytes.\r
\r
- @param Buffer Memory to set.\r
- @param Size Number of bytes to set\r
- @param Value Value of the set operation.\r
+ @param Buffer The memory to set.\r
+ @param Length The number of bytes to set\r
+ @param Value The value of the set operation.\r
\r
@return Buffer\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 Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The count of 16-bit value to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
\r
/**\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 Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The count of 32-bit value to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
\r
/**\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 Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The count of 64-bit value to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer\r
\r
/**\r
Set Buffer to 0 for Size bytes.\r
\r
- @param Buffer Memory to set.\r
- @param Size Number of bytes to set\r
+ @param Buffer The memory to set.\r
+ @param Length The number of bytes to set.\r
\r
@return Buffer\r
\r
/**\r
Compares two memory buffers of a given length.\r
\r
- @param DestinationBuffer First memory buffer\r
- @param SourceBuffer Second memory buffer\r
- @param Length Length of DestinationBuffer and SourceBuffer memory\r
+ @param DestinationBuffer The first memory buffer.\r
+ @param SourceBuffer The second memory buffer.\r
+ @param Length The 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
Scans a target buffer for an 8-bit value, and returns a pointer to the\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 Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The count of 8-bit value to scan. Must be non-zero.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return Pointer to the first occurrence or NULL if not found.\r
+ @return The pointer to the first occurrence, or NULL if not found.\r
\r
**/\r
CONST VOID *\r
Scans a target buffer for a 16-bit value, and returns a pointer to the\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 Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The count of 16-bit value to scan. Must be non-zero.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return Pointer to the first occurrence or NULL if not found.\r
+ @return The pointer to the first occurrence, or NULL if not found.\r
\r
**/\r
CONST VOID *\r
Scans a target buffer for a 32-bit value, and returns a pointer to the\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 Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The count of 32-bit value to scan. Must be non-zero.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return Pointer to the first occurrence or NULL if not found.\r
+ @return The pointer to the first occurrence, or NULL if not found.\r
\r
**/\r
CONST VOID *\r
Scans a target buffer for a 64-bit value, and returns a pointer to the\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 Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The count of 64-bit value to scan. Must be non-zero.\r
+ @param Value The calue to search for in the target buffer.\r
\r
- @return Pointer to the first occurrence or NULL if not found.\r
+ @return The pointer to the first occurrence, or NULL if not found.\r
\r
**/\r
CONST VOID *\r
projects / mirror_edk2.git / blobdiff