EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGlueDxeSmmDriverEntryPoint.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 Module Name:
  13
  14   EdkIIGlueDxeSmmDriverEntryPoint.h
  15
  16 Abstract:
  17
  18   Public header file for DXE SMM Driver Entry Point Lib
  19
  20 --*/
  21
  22 #ifndef __EDKII_GLUE_MODULE_ENTRY_POINT_H__
  23 #define __EDKII_GLUE_MODULE_ENTRY_POINT_H__
  24
  25 //
  26 // Declare the EFI/UEFI Specification Revision to which this driver is implemented
  27 //
  28 extern const UINT32                   _gUefiDriverRevision;
  29
  30 //
  31 // Declare the number of entry points in the image.
  32 //
  33 extern const UINT8                    _gDriverEntryPointCount;
  34
  35 //
  36 // Declare the number of unload handler in the image.
  37 //
  38 extern const UINT8                    _gDriverUnloadImageCount;
  39
  40 /**
  41   Enrty point to DXE SMM Driver.
  42
  43   @param  ImageHandle ImageHandle of the loaded driver.
  44   @param  SystemTable Pointer to the EFI System Table.
  45
  46   @retval  EFI_SUCCESS One or more of the drivers returned a success code.
  47   @retval  !EFI_SUCESS The return status from the last driver entry point in the list.
  48
  49 **/
  50 EFI_STATUS
  51 EFIAPI
  52 _ModuleEntryPoint (
  53   IN EFI_HANDLE        ImageHandle,
  54   IN EFI_SYSTEM_TABLE  *SystemTable
  55   );
  56
  57 /**
  58   Enrty point wrapper of DXE SMM Driver.
  59
  60   @param  ImageHandle ImageHandle of the loaded driver.
  61   @param  SystemTable Pointer to the EFI System Table.
  62
  63   @retval  EFI_SUCCESS One or more of the drivers returned a success code.
  64   @retval  !EFI_SUCESS The return status from the last driver entry point in the list.
  65
  66 **/
  67 EFI_STATUS
  68 EFIAPI
  69 EfiMain (
  70   IN EFI_HANDLE        ImageHandle,
  71   IN EFI_SYSTEM_TABLE  *SystemTable
  72   );
  73
  74 /**
  75   Computes the cummulative return status for the driver entry point and perform
  76   a long jump back into DriverEntryPoint().
  77
  78   @param  Status Status returned by the driver that is exiting.
  79
  80 **/
  81 VOID
  82 EFIAPI
  83 ExitDriver (
  84   IN EFI_STATUS  Status
  85   );
  86
  87 /**
  88   Call constructs for all libraries. Automatics Generated by tool.
  89
  90   @param  ImageHandle ImageHandle of the loaded driver.
  91   @param  SystemTable Pointer to the EFI System Table.
  92
  93 **/
  94 VOID
  95 EFIAPI
  96 ProcessLibraryConstructorList (
  97   IN EFI_HANDLE        ImageHandle,
  98   IN EFI_SYSTEM_TABLE  *SystemTable
  99   );
 100
 101 /**
 102   Call destructors 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 ProcessLibraryDestructorList (
 111   IN EFI_HANDLE        ImageHandle,
 112   IN EFI_SYSTEM_TABLE  *SystemTable
 113   );
 114
 115
 116 /**
 117   Call the list of driver entry points. Automatics Generated by tool.
 118
 119   @param  ImageHandle ImageHandle of the loaded driver.
 120   @param  SystemTable Pointer to the EFI System Table.
 121
 122   @return Status returned by entry points of drivers.
 123
 124 **/
 125 EFI_STATUS
 126 EFIAPI
 127 ProcessModuleEntryPointList (
 128   IN EFI_HANDLE        ImageHandle,
 129   IN EFI_SYSTEM_TABLE  *SystemTable
 130   );
 131
 132
 133 /**
 134   Call the unload handlers for all the modules. Automatics Generated by tool.
 135
 136   @param  ImageHandle ImageHandle of the loaded driver.
 137
 138   @return Status returned by unload handlers of drivers.
 139
 140 **/
 141 EFI_STATUS
 142 EFIAPI
 143 ProcessModuleUnloadList (
 144   IN EFI_HANDLE  ImageHandle
 145   );
 146
 147 #endif