X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FUefiApplicationEntryPoint.h;h=ce355947f7592ab7beb00773b79d3b3890699924;hp=94aa0c539da214e21f4b9f52e3c401152438a0c3;hb=HEAD;hpb=f6d2bcc6fa8161d20ff2b3601c94c566b5a9bc35 diff --git a/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/MdePkg/Include/Library/UefiApplicationEntryPoint.h index 94aa0c539d..ce355947f7 100644 --- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h +++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h @@ -1,14 +1,8 @@ /** @file Module entry point library for UEFI Applications. -Copyright (c) 2007 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -16,13 +10,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __UEFI_APPLICATION_ENTRY_POINT_H__ /// -/// Declare the EFI/UEFI Specification Revision to which this driver is implemented +/// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// -extern CONST UINT32 _gUefiDriverRevision; - +extern CONST UINT32 _gUefiDriverRevision; /** - Enrty point to UEFI Application. + Entry point to UEFI Application. This function is the entry point for a UEFI Application. This function must call ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList(). @@ -45,9 +38,8 @@ _ModuleEntryPoint ( IN EFI_SYSTEM_TABLE *SystemTable ); - /** - Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). + Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). @param ImageHandle The image handle of the UEFI Application. @param SystemTable A pointer to the EFI System Table. @@ -64,16 +56,15 @@ EfiMain ( IN EFI_SYSTEM_TABLE *SystemTable ); - /** Invokes the library destructors for all dependent libraries and terminates - the UEFI Application. + the UEFI Application. This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit() with a status specified by Status. @param Status Status returned by the application that is exiting. - + **/ VOID EFIAPI @@ -81,7 +72,6 @@ Exit ( IN EFI_STATUS Status ); - /** Autogenerated function that calls the library constructors for all of the module's dependent libraries. @@ -89,7 +79,7 @@ Exit ( 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. + 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 @@ -97,7 +87,7 @@ Exit ( @param ImageHandle The image handle of the UEFI Application. @param SystemTable A pointer to the EFI System Table. - + **/ VOID EFIAPI @@ -106,15 +96,14 @@ ProcessLibraryConstructorList ( 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 ExitDriver(). + 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. + 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 @@ -134,7 +123,7 @@ ProcessLibraryDestructorList ( /** 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 + 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.