2 Definition of Pei Core Structures and Services
4 Copyright (c) 2006 - 2007, 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.
19 #include <Ppi/DxeIpl.h>
20 #include <Ppi/MemoryDiscovered.h>
21 #include <Ppi/StatusCode.h>
22 #include <Ppi/Reset.h>
23 #include <Ppi/FirmwareVolume.h>
24 #include <Ppi/FirmwareVolumeInfo.h>
25 #include <Ppi/Decompress.h>
26 #include <Ppi/GuidedSectionExtraction.h>
27 #include <Ppi/LoadFile.h>
28 #include <Ppi/Security2.h>
29 #include <Ppi/TemporaryRamSupport.h>
30 #include <Library/DebugLib.h>
31 #include <Library/PeiCoreEntryPoint.h>
32 #include <Library/BaseLib.h>
33 #include <Library/HobLib.h>
34 #include <Library/PerformanceLib.h>
35 #include <Library/PeiServicesLib.h>
36 #include <Library/ReportStatusCodeLib.h>
37 #include <Library/PeCoffLib.h>
38 #include <Library/PeCoffGetEntryPointLib.h>
39 #include <Library/BaseMemoryLib.h>
40 #include <Library/CacheMaintenanceLib.h>
41 #include <Library/TimerLib.h>
42 #include <Library/PcdLib.h>
43 #include <IndustryStandard/PeImage.h>
44 #include <Library/PeiServicesTablePointerLib.h>
45 #include <Library/MemoryAllocationLib.h>
46 #include <Library/PeiPiLib.h>
47 #include <Guid/FirmwareFileSystem2.h>
48 #include <Guid/AprioriFileName.h>
50 #define PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE 0xff
53 /// Pei Core private data structures
56 EFI_PEI_PPI_DESCRIPTOR
*Ppi
;
57 EFI_PEI_NOTIFY_DESCRIPTOR
*Notify
;
59 } PEI_PPI_LIST_POINTERS
;
62 /// PPI database structure
68 INTN LastDispatchedInstall
;
69 INTN LastDispatchedNotify
;
70 PEI_PPI_LIST_POINTERS PpiListPtrs
[FixedPcdGet32 (PcdPeiCoreMaxPpiSupported
)];
75 // PEI_CORE_FV_HANDE.PeimState
76 // Do not change these values as there is code doing math to change states.
77 // Look for Private->Fv[FvCount].PeimState[PeimCount]++;
79 #define PEIM_STATE_NOT_DISPATCHED 0x00
80 #define PEIM_STATE_DISPATCHED 0x01
81 #define PEIM_STATE_REGISITER_FOR_SHADOW 0x02
82 #define PEIM_STATE_DONE 0x03
85 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
86 UINT8 PeimState
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
87 EFI_PEI_FILE_HANDLE FvFileHandles
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
91 #define CACHE_SETION_MAX_NUMBER 0x10
93 EFI_COMMON_SECTION_HEADER
* Section
[CACHE_SETION_MAX_NUMBER
];
94 VOID
* SectionData
[CACHE_SETION_MAX_NUMBER
];
95 UINTN SectionSize
[CACHE_SETION_MAX_NUMBER
];
96 UINTN AllSectionCount
;
101 #define PEI_CORE_HANDLE_SIGNATURE EFI_SIGNATURE_32('P','e','i','C')
104 /// Pei Core private data structure instance
108 EFI_PEI_SERVICES
*PS
; // Point to ServiceTableShadow
109 PEI_PPI_DATABASE PpiData
;
111 PEI_CORE_FV_HANDLE Fv
[FixedPcdGet32 (PcdPeiCoreMaxFvSupported
)];
112 EFI_PEI_FILE_HANDLE CurrentFvFileHandles
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
114 UINTN CurrentPeimFvCount
;
115 UINTN CurrentPeimCount
;
116 EFI_PEI_FILE_HANDLE CurrentFileHandle
;
118 EFI_PEI_FV_HANDLE AllFv
[FixedPcdGet32 (PcdPeiCoreMaxFvSupported
)];
119 EFI_PEI_HOB_POINTERS HobList
;
120 BOOLEAN SwitchStackSignal
;
121 BOOLEAN PeiMemoryInstalled
;
122 EFI_PHYSICAL_ADDRESS StackBase
;
124 VOID
*BottomOfCarHeap
;
127 EFI_PEI_SECURITY2_PPI
*PrivateSecurityPpi
;
128 EFI_PEI_SERVICES ServiceTableShadow
;
129 UINTN SizeOfTemporaryMemory
;
130 UINTN SizeOfCacheAsRam
;
131 VOID
*MaxTopOfCarHeap
;
132 EFI_PEI_PPI_DESCRIPTOR
*XipLoadFile
;
133 EFI_PHYSICAL_ADDRESS PhysicalMemoryBegin
;
134 UINT64 PhysicalMemoryLength
;
135 EFI_PHYSICAL_ADDRESS FreePhysicalMemoryTop
;
136 VOID
* ShadowedPeiCore
;
137 CACHE_SECTION_DATA CacheSection
;
141 /// Pei Core Instance Data Macros
143 #define PEI_CORE_INSTANCE_FROM_PS_THIS(a) \
144 CR(a, PEI_CORE_INSTANCE, PS, PEI_CORE_HANDLE_SIGNATURE)
148 (EFIAPI
*PEI_CORE_ENTRY_POINT
)(
149 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
150 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
,
151 IN PEI_CORE_INSTANCE
*OldCoreData
155 /// Union of temporarily used function pointers (to save stack space)
158 PEI_CORE_ENTRY_POINT PeiCore
;
159 EFI_PEIM_ENTRY_POINT2 PeimEntry
;
160 EFI_PEIM_NOTIFY_ENTRY_POINT PeimNotifyEntry
;
161 EFI_DXE_IPL_PPI
*DxeIpl
;
162 EFI_PEI_PPI_DESCRIPTOR
*PpiDescriptor
;
163 EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
;
165 } PEI_CORE_TEMP_POINTERS
;
170 CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
171 EFI_PEI_PPI_DESCRIPTOR
*PpiList
;
173 } PEI_CORE_PARAMETERS
;
180 The entry routine to Pei Core, invoked by PeiMain during transition
181 from SEC to PEI. After switching stack in the PEI core, it will restart
182 with the old core data.
185 @param SecCoreData Points to a data structure containing information about the PEI core's operating
186 environment, such as the size and location of temporary RAM, the stack location and
188 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
189 An empty PPI list consists of a single descriptor with the end-tag
190 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
191 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
192 that both the PEI Foundation and any modules can leverage the associated service
193 calls and/or code in these early PPIs
194 @param Data Pointer to old core data that is used to initialize the
197 @retval EFI_NOT_FOUND Never reach
203 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
204 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpList
,
210 // Dispatcher support functions
215 This is the POSTFIX version of the dependency evaluator. When a
216 PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on
217 the evaluation stack. When that entry is poped from the evaluation
218 stack, the PPI is checked if it is installed. This method allows
219 some time savings as not all PPIs must be checked for certain
220 operation types (AND, OR).
223 @param PeiServices Calling context.
224 @param DependencyExpression Pointer to a dependency expression. The Grammar adheres to
225 the BNF described above and is stored in postfix notation.
227 @retval TRUE if it is a well-formed Grammar
228 @retval FALSE if the dependency expression overflows the evaluation stack
229 if the dependency expression underflows the evaluation stack
230 if the dependency expression is not a well-formed Grammar.
234 PeimDispatchReadiness (
235 IN EFI_PEI_SERVICES
**PeiServices
,
236 IN VOID
*DependencyExpression
241 Conduct PEIM dispatch.
243 @param SecCoreData Points to a data structure containing information about the PEI core's operating
244 environment, such as the size and location of temporary RAM, the stack location and
246 PrivateData - Pointer to the private data passed in from caller
247 DispatchData - Pointer to PEI_CORE_DISPATCH_DATA data.
248 @param Private EDES_TODO: Add parameter description
250 @retval EFI_SUCCESS Successfully dispatched PEIM.
251 @retval EFI_NOT_FOUND The dispatch failed.
256 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
257 IN PEI_CORE_INSTANCE
*PrivateData
262 Initialize the Dispatcher's data members
264 @param PrivateData PeiCore's private data structure
265 @param OldCoreData Old data from SecCore
266 NULL if being run in non-permament memory mode.
267 @param SecCoreData Points to a data structure containing information about the PEI core's operating
268 environment, such as the size and location of temporary RAM, the stack location and
273 InitializeDispatcherData (
274 IN PEI_CORE_INSTANCE
*PrivateData
,
275 IN PEI_CORE_INSTANCE
*OldCoreData
,
276 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
281 This routine parses the Dependency Expression, if available, and
282 decides if the module can be executed.
285 @param Private PeiCore's private data structure
286 @param FileHandle PEIM's file handle
287 @param PeimCount Peim count in all dispatched PEIMs.
289 @retval TRUE Can be dispatched
290 @retval FALSE Cannot be dispatched
295 IN PEI_CORE_INSTANCE
*Private
,
296 IN EFI_PEI_FILE_HANDLE FileHandle
,
302 // PPI support functions
306 Initialize PPI services.
308 @param PrivateData Pointer to the PEI Core data.
309 @param OldCoreData Pointer to old PEI Core data.
310 NULL if being run in non-permament memory mode.
314 InitializePpiServices (
315 IN PEI_CORE_INSTANCE
*PrivateData
,
316 IN PEI_CORE_INSTANCE
*OldCoreData
322 Migrate the Hob list from the CAR stack to PEI installed memory.
324 @param PeiServices The PEI core services table.
325 @param OldCheckingBottom The old checking bottom.
326 @param OldCheckingTop The old checking top.
327 @param Fixup The address difference between
328 the new Hob list and old Hob list.
333 IN PEI_CORE_INSTANCE
*PrivateData
,
334 IN UINTN OldCheckingBottom
,
335 IN UINTN OldCheckingTop
,
342 Install PPI services.
344 @param PeiServices - Pointer to the PEI Service Table
345 @param PpiList - Pointer to a list of PEI PPI Descriptors.
347 @retval EFI_SUCCESS - if all PPIs in PpiList are successfully installed.
348 @retval EFI_INVALID_PARAMETER - if PpiList is NULL pointer
349 @retval EFI_INVALID_PARAMETER - if any PPI in PpiList is not valid
350 @retval EFI_OUT_OF_RESOURCES - if there is no more memory resource to install PPI
356 IN CONST EFI_PEI_SERVICES
**PeiServices
,
357 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
363 Re-Install PPI services.
365 @param PeiServices - Pointer to the PEI Service Table
366 @param OldPpi - Pointer to the old PEI PPI Descriptors.
367 @param NewPpi - Pointer to the new PEI PPI Descriptors.
369 @retval EFI_SUCCESS - if the operation was successful
370 @retval EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL
371 @retval EFI_INVALID_PARAMETER - if NewPpi is not valid
372 @retval EFI_NOT_FOUND - if the PPI was not in the database
378 IN CONST EFI_PEI_SERVICES
**PeiServices
,
379 IN CONST EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
380 IN CONST EFI_PEI_PPI_DESCRIPTOR
*NewPpi
386 Locate a given named PPI.
389 @param PeiServices - Pointer to the PEI Service Table
390 @param Guid - Pointer to GUID of the PPI.
391 @param Instance - Instance Number to discover.
392 @param PpiDescriptor - Pointer to reference the found descriptor. If not NULL,
393 returns a pointer to the descriptor (includes flags, etc)
394 @param Ppi - Pointer to reference the found PPI
396 @retval EFI_SUCCESS if the PPI is in the database
397 @retval EFI_NOT_FOUND if the PPI is not in the database
403 IN CONST EFI_PEI_SERVICES
**PeiServices
,
404 IN CONST EFI_GUID
*Guid
,
406 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor
,
413 Install a notification for a given PPI.
416 @param PeiServices - Pointer to the PEI Service Table
417 @param NotifyList - Pointer to list of Descriptors to notify upon.
419 @retval EFI_SUCCESS if successful
420 @retval EFI_OUT_OF_RESOURCES if no space in the database
421 @retval EFI_INVALID_PARAMETER if not a good decriptor
427 IN CONST EFI_PEI_SERVICES
**PeiServices
,
428 IN CONST EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
434 Process the Notify List at dispatch level.
436 @param PrivateData PeiCore's private data structure.
441 IN PEI_CORE_INSTANCE
*PrivateData
447 Dispatch notifications.
449 @param PrivateData PeiCore's private data structure
450 @param NotifyType Type of notify to fire.
451 @param InstallStartIndex Install Beginning index.
452 @param InstallStopIndex Install Ending index.
453 @param NotifyStartIndex Notify Beginning index.
454 @param NotifyStopIndex Notify Ending index.
459 IN PEI_CORE_INSTANCE
*PrivateData
,
461 IN INTN InstallStartIndex
,
462 IN INTN InstallStopIndex
,
463 IN INTN NotifyStartIndex
,
464 IN INTN NotifyStopIndex
469 // Boot mode support functions
472 This service enables PEIMs to ascertain the present value of the boot mode.
474 @param PeiServices The PEI core services table.
475 @param BootMode A pointer to contain the value of the boot mode.
477 @retval EFI_SUCCESS The boot mode was returned successfully.
478 @retval EFI_INVALID_PARAMETER BootMode is NULL.
484 IN CONST EFI_PEI_SERVICES
**PeiServices
,
485 IN OUT EFI_BOOT_MODE
*BootMode
490 This service enables PEIMs to update the boot mode variable.
493 @param PeiServices - The PEI core services table.
494 @param BootMode - The value of the boot mode to set.
496 @return EFI_SUCCESS - The value was successfully updated
502 IN CONST EFI_PEI_SERVICES
**PeiServices
,
503 IN EFI_BOOT_MODE BootMode
508 // Security support functions
512 Initialize the security services.
514 @param PeiServices The PEI core services table.
515 @param OldCoreData Pointer to the old core data.
516 NULL if being run in non-permament memory mode.
520 InitializeSecurityServices (
521 IN EFI_PEI_SERVICES
**PeiServices
,
522 IN PEI_CORE_INSTANCE
*OldCoreData
527 Verify a Firmware volume
529 @param CurrentFvAddress Pointer to the current Firmware Volume under consideration
531 @retval EFI_SUCCESS Firmware Volume is legal
532 @retval EFI_SECURITY_VIOLATION Firmware Volume fails integrity test
537 IN EFI_FIRMWARE_VOLUME_HEADER
*CurrentFvAddress
543 Provide a callout to the security verification service.
546 @param PrivateData PeiCore's private data structure
547 @param VolumeHandle Handle of FV
548 @param FileHandle Handle of PEIM's ffs
550 @retval EFI_SUCCESS Image is OK
551 @retval EFI_SECURITY_VIOLATION Image is illegal
556 IN PEI_CORE_INSTANCE
*PrivateData
,
557 IN EFI_PEI_FV_HANDLE VolumeHandle
,
558 IN EFI_PEI_FILE_HANDLE FileHandle
564 Gets the pointer to the HOB List.
567 @param PeiServices The PEI core services table.
568 @param HobList Pointer to the HOB List.
570 @retval EFI_SUCCESS Get the pointer of HOB List
571 @retval EFI_NOT_AVAILABLE_YET the HOB List is not yet published
572 @retval EFI_INVALID_PARAMETER HobList is NULL (in debug mode)
578 IN CONST EFI_PEI_SERVICES
**PeiServices
,
579 IN OUT VOID
**HobList
584 Add a new HOB to the HOB List.
586 @param PeiServices - The PEI core services table.
587 @param Type - Type of the new HOB.
588 @param Length - Length of the new HOB to allocate.
589 @param Hob - Pointer to the new HOB.
591 @return EFI_SUCCESS Success to create hob.
592 @retval EFI_INVALID_PARAMETER if Hob is NULL
593 @retval EFI_NOT_AVAILABLE_YET if HobList is still not available.
594 @retval EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.
600 IN CONST EFI_PEI_SERVICES
**PeiServices
,
609 Builds a Handoff Information Table HOB
611 @param BootMode - Current Bootmode
612 @param MemoryBegin - Start Memory Address.
613 @param MemoryLength - Length of Memory.
615 @return EFI_SUCCESS Always success to initialize HOB.
619 PeiCoreBuildHobHandoffInfoTable (
620 IN EFI_BOOT_MODE BootMode
,
621 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
622 IN UINT64 MemoryLength
628 // FFS Fw Volume support functions
631 Given the input file pointer, search for the next matching file in the
632 FFS volume as defined by SearchType. The search starts from FileHeader inside
633 the Firmware Volume defined by FwVolHeader.
636 @param PeiServices Pointer to the PEI Core Services Table.
637 @param SearchType Filter to find only files of this type.
638 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
639 @param VolumeHandle Pointer to the FV header of the volume to search.
640 @param FileHandle Pointer to the current file from which to begin searching.
641 This pointer will be updated upon return to reflect the file found.
642 @retval EFI_NOT_FOUND No files matching the search criteria were found
643 @retval EFI_SUCCESS Success to find next file in given volume
649 IN CONST EFI_PEI_SERVICES
**PeiServices
,
651 IN EFI_PEI_FV_HANDLE FwVolHeader
,
652 IN OUT EFI_PEI_FILE_HANDLE
*FileHeader
657 Given the input file pointer, search for the next matching section in the
661 @param PeiServices Pointer to the PEI Core Services Table.
662 @param SectionType Filter to find only sections of this type.
663 @param FileHandle Pointer to the current file to search.
664 @param SectionData Pointer to the Section matching SectionType in FfsFileHeader.
665 NULL if section not found
667 @retval EFI_NOT_FOUND No files matching the search criteria were found
668 @retval EFI_SUCCESS Success to find section data in given file
673 PeiFfsFindSectionData (
674 IN CONST EFI_PEI_SERVICES
**PeiServices
,
675 IN EFI_SECTION_TYPE SectionType
,
676 IN EFI_PEI_FILE_HANDLE FfsFileHeader
,
677 IN OUT VOID
**SectionData
682 search the firmware volumes by index
684 @param PeiServices The PEI core services table.
685 @param Instance Instance of FV to find
686 @param VolumeHandle Pointer to found Volume.
688 @retval EFI_INVALID_PARAMETER FwVolHeader is NULL
689 @retval EFI_SUCCESS Firmware volume instance successfully found.
694 PeiFvFindNextVolume (
695 IN CONST EFI_PEI_SERVICES
**PeiServices
,
697 IN OUT EFI_PEI_FV_HANDLE
*FwVolHeader
702 // Memory support functions
706 Initialize the memory services.
709 @param PrivateData Add parameter description
710 @param SecCoreData Points to a data structure containing information about the PEI core's operating
711 environment, such as the size and location of temporary RAM, the stack location and
713 @param OldCoreData Pointer to the PEI Core data.
714 NULL if being run in non-permament memory mode.
718 InitializeMemoryServices (
719 IN PEI_CORE_INSTANCE
*PrivateData
,
720 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
721 IN PEI_CORE_INSTANCE
*OldCoreData
727 Install the permanent memory is now available.
728 Creates HOB (PHIT and Stack).
730 @param PeiServices - The PEI core services table.
731 @param MemoryBegin - Start of memory address.
732 @param MemoryLength - Length of memory.
734 @return EFI_SUCCESS Always success.
739 PeiInstallPeiMemory (
740 IN CONST EFI_PEI_SERVICES
**PeiServices
,
741 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
742 IN UINT64 MemoryLength
748 Memory allocation service on permanent memory,
749 not usable prior to the memory installation.
752 @param PeiServices - The PEI core services table.
753 @param MemoryType - Type of memory to allocate.
754 @param Pages - Number of pages to allocate.
755 @param Memory - Pointer of memory allocated.
757 @retval EFI_SUCCESS The allocation was successful
758 @retval EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported.
759 @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available
760 @retval EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement
761 to allocate the number of pages.
767 IN CONST EFI_PEI_SERVICES
**PeiServices
,
768 IN EFI_MEMORY_TYPE MemoryType
,
770 OUT EFI_PHYSICAL_ADDRESS
*Memory
776 Memory allocation service on the CAR.
779 @param PeiServices - The PEI core services table.
780 @param Size - Amount of memory required
781 @param Buffer - Address of pointer to the buffer
783 @retval EFI_SUCCESS The allocation was successful
784 @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement
785 to allocate the requested size.
791 IN CONST EFI_PEI_SERVICES
**PeiServices
,
799 Routine for load image file.
802 @param PeiServices - The PEI core services table.
803 @param FileHandle - Pointer to the FFS file header of the image.
804 @param EntryPoint - Pointer to entry point of specified image file for output.
805 @param AuthenticationState - Pointer to attestation authentication state of image.
807 @retval EFI_SUCCESS - Image is successfully loaded.
808 @retval EFI_NOT_FOUND - Fail to locate necessary PPI
809 @retval Others - Fail to load file.
814 IN EFI_PEI_SERVICES
**PeiServices
,
815 IN EFI_PEI_FILE_HANDLE FileHandle
,
816 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
,
817 OUT UINT32
*AuthenticationState
823 Core version of the Status Code reporter
826 @param PeiServices The PEI core services table.
827 @param CodeType Type of Status Code.
828 @param Value Value to output for Status Code.
829 @param Instance Instance Number of this status code.
830 @param CallerId ID of the caller of this status code.
831 @param Data Optional data associated with this status code.
833 @retval EFI_SUCCESS if status code is successfully reported
834 @retval EFI_NOT_AVAILABLE_YET if StatusCodePpi has not been installed
839 PeiReportStatusCode (
840 IN CONST EFI_PEI_SERVICES
**PeiServices
,
841 IN EFI_STATUS_CODE_TYPE CodeType
,
842 IN EFI_STATUS_CODE_VALUE Value
,
844 IN CONST EFI_GUID
*CallerId
,
845 IN CONST EFI_STATUS_CODE_DATA
*Data OPTIONAL
851 Core version of the Reset System
854 @param PeiServices - The PEI core services table.
856 @retval EFI_NOT_AVAILABLE_YET PPI not available yet.
857 @retval EFI_DEVICE_ERROR Did not reset system.
858 Otherwise, resets the system.
864 IN CONST EFI_PEI_SERVICES
**PeiServices
870 Initialize PeiCore Fv List.
873 @param PrivateData - Pointer to PEI_CORE_INSTANCE.
874 @param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.
881 IN PEI_CORE_INSTANCE
*PrivateData
,
882 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
887 Process Firmware Volum Information once FvInfoPPI install.
890 @param PeiServices - General purpose services available to every PEIM.
891 @param NotifyDescriptor EDES_TODO: Add parameter description
892 @param Ppi EDES_TODO: Add parameter description
894 @retval EFI_SUCCESS if the interface could be successfully installed
899 FirmwareVolmeInfoPpiNotifyCallback (
900 IN EFI_PEI_SERVICES
**PeiServices
,
901 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
908 Given the input VolumeHandle, search for the next matching name file.
911 @param FileName - File name to search.
912 @param VolumeHandle - The current FV to search.
913 @param FileHandle - Pointer to the file matching name in VolumeHandle.
914 - NULL if file not found
921 PeiFfsFindFileByName (
922 IN CONST EFI_GUID
*FileName
,
923 IN EFI_PEI_FV_HANDLE VolumeHandle
,
924 OUT EFI_PEI_FILE_HANDLE
*FileHandle
930 Returns information about a specific file.
933 @param FileHandle - The handle to file.
934 @param FileInfo - Pointer to the file information.
936 @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.
937 @retval EFI_SUCCESS Success to collect file info.
943 IN EFI_PEI_FILE_HANDLE FileHandle
,
944 OUT EFI_FV_FILE_INFO
*FileInfo
950 Collect information of given Fv Volume.
952 @param VolumeHandle - The handle to Fv Volume.
953 @param VolumeInfo - The pointer to volume information.
955 @retval EFI_INVALID_PARAMETER VolumeInfo is NULL
956 @retval EFI_SUCCESS Success to collect fv info.
960 PeiFfsGetVolumeInfo (
961 IN EFI_PEI_FV_HANDLE VolumeHandle
,
962 OUT EFI_FV_INFO
*VolumeInfo
967 This routine enable a PEIM to register itself to shadow when PEI Foundation
968 discovery permanent memory.
970 @param FileHandle File handle of a PEIM.
972 @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.
973 @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.
974 @retval EFI_SUCCESS Successfully to register itself.
979 PeiRegisterForShadow (
980 IN EFI_PEI_FILE_HANDLE FileHandle
985 Given the input file pointer, search for the next matching file in the
986 FFS volume as defined by SearchType. The search starts from FileHeader inside
987 the Firmware Volume defined by FwVolHeader.
990 @param FvHandle Pointer to the FV header of the volume to search
991 @param FileName File name
992 @param SearchType Filter to find only files of this type.
993 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
994 @param FileHandle This parameter must point to a valid FFS volume.
995 @param AprioriFile Pointer to AprioriFile image in this FV if has
997 @return EFI_NOT_FOUND No files matching the search criteria were found
998 @retval EFI_SUCCESS Success to search given file
1003 IN CONST EFI_PEI_FV_HANDLE FvHandle
,
1004 IN CONST EFI_GUID
*FileName
, OPTIONAL
1005 IN EFI_FV_FILETYPE SearchType
,
1006 IN OUT EFI_PEI_FILE_HANDLE
*FileHandle
,
1007 IN OUT EFI_PEI_FV_HANDLE
*AprioriFile OPTIONAL
1013 Install Pei Load File PPI.
1016 @param PrivateData - Pointer to PEI_CORE_INSTANCE.
1017 @param OldCoreData - Pointer to PEI_CORE_INSTANCE.
1021 InitializeImageServices (
1022 IN PEI_CORE_INSTANCE
*PrivateData
,
1023 IN PEI_CORE_INSTANCE
*OldCoreData
1028 Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.
1030 @param PeiServices Pointer to the PEI Core Services Table.
1031 @param FileHandle File handle of a Fv type file.
1032 @param AuthenticationState Pointer to attestation authentication state of image.
1035 @retval EFI_NOT_FOUND FV image can't be found.
1036 @retval EFI_SUCCESS Successfully to process it.
1041 IN EFI_PEI_SERVICES
**PeiServices
,
1042 IN EFI_PEI_FILE_HANDLE FvFileHandle
,
1043 OUT UINT32
*AuthenticationState