MdePkg/Include/Ppi/DxeIpl.h

   1 /** @file
   2   This file declares DXE Initial Program Load PPI.
   3   When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.
   4
   5   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8   @par Revision Reference:
   9   This PPI is introduced in PI Version 1.0.
  10
  11 **/
  12
  13 #ifndef __DXE_IPL_H__
  14 #define __DXE_IPL_H__
  15
  16 #define EFI_DXE_IPL_PPI_GUID \
  17   { \
  18     0xae8ce5d, 0xe448, 0x4437, {0xa8, 0xd7, 0xeb, 0xf5, 0xf1, 0x94, 0xf7, 0x31 } \
  19   }
  20
  21 typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
  22
  23 /**
  24   The architectural PPI that the PEI Foundation invokes when
  25   there are no additional PEIMs to invoke.
  26
  27   This function is invoked by the PEI Foundation.
  28   The PEI Foundation will invoke this service when there are
  29   no additional PEIMs to invoke in the system.
  30   If this PPI does not exist, it is an error condition and
  31   an ill-formed firmware set. The DXE IPL PPI should never
  32   return after having been invoked by the PEI Foundation.
  33   The DXE IPL PPI can do many things internally, including the following:
  34     - Invoke the DXE entry point from a firmware volume
  35     - Invoke the recovery processing modules
  36     - Invoke the S3 resume modules
  37
  38   @param  This           Pointer to the DXE IPL PPI instance
  39   @param  PeiServices    Pointer to the PEI Services Table.
  40   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.
  41
  42   @retval EFI_SUCCESS    Upon this return code, the PEI Foundation should enter
  43                          some exception handling.Under normal circumstances,
  44                          the DXE IPL PPI should not return.
  45
  46 **/
  47 typedef
  48 EFI_STATUS
  49 (EFIAPI *EFI_DXE_IPL_ENTRY)(
  50   IN CONST EFI_DXE_IPL_PPI        *This,
  51   IN EFI_PEI_SERVICES             **PeiServices,
  52   IN EFI_PEI_HOB_POINTERS         HobList
  53   );
  54
  55 ///
  56 /// Final service to be invoked by the PEI Foundation.
  57 /// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.
  58 /// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.
  59 ///
  60 struct _EFI_DXE_IPL_PPI {
  61   EFI_DXE_IPL_ENTRY    Entry;
  62 };
  63
  64 extern EFI_GUID  gEfiDxeIplPpiGuid;
  65
  66 #endif