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