diff options
| -rw-r--r-- | MdePkg/Include/Library/UefiDriverEntryPoint.h | 24 | ||||
| -rw-r--r-- | MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c | 33 |
2 files changed, 37 insertions, 20 deletions
diff --git a/MdePkg/Include/Library/UefiDriverEntryPoint.h b/MdePkg/Include/Library/UefiDriverEntryPoint.h index 6db6086af0..54ae03ddef 100644 --- a/MdePkg/Include/Library/UefiDriverEntryPoint.h +++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h @@ -28,17 +28,18 @@ extern CONST UINT8 _gDriverUnloadImageCount; /**
- Enrty point to DXE Driver.
+ The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,
- or UEFI Driver. This function must call ProcessLibraryConstructorList() and
+ or UEFI Driver. This function must call ProcessLibraryConstructorList() and
ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()
- is an error status, then ProcessLibraryDestructorList() must be called. The return
- value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is
- greater than zero, then an unload handler must be registered for this image and the
- unload handler must invoke ProcessModuleUnloadList(). If _gUefiDriverRevision is not
- zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, then return
- EFI_INCOMPATIBLE_VERSION.
+ is an error status, then ProcessLibraryDestructorList() must be called. The return value
+ from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater
+ than zero, then an unload handler must be registered for this image and the unload handler
+ must invoke ProcessModuleUnloadList().
+ If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
+ then return EFI_INCOMPATIBLE_VERSION.
+
@param ImageHandle ImageHandle of the loaded driver.
@param SystemTable Pointer to the EFI System Table.
@@ -57,7 +58,7 @@ _ModuleEntryPoint ( /**
- Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
+ Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.
@@ -100,7 +101,7 @@ ExitDriver ( 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
+ 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,
@@ -120,7 +121,8 @@ ProcessLibraryConstructorList ( /**
- Autogenerated function that calls the library descructors for all of the module's dependent libraries.
+ Autogenerated function that calls the library descructors for all of the module's
+ dependent libraries.
This function may be called by _ModuleEntryPoint() or ExitDriver().
This function calls the set of library destructors for the set of library instances
diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c index 68410ba3c9..02d7160588 100644 --- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c +++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c @@ -63,13 +63,25 @@ _DriverUnloadHandler ( /**
- Enrty point to DXE Driver.
+ The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
+
+ This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,
+ or UEFI Driver. This function must call ProcessLibraryConstructorList() and
+ ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()
+ is an error status, then ProcessLibraryDestructorList() must be called. The return value
+ from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater
+ than zero, then an unload handler must be registered for this image and the unload handler
+ must invoke ProcessModuleUnloadList().
+ If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
+ then return EFI_INCOMPATIBLE_VERSION.
- @param ImageHandle ImageHandle of the loaded driver.
- @param SystemTable Pointer to the EFI System Table.
- @retval EFI_SUCCESS One or more of the drivers returned a success code.
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.
+ @param ImageHandle ImageHandle of the loaded driver.
+ @param SystemTable Pointer to the EFI System Table.
+
+ @retval EFI_SUCCESS One or more of the drivers returned a success code.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval Other Return value from ProcessModuleEntryPointList().
**/
EFI_STATUS
@@ -129,14 +141,17 @@ _ModuleEntryPoint ( /**
- Enrty point wrapper of DXE Driver.
+ Required by the EBC compiler and identical in functionality to _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.
- @retval EFI_SUCCESS One or more of the drivers returned a success code.
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.
-
+ @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
+ or UEFI Driver exited normally.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval Other Return value from ProcessModuleEntryPointList().
**/
EFI_STATUS
EFIAPI
|