Code have been checked with spec

[mirror_edk2.git] / MdePkg / Include / Library / DxeCoreEntryPoint.h

diff --git a/MdePkg/Include/Library/DxeCoreEntryPoint.h b/MdePkg/Include/Library/DxeCoreEntryPoint.h
index d735c821652960ae9951cac33a81a8e91fe8dafc..09a5499d01b1698e70d84ea93c724998be2fd2c2 100644 (file)
--- a/MdePkg/Include/Library/DxeCoreEntryPoint.h
+++ b/MdePkg/Include/Library/DxeCoreEntryPoint.h
@@ -1,14 +1,14 @@
 /** @file\r
-  Entry point to the DXE Core\r
+  Module entry point library for DXE core.\r
 \r
-  Copyright (c) 2006, 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
+Copyright (c) 2006 - 2008, 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
+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
 **/\r
 \r
@@ -16,15 +16,22 @@
 #define __MODULE_ENTRY_POINT_H__\r
 \r
 ///\r
-/// Declare the cache of copy of HobList. \r
+/// Global variable that contains a pointer to the Hob List passed into the DXE Core entry point. \r
 /// \r
 extern VOID  *gHobList;\r
 \r
 \r
 /**\r
-  Enrty point to DXE core.\r
+  The entry point of PE/COFF Image for the DXE Core. \r
 \r
-  @param  HobStart Pointer of HobList.\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
@@ -35,9 +42,11 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Wrapper of enrty 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
@@ -48,10 +57,19 @@ EfiMain (
 \r
 \r
 /**\r
-  Call constructs for all libraries. Automatics Generated by tool.\r
+  Autogenerated function that calls the library constructors for all of the module's dependent libraries.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of library constructors for the set of library instances\r
+  that a module depends on.  This includes library instances that a module depends on\r
+  directly and library instances that a module depends on indirectly through other\r
+  libraries. This function is autogenerated by build tools and those build tools are\r
+  responsible for collecting the set of library instances, determine which ones have\r
+  constructors, and calling the library constructors in the proper order based upon\r
+  each of the library instances own dependencies.\r
+\r
+  @param  ImageHandle  The image handle of the DXE Core.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
 **/\r
 VOID\r
@@ -61,24 +79,16 @@ ProcessLibraryConstructorList (
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   );\r
 \r
-/**\r
-  Call destructors for all libraries. Automatics Generated by tool.\r
-\r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-ProcessLibraryDestructorList (\r
-  IN EFI_HANDLE        ImageHandle,\r
-  IN EFI_SYSTEM_TABLE  *SystemTable\r
-  );\r
 \r
 /**\r
-  Call the list of driver entry points. Automatics Generated by tool.\r
+  Autogenerated function that calls a set of module entry points.\r
+\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of module entry points.  \r
+  This function is autogenerated by build tools and those build tools are responsible\r
+  for collecting the module entry points and calling them in a specified order.\r
 \r
-  @param  HobStart Pointer to HobList.\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
  \r
 **/\r
 VOID\r