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