Update EntryPoint library header

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

diff --git a/MdePkg/Include/Library/UefiDriverEntryPoint.h b/MdePkg/Include/Library/UefiDriverEntryPoint.h
index ef9570ba04ae66cf9d2289c087ed3038312b76a4..7946cb13f85f9fb5b473440eeec26c93f081dd76 100644 (file)
--- a/MdePkg/Include/Library/UefiDriverEntryPoint.h
+++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h
@@ -16,6 +16,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __MODULE_ENTRY_POINT_H__\r
 #define __MODULE_ENTRY_POINT_H__\r
 \r
+///\r
+///Declare the PI Specification Revision that this driver requires to execute correctly.\r
+///\r
+extern CONST UINT32                   _gDxeRevision;\r
+\r
 ///\r
 /// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
 ///\r
@@ -41,8 +46,8 @@ extern CONST UINT8                    _gDriverUnloadImageCount;
   then return EFI_INCOMPATIBLE_VERSION.\r
 \r
 \r
-  @param  ImageHandle  ImageHandle of the loaded driver.\r
-  @param  SystemTable  Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
   @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
                                      or UEFI Driver exited normally.\r
@@ -63,8 +68,8 @@ _ModuleEntryPoint (
 \r
   This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
   @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
                                      or UEFI Driver exited normally.\r
@@ -80,7 +85,7 @@ EfiMain (
 \r
 \r
 /**\r
-  Invokes the library destructors fror all dependent libraries and terminates the\r
+  Invokes the library destructors for all dependent libraries and terminates the\r
   DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. \r
 \r
   This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()\r
@@ -109,8 +114,8 @@ ExitDriver (
   and calling the library constructors in the proper order based upon each of the library\r
   instances own dependencies.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
 **/\r
 VOID\r
@@ -133,8 +138,8 @@ ProcessLibraryConstructorList (
   collecting the set of library instances, determine which ones have destructors, and calling\r
   the library destructors in the proper order based upon each of the library instances own dependencies.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
 **/\r
 VOID\r
@@ -153,11 +158,11 @@ ProcessLibraryDestructorList (
   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  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
-  @retval  EFI_SUCCESS   The UEFI Application executed normally.\r
-  @retval  !EFI_SUCCESS  The UEFI Application failed to execute normally.\r
+  @retval  EFI_SUCCESS   The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver executed normally.\r
+  @retval  !EFI_SUCCESS  The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver failed to execute normally.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -175,7 +180,7 @@ ProcessModuleEntryPointList (
   This function is autogenerated by build tools and those build tools are responsible\r
   for collecting the module unload handlers and calling them in a specified order.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
 \r
   @retval  EFI_SUCCESS  The unoad handlers executed normally.\r
   @retval  !EFI_SUCCESS The unload handlers failed to execute normally.\r