]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
2 | PI PEI master include file. This file should match the PI spec.\r | |
3 | \r | |
66e5133c | 4 | Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r |
af2dc6a7 | 5 | This program and the accompanying materials are licensed and made available under \r |
6 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php. \r | |
9 | \r | |
959ccb23 | 10 | \r |
af2dc6a7 | 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
959ccb23 | 13 | \r |
959ccb23 | 14 | @par Revision Reference:\r |
66e5133c | 15 | PI Version 1.4a.\r |
959ccb23 | 16 | \r |
17 | **/\r | |
18 | \r | |
19 | #ifndef __PI_PEICIS_H__\r | |
20 | #define __PI_PEICIS_H__\r | |
21 | \r | |
d7dfd027 | 22 | #include <Uefi/UefiMultiPhase.h>\r |
959ccb23 | 23 | #include <Pi/PiMultiPhase.h>\r |
24 | \r | |
6de794cd | 25 | ///\r |
af2dc6a7 | 26 | /// The handles of EFI FV.\r |
6de794cd | 27 | /// \r |
00edb218 | 28 | typedef VOID *EFI_PEI_FV_HANDLE;\r |
6de794cd | 29 | \r |
30 | ///\r | |
af2dc6a7 | 31 | /// The handles of EFI FFS.\r |
6de794cd | 32 | /// \r |
00edb218 | 33 | typedef VOID *EFI_PEI_FILE_HANDLE;\r |
959ccb23 | 34 | \r |
6de794cd | 35 | ///\r |
af2dc6a7 | 36 | /// Declare the forward reference data structure for EFI_PEI_SERVICE.\r |
6de794cd | 37 | /// \r |
959ccb23 | 38 | typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r |
6de794cd | 39 | \r |
40 | ///\r | |
af2dc6a7 | 41 | /// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.\r |
6de794cd | 42 | /// \r |
959ccb23 | 43 | typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r |
44 | \r | |
45 | \r | |
46 | #include <Ppi/CpuIo.h>\r | |
47 | #include <Ppi/PciCfg2.h>\r | |
48 | \r | |
fb3df220 | 49 | \r |
959ccb23 | 50 | /**\r |
51 | The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r | |
52 | Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r | |
53 | \r | |
6de794cd | 54 | @param FileHandle Pointer to the FFS file header.\r |
959ccb23 | 55 | @param PeiServices Describes the list of possible PEI Services.\r |
56 | \r | |
373b5cf9 | 57 | @retval EFI_SUCCESS The PEI completed successfully.\r |
58 | @retval !EFI_SUCCESS There is error in PEIM.\r | |
959ccb23 | 59 | \r |
60 | **/\r | |
61 | typedef\r | |
62 | EFI_STATUS\r | |
1c9d209f | 63 | (EFIAPI *EFI_PEIM_ENTRY_POINT2)(\r |
b0d803fe | 64 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
65 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
959ccb23 | 66 | );\r |
67 | \r | |
68 | /**\r | |
69 | Entry point of the notification callback function itself within the PEIM.\r | |
70 | \r | |
71 | @param PeiServices Indirect reference to the PEI Services Table.\r | |
72 | @param NotifyDescriptor Address of the notification descriptor data structure.\r | |
73 | @param Ppi Address of the PPI that was installed.\r | |
74 | \r | |
373b5cf9 | 75 | @return Status of the notification.\r |
66e5133c | 76 | The status code returned from this function is ignored.\r |
959ccb23 | 77 | **/\r |
78 | typedef\r | |
79 | EFI_STATUS\r | |
6de794cd | 80 | (EFIAPI *EFI_PEIM_NOTIFY_ENTRY_POINT)(\r |
959ccb23 | 81 | IN EFI_PEI_SERVICES **PeiServices,\r |
82 | IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r | |
83 | IN VOID *Ppi\r | |
84 | );\r | |
85 | \r | |
86 | //\r | |
87 | // PEI Ppi Services List Descriptors\r | |
88 | //\r | |
89 | #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001\r | |
90 | #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010\r | |
91 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020\r | |
92 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040\r | |
93 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060\r | |
94 | #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000\r | |
95 | \r | |
6de794cd | 96 | ///\r |
97 | /// The data structure through which a PEIM describes available services to the PEI Foundation.\r | |
98 | /// \r | |
959ccb23 | 99 | typedef struct {\r |
1bf79370 LG |
100 | ///\r |
101 | /// This field is a set of flags describing the characteristics of this imported table entry.\r | |
102 | /// All flags are defined as EFI_PEI_PPI_DESCRIPTOR_***, which can also be combined into one.\r | |
103 | ///\r | |
959ccb23 | 104 | UINTN Flags;\r |
1bf79370 LG |
105 | ///\r |
106 | /// The address of the EFI_GUID that names the interface.\r | |
107 | ///\r | |
959ccb23 | 108 | EFI_GUID *Guid;\r |
1bf79370 LG |
109 | ///\r |
110 | /// A pointer to the PPI. It contains the information necessary to install a service.\r | |
111 | ///\r | |
959ccb23 | 112 | VOID *Ppi;\r |
113 | } EFI_PEI_PPI_DESCRIPTOR;\r | |
114 | \r | |
6de794cd | 115 | /// \r |
116 | /// The data structure in a given PEIM that tells the PEI \r | |
117 | /// Foundation where to invoke the notification service.\r | |
118 | /// \r | |
959ccb23 | 119 | struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r |
1bf79370 | 120 | ///\r |
af2dc6a7 | 121 | /// Details if the type of notification are callback or dispatch.\r |
1bf79370 | 122 | ///\r |
959ccb23 | 123 | UINTN Flags;\r |
1bf79370 LG |
124 | ///\r |
125 | /// The address of the EFI_GUID that names the interface.\r | |
126 | ///\r | |
959ccb23 | 127 | EFI_GUID *Guid;\r |
1bf79370 LG |
128 | ///\r |
129 | /// Address of the notification callback function itself within the PEIM.\r | |
130 | ///\r | |
959ccb23 | 131 | EFI_PEIM_NOTIFY_ENTRY_POINT Notify;\r |
132 | };\r | |
133 | \r | |
8546d5a6 | 134 | ///\r |
135 | /// This data structure is the means by which callable services are installed and\r | |
136 | /// notifications are registered in the PEI phase.\r | |
137 | ///\r | |
138 | typedef union {\r | |
139 | ///\r | |
140 | /// The typedef structure of the notification descriptor.\r | |
141 | ///\r | |
142 | EFI_PEI_NOTIFY_DESCRIPTOR Notify;\r | |
143 | ///\r | |
144 | /// The typedef structure of the PPI descriptor.\r | |
145 | ///\r | |
146 | EFI_PEI_PPI_DESCRIPTOR Ppi;\r | |
147 | } EFI_PEI_DESCRIPTOR;\r | |
148 | \r | |
959ccb23 | 149 | /**\r |
150 | This service is the first one provided by the PEI Foundation. This function \r | |
151 | installs an interface in the PEI PPI database by GUID. The purpose of the \r | |
152 | service is to publish an interface that other parties can use to call \r | |
153 | additional PEIMs.\r | |
154 | \r | |
155 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r | |
156 | published by the PEI Foundation.\r | |
157 | @param PpiList A pointer to the list of interfaces that the caller shall install.\r | |
158 | \r | |
159 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
af2dc6a7 | 160 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI \r |
161 | descriptors in the list do not have the \r | |
162 | EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
959ccb23 | 163 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r |
164 | \r | |
165 | **/\r | |
166 | typedef\r | |
167 | EFI_STATUS\r | |
6de794cd | 168 | (EFIAPI *EFI_PEI_INSTALL_PPI)(\r |
1c280088 | 169 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
170 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
959ccb23 | 171 | );\r |
172 | \r | |
173 | /**\r | |
174 | This function reinstalls an interface in the PEI PPI database by GUID. \r | |
175 | The purpose of the service is to publish an interface that other parties \r | |
176 | can use to replace a same-named interface in the protocol database \r | |
177 | with a different interface. \r | |
178 | \r | |
179 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r | |
180 | published by the PEI Foundation.\r | |
181 | @param OldPpi A pointer to the former PPI in the database.\r | |
182 | @param NewPpi A pointer to the new interfaces that the caller shall install.\r | |
183 | \r | |
184 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
185 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r | |
186 | list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
187 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
188 | @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r | |
189 | \r | |
190 | **/\r | |
191 | typedef\r | |
192 | EFI_STATUS\r | |
6de794cd | 193 | (EFIAPI *EFI_PEI_REINSTALL_PPI)(\r |
1c280088 | 194 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
195 | IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r | |
196 | IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r | |
959ccb23 | 197 | );\r |
198 | \r | |
199 | /**\r | |
200 | This function locates an interface in the PEI PPI database by GUID. \r | |
201 | \r | |
202 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r | |
203 | @param Guid A pointer to the GUID whose corresponding interface needs to be found.\r | |
204 | @param Instance The N-th instance of the interface that is required.\r | |
205 | @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r | |
206 | @param Ppi A pointer to the instance of the interface.\r | |
207 | \r | |
208 | @retval EFI_SUCCESS The interface was successfully returned.\r | |
209 | @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r | |
210 | \r | |
211 | **/\r | |
212 | typedef\r | |
213 | EFI_STATUS\r | |
6de794cd | 214 | (EFIAPI *EFI_PEI_LOCATE_PPI)(\r |
1c280088 | 215 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
216 | IN CONST EFI_GUID *Guid,\r | |
217 | IN UINTN Instance,\r | |
218 | IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor OPTIONAL,\r | |
219 | IN OUT VOID **Ppi\r | |
959ccb23 | 220 | );\r |
221 | \r | |
222 | /**\r | |
223 | This function installs a notification service to be called back when a \r | |
224 | given interface is installed or reinstalled. The purpose of the service \r | |
225 | is to publish an interface that other parties can use to call additional PPIs \r | |
226 | that may materialize later.\r | |
227 | \r | |
228 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
229 | @param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r | |
230 | \r | |
231 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
af2dc6a7 | 232 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the \r |
959ccb23 | 233 | list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r |
234 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
235 | \r | |
236 | **/\r | |
237 | typedef\r | |
238 | EFI_STATUS\r | |
6de794cd | 239 | (EFIAPI *EFI_PEI_NOTIFY_PPI)(\r |
1c280088 | 240 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
241 | IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r | |
959ccb23 | 242 | );\r |
243 | \r | |
244 | /**\r | |
245 | This function returns the present value of the boot mode.\r | |
246 | \r | |
247 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
248 | @param BootMode A pointer to contain the value of the boot mode.\r | |
249 | \r | |
af2dc6a7 | 250 | @retval EFI_SUCCESS The boot mode returned successfully.\r |
959ccb23 | 251 | \r |
252 | **/\r | |
253 | typedef\r | |
254 | EFI_STATUS\r | |
6de794cd | 255 | (EFIAPI *EFI_PEI_GET_BOOT_MODE)(\r |
1c280088 | 256 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
257 | OUT EFI_BOOT_MODE *BootMode\r | |
959ccb23 | 258 | );\r |
259 | \r | |
260 | /**\r | |
261 | This function sets the value of the boot mode.\r | |
262 | \r | |
263 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
264 | @param BootMode The value of the boot mode to set.\r | |
265 | \r | |
af2dc6a7 | 266 | @retval EFI_SUCCESS The boot mode returned successfully.\r |
959ccb23 | 267 | \r |
268 | **/\r | |
269 | typedef\r | |
270 | EFI_STATUS\r | |
6de794cd | 271 | (EFIAPI *EFI_PEI_SET_BOOT_MODE)(\r |
1c280088 | 272 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
273 | IN EFI_BOOT_MODE BootMode\r | |
959ccb23 | 274 | );\r |
275 | \r | |
276 | /**\r | |
277 | This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r | |
278 | \r | |
279 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
280 | @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r | |
281 | \r | |
282 | @retval EFI_SUCCESS The list was successfully returned.\r | |
283 | @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r | |
284 | \r | |
285 | **/\r | |
286 | typedef\r | |
287 | EFI_STATUS\r | |
6de794cd | 288 | (EFIAPI *EFI_PEI_GET_HOB_LIST)(\r |
1c280088 | 289 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
67c89a21 | 290 | OUT VOID **HobList\r |
959ccb23 | 291 | );\r |
292 | \r | |
293 | /**\r | |
af2dc6a7 | 294 | This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.\r |
959ccb23 | 295 | \r |
296 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
297 | @param Type The type of HOB to be installed.\r | |
298 | @param Length The length of the HOB to be added.\r | |
299 | @param Hob The address of a pointer that will contain the HOB header.\r | |
300 | \r | |
301 | @retval EFI_SUCCESS The HOB was successfully created.\r | |
302 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
303 | \r | |
304 | **/\r | |
305 | typedef\r | |
306 | EFI_STATUS\r | |
6de794cd | 307 | (EFIAPI *EFI_PEI_CREATE_HOB)(\r |
1c280088 | 308 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
309 | IN UINT16 Type,\r | |
310 | IN UINT16 Length,\r | |
7b1bf9f6 | 311 | IN OUT VOID **Hob\r |
959ccb23 | 312 | );\r |
313 | \r | |
314 | /**\r | |
315 | The purpose of the service is to abstract the capability of the PEI \r | |
316 | Foundation to discover instances of firmware volumes in the system. \r | |
c7c308ad | 317 | \r |
318 | This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this\r | |
319 | service to abstract the locations and formats of various firmware volumes. These volumes include\r | |
320 | the Boot Firmware Volume and any other volumes exposed by EFI_PEI_FV_PPI. The service\r | |
321 | returns a volume handle of type EFI_PEI_FV_HANDLE, which must be unique within the system.\r | |
959ccb23 | 322 | \r |
323 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
c7c308ad | 324 | @param Instance This instance of the firmware volume to find.\r |
325 | The value 0 is the Boot Firmware Volume (BFV).\r | |
326 | @param VolumeHandle On exit, points to the next volumn handle or NULL if it does not exist.\r | |
959ccb23 | 327 | \r |
328 | @retval EFI_SUCCESS The volume was found.\r | |
329 | @retval EFI_NOT_FOUND The volume was not found.\r | |
7b1bf9f6 | 330 | @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.\r |
959ccb23 | 331 | \r |
332 | **/\r | |
333 | typedef\r | |
334 | EFI_STATUS\r | |
6de794cd | 335 | (EFIAPI *EFI_PEI_FFS_FIND_NEXT_VOLUME2)(\r |
1c280088 | 336 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
337 | IN UINTN Instance,\r | |
338 | OUT EFI_PEI_FV_HANDLE *VolumeHandle\r | |
959ccb23 | 339 | );\r |
340 | \r | |
341 | /**\r | |
c7c308ad | 342 | Searches for the next matching file in the firmware volume.\r |
343 | \r | |
344 | This service enables PEIMs to discover firmware files within a specified volume.\r | |
345 | To find the first instance of a firmware file, pass a FileHandle value of NULL into the service.\r | |
346 | The service returns a file handle of type EFI_PEI_FILE_HANDLE, which must be unique within\r | |
347 | the system.\r | |
959ccb23 | 348 | \r |
349 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
350 | @param SearchType A filter to find files only of this type.\r | |
c7c308ad | 351 | @param FvHandle Handle of firmware volume in which to search.\r |
352 | @param FileHandle On entry, points to the current handle from which to begin searching\r | |
353 | or NULL to start at the beginning of the firmware volume.\r | |
354 | On exit, points the file handle of the next file in the volume or NULL\r | |
355 | if there are no more files.\r | |
959ccb23 | 356 | \r |
c7c308ad | 357 | @retval EFI_SUCCESS The file was found.\r |
358 | @retval EFI_NOT_FOUND The file was not found.\r | |
359 | @retval EFI_NOT_FOUND The header checksum was not zero.\r | |
959ccb23 | 360 | \r |
361 | **/\r | |
362 | typedef\r | |
363 | EFI_STATUS\r | |
6de794cd | 364 | (EFIAPI *EFI_PEI_FFS_FIND_NEXT_FILE2)(\r |
1c280088 | 365 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
366 | IN EFI_FV_FILETYPE SearchType,\r | |
c7c308ad | 367 | IN CONST EFI_PEI_FV_HANDLE FvHandle,\r |
1c280088 | 368 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r |
959ccb23 | 369 | );\r |
370 | \r | |
371 | /**\r | |
c7c308ad | 372 | Searches for the next matching section within the specified file.\r |
373 | \r | |
374 | This service enables PEI modules to discover the first section of a given type within a valid file.\r | |
375 | This service will search within encapsulation sections (compression and GUIDed) as well. It will\r | |
376 | search inside of a GUIDed section or a compressed section, but may not, for example, search a\r | |
377 | GUIDed section inside a GUIDes section.\r | |
af2dc6a7 | 378 | This service will not search within compression sections or GUIDed sections that require\r |
c7c308ad | 379 | extraction if memory is not present.\r |
959ccb23 | 380 | \r |
381 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
382 | @param SectionType The value of the section type to find.\r | |
c7c308ad | 383 | @param FileHandle Handle of the firmware file to search.\r |
959ccb23 | 384 | @param SectionData A pointer to the discovered section, if successful.\r |
385 | \r | |
c7c308ad | 386 | @retval EFI_SUCCESS The section was found.\r |
387 | @retval EFI_NOT_FOUND The section was not found.\r | |
959ccb23 | 388 | \r |
389 | **/\r | |
390 | typedef\r | |
391 | EFI_STATUS\r | |
6de794cd | 392 | (EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA2)(\r |
1c280088 | 393 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
394 | IN EFI_SECTION_TYPE SectionType,\r | |
395 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
c7c308ad | 396 | OUT VOID **SectionData\r |
959ccb23 | 397 | );\r |
398 | \r | |
c7935105 SZ |
399 | /**\r |
400 | Searches for the next matching section within the specified file.\r | |
401 | \r | |
402 | This service enables PEI modules to discover the section of a given type within a valid file.\r | |
403 | This service will search within encapsulation sections (compression and GUIDed) as well. It will\r | |
404 | search inside of a GUIDed section or a compressed section, but may not, for example, search a\r | |
405 | GUIDed section inside a GUIDes section.\r | |
406 | This service will not search within compression sections or GUIDed sections that require\r | |
407 | extraction if memory is not present.\r | |
408 | \r | |
409 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
410 | @param SectionType The value of the section type to find.\r | |
411 | @param SectionInstance Section instance to find.\r | |
412 | @param FileHandle Handle of the firmware file to search.\r | |
413 | @param SectionData A pointer to the discovered section, if successful.\r | |
414 | @param AuthenticationStatus A pointer to the authentication status for this section.\r | |
415 | \r | |
416 | @retval EFI_SUCCESS The section was found.\r | |
417 | @retval EFI_NOT_FOUND The section was not found.\r | |
418 | \r | |
419 | **/\r | |
420 | typedef\r | |
421 | EFI_STATUS\r | |
422 | (EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA3)(\r | |
423 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
424 | IN EFI_SECTION_TYPE SectionType,\r | |
425 | IN UINTN SectionInstance,\r | |
426 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
427 | OUT VOID **SectionData,\r | |
428 | OUT UINT32 *AuthenticationStatus\r | |
429 | );\r | |
430 | \r | |
959ccb23 | 431 | /**\r |
432 | This function registers the found memory configuration with the PEI Foundation.\r | |
433 | \r | |
434 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
af2dc6a7 | 435 | @param MemoryBegin The value of a region of installed memory.\r |
959ccb23 | 436 | @param MemoryLength The corresponding length of a region of installed memory.\r |
437 | \r | |
438 | @retval EFI_SUCCESS The region was successfully installed in a HOB.\r | |
439 | @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r | |
440 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
441 | \r | |
442 | **/\r | |
443 | typedef\r | |
444 | EFI_STATUS\r | |
6de794cd | 445 | (EFIAPI *EFI_PEI_INSTALL_PEI_MEMORY)(\r |
1c280088 | 446 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 447 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r |
448 | IN UINT64 MemoryLength\r | |
449 | );\r | |
450 | \r | |
451 | /**\r | |
452 | The purpose of the service is to publish an interface that allows \r | |
453 | PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r | |
454 | \r | |
455 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
456 | @param MemoryType The type of memory to allocate.\r | |
457 | @param Pages The number of contiguous 4 KB pages to allocate.\r | |
af2dc6a7 | 458 | @param Memory A pointer to a physical address. On output, the address is set to the base \r |
959ccb23 | 459 | of the page range that was allocated.\r |
460 | \r | |
461 | @retval EFI_SUCCESS The memory range was successfully allocated.\r | |
462 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r | |
af2dc6a7 | 463 | @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r |
ded5aa23 | 464 | EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r |
b7113eb0 | 465 | EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r |
959ccb23 | 466 | \r |
467 | **/\r | |
468 | typedef\r | |
469 | EFI_STATUS\r | |
6de794cd | 470 | (EFIAPI *EFI_PEI_ALLOCATE_PAGES)(\r |
1c280088 | 471 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 472 | IN EFI_MEMORY_TYPE MemoryType,\r |
473 | IN UINTN Pages,\r | |
c7c308ad | 474 | OUT EFI_PHYSICAL_ADDRESS *Memory\r |
959ccb23 | 475 | );\r |
476 | \r | |
477 | /**\r | |
478 | The purpose of this service is to publish an interface that \r | |
479 | allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r | |
480 | \r | |
481 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
482 | @param Size The number of bytes to allocate from the pool.\r | |
483 | @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r | |
484 | \r | |
485 | @retval EFI_SUCCESS The allocation was successful.\r | |
486 | @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r | |
487 | \r | |
488 | **/\r | |
489 | typedef\r | |
490 | EFI_STATUS\r | |
6de794cd | 491 | (EFIAPI *EFI_PEI_ALLOCATE_POOL)(\r |
1c280088 | 492 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 493 | IN UINTN Size,\r |
494 | OUT VOID **Buffer\r | |
495 | );\r | |
496 | \r | |
497 | /**\r | |
498 | This service copies the contents of one buffer to another buffer.\r | |
499 | \r | |
af2dc6a7 | 500 | @param Destination The pointer to the destination buffer of the memory copy.\r |
501 | @param Source The pointer to the source buffer of the memory copy.\r | |
502 | @param Length The number of bytes to copy from Source to Destination.\r | |
959ccb23 | 503 | \r |
959ccb23 | 504 | **/\r |
505 | typedef\r | |
506 | VOID\r | |
6de794cd | 507 | (EFIAPI *EFI_PEI_COPY_MEM)(\r |
959ccb23 | 508 | IN VOID *Destination,\r |
509 | IN VOID *Source,\r | |
510 | IN UINTN Length\r | |
511 | );\r | |
512 | \r | |
513 | /**\r | |
514 | The service fills a buffer with a specified value.\r | |
515 | \r | |
af2dc6a7 | 516 | @param Buffer The pointer to the buffer to fill.\r |
517 | @param Size The number of bytes in Buffer to fill.\r | |
518 | @param Value The value to fill Buffer with.\r | |
959ccb23 | 519 | \r |
959ccb23 | 520 | **/\r |
521 | typedef\r | |
522 | VOID\r | |
6de794cd | 523 | (EFIAPI *EFI_PEI_SET_MEM)(\r |
959ccb23 | 524 | IN VOID *Buffer,\r |
525 | IN UINTN Size,\r | |
526 | IN UINT8 Value\r | |
527 | );\r | |
528 | \r | |
529 | /**\r | |
530 | This service publishes an interface that allows PEIMs to report status codes.\r | |
531 | \r | |
c7c308ad | 532 | ReportStatusCode() is called by PEIMs that wish to report status information on their\r |
533 | progress. The principal use model is for a PEIM to emit one of the standard 32-bit error codes. This\r | |
534 | will allow a platform owner to ascertain the state of the system, especially under conditions where\r | |
535 | the full consoles might not have been installed.\r | |
536 | \r | |
959ccb23 | 537 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r |
538 | @param Type Indicates the type of status code being reported.\r | |
539 | @param Value Describes the current status of a hardware or\r | |
540 | software entity. This includes information about the class and\r | |
541 | subclass that is used to classify the entity as well as an operation.\r | |
542 | For progress codes, the operation is the current activity.\r | |
543 | For error codes, it is the exception.For debug codes,it is not defined at this time.\r | |
544 | @param Instance The enumeration of a hardware or software entity within\r | |
545 | the system. A system may contain multiple entities that match a class/subclass\r | |
546 | pairing. The instance differentiates between them. An instance of 0 indicates\r | |
547 | that instance information is unavailable, not meaningful, or not relevant.\r | |
548 | Valid instance numbers start with 1.\r | |
549 | @param CallerId This optional parameter may be used to identify the caller.\r | |
550 | This parameter allows the status code driver to apply different rules to\r | |
551 | different callers.\r | |
552 | @param Data This optional parameter may be used to pass additional data.\r | |
553 | \r | |
554 | @retval EFI_SUCCESS The function completed successfully.\r | |
555 | @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.\r | |
556 | \r | |
557 | **/\r | |
558 | typedef\r | |
559 | EFI_STATUS\r | |
6de794cd | 560 | (EFIAPI *EFI_PEI_REPORT_STATUS_CODE)(\r |
1c280088 | 561 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
562 | IN EFI_STATUS_CODE_TYPE Type,\r | |
563 | IN EFI_STATUS_CODE_VALUE Value,\r | |
564 | IN UINT32 Instance,\r | |
565 | IN CONST EFI_GUID *CallerId OPTIONAL,\r | |
566 | IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
959ccb23 | 567 | );\r |
568 | \r | |
569 | /**\r | |
570 | Resets the entire platform.\r | |
571 | \r | |
c7c308ad | 572 | This service resets the entire platform, including all processors\r |
573 | and devices, and reboots the system.\r | |
574 | This service will never return EFI_SUCCESS. \r | |
575 | \r | |
959ccb23 | 576 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r |
577 | table published by the PEI Foundation.\r | |
578 | \r | |
959ccb23 | 579 | @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r |
580 | \r | |
581 | **/\r | |
582 | typedef\r | |
583 | EFI_STATUS\r | |
6de794cd | 584 | (EFIAPI *EFI_PEI_RESET_SYSTEM)(\r |
b0d803fe | 585 | IN CONST EFI_PEI_SERVICES **PeiServices\r |
959ccb23 | 586 | );\r |
587 | \r | |
ddcf46b2 SZ |
588 | /**\r |
589 | Resets the entire platform.\r | |
590 | \r | |
591 | @param[in] ResetType The type of reset to perform.\r | |
592 | @param[in] ResetStatus The status code for the reset.\r | |
593 | @param[in] DataSize The size, in bytes, of WatchdogData.\r | |
594 | @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r | |
595 | the data buffer starts with a Null-terminated string, optionally\r | |
596 | followed by additional binary data. The string is a description\r | |
597 | that the caller may use to further indicate the reason for the\r | |
598 | system reset. ResetData is only valid if ResetStatus is something\r | |
599 | other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r | |
600 | where a minimum amount of ResetData is always required.\r | |
601 | \r | |
602 | **/\r | |
603 | typedef\r | |
604 | VOID\r | |
605 | (EFIAPI *EFI_PEI_RESET2_SYSTEM) (\r | |
606 | IN EFI_RESET_TYPE ResetType,\r | |
607 | IN EFI_STATUS ResetStatus,\r | |
608 | IN UINTN DataSize,\r | |
609 | IN VOID *ResetData OPTIONAL\r | |
610 | );\r | |
611 | \r | |
959ccb23 | 612 | /**\r |
c7c308ad | 613 | Find a file within a volume by its name.\r |
614 | \r | |
00edb218 A |
615 | This service searches for files with a specific name, within\r |
616 | either the specified firmware volume or all firmware volumes.\r | |
617 | The service returns a file handle of type EFI_PEI_FILE_HANDLE,\r | |
959ccb23 | 618 | which must be unique within the system.\r |
619 | \r | |
00edb218 A |
620 | @param FileName A pointer to the name of the file to\r |
621 | find within the firmware volume.\r | |
c7c308ad | 622 | @param VolumeHandle The firmware volume to search.\r |
623 | @param FileHandle Upon exit, points to the found file's\r | |
959ccb23 | 624 | handle or NULL if it could not be found.\r |
625 | \r | |
af2dc6a7 | 626 | @retval EFI_SUCCESS The file was found.\r |
627 | @retval EFI_NOT_FOUND The file was not found.\r | |
00edb218 A |
628 | @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or\r |
629 | FileName was NULL.\r | |
959ccb23 | 630 | \r |
959ccb23 | 631 | **/\r |
632 | typedef\r | |
633 | EFI_STATUS\r | |
6de794cd | 634 | (EFIAPI *EFI_PEI_FFS_FIND_BY_NAME)(\r |
c7c308ad | 635 | IN CONST EFI_GUID *FileName,\r |
636 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
637 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
00edb218 | 638 | );\r |
959ccb23 | 639 | \r |
c7c308ad | 640 | ///\r |
af2dc6a7 | 641 | /// The information of the FV file.\r |
c7c308ad | 642 | ///\r |
959ccb23 | 643 | typedef struct {\r |
c7c308ad | 644 | ///\r |
645 | /// Name of the file.\r | |
646 | ///\r | |
00edb218 | 647 | EFI_GUID FileName;\r |
c7c308ad | 648 | ///\r |
649 | /// File type.\r | |
650 | ///\r | |
00edb218 | 651 | EFI_FV_FILETYPE FileType;\r |
c7c308ad | 652 | ///\r |
653 | /// Attributes of the file.\r | |
654 | ///\r | |
00edb218 | 655 | EFI_FV_FILE_ATTRIBUTES FileAttributes;\r |
c7c308ad | 656 | ///\r |
657 | /// Points to the file's data (not the header).\r | |
658 | /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r | |
659 | /// is zero.\r | |
660 | ///\r | |
00edb218 | 661 | VOID *Buffer;\r |
c7c308ad | 662 | ///\r |
242942b2 | 663 | /// Size of the file's data.\r |
c7c308ad | 664 | ///\r |
00edb218 | 665 | UINT32 BufferSize;\r |
959ccb23 | 666 | } EFI_FV_FILE_INFO;\r |
667 | \r | |
c7935105 SZ |
668 | ///\r |
669 | /// The information with authentication status of the FV file.\r | |
670 | ///\r | |
671 | typedef struct {\r | |
672 | ///\r | |
673 | /// Name of the file.\r | |
674 | ///\r | |
675 | EFI_GUID FileName;\r | |
676 | ///\r | |
677 | /// File type.\r | |
678 | ///\r | |
679 | EFI_FV_FILETYPE FileType;\r | |
680 | ///\r | |
681 | /// Attributes of the file.\r | |
682 | ///\r | |
683 | EFI_FV_FILE_ATTRIBUTES FileAttributes;\r | |
684 | ///\r | |
685 | /// Points to the file's data (not the header).\r | |
686 | /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r | |
687 | /// is zero.\r | |
688 | ///\r | |
689 | VOID *Buffer;\r | |
690 | ///\r | |
691 | /// Size of the file's data.\r | |
692 | ///\r | |
693 | UINT32 BufferSize;\r | |
694 | ///\r | |
695 | /// Authentication status for this file.\r | |
696 | ///\r | |
697 | UINT32 AuthenticationStatus;\r | |
698 | } EFI_FV_FILE_INFO2;\r | |
699 | \r | |
959ccb23 | 700 | /**\r |
c7c308ad | 701 | Returns information about a specific file.\r |
702 | \r | |
00edb218 A |
703 | This function returns information about a specific file,\r |
704 | including its file name, type, attributes, starting address and\r | |
af2dc6a7 | 705 | size. If the firmware volume is not memory mapped, then the\r |
959ccb23 | 706 | Buffer member will be NULL.\r |
707 | \r | |
af2dc6a7 | 708 | @param FileHandle The handle of the file.\r |
5528573c | 709 | @param FileInfo Upon exit, points to the file's\r |
959ccb23 | 710 | information.\r |
711 | \r | |
af2dc6a7 | 712 | @retval EFI_SUCCESS File information was returned.\r |
713 | @retval EFI_INVALID_PARAMETER FileHandle does not\r | |
959ccb23 | 714 | represent a valid file.\r |
af2dc6a7 | 715 | @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r |
959ccb23 | 716 | \r |
717 | **/\r | |
718 | typedef\r | |
719 | EFI_STATUS\r | |
6de794cd | 720 | (EFIAPI *EFI_PEI_FFS_GET_FILE_INFO)(\r |
c7c308ad | 721 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
1c280088 | 722 | OUT EFI_FV_FILE_INFO *FileInfo\r |
00edb218 | 723 | );\r |
959ccb23 | 724 | \r |
c7935105 SZ |
725 | /**\r |
726 | Returns information about a specific file.\r | |
727 | \r | |
728 | This function returns information about a specific file,\r | |
729 | including its file name, type, attributes, starting address, size and authentication status.\r | |
730 | If the firmware volume is not memory mapped, then the Buffer member will be NULL.\r | |
731 | \r | |
732 | @param FileHandle The handle of the file.\r | |
733 | @param FileInfo Upon exit, points to the file's\r | |
734 | information.\r | |
735 | \r | |
736 | @retval EFI_SUCCESS File information was returned.\r | |
737 | @retval EFI_INVALID_PARAMETER FileHandle does not\r | |
738 | represent a valid file.\r | |
739 | @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r | |
740 | \r | |
741 | **/\r | |
742 | typedef\r | |
743 | EFI_STATUS\r | |
744 | (EFIAPI *EFI_PEI_FFS_GET_FILE_INFO2)(\r | |
745 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
746 | OUT EFI_FV_FILE_INFO2 *FileInfo\r | |
747 | );\r | |
748 | \r | |
c7c308ad | 749 | ///\r |
af2dc6a7 | 750 | /// The information of the FV volume.\r |
c7c308ad | 751 | ///\r |
959ccb23 | 752 | typedef struct {\r |
c7c308ad | 753 | ///\r |
754 | /// Attributes of the firmware volume.\r | |
755 | ///\r | |
4ba967e7 | 756 | EFI_FVB_ATTRIBUTES_2 FvAttributes;\r |
c7c308ad | 757 | ///\r |
758 | /// Format of the firmware volume.\r | |
759 | ///\r | |
4ba967e7 | 760 | EFI_GUID FvFormat;\r |
c7c308ad | 761 | ///\r |
762 | /// Name of the firmware volume.\r | |
763 | ///\r | |
4ba967e7 | 764 | EFI_GUID FvName;\r |
c7c308ad | 765 | ///\r |
766 | /// Points to the first byte of the firmware\r | |
767 | /// volume, if bit EFI_FVB_MEMORY_MAPPED is\r | |
768 | /// set in FvAttributes.\r | |
769 | ///\r | |
4ba967e7 | 770 | VOID *FvStart;\r |
c7c308ad | 771 | ///\r |
772 | /// Size of the firmware volume.\r | |
773 | ///\r | |
4ba967e7 | 774 | UINT64 FvSize;\r |
959ccb23 | 775 | } EFI_FV_INFO;\r |
776 | \r | |
777 | /**\r | |
4b503a77 | 778 | Returns information about the specified volume.\r |
c7c308ad | 779 | \r |
00edb218 A |
780 | This function returns information about a specific firmware\r |
781 | volume, including its name, type, attributes, starting address\r | |
959ccb23 | 782 | and size.\r |
783 | \r | |
784 | @param VolumeHandle Handle of the volume.\r | |
5a9403b8 | 785 | @param VolumeInfo Upon exit, points to the volume's information.\r |
959ccb23 | 786 | \r |
af2dc6a7 | 787 | @retval EFI_SUCCESS The volume information returned.\r |
5a9403b8 | 788 | @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.\r |
789 | @retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.\r | |
af2dc6a7 | 790 | @retval EFI_SUCCESS Information was successfully returned.\r |
5a9403b8 | 791 | @retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.\r |
959ccb23 | 792 | \r |
793 | **/\r | |
794 | typedef\r | |
795 | EFI_STATUS\r | |
6de794cd | 796 | (EFIAPI *EFI_PEI_FFS_GET_VOLUME_INFO)(\r |
1c280088 | 797 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r |
798 | OUT EFI_FV_INFO *VolumeInfo\r | |
00edb218 | 799 | );\r |
959ccb23 | 800 | \r |
801 | /**\r | |
4b503a77 | 802 | Register a PEIM so that it will be shadowed and called again.\r |
c7c308ad | 803 | \r |
00edb218 A |
804 | This service registers a file handle so that after memory is\r |
805 | available, the PEIM will be re-loaded into permanent memory and\r | |
806 | re-initialized. The PEIM registered this way will always be\r | |
807 | initialized twice. The first time, this function call will\r | |
808 | return EFI_SUCCESS. The second time, this function call will\r | |
809 | return EFI_ALREADY_STARTED. Depending on the order in which\r | |
810 | PEIMs are dispatched, the PEIM making this call may be\r | |
811 | initialized after permanent memory is installed, even the first\r | |
959ccb23 | 812 | time.\r |
813 | \r | |
c7c308ad | 814 | @param FileHandle PEIM's file handle. Must be the currently\r |
4b503a77 | 815 | executing PEIM.\r |
959ccb23 | 816 | \r |
4ba967e7 | 817 | @retval EFI_SUCCESS The PEIM was successfully registered for\r |
818 | shadowing.\r | |
00edb218 | 819 | @retval EFI_ALREADY_STARTED The PEIM was previously\r |
959ccb23 | 820 | registered for shadowing.\r |
4ba967e7 | 821 | @retval EFI_NOT_FOUND The FileHandle does not refer to a\r |
822 | valid file handle.\r | |
959ccb23 | 823 | \r |
824 | **/\r | |
825 | typedef\r | |
826 | EFI_STATUS\r | |
6de794cd | 827 | (EFIAPI *EFI_PEI_REGISTER_FOR_SHADOW)(\r |
1c280088 | 828 | IN EFI_PEI_FILE_HANDLE FileHandle\r |
00edb218 | 829 | );\r |
959ccb23 | 830 | \r |
831 | \r | |
832 | //\r | |
833 | // PEI Specification Revision information\r | |
834 | //\r | |
835 | #define PEI_SPECIFICATION_MAJOR_REVISION 1\r | |
693bebd9 | 836 | #define PEI_SPECIFICATION_MINOR_REVISION 40\r |
32d4a8ef | 837 | ///\r |
af2dc6a7 | 838 | /// Specification inconsistency here: \r |
839 | /// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \r | |
840 | /// to pass a multiple tool chain, it appends an ULL.\r | |
32d4a8ef | 841 | ///\r |
959ccb23 | 842 | //\r |
843 | // PEI Services Table\r | |
844 | //\r | |
f490a61d | 845 | #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r |
32d4a8ef | 846 | ///\r |
af2dc6a7 | 847 | /// Specification inconsistency here: \r |
848 | /// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is \r | |
32d4a8ef | 849 | /// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))\r |
af2dc6a7 | 850 | /// and it should be as follows:\r |
32d4a8ef | 851 | ///\r |
ef4fa1a4 | 852 | #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r |
959ccb23 | 853 | \r |
6de794cd | 854 | /// \r |
855 | /// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r | |
856 | /// Foundation. These services fall into various classes, including the following:\r | |
857 | /// - Managing the boot mode\r | |
858 | /// - Allocating both early and permanent memory\r | |
859 | /// - Supporting the Firmware File System (FFS)\r | |
860 | /// - Abstracting the PPI database abstraction\r | |
af2dc6a7 | 861 | /// - Creating Hand-Off Blocks (HOBs).\r |
6de794cd | 862 | ///\r |
146332ae | 863 | struct _EFI_PEI_SERVICES {\r |
c7c308ad | 864 | ///\r |
865 | /// The table header for the PEI Services Table.\r | |
866 | ///\r | |
44717a39 | 867 | EFI_TABLE_HEADER Hdr;\r |
868 | \r | |
869 | //\r | |
870 | // PPI Functions\r | |
871 | //\r | |
872 | EFI_PEI_INSTALL_PPI InstallPpi;\r | |
873 | EFI_PEI_REINSTALL_PPI ReInstallPpi;\r | |
874 | EFI_PEI_LOCATE_PPI LocatePpi;\r | |
875 | EFI_PEI_NOTIFY_PPI NotifyPpi;\r | |
876 | \r | |
877 | //\r | |
878 | // Boot Mode Functions\r | |
879 | //\r | |
880 | EFI_PEI_GET_BOOT_MODE GetBootMode;\r | |
881 | EFI_PEI_SET_BOOT_MODE SetBootMode;\r | |
882 | \r | |
883 | //\r | |
884 | // HOB Functions\r | |
885 | //\r | |
886 | EFI_PEI_GET_HOB_LIST GetHobList;\r | |
887 | EFI_PEI_CREATE_HOB CreateHob;\r | |
888 | \r | |
889 | //\r | |
890 | // Firmware Volume Functions\r | |
891 | //\r | |
00edb218 A |
892 | EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume;\r |
893 | EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile;\r | |
894 | EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData;\r | |
44717a39 | 895 | \r |
896 | //\r | |
897 | // PEI Memory Functions\r | |
898 | //\r | |
899 | EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory;\r | |
900 | EFI_PEI_ALLOCATE_PAGES AllocatePages;\r | |
901 | EFI_PEI_ALLOCATE_POOL AllocatePool;\r | |
902 | EFI_PEI_COPY_MEM CopyMem;\r | |
903 | EFI_PEI_SET_MEM SetMem;\r | |
904 | \r | |
905 | //\r | |
906 | // Status Code\r | |
907 | //\r | |
908 | EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r | |
909 | \r | |
910 | //\r | |
911 | // Reset\r | |
912 | //\r | |
913 | EFI_PEI_RESET_SYSTEM ResetSystem;\r | |
914 | \r | |
915 | //\r | |
916 | // (the following interfaces are installed by publishing PEIM)\r | |
917 | // I/O Abstractions\r | |
918 | //\r | |
919 | EFI_PEI_CPU_IO_PPI *CpuIo;\r | |
920 | EFI_PEI_PCI_CFG2_PPI *PciCfg;\r | |
921 | \r | |
922 | //\r | |
923 | // Future Installed Services\r | |
924 | //\r | |
925 | EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName;\r | |
926 | EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo;\r | |
927 | EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r | |
928 | EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r | |
c7935105 SZ |
929 | EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3;\r |
930 | EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2;\r | |
ddcf46b2 | 931 | EFI_PEI_RESET2_SYSTEM ResetSystem2;\r |
00edb218 | 932 | };\r |
959ccb23 | 933 | \r |
934 | \r | |
6de794cd | 935 | ///\r |
af2dc6a7 | 936 | /// EFI_SEC_PEI_HAND_OFF structure holds information about\r |
6de794cd | 937 | /// PEI core's operating environment, such as the size of location of\r |
938 | /// temporary RAM, the stack location and BFV location.\r | |
939 | /// \r | |
959ccb23 | 940 | typedef struct _EFI_SEC_PEI_HAND_OFF {\r |
c7c308ad | 941 | ///\r |
942 | /// Size of the data structure.\r | |
943 | /// \r | |
959ccb23 | 944 | UINT16 DataSize;\r |
945 | \r | |
c7c308ad | 946 | ///\r |
947 | /// Points to the first byte of the boot firmware volume, \r | |
948 | /// which the PEI Dispatcher should search for \r | |
949 | /// PEI modules.\r | |
950 | /// \r | |
959ccb23 | 951 | VOID *BootFirmwareVolumeBase;\r |
952 | \r | |
c7c308ad | 953 | ///\r |
954 | /// Size of the boot firmware volume, in bytes.\r | |
955 | /// \r | |
959ccb23 | 956 | UINTN BootFirmwareVolumeSize;\r |
957 | \r | |
c7c308ad | 958 | ///\r |
959 | /// Points to the first byte of the temporary RAM.\r | |
960 | /// \r | |
959ccb23 | 961 | VOID *TemporaryRamBase;\r |
962 | \r | |
c7c308ad | 963 | ///\r |
964 | /// Size of the temporary RAM, in bytes.\r | |
965 | /// \r | |
959ccb23 | 966 | UINTN TemporaryRamSize;\r |
967 | \r | |
c7c308ad | 968 | ///\r |
969 | /// Points to the first byte of the temporary RAM \r | |
970 | /// available for use by the PEI Foundation. The area \r | |
971 | /// described by PeiTemporaryRamBase and PeiTemporaryRamSize \r | |
972 | /// must not extend outside beyond the area described by\r | |
973 | /// TemporaryRamBase & TemporaryRamSize. This area should not\r | |
974 | /// overlap with the area reported by StackBase and \r | |
975 | /// StackSize.\r | |
976 | ///\r | |
959ccb23 | 977 | VOID *PeiTemporaryRamBase;\r |
978 | \r | |
c7c308ad | 979 | ///\r |
af2dc6a7 | 980 | /// The size of the available temporary RAM available for \r |
c7c308ad | 981 | /// use by the PEI Foundation, in bytes.\r |
982 | /// \r | |
959ccb23 | 983 | UINTN PeiTemporaryRamSize;\r |
984 | \r | |
c7c308ad | 985 | ///\r |
986 | /// Points to the first byte of the stack. \r | |
987 | /// This are may be part of the memory described by \r | |
988 | /// TemporaryRamBase and TemporaryRamSize \r | |
989 | /// or may be an entirely separate area.\r | |
990 | /// \r | |
959ccb23 | 991 | VOID *StackBase;\r |
992 | \r | |
c7c308ad | 993 | ///\r |
994 | /// Size of the stack, in bytes.\r | |
995 | /// \r | |
959ccb23 | 996 | UINTN StackSize;\r |
997 | } EFI_SEC_PEI_HAND_OFF;\r | |
998 | \r | |
fb3df220 | 999 | \r |
1000 | /**\r | |
af2dc6a7 | 1001 | The entry point of PEI Foundation.\r |
fb3df220 | 1002 | \r |
1003 | This function is the entry point for the PEI Foundation, which\r | |
1004 | allows the SEC phase to pass information about the stack,\r | |
1005 | temporary RAM and the Boot Firmware Volume. In addition, it also\r | |
1006 | allows the SEC phase to pass services and data forward for use\r | |
1007 | during the PEI phase in the form of one or more PPIs. There is\r | |
1008 | no limit to the number of additional PPIs that can be passed\r | |
1009 | from SEC into the PEI Foundation. As part of its initialization\r | |
1010 | phase, the PEI Foundation will add these SEC-hosted PPIs to its\r | |
1011 | PPI database such that both the PEI Foundation and any modules\r | |
1012 | can leverage the associated service calls and/or code in these\r | |
1013 | early PPIs.\r | |
1014 | \r | |
1015 | @param SecCoreData Points to a data structure containing\r | |
1016 | information about the PEI core's\r | |
1017 | operating environment, such as the size\r | |
1018 | and location of temporary RAM, the stack\r | |
4b503a77 | 1019 | location and the BFV location.\r |
fb3df220 | 1020 | \r |
1021 | @param PpiList Points to a list of one or more PPI\r | |
1022 | descriptors to be installed initially by\r | |
1023 | the PEI core. An empty PPI list consists\r | |
1024 | of a single descriptor with the end-tag\r | |
1025 | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r | |
1026 | As part of its initialization phase, the\r | |
1027 | PEI Foundation will add these SEC-hosted\r | |
1028 | PPIs to its PPI database such that both\r | |
1029 | the PEI Foundation and any modules can\r | |
1030 | leverage the associated service calls\r | |
1031 | and/or code in these early PPIs.\r | |
1032 | \r | |
1033 | \r | |
1034 | **/\r | |
1035 | typedef\r | |
1036 | VOID\r | |
e5544398 | 1037 | (EFIAPI *EFI_PEI_CORE_ENTRY_POINT)(\r |
fb3df220 | 1038 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r |
1039 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
1040 | );\r | |
1041 | \r | |
959ccb23 | 1042 | #endif\r |