]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseLib/Ia32/Monitor.c
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / Monitor.c
index 469aa6d7fa87005d4d6dfe198d13a2d62bf3829b..966b128a3b8dca361e4698426d388c711e0eb48b 100644 (file)
@@ -1,22 +1,27 @@
 /** @file\r
   AsmMonitor function\r
 \r
-  Copyright (c) 2006 - 2007, 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
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\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  RegisterEax The value to load into EAX or RAX before executing the MONITOR\r
+                      instruction.\r
+  @param  RegisterEcx The value to load into ECX or RCX before executing the MONITOR\r
+                      instruction.\r
+  @param  RegisterEdx The value to load into EDX or RDX before executing the MONITOR\r
+                      instruction.\r
 \r
+  @return RegisterEax\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmMonitor (\r