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 via this PPI.
   4
   5   Copyright (c) 2006, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   Module Name:  DxeIpl.h
  15
  16   @par Revision Reference:
  17   This PPI is defined in PEI CIS.
  18   Version 0.91.
  19
  20 **/
  21
  22 #ifndef __DXE_IPL_H__
  23 #define __DXE_IPL_H__
  24
  25 #define EFI_DXE_IPL_PPI_GUID \
  26   { \
  27     0xae8ce5d, 0xe448, 0x4437, {0xa8, 0xd7, 0xeb, 0xf5, 0xf1, 0x94, 0xf7, 0x31 } \
  28   }
  29
  30 typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
  31
  32 /**
  33   The architectural PPI that the PEI Foundation invokes when
  34   there are no additional PEIMs to invoke.
  35
  36   @param  This           Pointer to the DXE IPL PPI instance
  37   @param  PeiServices    Pointer to the PEI Services Table.
  38   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.
  39
  40   @retval EFI_SUCCESS           Upon this return code, the PEI Foundation should enter
  41                                 some exception handling.Under normal circumstances, the DXE IPL PPI should not return.
  42
  43 **/
  44 typedef
  45 EFI_STATUS
  46 (EFIAPI *EFI_DXE_IPL_ENTRY) (
  47   IN EFI_DXE_IPL_PPI              *This,
  48   IN EFI_PEI_SERVICES             **PeiServices,
  49   IN EFI_PEI_HOB_POINTERS         HobList
  50   );
  51
  52 /**
  53   @par Ppi Description:
  54   Final service to be invoked by the PEI Foundation.
  55   The DXE IPL PPI is responsible for locating and loading the DXE Foundation.
  56   The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.
  57
  58   @param Entry
  59   The entry point to the DXE IPL PPI.
  60
  61 **/
  62 struct _EFI_DXE_IPL_PPI {
  63   EFI_DXE_IPL_ENTRY Entry;
  64 };
  65
  66 extern EFI_GUID gEfiDxeIplPpiGuid;
  67
  68 #endif