3 Responsibility of this module is to load the DXE Core from a Firmware Volume.
5 Copyright (c) 2006 - 2007 Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Ppi/GuidedSectionExtraction.h>
18 #include <FrameworkPei.h>
21 CustomGuidedSectionExtract (
22 IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
*This
,
23 IN CONST VOID
*InputSection
,
24 OUT VOID
**OutputBuffer
,
25 OUT UINTN
*OutputSize
,
26 OUT UINT32
*AuthenticationStatus
33 IN CONST EFI_PEI_DECOMPRESS_PPI
*This
,
34 IN CONST EFI_COMPRESSION_SECTION
*InputSection
,
35 OUT VOID
**OutputBuffer
,
40 BOOLEAN gInMemory
= FALSE
;
43 // Module Globals used in the DXE to PEI handoff
44 // These must be module globals, so the stack can be switched
46 static EFI_DXE_IPL_PPI mDxeIplPpi
= {
50 STATIC EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomGuidedSectionExtractionPpi
= {
51 CustomGuidedSectionExtract
54 STATIC EFI_PEI_DECOMPRESS_PPI mDecompressPpi
= {
58 static EFI_PEI_PPI_DESCRIPTOR mPpiList
[] = {
60 EFI_PEI_PPI_DESCRIPTOR_PPI
,
65 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
66 &gEfiPeiDecompressPpiGuid
,
71 static EFI_PEI_PPI_DESCRIPTOR mPpiSignal
= {
72 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
73 &gEfiEndOfPeiSignalPpiGuid
,
78 Initializes the Dxe Ipl PPI
80 @param FfsHandle The handle of FFS file.
81 @param PeiServices General purpose services available to
87 PeimInitializeDxeIpl (
88 IN EFI_PEI_FILE_HANDLE FfsHandle
,
89 IN EFI_PEI_SERVICES
**PeiServices
93 EFI_BOOT_MODE BootMode
;
94 EFI_GUID
*ExtractHandlerGuidTable
;
95 UINTN ExtractHandlerNumber
;
96 EFI_PEI_PPI_DESCRIPTOR
*GuidPpi
;
98 Status
= PeiServicesGetBootMode (&BootMode
);
99 ASSERT_EFI_ERROR (Status
);
101 if (BootMode
!= BOOT_ON_S3_RESUME
) {
102 Status
= PeiServicesRegisterForShadow (FfsHandle
);
103 if (Status
== EFI_SUCCESS
) {
105 // EFI_SUCESS means the first time call register for shadow
108 } else if (Status
== EFI_ALREADY_STARTED
) {
113 // Get custom extract guided section method guid list
115 ExtractHandlerNumber
= ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable
);
118 // Install custom extraction guid ppi
120 if (ExtractHandlerNumber
> 0) {
122 GuidPpi
= (EFI_PEI_PPI_DESCRIPTOR
*) AllocatePool (ExtractHandlerNumber
* sizeof (EFI_PEI_PPI_DESCRIPTOR
));
123 ASSERT (GuidPpi
!= NULL
);
124 while (ExtractHandlerNumber
-- > 0) {
125 GuidPpi
->Flags
= EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
;
126 GuidPpi
->Ppi
= &mCustomGuidedSectionExtractionPpi
;
127 GuidPpi
->Guid
= &(ExtractHandlerGuidTable
[ExtractHandlerNumber
]);
128 Status
= PeiServicesInstallPpi (GuidPpi
++);
129 ASSERT_EFI_ERROR(Status
);
133 ASSERT_EFI_ERROR (FALSE
);
138 // Install FvFileLoader and DxeIpl PPIs.
140 Status
= PeiServicesInstallPpi (mPpiList
);
141 ASSERT_EFI_ERROR(Status
);
147 Main entry point to last PEIM
149 @param This Entry point for DXE IPL PPI
150 @param PeiServices General purpose services available to every PEIM.
151 @param HobList Address to the Pei HOB list
153 @return EFI_SUCCESS DXE core was successfully loaded.
154 @return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.
159 IN EFI_DXE_IPL_PPI
*This
,
160 IN EFI_PEI_SERVICES
**PeiServices
,
161 IN EFI_PEI_HOB_POINTERS HobList
165 EFI_GUID DxeCoreFileName
;
166 EFI_PHYSICAL_ADDRESS DxeCoreAddress
;
168 EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint
;
169 EFI_BOOT_MODE BootMode
;
170 EFI_PEI_FV_HANDLE VolumeHandle
;
171 EFI_PEI_FILE_HANDLE FileHandle
;
175 // if in S3 Resume, restore configure
177 Status
= PeiServicesGetBootMode (&BootMode
);
178 ASSERT_EFI_ERROR(Status
);
180 if (BootMode
== BOOT_ON_S3_RESUME
) {
181 Status
= AcpiS3ResumeOs();
182 ASSERT_EFI_ERROR (Status
);
183 } else if (BootMode
== BOOT_IN_RECOVERY_MODE
) {
184 Status
= PeiRecoverFirmware ();
185 if (EFI_ERROR (Status
)) {
186 DEBUG ((EFI_D_ERROR
, "Load Recovery Capsule Failed.(Status = %r)\n", Status
));
191 // Now should have a HOB with the DXE core w/ the old HOB destroyed
196 // If any FV contains an encapsulated FV extract that FV
198 DxeIplAddEncapsulatedFirmwareVolumes ();
201 // Look in all the FVs present in PEI and find the DXE Core
204 Status
= DxeIplFindFirmwareVolumeInstance (&Instance
, EFI_FV_FILETYPE_DXE_CORE
, &VolumeHandle
, &FileHandle
);
205 ASSERT_EFI_ERROR (Status
);
207 CopyMem(&DxeCoreFileName
, &(((EFI_FFS_FILE_HEADER
*)FileHandle
)->Name
), sizeof (EFI_GUID
));
210 // Load the DXE Core from a Firmware Volume
212 Status
= PeiLoadFile (
219 ASSERT_EFI_ERROR (Status
);
222 // Add HOB for the DXE Core
232 // Report Status Code EFI_SW_PEI_PC_HANDOFF_TO_NEXT
236 EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT
240 // Transfer control to the DXE Core
241 // The handoff state is simply a pointer to the HOB list
243 DEBUG ((EFI_D_INFO
, "DXE Core Entry Point 0x%08x\n", (UINTN
) DxeCoreEntryPoint
));
244 HandOffToDxeCore (DxeCoreEntryPoint
, HobList
, &mPpiSignal
);
246 // If we get here, then the DXE Core returned. This is an error
247 // Dxe Core should not return.
252 return EFI_OUT_OF_RESOURCES
;
259 IN EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
,
260 OUT UINT32
*FvAlignment
264 // Because FvLength in FvHeader is UINT64 type,
265 // so FvHeader must meed at least 8 bytes alignment.
266 // Get the appropriate alignment requirement.
268 if ((FvHeader
->Attributes
& EFI_FVB2_ALIGNMENT
) < EFI_FVB2_ALIGNMENT_8
) {
269 return EFI_UNSUPPORTED
;
272 *FvAlignment
= 1 << ((FvHeader
->Attributes
& EFI_FVB2_ALIGNMENT
) >> 16);
277 Search EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE image and expand
280 @return EFI_OUT_OF_RESOURCES There are no memory space to exstract FV
281 @return EFI_SUCESS Sucess to find the FV
284 DxeIplAddEncapsulatedFirmwareVolumes (
289 EFI_STATUS VolumeStatus
;
291 EFI_FV_INFO VolumeInfo
;
292 EFI_PEI_FV_HANDLE VolumeHandle
;
293 EFI_PEI_FILE_HANDLE FileHandle
;
294 UINT32 SectionLength
;
295 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
296 EFI_FIRMWARE_VOLUME_IMAGE_SECTION
*SectionHeader
;
300 Status
= EFI_NOT_FOUND
;
304 VolumeStatus
= DxeIplFindFirmwareVolumeInstance (
306 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
,
311 if (!EFI_ERROR (VolumeStatus
)) {
312 Status
= PeiServicesFfsFindSectionData (
313 EFI_SECTION_FIRMWARE_VOLUME_IMAGE
,
314 (EFI_FFS_FILE_HEADER
*)FileHandle
,
318 if (!EFI_ERROR (Status
)) {
319 if (FvHeader
->Signature
== EFI_FVH_SIGNATURE
) {
321 // Because FvLength in FvHeader is UINT64 type,
322 // so FvHeader must meed at least 8 bytes alignment.
323 // If current FvImage base address doesn't meet its alignment,
324 // we need to reload this FvImage to another correct memory address.
326 Status
= GetFvAlignment(FvHeader
, &FvAlignment
);
327 if (EFI_ERROR(Status
)) {
330 if (((UINTN
) FvHeader
% FvAlignment
) != 0) {
331 SectionHeader
= (EFI_FIRMWARE_VOLUME_IMAGE_SECTION
*)((UINTN
)FvHeader
- sizeof(EFI_FIRMWARE_VOLUME_IMAGE_SECTION
));
332 SectionLength
= *(UINT32
*)SectionHeader
->Size
& 0x00FFFFFF;
334 DstBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINTN
) SectionLength
- sizeof (EFI_COMMON_SECTION_HEADER
)), FvAlignment
);
335 if (DstBuffer
== NULL
) {
336 return EFI_OUT_OF_RESOURCES
;
338 CopyMem (DstBuffer
, FvHeader
, (UINTN
) SectionLength
- sizeof (EFI_COMMON_SECTION_HEADER
));
339 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) DstBuffer
;
343 // This new Firmware Volume comes from a firmware file within a firmware volume.
344 // Record the original Firmware Volume Name.
346 PeiServicesFfsGetVolumeInfo (&VolumeHandle
, &VolumeInfo
);
348 PeiPiLibBuildPiFvInfoPpi (
349 (EFI_PHYSICAL_ADDRESS
) FvHeader
,
351 &(VolumeInfo
.FvName
),
352 &(((EFI_FFS_FILE_HEADER
*)FileHandle
)->Name
)
355 ASSERT_EFI_ERROR (Status
);
358 // Makes the encapsulated volume show up in DXE phase to skip processing of
359 // encapsulated file again.
362 (EFI_PHYSICAL_ADDRESS
)(UINTN
)FvHeader
,
365 &(((EFI_FFS_FILE_HEADER
*)FileHandle
)->Name
)
371 } while (!EFI_ERROR (VolumeStatus
));
377 Find the First Volume that contains the first FileType.
379 @param Instance The Fv instance.
380 @param SeachType The type of file to search.
381 @param VolumeHandle Pointer to Fv which contains the file to search.
382 @param FileHandle Pointer to FFS file to search.
384 @return EFI_SUCESS Success to find the FFS in specificed FV
385 @return others Fail to find the FFS in specificed FV
388 DxeIplFindFirmwareVolumeInstance (
389 IN OUT UINTN
*Instance
,
390 IN EFI_FV_FILETYPE SeachType
,
391 OUT EFI_PEI_FV_HANDLE
*VolumeHandle
,
392 OUT EFI_PEI_FILE_HANDLE
*FileHandle
396 EFI_STATUS VolumeStatus
;
399 VolumeStatus
= PeiServicesFfsFindNextVolume (*Instance
, VolumeHandle
);
400 if (!EFI_ERROR (VolumeStatus
)) {
402 Status
= PeiServicesFfsFindNextFile (SeachType
, *VolumeHandle
, FileHandle
);
403 if (!EFI_ERROR (Status
)) {
408 } while (!EFI_ERROR (VolumeStatus
));
414 Loads and relocates a PE/COFF image into memory.
416 @param FileHandle The image file handle
417 @param ImageAddress The base address of the relocated PE/COFF image
418 @param ImageSize The size of the relocated PE/COFF image
419 @param EntryPoint The entry point of the relocated PE/COFF image
421 @return EFI_SUCCESS The file was loaded and relocated
422 @return EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file
426 IN EFI_PEI_FILE_HANDLE FileHandle
,
427 OUT EFI_PHYSICAL_ADDRESS
*ImageAddress
,
428 OUT UINT64
*ImageSize
,
429 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
434 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
437 // First try to find the required section in this ffs file.
439 Status
= PeiServicesFfsFindSectionData (
445 if (EFI_ERROR (Status
)) {
446 Status
= PeiServicesFfsFindSectionData (
453 if (EFI_ERROR (Status
)) {
455 // NO image types we support so exit.
460 ZeroMem (&ImageContext
, sizeof (ImageContext
));
461 ImageContext
.Handle
= Pe32Data
;
462 Status
= GetImageReadFunction (&ImageContext
);
464 ASSERT_EFI_ERROR (Status
);
466 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
467 if (EFI_ERROR (Status
)) {
471 // Allocate Memory for the image
473 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
) AllocatePages (EFI_SIZE_TO_PAGES ((UINT32
) ImageContext
.ImageSize
));
474 ASSERT (ImageContext
.ImageAddress
!= 0);
477 // Load the image to our new buffer
479 Status
= PeCoffLoaderLoadImage (&ImageContext
);
480 if (EFI_ERROR (Status
)) {
484 // Relocate the image in our new buffer
486 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
487 if (EFI_ERROR (Status
)) {
492 // Flush the instruction cache so the image data is written before we execute it
494 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
496 *ImageAddress
= ImageContext
.ImageAddress
;
497 *ImageSize
= ImageContext
.ImageSize
;
498 *EntryPoint
= ImageContext
.EntryPoint
;
504 The ExtractSection() function processes the input section and
505 returns a pointer to the section contents. If the section being
506 extracted does not require processing (if the section
507 GuidedSectionHeader.Attributes has the
508 EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then
509 OutputBuffer is just updated to point to the start of the
510 section's contents. Otherwise, *Buffer must be allocated
511 from PEI permanent memory.
513 @param This Indicates the
514 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.
515 Buffer containing the input GUIDed section to be
516 processed. OutputBuffer OutputBuffer is
517 allocated from PEI permanent memory and contains
518 the new section stream.
520 @param OutputSize A pointer to a caller-allocated
521 UINTN in which the size of *OutputBuffer
522 allocation is stored. If the function
523 returns anything other than EFI_SUCCESS,
524 the value of OutputSize is undefined.
526 @param AuthenticationStatus A pointer to a caller-allocated
527 UINT32 that indicates the
528 authentication status of the
529 output buffer. If the input
530 section's GuidedSectionHeader.
531 Attributes field has the
532 EFI_GUIDED_SECTION_AUTH_STATUS_VALID
534 AuthenticationStatus must return
535 zero. These bits reflect the
536 status of the extraction
537 operation. If the function
538 returns anything other than
539 EFI_SUCCESS, the value of
540 AuthenticationStatus is
543 @retval EFI_SUCCESS The InputSection was
544 successfully processed and the
545 section contents were returned.
547 @retval EFI_OUT_OF_RESOURCES The system has insufficient
548 resources to process the request.
550 @reteval EFI_INVALID_PARAMETER The GUID in InputSection does
551 not match this instance of the
552 GUIDed Section Extraction PPI.
555 CustomGuidedSectionExtract (
556 IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
*This
,
557 IN CONST VOID
*InputSection
,
558 OUT VOID
**OutputBuffer
,
559 OUT UINTN
*OutputSize
,
560 OUT UINT32
*AuthenticationStatus
564 UINT8
*ScratchBuffer
;
565 UINT32 ScratchBufferSize
;
566 UINT32 OutputBufferSize
;
567 UINT16 SectionAttribute
;
570 // Init local variable
572 ScratchBuffer
= NULL
;
575 // Call GetInfo to get the size and attribute of input guided section data.
577 Status
= ExtractGuidedSectionGetInfo (
584 if (EFI_ERROR (Status
)) {
585 DEBUG ((EFI_D_ERROR
, "GetInfo from guided section Failed - %r\n", Status
));
589 if (ScratchBufferSize
!= 0) {
591 // Allocate scratch buffer
593 ScratchBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize
));
594 if (ScratchBuffer
== NULL
) {
595 return EFI_OUT_OF_RESOURCES
;
599 if ((SectionAttribute
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) && OutputBufferSize
> 0) {
601 // Allocate output buffer
603 *OutputBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (OutputBufferSize
));
604 if (*OutputBuffer
== NULL
) {
605 return EFI_OUT_OF_RESOURCES
;
609 Status
= ExtractGuidedSectionDecode (
616 if (EFI_ERROR (Status
)) {
620 DEBUG ((EFI_D_ERROR
, "Extract guided section Failed - %r\n", Status
));
624 *OutputSize
= (UINTN
) OutputBufferSize
;
633 IN CONST EFI_PEI_DECOMPRESS_PPI
*This
,
634 IN CONST EFI_COMPRESSION_SECTION
*CompressionSection
,
635 OUT VOID
**OutputBuffer
,
636 OUT UINTN
*OutputSize
641 UINT8
*ScratchBuffer
;
643 UINT32 ScratchBufferSize
;
644 EFI_COMMON_SECTION_HEADER
*Section
;
647 if (CompressionSection
->CommonHeader
.Type
!= EFI_SECTION_COMPRESSION
) {
649 return EFI_INVALID_PARAMETER
;
652 Section
= (EFI_COMMON_SECTION_HEADER
*) CompressionSection
;
653 SectionLength
= *(UINT32
*) (Section
->Size
) & 0x00ffffff;
656 // This is a compression set, expand it
658 switch (CompressionSection
->CompressionType
) {
659 case EFI_STANDARD_COMPRESSION
:
661 // Load EFI standard compression.
662 // For compressed data, decompress them to dstbuffer.
664 Status
= UefiDecompressGetInfo (
665 (UINT8
*) ((EFI_COMPRESSION_SECTION
*) Section
+ 1),
666 (UINT32
) SectionLength
- sizeof (EFI_COMPRESSION_SECTION
),
667 (UINT32
*) &DstBufferSize
,
670 if (EFI_ERROR (Status
)) {
674 DEBUG ((EFI_D_ERROR
, "Decompress GetInfo Failed - %r\n", Status
));
675 return EFI_NOT_FOUND
;
678 // Allocate scratch buffer
680 ScratchBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize
));
681 if (ScratchBuffer
== NULL
) {
682 return EFI_OUT_OF_RESOURCES
;
685 // Allocate destination buffer
687 DstBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize
));
688 if (DstBuffer
== NULL
) {
689 return EFI_OUT_OF_RESOURCES
;
692 // Call decompress function
694 Status
= UefiDecompress (
695 (CHAR8
*) ((EFI_COMPRESSION_SECTION
*) Section
+ 1),
699 if (EFI_ERROR (Status
)) {
703 DEBUG ((EFI_D_ERROR
, "Decompress Failed - %r\n", Status
));
704 return EFI_NOT_FOUND
;
708 // porting note the original branch for customized compress is removed, it should be change to use GUID compress
710 case EFI_NOT_COMPRESSED
:
712 // Allocate destination buffer
714 DstBufferSize
= CompressionSection
->UncompressedLength
;
715 DstBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize
));
716 if (DstBuffer
== NULL
) {
717 return EFI_OUT_OF_RESOURCES
;
720 // stream is not actually compressed, just encapsulated. So just copy it.
722 CopyMem (DstBuffer
, CompressionSection
+ 1, DstBufferSize
);
727 // Don't support other unknown compression type.
730 return EFI_NOT_FOUND
;
733 *OutputSize
= DstBufferSize
;
734 *OutputBuffer
= DstBuffer
;