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

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation
   4 All rights reserved. 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   EdkIIGluePeimEntryPoint.h
  16
  17 Abstract:
  18
  19   Public header file for PEIM Entry Point Lib
  20
  21 --*/
  22
  23 #ifndef __EDKII_GLUE_PEIM_ENTRY_POINT_H__
  24 #define __EDKII_GLUE_PEIM_ENTRY_POINT_H__
  25
  26 //
  27 // Declare the EFI/UEFI Specification Revision to which this driver is implemented
  28 //
  29 extern const UINT32                   _gPeimRevision;
  30
  31 /**
  32   Image entry point of Peim.
  33
  34   @param  FfsHeader   Pointer to FFS header the loaded driver.
  35   @param  PeiServices Pointer to the PEI services.
  36
  37   @return  Status returned by entry points of Peims.
  38
  39 **/
  40 EFI_STATUS
  41 EFIAPI
  42 _ModuleEntryPoint (
  43   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  44   IN EFI_PEI_SERVICES          **PeiServices
  45   );
  46
  47
  48 /**
  49   Wrapper of Peim image entry point.
  50
  51   @param  FfsHeader   Pointer to FFS header the loaded driver.
  52   @param  PeiServices Pointer to the PEI services.
  53
  54   @return  Status returned by entry points of Peims.
  55
  56 **/
  57 EFI_STATUS
  58 EFIAPI
  59 EfiMain (
  60   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  61   IN EFI_PEI_SERVICES          **PeiServices
  62   );
  63
  64
  65 /**
  66   Call constructs for all libraries. Automatics Generated by tool.
  67
  68   @param  FfsHeader   Pointer to FFS header the loaded driver.
  69   @param  PeiServices Pointer to the PEI services.
  70
  71 **/
  72 VOID
  73 EFIAPI
  74 ProcessLibraryConstructorList (
  75   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  76   IN EFI_PEI_SERVICES          **PeiServices
  77   );
  78
  79
  80 /**
  81   Call destructors for all libraries. Automatics Generated by tool.
  82
  83   @param  FfsHeader   Pointer to FFS header the loaded driver.
  84   @param  PeiServices Pointer to the PEI services.
  85
  86 **/
  87 VOID
  88 EFIAPI
  89 ProcessLibraryDestructorList (
  90   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  91   IN EFI_PEI_SERVICES          **PeiServices
  92   );
  93
  94
  95 /**
  96   Call the list of driver entry points. Automatics Generated by tool.
  97
  98   @param  FfsHeader   Pointer to FFS header the loaded driver.
  99   @param  PeiServices Pointer to the PEI services.
 100
 101   @return Status returned by entry points of drivers.
 102
 103 **/
 104 EFI_STATUS
 105 EFIAPI
 106 ProcessModuleEntryPointList (
 107   IN EFI_FFS_FILE_HEADER       *FfsHeader,
 108   IN EFI_PEI_SERVICES          **PeiServices
 109   );
 110
 111 #endif