Synchronize function comment in

[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
\r
  Enrty point to PEI core.\r
\r
  @param SecCoreData    Points to a data structure containing\r
                        information about the PEI core's\r
                        operating environment, such as the size\r
                        and location of temporary RAM, the stack\r
                        location and the BFV location. The type\r
                        EFI_SEC_PEI_HAND_OFF is\r
\r
  @param PpiList        Points to a list of one or more PPI\r
                        descriptors to be installed initially by\r
                        the PEI core. An empty PPI list consists\r
                        of a single descriptor with the end-tag\r
                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
                        As part of its initialization phase, the\r
                        PEI Foundation will add these SEC-hosted\r
                        PPIs to its PPI database such that both\r
                        the PEI Foundation and any modules can\r
                        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
  \r
  Wrapper of enrty point to PEI core.\r
  \r
  @param SecCoreData    Points to a data structure containing\r
                        information about the PEI core's\r
                        operating environment, such as the size\r
                        and location of temporary RAM, the stack\r
                        location and the BFV location. The type\r
                        EFI_SEC_PEI_HAND_OFF is\r
\r
  @param PpiList        Points to a list of one or more PPI\r
                        descriptors to be installed initially by\r
                        the PEI core. An empty PPI list consists\r
                        of a single descriptor with the end-tag\r
                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
                        As part of its initialization phase, the\r
                        PEI Foundation will add these SEC-hosted\r
                        PPIs to its PPI database such that both\r
                        the PEI Foundation and any modules can\r
                        leverage the associated service calls\r
                        and/or code 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