MdePkg/Include/Library/PeimEntryPoint.h

   1 /** @file
   2   Entry point to a PEIM
   3
   4 Copyright (c) 2006, Intel Corporation<BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __MODULE_ENTRY_POINT_H__
  16 #define __MODULE_ENTRY_POINT_H__
  17
  18 ///
  19 /// Declare the EFI/UEFI Specification Revision to which this driver is implemented
  20 ///
  21 extern CONST UINT32       _gPeimRevision;
  22
  23
  24 /**
  25   Image entry point of Peim.
  26
  27   @param  FfsHeader   Pointer to FFS header the loaded driver.
  28   @param  PeiServices Pointer to the PEI services.
  29
  30   @return  Status returned by entry points of Peims.
  31
  32 **/
  33 EFI_STATUS
  34 EFIAPI
  35 _ModuleEntryPoint (
  36   IN EFI_PEI_FILE_HANDLE       FileHandle,
  37   IN CONST EFI_PEI_SERVICES    **PeiServices
  38   );
  39
  40
  41 /**
  42   Wrapper of Peim image entry point.
  43
  44   @param  FfsHeader   Pointer to FFS header the loaded driver.
  45   @param  PeiServices Pointer to the PEI services.
  46
  47   @return  Status returned by entry points of Peims.
  48
  49 **/
  50 EFI_STATUS
  51 EFIAPI
  52 EfiMain (
  53   IN EFI_PEI_FILE_HANDLE       FileHandle,
  54   IN CONST EFI_PEI_SERVICES    **PeiServices
  55   );
  56
  57
  58 /**
  59   Call constructs for all libraries. Automatics Generated by tool.
  60
  61   @param  FfsHeader   Pointer to FFS header the loaded driver.
  62   @param  PeiServices Pointer to the PEI services.
  63
  64 **/
  65 VOID
  66 EFIAPI
  67 ProcessLibraryConstructorList (
  68   IN EFI_PEI_FILE_HANDLE       FileHandle,
  69   IN CONST EFI_PEI_SERVICES    **PeiServices
  70   );
  71
  72
  73 /**
  74   Call destructors for all libraries. Automatics Generated by tool.
  75
  76   @param  FfsHeader   Pointer to FFS header the loaded driver.
  77   @param  PeiServices Pointer to the PEI services.
  78
  79 **/
  80 VOID
  81 EFIAPI
  82 ProcessLibraryDestructorList (
  83   IN EFI_PEI_FILE_HANDLE       FileHandle,
  84   IN CONST EFI_PEI_SERVICES    **PeiServices
  85   );
  86
  87
  88 /**
  89   Call the list of driver entry points. Automatics Generated by tool.
  90
  91   @param  FfsHeader   Pointer to FFS header the loaded driver.
  92   @param  PeiServices Pointer to the PEI services.
  93
  94   @return Status returned by entry points of drivers.
  95
  96 **/
  97 EFI_STATUS
  98 EFIAPI
  99 ProcessModuleEntryPointList (
 100   IN EFI_PEI_FILE_HANDLE       FileHandle,
 101   IN CONST EFI_PEI_SERVICES    **PeiServices
 102   );
 103
 104 #endif