added some comments in BaseLib

[mirror_edk2.git] / MdePkg / Include / Library / PeimEntryPoint.h

/** @file\r
  Entry point to a PEIM\r
\r
Copyright (c) 2006, Intel Corporation<BR>\r
All rights reserved. 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
#ifndef __MODULE_ENTRY_POINT_H__\r
#define __MODULE_ENTRY_POINT_H__\r
\r
//\r
// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
//\r
extern const UINT32                   _gPeimRevision;\r
\r
/**\r
  Image entry point of Peim.\r
\r
  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
  @param  PeiServices Pointer to the PEI services.\r
\r
  @return  Status returned by entry points of Peims.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
\r
/**\r
  Wrapper of Peim image entry point.\r
\r
  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
  @param  PeiServices Pointer to the PEI services.\r
\r
  @return  Status returned by entry points of Peims.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiMain (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
\r
/**\r
  Call constructs for all libraries. Automatics Generated by tool.\r
\r
  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
  @param  PeiServices Pointer to the PEI services.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryConstructorList (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
\r
/**\r
  Call destructors for all libraries. Automatics Generated by tool.\r
\r
  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
  @param  PeiServices Pointer to the PEI services.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryDestructorList (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
\r
/**\r
  Call the list of driver entry points. Automatics Generated by tool.\r
\r
  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
  @param  PeiServices Pointer to the PEI services.\r
\r
  @return Status returned by entry points of drivers.  \r
 \r
**/\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
#endif\r