TianoCore EDK2 master
Loading...
Searching...
No Matches
UefiApplicationEntryPoint.h File Reference

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI _ModuleEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
EFI_STATUS EFIAPI EfiMain (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
VOID EFIAPI Exit (IN EFI_STATUS Status)
 
VOID EFIAPI ProcessLibraryConstructorList (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
VOID EFIAPI ProcessLibraryDestructorList (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
EFI_STATUS EFIAPI ProcessModuleEntryPointList (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 

Variables

CONST UINT32 _gUefiDriverRevision
 

Detailed Description

Module entry point library for UEFI Applications.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiApplicationEntryPoint.h.

Function Documentation

◆ _ModuleEntryPoint()

EFI_STATUS EFIAPI _ModuleEntryPoint ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Entry point to UEFI Application.

This function is the entry point for a UEFI Application. This function must call ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList(). The return value from ProcessModuleEntryPointList() is returned. If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe UEFI Application exited normally.
EFI_INCOMPATIBLE_VERSION_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
OtherReturn value from ProcessModuleEntryPointList().

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.

Parameters
ImageHandleThe image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver exited normally.
EFI_INCOMPATIBLE_VERSION_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
OtherReturn value from ProcessModuleEntryPointList().

The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, or UEFI Driver.

Parameters
ImageHandleThe image handle of the DXE Driver, DXE Runtime Driver, or UEFI Driver.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe DXE Driver, DXE Runtime Driver, or UEFI Driver exited normally.
EFI_INCOMPATIBLE_VERSION_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
OtherReturn value from ProcessModuleEntryPointList().

Definition at line 34 of file ApplicationEntryPoint.c.

◆ EfiMain()

EFI_STATUS EFIAPI EfiMain ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

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

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe UEFI Application exited normally.
EFI_INCOMPATIBLE_VERSION_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
OtherReturn value from ProcessModuleEntryPointList().

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

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

Parameters
ImageHandleThe image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver exited normally.
EFI_INCOMPATIBLE_VERSION_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
OtherReturn value from ProcessModuleEntryPointList().

Definition at line 106 of file ApplicationEntryPoint.c.

◆ Exit()

VOID EFIAPI Exit ( IN EFI_STATUS  Status)

Invokes the library destructors for all dependent libraries and terminates the UEFI Application.

This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit() with a status specified by Status.

Parameters
StatusStatus returned by the application that is exiting.

Definition at line 83 of file ApplicationEntryPoint.c.

◆ ProcessLibraryConstructorList()

VOID EFIAPI ProcessLibraryConstructorList ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Autogenerated function that calls the library constructors for all of the module's dependent libraries.

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.

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.

◆ ProcessLibraryDestructorList()

VOID EFIAPI ProcessLibraryDestructorList ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Autogenerated function that calls the library descructors for all of the module's dependent libraries.

This function may be called by _ModuleEntryPoint()or Exit(). This function calls the set of library destructors 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 destructors, and calling the library destructors in the proper order based upon each of the library instances own dependencies.

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.

◆ ProcessModuleEntryPointList()

EFI_STATUS EFIAPI ProcessModuleEntryPointList ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

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

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.

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe UEFI Application executed normally.
!EFI_SUCCESSThe UEFI Application failed to execute normally.

Variable Documentation

◆ _gUefiDriverRevision

CONST UINT32 _gUefiDriverRevision
extern

Declare the EFI/UEFI Specification Revision to which this driver is implemented