summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Ppi
diff options
context:
space:
mode:
authorbxing <bxing@6f19259b-4bc3-4df7-8a09-765794883524>2007-07-09 02:32:32 +0000
committerbxing <bxing@6f19259b-4bc3-4df7-8a09-765794883524>2007-07-09 02:32:32 +0000
commitbaced22877abeadf5fcc7dba5424ee4808460df4 (patch)
treec99b3fad1fc55ee3a06b489ffc2a37d074264736 /IntelFrameworkPkg/Include/Ppi
parent7b7cae7b865b207dad421351d612edb1c1123294 (diff)
downloadedk2-platforms-baced22877abeadf5fcc7dba5424ee4808460df4.tar.xz
Added FvFileLoader PPI
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3142 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi')
-rw-r--r--IntelFrameworkPkg/Include/Ppi/LoadFile.h72
1 files changed, 72 insertions, 0 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/LoadFile.h b/IntelFrameworkPkg/Include/Ppi/LoadFile.h
new file mode 100644
index 0000000000..ca056bcc46
--- /dev/null
+++ b/IntelFrameworkPkg/Include/Ppi/LoadFile.h
@@ -0,0 +1,72 @@
+/** @file
+ Load image file from fv to memory.
+
+ Copyright (c) 2007, Intel Corporation
+ All rights reserved. This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+ Module Name: LoadFile.h
+
+ @par Revision Reference:
+ This PPI is defined in PEI CIS spec Version 0.91.
+
+**/
+
+#ifndef _FV_FILE_LOADER_PPI_H_
+#define _FV_FILE_LOADER_PPI_H_
+
+#define EFI_PEI_FV_FILE_LOADER_GUID \
+ { \
+ 0x7e1f0d85, 0x4ff, 0x4bb2, {0x86, 0x6a, 0x31, 0xa2, 0x99, 0x6a, 0x48, 0xa8 } \
+ }
+
+typedef struct _EFI_PEI_FV_FILE_LOADER_PPI EFI_PEI_FV_FILE_LOADER_PPI;
+
+/**
+ Loads a PEIM into memory for subsequent execution.
+
+ @param This Interface pointer that implements the Load File PPI instance.
+ @param FfsHeader Pointer to the FFS header of the file to load.
+ @param ImageAddress Pointer to the address of the loaded Image
+ @param ImageSize Pointer to the size of the loaded image.
+ @param EntryPoint Pointer to the entry point of the image.
+
+ @retval EFI_SUCCESS The image was loaded successfully.
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory.
+ @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
+ contain a valid PE/COFF image that could be loaded.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PEI_FV_LOAD_FILE) (
+ IN EFI_PEI_FV_FILE_LOADER_PPI *This,
+ IN EFI_FFS_FILE_HEADER *FfsHeader,
+ OUT EFI_PHYSICAL_ADDRESS *ImageAddress,
+ OUT UINT64 *ImageSize,
+ OUT EFI_PHYSICAL_ADDRESS *EntryPoint
+ );
+
+/**
+ @par Ppi Description:
+ This PPI is a pointer to the Load File service. This service will be
+ published by a PEIM.The PEI Foundation will use this service to
+ launch the known non-XIP PE/COFF PEIM images. This service may
+ depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.
+
+ @param FvLoadFile
+ Loads a PEIM into memory for subsequent execution
+
+**/
+struct _EFI_PEI_FV_FILE_LOADER_PPI {
+ EFI_PEI_FV_LOAD_FILE FvLoadFile;
+};
+
+extern EFI_GUID gEfiPeiFvFileLoaderPpiGuid;
+
+#endif