Code Scrub for MdePkg.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / Monitor.c

diff --git a/MdePkg/Library/BaseLib/Ia32/Monitor.c b/MdePkg/Library/BaseLib/Ia32/Monitor.c
index 469aa6d7fa87005d4d6dfe198d13a2d62bf3829b..68da9c68c731b275ef1150a96ec26963dba0028e 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/Monitor.c
+++ b/MdePkg/Library/BaseLib/Ia32/Monitor.c
@@ -17,6 +17,22 @@
 //\r
 \r
 \r
+/**\r
+  Sets up a monitor buffer that is used by AsmMwait().\r
+\r
+  Executes a MONITOR instruction with the register state specified by Eax, Ecx\r
+  and Edx. Returns Eax. This function is only available on IA-32 and X64.\r
+\r
+  @param  Eax The value to load into EAX or RAX before executing the MONITOR\r
+              instruction.\r
+  @param  Ecx The value to load into ECX or RCX before executing the MONITOR\r
+              instruction.\r
+  @param  Edx The value to load into EDX or RDX before executing the MONITOR\r
+              instruction.\r
+\r
+  @return Eax\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmMonitor (\r