X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FBaseMemoryLibOptDxe%2FMemLibInternals.h;h=bbd8b63cb81829ebc9206c249f2778fc894ddb10;hp=24ad92e3f5d8b4674d05abce36595c65742a26f1;hb=9344f0921518309295da89c221d10cbead8531aa;hpb=2bfb60098f608dc32ff5d22b0fd087c1636b0881
diff --git a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
index 24ad92e3f5..bbd8b63cb8 100644
--- a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
+++ b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
@@ -8,17 +8,9 @@
BaseMemoryLibRepStr
BaseMemoryLibOptDxe
BaseMemoryLibOptPei
- PeiMemoryLib
- DxeMemoryLib
- Copyright (c) 2006, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+ Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent
**/
@@ -30,15 +22,14 @@
#include
#include
-
/**
Copy Length bytes from Source to Destination.
- @param DestinationBuffer Target of copy
- @param SourceBuffer Place to copy from
- @param Length Number of bytes to copy
+ @param DestinationBuffer The target of the copy request.
+ @param SourceBuffer The place to copy from.
+ @param Length The number of bytes to copy.
- @return Destination
+ @return Destination.
**/
VOID *
@@ -52,9 +43,9 @@ InternalMemCopyMem (
/**
Set Buffer to Value for Size bytes.
- @param Buffer Memory to set.
- @param Length Number of bytes to set
- @param Value Value of the set operation.
+ @param Buffer The memory to set.
+ @param Length The number of bytes to set.
+ @param Value The value of the set operation.
@return Buffer
@@ -70,11 +61,11 @@ InternalMemSetMem (
/**
Fills a target buffer with a 16-bit value, and returns the target buffer.
- @param Buffer Pointer to the target buffer to fill.
- @param Length Number of bytes in Buffer to fill.
- @param Value Value with which to fill Length bytes of Buffer.
+ @param Buffer The pointer to the target buffer to fill.
+ @param Length The count of 16-bit value to fill.
+ @param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -88,11 +79,11 @@ InternalMemSetMem16 (
/**
Fills a target buffer with a 32-bit value, and returns the target buffer.
- @param Buffer Pointer to the target buffer to fill.
- @param Length Number of bytes in Buffer to fill.
- @param Value Value with which to fill Length bytes of Buffer.
+ @param Buffer The pointer to the target buffer to fill.
+ @param Length The count of 32-bit value to fill.
+ @param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -106,11 +97,11 @@ InternalMemSetMem32 (
/**
Fills a target buffer with a 64-bit value, and returns the target buffer.
- @param Buffer Pointer to the target buffer to fill.
- @param Length Number of bytes in Buffer to fill.
- @param Value Value with which to fill Length bytes of Buffer.
+ @param Buffer The pointer to the target buffer to fill.
+ @param Length The count of 64-bit value to fill.
+ @param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -124,10 +115,10 @@ InternalMemSetMem64 (
/**
Set Buffer to 0 for Size bytes.
- @param Buffer Memory to set.
- @param Length Number of bytes to set
+ @param Buffer The memory to set.
+ @param Length The number of bytes to set
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -140,12 +131,14 @@ InternalMemZeroMem (
/**
Compares two memory buffers of a given length.
- @param DestinationBuffer First memory buffer
- @param SourceBuffer Second memory buffer
- @param Length Length of DestinationBuffer and SourceBuffer memory
+ @param DestinationBuffer The first memory buffer.
+ @param SourceBuffer The second memory buffer.
+ @param Length The length of DestinationBuffer and SourceBuffer memory
regions to compare. Must be non-zero.
- @retval 0 if MemOne == MemTwo
+ @return 0 All Length bytes of the two buffers are identical.
+ @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
+ mismatched byte in DestinationBuffer.
**/
INTN
@@ -160,11 +153,11 @@ InternalMemCompareMem (
Scans a target buffer for an 8-bit value, and returns a pointer to the
matching 8-bit value in the target buffer.
- @param Buffer Pointer to the target buffer to scan.
- @param Length Number of bytes in Buffer to scan. Must be non-zero.
- @param Value Value to search for in the target buffer.
+ @param Buffer The pointer to the target buffer to scan.
+ @param Length The count of 8-bit value to scan. Must be non-zero.
+ @param Value The value to search for in the target buffer.
- @return Pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence or NULL if not found.
**/
CONST VOID *
@@ -179,11 +172,11 @@ InternalMemScanMem8 (
Scans a target buffer for a 16-bit value, and returns a pointer to the
matching 16-bit value in the target buffer.
- @param Buffer Pointer to the target buffer to scan.
- @param Length Number of bytes in Buffer to scan. Must be non-zero.
- @param Value Value to search for in the target buffer.
+ @param Buffer The pointer to the target buffer to scan.
+ @param Length The count of 16-bit value to scan. Must be non-zero.
+ @param Value The value to search for in the target buffer.
- @return Pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence or NULL if not found.
**/
CONST VOID *
@@ -198,11 +191,11 @@ InternalMemScanMem16 (
Scans a target buffer for a 32-bit value, and returns a pointer to the
matching 32-bit value in the target buffer.
- @param Buffer Pointer to the target buffer to scan.
- @param Length Number of bytes in Buffer to scan. Must be non-zero.
- @param Value Value to search for in the target buffer.
+ @param Buffer The pointer to the target buffer to scan.
+ @param Length The count of 32-bit value to scan. Must be non-zero.
+ @param Value The value to search for in the target buffer.
- @return Pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence or NULL if not found.
**/
CONST VOID *
@@ -217,11 +210,11 @@ InternalMemScanMem32 (
Scans a target buffer for a 64-bit value, and returns a pointer to the
matching 64-bit value in the target buffer.
- @param Buffer Pointer to the target buffer to scan.
- @param Length Number of bytes in Buffer to scan. Must be non-zero.
- @param Value Value to search for in the target buffer.
+ @param Buffer The pointer to the target buffer to scan.
+ @param Length The count of 64-bit value to scan. Must be non-zero.
+ @param Value The value to search for in the target buffer.
- @return Pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence or NULL if not found.
**/
CONST VOID *
@@ -232,4 +225,21 @@ InternalMemScanMem64 (
IN UINT64 Value
);
+/**
+ Checks whether the contents of a buffer are all zeros.
+
+ @param Buffer The pointer to the buffer to be checked.
+ @param Length The size of the buffer (in bytes) to be checked.
+
+ @retval TRUE Contents of the buffer are all zeros.
+ @retval FALSE Contents of the buffer are not all zeros.
+
+**/
+BOOLEAN
+EFIAPI
+InternalMemIsZeroBuffer (
+ IN CONST VOID *Buffer,
+ IN UINTN Length
+ );
+
#endif