4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Module entry point library for PEI core.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __MODULE_ENTRY_POINT_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __MODULE_ENTRY_POINT_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The entry point of PE/COFF Image for the PEI Core.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is the entry point for the PEI Foundation, which allows the SEC phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to pass information about the stack, temporary RAM and the Boot Firmware Volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In addition, it also allows the SEC phase to pass services and data forward for use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync during the PEI phase in the form of one or more PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync There is no limit to the number of additional PPIs that can be passed from SEC into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the PEI Foundation. As part of its initialization phase, the PEI Foundation will add
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync modules can leverage the associated service calls and/or code in these early PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is required to call ProcessModuleEntryPointList() with the Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter set to NULL. ProcessModuleEntryPoint() is never expected to return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the PEI Services Table and the file handle for the PEI Core itself have been established.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SecCoreData Points to a data structure containing information about the PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync core's operating environment, such as the size and location of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync temporary RAM, the stack location and the BFV location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PpiList Points to a list of one or more PPI descriptors to be installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync initially by the PEI core. An empty PPI list consists of a single
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As part of its initialization phase, the PEI Foundation will add
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync these SEC-hosted PPIs to its PPI database such that both the PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Foundation and any modules can leverage the associated service calls
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and/or code in these early PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync_ModuleEntryPoint(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is required to call _ModuleEntryPoint() passing in SecCoreData and PpiList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SecCoreData Points to a data structure containing information about the PEI core's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operating environment, such as the size and location of temporary RAM,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the stack location and the BFV location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PpiList Points to a list of one or more PPI descriptors to be installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync initially by the PEI core. An empty PPI list consists of a single
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As part of its initialization phase, the PEI Foundation will add these
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SEC-hosted PPIs to its PPI database such that both the PEI Foundation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and any modules can leverage the associated service calls and/or code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in these early PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEfiMain (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Autogenerated function that calls the library constructors for all of the module's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dependent libraries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called by the PEI Core once an initial PEI Services Table has been established.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function calls the set of library constructors for the set of library instances that a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync module depends on. This include library instances that a module depends on directly and library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instances that a module depends on indirectly through other libraries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is autogenerated by build tools and those build tools are responsible for collecting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the set of library instances, determining which ones have constructors, and calling the library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync constructors in the proper order based upon the dependencies of each of the library instances.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The PEI Core must call this function with a NULL FileHandle value as soon as the initial PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Services Table has been established.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Handle of the file being invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PeiServices Describes the list of possible PEI Services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncProcessLibraryConstructorList (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PEI_FILE_HANDLE FileHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_PEI_SERVICES **PeiServices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Autogenerated function that calls a set of module entry points.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called by _ModuleEntryPoint().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function calls the set of module entry points.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is autogenerated by build tools and those build tools are responsible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for collecting the module entry points and calling them in a specified order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SecCoreData Points to a data structure containing information about the PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync core's operating environment, such as the size and location of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync temporary RAM, the stack location and the BFV location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PpiList Points to a list of one or more PPI descriptors to be installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync initially by the PEI core. An empty PPI list consists of a single
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As part of its initialization phase, the PEI Foundation will add
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync these SEC-hosted PPIs to its PPI database such that both the PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Foundation and any modules can leverage the associated service calls
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and/or code in these early PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context A pointer to a private context structure defined by the PEI Core
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implementation. The implementation of _ModuleEntryPoint() must set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this parameter is NULL to indicate that this is the first PEI phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncProcessModuleEntryPointList (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif