MdePkg/Include/Ppi/RecoveryModule.h

   1 /** @file
   2   This file declares Recovery Module PPI.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  RecoveryModule.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in Framework of EFI Recovery Spec.
  17   Version 0.9
  18
  19 **/
  20
  21 #ifndef __PEI_RECOVERY_MODULE_PPI_H__
  22 #define __PEI_RECOVERY_MODULE_PPI_H__
  23
  24 #define EFI_PEI_RECOVERY_MODULE_PPI_GUID \
  25   { \
  26     0xFB6D9542, 0x612D, 0x4f45, {0x87, 0x2F, 0x5C, 0xFF, 0x52, 0xE9, 0x3D, 0xCF } \
  27   }
  28
  29 typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI;
  30
  31 /**
  32   Loads a DXE capsule from some media into memory and updates the HOB table
  33   with the DXE firmware volume information.
  34
  35   @param  PeiServices    General-purpose services that are available to every PEIM.
  36   @param  This           Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
  37
  38   @retval EFI_SUCCESS           The capsule was loaded correctly.
  39   @retval EFI_DEVICE_ERROR      A device error occurred.
  40   @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.
  41
  42 **/
  43 typedef
  44 EFI_STATUS
  45 (EFIAPI *EFI_PEI_LOAD_RECOVERY_CAPSULE) (
  46   IN EFI_PEI_SERVICES                     **PeiServices,
  47   IN EFI_PEI_RECOVERY_MODULE_PPI          *This
  48   );
  49
  50 /**
  51   @par Ppi Description:
  52   Finds and loads the recovery files.
  53
  54   @param LoadRecoveryCapsule
  55   Loads a DXE binary capsule into memory.
  56
  57 **/
  58 struct _EFI_PEI_RECOVERY_MODULE_PPI {
  59   EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;
  60 };
  61
  62 extern EFI_GUID gEfiPeiRecoveryModulePpiGuid;
  63
  64 #endif