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
;
141 EFI_PEI_FV_HANDLE AllFv
[FixedPcdGet32 (PcdPeiCoreMaxFvSupported
)];
142 EFI_PEI_HOB_POINTERS HobList
;
143 BOOLEAN SwitchStackSignal
;
144 BOOLEAN PeiMemoryInstalled
;
145 EFI_PHYSICAL_ADDRESS StackBase
;
147 VOID
*BottomOfCarHeap
;
150 EFI_PEI_SECURITY2_PPI
*PrivateSecurityPpi
;
151 EFI_PEI_SERVICES ServiceTableShadow
;
152 UINTN SizeOfTemporaryMemory
;
153 UINTN SizeOfCacheAsRam
;
154 VOID
*MaxTopOfCarHeap
;
155 EFI_PEI_PPI_DESCRIPTOR
*XipLoadFile
;
156 EFI_PHYSICAL_ADDRESS PhysicalMemoryBegin
;
157 UINT64 PhysicalMemoryLength
;
158 EFI_PHYSICAL_ADDRESS FreePhysicalMemoryTop
;
159 VOID
* ShadowedPeiCore
;
160 CACHE_SECTION_DATA CacheSection
;
164 /// Pei Core Instance Data Macros
166 #define PEI_CORE_INSTANCE_FROM_PS_THIS(a) \
167 CR(a, PEI_CORE_INSTANCE, PS, PEI_CORE_HANDLE_SIGNATURE)
170 Function Pointer type for PeiCore function.
171 @param SecCoreData Points to a data structure containing information about the PEI core's operating
172 environment, such as the size and location of temporary RAM, the stack location and
174 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
175 An empty PPI list consists of a single descriptor with the end-tag
176 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
177 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
178 that both the PEI Foundation and any modules can leverage the associated service
179 calls and/or code in these early PPIs
180 @param Data Pointer to old core data that is used to initialize the
185 (EFIAPI
*PEICORE_FUNCTION_POINTER
)(
186 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
187 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
,
188 IN PEI_CORE_INSTANCE
*OldCoreData
192 /// Union of temporarily used function pointers (to save stack space)
195 PEICORE_FUNCTION_POINTER PeiCore
;
196 EFI_PEIM_ENTRY_POINT2 PeimEntry
;
197 EFI_PEIM_NOTIFY_ENTRY_POINT PeimNotifyEntry
;
198 EFI_DXE_IPL_PPI
*DxeIpl
;
199 EFI_PEI_PPI_DESCRIPTOR
*PpiDescriptor
;
200 EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
;
202 } PEI_CORE_TEMP_POINTERS
;
205 CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
206 EFI_PEI_PPI_DESCRIPTOR
*PpiList
;
208 } PEI_CORE_PARAMETERS
;
215 The entry routine to Pei Core, invoked by PeiMain during transition
216 from SEC to PEI. After switching stack in the PEI core, it will restart
217 with the old core data.
220 @param SecCoreData Points to a data structure containing information about the PEI core's operating
221 environment, such as the size and location of temporary RAM, the stack location and
223 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
224 An empty PPI list consists of a single descriptor with the end-tag
225 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
226 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
227 that both the PEI Foundation and any modules can leverage the associated service
228 calls and/or code in these early PPIs
229 @param Data Pointer to old core data that is used to initialize the
232 @retval EFI_NOT_FOUND Never reach
238 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
239 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpList
,
245 // Dispatcher support functions
250 This is the POSTFIX version of the dependency evaluator. When a
251 PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on
252 the evaluation stack. When that entry is poped from the evaluation
253 stack, the PPI is checked if it is installed. This method allows
254 some time savings as not all PPIs must be checked for certain
255 operation types (AND, OR).
258 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
259 @param DependencyExpression Pointer to a dependency expression. The Grammar adheres to
260 the BNF described above and is stored in postfix notation.
262 @retval TRUE if it is a well-formed Grammar
263 @retval FALSE if the dependency expression overflows the evaluation stack
264 if the dependency expression underflows the evaluation stack
265 if the dependency expression is not a well-formed Grammar.
269 PeimDispatchReadiness (
270 IN EFI_PEI_SERVICES
**PeiServices
,
271 IN VOID
*DependencyExpression
276 Conduct PEIM dispatch.
278 @param SecCoreData Pointer to the data structure containing SEC to PEI handoff data
279 @param PrivateData Pointer to the private data passed in from caller
281 @retval EFI_SUCCESS Successfully dispatched PEIM.
282 @retval EFI_NOT_FOUND The dispatch failed.
287 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
288 IN PEI_CORE_INSTANCE
*PrivateData
293 Initialize the Dispatcher's data members
295 @param PrivateData PeiCore's private data structure
296 @param OldCoreData Old data from SecCore
297 NULL if being run in non-permament memory mode.
298 @param SecCoreData Points to a data structure containing information about the PEI core's operating
299 environment, such as the size and location of temporary RAM, the stack location and
304 InitializeDispatcherData (
305 IN PEI_CORE_INSTANCE
*PrivateData
,
306 IN PEI_CORE_INSTANCE
*OldCoreData
,
307 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
312 This routine parses the Dependency Expression, if available, and
313 decides if the module can be executed.
316 @param Private PeiCore's private data structure
317 @param FileHandle PEIM's file handle
318 @param PeimCount The index of last dispatched PEIM.
320 @retval TRUE Can be dispatched
321 @retval FALSE Cannot be dispatched
326 IN PEI_CORE_INSTANCE
*Private
,
327 IN EFI_PEI_FILE_HANDLE FileHandle
,
333 // PPI support functions
337 Initialize PPI services.
339 @param PrivateData Pointer to the PEI Core data.
340 @param OldCoreData Pointer to old PEI Core data.
341 NULL if being run in non-permament memory mode.
345 InitializePpiServices (
346 IN PEI_CORE_INSTANCE
*PrivateData
,
347 IN PEI_CORE_INSTANCE
*OldCoreData
353 Migrate the Hob list from the CAR stack to PEI installed memory.
355 @param PrivateData Pointer to PeiCore's private data structure.
356 @param OldCheckingBottom Bottom of temporary memory range. All Ppi in this range
357 will be fixup for PpiData and PpiDescriptor pointer.
358 @param OldCheckingTop Top of temporary memory range. All Ppi in this range
359 will be fixup for PpiData and PpiDescriptor.
360 @param Fixup The address difference between
361 the new Hob list and old Hob list.
366 IN PEI_CORE_INSTANCE
*PrivateData
,
367 IN UINTN OldCheckingBottom
,
368 IN UINTN OldCheckingTop
,
375 Install PPI services. It is implementation of EFI_PEI_SERVICE.InstallPpi.
377 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
378 @param PpiList Pointer to ppi array that want to be installed.
380 @retval EFI_SUCCESS if all PPIs in PpiList are successfully installed.
381 @retval EFI_INVALID_PARAMETER if PpiList is NULL pointer
382 if any PPI in PpiList is not valid
383 @retval EFI_OUT_OF_RESOURCES if there is no more memory resource to install PPI
389 IN CONST EFI_PEI_SERVICES
**PeiServices
,
390 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
396 Re-Install PPI services.
398 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
399 @param OldPpi Pointer to the old PEI PPI Descriptors.
400 @param NewPpi Pointer to the new PEI PPI Descriptors.
402 @retval EFI_SUCCESS if the operation was successful
403 @retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL
404 if NewPpi is not valid
405 @retval EFI_NOT_FOUND if the PPI was not in the database
411 IN CONST EFI_PEI_SERVICES
**PeiServices
,
412 IN CONST EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
413 IN CONST EFI_PEI_PPI_DESCRIPTOR
*NewPpi
419 Locate a given named PPI.
422 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
423 @param Guid Pointer to GUID of the PPI.
424 @param Instance Instance Number to discover.
425 @param PpiDescriptor Pointer to reference the found descriptor. If not NULL,
426 returns a pointer to the descriptor (includes flags, etc)
427 @param Ppi Pointer to reference the found PPI
429 @retval EFI_SUCCESS if the PPI is in the database
430 @retval EFI_NOT_FOUND if the PPI is not in the database
436 IN CONST EFI_PEI_SERVICES
**PeiServices
,
437 IN CONST EFI_GUID
*Guid
,
439 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor
,
446 Install a notification for a given PPI.
449 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
450 @param NotifyList Pointer to list of Descriptors to notify upon.
452 @retval EFI_SUCCESS if successful
453 @retval EFI_OUT_OF_RESOURCES if no space in the database
454 @retval EFI_INVALID_PARAMETER if not a good decriptor
460 IN CONST EFI_PEI_SERVICES
**PeiServices
,
461 IN CONST EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
467 Process the Notify List at dispatch level.
469 @param PrivateData PeiCore's private data structure.
474 IN PEI_CORE_INSTANCE
*PrivateData
480 Dispatch notifications.
482 @param PrivateData PeiCore's private data structure
483 @param NotifyType Type of notify to fire.
484 @param InstallStartIndex Install Beginning index.
485 @param InstallStopIndex Install Ending index.
486 @param NotifyStartIndex Notify Beginning index.
487 @param NotifyStopIndex Notify Ending index.
492 IN PEI_CORE_INSTANCE
*PrivateData
,
494 IN INTN InstallStartIndex
,
495 IN INTN InstallStopIndex
,
496 IN INTN NotifyStartIndex
,
497 IN INTN NotifyStopIndex
502 // Boot mode support functions
505 This service enables PEIMs to ascertain the present value of the boot mode.
507 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
508 @param BootMode A pointer to contain the value of the boot mode.
510 @retval EFI_SUCCESS The boot mode was returned successfully.
511 @retval EFI_INVALID_PARAMETER BootMode is NULL.
517 IN CONST EFI_PEI_SERVICES
**PeiServices
,
518 IN OUT EFI_BOOT_MODE
*BootMode
523 This service enables PEIMs to update the boot mode variable.
526 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
527 @param BootMode The value of the boot mode to set.
529 @return EFI_SUCCESS The value was successfully updated
535 IN CONST EFI_PEI_SERVICES
**PeiServices
,
536 IN EFI_BOOT_MODE BootMode
541 // Security support functions
545 Initialize the security services.
547 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
548 @param OldCoreData Pointer to the old core data.
549 NULL if being run in non-permament memory mode.
553 InitializeSecurityServices (
554 IN EFI_PEI_SERVICES
**PeiServices
,
555 IN PEI_CORE_INSTANCE
*OldCoreData
560 Verify a Firmware volume
562 @param CurrentFvAddress Pointer to the current Firmware Volume under consideration
564 @retval EFI_SUCCESS Firmware Volume is legal
565 @retval EFI_SECURITY_VIOLATION Firmware Volume fails integrity test
570 IN EFI_FIRMWARE_VOLUME_HEADER
*CurrentFvAddress
576 Provide a callout to the security verification service.
579 @param PrivateData PeiCore's private data structure
580 @param VolumeHandle Handle of FV
581 @param FileHandle Handle of PEIM's ffs
583 @retval EFI_SUCCESS Image is OK
584 @retval EFI_SECURITY_VIOLATION Image is illegal
589 IN PEI_CORE_INSTANCE
*PrivateData
,
590 IN EFI_PEI_FV_HANDLE VolumeHandle
,
591 IN EFI_PEI_FILE_HANDLE FileHandle
597 Gets the pointer to the HOB List.
600 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
601 @param HobList Pointer to the HOB List.
603 @retval EFI_SUCCESS Get the pointer of HOB List
604 @retval EFI_NOT_AVAILABLE_YET the HOB List is not yet published
605 @retval EFI_INVALID_PARAMETER HobList is NULL (in debug mode)
611 IN CONST EFI_PEI_SERVICES
**PeiServices
,
612 IN OUT VOID
**HobList
617 Add a new HOB to the HOB List.
619 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
620 @param Type Type of the new HOB.
621 @param Length Length of the new HOB to allocate.
622 @param Hob Pointer to the new HOB.
624 @return EFI_SUCCESS Success to create hob.
625 @retval EFI_INVALID_PARAMETER if Hob is NULL
626 @retval EFI_NOT_AVAILABLE_YET if HobList is still not available.
627 @retval EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.
633 IN CONST EFI_PEI_SERVICES
**PeiServices
,
642 Builds a Handoff Information Table HOB
644 @param BootMode - Current Bootmode
645 @param MemoryBegin - Start Memory Address.
646 @param MemoryLength - Length of Memory.
648 @return EFI_SUCCESS Always success to initialize HOB.
652 PeiCoreBuildHobHandoffInfoTable (
653 IN EFI_BOOT_MODE BootMode
,
654 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
655 IN UINT64 MemoryLength
661 // FFS Fw Volume support functions
664 Given the input file pointer, search for the next matching file in the
665 FFS volume as defined by SearchType. The search starts from FileHeader inside
666 the Firmware Volume defined by FwVolHeader.
669 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
670 @param SearchType Filter to find only files of this type.
671 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
672 @param FwVolHeader Pointer to the FV header of the volume to search.
673 @param FileHeader Pointer to the current file from which to begin searching.
674 This pointer will be updated upon return to reflect the file found.
675 @retval EFI_NOT_FOUND No files matching the search criteria were found
676 @retval EFI_SUCCESS Success to find next file in given volume
682 IN CONST EFI_PEI_SERVICES
**PeiServices
,
684 IN EFI_PEI_FV_HANDLE FwVolHeader
,
685 IN OUT EFI_PEI_FILE_HANDLE
*FileHeader
690 Given the input file pointer, search for the next matching section in the
693 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
694 @param SectionType Filter to find only sections of this type.
695 @param FfsFileHeader Pointer to the current file to search.
696 @param SectionData Pointer to the Section matching SectionType in FfsFileHeader.
697 NULL if section not found
699 @retval EFI_NOT_FOUND No files matching the search criteria were found
700 @retval EFI_SUCCESS Success to find section data in given file
705 PeiFfsFindSectionData (
706 IN CONST EFI_PEI_SERVICES
**PeiServices
,
707 IN EFI_SECTION_TYPE SectionType
,
708 IN EFI_PEI_FILE_HANDLE FfsFileHeader
,
709 IN OUT VOID
**SectionData
714 search the firmware volumes by index
716 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
717 @param Instance Instance of FV to find
718 @param FwVolHeader Pointer to found Volume.
720 @retval EFI_INVALID_PARAMETER FwVolHeader is NULL
721 @retval EFI_SUCCESS Firmware volume instance successfully found.
726 PeiFvFindNextVolume (
727 IN CONST EFI_PEI_SERVICES
**PeiServices
,
729 IN OUT EFI_PEI_FV_HANDLE
*FwVolHeader
734 // Memory support functions
738 Initialize the memory services.
740 @param PrivateData PeiCore's private data structure
741 @param SecCoreData Points to a data structure containing information about the PEI core's operating
742 environment, such as the size and location of temporary RAM, the stack location and
744 @param OldCoreData Pointer to the PEI Core data.
745 NULL if being run in non-permament memory mode.
749 InitializeMemoryServices (
750 IN PEI_CORE_INSTANCE
*PrivateData
,
751 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
752 IN PEI_CORE_INSTANCE
*OldCoreData
758 Install the permanent memory is now available.
759 Creates HOB (PHIT and Stack).
761 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
762 @param MemoryBegin Start of memory address.
763 @param MemoryLength Length of memory.
765 @return EFI_SUCCESS Always success.
770 PeiInstallPeiMemory (
771 IN CONST EFI_PEI_SERVICES
**PeiServices
,
772 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
773 IN UINT64 MemoryLength
779 Memory allocation service on permanent memory,
780 not usable prior to the memory installation.
783 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
784 @param MemoryType Type of memory to allocate.
785 @param Pages Number of pages to allocate.
786 @param Memory Pointer of memory allocated.
788 @retval EFI_SUCCESS The allocation was successful
789 @retval EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported.
790 @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available
791 @retval EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement
792 to allocate the number of pages.
798 IN CONST EFI_PEI_SERVICES
**PeiServices
,
799 IN EFI_MEMORY_TYPE MemoryType
,
801 OUT EFI_PHYSICAL_ADDRESS
*Memory
807 Memory allocation service on the CAR.
810 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
811 @param Size Amount of memory required
812 @param Buffer Address of pointer to the buffer
814 @retval EFI_SUCCESS The allocation was successful
815 @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement
816 to allocate the requested size.
822 IN CONST EFI_PEI_SERVICES
**PeiServices
,
830 Routine for load image file.
833 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
834 @param FileHandle Pointer to the FFS file header of the image.
835 @param EntryPoint Pointer to entry point of specified image file for output.
836 @param AuthenticationState Pointer to attestation authentication state of image.
838 @retval EFI_SUCCESS Image is successfully loaded.
839 @retval EFI_NOT_FOUND Fail to locate necessary PPI
840 @retval Others Fail to load file.
845 IN EFI_PEI_SERVICES
**PeiServices
,
846 IN EFI_PEI_FILE_HANDLE FileHandle
,
847 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
,
848 OUT UINT32
*AuthenticationState
854 Core version of the Status Code reporter
857 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
858 @param CodeType Type of Status Code.
859 @param Value Value to output for Status Code.
860 @param Instance Instance Number of this status code.
861 @param CallerId ID of the caller of this status code.
862 @param Data Optional data associated with this status code.
864 @retval EFI_SUCCESS if status code is successfully reported
865 @retval EFI_NOT_AVAILABLE_YET if StatusCodePpi has not been installed
870 PeiReportStatusCode (
871 IN CONST EFI_PEI_SERVICES
**PeiServices
,
872 IN EFI_STATUS_CODE_TYPE CodeType
,
873 IN EFI_STATUS_CODE_VALUE Value
,
875 IN CONST EFI_GUID
*CallerId
,
876 IN CONST EFI_STATUS_CODE_DATA
*Data OPTIONAL
882 Core version of the Reset System
885 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
887 @retval EFI_NOT_AVAILABLE_YET PPI not available yet.
888 @retval EFI_DEVICE_ERROR Did not reset system.
889 Otherwise, resets the system.
895 IN CONST EFI_PEI_SERVICES
**PeiServices
901 Initialize PeiCore Fv List.
904 @param PrivateData - Pointer to PEI_CORE_INSTANCE.
905 @param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.
910 IN PEI_CORE_INSTANCE
*PrivateData
,
911 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
916 Process Firmware Volum Information once FvInfoPPI install.
918 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
919 @param NotifyDescriptor Address of the notification descriptor data structure.
920 @param Ppi Address of the PPI that was installed.
922 @retval EFI_SUCCESS if the interface could be successfully installed
927 FirmwareVolmeInfoPpiNotifyCallback (
928 IN EFI_PEI_SERVICES
**PeiServices
,
929 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
936 Given the input VolumeHandle, search for the next matching name file.
938 @param FileName File name to search.
939 @param VolumeHandle The current FV to search.
940 @param FileHandle Pointer to the file matching name in VolumeHandle.
941 NULL if file not found
943 @retval EFI_NOT_FOUND No files matching the search criteria were found
944 @retval EFI_SUCCESS Success to search given file
949 PeiFfsFindFileByName (
950 IN CONST EFI_GUID
*FileName
,
951 IN EFI_PEI_FV_HANDLE VolumeHandle
,
952 OUT EFI_PEI_FILE_HANDLE
*FileHandle
958 Returns information about a specific file.
961 @param FileHandle The handle to file.
962 @param FileInfo Pointer to the file information.
964 @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.
965 @retval EFI_SUCCESS Success to collect file info.
971 IN EFI_PEI_FILE_HANDLE FileHandle
,
972 OUT EFI_FV_FILE_INFO
*FileInfo
978 Collect information of given Fv Volume.
980 @param VolumeHandle The handle to Fv Volume.
981 @param VolumeInfo The pointer to volume information.
983 @retval EFI_INVALID_PARAMETER VolumeInfo is NULL
984 @retval EFI_SUCCESS Success to collect fv info.
988 PeiFfsGetVolumeInfo (
989 IN EFI_PEI_FV_HANDLE VolumeHandle
,
990 OUT EFI_FV_INFO
*VolumeInfo
995 This routine enable a PEIM to register itself to shadow when PEI Foundation
996 discovery permanent memory.
998 @param FileHandle File handle of a PEIM.
1000 @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.
1001 @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.
1002 @retval EFI_SUCCESS Successfully to register itself.
1007 PeiRegisterForShadow (
1008 IN EFI_PEI_FILE_HANDLE FileHandle
1013 Given the input file pointer, search for the next matching file in the
1014 FFS volume as defined by SearchType. The search starts from FileHeader inside
1015 the Firmware Volume defined by FwVolHeader.
1018 @param FvHandle Pointer to the FV header of the volume to search
1019 @param FileName File name
1020 @param SearchType Filter to find only files of this type.
1021 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
1022 @param FileHandle This parameter must point to a valid FFS volume.
1023 @param AprioriFile Pointer to AprioriFile image in this FV if has
1025 @return EFI_NOT_FOUND No files matching the search criteria were found
1026 @retval EFI_SUCCESS Success to search given file
1031 IN CONST EFI_PEI_FV_HANDLE FvHandle
,
1032 IN CONST EFI_GUID
*FileName
, OPTIONAL
1033 IN EFI_FV_FILETYPE SearchType
,
1034 IN OUT EFI_PEI_FILE_HANDLE
*FileHandle
,
1035 IN OUT EFI_PEI_FV_HANDLE
*AprioriFile OPTIONAL
1040 Initialize image service that install PeiLoadFilePpi.
1042 @param PrivateData Pointer to PeiCore's private data structure PEI_CORE_INSTANCE.
1043 @param OldCoreData Pointer to Old PeiCore's private data.
1044 If NULL, PeiCore is entered at first time, stack/heap in temporary memory.
1045 If not NULL, PeiCore is entered at second time, stack/heap has been moved
1046 to permenent memory.
1050 InitializeImageServices (
1051 IN PEI_CORE_INSTANCE
*PrivateData
,
1052 IN PEI_CORE_INSTANCE
*OldCoreData
1057 Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.
1059 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
1060 @param FileHandle File handle of a Fv type file.
1061 @param AuthenticationState Pointer to attestation authentication state of image.
1062 If return 0, means pass security checking.
1064 @retval EFI_NOT_FOUND FV image can't be found.
1065 @retval EFI_SUCCESS Successfully to process it.
1070 IN EFI_PEI_SERVICES
**PeiServices
,
1071 IN EFI_PEI_FILE_HANDLE FvFileHandle
,
1072 OUT UINT32
*AuthenticationState