TianoCore EDK2 master
Loading...
Searching...
No Matches
DxeIpl.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_DXE_IPL_PPI
 

Macros

#define EFI_DXE_IPL_PPI_GUID
 

Typedefs

typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI
 
typedef EFI_STATUS(EFIAPI * EFI_DXE_IPL_ENTRY) (IN CONST EFI_DXE_IPL_PPI *This, IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_HOB_POINTERS HobList)
 

Variables

EFI_GUID gEfiDxeIplPpiGuid
 

Detailed Description

This file declares DXE Initial Program Load PPI. When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:
This PPI is introduced in PI Version 1.0.

Definition in file DxeIpl.h.

Macro Definition Documentation

◆ EFI_DXE_IPL_PPI_GUID

#define EFI_DXE_IPL_PPI_GUID
Value:
{ \
0xae8ce5d, 0xe448, 0x4437, {0xa8, 0xd7, 0xeb, 0xf5, 0xf1, 0x94, 0xf7, 0x31 } \
}

Definition at line 16 of file DxeIpl.h.

Typedef Documentation

◆ EFI_DXE_IPL_ENTRY

typedef EFI_STATUS(EFIAPI * EFI_DXE_IPL_ENTRY) (IN CONST EFI_DXE_IPL_PPI *This, IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_HOB_POINTERS HobList)

The architectural PPI that the PEI Foundation invokes when there are no additional PEIMs to invoke.

This function is invoked by the PEI Foundation. The PEI Foundation will invoke this service when there are no additional PEIMs to invoke in the system. If this PPI does not exist, it is an error condition and an ill-formed firmware set. The DXE IPL PPI should never return after having been invoked by the PEI Foundation. The DXE IPL PPI can do many things internally, including the following:

  • Invoke the DXE entry point from a firmware volume
  • Invoke the recovery processing modules
  • Invoke the S3 resume modules
Parameters
ThisPointer to the DXE IPL PPI instance
PeiServicesPointer to the PEI Services Table.
HobListPointer to the list of Hand-Off Block (HOB) entries.
Return values
EFI_SUCCESSUpon this return code, the PEI Foundation should enter some exception handling.Under normal circumstances, the DXE IPL PPI should not return.

Definition at line 48 of file DxeIpl.h.

◆ EFI_DXE_IPL_PPI

Definition at line 21 of file DxeIpl.h.