MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Module entry point library for UEFI Applications.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __UEFI_APPLICATION_ENTRY_POINT_H__\r
#define __UEFI_APPLICATION_ENTRY_POINT_H__\r
\r
///\r
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented\r
///\r
extern CONST UINT32        _gUefiDriverRevision;\r
\r
\r
/**\r
  Entry point to UEFI Application.\r
\r
  This function is the entry point for a UEFI Application. This function must call\r
  ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().\r
  The return value from ProcessModuleEntryPointList() is returned.\r
  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
  then return EFI_INCOMPATIBLE_VERSION.\r
\r
  @param  ImageHandle  The image handle of the UEFI Application.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS               The UEFI Application exited normally.\r
  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
\r
  @param  ImageHandle  The image handle of the UEFI Application.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS               The UEFI Application exited normally.\r
  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiMain (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Invokes the library destructors for all dependent libraries and terminates\r
  the UEFI Application.\r
\r
  This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()\r
  with a status specified by Status.\r
\r
  @param  Status  Status returned by the application that is exiting.\r
\r
**/\r
VOID\r
EFIAPI\r
Exit (\r
  IN EFI_STATUS  Status\r
  );\r
\r
\r
/**\r
  Autogenerated function that calls the library constructors for all of the module's\r
  dependent libraries.\r
\r
  This function must be called by _ModuleEntryPoint().\r
  This function calls the set of library constructors for the set of library instances\r
  that a module depends on. This includes library instances that a module depends on\r
  directly and library instances that a module depends on indirectly through other libraries.\r
  This function is autogenerated by build tools and those build tools are responsible for\r
  collecting the set of library instances, determine which ones have constructors, and\r
  calling the library constructors in the proper order based upon each of the library\r
  instances own dependencies.\r
\r
  @param  ImageHandle  The image handle of the UEFI Application.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryConstructorList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Autogenerated function that calls the library descructors for all of the module's\r
  dependent libraries.\r
\r
  This function may be called by _ModuleEntryPoint()or Exit().\r
  This function calls the set of library destructors for the set of library instances\r
  that a module depends on.  This includes library instances that a module depends on\r
  directly and library instances that a module depends on indirectly through other libraries.\r
  This function is autogenerated by build tools and those build tools are responsible\r
  for collecting the set of library instances, determine which ones have destructors,\r
  and calling the library destructors in the proper order based upon each of the library\r
  instances own dependencies.\r
\r
  @param  ImageHandle  The image handle of the UEFI Application.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryDestructorList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  This function calls the set of module entry points. It must be called by _ModuleEntryPoint().\r
\r
  This function is autogenerated by build tools and those build tools are\r
  responsible for collecting the module entry points and calling them in a specified order.\r
\r
  @param  ImageHandle    The image handle of the UEFI Application.\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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
#endif\r