X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FDxeCoreEntryPoint.h;h=09a5499d01b1698e70d84ea93c724998be2fd2c2;hb=34860f7a069641fb9e14077c01605215aae68a9b;hp=af4c24438376568b129f9741c5f19bd9dddfba5f;hpb=0308e20dc67c63e48211b140558ae3bd13a1cbf5;p=mirror_edk2.git

diff --git a/MdePkg/Include/Library/DxeCoreEntryPoint.h b/MdePkg/Include/Library/DxeCoreEntryPoint.h
index af4c244383..09a5499d01 100644
--- a/MdePkg/Include/Library/DxeCoreEntryPoint.h
+++ b/MdePkg/Include/Library/DxeCoreEntryPoint.h
@@ -1,14 +1,14 @@
 /** @file
-  Entry point to the DXE Core
+  Module entry point library for DXE core.
 
-  Copyright (c) 2006, Intel Corporation<BR>
-  All rights reserved. This program and the accompanying materials
-  are licensed and made available under the terms and conditions of the BSD License
-  which accompanies this distribution.  The full text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
+Copyright (c) 2006 - 2008, Intel Corporation
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
 
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 **/
 
@@ -22,9 +22,16 @@ extern VOID  *gHobList;
 
 
 /**
-  Enrty point to DXE core.
+  The entry point of PE/COFF Image for the DXE Core. 
 
-  @param  HobStart Pointer of HobList.
+  This function is the entry point for the DXE Core.  This function is required
+  to call ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never
+  expected to return.  The DXE Core is responsible for calling ProcessLibraryConstructorList()
+  as soon as the EFI System Table and the image handle for the DXE Core itself have
+  been established.
+  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
+
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. 
 
 **/
 VOID
@@ -35,9 +42,11 @@ _ModuleEntryPoint (
 
 
 /**
-  Wrapper of enrty point to DXE CORE.
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
+
+  This function is required to call _ModuleEntryPoint() passing in HobStart.
 
-  @param  HobStart Pointer of HobList.
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. 
 
 **/
 VOID
@@ -48,10 +57,19 @@ EfiMain (
 
 
 /**
-  Call constructs for all libraries. Automatics Generated by tool.
+  Autogenerated function that calls the library constructors for all of the module's dependent libraries.
 
-  @param  ImageHandle ImageHandle of the loaded driver.
-  @param  SystemTable Pointer to the EFI System Table.
+  This function must be called by _ModuleEntryPoint().
+  This function calls the set of library constructors for the set of library instances
+  that a module depends on.  This includes library instances that a module depends on
+  directly and library instances that a module depends on indirectly through other
+  libraries. This function is autogenerated by build tools and those build tools are
+  responsible for collecting the set of library instances, determine which ones have
+  constructors, and calling the library constructors in the proper order based upon
+  each of the library instances own dependencies.
+
+  @param  ImageHandle  The image handle of the DXE Core.
+  @param  SystemTable  A pointer to the EFI System Table.
 
 **/
 VOID
@@ -61,24 +79,16 @@ ProcessLibraryConstructorList (
   IN EFI_SYSTEM_TABLE  *SystemTable
   );
 
-/**
-  Call destructors for all libraries. Automatics Generated by tool.
-
-  @param  ImageHandle ImageHandle of the loaded driver.
-  @param  SystemTable Pointer to the EFI System Table.
-
-**/
-VOID
-EFIAPI
-ProcessLibraryDestructorList (
-  IN EFI_HANDLE        ImageHandle,
-  IN EFI_SYSTEM_TABLE  *SystemTable
-  );
 
 /**
-  Call the list of driver entry points. Automatics Generated by tool.
+  Autogenerated function that calls a set of module entry points.
+
+  This function must be called by _ModuleEntryPoint().
+  This function calls the set of module entry points.  
+  This function is autogenerated by build tools and those build tools are responsible
+  for collecting the module entry points and calling them in a specified order.
 
-  @param  HobStart Pointer to HobList.
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. 
  
 **/
 VOID