MdeModulePkg: Add Capsule On Disk related definition.

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / CapsuleOnDisk.h

/** @file\r
  This file declares Capsule On Disk PPI.  This PPI is used to find and load the\r
  capsule on files that are relocated into a temp file under rootdir.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PEI_CAPSULE_ON_DISK_PPI_H__\r
#define __PEI_CAPSULE_ON_DISK_PPI_H__\r
\r
#define EFI_PEI_CAPSULE_ON_DISK_PPI_GUID \\r
  { \\r
    0x71a9ea61, 0x5a35, 0x4a5d, {0xac, 0xef, 0x9c, 0xf8, 0x6d, 0x6d, 0x67, 0xe0 } \\r
  }\r
\r
typedef struct _EFI_PEI_CAPSULE_ON_DISK_PPI EFI_PEI_CAPSULE_ON_DISK_PPI;\r
\r
/**\r
  Loads a DXE capsule from some media into memory and updates the HOB table\r
  with the DXE firmware volume information.\r
\r
  @param  PeiServices   General-purpose services that are available to every PEIM.\r
  @param  This          Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.\r
\r
  @retval EFI_SUCCESS        The capsule was loaded correctly.\r
  @retval EFI_DEVICE_ERROR   A device error occurred.\r
  @retval EFI_NOT_FOUND      A recovery DXE capsule cannot be found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_LOAD_CAPSULE_ON_DISK)(\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN EFI_PEI_CAPSULE_ON_DISK_PPI  *This\r
  );\r
\r
///\r
///  Finds and loads the recovery files.\r
///\r
struct _EFI_PEI_CAPSULE_ON_DISK_PPI {\r
  EFI_PEI_LOAD_CAPSULE_ON_DISK LoadCapsuleOnDisk;  ///< Loads a DXE binary capsule into memory.\r
};\r
\r
extern EFI_GUID gEdkiiPeiCapsuleOnDiskPpiGuid;\r
\r
#define EFI_PEI_BOOT_IN_CAPSULE_ON_DISK_MODE_PPI \\r
  { \\r
    0xb08a11e4, 0xe2b7, 0x4b75, { 0xb5, 0x15, 0xaf, 0x61, 0x6, 0x68, 0xbf, 0xd1 } \\r
  }\r
\r
extern EFI_GUID gEfiPeiBootInCapsuleOnDiskModePpiGuid;\r
\r
#endif\r