2 The logic to process capsule.
4 Copyright (c) 2011 - 2012, Intel Corporation. All rights reserved.<BR>
5 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.
18 #include <Guid/CapsuleVendor.h>
20 #include <Library/BaseMemoryLib.h>
21 #include <Library/DebugLib.h>
22 #include <Library/PrintLib.h>
23 #include <Library/BaseLib.h>
25 #define MIN_COALESCE_ADDR (1024 * 1024)
26 #define MAX_SUPPORT_CAPSULE_NUM 50
28 #define EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('C', 'a', 'p', 'D')
33 } EFI_CAPSULE_PEIM_PRIVATE_DATA
;
36 Given a pointer to the capsule block list, info on the available system
37 memory, and the size of a buffer, find a free block of memory where a
38 buffer of the given size can be copied to safely.
40 @param BlockList Pointer to head of capsule block descriptors
41 @param MemBase Pointer to the base of memory in which we want to find free space
42 @param MemSize The size of the block of memory pointed to by MemBase
43 @param DataSize How big a free block we want to find
45 @return A pointer to a memory block of at least DataSize that lies somewhere
46 between MemBase and (MemBase + MemSize). The memory pointed to does not
47 contain any of the capsule block descriptors or capsule blocks pointed to
53 EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
,
60 Check the integrity of the capsule descriptors.
62 @param BlockList Pointer to the capsule descriptors
64 @retval NULL BlockList is not valid.
65 @retval LastBlockDesc Last one Block in BlockList
68 EFI_CAPSULE_BLOCK_DESCRIPTOR
*
69 ValidateCapsuleIntegrity (
70 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
74 The capsule block descriptors may be fragmented and spread all over memory.
75 To simplify the coalescing of capsule blocks, first coalesce all the
76 capsule block descriptors low in memory.
78 The descriptors passed in can be fragmented throughout memory. Here
79 they are relocated into memory to turn them into a contiguous (null
82 @param PeiServices pointer to PEI services table
83 @param BlockList pointer to the capsule block descriptors
84 @param MemBase base of system memory in which we can work
85 @param MemSize size of the system memory pointed to by MemBase
87 @retval NULL could not relocate the descriptors
88 @retval Pointer to the base of the successfully-relocated block descriptors.
91 EFI_CAPSULE_BLOCK_DESCRIPTOR
*
92 RelocateBlockDescriptors (
93 IN EFI_PEI_SERVICES
**PeiServices
,
94 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
,
100 Check every capsule header.
102 @param CapsuleHeader The pointer to EFI_CAPSULE_HEADER
104 @retval FALSE Capsule is OK
105 @retval TRUE Capsule is corrupted
110 IN EFI_CAPSULE_HEADER
*CapsuleHeader
114 Determine if two buffers overlap in memory.
116 @param Buff1 pointer to first buffer
117 @param Size1 size of Buff1
118 @param Buff2 pointer to second buffer
119 @param Size2 size of Buff2
121 @retval TRUE Buffers overlap in memory.
122 @retval FALSE Buffer doesn't overlap.
134 Given a pointer to a capsule block descriptor, traverse the list to figure
135 out how many legitimate descriptors there are, and how big the capsule it
138 @param Desc Pointer to the capsule block descriptors
139 NumDescriptors - optional pointer to where to return the number of descriptors
140 CapsuleSize - optional pointer to where to return the capsule size
141 @param NumDescriptors Optional pointer to where to return the number of descriptors
142 @param CapsuleSize Optional pointer to where to return the capsule size
144 @retval EFI_NOT_FOUND No descriptors containing data in the list
145 @retval EFI_SUCCESS Return data is valid
150 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*Desc
,
151 IN OUT UINTN
*NumDescriptors OPTIONAL
,
152 IN OUT UINTN
*CapsuleSize OPTIONAL
156 Given a pointer to the capsule block list, info on the available system
157 memory, and the size of a buffer, find a free block of memory where a
158 buffer of the given size can be copied to safely.
160 @param BlockList Pointer to head of capsule block descriptors
161 @param MemBase Pointer to the base of memory in which we want to find free space
162 @param MemSize The size of the block of memory pointed to by MemBase
163 @param DataSize How big a free block we want to find
165 @return A pointer to a memory block of at least DataSize that lies somewhere
166 between MemBase and (MemBase + MemSize). The memory pointed to does not
167 contain any of the capsule block descriptors or capsule blocks pointed to
173 EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
,
180 EFI_CAPSULE_BLOCK_DESCRIPTOR
*CurrDesc
;
181 EFI_CAPSULE_BLOCK_DESCRIPTOR
*TempDesc
;
186 // Need at least enough to copy the data to at the end of the buffer, so
187 // say the end is less the data size for easy comparisons here.
189 MemEnd
= MemBase
+ MemSize
- DataSize
;
190 CurrDesc
= BlockList
;
192 // Go through all the descriptor blocks and see if any obstruct the range
194 while (CurrDesc
!= NULL
) {
196 // Get the size of this block list and see if it's in the way
200 Size
= sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
201 while (TempDesc
->Length
!= 0) {
202 Size
+= sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
206 if (IsOverlapped (MemBase
, DataSize
, (UINT8
*) CurrDesc
, Size
)) {
208 // Set our new base to the end of this block list and start all over
210 MemBase
= (UINT8
*) CurrDesc
+ Size
;
211 CurrDesc
= BlockList
;
212 if (MemBase
> MemEnd
) {
219 // Now go through all the blocks and make sure none are in the way
221 while ((CurrDesc
->Length
!= 0) && (!Failed
)) {
222 if (IsOverlapped (MemBase
, DataSize
, (UINT8
*) (UINTN
) CurrDesc
->Union
.DataBlock
, (UINTN
) CurrDesc
->Length
)) {
224 // Set our new base to the end of this block and start all over
227 MemBase
= (UINT8
*) ((UINTN
) CurrDesc
->Union
.DataBlock
) + CurrDesc
->Length
;
228 CurrDesc
= BlockList
;
229 if (MemBase
> MemEnd
) {
236 // Normal continuation -- jump to next block descriptor list
239 CurrDesc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) CurrDesc
->Union
.ContinuationPointer
;
246 Check the integrity of the capsule descriptors.
248 @param BlockList Pointer to the capsule descriptors
250 @retval NULL BlockList is not valid.
251 @retval LastBlockDesc Last one Block in BlockList
254 EFI_CAPSULE_BLOCK_DESCRIPTOR
*
255 ValidateCapsuleIntegrity (
256 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
259 EFI_CAPSULE_HEADER
*CapsuleHeader
;
262 EFI_CAPSULE_BLOCK_DESCRIPTOR
*Ptr
;
265 // Go through the list to look for inconsistencies. Check for:
266 // * misaligned block descriptors.
267 // * The first capsule header guid
268 // * The first capsule header flag
269 // * Data + Length < Data (wrap)
273 while ((Ptr
->Length
!= 0) || (Ptr
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
275 // Make sure the descriptor is aligned at UINT64 in memory
277 if ((UINTN
) Ptr
& 0x07) {
278 DEBUG ((EFI_D_ERROR
, "BlockList address failed alignment check\n"));
282 if (Ptr
->Length
== 0) {
284 // Descriptor points to another list of block descriptors somewhere
287 Ptr
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) Ptr
->Union
.ContinuationPointer
;
290 //To enhance the reliability of check-up, the first capsule's header is checked here.
291 //More reliabilities check-up will do later.
293 if (CapsuleSize
== 0) {
295 //Move to the first capsule to check its header.
297 CapsuleHeader
= (EFI_CAPSULE_HEADER
*)((UINTN
)Ptr
->Union
.DataBlock
);
298 if (IsCapsuleCorrupted (CapsuleHeader
)) {
302 CapsuleSize
= CapsuleHeader
->CapsuleImageSize
;
305 if (CapsuleSize
>= Ptr
->Length
) {
306 CapsuleSize
= CapsuleSize
- Ptr
->Length
;
312 // Move to next BLOCK descriptor
318 if ((CapsuleCount
== 0) || (CapsuleSize
!= 0)) {
320 // No any capsule is found in BlockList or capsule data is corrupted.
329 The capsule block descriptors may be fragmented and spread all over memory.
330 To simplify the coalescing of capsule blocks, first coalesce all the
331 capsule block descriptors low in memory.
333 The descriptors passed in can be fragmented throughout memory. Here
334 they are relocated into memory to turn them into a contiguous (null
337 @param PeiServices pointer to PEI services table
338 @param BlockList pointer to the capsule block descriptors
339 @param MemBase base of system memory in which we can work
340 @param MemSize size of the system memory pointed to by MemBase
342 @retval NULL could not relocate the descriptors
343 @retval Pointer to the base of the successfully-relocated block descriptors.
346 EFI_CAPSULE_BLOCK_DESCRIPTOR
*
347 RelocateBlockDescriptors (
348 IN EFI_PEI_SERVICES
**PeiServices
,
349 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
,
354 EFI_CAPSULE_BLOCK_DESCRIPTOR
*NewBlockList
;
355 EFI_CAPSULE_BLOCK_DESCRIPTOR
*CurrBlockDescHead
;
356 EFI_CAPSULE_BLOCK_DESCRIPTOR
*TempBlockDesc
;
357 EFI_CAPSULE_BLOCK_DESCRIPTOR
*PrevBlockDescTail
;
358 UINTN NumDescriptors
;
363 // Get the info on the blocks and descriptors. Since we're going to move
364 // the descriptors low in memory, adjust the base/size values accordingly here.
365 // GetCapsuleInfo() returns the number of legit descriptors, so add one for
368 if (GetCapsuleInfo (BlockList
, &NumDescriptors
, NULL
) != EFI_SUCCESS
) {
373 BufferSize
= NumDescriptors
* sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
374 NewBlockList
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) MemBase
;
375 if (MemSize
< BufferSize
) {
379 MemSize
-= BufferSize
;
380 MemBase
+= BufferSize
;
382 // Go through all the blocks and make sure none are in the way
384 TempBlockDesc
= BlockList
;
385 while (TempBlockDesc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
) {
386 if (TempBlockDesc
->Length
== 0) {
388 // Next block of descriptors
390 TempBlockDesc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) TempBlockDesc
->Union
.ContinuationPointer
;
393 // If the capsule data pointed to by this descriptor is in the way,
397 (UINT8
*) NewBlockList
,
399 (UINT8
*) (UINTN
) TempBlockDesc
->Union
.DataBlock
,
400 (UINTN
) TempBlockDesc
->Length
403 // Relocate the block
405 RelocBuffer
= FindFreeMem (BlockList
, MemBase
, MemSize
, (UINTN
) TempBlockDesc
->Length
);
406 if (RelocBuffer
== NULL
) {
410 CopyMem ((VOID
*) RelocBuffer
, (VOID
*) (UINTN
) TempBlockDesc
->Union
.DataBlock
, (UINTN
) TempBlockDesc
->Length
);
411 TempBlockDesc
->Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) RelocBuffer
;
413 DEBUG ((EFI_D_INFO
, "Capsule relocate descriptors from/to/size 0x%X 0x%X 0x%X\n", (UINT32
)(UINTN
)TempBlockDesc
->Union
.DataBlock
, (UINT32
)(UINTN
)RelocBuffer
, (UINT32
)(UINTN
)TempBlockDesc
->Length
));
419 // Now go through all the block descriptors to make sure that they're not
420 // in the memory region we want to copy them to.
422 CurrBlockDescHead
= BlockList
;
423 PrevBlockDescTail
= NULL
;
424 while ((CurrBlockDescHead
!= NULL
) && (CurrBlockDescHead
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
426 // Get the size of this list then see if it overlaps our low region
428 TempBlockDesc
= CurrBlockDescHead
;
429 BlockListSize
= sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
430 while (TempBlockDesc
->Length
!= 0) {
431 BlockListSize
+= sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
436 (UINT8
*) NewBlockList
,
438 (UINT8
*) CurrBlockDescHead
,
442 // Overlaps, so move it out of the way
444 RelocBuffer
= FindFreeMem (BlockList
, MemBase
, MemSize
, BlockListSize
);
445 if (RelocBuffer
== NULL
) {
448 CopyMem ((VOID
*) RelocBuffer
, (VOID
*) CurrBlockDescHead
, BlockListSize
);
449 DEBUG ((EFI_D_INFO
, "Capsule reloc descriptor block #2\n"));
451 // Point the previous block's next point to this copied version. If
452 // the tail pointer is null, then this is the first descriptor block.
454 if (PrevBlockDescTail
== NULL
) {
455 BlockList
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) RelocBuffer
;
457 PrevBlockDescTail
->Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) RelocBuffer
;
461 // Save our new tail and jump to the next block list
463 PrevBlockDescTail
= TempBlockDesc
;
464 CurrBlockDescHead
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) TempBlockDesc
->Union
.ContinuationPointer
;
467 // Cleared out low memory. Now copy the descriptors down there.
469 TempBlockDesc
= BlockList
;
470 CurrBlockDescHead
= NewBlockList
;
471 while ((TempBlockDesc
!= NULL
) && (TempBlockDesc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
472 if (TempBlockDesc
->Length
!= 0) {
473 CurrBlockDescHead
->Union
.DataBlock
= TempBlockDesc
->Union
.DataBlock
;
474 CurrBlockDescHead
->Length
= TempBlockDesc
->Length
;
478 TempBlockDesc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) TempBlockDesc
->Union
.ContinuationPointer
;
484 CurrBlockDescHead
->Union
.ContinuationPointer
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
485 CurrBlockDescHead
->Length
= 0;
490 Determine if two buffers overlap in memory.
492 @param Buff1 pointer to first buffer
493 @param Size1 size of Buff1
494 @param Buff2 pointer to second buffer
495 @param Size2 size of Buff2
497 @retval TRUE Buffers overlap in memory.
498 @retval FALSE Buffer doesn't overlap.
510 // If buff1's end is less than the start of buff2, then it's ok.
511 // Also, if buff1's start is beyond buff2's end, then it's ok.
513 if (((Buff1
+ Size1
) <= Buff2
) || (Buff1
>= (Buff2
+ Size2
))) {
521 Given a pointer to a capsule block descriptor, traverse the list to figure
522 out how many legitimate descriptors there are, and how big the capsule it
525 @param Desc Pointer to the capsule block descriptors
526 NumDescriptors - optional pointer to where to return the number of descriptors
527 CapsuleSize - optional pointer to where to return the capsule size
528 @param NumDescriptors Optional pointer to where to return the number of descriptors
529 @param CapsuleSize Optional pointer to where to return the capsule size
531 @retval EFI_NOT_FOUND No descriptors containing data in the list
532 @retval EFI_SUCCESS Return data is valid
537 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*Desc
,
538 IN OUT UINTN
*NumDescriptors OPTIONAL
,
539 IN OUT UINTN
*CapsuleSize OPTIONAL
545 ASSERT (Desc
!= NULL
);
550 while (Desc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
) {
551 if (Desc
->Length
== 0) {
553 // Descriptor points to another list of block descriptors somewhere
555 Desc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) Desc
->Union
.ContinuationPointer
;
557 Size
+= (UINTN
) Desc
->Length
;
563 // If no descriptors, then fail
566 return EFI_NOT_FOUND
;
569 if (NumDescriptors
!= NULL
) {
570 *NumDescriptors
= Count
;
573 if (CapsuleSize
!= NULL
) {
581 Check every capsule header.
583 @param CapsuleHeader The pointer to EFI_CAPSULE_HEADER
585 @retval FALSE Capsule is OK
586 @retval TRUE Capsule is corrupted
591 IN EFI_CAPSULE_HEADER
*CapsuleHeader
595 //A capsule to be updated across a system reset should contain CAPSULE_FLAGS_PERSIST_ACROSS_RESET.
597 if ((CapsuleHeader
->Flags
& CAPSULE_FLAGS_PERSIST_ACROSS_RESET
) == 0) {
601 //Make sure the flags combination is supported by the platform.
603 if ((CapsuleHeader
->Flags
& (CAPSULE_FLAGS_PERSIST_ACROSS_RESET
| CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE
)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE
) {
606 if ((CapsuleHeader
->Flags
& (CAPSULE_FLAGS_PERSIST_ACROSS_RESET
| CAPSULE_FLAGS_INITIATE_RESET
)) == CAPSULE_FLAGS_INITIATE_RESET
) {
614 Try to verify the integrity of a capsule test pattern before the
615 capsule gets coalesced. This can be useful in narrowing down
616 where capsule data corruption occurs.
618 The test pattern mode fills in memory with a counting UINT32 value.
619 If the capsule is not divided up in a multiple of 4-byte blocks, then
620 things get messy doing the check. Therefore there are some cases
621 here where we just give up and skip the pre-coalesce check.
623 @param PeiServices PEI services table
624 @param Desc Pointer to capsule descriptors
627 CapsuleTestPatternPreCoalesce (
628 IN EFI_PEI_SERVICES
**PeiServices
,
629 IN EFI_CAPSULE_BLOCK_DESCRIPTOR
*Desc
636 // Find first data descriptor
638 while ((Desc
->Length
== 0) && (Desc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
639 Desc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) Desc
->Union
.ContinuationPointer
;
642 if (Desc
->Union
.ContinuationPointer
== 0) {
646 // First one better be long enough to at least hold the test signature
648 if (Desc
->Length
< sizeof (UINT32
)) {
649 DEBUG ((EFI_D_INFO
, "Capsule test pattern pre-coalesce punted #1\n"));
653 TestPtr
= (UINT32
*) (UINTN
) Desc
->Union
.DataBlock
;
657 if (*TestPtr
!= 0x54534554) {
662 TestSize
= (UINT32
) Desc
->Length
- 2 * sizeof (UINT32
);
664 // Skip over the signature and the size fields in the pattern data header
668 if ((TestSize
& 0x03) != 0) {
669 DEBUG ((EFI_D_INFO
, "Capsule test pattern pre-coalesce punted #2\n"));
673 while (TestSize
> 0) {
674 if (*TestPtr
!= TestCounter
) {
675 DEBUG ((EFI_D_INFO
, "Capsule test pattern pre-coalesce failed data corruption check\n"));
679 TestSize
-= sizeof (UINT32
);
684 while ((Desc
->Length
== 0) && (Desc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
685 Desc
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*) (UINTN
) Desc
->Union
.ContinuationPointer
;
688 if (Desc
->Union
.ContinuationPointer
== (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
) {
691 TestSize
= (UINT32
) Desc
->Length
;
692 TestPtr
= (UINT32
*) (UINTN
) Desc
->Union
.DataBlock
;
697 Checks for the presence of capsule descriptors.
698 Get capsule descriptors from variable CapsuleUpdateData, CapsuleUpdateData1, CapsuleUpdateData2...
700 @param BlockListBuffer Pointer to the buffer of capsule descriptors variables
701 @param BlockDescriptorList Pointer to the capsule descriptors list
703 @retval EFI_SUCCESS a valid capsule is present
704 @retval EFI_NOT_FOUND if a valid capsule is not present
707 BuildCapsuleDescriptors (
708 IN EFI_PHYSICAL_ADDRESS
*BlockListBuffer
,
709 OUT EFI_CAPSULE_BLOCK_DESCRIPTOR
**BlockDescriptorList
713 EFI_CAPSULE_BLOCK_DESCRIPTOR
*LastBlock
;
714 EFI_CAPSULE_BLOCK_DESCRIPTOR
*TempBlock
;
715 EFI_CAPSULE_BLOCK_DESCRIPTOR
*HeadBlock
;
722 while (BlockListBuffer
[Index
] != 0) {
724 // Test integrity of descriptors.
726 TempBlock
= ValidateCapsuleIntegrity ((EFI_CAPSULE_BLOCK_DESCRIPTOR
*)(UINTN
)BlockListBuffer
[Index
]);
727 if (TempBlock
!= NULL
) {
728 if (LastBlock
== NULL
) {
729 LastBlock
= TempBlock
;
732 // Return the base of the block descriptors
734 HeadBlock
= (EFI_CAPSULE_BLOCK_DESCRIPTOR
*)(UINTN
)BlockListBuffer
[Index
];
737 // Combine the different BlockList into single BlockList.
739 LastBlock
->Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)BlockListBuffer
[Index
];
740 LastBlock
->Length
= 0;
741 LastBlock
= TempBlock
;
747 if (HeadBlock
!= NULL
) {
748 *BlockDescriptorList
= HeadBlock
;
751 return EFI_NOT_FOUND
;
755 The function to coalesce a fragmented capsule in memory.
757 Memory Map for coalesced capsule:
758 MemBase + ---->+---------------------------+<-----------+
759 MemSize | CapsuleOffset[49] | |
760 +---------------------------+ |
761 | ................ | |
762 +---------------------------+ |
763 | CapsuleOffset[2] | |
764 +---------------------------+ |
765 | CapsuleOffset[1] | |
766 +---------------------------+ |
767 | CapsuleOffset[0] | CapsuleSize
768 +---------------------------+ |
770 +---------------------------+ |
776 +---------------------------+ |
778 DestPtr ----> +---------------------------+<-----------+
780 | FreeMem | FreeMemSize
782 FreeMemBase --->+---------------------------+<-----------+
784 +---------------------------+
785 | BlockDescriptor n |
786 +---------------------------+
787 | ................. |
788 +---------------------------+
789 | BlockDescriptor 1 |
790 +---------------------------+
791 | BlockDescriptor 0 |
792 +---------------------------+
793 | PrivateDataDesc 0 |
794 MemBase ---->+---------------------------+<----- BlockList
796 @param PeiServices General purpose services available to every PEIM.
797 @param BlockListBuffer Point to the buffer of Capsule Descriptor Variables.
798 @param MemoryBase Pointer to the base of a block of memory that we can walk
799 all over while trying to coalesce our buffers.
800 On output, this variable will hold the base address of
802 @param MemorySize Size of the memory region pointed to by MemoryBase.
803 On output, this variable will contain the size of the
806 @retval EFI_NOT_FOUND If we could not find the capsule descriptors.
808 @retval EFI_BUFFER_TOO_SMALL
809 If we could not coalesce the capsule in the memory
810 region provided to us.
812 @retval EFI_SUCCESS Processed the capsule successfully.
816 CapsuleDataCoalesce (
817 IN EFI_PEI_SERVICES
**PeiServices
,
818 IN EFI_PHYSICAL_ADDRESS
*BlockListBuffer
,
819 IN OUT VOID
**MemoryBase
,
820 IN OUT UINTN
*MemorySize
823 VOID
*NewCapsuleBase
;
829 UINT32 CapsuleOffset
[MAX_SUPPORT_CAPSULE_NUM
];
833 UINT64 CapsuleImageSize
;
835 UINTN DescriptorsSize
;
837 UINTN NumDescriptors
;
839 BOOLEAN CapsuleBeginFlag
;
841 EFI_CAPSULE_HEADER
*CapsuleHeader
;
842 EFI_CAPSULE_PEIM_PRIVATE_DATA PrivateData
;
843 EFI_CAPSULE_PEIM_PRIVATE_DATA
*PrivateDataPtr
;
844 EFI_CAPSULE_BLOCK_DESCRIPTOR
*BlockList
;
845 EFI_CAPSULE_BLOCK_DESCRIPTOR
*CurrentBlockDesc
;
846 EFI_CAPSULE_BLOCK_DESCRIPTOR
*TempBlockDesc
;
847 EFI_CAPSULE_BLOCK_DESCRIPTOR PrivateDataDesc
[2];
852 CapsuleImageSize
= 0;
853 PrivateDataPtr
= NULL
;
855 CapsuleHeader
= NULL
;
856 CapsuleBeginFlag
= TRUE
;
862 // Build capsule descriptors list
864 Status
= BuildCapsuleDescriptors (BlockListBuffer
, &BlockList
);
865 if (EFI_ERROR (Status
)) {
870 CapsuleTestPatternPreCoalesce (PeiServices
, BlockList
);
874 // Get the size of our descriptors and the capsule size. GetCapsuleInfo()
875 // returns the number of descriptors that actually point to data, so add
876 // one for a terminator. Do that below.
878 GetCapsuleInfo (BlockList
, &NumDescriptors
, &CapsuleSize
);
879 if ((CapsuleSize
== 0) || (NumDescriptors
== 0)) {
880 return EFI_NOT_FOUND
;
884 // Initialize our local copy of private data. When we're done, we'll create a
885 // descriptor for it as well so that it can be put into free memory without
886 // trashing anything.
888 PrivateData
.Signature
= EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE
;
889 PrivateData
.CapsuleSize
= (UINT32
) CapsuleSize
;
890 PrivateDataDesc
[0].Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) &PrivateData
;
891 PrivateDataDesc
[0].Length
= sizeof (EFI_CAPSULE_PEIM_PRIVATE_DATA
);
892 PrivateDataDesc
[1].Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) BlockList
;
893 PrivateDataDesc
[1].Length
= 0;
895 // In addition to PrivateDataDesc[1:0], one terminator is added
896 // See below RelocateBlockDescriptors()
899 CapsuleSize
+= sizeof (EFI_CAPSULE_PEIM_PRIVATE_DATA
) + sizeof(CapsuleOffset
) + sizeof(UINT32
);
900 BlockList
= PrivateDataDesc
;
901 DescriptorsSize
= NumDescriptors
* sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR
);
904 // Don't go below some min address. If the base is below it,
905 // then move it up and adjust the size accordingly.
907 DEBUG ((EFI_D_INFO
, "Capsule Memory range from 0x%8X to 0x%8X\n", (UINTN
) *MemoryBase
, (UINTN
)*MemoryBase
+ *MemorySize
));
908 if ((UINTN
)*MemoryBase
< (UINTN
) MIN_COALESCE_ADDR
) {
909 if (((UINTN
)*MemoryBase
+ *MemorySize
) < (UINTN
) MIN_COALESCE_ADDR
) {
910 return EFI_BUFFER_TOO_SMALL
;
912 *MemorySize
= *MemorySize
- ((UINTN
) MIN_COALESCE_ADDR
- (UINTN
) *MemoryBase
);
913 *MemoryBase
= (VOID
*) (UINTN
) MIN_COALESCE_ADDR
;
917 if (*MemorySize
<= (CapsuleSize
+ DescriptorsSize
)) {
918 return EFI_BUFFER_TOO_SMALL
;
921 FreeMemBase
= *MemoryBase
;
922 FreeMemSize
= *MemorySize
;
923 DEBUG ((EFI_D_INFO
, "Capsule Free Memory from 0x%8X to 0x%8X\n", (UINTN
) FreeMemBase
, (UINTN
) FreeMemBase
+ FreeMemSize
));
926 // Relocate all the block descriptors to low memory to make further
927 // processing easier.
929 BlockList
= RelocateBlockDescriptors (PeiServices
, BlockList
, FreeMemBase
, FreeMemSize
);
930 if (BlockList
== NULL
) {
932 // Not enough room to relocate the descriptors
934 return EFI_BUFFER_TOO_SMALL
;
938 // Take the top of memory for the capsule. Naturally align.
940 DestPtr
= FreeMemBase
+ FreeMemSize
- CapsuleSize
;
941 DestPtr
= (UINT8
*) ((UINTN
) DestPtr
&~ (UINTN
) (sizeof (UINTN
) - 1));
942 FreeMemBase
= (UINT8
*) BlockList
+ DescriptorsSize
;
943 FreeMemSize
= (UINTN
) DestPtr
- (UINTN
) FreeMemBase
;
944 NewCapsuleBase
= (VOID
*) DestPtr
;
947 // Move all the blocks to the top (high) of memory.
948 // Relocate all the obstructing blocks. Note that the block descriptors
949 // were coalesced when they were relocated, so we can just ++ the pointer.
951 CurrentBlockDesc
= BlockList
;
952 while ((CurrentBlockDesc
->Length
!= 0) || (CurrentBlockDesc
->Union
.ContinuationPointer
!= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
)) {
954 // See if any of the remaining capsule blocks are in the way
956 TempBlockDesc
= CurrentBlockDesc
;
957 while (TempBlockDesc
->Length
!= 0) {
959 // Is this block in the way of where we want to copy the current descriptor to?
963 (UINTN
) CurrentBlockDesc
->Length
,
964 (UINT8
*) (UINTN
) TempBlockDesc
->Union
.DataBlock
,
965 (UINTN
) TempBlockDesc
->Length
968 // Relocate the block
970 RelocPtr
= FindFreeMem (BlockList
, FreeMemBase
, FreeMemSize
, (UINTN
) TempBlockDesc
->Length
);
971 if (RelocPtr
== NULL
) {
972 return EFI_BUFFER_TOO_SMALL
;
975 CopyMem ((VOID
*) RelocPtr
, (VOID
*) (UINTN
) TempBlockDesc
->Union
.DataBlock
, (UINTN
) TempBlockDesc
->Length
);
976 DEBUG ((EFI_D_INFO
, "Capsule reloc data block from 0x%8X to 0x%8X with size 0x%8X\n",
977 (UINTN
) TempBlockDesc
->Union
.DataBlock
, (UINTN
) RelocPtr
, (UINTN
) TempBlockDesc
->Length
));
979 TempBlockDesc
->Union
.DataBlock
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) RelocPtr
;
987 // Ok, we made it through. Copy the block.
988 // we just support greping one capsule from the lists of block descs list.
992 //Skip the first block descriptor that filled with EFI_CAPSULE_PEIM_PRIVATE_DATA
994 if (CapsuleTimes
> 1) {
996 //For every capsule entry point, check its header to determine whether to relocate it.
997 //If it is invalid, skip it and move on to the next capsule. If it is valid, relocate it.
999 if (CapsuleBeginFlag
) {
1000 CapsuleBeginFlag
= FALSE
;
1001 CapsuleHeader
= (EFI_CAPSULE_HEADER
*)(UINTN
)CurrentBlockDesc
->Union
.DataBlock
;
1002 SizeLeft
= CapsuleHeader
->CapsuleImageSize
;
1003 if (!IsCapsuleCorrupted (CapsuleHeader
)) {
1005 if (CapsuleIndex
> (MAX_SUPPORT_CAPSULE_NUM
- 1)) {
1006 DEBUG ((EFI_D_ERROR
, "Capsule number exceeds the max number of %d!\n", MAX_SUPPORT_CAPSULE_NUM
));
1007 return EFI_BUFFER_TOO_SMALL
;
1011 // Relocate this valid capsule
1013 IsCorrupted
= FALSE
;
1014 CapsuleImageSize
+= SizeLeft
;
1016 // Cache the begin offset of this capsule
1018 CapsuleOffset
[CapsuleIndex
++] = (UINT32
) (UINTN
) DestPtr
- (UINT32
)(UINTN
)NewCapsuleBase
- (UINT32
)sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA
);
1022 if (CurrentBlockDesc
->Length
< SizeLeft
) {
1024 CopyMem ((VOID
*) DestPtr
, (VOID
*) (UINTN
) (CurrentBlockDesc
->Union
.DataBlock
), (UINTN
)CurrentBlockDesc
->Length
);
1025 DEBUG ((EFI_D_INFO
, "Capsule coalesce block no.0x%8X from 0x%8lX to 0x%8lX with size 0x%8X\n",CapsuleTimes
,
1026 (UINTN
)CurrentBlockDesc
->Union
.DataBlock
, (UINTN
)DestPtr
, (UINTN
)CurrentBlockDesc
->Length
));
1027 DestPtr
+= CurrentBlockDesc
->Length
;
1029 SizeLeft
-= CurrentBlockDesc
->Length
;
1032 //Here is the end of the current capsule image.
1035 CopyMem ((VOID
*) DestPtr
, (VOID
*)(UINTN
)(CurrentBlockDesc
->Union
.DataBlock
), (UINTN
) SizeLeft
);
1036 DEBUG ((EFI_D_INFO
, "Capsule coalesce block no.0x%8X from 0x%8lX to 0x%8lX with size 0x%8X\n",CapsuleTimes
,
1037 (UINTN
)CurrentBlockDesc
->Union
.DataBlock
, (UINTN
)DestPtr
, (UINTN
) SizeLeft
));
1038 DestPtr
+= SizeLeft
;
1041 // Start the next cycle
1045 CapsuleBeginFlag
= TRUE
;
1049 //The first entry is the block descriptor for EFI_CAPSULE_PEIM_PRIVATE_DATA.
1051 CopyMem ((VOID
*) DestPtr
, (VOID
*) (UINTN
) CurrentBlockDesc
->Union
.DataBlock
, (UINTN
) CurrentBlockDesc
->Length
);
1052 DestPtr
+= CurrentBlockDesc
->Length
;
1055 //Walk through the block descriptor list.
1060 // We return the base of memory we want reserved, and the size.
1061 // The memory peim should handle it appropriately from there.
1063 *MemorySize
= (UINTN
) CapsuleSize
;
1064 *MemoryBase
= (VOID
*) NewCapsuleBase
;
1067 //Append the offsets of mutiply capsules to the continous buffer
1069 DataPtr
= (VOID
*)((UINTN
)NewCapsuleBase
+ sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA
) + (UINTN
)CapsuleImageSize
);
1070 AddDataPtr
= (UINT32
*)(((UINTN
) DataPtr
+ sizeof(UINT32
) - 1) &~ (UINT32
) (sizeof (UINT32
) - 1));
1072 *AddDataPtr
++ = CapsuleIndex
;
1074 CopyMem (AddDataPtr
, &CapsuleOffset
[0], sizeof (UINT32
) * CapsuleIndex
);
1076 PrivateDataPtr
= (EFI_CAPSULE_PEIM_PRIVATE_DATA
*) NewCapsuleBase
;
1077 PrivateDataPtr
->CapsuleSize
= (UINT32
) CapsuleImageSize
;