Remove autogen.h from all dxs files, because autogen.h file has been included by...
[mirror_edk2.git] / EdkModulePkg / Core / DxeIplPeim / DxeLoad.c
1 /*++
2
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 DxeLoad.c
15
16 Abstract:
17
18 Last PEIM.
19 Responsibility of this module is to load the DXE Core from a Firmware Volume.
20
21 --*/
22
23 #include "DxeIpl.h"
24
25 BOOLEAN gInMemory = FALSE;
26
27 //
28 // Module Globals used in the DXE to PEI handoff
29 // These must be module globals, so the stack can be switched
30 //
31 static EFI_DXE_IPL_PPI mDxeIplPpi = {
32 DxeLoadCore
33 };
34
35 static EFI_PEI_FV_FILE_LOADER_PPI mLoadFilePpi = {
36 DxeIplLoadFile
37 };
38
39 static EFI_PEI_PPI_DESCRIPTOR mPpiList[] = {
40 {
41 EFI_PEI_PPI_DESCRIPTOR_PPI,
42 &gEfiPeiFvFileLoaderPpiGuid,
43 &mLoadFilePpi
44 },
45 {
46 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
47 &gEfiDxeIplPpiGuid,
48 &mDxeIplPpi
49 }
50 };
51
52 static EFI_PEI_PPI_DESCRIPTOR mPpiSignal = {
53 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
54 &gEfiEndOfPeiSignalPpiGuid,
55 NULL
56 };
57
58 GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY gEfiDecompress = {
59 UefiDecompressGetInfo,
60 UefiDecompress
61 };
62
63 GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY gTianoDecompress = {
64 TianoDecompressGetInfo,
65 TianoDecompress
66 };
67
68 GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY gCustomDecompress = {
69 CustomDecompressGetInfo,
70 CustomDecompress
71 };
72
73 EFI_STATUS
74 EFIAPI
75 PeimInitializeDxeIpl (
76 IN EFI_FFS_FILE_HEADER *FfsHeader,
77 IN EFI_PEI_SERVICES **PeiServices
78 )
79 /*++
80
81 Routine Description:
82
83 Initializes the Dxe Ipl PPI
84
85 Arguments:
86
87 FfsHeader - Pointer to FFS file header
88 PeiServices - General purpose services available to every PEIM.
89
90 Returns:
91
92 EFI_SUCCESS
93
94 --*/
95 {
96 EFI_STATUS Status;
97 EFI_PEI_PE_COFF_LOADER_PROTOCOL *PeiEfiPeiPeCoffLoader;
98 EFI_BOOT_MODE BootMode;
99
100 Status = PeiServicesGetBootMode (&BootMode);
101 ASSERT_EFI_ERROR (Status);
102
103 if (!gInMemory && (BootMode != BOOT_ON_S3_RESUME)) {
104 //
105 // The DxeIpl has not yet been shadowed
106 //
107 PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();
108
109 //
110 // Shadow DxeIpl and then re-run its entry point
111 //
112 Status = ShadowDxeIpl (FfsHeader, PeiEfiPeiPeCoffLoader);
113 } else {
114 //
115 // Install FvFileLoader and DxeIpl PPIs.
116 //
117 Status = PeiServicesInstallPpi (mPpiList);
118 ASSERT_EFI_ERROR(Status);
119 }
120
121 return Status;
122 }
123
124 EFI_STATUS
125 EFIAPI
126 DxeLoadCore (
127 IN EFI_DXE_IPL_PPI *This,
128 IN EFI_PEI_SERVICES **PeiServices,
129 IN EFI_PEI_HOB_POINTERS HobList
130 )
131 /*++
132
133 Routine Description:
134
135 Main entry point to last PEIM
136
137 Arguments:
138 This - Entry point for DXE IPL PPI
139 PeiServices - General purpose services available to every PEIM.
140 HobList - Address to the Pei HOB list
141
142 Returns:
143
144 EFI_SUCCESS - DEX core was successfully loaded.
145 EFI_OUT_OF_RESOURCES - There are not enough resources to load DXE core.
146
147 --*/
148 {
149 EFI_STATUS Status;
150 EFI_GUID DxeCoreFileName;
151 EFI_GUID FirmwareFileName;
152 VOID *Pe32Data;
153 VOID *FvImageData;
154 EFI_PHYSICAL_ADDRESS DxeCoreAddress;
155 UINT64 DxeCoreSize;
156 EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint;
157 EFI_PEI_PE_COFF_LOADER_PROTOCOL *PeiEfiPeiPeCoffLoader;
158 EFI_BOOT_MODE BootMode;
159 EFI_PEI_RECOVERY_MODULE_PPI *PeiRecovery;
160 EFI_PEI_S3_RESUME_PPI *S3Resume;
161
162 // PERF_START (PeiServices, L"DxeIpl", NULL, 0);
163
164 //
165 // if in S3 Resume, restore configure
166 //
167 Status = PeiServicesGetBootMode (&BootMode);
168 ASSERT_EFI_ERROR(Status);
169
170 if (BootMode == BOOT_ON_S3_RESUME) {
171 Status = PeiServicesLocatePpi (
172 &gEfiPeiS3ResumePpiGuid,
173 0,
174 NULL,
175 (VOID **)&S3Resume
176 );
177 ASSERT_EFI_ERROR (Status);
178
179 Status = S3Resume->S3RestoreConfig (PeiServices);
180 ASSERT_EFI_ERROR (Status);
181 } else if (BootMode == BOOT_IN_RECOVERY_MODE) {
182
183 Status = PeiServicesLocatePpi (
184 &gEfiPeiRecoveryModulePpiGuid,
185 0,
186 NULL,
187 (VOID **)&PeiRecovery
188 );
189 ASSERT_EFI_ERROR (Status);
190
191 Status = PeiRecovery->LoadRecoveryCapsule (PeiServices, PeiRecovery);
192 if (EFI_ERROR (Status)) {
193 DEBUG ((EFI_D_ERROR, "Load Recovery Capsule Failed.(Status = %r)\n", Status));
194 CpuDeadLoop ();
195 }
196
197 //
198 // Now should have a HOB with the DXE core w/ the old HOB destroyed
199 //
200 }
201
202 //
203 // Install the PEI Protocols that are shared between PEI and DXE
204 //
205 PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();
206 ASSERT (PeiEfiPeiPeCoffLoader != NULL);
207
208
209 //
210 // Find the EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE type compressed Firmware Volume file
211 // The file found will be processed by PeiProcessFile: It will first be decompressed to
212 // a normal FV, then a corresponding FV type hob will be built.
213 //
214 Status = PeiFindFile (
215 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,
216 EFI_SECTION_FIRMWARE_VOLUME_IMAGE,
217 &FirmwareFileName,
218 &FvImageData
219 );
220
221 //
222 // Find the DXE Core in a Firmware Volume
223 //
224 Status = PeiFindFile (
225 EFI_FV_FILETYPE_DXE_CORE,
226 EFI_SECTION_PE32,
227 &DxeCoreFileName,
228 &Pe32Data
229 );
230 ASSERT_EFI_ERROR (Status);
231
232 //
233 // Load the DXE Core from a Firmware Volume
234 //
235 Status = PeiLoadFile (
236 PeiEfiPeiPeCoffLoader,
237 Pe32Data,
238 &DxeCoreAddress,
239 &DxeCoreSize,
240 &DxeCoreEntryPoint
241 );
242 ASSERT_EFI_ERROR (Status);
243
244 //
245 // Add HOB for the DXE Core
246 //
247 BuildModuleHob (
248 &DxeCoreFileName,
249 DxeCoreAddress,
250 DxeCoreSize,
251 DxeCoreEntryPoint
252 );
253
254 //
255 // Report Status Code EFI_SW_PEI_PC_HANDOFF_TO_NEXT
256 //
257 REPORT_STATUS_CODE (
258 EFI_PROGRESS_CODE,
259 EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT
260 );
261
262 if (FeaturePcdGet (PcdDxeIplBuildShareCodeHobs)) {
263 if (FeaturePcdGet (PcdDxeIplSupportEfiDecompress)) {
264 //
265 // Add HOB for the EFI Decompress Protocol
266 //
267 BuildGuidDataHob (
268 &gEfiDecompressProtocolGuid,
269 (VOID *)&gEfiDecompress,
270 sizeof (gEfiDecompress)
271 );
272 }
273 if (FeaturePcdGet (PcdDxeIplSupportTianoDecompress)) {
274 //
275 // Add HOB for the Tiano Decompress Protocol
276 //
277 BuildGuidDataHob (
278 &gEfiTianoDecompressProtocolGuid,
279 (VOID *)&gTianoDecompress,
280 sizeof (gTianoDecompress)
281 );
282 }
283 if (FeaturePcdGet (PcdDxeIplSupportCustomDecompress)) {
284 //
285 // Add HOB for the user customized Decompress Protocol
286 //
287 BuildGuidDataHob (
288 &gEfiCustomizedDecompressProtocolGuid,
289 (VOID *)&gCustomDecompress,
290 sizeof (gCustomDecompress)
291 );
292 }
293
294 //
295 // Add HOB for the PE/COFF Loader Protocol
296 //
297 BuildGuidDataHob (
298 &gEfiPeiPeCoffLoaderGuid,
299 (VOID *)&PeiEfiPeiPeCoffLoader,
300 sizeof (VOID *)
301 );
302 }
303
304 //
305 // Transfer control to the DXE Core
306 // The handoff state is simply a pointer to the HOB list
307 //
308
309 DEBUG ((EFI_D_INFO, "DXE Core Entry Point 0x%08x\n", (UINTN) DxeCoreEntryPoint));
310 HandOffToDxeCore (DxeCoreEntryPoint, HobList, &mPpiSignal);
311 //
312 // If we get here, then the DXE Core returned. This is an error
313 // Dxe Core should not return.
314 //
315 ASSERT (FALSE);
316 CpuDeadLoop ();
317
318 return EFI_OUT_OF_RESOURCES;
319 }
320
321 EFI_STATUS
322 PeiFindFile (
323 IN UINT8 Type,
324 IN UINT16 SectionType,
325 OUT EFI_GUID *FileName,
326 OUT VOID **Pe32Data
327 )
328 /*++
329
330 Routine Description:
331
332 Finds a PE/COFF of a specific Type and SectionType in the Firmware Volumes
333 described in the HOB list. Able to search in a compression set in a FFS file.
334 But only one level of compression is supported, that is, not able to search
335 in a compression set that is within another compression set.
336
337 Arguments:
338
339 Type - The Type of file to retrieve
340
341 SectionType - The type of section to retrieve from a file
342
343 FileName - The name of the file found in the Firmware Volume
344
345 Pe32Data - Pointer to the beginning of the PE/COFF file found in the Firmware Volume
346
347 Returns:
348
349 EFI_SUCCESS - The file was found, and the name is returned in FileName, and a pointer to
350 the PE/COFF image is returned in Pe32Data
351
352 EFI_NOT_FOUND - The file was not found in the Firmware Volumes present in the HOB List
353
354 --*/
355 {
356 EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
357 EFI_FFS_FILE_HEADER *FfsFileHeader;
358 EFI_STATUS Status;
359 EFI_PEI_HOB_POINTERS Hob;
360
361
362 FwVolHeader = NULL;
363 FfsFileHeader = NULL;
364 Status = EFI_SUCCESS;
365
366 //
367 // For each Firmware Volume, look for a specified type
368 // of file and break out until no one is found
369 //
370 Hob.Raw = GetHobList ();
371 while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_FV, Hob.Raw)) != NULL) {
372 FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) (Hob.FirmwareVolume->BaseAddress);
373 //
374 // Make sure the FV HOB does not get corrupted.
375 //
376 ASSERT (FwVolHeader->Signature == EFI_FVH_SIGNATURE);
377
378 Status = PeiServicesFfsFindNextFile (
379 Type,
380 FwVolHeader,
381 &FfsFileHeader
382 );
383 if (!EFI_ERROR (Status)) {
384 Status = PeiProcessFile (
385 SectionType,
386 FfsFileHeader,
387 Pe32Data,
388 &Hob
389 );
390 CopyMem (FileName, &FfsFileHeader->Name, sizeof (EFI_GUID));
391 //
392 // Find all Fv type ffs to get all FvImage and add them into FvHob
393 //
394 if (!EFI_ERROR (Status) && (Type != EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) {
395 return EFI_SUCCESS;
396 }
397 }
398 Hob.Raw = GET_NEXT_HOB (Hob);
399 }
400 return EFI_NOT_FOUND;
401 }
402
403 EFI_STATUS
404 PeiLoadFile (
405 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *PeiEfiPeiPeCoffLoader,
406 IN VOID *Pe32Data,
407 OUT EFI_PHYSICAL_ADDRESS *ImageAddress,
408 OUT UINT64 *ImageSize,
409 OUT EFI_PHYSICAL_ADDRESS *EntryPoint
410 )
411 /*++
412
413 Routine Description:
414
415 Loads and relocates a PE/COFF image into memory.
416
417 Arguments:
418
419 PeiEfiPeiPeCoffLoader - Pointer to a PE COFF loader protocol
420
421 Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated
422
423 ImageAddress - The base address of the relocated PE/COFF image
424
425 ImageSize - The size of the relocated PE/COFF image
426
427 EntryPoint - The entry point of the relocated PE/COFF image
428
429 Returns:
430
431 EFI_SUCCESS - The file was loaded and relocated
432
433 EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file
434
435 --*/
436 {
437 EFI_STATUS Status;
438 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;
439
440 ZeroMem (&ImageContext, sizeof (ImageContext));
441 ImageContext.Handle = Pe32Data;
442 Status = GetImageReadFunction (&ImageContext);
443
444 ASSERT_EFI_ERROR (Status);
445
446 Status = PeiEfiPeiPeCoffLoader->GetImageInfo (PeiEfiPeiPeCoffLoader, &ImageContext);
447 if (EFI_ERROR (Status)) {
448 return Status;
449 }
450 //
451 // Allocate Memory for the image
452 //
453 ImageContext.ImageAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) AllocatePages (EFI_SIZE_TO_PAGES ((UINT32) ImageContext.ImageSize));
454 ASSERT (ImageContext.ImageAddress != 0);
455
456 //
457 // Load the image to our new buffer
458 //
459 Status = PeiEfiPeiPeCoffLoader->LoadImage (PeiEfiPeiPeCoffLoader, &ImageContext);
460 if (EFI_ERROR (Status)) {
461 return Status;
462 }
463 //
464 // Relocate the image in our new buffer
465 //
466 Status = PeiEfiPeiPeCoffLoader->RelocateImage (PeiEfiPeiPeCoffLoader, &ImageContext);
467 if (EFI_ERROR (Status)) {
468 return Status;
469 }
470
471 //
472 // Flush the instruction cache so the image data is written before we execute it
473 //
474 InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);
475
476 *ImageAddress = ImageContext.ImageAddress;
477 *ImageSize = ImageContext.ImageSize;
478 *EntryPoint = ImageContext.EntryPoint;
479
480 return EFI_SUCCESS;
481 }
482
483 EFI_STATUS
484 ShadowDxeIpl (
485 IN EFI_FFS_FILE_HEADER *DxeIplFileHeader,
486 IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *PeiEfiPeiPeCoffLoader
487 )
488 /*++
489
490 Routine Description:
491
492 Shadow the DXE IPL to a different memory location. This occurs after permanent
493 memory has been discovered.
494
495 Arguments:
496
497 DxeIplFileHeader - Pointer to the FFS file header of the DXE IPL driver
498
499 PeiEfiPeiPeCoffLoader - Pointer to a PE COFF loader protocol
500
501 Returns:
502
503 EFI_SUCCESS - DXE IPL was successfully shadowed to a different memory location.
504
505 EFI_ ERROR - The shadow was unsuccessful.
506
507
508 --*/
509 {
510 UINTN SectionLength;
511 UINTN OccupiedSectionLength;
512 EFI_PHYSICAL_ADDRESS DxeIplAddress;
513 UINT64 DxeIplSize;
514 EFI_PHYSICAL_ADDRESS DxeIplEntryPoint;
515 EFI_STATUS Status;
516 EFI_COMMON_SECTION_HEADER *Section;
517
518 Section = (EFI_COMMON_SECTION_HEADER *) (DxeIplFileHeader + 1);
519
520 while ((Section->Type != EFI_SECTION_PE32) && (Section->Type != EFI_SECTION_TE)) {
521 SectionLength = *(UINT32 *) (Section->Size) & 0x00ffffff;
522 OccupiedSectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);
523 Section = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + OccupiedSectionLength);
524 }
525 //
526 // Relocate DxeIpl into memory by using loadfile service
527 //
528 Status = PeiLoadFile (
529 PeiEfiPeiPeCoffLoader,
530 (VOID *) (Section + 1),
531 &DxeIplAddress,
532 &DxeIplSize,
533 &DxeIplEntryPoint
534 );
535
536 if (Status == EFI_SUCCESS) {
537 //
538 // Set gInMemory global variable to TRUE to indicate the dxeipl is shadowed.
539 //
540 *(BOOLEAN *) ((UINTN) &gInMemory + (UINTN) DxeIplEntryPoint - (UINTN) _ModuleEntryPoint) = TRUE;
541 Status = ((EFI_PEIM_ENTRY_POINT) (UINTN) DxeIplEntryPoint) (DxeIplFileHeader, GetPeiServicesTablePointer());
542 }
543
544 return Status;
545 }
546
547 EFI_STATUS
548 EFIAPI
549 DxeIplLoadFile (
550 IN EFI_PEI_FV_FILE_LOADER_PPI *This,
551 IN EFI_FFS_FILE_HEADER *FfsHeader,
552 OUT EFI_PHYSICAL_ADDRESS *ImageAddress,
553 OUT UINT64 *ImageSize,
554 OUT EFI_PHYSICAL_ADDRESS *EntryPoint
555 )
556 /*++
557
558 Routine Description:
559
560 Given a pointer to an FFS file containing a PE32 image, get the
561 information on the PE32 image, and then "load" it so that it
562 can be executed.
563
564 Arguments:
565
566 This - pointer to our file loader protocol
567
568 FfsHeader - pointer to the FFS file header of the FFS file that
569 contains the PE32 image we want to load
570
571 ImageAddress - returned address where the PE32 image is loaded
572
573 ImageSize - returned size of the loaded PE32 image
574
575 EntryPoint - entry point to the loaded PE32 image
576
577 Returns:
578
579 EFI_SUCCESS - The FFS file was successfully loaded.
580
581 EFI_ERROR - Unable to load the FFS file.
582
583 --*/
584 {
585 EFI_PEI_PE_COFF_LOADER_PROTOCOL *PeiEfiPeiPeCoffLoader;
586 EFI_STATUS Status;
587 VOID *Pe32Data;
588
589 Pe32Data = NULL;
590 PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();
591
592 //
593 // Preprocess the FFS file to get a pointer to the PE32 information
594 // in the enclosed PE32 image.
595 //
596 Status = PeiProcessFile (
597 EFI_SECTION_PE32,
598 FfsHeader,
599 &Pe32Data,
600 NULL
601 );
602
603 if (EFI_ERROR (Status)) {
604 return Status;
605 }
606 //
607 // Load the PE image from the FFS file
608 //
609 Status = PeiLoadFile (
610 PeiEfiPeiPeCoffLoader,
611 Pe32Data,
612 ImageAddress,
613 ImageSize,
614 EntryPoint
615 );
616
617 return Status;
618 }
619
620 EFI_STATUS
621 PeiProcessFile (
622 IN UINT16 SectionType,
623 IN EFI_FFS_FILE_HEADER *FfsFileHeader,
624 OUT VOID **Pe32Data,
625 IN EFI_PEI_HOB_POINTERS *OrigHob
626 )
627 /*++
628
629 Routine Description:
630
631 Arguments:
632
633 SectionType - The type of section in the FFS file to process.
634
635 FfsFileHeader - Pointer to the FFS file to process, looking for the
636 specified SectionType
637
638 Pe32Data - returned pointer to the start of the PE32 image found
639 in the FFS file.
640
641 Returns:
642
643 EFI_SUCCESS - found the PE32 section in the FFS file
644
645 --*/
646 {
647 EFI_STATUS Status;
648 VOID *SectionData;
649 DECOMPRESS_LIBRARY *DecompressLibrary;
650 UINT8 *DstBuffer;
651 UINT8 *ScratchBuffer;
652 UINT32 DstBufferSize;
653 UINT32 ScratchBufferSize;
654 EFI_COMMON_SECTION_HEADER *CmpSection;
655 UINTN CmpSectionLength;
656 UINTN OccupiedCmpSectionLength;
657 VOID *CmpFileData;
658 UINTN CmpFileSize;
659 EFI_COMMON_SECTION_HEADER *Section;
660 UINTN SectionLength;
661 UINTN OccupiedSectionLength;
662 UINT64 FileSize;
663 UINT32 AuthenticationStatus;
664 EFI_PEI_SECTION_EXTRACTION_PPI *SectionExtract;
665 UINT32 BufferSize;
666 UINT8 *Buffer;
667 EFI_PEI_SECURITY_PPI *Security;
668 BOOLEAN StartCrisisRecovery;
669 EFI_GUID TempGuid;
670 EFI_FIRMWARE_VOLUME_HEADER *FvHeader;
671 EFI_COMPRESSION_SECTION *CompressionSection;
672
673 //
674 // Initialize local variables.
675 //
676 DecompressLibrary = NULL;
677 DstBuffer = NULL;
678 DstBufferSize = 0;
679
680 Status = PeiServicesFfsFindSectionData (
681 EFI_SECTION_COMPRESSION,
682 FfsFileHeader,
683 &SectionData
684 );
685
686 //
687 // First process the compression section
688 //
689 if (!EFI_ERROR (Status)) {
690 //
691 // Yes, there is a compression section, so extract the contents
692 // Decompress the image here
693 //
694 Section = (EFI_COMMON_SECTION_HEADER *) (UINTN) (VOID *) ((UINT8 *) (FfsFileHeader) + (UINTN) sizeof (EFI_FFS_FILE_HEADER));
695
696 do {
697 SectionLength = *(UINT32 *) (Section->Size) & 0x00ffffff;
698 OccupiedSectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);
699
700 //
701 // Was the DXE Core file encapsulated in a GUID'd section?
702 //
703 if (Section->Type == EFI_SECTION_GUID_DEFINED) {
704
705 //
706 // This following code constitutes the addition of the security model
707 // to the DXE IPL.
708 //
709 //
710 // Set a default authenticatino state
711 //
712 AuthenticationStatus = 0;
713
714 Status = PeiServicesLocatePpi (
715 &gEfiPeiSectionExtractionPpiGuid,
716 0,
717 NULL,
718 (VOID **)&SectionExtract
719 );
720
721 if (EFI_ERROR (Status)) {
722 return Status;
723 }
724 //
725 // Verify Authentication State
726 //
727 CopyMem (&TempGuid, Section + 1, sizeof (EFI_GUID));
728
729 Status = SectionExtract->PeiGetSection (
730 GetPeiServicesTablePointer(),
731 SectionExtract,
732 (EFI_SECTION_TYPE *) &SectionType,
733 &TempGuid,
734 0,
735 (VOID **) &Buffer,
736 &BufferSize,
737 &AuthenticationStatus
738 );
739
740 if (EFI_ERROR (Status)) {
741 return Status;
742 }
743 //
744 // If not ask the Security PPI, if exists, for disposition
745 //
746 //
747 Status = PeiServicesLocatePpi (
748 &gEfiPeiSecurityPpiGuid,
749 0,
750 NULL,
751 (VOID **)&Security
752 );
753 if (EFI_ERROR (Status)) {
754 return Status;
755 }
756
757 Status = Security->AuthenticationState (
758 GetPeiServicesTablePointer(),
759 (struct _EFI_PEI_SECURITY_PPI *) Security,
760 AuthenticationStatus,
761 FfsFileHeader,
762 &StartCrisisRecovery
763 );
764
765 if (EFI_ERROR (Status)) {
766 return Status;
767 }
768 //
769 // If there is a security violation, report to caller and have
770 // the upper-level logic possible engender a crisis recovery
771 //
772 if (StartCrisisRecovery) {
773 return EFI_SECURITY_VIOLATION;
774 }
775 }
776
777 if (Section->Type == EFI_SECTION_PE32) {
778 //
779 // This is what we want
780 //
781 *Pe32Data = (VOID *) (Section + 1);
782 return EFI_SUCCESS;
783 } else if (Section->Type == EFI_SECTION_COMPRESSION) {
784 //
785 // This is a compression set, expand it
786 //
787 CompressionSection = (EFI_COMPRESSION_SECTION *) Section;
788
789 switch (CompressionSection->CompressionType) {
790 case EFI_STANDARD_COMPRESSION:
791 //
792 // Load EFI standard compression.
793 //
794 if (FeaturePcdGet (PcdDxeIplSupportTianoDecompress)) {
795 DecompressLibrary = &gEfiDecompress;
796 } else {
797 ASSERT (FALSE);
798 return EFI_NOT_FOUND;
799 }
800 break;
801
802 case EFI_CUSTOMIZED_COMPRESSION:
803 //
804 // Load user customized compression.
805 //
806 if (FeaturePcdGet (PcdDxeIplSupportCustomDecompress)) {
807 DecompressLibrary = &gCustomDecompress;
808 } else {
809 ASSERT (FALSE);
810 return EFI_NOT_FOUND;
811 }
812 break;
813
814 case EFI_NOT_COMPRESSED:
815 //
816 // Allocate destination buffer
817 //
818 DstBufferSize = CompressionSection->UncompressedLength;
819 DstBuffer = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));
820 if (DstBuffer == NULL) {
821 return EFI_OUT_OF_RESOURCES;
822 }
823 //
824 // stream is not actually compressed, just encapsulated. So just copy it.
825 //
826 CopyMem (DstBuffer, CompressionSection + 1, DstBufferSize);
827 break;
828
829 default:
830 //
831 // Don't support other unknown compression type.
832 //
833 ASSERT_EFI_ERROR (Status);
834 return EFI_NOT_FOUND;
835 }
836
837 if (CompressionSection->CompressionType != EFI_NOT_COMPRESSED) {
838 //
839 // For compressed data, decompress them to dstbuffer.
840 //
841 Status = DecompressLibrary->GetInfo (
842 (UINT8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),
843 (UINT32) SectionLength - sizeof (EFI_COMPRESSION_SECTION),
844 &DstBufferSize,
845 &ScratchBufferSize
846 );
847 if (EFI_ERROR (Status)) {
848 //
849 // GetInfo failed
850 //
851 DEBUG ((EFI_D_ERROR, "Decompress GetInfo Failed - %r\n", Status));
852 return EFI_NOT_FOUND;
853 }
854
855 //
856 // Allocate scratch buffer
857 //
858 ScratchBuffer = AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize));
859 if (ScratchBuffer == NULL) {
860 return EFI_OUT_OF_RESOURCES;
861 }
862
863 //
864 // Allocate destination buffer
865 //
866 DstBuffer = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));
867 if (DstBuffer == NULL) {
868 return EFI_OUT_OF_RESOURCES;
869 }
870
871 //
872 // Call decompress function
873 //
874 Status = DecompressLibrary->Decompress (
875 (CHAR8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),
876 DstBuffer,
877 ScratchBuffer
878 );
879 if (EFI_ERROR (Status)) {
880 //
881 // Decompress failed
882 //
883 DEBUG ((EFI_D_ERROR, "Decompress Failed - %r\n", Status));
884 return EFI_NOT_FOUND;
885 }
886 }
887
888 //
889 // Decompress successfully.
890 // Loop the decompressed data searching for expected section.
891 //
892 CmpSection = (EFI_COMMON_SECTION_HEADER *) DstBuffer;
893 CmpFileData = (VOID *) DstBuffer;
894 CmpFileSize = DstBufferSize;
895 do {
896 CmpSectionLength = *(UINT32 *) (CmpSection->Size) & 0x00ffffff;
897 if (CmpSection->Type == SectionType) {
898 //
899 // This is what we want
900 //
901 if (SectionType == EFI_SECTION_PE32) {
902 *Pe32Data = (VOID *) (CmpSection + 1);
903 return EFI_SUCCESS;
904 } else if (SectionType == EFI_SECTION_FIRMWARE_VOLUME_IMAGE) {
905 //
906 // Firmware Volume Image in this Section
907 // Skip the section header to get FvHeader
908 //
909 FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (CmpSection + 1);
910
911 if (FvHeader->Signature == EFI_FVH_SIGNATURE) {
912 //
913 // Because FvLength in FvHeader is UINT64 type,
914 // so FvHeader must meed at least 8 bytes alignment.
915 // If current FvImage base address doesn't meet its alignment,
916 // we need to reload this FvImage to another correct memory address.
917 //
918 if (((UINTN) FvHeader % sizeof (UINT64)) != 0) {
919 DstBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINTN) CmpSectionLength - sizeof (EFI_COMMON_SECTION_HEADER)), sizeof (UINT64));
920 if (DstBuffer == NULL) {
921 return EFI_OUT_OF_RESOURCES;
922 }
923 CopyMem (DstBuffer, FvHeader, (UINTN) CmpSectionLength - sizeof (EFI_COMMON_SECTION_HEADER));
924 FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) DstBuffer;
925 }
926
927 //
928 // Build new FvHob for new decompressed Fv image.
929 //
930 BuildFvHob ((EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader, FvHeader->FvLength);
931
932 //
933 // Set the original FvHob to unused.
934 //
935 if (OrigHob != NULL) {
936 OrigHob->Header->HobType = EFI_HOB_TYPE_UNUSED;
937 }
938
939 //
940 // return found FvImage data.
941 //
942 *Pe32Data = (VOID *) FvHeader;
943 return EFI_SUCCESS;
944 }
945 }
946 }
947 OccupiedCmpSectionLength = GET_OCCUPIED_SIZE (CmpSectionLength, 4);
948 CmpSection = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) CmpSection + OccupiedCmpSectionLength);
949 } while (CmpSection->Type != 0 && (UINTN) ((UINT8 *) CmpSection - (UINT8 *) CmpFileData) < CmpFileSize);
950 }
951 //
952 // End of the decompression activity
953 //
954
955 Section = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + OccupiedSectionLength);
956 FileSize = FfsFileHeader->Size[0] & 0xFF;
957 FileSize += (FfsFileHeader->Size[1] << 8) & 0xFF00;
958 FileSize += (FfsFileHeader->Size[2] << 16) & 0xFF0000;
959 FileSize &= 0x00FFFFFF;
960 } while (Section->Type != 0 && (UINTN) ((UINT8 *) Section - (UINT8 *) FfsFileHeader) < FileSize);
961
962 //
963 // search all sections (compression and non compression) in this FFS, don't
964 // find expected section.
965 //
966 return EFI_NOT_FOUND;
967 } else {
968 //
969 // For those FFS that doesn't contain compression section, directly search
970 // PE or TE section in this FFS.
971 //
972
973 Status = PeiServicesFfsFindSectionData (
974 EFI_SECTION_PE32,
975 FfsFileHeader,
976 &SectionData
977 );
978
979 if (EFI_ERROR (Status)) {
980 Status = PeiServicesFfsFindSectionData (
981 EFI_SECTION_TE,
982 FfsFileHeader,
983 &SectionData
984 );
985 if (EFI_ERROR (Status)) {
986 return Status;
987 }
988 }
989 }
990
991 *Pe32Data = SectionData;
992
993 return EFI_SUCCESS;
994 }
995