2 Framework PEI master include file. This file should match the PEI CIS spec.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 @par Revision Reference:
20 #ifndef __PEIM_CIS_H__
21 #define __PEIM_CIS_H__
23 #include <Common/MultiPhase.h>
24 #include <Common/BootMode.h>
25 #include <Common/Hob.h>
26 #include <Common/FirmwareVolumeImageFormat.h>
27 #include <Common/FirmwareVolumeHeader.h>
28 #include <Common/FirmwareFileSystem.h>
29 #include <Common/Dependency.h>
31 #define TIANO_ERROR(a) (MAX_2_BITS | (a))
33 #if (EFI_SPECIFICATION_VERSION < 0x00020000)
35 // Tiano added a couple of return types. These are owned by UEFI specification
36 // and Tiano can not use them. Thus for UEFI 2.0/R9 support we moved the values
37 // to a UEFI OEM extension range to conform to UEFI specification.
39 #define EFI_NOT_AVAILABLE_YET EFIERR (28)
40 #define EFI_UNLOAD_IMAGE EFIERR (29)
42 #define EFI_NOT_AVAILABLE_YET TIANO_ERROR (0)
43 #define EFI_UNLOAD_IMAGE TIANO_ERROR (1)
47 // Declare forward referenced data structures
49 typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES
;
50 typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR
;
53 #include <Ppi/CpuIo.h>
54 #include <Ppi/PciCfg.h>
57 // PEI Specification Revision information
59 #define PEI_SPECIFICATION_MAJOR_REVISION 0
60 #define PEI_SPECIFICATION_MINOR_REVISION 91
63 The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI
64 Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
66 @param FfsHeader Pointer to the FFS file header.
67 @param PeiServices Describes the list of possible PEI Services.
74 (EFIAPI
*EFI_PEIM_ENTRY_POINT
)(
75 IN EFI_FFS_FILE_HEADER
*FfsHeader
,
76 IN EFI_PEI_SERVICES
**PeiServices
80 Entry point of the notification callback function itself within the PEIM.
82 @param PeiServices Indirect reference to the PEI Services Table.
83 @param NotifyDescriptor Address of the notification descriptor data structure.
84 @param Ppi Address of the PPI that was installed.
91 (EFIAPI
*EFI_PEIM_NOTIFY_ENTRY_POINT
) (
92 IN EFI_PEI_SERVICES
**PeiServices
,
93 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
98 // PEI Ppi Services List Descriptors
100 #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001
101 #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010
102 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020
103 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040
104 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060
105 #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000
111 } EFI_PEI_PPI_DESCRIPTOR
;
113 struct _EFI_PEI_NOTIFY_DESCRIPTOR
{
116 EFI_PEIM_NOTIFY_ENTRY_POINT Notify
;
120 This service is the first one provided by the PEI Foundation. This function
121 installs an interface in the PEI PPI database by GUID. The purpose of the
122 service is to publish an interface that other parties can use to call
125 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
126 published by the PEI Foundation.
127 @param PpiList A pointer to the list of interfaces that the caller shall install.
129 @retval EFI_SUCCESS The interface was successfully installed.
130 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
131 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
136 (EFIAPI
*EFI_PEI_INSTALL_PPI
) (
137 IN EFI_PEI_SERVICES
**PeiServices
,
138 IN EFI_PEI_PPI_DESCRIPTOR
*PpiList
142 This function reinstalls an interface in the PEI PPI database by GUID.
143 The purpose of the service is to publish an interface that other parties
144 can use to replace a same-named interface in the protocol database
145 with a different interface.
147 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
148 published by the PEI Foundation.
149 @param OldPpi A pointer to the former PPI in the database.
150 @param NewPpi A pointer to the new interfaces that the caller shall install.
152 @retval EFI_SUCCESS The interface was successfully installed.
153 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
154 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
155 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
156 @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.
161 (EFIAPI
*EFI_PEI_REINSTALL_PPI
) (
162 IN EFI_PEI_SERVICES
**PeiServices
,
163 IN EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
164 IN EFI_PEI_PPI_DESCRIPTOR
*NewPpi
168 This function locates an interface in the PEI PPI database by GUID.
170 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
171 @param Guid A pointer to the GUID whose corresponding interface needs to be found.
172 @param Instance The N-th instance of the interface that is required.
173 @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
174 @param Ppi A pointer to the instance of the interface.
176 @retval EFI_SUCCESS The interface was successfully returned.
177 @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
182 (EFIAPI
*EFI_PEI_LOCATE_PPI
) (
183 IN EFI_PEI_SERVICES
**PeiServices
,
186 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor
,
191 This function installs a notification service to be called back when a
192 given interface is installed or reinstalled. The purpose of the service
193 is to publish an interface that other parties can use to call additional PPIs
194 that may materialize later.
196 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
197 @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
199 @retval EFI_SUCCESS The interface was successfully installed.
200 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
201 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
202 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
207 (EFIAPI
*EFI_PEI_NOTIFY_PPI
) (
208 IN EFI_PEI_SERVICES
**PeiServices
,
209 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
213 This function returns the present value of the boot mode.
215 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
216 @param BootMode A pointer to contain the value of the boot mode.
218 @retval EFI_SUCCESS The boot mode was returned successfully.
223 (EFIAPI
*EFI_PEI_GET_BOOT_MODE
) (
224 IN EFI_PEI_SERVICES
**PeiServices
,
225 OUT EFI_BOOT_MODE
*BootMode
229 This function sets the value of the boot mode.
231 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
232 @param BootMode The value of the boot mode to set.
234 @retval EFI_SUCCESS The boot mode was returned successfully.
239 (EFIAPI
*EFI_PEI_SET_BOOT_MODE
) (
240 IN EFI_PEI_SERVICES
**PeiServices
,
241 IN EFI_BOOT_MODE BootMode
245 This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.
247 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
248 @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize
250 @retval EFI_SUCCESS The list was successfully returned.
251 @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
256 (EFIAPI
*EFI_PEI_GET_HOB_LIST
) (
257 IN EFI_PEI_SERVICES
**PeiServices
,
258 IN OUT VOID
**HobList
262 This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.
264 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
265 @param Type The type of HOB to be installed.
266 @param Length The length of the HOB to be added.
267 @param Hob The address of a pointer that will contain the HOB header.
269 @retval EFI_SUCCESS The HOB was successfully created.
270 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
275 (EFIAPI
*EFI_PEI_CREATE_HOB
) (
276 IN EFI_PEI_SERVICES
**PeiServices
,
283 The purpose of the service is to abstract the capability of the PEI
284 Foundation to discover instances of firmware volumes in the system.
285 Given the input file pointer, this service searches for the next
286 matching file in the Firmware File System (FFS) volume.
288 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
289 @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
290 @param FwVolHeader Pointer to the firmware volume header of the volume to return.
292 @retval EFI_SUCCESS The volume was found.
293 @retval EFI_NOT_FOUND The volume was not found.
294 @retval EFI_INVALID_PARAMETER FwVolHeader is NULL
299 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_VOLUME
) (
300 IN EFI_PEI_SERVICES
**PeiServices
,
302 IN OUT EFI_FIRMWARE_VOLUME_HEADER
**FwVolHeader
306 The purpose of the service is to abstract the capability of the PEI
307 Foundation to discover instances of firmware files in the system.
308 Given the input file pointer, this service searches for the next matching
309 file in the Firmware File System (FFS) volume.
311 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
312 @param SearchType A filter to find files only of this type.
313 @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter
314 must point to a valid FFS volume.
315 @param FileHeader Pointer to the current file from which to begin searching.This pointer will be
316 updated upon return to reflect the file found.
318 @retval EFI_SUCCESS The file was found.
319 @retval EFI_NOT_FOUND The file was not found.
320 @retval EFI_NOT_FOUND The header checksum was not zero.
325 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_FILE
) (
326 IN EFI_PEI_SERVICES
**PeiServices
,
327 IN EFI_FV_FILETYPE SearchType
,
328 IN EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
,
329 IN OUT EFI_FFS_FILE_HEADER
**FileHeader
333 Given the input file pointer, this service searches for the next
334 matching file in the Firmware File System (FFS) volume.
336 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
337 @param SectionType The value of the section type to find.
338 @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.
339 @param SectionData A pointer to the discovered section, if successful.
341 @retval EFI_SUCCESS The section was found.
342 @retval EFI_NOT_FOUND The section was not found.
347 (EFIAPI
*EFI_PEI_FFS_FIND_SECTION_DATA
) (
348 IN EFI_PEI_SERVICES
**PeiServices
,
349 IN EFI_SECTION_TYPE SectionType
,
350 IN EFI_FFS_FILE_HEADER
*FfsFileHeader
,
351 IN OUT VOID
**SectionData
355 This function registers the found memory configuration with the PEI Foundation.
357 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
358 @param MemoryBegin The value of a region of installed memory
359 @param MemoryLength The corresponding length of a region of installed memory.
361 @retval EFI_SUCCESS The region was successfully installed in a HOB.
362 @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
363 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
368 (EFIAPI
*EFI_PEI_INSTALL_PEI_MEMORY
) (
369 IN EFI_PEI_SERVICES
**PeiServices
,
370 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
371 IN UINT64 MemoryLength
375 The purpose of the service is to publish an interface that allows
376 PEIMs to allocate memory ranges that are managed by the PEI Foundation.
378 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
379 @param MemoryType The type of memory to allocate.
380 @param Pages The number of contiguous 4 KB pages to allocate.
381 @param Memory Pointer to a physical address. On output, the address is set to the base
382 of the page range that was allocated.
384 @retval EFI_SUCCESS The memory range was successfully allocated.
385 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
386 @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.
391 (EFIAPI
*EFI_PEI_ALLOCATE_PAGES
) (
392 IN EFI_PEI_SERVICES
**PeiServices
,
393 IN EFI_MEMORY_TYPE MemoryType
,
395 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
399 The purpose of this service is to publish an interface that
400 allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
402 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
403 @param Size The number of bytes to allocate from the pool.
404 @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
406 @retval EFI_SUCCESS The allocation was successful.
407 @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
412 (EFIAPI
*EFI_PEI_ALLOCATE_POOL
) (
413 IN EFI_PEI_SERVICES
**PeiServices
,
419 This service copies the contents of one buffer to another buffer.
421 @param Destination Pointer to the destination buffer of the memory copy.
422 @param Source Pointer to the source buffer of the memory copy
423 @param Length Number of bytes to copy from Source to Destination.
430 (EFIAPI
*EFI_PEI_COPY_MEM
) (
431 IN VOID
*Destination
,
437 The service fills a buffer with a specified value.
439 @param Buffer Pointer to the buffer to fill.
440 @param Size Number of bytes in Buffer to fill.
441 @param Value Value to fill Buffer with
448 (EFIAPI
*EFI_PEI_SET_MEM
) (
455 This service publishes an interface that allows PEIMs to report status codes.
457 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
458 @param Type Indicates the type of status code being reported.
459 @param Value Describes the current status of a hardware or
460 software entity. This includes information about the class and
461 subclass that is used to classify the entity as well as an operation.
462 For progress codes, the operation is the current activity.
463 For error codes, it is the exception.For debug codes,it is not defined at this time.
464 @param Instance The enumeration of a hardware or software entity within
465 the system. A system may contain multiple entities that match a class/subclass
466 pairing. The instance differentiates between them. An instance of 0 indicates
467 that instance information is unavailable, not meaningful, or not relevant.
468 Valid instance numbers start with 1.
469 @param CallerId This optional parameter may be used to identify the caller.
470 This parameter allows the status code driver to apply different rules to
472 @param Data This optional parameter may be used to pass additional data.
474 @retval EFI_SUCCESS The function completed successfully.
475 @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.
480 (EFIAPI
*EFI_PEI_REPORT_STATUS_CODE
) (
481 IN EFI_PEI_SERVICES
**PeiServices
,
482 IN EFI_STATUS_CODE_TYPE Type
,
483 IN EFI_STATUS_CODE_VALUE Value
,
485 IN EFI_GUID
*CallerId OPTIONAL
,
486 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
490 Resets the entire platform.
492 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES
493 table published by the PEI Foundation.
495 @retval EFI_SUCCESS The function completed successfully.
496 @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
501 (EFIAPI
*EFI_PEI_RESET_SYSTEM
) (
502 IN EFI_PEI_SERVICES
**PeiServices
506 // EFI PEI Services Table
508 #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL
509 #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION << 16) | (PEI_SPECIFICATION_MINOR_REVISION))
511 struct _EFI_PEI_SERVICES
{
512 EFI_TABLE_HEADER Hdr
;
517 EFI_PEI_INSTALL_PPI InstallPpi
;
518 EFI_PEI_REINSTALL_PPI ReInstallPpi
;
519 EFI_PEI_LOCATE_PPI LocatePpi
;
520 EFI_PEI_NOTIFY_PPI NotifyPpi
;
523 // Boot Mode Functions
525 EFI_PEI_GET_BOOT_MODE GetBootMode
;
526 EFI_PEI_SET_BOOT_MODE SetBootMode
;
531 EFI_PEI_GET_HOB_LIST GetHobList
;
532 EFI_PEI_CREATE_HOB CreateHob
;
535 // Filesystem Functions
537 EFI_PEI_FFS_FIND_NEXT_VOLUME FfsFindNextVolume
;
538 EFI_PEI_FFS_FIND_NEXT_FILE FfsFindNextFile
;
539 EFI_PEI_FFS_FIND_SECTION_DATA FfsFindSectionData
;
544 EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory
;
545 EFI_PEI_ALLOCATE_PAGES AllocatePages
;
546 EFI_PEI_ALLOCATE_POOL AllocatePool
;
547 EFI_PEI_COPY_MEM CopyMem
;
548 EFI_PEI_SET_MEM SetMem
;
553 EFI_PEI_REPORT_STATUS_CODE PeiReportStatusCode
;
558 EFI_PEI_RESET_SYSTEM PeiResetSystem
;
561 // Pointer to PPI interface
563 EFI_PEI_CPU_IO_PPI
*CpuIo
;
564 EFI_PEI_PCI_CFG_PPI
*PciCfg
;
569 UINTN BootFirmwareVolume
;
570 UINTN SizeOfCacheAsRam
;
571 EFI_PEI_PPI_DESCRIPTOR
*DispatchTable
;
572 } EFI_PEI_STARTUP_DESCRIPTOR
;
574 #include <Common/EfiImage.h>
575 #include <Common/StatusCode.h>
576 #include <Common/BootScript.h>
577 #include <Common/Capsule.h>
579 #include <Guid/Apriori.h>
580 #include <Guid/Capsule.h>
581 #include <Guid/DxeServices.h>
582 #include <Guid/HobList.h>
583 #include <Guid/MemoryAllocationHob.h>
584 #include <Guid/FirmwareFileSystem.h>
585 #include <Guid/SmramMemoryReserve.h>
586 #include <Guid/GlobalVariable.h>
588 #include <Ppi/BlockIo.h>
589 #include <Ppi/BootInRecoveryMode.h>
590 #include <Ppi/BootScriptExecuter.h>
591 #include <Ppi/DeviceRecoveryModule.h>
592 #include <Ppi/DxeIpl.h>
593 #include <Ppi/EndOfPeiPhase.h>
594 #include <Ppi/FindFv.h>
595 #include <Ppi/LoadFile.h>
596 #include <Ppi/MasterBootMode.h>
597 #include <Ppi/MemoryDiscovered.h>
599 #include <Ppi/ReadOnlyVariable.h>
600 #include <Ppi/RecoveryModule.h>
601 #include <Ppi/Reset.h>
602 #include <Ppi/S3Resume.h>
603 #include <Ppi/SecPlatformInformation.h>
604 #include <Ppi/SectionExtraction.h>
605 #include <Ppi/Security.h>
606 #include <Ppi/Smbus.h>
607 #include <Ppi/Stall.h>
608 #include <Ppi/StatusCode.h>
610 #include <Protocol/FirmwareVolumeBlock.h>