Switch DxeCore to use DxeCoreMemoryAllocationLib for NT32 platform.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Exec.h

diff --git a/MdeModulePkg/Core/Dxe/Exec.h b/MdeModulePkg/Core/Dxe/Exec.h
index 5df700113db87bc78366d00128a2ae7433e1497f..19ada45ca2d443c07f8b518a06651a7d672b64a0 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Exec.h
+++ b/MdeModulePkg/Core/Dxe/Exec.h
@@ -1,23 +1,16 @@
-/*++\r
+/** @file\r
+  UEFI Event support functions and structure.\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \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. <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
-Module Name:\r
-  \r
-  exec.h\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
-Abstract:\r
-    \r
-  EFI Event support\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _EXEC_H_\r
 #define _EXEC_H_\r
@@ -50,9 +43,9 @@ typedef struct {
   EFI_EVENT_NOTIFY        NotifyFunction;\r
   VOID                    *NotifyContext;\r
   EFI_GUID                EventGroup;\r
-  LIST_ENTRY              NotifyLink; \r
+  LIST_ENTRY              NotifyLink;\r
   BOOLEAN                 ExFlag;\r
-  \r
+\r
   //\r
   // A list of all runtime events\r
   //\r
@@ -73,127 +66,78 @@ typedef struct {
     } Timer;\r
   } u;\r
 \r
-} IEVENT;    \r
+} IEVENT;\r
 \r
 //\r
 // Internal prototypes\r
 //\r
 \r
+\r
+/**\r
+  Dispatches all pending events.\r
+\r
+  @param  Priority               The task priority level of event notifications\r
+                                 to dispatch\r
+\r
+**/\r
 VOID\r
 CoreDispatchEventNotifies (\r
   IN EFI_TPL      Priority\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+  );\r
 \r
-  Dispatches all pending events. \r
 \r
-Arguments:\r
 \r
-  Priority - The task priority level of event notifications to dispatch\r
-    \r
-Returns:\r
+/**\r
+  Return the highest set bit.\r
 \r
-  None\r
-\r
---*/\r
-;\r
+  @param  Number  The value to check\r
 \r
+  @return Bit position of the highest set bit\r
 \r
+**/\r
 UINTN\r
 CoreHighestSetBit (\r
-  IN UINTN         Number\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Return the highest set bit\r
-  \r
-Arguments:\r
-  \r
-  Number - The value to check\r
-  \r
-Returns:\r
-  \r
-  Bit position of the highest set bit\r
-\r
---*/\r
-;\r
-\r
+  IN UINTN     Number\r
+  );\r
 \r
-BOOLEAN\r
-GetInterruptState (\r
-  VOID               \r
-  )\r
-/*++\r
 \r
-Routine Description:\r
 \r
+/**\r
   Disables CPU interrupts.\r
 \r
-Arguments:\r
-\r
-  This                - Protocol instance structure\r
-\r
-  State               - Pointer to the CPU's current interrupt state\r
+  @retval EFI_SUCCESS            If interrupts were disabled in the CPU.\r
+  @retval EFI_INVALID_PARAMETER  State is NULL.\r
 \r
-Returns: \r
-\r
-  EFI_SUCCESS           - If interrupts were disabled in the CPU.\r
-\r
-  EFI_INVALID_PARAMETER - State is NULL.\r
-  \r
---*/\r
-;\r
+**/\r
+BOOLEAN\r
+GetInterruptState (\r
+  VOID\r
+  );\r
 \r
 //\r
 // Exported functions\r
 //\r
 \r
-VOID\r
-CoreEventVirtualAddressFixup (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   A function out of date, should be removed.\r
 \r
-Arguments:\r
-\r
-  None\r
-    \r
-Returns:\r
+**/\r
+VOID\r
+CoreEventVirtualAddressFixup (\r
+  VOID\r
+  );\r
 \r
-  None\r
 \r
---*/\r
-;\r
 \r
+/**\r
+  Initializes timer support.\r
 \r
+**/\r
 VOID\r
 CoreInitializeTimer (\r
   VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Initializes timer support\r
-\r
-Arguments:\r
-\r
-  None\r
-    \r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
-;\r
+  );\r
 \r
 //\r
 // extern data declarations\r
@@ -203,6 +147,5 @@ extern EFI_LOCK       gEventQueueLock;
 extern UINTN          gEventPending;\r
 extern LIST_ENTRY     gEventQueue[];\r
 extern LIST_ENTRY     gEventSignalQueue;\r
-extern UINT8          gHSB[];\r
 \r
 #endif\r