PeimEntryPoint.h File Reference

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	_ModuleEntryPoint (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)
EFI_STATUS EFIAPI	EfiMain (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)
VOID EFIAPI	ProcessLibraryConstructorList (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)
EFI_STATUS EFIAPI	ProcessModuleEntryPointList (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
CONST UINT32	_gPeimRevision

Detailed Description

Module entry point library for PEIM.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Function Documentation

_ModuleEntryPoint()

EFI_STATUS EFIAPI _ModuleEntryPoint	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

The entry point of PE/COFF Image for a PEIM.

This function is the entry point for a PEIM. This function must call ProcessLibraryConstructorList() and ProcessModuleEntryPointList(). The return value from ProcessModuleEntryPointList() is returned. If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The PEIM executed normally.
!EFI_SUCCESS	The PEIM failed to execute normally.

EfiMain()

EFI_STATUS EFIAPI EfiMain	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().

This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The PEIM executed normally.
!EFI_SUCCESS	The PEIM failed to execute normally.

ProcessLibraryConstructorList()

VOID EFIAPI ProcessLibraryConstructorList	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Autogenerated function that calls the library constructors for all of the module's dependent libraries.

This function must be called by _ModuleEntryPoint(). This function calls the set of library constructors for the set of library instances that a module depends on. This includes library instances that a module depends on directly and library instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have constructors, and calling the library constructors in the proper order based upon each of the library instances own dependencies.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

ProcessModuleEntryPointList()

EFI_STATUS EFIAPI ProcessModuleEntryPointList	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Autogenerated function that calls a set of module entry points.

This function must be called by _ModuleEntryPoint(). This function calls the set of module entry points. This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The PEIM executed normally.
!EFI_SUCCESS	The PEIM failed to execute normally.

Variable Documentation

_gPeimRevision

CONST UINT32 _gPeimRevision

extern

Declare the EFI/UEFI Specification Revision to which this driver is implemented