Function headers in .h and .c files synchronized with spec

[mirror_edk2.git] / MdePkg / Library / PeiCoreEntryPoint / PeiCoreEntryPoint.c

/** @file\r
  Entry point to a the PEI Core.\r
\r
Copyright (c) 2006 - 2007, 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
\r
#include <PiPei.h>\r
\r
//\r
// The Library classes this module produced\r
//\r
#include <Library/PeiCoreEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
\r
/**\r
  The entry point of PE/COFF Image for the PEI Core.\r
\r
  This function is the entry point for the PEI Foundation, which allows the SEC phase\r
  to pass information about the stack, temporary RAM and the Boot Firmware Volume.\r
  In addition, it also allows the SEC phase to pass services and data forward for use\r
  during the PEI phase in the form of one or more PPIs.\r
  There is no limit to the number of additional PPIs that can be passed from SEC into\r
  the PEI Foundation. As part of its initialization phase, the PEI Foundation will add\r
  these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any\r
  modules can leverage the associated service calls and/or code in these early PPIs.\r
  This function is required to call ProcessModuleEntryPointList() with the Context\r
  parameter set to NULL.  ProcessModuleEntryPoint() is never expected to return.\r
  The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as\r
  the PEI Services Table and the file handle for the PEI Core itself have been established.\r
  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
\r
  @param SecCoreData  Points to a data structure containing information about the PEI\r
                      core's operating environment, such as the size and location of\r
                      temporary RAM, the stack location and the BFV location. \r
\r
  @param PpiList      Points to a list of one or more PPI descriptors to be installed\r
                      initially by the PEI core. An empty PPI list consists of a single\r
                      descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
                      As part of its initialization phase, the PEI Foundation will add\r
                      these SEC-hosted PPIs to its PPI database such that both the PEI\r
                      Foundation and any modules can leverage the associated service calls\r
                      and/or code in these early PPIs.\r
\r
**/\r
VOID\r
EFIAPI \r
_ModuleEntryPoint(\r
  IN CONST  EFI_SEC_PEI_HAND_OFF    *SecCoreData,\r
  IN CONST  EFI_PEI_PPI_DESCRIPTOR  *PpiList\r
)\r
{\r
  ProcessModuleEntryPointList (SecCoreData, PpiList, NULL);\r
  \r
  //\r
  // Should never return\r
  //\r
  ASSERT(FALSE);\r
  CpuDeadLoop ();  \r
}\r
\r
\r
/**\r
  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
\r
  This function is required to call _ModuleEntryPoint() passing in SecCoreData and PpiList.\r
\r
  @param SecCoreData  Points to a data structure containing information about the PEI core's\r
                      operating environment, such as the size and location of temporary RAM,\r
                      the stack location and the BFV location. \r
\r
  @param PpiList      Points to a list of one or more PPI descriptors to be installed\r
                      initially by the PEI core.  An empty PPI list consists of a single\r
                      descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
                      As part of its initialization phase, the PEI Foundation will add these\r
                      SEC-hosted PPIs to its PPI database such that both the PEI Foundation\r
                      and any modules can leverage the associated service calls and/or code\r
                      in these early PPIs.\r
\r
**/\r
VOID\r
EFIAPI\r
EfiMain (\r
  IN CONST  EFI_SEC_PEI_HAND_OFF    *SecCoreData,\r
  IN CONST  EFI_PEI_PPI_DESCRIPTOR  *PpiList\r
  )\r
{\r
  _ModuleEntryPoint (SecCoreData, PpiList);\r
}\r