MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Library / PeiMemoryLib / MemLibInternals.h

diff --git a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h
index 131d17d26e814965de4b86dcc31a1e08488139ab..cf9b87387d03b058a22580b9d3883771efc74f23 100644 (file)
--- a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h
+++ b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h
@@ -1,7 +1,7 @@
 /** @file\r
   Declaration of internal functions for Base Memory Library.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2018, 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
@@ -26,7 +26,7 @@
   Copies a source buffer to a destination buffer, and returns the destination buffer.\r
 \r
   This function wraps the (*PeiServices)->CopyMem ().\r
-  \r
+\r
   @param  DestinationBuffer   The pointer to the destination buffer of the memory copy.\r
   @param  SourceBuffer        The pointer to the source buffer of the memory copy.\r
   @param  Length              The number of bytes to copy from SourceBuffer to DestinationBuffer.\r
@@ -46,8 +46,8 @@ InternalMemCopyMem (
   Fills a target buffer with a byte value, and returns the target buffer.\r
 \r
   This function wraps the (*PeiServices)->SetMem ().\r
-  \r
-  @param  Buffer    Memory to set.\r
+\r
+  @param  Buffer    The memory to set.\r
   @param  Size      The number of bytes to set.\r
   @param  Value     Value of the set operation.\r
 \r
@@ -119,7 +119,7 @@ InternalMemSetMem64 (
 /**\r
   Set Buffer to 0 for Size bytes.\r
 \r
-  @param  Buffer Memory to set.\r
+  @param  Buffer The memory to set.\r
   @param  Length The number of bytes to set\r
 \r
   @return Buffer\r
@@ -135,9 +135,9 @@ InternalMemZeroMem (
 /**\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
   @return 0                 All Length bytes of the two buffers are identical.\r
@@ -161,7 +161,7 @@ InternalMemCompareMem (
   @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 The 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
@@ -180,7 +180,7 @@ InternalMemScanMem8 (
   @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 The 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
@@ -199,7 +199,7 @@ InternalMemScanMem16 (
   @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 The 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
@@ -218,7 +218,7 @@ InternalMemScanMem32 (
   @param  Length  The count of 64-bit value to scan. Must be non-zero.\r
   @param  Value   The value to search for in the target buffer.\r
 \r
-  @return The 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
@@ -229,4 +229,21 @@ InternalMemScanMem64 (
   IN      UINT64                    Value\r
   );\r
 \r
+/**\r
+  Checks whether the contents of a buffer are all zeros.\r
+\r
+  @param  Buffer  The pointer to the buffer to be checked.\r
+  @param  Length  The size of the buffer (in bytes) to be checked.\r
+\r
+  @retval TRUE    Contents of the buffer are all zeros.\r
+  @retval FALSE   Contents of the buffer are not all zeros.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+InternalMemIsZeroBuffer (\r
+  IN CONST VOID  *Buffer,\r
+  IN UINTN       Length\r
+  );\r
+\r
 #endif\r