2 Capsule update PEIM for UEFI2.0
4 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions
8 of the BSD License which accompanies this distribution. The
9 full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 // Global Descriptor Table (GDT)
23 GLOBAL_REMOVE_IF_UNREFERENCED IA32_SEGMENT_DESCRIPTOR mGdtEntries
[] = {
24 /* selector { Global Segment Descriptor } */
25 /* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //null descriptor
26 /* 0x08 */ {{0xffff, 0, 0, 0x3, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //linear data segment descriptor
27 /* 0x10 */ {{0xffff, 0, 0, 0xf, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //linear code segment descriptor
28 /* 0x18 */ {{0xffff, 0, 0, 0x3, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system data segment descriptor
29 /* 0x20 */ {{0xffff, 0, 0, 0xb, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system code segment descriptor
30 /* 0x28 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //spare segment descriptor
31 /* 0x30 */ {{0xffff, 0, 0, 0x3, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system data segment descriptor
32 /* 0x38 */ {{0xffff, 0, 0, 0xb, 1, 0, 1, 0xf, 0, 1, 0, 1, 0}}, //system code segment descriptor
33 /* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //spare segment descriptor
39 GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt
= {
40 sizeof (mGdtEntries
) - 1,
45 Calculate the total size of page table.
47 @return The size of page table.
52 CalculatePageTableSize (
59 UINT8 PhysicalAddressBits
;
61 UINT32 NumberOfPml4EntriesNeeded
;
62 UINT32 NumberOfPdpEntriesNeeded
;
63 BOOLEAN Page1GSupport
;
65 Page1GSupport
= FALSE
;
66 if (PcdGetBool(PcdUse1GPageTable
)) {
67 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
68 if (RegEax
>= 0x80000001) {
69 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
70 if ((RegEdx
& BIT26
) != 0) {
77 // Get physical address bits supported.
79 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
81 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
83 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
84 if (RegEax
>= 0x80000008) {
85 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
86 PhysicalAddressBits
= (UINT8
) RegEax
;
88 PhysicalAddressBits
= 36;
93 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
95 ASSERT (PhysicalAddressBits
<= 52);
96 if (PhysicalAddressBits
> 48) {
97 PhysicalAddressBits
= 48;
101 // Calculate the table entries needed.
103 if (PhysicalAddressBits
<= 39 ) {
104 NumberOfPml4EntriesNeeded
= 1;
105 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
107 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
108 NumberOfPdpEntriesNeeded
= 512;
111 if (!Page1GSupport
) {
112 TotalPagesNum
= (NumberOfPdpEntriesNeeded
+ 1) * NumberOfPml4EntriesNeeded
+ 1;
114 TotalPagesNum
= NumberOfPml4EntriesNeeded
+ 1;
117 return EFI_PAGES_TO_SIZE (TotalPagesNum
);
121 Allocates and fills in the Page Directory and Page Table Entries to
122 establish a 1:1 Virtual to Physical mapping.
124 @param[in] PageTablesAddress The base address of page table.
128 CreateIdentityMappingPageTables (
129 IN EFI_PHYSICAL_ADDRESS PageTablesAddress
134 UINT8 PhysicalAddressBits
;
135 EFI_PHYSICAL_ADDRESS PageAddress
;
136 UINTN IndexOfPml4Entries
;
137 UINTN IndexOfPdpEntries
;
138 UINTN IndexOfPageDirectoryEntries
;
139 UINT32 NumberOfPml4EntriesNeeded
;
140 UINT32 NumberOfPdpEntriesNeeded
;
141 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
142 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
143 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
144 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
145 UINTN BigPageAddress
;
147 BOOLEAN Page1GSupport
;
148 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
150 Page1GSupport
= FALSE
;
151 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
152 if (RegEax
>= 0x80000001) {
153 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
154 if ((RegEdx
& BIT26
) != 0) {
155 Page1GSupport
= TRUE
;
160 // Get physical address bits supported.
162 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
164 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
166 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
167 if (RegEax
>= 0x80000008) {
168 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
169 PhysicalAddressBits
= (UINT8
) RegEax
;
171 PhysicalAddressBits
= 36;
176 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
178 ASSERT (PhysicalAddressBits
<= 52);
179 if (PhysicalAddressBits
> 48) {
180 PhysicalAddressBits
= 48;
184 // Calculate the table entries needed.
186 if (PhysicalAddressBits
<= 39 ) {
187 NumberOfPml4EntriesNeeded
= 1;
188 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
190 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
191 NumberOfPdpEntriesNeeded
= 512;
195 // Pre-allocate big pages to avoid later allocations.
197 BigPageAddress
= (UINTN
) PageTablesAddress
;
200 // By architecture only one PageMapLevel4 exists - so lets allocate storage for it.
202 PageMap
= (VOID
*) BigPageAddress
;
203 BigPageAddress
+= SIZE_4KB
;
205 PageMapLevel4Entry
= PageMap
;
207 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
209 // Each PML4 entry points to a page of Page Directory Pointer entires.
210 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
212 PageDirectoryPointerEntry
= (VOID
*) BigPageAddress
;
213 BigPageAddress
+= SIZE_4KB
;
218 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
;
219 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
220 PageMapLevel4Entry
->Bits
.Present
= 1;
223 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
225 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
227 // Fill in the Page Directory entries
229 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
;
230 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
231 PageDirectory1GEntry
->Bits
.Present
= 1;
232 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
235 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
237 // Each Directory Pointer entries points to a page of Page Directory entires.
238 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
240 PageDirectoryEntry
= (VOID
*) BigPageAddress
;
241 BigPageAddress
+= SIZE_4KB
;
244 // Fill in a Page Directory Pointer Entries
246 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
;
247 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
248 PageDirectoryPointerEntry
->Bits
.Present
= 1;
250 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
252 // Fill in the Page Directory entries
254 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
;
255 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
256 PageDirectoryEntry
->Bits
.Present
= 1;
257 PageDirectoryEntry
->Bits
.MustBe1
= 1;
261 for (; IndexOfPdpEntries
< 512; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
263 PageDirectoryPointerEntry
,
264 sizeof(PAGE_MAP_AND_DIRECTORY_POINTER
)
271 // For the PML4 entries we are not using fill in a null entry.
273 for (; IndexOfPml4Entries
< 512; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
276 sizeof (PAGE_MAP_AND_DIRECTORY_POINTER
)
282 Return function from long mode to 32-bit mode.
284 @param EntrypointContext Context for mode switching
285 @param ReturnContext Context for mode switching
290 SWITCH_32_TO_64_CONTEXT
*EntrypointContext
,
291 SWITCH_64_TO_32_CONTEXT
*ReturnContext
295 // Restore original GDT
297 AsmWriteGdtr (&ReturnContext
->Gdtr
);
300 // return to original caller
302 LongJump ((BASE_LIBRARY_JUMP_BUFFER
*)(UINTN
)EntrypointContext
->JumpBuffer
, 1);
311 Thunk function from 32-bit protection mode to long mode.
313 @param PageTableAddress Page table base address
314 @param Context Context for mode switching
315 @param ReturnContext Context for mode switching
317 @retval EFI_SUCCESS Function successfully executed.
322 EFI_PHYSICAL_ADDRESS PageTableAddress
,
323 SWITCH_32_TO_64_CONTEXT
*Context
,
324 SWITCH_64_TO_32_CONTEXT
*ReturnContext
331 // Save return address, LongJump will return here then
333 SetJumpFlag
= SetJump ((BASE_LIBRARY_JUMP_BUFFER
*) (UINTN
) Context
->JumpBuffer
);
335 if (SetJumpFlag
== 0) {
338 // Build Page Tables for all physical memory processor supports
340 CreateIdentityMappingPageTables (PageTableAddress
);
345 AsmWriteGdtr (&mGdt
);
350 AsmWriteCr3 ((UINTN
) PageTableAddress
);
353 // Disable interrupt of Debug timer, since the IDT table cannot work in long mode
355 SaveAndSetDebugTimerInterrupt (FALSE
);
357 // Transfer to long mode
361 (UINT64
) Context
->EntryPoint
,
362 (UINT64
)(UINTN
) Context
,
363 (UINT64
)(UINTN
) ReturnContext
,
364 Context
->StackBufferBase
+ Context
->StackBufferLength
369 // Convert to 32-bit Status and return
371 Status
= EFI_SUCCESS
;
372 if ((UINTN
) ReturnContext
->ReturnStatus
!= 0) {
373 Status
= ENCODE_ERROR ((UINTN
) ReturnContext
->ReturnStatus
);
380 If in 32 bit protection mode, and coalesce image is of X64, switch to long mode.
382 @param LongModeBuffer The context of long mode.
383 @param CoalesceEntry Entry of coalesce image.
384 @param BlockListAddr Address of block list.
385 @param MemoryBase Base of memory range.
386 @param MemorySize Size of memory range.
388 @retval EFI_SUCCESS Successfully switched to long mode and execute coalesce.
389 @retval Others Failed to execute coalesce in long mode.
394 IN EFI_CAPSULE_LONG_MODE_BUFFER
*LongModeBuffer
,
395 IN COALESCE_ENTRY CoalesceEntry
,
396 IN EFI_PHYSICAL_ADDRESS BlockListAddr
,
397 IN OUT VOID
**MemoryBase
,
398 IN OUT UINTN
*MemorySize
402 EFI_PHYSICAL_ADDRESS MemoryBase64
;
404 EFI_PHYSICAL_ADDRESS MemoryEnd64
;
405 SWITCH_32_TO_64_CONTEXT Context
;
406 SWITCH_64_TO_32_CONTEXT ReturnContext
;
407 BASE_LIBRARY_JUMP_BUFFER JumpBuffer
;
408 EFI_PHYSICAL_ADDRESS ReservedRangeBase
;
409 EFI_PHYSICAL_ADDRESS ReservedRangeEnd
;
411 ZeroMem (&Context
, sizeof (SWITCH_32_TO_64_CONTEXT
));
412 ZeroMem (&ReturnContext
, sizeof (SWITCH_64_TO_32_CONTEXT
));
414 MemoryBase64
= (UINT64
) (UINTN
) *MemoryBase
;
415 MemorySize64
= (UINT64
) (UINTN
) *MemorySize
;
416 MemoryEnd64
= MemoryBase64
+ MemorySize64
;
419 // Merge memory range reserved for stack and page table
421 if (LongModeBuffer
->StackBaseAddress
< LongModeBuffer
->PageTableAddress
) {
422 ReservedRangeBase
= LongModeBuffer
->StackBaseAddress
;
423 ReservedRangeEnd
= LongModeBuffer
->PageTableAddress
+ CalculatePageTableSize ();
425 ReservedRangeBase
= LongModeBuffer
->PageTableAddress
;
426 ReservedRangeEnd
= LongModeBuffer
->StackBaseAddress
+ LongModeBuffer
->StackSize
;
430 // Check if memory range reserved is overlap with MemoryBase ~ MemoryBase + MemorySize.
431 // If they are overlapped, get a larger range to process capsule data.
433 if (ReservedRangeBase
<= MemoryBase64
) {
434 if (ReservedRangeEnd
< MemoryEnd64
) {
435 MemoryBase64
= ReservedRangeEnd
;
437 DEBUG ((EFI_D_ERROR
, "Memory is not enough to process capsule!\n"));
438 return EFI_OUT_OF_RESOURCES
;
440 } else if (ReservedRangeBase
< MemoryEnd64
) {
441 if (ReservedRangeEnd
< MemoryEnd64
&&
442 ReservedRangeBase
- MemoryBase64
< MemoryEnd64
- ReservedRangeEnd
) {
443 MemoryBase64
= ReservedRangeEnd
;
445 MemorySize64
= (UINT64
)(UINTN
)(ReservedRangeBase
- MemoryBase64
);
450 // Initialize context jumping to 64-bit enviroment
452 Context
.JumpBuffer
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&JumpBuffer
;
453 Context
.StackBufferBase
= LongModeBuffer
->StackBaseAddress
;
454 Context
.StackBufferLength
= LongModeBuffer
->StackSize
;
455 Context
.EntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)CoalesceEntry
;
456 Context
.BlockListAddr
= BlockListAddr
;
457 Context
.MemoryBase64Ptr
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&MemoryBase64
;
458 Context
.MemorySize64Ptr
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&MemorySize64
;
461 // Prepare data for return back
463 ReturnContext
.ReturnCs
= 0x10;
464 ReturnContext
.ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)ReturnFunction
;
466 // Will save the return status of processing capsule
468 ReturnContext
.ReturnStatus
= 0;
473 AsmReadGdtr ((IA32_DESCRIPTOR
*)&ReturnContext
.Gdtr
);
475 Status
= Thunk32To64 (LongModeBuffer
->PageTableAddress
, &Context
, &ReturnContext
);
477 if (!EFI_ERROR (Status
)) {
478 *MemoryBase
= (VOID
*) (UINTN
) MemoryBase64
;
479 *MemorySize
= (UINTN
) MemorySize64
;
487 Locates the coalesce image entry point, and detects its machine type.
489 @param CoalesceImageEntryPoint Pointer to coalesce image entry point for output.
490 @param CoalesceImageMachineType Pointer to machine type of coalesce image.
492 @retval EFI_SUCCESS Coalesce image successfully located.
493 @retval Others Failed to locate the coalesce image.
497 FindCapsuleCoalesceImage (
498 OUT EFI_PHYSICAL_ADDRESS
*CoalesceImageEntryPoint
,
499 OUT UINT16
*CoalesceImageMachineType
504 EFI_PEI_LOAD_FILE_PPI
*LoadFile
;
505 EFI_PEI_FV_HANDLE VolumeHandle
;
506 EFI_PEI_FILE_HANDLE FileHandle
;
507 EFI_PHYSICAL_ADDRESS CoalesceImageAddress
;
508 UINT64 CoalesceImageSize
;
509 UINT32 AuthenticationState
;
514 Status
= PeiServicesFfsFindNextVolume (Instance
++, &VolumeHandle
);
515 if (EFI_ERROR (Status
)) {
518 Status
= PeiServicesFfsFindFileByName (PcdGetPtr(PcdCapsuleCoalesceFile
), VolumeHandle
, &FileHandle
);
519 if (!EFI_ERROR (Status
)) {
520 Status
= PeiServicesLocatePpi (&gEfiPeiLoadFilePpiGuid
, 0, NULL
, (VOID
**) &LoadFile
);
521 ASSERT_EFI_ERROR (Status
);
523 Status
= LoadFile
->LoadFile (
526 &CoalesceImageAddress
,
528 CoalesceImageEntryPoint
,
531 if (EFI_ERROR (Status
)) {
532 DEBUG ((EFI_D_ERROR
, "Unable to find PE32 section in CapsuleRelocate image ffs %r!\n", Status
));
535 *CoalesceImageMachineType
= PeCoffLoaderGetMachineType ((VOID
*) (UINTN
) CoalesceImageAddress
);
548 Checks for the presence of capsule descriptors.
549 Get capsule descriptors from variable CapsuleUpdateData, CapsuleUpdateData1, CapsuleUpdateData2...
550 and save to DescriptorBuffer.
552 @param DescriptorBuffer Pointer to the capsule descriptors
554 @retval EFI_SUCCESS a valid capsule is present
555 @retval EFI_NOT_FOUND if a valid capsule is not present
558 GetCapsuleDescriptors (
559 IN EFI_PHYSICAL_ADDRESS
*DescriptorBuffer
568 CHAR16 CapsuleVarName
[30];
570 EFI_PHYSICAL_ADDRESS CapsuleDataPtr64
;
571 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*PPIVariableServices
;
575 CapsuleVarName
[0] = 0;
578 Status
= PeiServicesLocatePpi (
579 &gEfiPeiReadOnlyVariable2PpiGuid
,
582 (VOID
**) &PPIVariableServices
584 if (Status
== EFI_SUCCESS
) {
585 StrCpy (CapsuleVarName
, EFI_CAPSULE_VARIABLE_NAME
);
586 TempVarName
= CapsuleVarName
+ StrLen (CapsuleVarName
);
587 Size
= sizeof (CapsuleDataPtr64
);
591 // For the first Capsule Image
593 Status
= PPIVariableServices
->GetVariable (
596 &gEfiCapsuleVendorGuid
,
599 (VOID
*) &CapsuleDataPtr64
601 if (EFI_ERROR (Status
)) {
602 DEBUG ((EFI_D_ERROR
, "Capsule -- capsule variable not set\n"));
603 return EFI_NOT_FOUND
;
606 // We have a chicken/egg situation where the memory init code needs to
607 // know the boot mode prior to initializing memory. For this case, our
608 // validate function will fail. We can detect if this is the case if blocklist
609 // pointer is null. In that case, return success since we know that the
612 if (DescriptorBuffer
== NULL
) {
616 UnicodeValueToString (TempVarName
, 0, Index
, 0);
617 Status
= PPIVariableServices
->GetVariable (
620 &gEfiCapsuleVendorGuid
,
623 (VOID
*) &CapsuleDataPtr64
625 if (EFI_ERROR (Status
)) {
630 // If this BlockList has been linked before, skip this variable
633 for (TempIndex
= 0; TempIndex
< ValidIndex
; TempIndex
++) {
634 if (DescriptorBuffer
[TempIndex
] == CapsuleDataPtr64
) {
646 // Cache BlockList which has been processed
648 DescriptorBuffer
[ValidIndex
++] = CapsuleDataPtr64
;
657 Gets the reserved long mode buffer.
659 @param LongModeBuffer Pointer to the long mode buffer for output.
661 @retval EFI_SUCCESS Long mode buffer successfully retrieved.
662 @retval Others Variable storing long mode buffer not found.
667 OUT EFI_CAPSULE_LONG_MODE_BUFFER
*LongModeBuffer
672 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*PPIVariableServices
;
674 Status
= PeiServicesLocatePpi (
675 &gEfiPeiReadOnlyVariable2PpiGuid
,
678 (VOID
**) &PPIVariableServices
680 ASSERT_EFI_ERROR (Status
);
682 Size
= sizeof (EFI_CAPSULE_LONG_MODE_BUFFER
);
683 Status
= PPIVariableServices
->GetVariable (
685 EFI_CAPSULE_LONG_MODE_BUFFER_NAME
,
686 &gEfiCapsuleVendorGuid
,
691 if (EFI_ERROR (Status
)) {
692 DEBUG (( EFI_D_ERROR
, "Error Get LongModeBuffer variable %r!\n", Status
));
698 Capsule PPI service to coalesce a fragmented capsule in memory.
700 @param PeiServices General purpose services available to every PEIM.
701 @param MemoryBase Pointer to the base of a block of memory that we can walk
702 all over while trying to coalesce our buffers.
703 On output, this variable will hold the base address of
705 @param MemorySize Size of the memory region pointed to by MemoryBase.
706 On output, this variable will contain the size of the
709 @retval EFI_NOT_FOUND if we can't determine the boot mode
710 if the boot mode is not flash-update
711 if we could not find the capsule descriptors
713 @retval EFI_BUFFER_TOO_SMALL
714 if we could not coalesce the capsule in the memory
715 region provided to us
717 @retval EFI_SUCCESS if there's no capsule, or if we processed the
718 capsule successfully.
723 IN EFI_PEI_SERVICES
**PeiServices
,
724 IN OUT VOID
**MemoryBase
,
725 IN OUT UINTN
*MemorySize
731 CHAR16 CapsuleVarName
[30];
733 EFI_PHYSICAL_ADDRESS CapsuleDataPtr64
;
735 EFI_BOOT_MODE BootMode
;
736 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*PPIVariableServices
;
737 EFI_PHYSICAL_ADDRESS
*VariableArrayAddress
;
739 UINT16 CoalesceImageMachineType
;
740 EFI_PHYSICAL_ADDRESS CoalesceImageEntryPoint
;
741 COALESCE_ENTRY CoalesceEntry
;
742 EFI_CAPSULE_LONG_MODE_BUFFER LongModeBuffer
;
747 CapsuleVarName
[0] = 0;
750 // Someone should have already ascertained the boot mode. If it's not
751 // capsule update, then return normally.
753 Status
= PeiServicesGetBootMode (&BootMode
);
754 if (EFI_ERROR (Status
) || (BootMode
!= BOOT_ON_FLASH_UPDATE
)) {
755 DEBUG ((EFI_D_ERROR
, "Boot mode is not correct for capsule update path.\n"));
756 Status
= EFI_NOT_FOUND
;
761 // User may set the same ScatterGatherList with several different variables,
762 // so cache all ScatterGatherList for check later.
764 Status
= PeiServicesLocatePpi (
765 &gEfiPeiReadOnlyVariable2PpiGuid
,
768 (VOID
**) &PPIVariableServices
770 if (EFI_ERROR (Status
)) {
773 Size
= sizeof (CapsuleDataPtr64
);
774 StrCpy (CapsuleVarName
, EFI_CAPSULE_VARIABLE_NAME
);
775 TempVarName
= CapsuleVarName
+ StrLen (CapsuleVarName
);
778 UnicodeValueToString (TempVarName
, 0, Index
, 0);
780 Status
= PPIVariableServices
->GetVariable (
783 &gEfiCapsuleVendorGuid
,
786 (VOID
*) &CapsuleDataPtr64
788 if (EFI_ERROR (Status
)) {
790 // There is no capsule variables, quit
792 DEBUG ((EFI_D_INFO
,"Capsule variable Index = %d\n", Index
));
799 DEBUG ((EFI_D_INFO
,"Capsule variable count = %d\n", VariableCount
));
802 // The last entry is the end flag.
804 Status
= PeiServicesAllocatePool (
805 (VariableCount
+ 1) * sizeof (EFI_PHYSICAL_ADDRESS
),
806 (VOID
**)&VariableArrayAddress
809 if (Status
!= EFI_SUCCESS
) {
810 DEBUG ((EFI_D_ERROR
, "AllocatePages Failed!, Status = %x\n", Status
));
814 ZeroMem (VariableArrayAddress
, (VariableCount
+ 1) * sizeof (EFI_PHYSICAL_ADDRESS
));
817 // Find out if we actually have a capsule.
818 // GetCapsuleDescriptors depends on variable PPI, so it should run in 32-bit environment.
820 Status
= GetCapsuleDescriptors (VariableArrayAddress
);
821 if (EFI_ERROR (Status
)) {
822 DEBUG ((EFI_D_ERROR
, "Fail to find capsule variables.\n"));
827 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
829 // Switch to 64-bit mode to process capsule data when:
830 // 1. When DXE phase is 64-bit
831 // 2. When the buffer for 64-bit transition exists
832 // 3. When Capsule X64 image is built in BIOS image
833 // In 64-bit mode, we can process capsule data above 4GB.
835 CoalesceImageEntryPoint
= 0;
836 Status
= GetLongModeContext (&LongModeBuffer
);
837 if (EFI_ERROR (Status
)) {
838 DEBUG ((EFI_D_ERROR
, "Fail to find the variables for long mode context!\n"));
839 Status
= EFI_NOT_FOUND
;
843 Status
= FindCapsuleCoalesceImage (&CoalesceImageEntryPoint
, &CoalesceImageMachineType
);
844 if ((EFI_ERROR (Status
)) || (CoalesceImageMachineType
!= EFI_IMAGE_MACHINE_X64
)) {
845 DEBUG ((EFI_D_ERROR
, "Fail to find CapsuleX64 module in FV!\n"));
846 Status
= EFI_NOT_FOUND
;
849 ASSERT (CoalesceImageEntryPoint
!= 0);
850 CoalesceEntry
= (COALESCE_ENTRY
) (UINTN
) CoalesceImageEntryPoint
;
851 Status
= ModeSwitch (&LongModeBuffer
, CoalesceEntry
, (EFI_PHYSICAL_ADDRESS
)(UINTN
)VariableArrayAddress
, MemoryBase
, MemorySize
);
854 // Capsule is processed in IA32 mode.
856 Status
= CapsuleDataCoalesce (PeiServices
, (EFI_PHYSICAL_ADDRESS
*)(UINTN
)VariableArrayAddress
, MemoryBase
, MemorySize
);
860 // Process capsule directly.
862 Status
= CapsuleDataCoalesce (PeiServices
, (EFI_PHYSICAL_ADDRESS
*)(UINTN
)VariableArrayAddress
, MemoryBase
, MemorySize
);
865 DEBUG ((EFI_D_INFO
, "Capsule Coalesce Status = %r!\n", Status
));
867 if (Status
== EFI_BUFFER_TOO_SMALL
) {
868 DEBUG ((EFI_D_ERROR
, "There is not enough memory to process capsule!\n"));
871 if (Status
== EFI_NOT_FOUND
) {
872 DEBUG ((EFI_D_ERROR
, "Fail to parse capsule descriptor in memory!\n"));
874 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
875 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_INVALID_CAPSULE_DESCRIPTOR
)
884 Determine if we're in capsule update boot mode.
886 @param PeiServices PEI services table
888 @retval EFI_SUCCESS if we have a capsule available
889 @retval EFI_NOT_FOUND no capsule detected
895 IN EFI_PEI_SERVICES
**PeiServices
899 Status
= GetCapsuleDescriptors (NULL
);
903 This function will look at a capsule and determine if it's a test pattern.
904 If it is, then it will verify it and emit an error message if corruption is detected.
906 @param PeiServices Standard pei services pointer
907 @param CapsuleBase Base address of coalesced capsule, which is preceeded
908 by private data. Very implementation specific.
910 @retval TRUE Capsule image is the test image
911 @retval FALSE Capsule image is not the test image.
916 IN EFI_PEI_SERVICES
**PeiServices
,
928 // Look at the capsule data and determine if it's a test pattern. If it
929 // is, then test it now.
931 TestPtr
= (UINT32
*) CapsuleBase
;
935 if (*TestPtr
== 0x54534554) {
937 DEBUG ((EFI_D_INFO
, "Capsule test pattern mode activated...\n"));
938 TestSize
= TestPtr
[1] / sizeof (UINT32
);
940 // Skip over the signature and the size fields in the pattern data header
944 while (TestSize
> 0) {
945 if (*TestPtr
!= TestCounter
) {
946 DEBUG ((EFI_D_INFO
, "Capsule test pattern mode FAILED: BaseAddr/FailAddr 0x%X 0x%X\n", (UINT32
)(UINTN
)(EFI_CAPSULE_PEIM_PRIVATE_DATA
*)CapsuleBase
, (UINT32
)(UINTN
)TestPtr
));
955 DEBUG ((EFI_D_INFO
, "Capsule test pattern mode SUCCESS\n"));
962 Capsule PPI service that gets called after memory is available. The
963 capsule coalesce function, which must be called first, returns a base
964 address and size, which can be anything actually. Once the memory init
965 PEIM has discovered memory, then it should call this function and pass in
966 the base address and size returned by the coalesce function. Then this
967 function can create a capsule HOB and return.
969 @param PeiServices standard pei services pointer
970 @param CapsuleBase address returned by the capsule coalesce function. Most
971 likely this will actually be a pointer to private data.
972 @param CapsuleSize value returned by the capsule coalesce function.
974 @retval EFI_VOLUME_CORRUPTED CapsuleBase does not appear to point to a
976 @retval EFI_SUCCESS if all goes well.
981 IN EFI_PEI_SERVICES
**PeiServices
,
982 IN VOID
*CapsuleBase
,
987 EFI_CAPSULE_PEIM_PRIVATE_DATA
*PrivateData
;
989 EFI_PHYSICAL_ADDRESS NewBuffer
;
992 EFI_PHYSICAL_ADDRESS BaseAddress
;
995 PrivateData
= (EFI_CAPSULE_PEIM_PRIVATE_DATA
*) CapsuleBase
;
996 if (PrivateData
->Signature
!= EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE
) {
997 return EFI_VOLUME_CORRUPTED
;
999 if (PrivateData
->CapsuleAllImageSize
>= MAX_ADDRESS
) {
1000 DEBUG ((EFI_D_ERROR
, "CapsuleAllImageSize too big - 0x%lx\n", PrivateData
->CapsuleAllImageSize
));
1001 return EFI_OUT_OF_RESOURCES
;
1003 if (PrivateData
->CapsuleNumber
>= MAX_ADDRESS
) {
1004 DEBUG ((EFI_D_ERROR
, "CapsuleNumber too big - 0x%lx\n", PrivateData
->CapsuleNumber
));
1005 return EFI_OUT_OF_RESOURCES
;
1008 // Capsule Number and Capsule Offset is in the tail of Capsule data.
1010 Size
= (UINTN
)PrivateData
->CapsuleAllImageSize
;
1011 CapsuleNumber
= (UINTN
)PrivateData
->CapsuleNumber
;
1013 // Allocate the memory so that it gets preserved into DXE
1015 Status
= PeiServicesAllocatePages (
1016 EfiRuntimeServicesData
,
1017 EFI_SIZE_TO_PAGES (Size
),
1021 if (Status
!= EFI_SUCCESS
) {
1022 DEBUG ((EFI_D_ERROR
, "AllocatePages Failed!\n"));
1026 // Copy to our new buffer for DXE
1028 DEBUG ((EFI_D_INFO
, "Capsule copy from 0x%8X to 0x%8X with size 0x%8X\n", (UINTN
)((UINT8
*)PrivateData
+ sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA
) + (CapsuleNumber
- 1) * sizeof(UINT64
)), (UINTN
) NewBuffer
, Size
));
1029 CopyMem ((VOID
*) (UINTN
) NewBuffer
, (VOID
*) (UINTN
) ((UINT8
*)PrivateData
+ sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA
) + (CapsuleNumber
- 1) * sizeof(UINT64
)), Size
);
1031 // Check for test data pattern. If it is the test pattern, then we'll
1032 // test it ans still create the HOB so that it can be used to verify
1033 // that capsules don't get corrupted all the way into BDS. BDS will
1034 // still try to turn it into a firmware volume, but will think it's
1035 // corrupted so nothing will happen.
1038 CapsuleTestPattern (PeiServices
, (VOID
*) (UINTN
) NewBuffer
);
1042 // Build the UEFI Capsule Hob for each capsule image.
1044 for (Index
= 0; Index
< CapsuleNumber
; Index
++) {
1045 BaseAddress
= NewBuffer
+ PrivateData
->CapsuleOffset
[Index
];
1046 Length
= ((EFI_CAPSULE_HEADER
*)((UINTN
) BaseAddress
))->CapsuleImageSize
;
1048 BuildCvHob (BaseAddress
, Length
);
1054 CONST PEI_CAPSULE_PPI mCapsulePpi
= {
1060 CONST EFI_PEI_PPI_DESCRIPTOR mUefiPpiListCapsule
= {
1061 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
1062 &gPeiCapsulePpiGuid
,
1063 (PEI_CAPSULE_PPI
*) &mCapsulePpi
1067 Entry point function for the PEIM
1069 @param FileHandle Handle of the file being invoked.
1070 @param PeiServices Describes the list of possible PEI Services.
1072 @return EFI_SUCCESS If we installed our PPI
1078 IN EFI_PEI_FILE_HANDLE FileHandle
,
1079 IN CONST EFI_PEI_SERVICES
**PeiServices
1083 // Just produce our PPI
1085 return PeiServicesInstallPpi (&mUefiPpiListCapsule
);