]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/BaseMemoryLib.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Library / BaseMemoryLib.h
index 47033d70a0974ec31b20e75dcbee17fa4548dd71..0a543116890fcbe63fa6a647ac17ad38e9ac4a7a 100644 (file)
@@ -5,11 +5,11 @@
   These functions should be used in place of coding your own loops to do equivalent common functions. \r
   This allows optimized library implementations to help increase performance. \r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
@@ -29,9 +29,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   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
+  @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
 \r
   @return DestinationBuffer.\r
 \r
@@ -51,9 +51,9 @@ CopyMem (
   \r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer    Memory to set.\r
-  @param  Length    Number of bytes to set.\r
-  @param  Value     Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer    The memory to set.\r
+  @param  Length    The number of bytes to set.\r
+  @param  Value     The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -78,9 +78,9 @@ SetMem (
   If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is not aligned on a 16-bit boundary, then ASSERT().\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 number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -105,9 +105,9 @@ SetMem16 (
   If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is not aligned on a 32-bit boundary, then ASSERT().\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 number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -132,9 +132,9 @@ SetMem32 (
   If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is not aligned on a 64-bit boundary, then ASSERT().\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 number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -159,9 +159,9 @@ SetMem64 (
   If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
   If Length is not aligned on a UINTN boundary, then ASSERT().\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 number of bytes in Buffer to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer.\r
 \r
@@ -182,8 +182,8 @@ SetMemN (
   If Length > 0 and Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to fill with zeros.\r
-  @param  Length      Number of bytes in Buffer to fill with zeros.\r
+  @param  Buffer      The pointer to the target buffer to fill with zeros.\r
+  @param  Length      The number of bytes in Buffer to fill with zeros.\r
 \r
   @return Buffer.\r
 \r
@@ -208,9 +208,9 @@ ZeroMem (
   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 to compare.\r
-  @param  SourceBuffer      Pointer to the source buffer to compare.\r
-  @param  Length            Number of bytes to compare.\r
+  @param  DestinationBuffer The pointer to the destination buffer to compare.\r
+  @param  SourceBuffer      The pointer to the source buffer to compare.\r
+  @param  Length            The number of bytes to compare.\r
 \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
@@ -237,11 +237,11 @@ CompareMem (
   If Length > 0 and Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\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 number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -266,11 +266,11 @@ ScanMem8 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\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 number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -295,11 +295,11 @@ ScanMem16 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\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 number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -324,11 +324,11 @@ ScanMem32 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\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 number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -353,11 +353,11 @@ ScanMem64 (
   If Length is not aligned on a UINTN boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer      Pointer to the target buffer to scan.\r
-  @param  Length      Number of bytes in Buffer to scan.\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 number of bytes in Buffer to scan.\r
+  @param  Value       The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r
@@ -377,8 +377,8 @@ ScanMemN (
   If DestinationGuid is NULL, then ASSERT().\r
   If SourceGuid is NULL, then ASSERT().\r
 \r
-  @param  DestinationGuid   Pointer to the destination GUID.\r
-  @param  SourceGuid        Pointer to the source GUID.\r
+  @param  DestinationGuid   The pointer to the destination GUID.\r
+  @param  SourceGuid        The pointer to the source GUID.\r
 \r
   @return DestinationGuid.\r
 \r
@@ -428,11 +428,11 @@ CompareGuid (
   If Length is not aligned on a 128-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan.\r
-  @param  Guid    Value to search for in the target buffer.\r
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The number of bytes in Buffer to scan.\r
+  @param  Guid    The value to search for in the target buffer.\r
 \r
-  @return A pointer to the matching Guid in the target buffer or NULL otherwise.\r
+  @return A pointer to the matching Guid in the target buffer, otherwise NULL.\r
 \r
 **/\r
 VOID *\r