Comments have been synchronized with spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6628 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 39 insertions, 14 deletions

diff --git a/MdePkg/Include/Library/DxeCoreEntryPoint.h b/MdePkg/Include/Library/DxeCoreEntryPoint.h
index f2454ef..04f2dbf 100644
--- a/MdePkg/Include/Library/DxeCoreEntryPoint.h
+++ b/MdePkg/Include/Library/DxeCoreEntryPoint.h
@@ -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 ProcessModuleEntryPoint() 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

@@ -76,9 +94,14 @@ ProcessLibraryDestructorList (
   );

 

 /**

-  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

diff --git a/MdePkg/Include/Library/PeimEntryPoint.h b/MdePkg/Include/Library/PeimEntryPoint.h
index 9980c91..ae53b2f 100644
--- a/MdePkg/Include/Library/PeimEntryPoint.h
+++ b/MdePkg/Include/Library/PeimEntryPoint.h
@@ -28,8 +28,8 @@ extern CONST UINT32       _gPeimRevision;
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

   @param  PeiServices Describes the list of possible PEI Services.

 

-  @return  Status returned by entry points of Peims.

-

+  @retval  EFI_SUCCESS   The PEIM executed normally.

+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.

 **/

 EFI_STATUS

 EFIAPI

@@ -40,13 +40,14 @@ _ModuleEntryPoint (
 

 

 /**

-  Wrapper of Peim image entry point.

+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().

 

   @param  FileHandle  Handle of the file being invoked. 

                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

   @param  PeiServices Describes the list of possible PEI Services.

 

-  @return  Status returned by entry points of Peims.

+  @retval EFI_SUCCESS  The PEIM executed normally.

+  @retval !EFI_SUCCESS The PEIM failed to execute normally.

 

 **/

 EFI_STATUS

@@ -96,7 +97,8 @@ ProcessLibraryDestructorList (
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

   @param  PeiServices Describes the list of possible PEI Services.

 

-  @return Status returned by entry points of drivers.  

+  @retval EFI_SUCCESS  The PEIM executed normally.

+  @retval !EFI_SUCCESS The PEIM failed to execute normally.

  

 **/

 EFI_STATUS