EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGlueUefiDriverEntryPoint.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   EdkIIGlueUefiDriverEntryPoint.h
  16
  17 Abstract:
  18
  19   Public header file for UEFI Driver Entry Point Lib
  20
  21 --*/
  22
  23 #ifndef __EDKII_GLUE_UEFI_DRIVER_ENTRY_POINT_H__
  24 #define __EDKII_GLUE_UEFI_DRIVER_ENTRY_POINT_H__
  25
  26 //
  27 // Declare the EFI/UEFI Specification Revision to which this driver is implemented
  28 //
  29 extern const UINT32                   _gUefiDriverRevision;
  30
  31 //
  32 // Declare the number of entry points in the image.
  33 //
  34 extern const UINT8                    _gDriverEntryPointCount;
  35
  36 //
  37 // Declare the number of unload handler in the image.
  38 //
  39 extern const UINT8                    _gDriverUnloadImageCount;
  40
  41 //
  42 // Declare the arrary of Boot Sevice Exit Event callbacks .
  43 //
  44 extern const EFI_EVENT_NOTIFY         _gDriverExitBootServicesEvent[];
  45
  46 //
  47 // Declare the arrary of Virtual Address Change Event callbacks .
  48 //
  49 extern const EFI_EVENT_NOTIFY         _gDriverSetVirtualAddressMapEvent[];
  50
  51 /**
  52   Enrty point to DXE SMM Driver.
  53
  54   @param  ImageHandle ImageHandle of the loaded driver.
  55   @param  SystemTable Pointer to the EFI System Table.
  56
  57   @retval  EFI_SUCCESS One or more of the drivers returned a success code.
  58   @retval  !EFI_SUCESS The return status from the last driver entry point in the list.
  59
  60 **/
  61 EFI_STATUS
  62 EFIAPI
  63 _ModuleEntryPoint (
  64   IN EFI_HANDLE        ImageHandle,
  65   IN EFI_SYSTEM_TABLE  *SystemTable
  66   );
  67
  68
  69 /**
  70   Enrty point wrapper of DXE Driver.
  71
  72   @param  ImageHandle ImageHandle of the loaded driver.
  73   @param  SystemTable Pointer to the EFI System Table.
  74
  75   @retval  EFI_SUCCESS One or more of the drivers returned a success code.
  76   @retval  !EFI_SUCESS The return status from the last driver entry point in the list.
  77
  78 **/
  79 EFI_STATUS
  80 EFIAPI
  81 EfiMain (
  82   IN EFI_HANDLE        ImageHandle,
  83   IN EFI_SYSTEM_TABLE  *SystemTable
  84   );
  85
  86
  87 /**
  88   Computes the cummulative return status for the driver entry point and perform
  89   a long jump back into DriverEntryPoint().
  90
  91   @param  Status Status returned by the driver that is exiting.
  92
  93 **/
  94 VOID
  95 EFIAPI
  96 ExitDriver (
  97   IN EFI_STATUS  Status
  98   );
  99
 100
 101 /**
 102   Call constructs for all libraries. Automatics Generated by tool.
 103
 104   @param  ImageHandle ImageHandle of the loaded driver.
 105   @param  SystemTable Pointer to the EFI System Table.
 106
 107 **/
 108 VOID
 109 EFIAPI
 110 ProcessLibraryConstructorList (
 111   IN EFI_HANDLE        ImageHandle,
 112   IN EFI_SYSTEM_TABLE  *SystemTable
 113   );
 114
 115
 116 /**
 117   Call destructors for all libraries. Automatics Generated by tool.
 118
 119   @param  ImageHandle ImageHandle of the loaded driver.
 120   @param  SystemTable Pointer to the EFI System Table.
 121
 122 **/
 123 VOID
 124 EFIAPI
 125 ProcessLibraryDestructorList (
 126   IN EFI_HANDLE        ImageHandle,
 127   IN EFI_SYSTEM_TABLE  *SystemTable
 128   );
 129
 130 /**
 131   Call the list of driver entry points. Automatics Generated by tool.
 132
 133   @param  ImageHandle ImageHandle of the loaded driver.
 134   @param  SystemTable Pointer to the EFI System Table.
 135
 136   @return Status returned by entry points of drivers.
 137
 138 **/
 139
 140 EFI_STATUS
 141 EFIAPI
 142 ProcessModuleEntryPointList (
 143   IN EFI_HANDLE        ImageHandle,
 144   IN EFI_SYSTEM_TABLE  *SystemTable
 145   );
 146
 147
 148 /**
 149   Call the unload handlers for all the modules. Automatics Generated by tool.
 150
 151   @param  ImageHandle ImageHandle of the loaded driver.
 152
 153   @return Status returned by unload handlers of drivers.
 154
 155 **/
 156 EFI_STATUS
 157 EFIAPI
 158 ProcessModuleUnloadList (
 159   IN EFI_HANDLE  ImageHandle
 160   );
 161
 162 #endif