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 PiLibInstallFvInfoPpi (
351 (UINT32
) FvHeader
->FvLength
,
352 &(VolumeInfo
.FvName
),
353 &(((EFI_FFS_FILE_HEADER
*)FileHandle
)->Name
)
357 // Inform HOB consumer phase, i.e. DXE core, the existance of this FV
360 (EFI_PHYSICAL_ADDRESS
) (UINTN
) FvHeader
,
364 ASSERT_EFI_ERROR (Status
);
367 // Makes the encapsulated volume show up in DXE phase to skip processing of
368 // encapsulated file again.
371 (EFI_PHYSICAL_ADDRESS
)(UINTN
)FvHeader
,
374 &(((EFI_FFS_FILE_HEADER
*)FileHandle
)->Name
)
380 } while (!EFI_ERROR (VolumeStatus
));
386 Find the First Volume that contains the first FileType.
388 @param Instance The Fv instance.
389 @param SeachType The type of file to search.
390 @param VolumeHandle Pointer to Fv which contains the file to search.
391 @param FileHandle Pointer to FFS file to search.
393 @return EFI_SUCESS Success to find the FFS in specificed FV
394 @return others Fail to find the FFS in specificed FV
397 DxeIplFindFirmwareVolumeInstance (
398 IN OUT UINTN
*Instance
,
399 IN EFI_FV_FILETYPE SeachType
,
400 OUT EFI_PEI_FV_HANDLE
*VolumeHandle
,
401 OUT EFI_PEI_FILE_HANDLE
*FileHandle
405 EFI_STATUS VolumeStatus
;
408 VolumeStatus
= PeiServicesFfsFindNextVolume (*Instance
, VolumeHandle
);
409 if (!EFI_ERROR (VolumeStatus
)) {
411 Status
= PeiServicesFfsFindNextFile (SeachType
, *VolumeHandle
, FileHandle
);
412 if (!EFI_ERROR (Status
)) {
417 } while (!EFI_ERROR (VolumeStatus
));
423 Loads and relocates a PE/COFF image into memory.
425 @param FileHandle The image file handle
426 @param ImageAddress The base address of the relocated PE/COFF image
427 @param ImageSize The size of the relocated PE/COFF image
428 @param EntryPoint The entry point of the relocated PE/COFF image
430 @return EFI_SUCCESS The file was loaded and relocated
431 @return EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file
435 IN EFI_PEI_FILE_HANDLE FileHandle
,
436 OUT EFI_PHYSICAL_ADDRESS
*ImageAddress
,
437 OUT UINT64
*ImageSize
,
438 OUT EFI_PHYSICAL_ADDRESS
*EntryPoint
443 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
446 // First try to find the required section in this ffs file.
448 Status
= PeiServicesFfsFindSectionData (
454 if (EFI_ERROR (Status
)) {
455 Status
= PeiServicesFfsFindSectionData (
462 if (EFI_ERROR (Status
)) {
464 // NO image types we support so exit.
469 ZeroMem (&ImageContext
, sizeof (ImageContext
));
470 ImageContext
.Handle
= Pe32Data
;
471 Status
= GetImageReadFunction (&ImageContext
);
473 ASSERT_EFI_ERROR (Status
);
475 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
476 if (EFI_ERROR (Status
)) {
480 // Allocate Memory for the image
482 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
) AllocatePages (EFI_SIZE_TO_PAGES ((UINT32
) ImageContext
.ImageSize
));
483 ASSERT (ImageContext
.ImageAddress
!= 0);
486 // Load the image to our new buffer
488 Status
= PeCoffLoaderLoadImage (&ImageContext
);
489 if (EFI_ERROR (Status
)) {
493 // Relocate the image in our new buffer
495 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
496 if (EFI_ERROR (Status
)) {
501 // Flush the instruction cache so the image data is written before we execute it
503 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
505 *ImageAddress
= ImageContext
.ImageAddress
;
506 *ImageSize
= ImageContext
.ImageSize
;
507 *EntryPoint
= ImageContext
.EntryPoint
;
513 The ExtractSection() function processes the input section and
514 returns a pointer to the section contents. If the section being
515 extracted does not require processing (if the section
516 GuidedSectionHeader.Attributes has the
517 EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then
518 OutputBuffer is just updated to point to the start of the
519 section's contents. Otherwise, *Buffer must be allocated
520 from PEI permanent memory.
522 @param This Indicates the
523 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.
524 Buffer containing the input GUIDed section to be
525 processed. OutputBuffer OutputBuffer is
526 allocated from PEI permanent memory and contains
527 the new section stream.
529 @param OutputSize A pointer to a caller-allocated
530 UINTN in which the size of *OutputBuffer
531 allocation is stored. If the function
532 returns anything other than EFI_SUCCESS,
533 the value of OutputSize is undefined.
535 @param AuthenticationStatus A pointer to a caller-allocated
536 UINT32 that indicates the
537 authentication status of the
538 output buffer. If the input
539 section's GuidedSectionHeader.
540 Attributes field has the
541 EFI_GUIDED_SECTION_AUTH_STATUS_VALID
543 AuthenticationStatus must return
544 zero. These bits reflect the
545 status of the extraction
546 operation. If the function
547 returns anything other than
548 EFI_SUCCESS, the value of
549 AuthenticationStatus is
552 @retval EFI_SUCCESS The InputSection was
553 successfully processed and the
554 section contents were returned.
556 @retval EFI_OUT_OF_RESOURCES The system has insufficient
557 resources to process the request.
559 @reteval EFI_INVALID_PARAMETER The GUID in InputSection does
560 not match this instance of the
561 GUIDed Section Extraction PPI.
564 CustomGuidedSectionExtract (
565 IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
*This
,
566 IN CONST VOID
*InputSection
,
567 OUT VOID
**OutputBuffer
,
568 OUT UINTN
*OutputSize
,
569 OUT UINT32
*AuthenticationStatus
573 UINT8
*ScratchBuffer
;
574 UINT32 ScratchBufferSize
;
575 UINT32 OutputBufferSize
;
576 UINT16 SectionAttribute
;
579 // Init local variable
581 ScratchBuffer
= NULL
;
584 // Call GetInfo to get the size and attribute of input guided section data.
586 Status
= ExtractGuidedSectionGetInfo (
593 if (EFI_ERROR (Status
)) {
594 DEBUG ((EFI_D_ERROR
, "GetInfo from guided section Failed - %r\n", Status
));
598 if (ScratchBufferSize
!= 0) {
600 // Allocate scratch buffer
602 ScratchBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize
));
603 if (ScratchBuffer
== NULL
) {
604 return EFI_OUT_OF_RESOURCES
;
608 if ((SectionAttribute
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) && OutputBufferSize
> 0) {
610 // Allocate output buffer
612 *OutputBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (OutputBufferSize
));
613 if (*OutputBuffer
== NULL
) {
614 return EFI_OUT_OF_RESOURCES
;
618 Status
= ExtractGuidedSectionDecode (
625 if (EFI_ERROR (Status
)) {
629 DEBUG ((EFI_D_ERROR
, "Extract guided section Failed - %r\n", Status
));
633 *OutputSize
= (UINTN
) OutputBufferSize
;
642 IN CONST EFI_PEI_DECOMPRESS_PPI
*This
,
643 IN CONST EFI_COMPRESSION_SECTION
*CompressionSection
,
644 OUT VOID
**OutputBuffer
,
645 OUT UINTN
*OutputSize
650 UINT8
*ScratchBuffer
;
652 UINT32 ScratchBufferSize
;
653 EFI_COMMON_SECTION_HEADER
*Section
;
656 if (CompressionSection
->CommonHeader
.Type
!= EFI_SECTION_COMPRESSION
) {
658 return EFI_INVALID_PARAMETER
;
661 Section
= (EFI_COMMON_SECTION_HEADER
*) CompressionSection
;
662 SectionLength
= *(UINT32
*) (Section
->Size
) & 0x00ffffff;
665 // This is a compression set, expand it
667 switch (CompressionSection
->CompressionType
) {
668 case EFI_STANDARD_COMPRESSION
:
670 // Load EFI standard compression.
671 // For compressed data, decompress them to dstbuffer.
673 Status
= UefiDecompressGetInfo (
674 (UINT8
*) ((EFI_COMPRESSION_SECTION
*) Section
+ 1),
675 (UINT32
) SectionLength
- sizeof (EFI_COMPRESSION_SECTION
),
676 (UINT32
*) &DstBufferSize
,
679 if (EFI_ERROR (Status
)) {
683 DEBUG ((EFI_D_ERROR
, "Decompress GetInfo Failed - %r\n", Status
));
684 return EFI_NOT_FOUND
;
687 // Allocate scratch buffer
689 ScratchBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize
));
690 if (ScratchBuffer
== NULL
) {
691 return EFI_OUT_OF_RESOURCES
;
694 // Allocate destination buffer
696 DstBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize
));
697 if (DstBuffer
== NULL
) {
698 return EFI_OUT_OF_RESOURCES
;
701 // Call decompress function
703 Status
= UefiDecompress (
704 (CHAR8
*) ((EFI_COMPRESSION_SECTION
*) Section
+ 1),
708 if (EFI_ERROR (Status
)) {
712 DEBUG ((EFI_D_ERROR
, "Decompress Failed - %r\n", Status
));
713 return EFI_NOT_FOUND
;
717 // porting note the original branch for customized compress is removed, it should be change to use GUID compress
719 case EFI_NOT_COMPRESSED
:
721 // Allocate destination buffer
723 DstBufferSize
= CompressionSection
->UncompressedLength
;
724 DstBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize
));
725 if (DstBuffer
== NULL
) {
726 return EFI_OUT_OF_RESOURCES
;
729 // stream is not actually compressed, just encapsulated. So just copy it.
731 CopyMem (DstBuffer
, CompressionSection
+ 1, DstBufferSize
);
736 // Don't support other unknown compression type.
739 return EFI_NOT_FOUND
;
742 *OutputSize
= DstBufferSize
;
743 *OutputBuffer
= DstBuffer
;