Update EntryPoint library header

Remove UefiTcgPlatform.h from Uefi Directory to IndustryStandard
Change EFI_OPTIONAL_POINTER to EFI_OPTIONAL_PTR aligned to UEFI spec.

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

1 files changed, 24 insertions, 26 deletions

diff --git a/MdePkg/Include/Library/PeimEntryPoint.h b/MdePkg/Include/Library/PeimEntryPoint.h
index ae53b2f94d..16ad7cce0a 100644
--- a/MdePkg/Include/Library/PeimEntryPoint.h
+++ b/MdePkg/Include/Library/PeimEntryPoint.h
@@ -22,10 +22,13 @@ extern CONST UINT32       _gPeimRevision;
 

 

 /**

-  Image entry point of Peim.

+  The entry point of PE/COFF Image for a PEIM.

+

+  This function is the entry point for a PEIM.  This function must call ProcessLibraryConstructorList() 

+  and ProcessModuleEntryPointList().  The return value from ProcessModuleEntryPointList() is returned.

+  If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().

 

   @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.

 

   @retval  EFI_SUCCESS   The PEIM executed normally.

@@ -41,9 +44,10 @@ _ModuleEntryPoint (
 

 /**

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

+  

+  This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.

 

   @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.

 

   @retval EFI_SUCCESS  The PEIM executed normally.

@@ -57,13 +61,20 @@ EfiMain (
   IN CONST EFI_PEI_SERVICES    **PeiServices

   );

 

-

 /**

-  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  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.

+  This function must be called by the PEI Core once an initial PEI Services Table has been established.

+  This function calls the set of library constructors for the set of library instances that a

+  module depends on.  This include 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  FileHandle   Handle of the file being invoked.

+  @param  PeiServices  Describes the list of possible PEI Services.

 

 **/

 VOID

@@ -73,28 +84,15 @@ ProcessLibraryConstructorList (
   IN CONST EFI_PEI_SERVICES    **PeiServices

   );

 

-

 /**

-  Call destructors for all libraries. Automatics Generated by tool.

-

-  @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.

+  Autogenerated function that calls a set of module entry points.

 

-**/

-VOID

-EFIAPI

-ProcessLibraryDestructorList (

-  IN EFI_PEI_FILE_HANDLE       FileHandle,

-  IN CONST EFI_PEI_SERVICES    **PeiServices

-  );

-

-

-/**

-  Call the list of driver entry points. Automatics Generated by tool.

+  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  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.

 

   @retval EFI_SUCCESS  The PEIM executed normally.