projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 878ddf1f | 1 | /** @file\r |
| 2 | Load image file from fv to memory. \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: LoadFile.h\r | |
| 14 | \r | |
| 15 | @par Revision Reference:\r | |
| 16 | This PPI is defined in PEI CIS spec Version 0.91.\r | |
| 17 | \r | |
| 18 | **/\r | |
| 19 | \r | |
| 20 | #ifndef __FV_FILE_LOADER_PPI_H__\r | |
| 21 | #define __FV_FILE_LOADER_PPI_H__\r | |
| 22 | \r | |
| 23 | #define EFI_PEI_FV_FILE_LOADER_GUID \\r | |
| 24 | { \\r | |
| 25 | 0x7e1f0d85, 0x4ff, 0x4bb2, {0x86, 0x6a, 0x31, 0xa2, 0x99, 0x6a, 0x48, 0xa8 } \\r | |
| 26 | }\r | |
| 27 | \r | |
| 28 | typedef struct _EFI_PEI_FV_FILE_LOADER_PPI EFI_PEI_FV_FILE_LOADER_PPI;\r | |
| 29 | \r | |
| 30 | /**\r | |
| 31 | Loads a PEIM into memory for subsequent execution.\r | |
| 32 | \r | |
| 0647c9ad LG |
33 | @param This Interface pointer that implements the Load File PPI instance.\r |
| 34 | @param FfsHeader Pointer to the FFS header of the file to load.\r | |
| 35 | @param ImageAddress Pointer to the address of the loaded Image\r | |
| 36 | @param ImageSize Pointer to the size of the loaded image.\r | |
| 37 | @param EntryPoint Pointer to the entry point of the image.\r | |
| 38 | \r | |
| 39 | @retval EFI_SUCCESS The image was loaded successfully.\r | |
| 40 | @retval EFI_OUT_OF_RESOURCES There was not enough memory.\r | |
| 41 | @retval EFI_INVALID_PARAMETER The contents of the FFS file did not\r | |
| 42 | contain a valid PE/COFF image that could be loaded.\r | |
| 878ddf1f | 43 | \r |
| 44 | **/\r | |
| 45 | typedef\r | |
| 46 | EFI_STATUS\r | |
| 47 | (EFIAPI *EFI_PEI_FV_LOAD_FILE) (\r | |
| 48 | IN EFI_PEI_FV_FILE_LOADER_PPI *This,\r | |
| 49 | IN EFI_FFS_FILE_HEADER *FfsHeader,\r | |
| 50 | OUT EFI_PHYSICAL_ADDRESS *ImageAddress,\r | |
| 51 | OUT UINT64 *ImageSize,\r | |
| 52 | OUT EFI_PHYSICAL_ADDRESS *EntryPoint\r | |
| 53 | );\r | |
| 54 | \r | |
| 55 | /**\r | |
| 56 | @par Ppi Description:\r | |
| 57 | This PPI is a pointer to the Load File service. This service will be \r | |
| 58 | published by a PEIM.The PEI Foundation will use this service to \r | |
| 59 | launch the known non-XIP PE/COFF PEIM images. This service may \r | |
| 60 | depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.\r | |
| 61 | \r | |
| 62 | @param FvLoadFile\r | |
| 63 | Loads a PEIM into memory for subsequent execution\r | |
| 64 | \r | |
| 65 | **/\r | |
| 66 | struct _EFI_PEI_FV_FILE_LOADER_PPI {\r | |
| 67 | EFI_PEI_FV_LOAD_FILE FvLoadFile;\r | |
| 68 | };\r | |
| 69 | \r | |
| 70 | extern EFI_GUID gEfiPeiFvFileLoaderPpiGuid;\r | |
| 71 | \r | |
| 72 | #endif\r |