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