Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / UefiDriverEntryPoint / DriverEntryPoint.c

/** @file\r
  Entry point to a EFI/DXE driver.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
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
\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/LoadedImage.h>\r
\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
\r
/**\r
  Unload function that is registered in the LoadImage protocol.  It un-installs\r
  protocols produced and deallocates pool used by the driver.  Called by the core\r
  when unloading the driver.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
\r
  @return Status returned by all unload().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
_DriverUnloadHandler (\r
  EFI_HANDLE ImageHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // If an UnloadImage() handler is specified, then call it\r
  //\r
  Status = ProcessModuleUnloadList (ImageHandle);\r
\r
  //\r
  // If the driver specific unload handler does not return an error, then call all of the\r
  // library destructors.  If the unload handler returned an error, then the driver can not be\r
  // unloaded, and the library destructors should not be called\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ProcessLibraryDestructorList (ImageHandle, gST);\r
  }\r
\r
  //\r
  // Return the status from the driver specific unload handler\r
  //\r
  return Status;\r
}\r
\r
\r
/**\r
  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. \r
\r
  This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
  or UEFI Driver.  This function must call ProcessLibraryConstructorList() and\r
  ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()\r
  is an error status, then ProcessLibraryDestructorList() must be called. The return value\r
  from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater\r
  than zero, then an unload handler must be registered for this image and the unload handler\r
  must invoke ProcessModuleUnloadList().\r
  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
  then return EFI_INCOMPATIBLE_VERSION.\r
\r
\r
  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
                                     or UEFI Driver 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
  EFI_LOADED_IMAGE_PROTOCOL  *LoadedImage;\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 driver\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
  //  Install unload handler...\r
  //\r
  if (_gDriverUnloadImageCount != 0) {\r
    Status = gBS->HandleProtocol (\r
                    ImageHandle,\r
                    &gEfiLoadedImageProtocolGuid,\r
                    (VOID **)&LoadedImage\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
    LoadedImage->Unload = _DriverUnloadHandler;\r
  }\r
\r
  //\r
  // Call the driver entry point\r
  //\r
  Status = ProcessModuleEntryPointList (ImageHandle, SystemTable);\r
\r
  //\r
  // If all of the drivers returned errors, then invoke all of the library destructors\r
  //\r
  if (EFI_ERROR (Status)) {\r
    ProcessLibraryDestructorList (ImageHandle, SystemTable);\r
  }\r
\r
  //\r
  // Return the cummalative return status code from all of the driver entry points\r
  //\r
  return Status;\r
}\r
\r
\r
/**\r
  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). \r
\r
  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\r
\r
  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
                                     or UEFI Driver exited normally.\r
  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
  @retval  Other                     Return value from ProcessModuleEntryPointList().\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