MdeModulePkg/Include/Ppi/CapsuleOnDisk.h

   1 /** @file
   2   This file declares Capsule On Disk PPI.  This PPI is used to find and load the
   3   capsule on files that are relocated into a temp file under rootdir.
   4
   5   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __PEI_CAPSULE_ON_DISK_PPI_H__
  11 #define __PEI_CAPSULE_ON_DISK_PPI_H__
  12
  13 #define EDKII_PEI_CAPSULE_ON_DISK_PPI_GUID \
  14   { \
  15     0x71a9ea61, 0x5a35, 0x4a5d, {0xac, 0xef, 0x9c, 0xf8, 0x6d, 0x6d, 0x67, 0xe0 } \
  16   }
  17
  18 typedef struct _EDKII_PEI_CAPSULE_ON_DISK_PPI EDKII_PEI_CAPSULE_ON_DISK_PPI;
  19
  20 /**
  21   Loads a DXE capsule from some media into memory and updates the HOB table
  22   with the DXE firmware volume information.
  23
  24   @param  PeiServices   General-purpose services that are available to every PEIM.
  25   @param  This          Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
  26
  27   @retval EFI_SUCCESS        The capsule was loaded correctly.
  28   @retval EFI_DEVICE_ERROR   A device error occurred.
  29   @retval EFI_NOT_FOUND      A recovery DXE capsule cannot be found.
  30
  31 **/
  32 typedef
  33 EFI_STATUS
  34 (EFIAPI *EDKII_PEI_LOAD_CAPSULE_ON_DISK)(
  35   IN EFI_PEI_SERVICES               **PeiServices,
  36   IN EDKII_PEI_CAPSULE_ON_DISK_PPI  *This
  37   );
  38
  39 ///
  40 ///  Finds and loads the recovery files.
  41 ///
  42 struct _EDKII_PEI_CAPSULE_ON_DISK_PPI {
  43   EDKII_PEI_LOAD_CAPSULE_ON_DISK    LoadCapsuleOnDisk; ///< Loads a DXE binary capsule into memory.
  44 };
  45
  46 extern EFI_GUID  gEdkiiPeiCapsuleOnDiskPpiGuid;
  47
  48 #define EDKII_PEI_BOOT_IN_CAPSULE_ON_DISK_MODE_PPI \
  49   { \
  50     0xb08a11e4, 0xe2b7, 0x4b75, { 0xb5, 0x15, 0xaf, 0x61, 0x6, 0x68, 0xbf, 0xd1 } \
  51   }
  52
  53 extern EFI_GUID  gEdkiiPeiBootInCapsuleOnDiskModePpiGuid;
  54
  55 #endif