2 Definition of Pei Core Structures and Services
4 Copyright (c) 2006 - 2008, 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>
51 /// It is an FFS type extension used for PeiFindFileEx. It indicates current
52 /// Ffs searching is for all PEIMs can be dispatched by PeiCore.
54 #define PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE 0xff
57 /// Pei Core private data structures
60 EFI_PEI_PPI_DESCRIPTOR
*Ppi
;
61 EFI_PEI_NOTIFY_DESCRIPTOR
*Notify
;
63 } PEI_PPI_LIST_POINTERS
;
66 /// PPI database structure which contains two link: PpiList and NotifyList. PpiList
67 /// is in head of PpiListPtrs array and notify is in end of PpiListPtrs.
71 /// index of end of PpiList link list.
75 /// index of end of notify link list.
79 /// index of the dispatched notify list.
83 /// index of last installed Ppi description in PpiList link list.
85 INTN LastDispatchedInstall
;
87 /// index of last dispatched notify in Notify link list.
89 INTN LastDispatchedNotify
;
93 PEI_PPI_LIST_POINTERS PpiListPtrs
[FixedPcdGet32 (PcdPeiCoreMaxPpiSupported
)];
98 // PEI_CORE_FV_HANDE.PeimState
99 // Do not change these values as there is code doing math to change states.
100 // Look for Private->Fv[FvCount].PeimState[PeimCount]++;
102 #define PEIM_STATE_NOT_DISPATCHED 0x00
103 #define PEIM_STATE_DISPATCHED 0x01
104 #define PEIM_STATE_REGISITER_FOR_SHADOW 0x02
105 #define PEIM_STATE_DONE 0x03
108 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
109 UINT8 PeimState
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
110 EFI_PEI_FILE_HANDLE FvFileHandles
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
112 } PEI_CORE_FV_HANDLE
;
114 #define CACHE_SETION_MAX_NUMBER 0x10
116 EFI_COMMON_SECTION_HEADER
* Section
[CACHE_SETION_MAX_NUMBER
];
117 VOID
* SectionData
[CACHE_SETION_MAX_NUMBER
];
118 UINTN SectionSize
[CACHE_SETION_MAX_NUMBER
];
119 UINTN AllSectionCount
;
121 } CACHE_SECTION_DATA
;
124 #define PEI_CORE_HANDLE_SIGNATURE EFI_SIGNATURE_32('P','e','i','C')
127 /// Pei Core private data structure instance
131 EFI_PEI_SERVICES
*PS
; // Point to ServiceTableShadow
132 PEI_PPI_DATABASE PpiData
;
134 PEI_CORE_FV_HANDLE Fv
[FixedPcdGet32 (PcdPeiCoreMaxFvSupported
)];
135 EFI_PEI_FILE_HANDLE CurrentFvFileHandles
[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv
)];
137 UINTN CurrentPeimFvCount
;
138 UINTN CurrentPeimCount
;
139 EFI_PEI_FILE_HANDLE CurrentFileHandle
;
140 BOOLEAN PeimNeedingDispatch
;
141 BOOLEAN PeimDispatchOnThisPass
;
142 BOOLEAN PeimDispatcherReenter
;
144 EFI_PEI_FV_HANDLE AllFv
[FixedPcdGet32 (PcdPeiCoreMaxFvSupported
)];
145 EFI_PEI_HOB_POINTERS HobList
;
146 BOOLEAN SwitchStackSignal
;
147 BOOLEAN PeiMemoryInstalled
;
148 EFI_PHYSICAL_ADDRESS StackBase
;
151 EFI_PEI_SECURITY2_PPI
*PrivateSecurityPpi
;
152 EFI_PEI_SERVICES ServiceTableShadow
;
153 EFI_PEI_PPI_DESCRIPTOR
*XipLoadFile
;
154 EFI_PHYSICAL_ADDRESS PhysicalMemoryBegin
;
155 UINT64 PhysicalMemoryLength
;
156 EFI_PHYSICAL_ADDRESS FreePhysicalMemoryTop
;
157 VOID
* ShadowedPeiCore
;
158 CACHE_SECTION_DATA CacheSection
;
162 /// Pei Core Instance Data Macros
164 #define PEI_CORE_INSTANCE_FROM_PS_THIS(a) \
165 CR(a, PEI_CORE_INSTANCE, PS, PEI_CORE_HANDLE_SIGNATURE)
168 Function Pointer type for PeiCore function.
169 @param SecCoreData Points to a data structure containing information about the PEI core's operating
170 environment, such as the size and location of temporary RAM, the stack location and
172 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
173 An empty PPI list consists of a single descriptor with the end-tag
174 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
175 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
176 that both the PEI Foundation and any modules can leverage the associated service
177 calls and/or code in these early PPIs
178 @param Data Pointer to old core data that is used to initialize the
183 (EFIAPI
*PEICORE_FUNCTION_POINTER
)(
184 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
185 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
,
186 IN PEI_CORE_INSTANCE
*OldCoreData
190 /// Union of temporarily used function pointers (to save stack space)
193 PEICORE_FUNCTION_POINTER PeiCore
;
194 EFI_PEIM_ENTRY_POINT2 PeimEntry
;
195 EFI_PEIM_NOTIFY_ENTRY_POINT PeimNotifyEntry
;
196 EFI_DXE_IPL_PPI
*DxeIpl
;
197 EFI_PEI_PPI_DESCRIPTOR
*PpiDescriptor
;
198 EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
;
200 } PEI_CORE_TEMP_POINTERS
;
203 CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
204 EFI_PEI_PPI_DESCRIPTOR
*PpiList
;
206 } PEI_CORE_PARAMETERS
;
213 The entry routine to Pei Core, invoked by PeiMain during transition
214 from SEC to PEI. After switching stack in the PEI core, it will restart
215 with the old core data.
218 @param SecCoreData Points to a data structure containing information about the PEI core's operating
219 environment, such as the size and location of temporary RAM, the stack location and
221 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
222 An empty PPI list consists of a single descriptor with the end-tag
223 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
224 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
225 that both the PEI Foundation and any modules can leverage the associated service
226 calls and/or code in these early PPIs
227 @param Data Pointer to old core data that is used to initialize the
230 @retval EFI_NOT_FOUND Never reach
236 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
237 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpList
,
242 // Dispatcher support functions
247 This is the POSTFIX version of the dependency evaluator. When a
248 PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on
249 the evaluation stack. When that entry is poped from the evaluation
250 stack, the PPI is checked if it is installed. This method allows
251 some time savings as not all PPIs must be checked for certain
252 operation types (AND, OR).
255 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
256 @param DependencyExpression Pointer to a dependency expression. The Grammar adheres to
257 the BNF described above and is stored in postfix notation.
259 @retval TRUE if it is a well-formed Grammar
260 @retval FALSE if the dependency expression overflows the evaluation stack
261 if the dependency expression underflows the evaluation stack
262 if the dependency expression is not a well-formed Grammar.
266 PeimDispatchReadiness (
267 IN EFI_PEI_SERVICES
**PeiServices
,
268 IN VOID
*DependencyExpression
272 Conduct PEIM dispatch.
274 @param SecCoreData Pointer to the data structure containing SEC to PEI handoff data
275 @param PrivateData Pointer to the private data passed in from caller
277 @retval EFI_SUCCESS Successfully dispatched PEIM.
278 @retval EFI_NOT_FOUND The dispatch failed.
283 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
284 IN PEI_CORE_INSTANCE
*PrivateData
288 Initialize the Dispatcher's data members
290 @param PrivateData PeiCore's private data structure
291 @param OldCoreData Old data from SecCore
292 NULL if being run in non-permament memory mode.
293 @param SecCoreData Points to a data structure containing information about the PEI core's operating
294 environment, such as the size and location of temporary RAM, the stack location and
299 InitializeDispatcherData (
300 IN PEI_CORE_INSTANCE
*PrivateData
,
301 IN PEI_CORE_INSTANCE
*OldCoreData
,
302 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
306 This routine parses the Dependency Expression, if available, and
307 decides if the module can be executed.
310 @param Private PeiCore's private data structure
311 @param FileHandle PEIM's file handle
312 @param PeimCount The index of last dispatched PEIM.
314 @retval TRUE Can be dispatched
315 @retval FALSE Cannot be dispatched
320 IN PEI_CORE_INSTANCE
*Private
,
321 IN EFI_PEI_FILE_HANDLE FileHandle
,
326 // PPI support functions
330 Initialize PPI services.
332 @param PrivateData Pointer to the PEI Core data.
333 @param OldCoreData Pointer to old PEI Core data.
334 NULL if being run in non-permament memory mode.
338 InitializePpiServices (
339 IN PEI_CORE_INSTANCE
*PrivateData
,
340 IN PEI_CORE_INSTANCE
*OldCoreData
345 Migrate the Hob list from the CAR stack to PEI installed memory.
347 @param PrivateData Pointer to PeiCore's private data structure.
348 @param OldCheckingBottom Bottom of temporary memory range. All Ppi in this range
349 will be fixup for PpiData and PpiDescriptor pointer.
350 @param OldCheckingTop Top of temporary memory range. All Ppi in this range
351 will be fixup for PpiData and PpiDescriptor.
352 @param Fixup The address difference between
353 the new Hob list and old Hob list.
358 IN PEI_CORE_INSTANCE
*PrivateData
,
359 IN UINTN OldCheckingBottom
,
360 IN UINTN OldCheckingTop
,
366 Install PPI services. It is implementation of EFI_PEI_SERVICE.InstallPpi.
368 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
369 @param PpiList Pointer to ppi array that want to be installed.
371 @retval EFI_SUCCESS if all PPIs in PpiList are successfully installed.
372 @retval EFI_INVALID_PARAMETER if PpiList is NULL pointer
373 if any PPI in PpiList is not valid
374 @retval EFI_OUT_OF_RESOURCES if there is no more memory resource to install PPI
380 IN CONST EFI_PEI_SERVICES
**PeiServices
,
381 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
386 Re-Install PPI services.
388 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
389 @param OldPpi Pointer to the old PEI PPI Descriptors.
390 @param NewPpi Pointer to the new PEI PPI Descriptors.
392 @retval EFI_SUCCESS if the operation was successful
393 @retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL
394 if NewPpi is not valid
395 @retval EFI_NOT_FOUND if the PPI was not in the database
401 IN CONST EFI_PEI_SERVICES
**PeiServices
,
402 IN CONST EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
403 IN CONST EFI_PEI_PPI_DESCRIPTOR
*NewPpi
408 Locate a given named PPI.
411 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
412 @param Guid Pointer to GUID of the PPI.
413 @param Instance Instance Number to discover.
414 @param PpiDescriptor Pointer to reference the found descriptor. If not NULL,
415 returns a pointer to the descriptor (includes flags, etc)
416 @param Ppi Pointer to reference the found PPI
418 @retval EFI_SUCCESS if the PPI is in the database
419 @retval EFI_NOT_FOUND if the PPI is not in the database
425 IN CONST EFI_PEI_SERVICES
**PeiServices
,
426 IN CONST EFI_GUID
*Guid
,
428 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor
,
434 Install a notification for a given PPI.
437 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
438 @param NotifyList Pointer to list of Descriptors to notify upon.
440 @retval EFI_SUCCESS if successful
441 @retval EFI_OUT_OF_RESOURCES if no space in the database
442 @retval EFI_INVALID_PARAMETER if not a good decriptor
448 IN CONST EFI_PEI_SERVICES
**PeiServices
,
449 IN CONST EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
454 Process the Notify List at dispatch level.
456 @param PrivateData PeiCore's private data structure.
461 IN PEI_CORE_INSTANCE
*PrivateData
466 Dispatch notifications.
468 @param PrivateData PeiCore's private data structure
469 @param NotifyType Type of notify to fire.
470 @param InstallStartIndex Install Beginning index.
471 @param InstallStopIndex Install Ending index.
472 @param NotifyStartIndex Notify Beginning index.
473 @param NotifyStopIndex Notify Ending index.
478 IN PEI_CORE_INSTANCE
*PrivateData
,
480 IN INTN InstallStartIndex
,
481 IN INTN InstallStopIndex
,
482 IN INTN NotifyStartIndex
,
483 IN INTN NotifyStopIndex
487 // Boot mode support functions
490 This service enables PEIMs to ascertain the present value of the boot mode.
492 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
493 @param BootMode A pointer to contain the value of the boot mode.
495 @retval EFI_SUCCESS The boot mode was returned successfully.
496 @retval EFI_INVALID_PARAMETER BootMode is NULL.
502 IN CONST EFI_PEI_SERVICES
**PeiServices
,
503 IN OUT EFI_BOOT_MODE
*BootMode
507 This service enables PEIMs to update the boot mode variable.
510 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
511 @param BootMode The value of the boot mode to set.
513 @return EFI_SUCCESS The value was successfully updated
519 IN CONST EFI_PEI_SERVICES
**PeiServices
,
520 IN EFI_BOOT_MODE BootMode
524 // Security support functions
528 Initialize the security services.
530 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
531 @param OldCoreData Pointer to the old core data.
532 NULL if being run in non-permament memory mode.
536 InitializeSecurityServices (
537 IN EFI_PEI_SERVICES
**PeiServices
,
538 IN PEI_CORE_INSTANCE
*OldCoreData
542 Verify a Firmware volume
544 @param CurrentFvAddress Pointer to the current Firmware Volume under consideration
546 @retval EFI_SUCCESS Firmware Volume is legal
547 @retval EFI_SECURITY_VIOLATION Firmware Volume fails integrity test
552 IN EFI_FIRMWARE_VOLUME_HEADER
*CurrentFvAddress
557 Provide a callout to the security verification service.
560 @param PrivateData PeiCore's private data structure
561 @param VolumeHandle Handle of FV
562 @param FileHandle Handle of PEIM's ffs
564 @retval EFI_SUCCESS Image is OK
565 @retval EFI_SECURITY_VIOLATION Image is illegal
570 IN PEI_CORE_INSTANCE
*PrivateData
,
571 IN EFI_PEI_FV_HANDLE VolumeHandle
,
572 IN EFI_PEI_FILE_HANDLE FileHandle
577 Gets the pointer to the HOB List.
580 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
581 @param HobList Pointer to the HOB List.
583 @retval EFI_SUCCESS Get the pointer of HOB List
584 @retval EFI_NOT_AVAILABLE_YET the HOB List is not yet published
585 @retval EFI_INVALID_PARAMETER HobList is NULL (in debug mode)
591 IN CONST EFI_PEI_SERVICES
**PeiServices
,
592 IN OUT VOID
**HobList
596 Add a new HOB to the HOB List.
598 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
599 @param Type Type of the new HOB.
600 @param Length Length of the new HOB to allocate.
601 @param Hob Pointer to the new HOB.
603 @return EFI_SUCCESS Success to create hob.
604 @retval EFI_INVALID_PARAMETER if Hob is NULL
605 @retval EFI_NOT_AVAILABLE_YET if HobList is still not available.
606 @retval EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.
612 IN CONST EFI_PEI_SERVICES
**PeiServices
,
620 Builds a Handoff Information Table HOB
622 @param BootMode - Current Bootmode
623 @param MemoryBegin - Start Memory Address.
624 @param MemoryLength - Length of Memory.
626 @return EFI_SUCCESS Always success to initialize HOB.
630 PeiCoreBuildHobHandoffInfoTable (
631 IN EFI_BOOT_MODE BootMode
,
632 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
633 IN UINT64 MemoryLength
638 // FFS Fw Volume support functions
641 Given the input file pointer, search for the next matching file in the
642 FFS volume as defined by SearchType. The search starts from FileHeader inside
643 the Firmware Volume defined by FwVolHeader.
646 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
647 @param SearchType Filter to find only files of this type.
648 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
649 @param FwVolHeader Pointer to the FV header of the volume to search.
650 @param FileHeader Pointer to the current file from which to begin searching.
651 This pointer will be updated upon return to reflect the file found.
652 @retval EFI_NOT_FOUND No files matching the search criteria were found
653 @retval EFI_SUCCESS Success to find next file in given volume
659 IN CONST EFI_PEI_SERVICES
**PeiServices
,
661 IN EFI_PEI_FV_HANDLE FwVolHeader
,
662 IN OUT EFI_PEI_FILE_HANDLE
*FileHeader
666 Given the input file pointer, search for the next matching section in the
669 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
670 @param SectionType Filter to find only sections of this type.
671 @param FfsFileHeader Pointer to the current file to search.
672 @param SectionData Pointer to the Section matching SectionType in FfsFileHeader.
673 NULL if section not found
675 @retval EFI_NOT_FOUND No files matching the search criteria were found
676 @retval EFI_SUCCESS Success to find section data in given file
681 PeiFfsFindSectionData (
682 IN CONST EFI_PEI_SERVICES
**PeiServices
,
683 IN EFI_SECTION_TYPE SectionType
,
684 IN EFI_PEI_FILE_HANDLE FfsFileHeader
,
685 IN OUT VOID
**SectionData
689 search the firmware volumes by index
691 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
692 @param Instance Instance of FV to find
693 @param FwVolHeader Pointer to found Volume.
695 @retval EFI_INVALID_PARAMETER FwVolHeader is NULL
696 @retval EFI_SUCCESS Firmware volume instance successfully found.
701 PeiFvFindNextVolume (
702 IN CONST EFI_PEI_SERVICES
**PeiServices
,
704 IN OUT EFI_PEI_FV_HANDLE
*FwVolHeader
708 // Memory support functions
712 Initialize the memory services.
714 @param PrivateData PeiCore's private data structure
715 @param SecCoreData Points to a data structure containing information about the PEI core's operating
716 environment, such as the size and location of temporary RAM, the stack location and
718 @param OldCoreData Pointer to the PEI Core data.
719 NULL if being run in non-permament memory mode.
723 InitializeMemoryServices (
724 IN PEI_CORE_INSTANCE
*PrivateData
,
725 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
726 IN PEI_CORE_INSTANCE
*OldCoreData
731 Install the permanent memory is now available.
732 Creates HOB (PHIT and Stack).
734 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
735 @param MemoryBegin Start of memory address.
736 @param MemoryLength Length of memory.
738 @return EFI_SUCCESS Always success.
743 PeiInstallPeiMemory (
744 IN CONST EFI_PEI_SERVICES
**PeiServices
,
745 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
746 IN UINT64 MemoryLength
751 Memory allocation service on permanent memory,
752 not usable prior to the memory installation.
755 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
756 @param MemoryType Type of memory to allocate.
757 @param Pages Number of pages to allocate.
758 @param Memory Pointer of memory allocated.
760 @retval EFI_SUCCESS The allocation was successful
761 @retval EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported.
762 @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available
763 @retval EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement
764 to allocate the number of pages.
770 IN CONST EFI_PEI_SERVICES
**PeiServices
,
771 IN EFI_MEMORY_TYPE MemoryType
,
773 OUT EFI_PHYSICAL_ADDRESS
*Memory
778 Memory allocation service on the CAR.
781 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
782 @param Size Amount of memory required
783 @param Buffer Address of pointer to the buffer
785 @retval EFI_SUCCESS The allocation was successful
786 @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement
787 to allocate the requested size.
793 IN CONST EFI_PEI_SERVICES
**PeiServices
,
800 Routine for load image file.
803 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
804 @param FileHandle Pointer to the FFS file header of the image.
805 @param EntryPoint Pointer to entry point of specified image file for output.
806 @param AuthenticationState Pointer to attestation authentication state of image.
808 @retval EFI_SUCCESS Image is successfully loaded.
809 @retval EFI_NOT_FOUND Fail to locate necessary PPI
810 @retval Others Fail to load file.
815 IN EFI_PEI_SERVICES
**PeiServices
,
816 IN EFI_PEI_FILE_HANDLE FileHandle
,
817 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
,
818 OUT UINT32
*AuthenticationState
823 Core version of the Status Code reporter
826 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
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
850 Core version of the Reset System
853 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
855 @retval EFI_NOT_AVAILABLE_YET PPI not available yet.
856 @retval EFI_DEVICE_ERROR Did not reset system.
857 Otherwise, resets the system.
863 IN CONST EFI_PEI_SERVICES
**PeiServices
868 Initialize PeiCore Fv List.
871 @param PrivateData - Pointer to PEI_CORE_INSTANCE.
872 @param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.
877 IN PEI_CORE_INSTANCE
*PrivateData
,
878 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
882 Process Firmware Volum Information once FvInfoPPI install.
884 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
885 @param NotifyDescriptor Address of the notification descriptor data structure.
886 @param Ppi Address of the PPI that was installed.
888 @retval EFI_SUCCESS if the interface could be successfully installed
893 FirmwareVolmeInfoPpiNotifyCallback (
894 IN EFI_PEI_SERVICES
**PeiServices
,
895 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
901 Given the input VolumeHandle, search for the next matching name file.
903 @param FileName File name to search.
904 @param VolumeHandle The current FV to search.
905 @param FileHandle Pointer to the file matching name in VolumeHandle.
906 NULL if file not found
908 @retval EFI_NOT_FOUND No files matching the search criteria were found
909 @retval EFI_SUCCESS Success to search given file
914 PeiFfsFindFileByName (
915 IN CONST EFI_GUID
*FileName
,
916 IN EFI_PEI_FV_HANDLE VolumeHandle
,
917 OUT EFI_PEI_FILE_HANDLE
*FileHandle
922 Returns information about a specific file.
925 @param FileHandle The handle to file.
926 @param FileInfo Pointer to the file information.
928 @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.
929 @retval EFI_SUCCESS Success to collect file info.
935 IN EFI_PEI_FILE_HANDLE FileHandle
,
936 OUT EFI_FV_FILE_INFO
*FileInfo
941 Collect information of given Fv Volume.
943 @param VolumeHandle The handle to Fv Volume.
944 @param VolumeInfo The pointer to volume information.
946 @retval EFI_INVALID_PARAMETER VolumeInfo is NULL
947 @retval EFI_SUCCESS Success to collect fv info.
951 PeiFfsGetVolumeInfo (
952 IN EFI_PEI_FV_HANDLE VolumeHandle
,
953 OUT EFI_FV_INFO
*VolumeInfo
957 This routine enable a PEIM to register itself to shadow when PEI Foundation
958 discovery permanent memory.
960 @param FileHandle File handle of a PEIM.
962 @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.
963 @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.
964 @retval EFI_SUCCESS Successfully to register itself.
969 PeiRegisterForShadow (
970 IN EFI_PEI_FILE_HANDLE FileHandle
974 Given the input file pointer, search for the next matching file in the
975 FFS volume as defined by SearchType. The search starts from FileHeader inside
976 the Firmware Volume defined by FwVolHeader.
979 @param FvHandle Pointer to the FV header of the volume to search
980 @param FileName File name
981 @param SearchType Filter to find only files of this type.
982 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
983 @param FileHandle This parameter must point to a valid FFS volume.
984 @param AprioriFile Pointer to AprioriFile image in this FV if has
986 @return EFI_NOT_FOUND No files matching the search criteria were found
987 @retval EFI_SUCCESS Success to search given file
992 IN CONST EFI_PEI_FV_HANDLE FvHandle
,
993 IN CONST EFI_GUID
*FileName
, OPTIONAL
994 IN EFI_FV_FILETYPE SearchType
,
995 IN OUT EFI_PEI_FILE_HANDLE
*FileHandle
,
996 IN OUT EFI_PEI_FV_HANDLE
*AprioriFile OPTIONAL
1000 Initialize image service that install PeiLoadFilePpi.
1002 @param PrivateData Pointer to PeiCore's private data structure PEI_CORE_INSTANCE.
1003 @param OldCoreData Pointer to Old PeiCore's private data.
1004 If NULL, PeiCore is entered at first time, stack/heap in temporary memory.
1005 If not NULL, PeiCore is entered at second time, stack/heap has been moved
1006 to permenent memory.
1010 InitializeImageServices (
1011 IN PEI_CORE_INSTANCE
*PrivateData
,
1012 IN PEI_CORE_INSTANCE
*OldCoreData
1016 Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.
1018 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
1019 @param FileHandle File handle of a Fv type file.
1020 @param AuthenticationState Pointer to attestation authentication state of image.
1021 If return 0, means pass security checking.
1023 @retval EFI_NOT_FOUND FV image can't be found.
1024 @retval EFI_SUCCESS Successfully to process it.
1029 IN EFI_PEI_SERVICES
**PeiServices
,
1030 IN EFI_PEI_FILE_HANDLE FvFileHandle
,
1031 OUT UINT32
*AuthenticationState