]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
Update copyright for files modified in this year
[mirror_edk2.git] / MdePkg / Library / DxeCoreEntryPoint / DxeCoreEntryPoint.c
index f2f30d694063620f0d6cbda5484e6e720b956a28..f1a32f0569f8e06cd7522409abcaf821e8da425f 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Entry point to the DXE Core.\r
 \r
-Copyright (c) 2006, 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
@@ -26,25 +26,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 VOID *gHobList = NULL;\r
 \r
 /**\r
-  Entry point to DXE core.\r
-\r
-  This function is the entry point to the DXE Foundation. The PEI phase, which executes just before\r
-  DXE, is responsible for loading and invoking the DXE Foundation in system memory. The only\r
-  parameter that is passed to the DXE Foundation is HobStart. This parameter is a pointer to the\r
-  HOB list that describes the system state at the hand-off to the DXE Foundation. At a minimum,\r
-  this system state must include the following:\r
-    - PHIT HOB\r
-    - CPU HOB\r
-    - Description of system memory\r
-    - Description of one or more firmware volumes\r
-  The DXE Foundation is also guaranteed that only one processor is running and that the processor is\r
-  running with interrupts disabled. The implementation of the DXE Foundation must not make any\r
-  assumptions about where the DXE Foundation will be loaded or where the stack is located. In\r
-  general, the DXE Foundation should make as few assumptions about the state of the system as\r
-  possible. This lack of assumptions will allow the DXE Foundation to be portable to the widest\r
-  variety of system architectures.\r
-  \r
-  @param  HobStart Pointer of HobList.\r
+  The entry point of PE/COFF Image for the DXE Core. \r
+\r
+  This function is the entry point for the DXE Core.  This function is required\r
+  to call ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never\r
+  expected to return.  The DXE Core is responsible for calling ProcessLibraryConstructorList()\r
+  as soon as the EFI System Table and the image handle for the DXE Core itself have\r
+  been established.\r
+  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
+\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r
@@ -72,9 +63,11 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Wrapper of entry point to DXE CORE.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+\r
+  This function is required to call _ModuleEntryPoint() passing in HobStart.\r
 \r
-  @param  HobStart Pointer of HobList.\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r