Split out Synchronization Library from Base Library

[mirror_edk2.git] / MdePkg / Library / BaseLib / X64 / InterlockedIncrement.c

diff --git a/MdePkg/Library/BaseLib/X64/InterlockedIncrement.c b/MdePkg/Library/BaseLib/X64/InterlockedIncrement.c
index eda9f79a5b205160cba92bc78cb9e8e990d5df22..455fb453d483ab1a51bd13c62ffed5c657c7cf37 100644 (file)
--- a/MdePkg/Library/BaseLib/X64/InterlockedIncrement.c
+++ b/MdePkg/Library/BaseLib/X64/InterlockedIncrement.c
@@ -1,7 +1,7 @@
 /** @file\r
   InterLockedIncrement function\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\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
@@ -12,15 +12,29 @@
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
+\r
 long _InterlockedIncrement(\r
    long * lpAddend\r
 );\r
 \r
 #pragma intrinsic(_InterlockedIncrement)\r
 \r
+/**\r
+  Performs an atomic increment of an 32-bit unsigned integer.\r
+\r
+  Performs an atomic increment of the 32-bit unsigned integer specified by\r
+  Value and returns the incremented value. The increment operation must be\r
+  performed using MP safe mechanisms. The state of the return value is not\r
+  guaranteed to be MP safe.\r
+\r
+  @param  Value A pointer to the 32-bit value to increment.\r
+\r
+  @return The incremented value.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncIncrement (\r