projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 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 |
| 2bbaeb0d | 5 | Copyright (c) 2007 - 2009, Intel Corporation\r |
| 79964ac8 | 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 | |
| 3f17e6d7 LG |
25 | ///\r |
| 26 | /// Inconsistent with specification here: \r | |
| 27 | /// GUID marco name has been changed to the consistent PPI GUID macro name.\r | |
| 28 | ///\r | |
| 79964ac8 | 29 | #define EFI_PEI_RECOVERY_MODULE_PPI_GUID \\r |
| 30 | { \\r | |
| 31 | 0xFB6D9542, 0x612D, 0x4f45, {0x87, 0x2F, 0x5C, 0xFF, 0x52, 0xE9, 0x3D, 0xCF } \\r | |
| 32 | }\r | |
| 33 | \r | |
| 34 | typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI;\r | |
| 35 | \r | |
| 36 | /**\r | |
| 37 | Loads a DXE capsule from some media into memory and updates the HOB table\r | |
| 38 | with the DXE firmware volume information.\r | |
| 39 | \r | |
| 40 | @param PeiServices General-purpose services that are available to every PEIM.\r | |
| 41 | @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.\r | |
| 42 | \r | |
| 43 | @retval EFI_SUCCESS The capsule was loaded correctly.\r | |
| 44 | @retval EFI_DEVICE_ERROR A device error occurred.\r | |
| 45 | @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r | |
| 46 | \r | |
| 47 | **/\r | |
| 48 | typedef\r | |
| 49 | EFI_STATUS\r | |
| 69686d56 | 50 | (EFIAPI *EFI_PEI_LOAD_RECOVERY_CAPSULE)(\r |
| 79964ac8 | 51 | IN EFI_PEI_SERVICES **PeiServices,\r |
| 52 | IN EFI_PEI_RECOVERY_MODULE_PPI *This\r | |
| 53 | );\r | |
| 54 | \r | |
| 55 | /**\r | |
| 79964ac8 | 56 | Finds and loads the recovery files.\r |
| 79964ac8 | 57 | **/\r |
| 58 | struct _EFI_PEI_RECOVERY_MODULE_PPI {\r | |
| 2bbaeb0d | 59 | EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule; ///< Loads a DXE binary capsule into memory.\r |
| 79964ac8 | 60 | };\r |
| 61 | \r | |
| 62 | extern EFI_GUID gEfiPeiRecoveryModulePpiGuid;\r | |
| 63 | \r | |
| 64 | #endif\r |