1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/** @file
Load image file from fv to memory.
Copyright (c) 2006, 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.
@par Revision Reference:
This PPI is defined in PI Version 1.00.
**/
#ifndef __FV_FILE_LOADER_PPI_H__
#define __FV_FILE_LOADER_PPI_H__
#define EFI_PEI_LOAD_FILE_PPI_GUID \
{ 0xb9e0abfe, 0x5979, 0x4914, { 0x97, 0x7f, 0x6d, 0xee, 0x78, 0xc2, 0x78, 0xa6 } }
typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
/**
This service is the single member function of EFI_LOAD_FILE_PPI. This service separates
image loading and relocating from the PEI Foundation.
@param This Interface pointer that implements
the Load File PPI instance.
@param FileHandle File handle of the file to load.
Type EFI_PEI_FILE_HANDLE is defined in
FfsFindNextFile().
@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.
@param AuthenticationState On exit, points to the attestation
authentication state of the image
or 0 if no attestation was
performed. The format of
AuthenticationState is defined in
EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI.ExtractSection()
@retval EFI_SUCCESS The image was loaded successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough memory.
@retval EFI_LOAD_ERROR There was no supported image in
the file EFI_INVALID_PARAMETER
FileHandle was not a valid
firmware file handle.
@retval EFI_INVALID_PARAMETER EntryPoint was NULL.
@retval EFI_NOT_SUPPORTED An image requires relocations or
is not memory mapped.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PEI_LOAD_FILE) (
IN CONST EFI_PEI_LOAD_FILE_PPI *This,
IN CONST EFI_PEI_FILE_HANDLE FileHandle,
OUT EFI_PHYSICAL_ADDRESS *ImageAddress,
OUT UINT64 *ImageSize,
OUT EFI_PHYSICAL_ADDRESS *EntryPoint,
OUT UINT32 *AuthenticationState
);
/**
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 PEI module images.
@param LoadFile Loads a PEIM into memory for subsequent
execution. See the LoadFile() function
description.
**/
struct _EFI_PEI_LOAD_FILE_PPI {
EFI_PEI_LOAD_FILE LoadFile;
};
#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
|
