/** @file\r
- Load image file from fv to memory. \r
+ Load image file from fv to memory.\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
@par Revision Reference:\r
- This PPI is defined in PI Version 1.00.\r
+ This PPI is introduced in PI Version 1.0.\r
\r
**/\r
\r
typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
\r
/**\r
- This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
- image loading and relocating from the PEI Foundation.\r
- \r
- @param This Interface pointer that implements\r
- the Load File PPI instance.\r
-\r
- @param FileHandle File handle of the file to load.\r
- Type EFI_PEI_FILE_HANDLE is defined in\r
- FfsFindNextFile().\r
-\r
- @param ImageAddress Pointer to the address of the\r
- loaded image.\r
-\r
- @param ImageSize Pointer to the size of the loaded\r
- image.\r
-\r
- @param EntryPoint Pointer to the entry point of the\r
- image.\r
-\r
- @param AuthenticationState On exit, points to the attestation\r
- authentication state of the image\r
- or 0 if no attestation was\r
- performed. The format of\r
- AuthenticationState is defined in\r
- EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI.ExtractSection()\r
-\r
-\r
- @retval EFI_SUCCESS The image was loaded successfully.\r
-\r
+ Loads a PEIM into memory for subsequent execution.\r
+\r
+ This service is the single member function of EFI_LOAD_FILE_PPI.\r
+ This service separates image loading and relocating from the PEI Foundation.\r
+\r
+ @param This Interface pointer that implements\r
+ the Load File PPI instance.\r
+ @param FileHandle File handle of the file to load.\r
+ @param ImageAddress Pointer to the address of the loaded image.\r
+ @param ImageSize Pointer to the size of the loaded image.\r
+ @param EntryPoint Pointer to the entry point of the image.\r
+ @param AuthenticationState On exit, points to the attestation\r
+ authentication state of the image\r
+ or 0 if no attestation was performed.\r
+\r
+ @retval EFI_SUCCESS The image was loaded successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory.\r
+ @retval EFI_LOAD_ERROR There was no supported image in the file.\r
+ @retval EFI_INVALID_PARAMETER FileHandle was not a valid firmware file handle.\r
+ @retval EFI_INVALID_PARAMETER EntryPoint was NULL.\r
+ @retval EFI_UNSUPPORTED An image requires relocations or is not\r
+ memory mapped.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL\r
+ There is not enough heap to allocate the requested size.\r
+ This will not prevent the XIP image from being invoked.\r
\r
- @retval EFI_LOAD_ERROR There was no supported image in\r
- the file EFI_INVALID_PARAMETER\r
- FileHandle was not a valid\r
- firmware file handle.\r
- @retval EFI_INVALID_PARAMETER EntryPoint was NULL.\r
-\r
- @retval EFI_NOT_SUPPORTED An image requires relocations or\r
- is not memory mapped.\r
- \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_LOAD_FILE)(\r
- IN CONST EFI_PEI_LOAD_FILE_PPI *This,\r
- IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r
- OUT EFI_PHYSICAL_ADDRESS *ImageAddress,\r
- OUT UINT64 *ImageSize,\r
- OUT EFI_PHYSICAL_ADDRESS *EntryPoint,\r
- OUT UINT32 *AuthenticationState\r
+ IN CONST EFI_PEI_LOAD_FILE_PPI *This,\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ OUT EFI_PHYSICAL_ADDRESS *ImageAddress,\r
+ OUT UINT64 *ImageSize,\r
+ OUT EFI_PHYSICAL_ADDRESS *EntryPoint,\r
+ OUT UINT32 *AuthenticationState\r
);\r
\r
-\r
-/**\r
- This PPI is a pointer to the Load File service.\r
- This service will be published by a PEIM. The PEI Foundation\r
- will use this service to launch the known PEI module images.\r
- \r
- \r
- @param LoadFile Loads a PEIM into memory for subsequent\r
- execution. See the LoadFile() function\r
- description.\r
- \r
-**/\r
+///\r
+/// This PPI is a pointer to the Load File service.\r
+/// This service will be published by a PEIM. The PEI Foundation\r
+/// will use this service to launch the known PEI module images.\r
+///\r
struct _EFI_PEI_LOAD_FILE_PPI {\r
EFI_PEI_LOAD_FILE LoadFile;\r
};\r
projects / mirror_edk2.git / blobdiff