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

4 files changed, 46 insertions, 47 deletions

diff --git a/MdePkg/Include/Library/PeiCoreEntryPoint.h b/MdePkg/Include/Library/PeiCoreEntryPoint.h
index 42ba464fbe..29c1d9c2e6 100644
--- a/MdePkg/Include/Library/PeiCoreEntryPoint.h
+++ b/MdePkg/Include/Library/PeiCoreEntryPoint.h
@@ -91,7 +91,7 @@ EfiMain (
   The PEI Core must call this function with a NULL FileHandle value as soon as the initial PEI

   Services Table has been established.

 

-  @param  FileHandle   Handle of the file being invoked.Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

+  @param  FileHandle   Handle of the file being invoked.

   @param  PeiServices  Describes the list of possible PEI Services.

 

 **/

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.

diff --git a/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
index 9497f9a162..94aa0c539d 100644
--- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h
+++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
@@ -66,7 +66,7 @@ EfiMain (
 

 

 /**

-  Invokes the library destructors fror all dependent libraries and terminates

+  Invokes the library destructors for all dependent libraries and terminates

   the UEFI Application. 

 

   This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()

@@ -132,12 +132,13 @@ ProcessLibraryDestructorList (
   );

 

 /**

-  Call driver entry point. For UEFI application, user

-  can only specify one entry point. Tool will automatically insert

-  this to Autogen.c.

+  This function calls the set of module entry points. It must be called by _ModuleEntryPoint().

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  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  ImageHandle    The image handle of the UEFI Application.

+  @param  SystemTable    A pointer to the EFI System Table.

 

   @retval  EFI_SUCCESS   The UEFI Application executed normally.

   @retval  !EFI_SUCCESS  The UEFI Application failed to execute normally.

diff --git a/MdePkg/Include/Library/UefiDriverEntryPoint.h b/MdePkg/Include/Library/UefiDriverEntryPoint.h
index 2e520582ec..7946cb13f8 100644
--- a/MdePkg/Include/Library/UefiDriverEntryPoint.h
+++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h
@@ -46,8 +46,8 @@ extern CONST UINT8                    _gDriverUnloadImageCount;
   then return EFI_INCOMPATIBLE_VERSION.

 

 

-  @param  ImageHandle  ImageHandle of the loaded driver.

-  @param  SystemTable  Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

 

   @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,

                                      or UEFI Driver exited normally.

@@ -68,8 +68,8 @@ _ModuleEntryPoint (
 

   This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

 

   @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,

                                      or UEFI Driver exited normally.

@@ -85,7 +85,7 @@ EfiMain (
 

 

 /**

-  Invokes the library destructors fror all dependent libraries and terminates the

+  Invokes the library destructors for all dependent libraries and terminates the

   DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. 

 

   This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()

@@ -114,8 +114,8 @@ ExitDriver (
   and calling the library constructors in the proper order based upon each of the library

   instances own dependencies.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

 

 **/

 VOID

@@ -138,8 +138,8 @@ ProcessLibraryConstructorList (
   collecting the set of library instances, determine which ones have destructors, and calling

   the library destructors in the proper order based upon each of the library instances own dependencies.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

 

 **/

 VOID

@@ -158,11 +158,11 @@ ProcessLibraryDestructorList (
   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  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

 

-  @retval  EFI_SUCCESS   The UEFI Application executed normally.

-  @retval  !EFI_SUCCESS  The UEFI Application failed to execute normally.

+  @retval  EFI_SUCCESS   The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver executed normally.

+  @retval  !EFI_SUCCESS  The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver failed to execute normally.

 **/

 EFI_STATUS

 EFIAPI

@@ -180,7 +180,7 @@ ProcessModuleEntryPointList (
   This function is autogenerated by build tools and those build tools are responsible

   for collecting the module unload handlers and calling them in a specified order.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.

 

   @retval  EFI_SUCCESS  The unoad handlers executed normally.

   @retval  !EFI_SUCCESS The unload handlers failed to execute normally.