Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / UefiApplicationEntryPoint / ApplicationEntryPoint.c

/** @file\r
  Entry point library instance to a UEFI application.\r
\r
Copyright (c) 2007 - 2008, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/UefiApplicationEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\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
  EFI_STATUS                 Status;\r
\r
  if (_gUefiDriverRevision != 0) {\r
    //\r
    // Make sure that the EFI/UEFI spec revision of the platform is >= EFI/UEFI spec revision of the application.\r
    //\r
    if (SystemTable->Hdr.Revision < _gUefiDriverRevision) {\r
      return EFI_INCOMPATIBLE_VERSION;\r
    }\r
  }\r
\r
  //\r
  // Call constructor for all libraries.\r
  //\r
  ProcessLibraryConstructorList (ImageHandle, SystemTable);\r
\r
  //\r
  // Call the module's entry point\r
  //\r
  Status = ProcessModuleEntryPointList (ImageHandle, SystemTable);\r
\r
  //\r
  // Process destructor for all libraries.\r
  //\r
  ProcessLibraryDestructorList (ImageHandle, SystemTable);\r
\r
  //\r
  // Return the return status code from the driver entry point\r
  //\r
  return Status;\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
  ProcessLibraryDestructorList (gImageHandle, gST);\r
\r
  gBS->Exit (gImageHandle, Status, 0, NULL);\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
  return _ModuleEntryPoint (ImageHandle, SystemTable);\r
}\r