02b71837fe50182d5c063fc8cfbe3750622af51c
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / RecoveryModule.h
1 /** @file
2 This file declares Recovery Module PPI.
3
4 Copyright (c) 2007, 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 #include <PiPei.h>
25
26 #define EFI_PEI_RECOVERY_MODULE_PPI_GUID \
27 { \
28 0xFB6D9542, 0x612D, 0x4f45, {0x87, 0x2F, 0x5C, 0xFF, 0x52, 0xE9, 0x3D, 0xCF } \
29 }
30
31 typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI;
32
33 /**
34 Loads a DXE capsule from some media into memory and updates the HOB table
35 with the DXE firmware volume information.
36
37 @param PeiServices General-purpose services that are available to every PEIM.
38 @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
39
40 @retval EFI_SUCCESS The capsule was loaded correctly.
41 @retval EFI_DEVICE_ERROR A device error occurred.
42 @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
43
44 **/
45 typedef
46 EFI_STATUS
47 (EFIAPI *EFI_PEI_LOAD_RECOVERY_CAPSULE) (
48 IN EFI_PEI_SERVICES **PeiServices,
49 IN EFI_PEI_RECOVERY_MODULE_PPI *This
50 );
51
52 /**
53 @par Ppi Description:
54 Finds and loads the recovery files.
55
56 @param LoadRecoveryCapsule
57 Loads a DXE binary capsule into memory.
58
59 **/
60 struct _EFI_PEI_RECOVERY_MODULE_PPI {
61 EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;
62 };
63
64 extern EFI_GUID gEfiPeiRecoveryModulePpiGuid;
65
66 #endif