Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / BaseMemoryLib / SetMemWrapper.c

diff --git a/MdePkg/Library/BaseMemoryLib/SetMemWrapper.c b/MdePkg/Library/BaseMemoryLib/SetMemWrapper.c
index 294a27a75362e6b9286b93e30c695e4cd93c33ba..6d6ec38ae22070e751f98129fed9fd3c64b640e4 100644 (file)
--- a/MdePkg/Library/BaseMemoryLib/SetMemWrapper.c
+++ b/MdePkg/Library/BaseMemoryLib/SetMemWrapper.c
@@ -1,52 +1,91 @@
 /** @file\r
 /** @file\r

-  SetMem() implementation.\r
+  SetMem() and SetMemN() implementation.\r

 \r
 \r

-  Copyright (c) 2006, 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
-\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:  SetMemWrapper.c\r
-\r
-  The following BaseMemoryLib instances share the same version of this file:\r
+  The following BaseMemoryLib instances contain the same copy of this file:\r

 \r
     BaseMemoryLib\r
     BaseMemoryLibMmx\r
     BaseMemoryLibSse2\r
     BaseMemoryLibRepStr\r
 \r
     BaseMemoryLib\r
     BaseMemoryLibMmx\r
     BaseMemoryLibSse2\r
     BaseMemoryLibRepStr\r

+    BaseMemoryLibOptDxe\r
+    BaseMemoryLibOptPei\r

     PeiMemoryLib\r
     UefiMemoryLib\r
 \r
     PeiMemoryLib\r
     UefiMemoryLib\r
 \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
+\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

 **/\r
 \r
 #include "MemLibInternals.h"\r
 \r
 /**\r
 **/\r
 \r
 #include "MemLibInternals.h"\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
   This function fills Length bytes of Buffer with Value, and returns Buffer.\r
 \r
   This function fills Length bytes of Buffer with Value, and returns Buffer.\r

-\r
+  \r

   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\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    Memory to set.\r
+  @param  Length    Number of bytes to set.\r
+  @param  Value     Value with which to fill Length bytes of Buffer.\r

 \r
 \r

-  @return Buffer\r
+  @return Buffer.\r

 \r
 **/\r
 VOID *\r
 EFIAPI\r
 SetMem (\r
 \r
 **/\r
 VOID *\r
 EFIAPI\r
 SetMem (\r

-  IN      VOID                      *Buffer,\r
-  IN      UINTN                     Size,\r
-  IN      UINT8                     Value\r
+  OUT VOID  *Buffer,\r
+  IN UINTN  Length,\r
+  IN UINT8  Value\r
+  )\r
+{\r
+  if (Length == 0) {\r
+    return Buffer;\r
+  }\r
+\r
+  ASSERT ((Length - 1) <= (MAX_ADDRESS - (UINTN)Buffer));\r
+\r
+  return InternalMemSetMem (Buffer, Length, Value);\r
+}\r
+\r
+/**\r
+  Fills a target buffer with a value that is size UINTN, and returns the target buffer.\r
+\r
+  This function fills Length bytes of Buffer with the UINTN sized value specified by\r
+  Value, and returns Buffer. Value is repeated every sizeof(UINTN) bytes for Length\r
+  bytes of Buffer.\r
+\r
+  If Length > 0 and Buffer is NULL, then ASSERT().\r
+  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
+  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
+\r
+  @return Buffer.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+SetMemN (\r
+  OUT VOID  *Buffer,\r
+  IN UINTN  Length,\r
+  IN UINTN  Value\r

   )\r
 {\r
   )\r
 {\r

-  ASSERT (Size <= MAX_ADDRESS - (UINTN)Buffer + 1);\r
-  return InternalMemSetMem (Buffer, Size, Value);\r
+  if (sizeof (UINTN) == sizeof (UINT64)) {\r
+    return SetMem64 (Buffer, Length, (UINT64)Value);\r
+  } else {\r
+    return SetMem32 (Buffer, Length, (UINT32)Value);\r
+  }\r

 }\r
 }\r