]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/CapsulePei/Common/CapsuleCoalesce.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Enhance the code logic for RelocateBlockDescriptors.
[mirror_edk2.git] / MdeModulePkg / Universal / CapsulePei / Common / CapsuleCoalesce.c
1 /** @file
2 The logic to process capsule.
3
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
9
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.
12
13 **/
14
15 #include <Uefi.h>
16 #include <PiPei.h>
17
18 #include <Guid/CapsuleVendor.h>
19
20 #include <Library/BaseMemoryLib.h>
21 #include <Library/DebugLib.h>
22 #include <Library/PrintLib.h>
23 #include <Library/BaseLib.h>
24
25 #define MIN_COALESCE_ADDR (1024 * 1024)
26 #define MAX_SUPPORT_CAPSULE_NUM 50
27
28 #define EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('C', 'a', 'p', 'D')
29
30 typedef struct {
31 UINT32 Signature;
32 UINT32 CapsuleSize;
33 } EFI_CAPSULE_PEIM_PRIVATE_DATA;
34
35 /**
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.
39
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
44
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
48 by the BlockList.
49
50 **/
51 UINT8 *
52 FindFreeMem (
53 EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList,
54 UINT8 *MemBase,
55 UINTN MemSize,
56 UINTN DataSize
57 );
58
59 /**
60 Check the integrity of the capsule descriptors.
61
62 @param BlockList Pointer to the capsule descriptors
63
64 @retval NULL BlockList is not valid.
65 @retval LastBlockDesc Last one Block in BlockList
66
67 **/
68 EFI_CAPSULE_BLOCK_DESCRIPTOR *
69 ValidateCapsuleIntegrity (
70 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList
71 );
72
73 /**
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.
77
78 The descriptors passed in can be fragmented throughout memory. Here
79 they are relocated into memory to turn them into a contiguous (null
80 terminated) array.
81
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
86
87 @retval NULL could not relocate the descriptors
88 @retval Pointer to the base of the successfully-relocated block descriptors.
89
90 **/
91 EFI_CAPSULE_BLOCK_DESCRIPTOR *
92 RelocateBlockDescriptors (
93 IN EFI_PEI_SERVICES **PeiServices,
94 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList,
95 IN UINT8 *MemBase,
96 IN UINTN MemSize
97 );
98
99 /**
100 Check every capsule header.
101
102 @param CapsuleHeader The pointer to EFI_CAPSULE_HEADER
103
104 @retval FALSE Capsule is OK
105 @retval TRUE Capsule is corrupted
106
107 **/
108 BOOLEAN
109 IsCapsuleCorrupted (
110 IN EFI_CAPSULE_HEADER *CapsuleHeader
111 );
112
113 /**
114 Determine if two buffers overlap in memory.
115
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
120
121 @retval TRUE Buffers overlap in memory.
122 @retval FALSE Buffer doesn't overlap.
123
124 **/
125 BOOLEAN
126 IsOverlapped (
127 UINT8 *Buff1,
128 UINTN Size1,
129 UINT8 *Buff2,
130 UINTN Size2
131 );
132
133 /**
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
136 refers to is.
137
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
143
144 @retval EFI_NOT_FOUND No descriptors containing data in the list
145 @retval EFI_SUCCESS Return data is valid
146
147 **/
148 EFI_STATUS
149 GetCapsuleInfo (
150 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *Desc,
151 IN OUT UINTN *NumDescriptors OPTIONAL,
152 IN OUT UINTN *CapsuleSize OPTIONAL
153 );
154
155 /**
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.
159
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
164
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
168 by the BlockList.
169
170 **/
171 UINT8 *
172 FindFreeMem (
173 EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList,
174 UINT8 *MemBase,
175 UINTN MemSize,
176 UINTN DataSize
177 )
178 {
179 UINTN Size;
180 EFI_CAPSULE_BLOCK_DESCRIPTOR *CurrDesc;
181 EFI_CAPSULE_BLOCK_DESCRIPTOR *TempDesc;
182 UINT8 *MemEnd;
183 BOOLEAN Failed;
184
185 //
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.
188 //
189 MemEnd = MemBase + MemSize - DataSize;
190 CurrDesc = BlockList;
191 //
192 // Go through all the descriptor blocks and see if any obstruct the range
193 //
194 while (CurrDesc != NULL) {
195 //
196 // Get the size of this block list and see if it's in the way
197 //
198 Failed = FALSE;
199 TempDesc = CurrDesc;
200 Size = sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
201 while (TempDesc->Length != 0) {
202 Size += sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
203 TempDesc++;
204 }
205
206 if (IsOverlapped (MemBase, DataSize, (UINT8 *) CurrDesc, Size)) {
207 //
208 // Set our new base to the end of this block list and start all over
209 //
210 MemBase = (UINT8 *) CurrDesc + Size;
211 CurrDesc = BlockList;
212 if (MemBase > MemEnd) {
213 return NULL;
214 }
215
216 Failed = TRUE;
217 }
218 //
219 // Now go through all the blocks and make sure none are in the way
220 //
221 while ((CurrDesc->Length != 0) && (!Failed)) {
222 if (IsOverlapped (MemBase, DataSize, (UINT8 *) (UINTN) CurrDesc->Union.DataBlock, (UINTN) CurrDesc->Length)) {
223 //
224 // Set our new base to the end of this block and start all over
225 //
226 Failed = TRUE;
227 MemBase = (UINT8 *) ((UINTN) CurrDesc->Union.DataBlock) + CurrDesc->Length;
228 CurrDesc = BlockList;
229 if (MemBase > MemEnd) {
230 return NULL;
231 }
232 }
233 CurrDesc++;
234 }
235 //
236 // Normal continuation -- jump to next block descriptor list
237 //
238 if (!Failed) {
239 CurrDesc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) CurrDesc->Union.ContinuationPointer;
240 }
241 }
242 return MemBase;
243 }
244
245 /**
246 Check the integrity of the capsule descriptors.
247
248 @param BlockList Pointer to the capsule descriptors
249
250 @retval NULL BlockList is not valid.
251 @retval LastBlockDesc Last one Block in BlockList
252
253 **/
254 EFI_CAPSULE_BLOCK_DESCRIPTOR *
255 ValidateCapsuleIntegrity (
256 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList
257 )
258 {
259 EFI_CAPSULE_HEADER *CapsuleHeader;
260 UINT64 CapsuleSize;
261 UINT32 CapsuleCount;
262 EFI_CAPSULE_BLOCK_DESCRIPTOR *Ptr;
263
264 //
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)
270 CapsuleSize = 0;
271 CapsuleCount = 0;
272 Ptr = BlockList;
273 while ((Ptr->Length != 0) || (Ptr->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
274 //
275 // Make sure the descriptor is aligned at UINT64 in memory
276 //
277 if ((UINTN) Ptr & 0x07) {
278 DEBUG ((EFI_D_ERROR, "BlockList address failed alignment check\n"));
279 return NULL;
280 }
281
282 if (Ptr->Length == 0) {
283 //
284 // Descriptor points to another list of block descriptors somewhere
285 // else.
286 //
287 Ptr = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) Ptr->Union.ContinuationPointer;
288 } else {
289 //
290 //To enhance the reliability of check-up, the first capsule's header is checked here.
291 //More reliabilities check-up will do later.
292 //
293 if (CapsuleSize == 0) {
294 //
295 //Move to the first capsule to check its header.
296 //
297 CapsuleHeader = (EFI_CAPSULE_HEADER*)((UINTN)Ptr->Union.DataBlock);
298 if (IsCapsuleCorrupted (CapsuleHeader)) {
299 return NULL;
300 }
301 CapsuleCount ++;
302 CapsuleSize = CapsuleHeader->CapsuleImageSize;
303 }
304
305 if (CapsuleSize >= Ptr->Length) {
306 CapsuleSize = CapsuleSize - Ptr->Length;
307 } else {
308 CapsuleSize = 0;
309 }
310
311 //
312 // Move to next BLOCK descriptor
313 //
314 Ptr++;
315 }
316 }
317
318 if ((CapsuleCount == 0) || (CapsuleSize != 0)) {
319 //
320 // No any capsule is found in BlockList or capsule data is corrupted.
321 //
322 return NULL;
323 }
324
325 return Ptr;
326 }
327
328 /**
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.
332
333 The descriptors passed in can be fragmented throughout memory. Here
334 they are relocated into memory to turn them into a contiguous (null
335 terminated) array.
336
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
341
342 @retval NULL could not relocate the descriptors
343 @retval Pointer to the base of the successfully-relocated block descriptors.
344
345 **/
346 EFI_CAPSULE_BLOCK_DESCRIPTOR *
347 RelocateBlockDescriptors (
348 IN EFI_PEI_SERVICES **PeiServices,
349 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList,
350 IN UINT8 *MemBase,
351 IN UINTN MemSize
352 )
353 {
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;
359 UINTN BufferSize;
360 UINT8 *RelocBuffer;
361 UINTN BlockListSize;
362 //
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
366 // a terminator.
367 //
368 if (GetCapsuleInfo (BlockList, &NumDescriptors, NULL) != EFI_SUCCESS) {
369 return NULL;
370 }
371
372 NumDescriptors++;
373 BufferSize = NumDescriptors * sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
374 NewBlockList = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) MemBase;
375 if (MemSize < BufferSize) {
376 return NULL;
377 }
378
379 MemSize -= BufferSize;
380 MemBase += BufferSize;
381 //
382 // Go through all the blocks and make sure none are in the way
383 //
384 TempBlockDesc = BlockList;
385 while (TempBlockDesc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {
386 if (TempBlockDesc->Length == 0) {
387 //
388 // Next block of descriptors
389 //
390 TempBlockDesc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) TempBlockDesc->Union.ContinuationPointer;
391 } else {
392 //
393 // If the capsule data pointed to by this descriptor is in the way,
394 // move it.
395 //
396 if (IsOverlapped (
397 (UINT8 *) NewBlockList,
398 BufferSize,
399 (UINT8 *) (UINTN) TempBlockDesc->Union.DataBlock,
400 (UINTN) TempBlockDesc->Length
401 )) {
402 //
403 // Relocate the block
404 //
405 RelocBuffer = FindFreeMem (BlockList, MemBase, MemSize, (UINTN) TempBlockDesc->Length);
406 if (RelocBuffer == NULL) {
407 return NULL;
408 }
409
410 CopyMem ((VOID *) RelocBuffer, (VOID *) (UINTN) TempBlockDesc->Union.DataBlock, (UINTN) TempBlockDesc->Length);
411 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));
412 TempBlockDesc->Union.DataBlock = (EFI_PHYSICAL_ADDRESS) (UINTN) RelocBuffer;
413 }
414 TempBlockDesc++;
415 }
416 }
417 //
418 // Now go through all the block descriptors to make sure that they're not
419 // in the memory region we want to copy them to.
420 //
421 CurrBlockDescHead = BlockList;
422 PrevBlockDescTail = NULL;
423 while ((CurrBlockDescHead != NULL) && (CurrBlockDescHead->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
424 //
425 // Get the size of this list then see if it overlaps our low region
426 //
427 TempBlockDesc = CurrBlockDescHead;
428 BlockListSize = sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
429 while (TempBlockDesc->Length != 0) {
430 BlockListSize += sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
431 TempBlockDesc++;
432 }
433
434 if (IsOverlapped (
435 (UINT8 *) NewBlockList,
436 BufferSize,
437 (UINT8 *) CurrBlockDescHead,
438 BlockListSize
439 )) {
440 //
441 // Overlaps, so move it out of the way
442 //
443 RelocBuffer = FindFreeMem (BlockList, MemBase, MemSize, BlockListSize);
444 if (RelocBuffer == NULL) {
445 return NULL;
446 }
447 CopyMem ((VOID *) RelocBuffer, (VOID *) CurrBlockDescHead, BlockListSize);
448 DEBUG ((EFI_D_INFO, "Capsule reloc descriptor block #2\n"));
449 //
450 // Point the previous block's next point to this copied version. If
451 // the tail pointer is null, then this is the first descriptor block.
452 //
453 if (PrevBlockDescTail == NULL) {
454 BlockList = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) RelocBuffer;
455 } else {
456 PrevBlockDescTail->Union.DataBlock = (EFI_PHYSICAL_ADDRESS) (UINTN) RelocBuffer;
457 }
458 }
459 //
460 // Save our new tail and jump to the next block list
461 //
462 PrevBlockDescTail = TempBlockDesc;
463 CurrBlockDescHead = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) TempBlockDesc->Union.ContinuationPointer;
464 }
465 //
466 // Cleared out low memory. Now copy the descriptors down there.
467 //
468 TempBlockDesc = BlockList;
469 CurrBlockDescHead = NewBlockList;
470 while ((TempBlockDesc != NULL) && (TempBlockDesc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
471 if (TempBlockDesc->Length != 0) {
472 CurrBlockDescHead->Union.DataBlock = TempBlockDesc->Union.DataBlock;
473 CurrBlockDescHead->Length = TempBlockDesc->Length;
474 CurrBlockDescHead++;
475 TempBlockDesc++;
476 } else {
477 TempBlockDesc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) TempBlockDesc->Union.ContinuationPointer;
478 }
479 }
480 //
481 // Null terminate
482 //
483 CurrBlockDescHead->Union.ContinuationPointer = (EFI_PHYSICAL_ADDRESS) (UINTN) NULL;
484 CurrBlockDescHead->Length = 0;
485 return NewBlockList;
486 }
487
488 /**
489 Determine if two buffers overlap in memory.
490
491 @param Buff1 pointer to first buffer
492 @param Size1 size of Buff1
493 @param Buff2 pointer to second buffer
494 @param Size2 size of Buff2
495
496 @retval TRUE Buffers overlap in memory.
497 @retval FALSE Buffer doesn't overlap.
498
499 **/
500 BOOLEAN
501 IsOverlapped (
502 UINT8 *Buff1,
503 UINTN Size1,
504 UINT8 *Buff2,
505 UINTN Size2
506 )
507 {
508 //
509 // If buff1's end is less than the start of buff2, then it's ok.
510 // Also, if buff1's start is beyond buff2's end, then it's ok.
511 //
512 if (((Buff1 + Size1) <= Buff2) || (Buff1 >= (Buff2 + Size2))) {
513 return FALSE;
514 }
515
516 return TRUE;
517 }
518
519 /**
520 Given a pointer to a capsule block descriptor, traverse the list to figure
521 out how many legitimate descriptors there are, and how big the capsule it
522 refers to is.
523
524 @param Desc Pointer to the capsule block descriptors
525 NumDescriptors - optional pointer to where to return the number of descriptors
526 CapsuleSize - optional pointer to where to return the capsule size
527 @param NumDescriptors Optional pointer to where to return the number of descriptors
528 @param CapsuleSize Optional pointer to where to return the capsule size
529
530 @retval EFI_NOT_FOUND No descriptors containing data in the list
531 @retval EFI_SUCCESS Return data is valid
532
533 **/
534 EFI_STATUS
535 GetCapsuleInfo (
536 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *Desc,
537 IN OUT UINTN *NumDescriptors OPTIONAL,
538 IN OUT UINTN *CapsuleSize OPTIONAL
539 )
540 {
541 UINTN Count;
542 UINTN Size;
543
544 ASSERT (Desc != NULL);
545
546 Count = 0;
547 Size = 0;
548
549 while (Desc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {
550 if (Desc->Length == 0) {
551 //
552 // Descriptor points to another list of block descriptors somewhere
553 //
554 Desc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) Desc->Union.ContinuationPointer;
555 } else {
556 Size += (UINTN) Desc->Length;
557 Count++;
558 Desc++;
559 }
560 }
561 //
562 // If no descriptors, then fail
563 //
564 if (Count == 0) {
565 return EFI_NOT_FOUND;
566 }
567
568 if (NumDescriptors != NULL) {
569 *NumDescriptors = Count;
570 }
571
572 if (CapsuleSize != NULL) {
573 *CapsuleSize = Size;
574 }
575
576 return EFI_SUCCESS;
577 }
578
579 /**
580 Check every capsule header.
581
582 @param CapsuleHeader The pointer to EFI_CAPSULE_HEADER
583
584 @retval FALSE Capsule is OK
585 @retval TRUE Capsule is corrupted
586
587 **/
588 BOOLEAN
589 IsCapsuleCorrupted (
590 IN EFI_CAPSULE_HEADER *CapsuleHeader
591 )
592 {
593 //
594 //A capsule to be updated across a system reset should contain CAPSULE_FLAGS_PERSIST_ACROSS_RESET.
595 //
596 if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) == 0) {
597 return TRUE;
598 }
599 //
600 //Make sure the flags combination is supported by the platform.
601 //
602 if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {
603 return TRUE;
604 }
605 if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_INITIATE_RESET)) == CAPSULE_FLAGS_INITIATE_RESET) {
606 return TRUE;
607 }
608
609 return FALSE;
610 }
611
612 /**
613 Try to verify the integrity of a capsule test pattern before the
614 capsule gets coalesced. This can be useful in narrowing down
615 where capsule data corruption occurs.
616
617 The test pattern mode fills in memory with a counting UINT32 value.
618 If the capsule is not divided up in a multiple of 4-byte blocks, then
619 things get messy doing the check. Therefore there are some cases
620 here where we just give up and skip the pre-coalesce check.
621
622 @param PeiServices PEI services table
623 @param Desc Pointer to capsule descriptors
624 **/
625 VOID
626 CapsuleTestPatternPreCoalesce (
627 IN EFI_PEI_SERVICES **PeiServices,
628 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *Desc
629 )
630 {
631 UINT32 *TestPtr;
632 UINT32 TestCounter;
633 UINT32 TestSize;
634 //
635 // Find first data descriptor
636 //
637 while ((Desc->Length == 0) && (Desc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
638 Desc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) Desc->Union.ContinuationPointer;
639 }
640
641 if (Desc->Union.ContinuationPointer == 0) {
642 return ;
643 }
644 //
645 // First one better be long enough to at least hold the test signature
646 //
647 if (Desc->Length < sizeof (UINT32)) {
648 DEBUG ((EFI_D_INFO, "Capsule test pattern pre-coalesce punted #1\n"));
649 return ;
650 }
651
652 TestPtr = (UINT32 *) (UINTN) Desc->Union.DataBlock;
653 //
654 // 0x54534554 "TEST"
655 //
656 if (*TestPtr != 0x54534554) {
657 return ;
658 }
659
660 TestCounter = 0;
661 TestSize = (UINT32) Desc->Length - 2 * sizeof (UINT32);
662 //
663 // Skip over the signature and the size fields in the pattern data header
664 //
665 TestPtr += 2;
666 while (1) {
667 if ((TestSize & 0x03) != 0) {
668 DEBUG ((EFI_D_INFO, "Capsule test pattern pre-coalesce punted #2\n"));
669 return ;
670 }
671
672 while (TestSize > 0) {
673 if (*TestPtr != TestCounter) {
674 DEBUG ((EFI_D_INFO, "Capsule test pattern pre-coalesce failed data corruption check\n"));
675 return ;
676 }
677
678 TestSize -= sizeof (UINT32);
679 TestCounter++;
680 TestPtr++;
681 }
682 Desc++;
683 while ((Desc->Length == 0) && (Desc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
684 Desc = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) Desc->Union.ContinuationPointer;
685 }
686
687 if (Desc->Union.ContinuationPointer == (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {
688 return ;
689 }
690 TestSize = (UINT32) Desc->Length;
691 TestPtr = (UINT32 *) (UINTN) Desc->Union.DataBlock;
692 }
693 }
694
695 /**
696 Checks for the presence of capsule descriptors.
697 Get capsule descriptors from variable CapsuleUpdateData, CapsuleUpdateData1, CapsuleUpdateData2...
698
699 @param BlockListBuffer Pointer to the buffer of capsule descriptors variables
700 @param BlockDescriptorList Pointer to the capsule descriptors list
701
702 @retval EFI_SUCCESS a valid capsule is present
703 @retval EFI_NOT_FOUND if a valid capsule is not present
704 **/
705 EFI_STATUS
706 BuildCapsuleDescriptors (
707 IN EFI_PHYSICAL_ADDRESS *BlockListBuffer,
708 OUT EFI_CAPSULE_BLOCK_DESCRIPTOR **BlockDescriptorList
709 )
710 {
711 UINTN Index;
712 EFI_CAPSULE_BLOCK_DESCRIPTOR *LastBlock;
713 EFI_CAPSULE_BLOCK_DESCRIPTOR *TempBlock;
714 EFI_CAPSULE_BLOCK_DESCRIPTOR *HeadBlock;
715
716 LastBlock = NULL;
717 HeadBlock = NULL;
718 TempBlock = NULL;
719 Index = 0;
720
721 while (BlockListBuffer[Index] != 0) {
722 //
723 // Test integrity of descriptors.
724 //
725 TempBlock = ValidateCapsuleIntegrity ((EFI_CAPSULE_BLOCK_DESCRIPTOR *)(UINTN)BlockListBuffer[Index]);
726 if (TempBlock != NULL) {
727 if (LastBlock == NULL) {
728 LastBlock = TempBlock;
729
730 //
731 // Return the base of the block descriptors
732 //
733 HeadBlock = (EFI_CAPSULE_BLOCK_DESCRIPTOR *)(UINTN)BlockListBuffer[Index];
734 } else {
735 //
736 // Combine the different BlockList into single BlockList.
737 //
738 LastBlock->Union.DataBlock = (EFI_PHYSICAL_ADDRESS)(UINTN)BlockListBuffer[Index];
739 LastBlock->Length = 0;
740 LastBlock = TempBlock;
741 }
742 }
743 Index ++;
744 }
745
746 if (HeadBlock != NULL) {
747 *BlockDescriptorList = HeadBlock;
748 return EFI_SUCCESS;
749 }
750 return EFI_NOT_FOUND;
751 }
752
753 /**
754 The function to coalesce a fragmented capsule in memory.
755
756 Memory Map for coalesced capsule:
757 MemBase + ---->+---------------------------+<-----------+
758 MemSize | CapsuleOffset[49] | |
759 +---------------------------+ |
760 | ................ | |
761 +---------------------------+ |
762 | CapsuleOffset[2] | |
763 +---------------------------+ |
764 | CapsuleOffset[1] | |
765 +---------------------------+ |
766 | CapsuleOffset[0] | CapsuleSize
767 +---------------------------+ |
768 | CapsuleNumber | |
769 +---------------------------+ |
770 | | |
771 | | |
772 | Capsule Image | |
773 | | |
774 | | |
775 +---------------------------+ |
776 | PrivateData | |
777 DestPtr ----> +---------------------------+<-----------+
778 | | |
779 | FreeMem | FreeMemSize
780 | | |
781 FreeMemBase --->+---------------------------+<-----------+
782 | Terminator |
783 +---------------------------+
784 | BlockDescriptor n |
785 +---------------------------+
786 | ................. |
787 +---------------------------+
788 | BlockDescriptor 1 |
789 +---------------------------+
790 | BlockDescriptor 0 |
791 +---------------------------+
792 | PrivateDataDesc 0 |
793 MemBase ---->+---------------------------+<----- BlockList
794
795 @param PeiServices General purpose services available to every PEIM.
796 @param BlockListBuffer Point to the buffer of Capsule Descriptor Variables.
797 @param MemoryBase Pointer to the base of a block of memory that we can walk
798 all over while trying to coalesce our buffers.
799 On output, this variable will hold the base address of
800 a coalesced capsule.
801 @param MemorySize Size of the memory region pointed to by MemoryBase.
802 On output, this variable will contain the size of the
803 coalesced capsule.
804
805 @retval EFI_NOT_FOUND If we could not find the capsule descriptors.
806
807 @retval EFI_BUFFER_TOO_SMALL
808 If we could not coalesce the capsule in the memory
809 region provided to us.
810
811 @retval EFI_SUCCESS Processed the capsule successfully.
812 **/
813 EFI_STATUS
814 EFIAPI
815 CapsuleDataCoalesce (
816 IN EFI_PEI_SERVICES **PeiServices,
817 IN EFI_PHYSICAL_ADDRESS *BlockListBuffer,
818 IN OUT VOID **MemoryBase,
819 IN OUT UINTN *MemorySize
820 )
821 {
822 VOID *NewCapsuleBase;
823 VOID *DataPtr;
824 UINT8 CapsuleIndex;
825 UINT8 *FreeMemBase;
826 UINT8 *DestPtr;
827 UINT8 *RelocPtr;
828 UINT32 CapsuleOffset[MAX_SUPPORT_CAPSULE_NUM];
829 UINT32 *AddDataPtr;
830 UINT32 CapsuleTimes;
831 UINT64 SizeLeft;
832 UINT64 CapsuleImageSize;
833 UINTN CapsuleSize;
834 UINTN DescriptorsSize;
835 UINTN FreeMemSize;
836 UINTN NumDescriptors;
837 BOOLEAN IsCorrupted;
838 BOOLEAN CapsuleBeginFlag;
839 EFI_STATUS Status;
840 EFI_CAPSULE_HEADER *CapsuleHeader;
841 EFI_CAPSULE_PEIM_PRIVATE_DATA PrivateData;
842 EFI_CAPSULE_PEIM_PRIVATE_DATA *PrivateDataPtr;
843 EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockList;
844 EFI_CAPSULE_BLOCK_DESCRIPTOR *CurrentBlockDesc;
845 EFI_CAPSULE_BLOCK_DESCRIPTOR *TempBlockDesc;
846 EFI_CAPSULE_BLOCK_DESCRIPTOR PrivateDataDesc[2];
847
848 CapsuleIndex = 0;
849 SizeLeft = 0;
850 CapsuleTimes = 0;
851 CapsuleImageSize = 0;
852 PrivateDataPtr = NULL;
853 AddDataPtr = NULL;
854 CapsuleHeader = NULL;
855 CapsuleBeginFlag = TRUE;
856 IsCorrupted = TRUE;
857 CapsuleSize = 0;
858 NumDescriptors = 0;
859
860 //
861 // Build capsule descriptors list
862 //
863 Status = BuildCapsuleDescriptors (BlockListBuffer, &BlockList);
864 if (EFI_ERROR (Status)) {
865 return Status;
866 }
867
868 DEBUG_CODE (
869 CapsuleTestPatternPreCoalesce (PeiServices, BlockList);
870 );
871
872 //
873 // Get the size of our descriptors and the capsule size. GetCapsuleInfo()
874 // returns the number of descriptors that actually point to data, so add
875 // one for a terminator. Do that below.
876 //
877 GetCapsuleInfo (BlockList, &NumDescriptors, &CapsuleSize);
878 if ((CapsuleSize == 0) || (NumDescriptors == 0)) {
879 return EFI_NOT_FOUND;
880 }
881
882 //
883 // Initialize our local copy of private data. When we're done, we'll create a
884 // descriptor for it as well so that it can be put into free memory without
885 // trashing anything.
886 //
887 PrivateData.Signature = EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE;
888 PrivateData.CapsuleSize = (UINT32) CapsuleSize;
889 PrivateDataDesc[0].Union.DataBlock = (EFI_PHYSICAL_ADDRESS) (UINTN) &PrivateData;
890 PrivateDataDesc[0].Length = sizeof (EFI_CAPSULE_PEIM_PRIVATE_DATA);
891 PrivateDataDesc[1].Union.DataBlock = (EFI_PHYSICAL_ADDRESS) (UINTN) BlockList;
892 PrivateDataDesc[1].Length = 0;
893 //
894 // In addition to PrivateDataDesc[1:0], one terminator is added
895 // See below RelocateBlockDescriptors()
896 //
897 NumDescriptors += 3;
898 CapsuleSize += sizeof (EFI_CAPSULE_PEIM_PRIVATE_DATA) + sizeof(CapsuleOffset) + sizeof(UINT32);
899 BlockList = PrivateDataDesc;
900 DescriptorsSize = NumDescriptors * sizeof (EFI_CAPSULE_BLOCK_DESCRIPTOR);
901
902 //
903 // Don't go below some min address. If the base is below it,
904 // then move it up and adjust the size accordingly.
905 //
906 DEBUG ((EFI_D_INFO, "Capsule Memory range from 0x%8X to 0x%8X\n", (UINTN) *MemoryBase, (UINTN)*MemoryBase + *MemorySize));
907 if ((UINTN)*MemoryBase < (UINTN) MIN_COALESCE_ADDR) {
908 if (((UINTN)*MemoryBase + *MemorySize) < (UINTN) MIN_COALESCE_ADDR) {
909 return EFI_BUFFER_TOO_SMALL;
910 } else {
911 *MemorySize = *MemorySize - ((UINTN) MIN_COALESCE_ADDR - (UINTN) *MemoryBase);
912 *MemoryBase = (VOID *) (UINTN) MIN_COALESCE_ADDR;
913 }
914 }
915
916 if (*MemorySize <= (CapsuleSize + DescriptorsSize)) {
917 return EFI_BUFFER_TOO_SMALL;
918 }
919
920 FreeMemBase = *MemoryBase;
921 FreeMemSize = *MemorySize;
922 DEBUG ((EFI_D_INFO, "Capsule Free Memory from 0x%8X to 0x%8X\n", (UINTN) FreeMemBase, (UINTN) FreeMemBase + FreeMemSize));
923
924 //
925 // Relocate all the block descriptors to low memory to make further
926 // processing easier.
927 //
928 BlockList = RelocateBlockDescriptors (PeiServices, BlockList, FreeMemBase, FreeMemSize);
929 if (BlockList == NULL) {
930 //
931 // Not enough room to relocate the descriptors
932 //
933 return EFI_BUFFER_TOO_SMALL;
934 }
935
936 //
937 // Take the top of memory for the capsule. Naturally align.
938 //
939 DestPtr = FreeMemBase + FreeMemSize - CapsuleSize;
940 DestPtr = (UINT8 *) ((UINTN) DestPtr &~ (UINTN) (sizeof (UINTN) - 1));
941 FreeMemBase = (UINT8 *) BlockList + DescriptorsSize;
942 FreeMemSize = (UINTN) DestPtr - (UINTN) FreeMemBase;
943 NewCapsuleBase = (VOID *) DestPtr;
944
945 //
946 // Move all the blocks to the top (high) of memory.
947 // Relocate all the obstructing blocks. Note that the block descriptors
948 // were coalesced when they were relocated, so we can just ++ the pointer.
949 //
950 CurrentBlockDesc = BlockList;
951 while ((CurrentBlockDesc->Length != 0) || (CurrentBlockDesc->Union.ContinuationPointer != (EFI_PHYSICAL_ADDRESS) (UINTN) NULL)) {
952 //
953 // See if any of the remaining capsule blocks are in the way
954 //
955 TempBlockDesc = CurrentBlockDesc;
956 while (TempBlockDesc->Length != 0) {
957 //
958 // Is this block in the way of where we want to copy the current descriptor to?
959 //
960 if (IsOverlapped (
961 (UINT8 *) DestPtr,
962 (UINTN) CurrentBlockDesc->Length,
963 (UINT8 *) (UINTN) TempBlockDesc->Union.DataBlock,
964 (UINTN) TempBlockDesc->Length
965 )) {
966 //
967 // Relocate the block
968 //
969 RelocPtr = FindFreeMem (BlockList, FreeMemBase, FreeMemSize, (UINTN) TempBlockDesc->Length);
970 if (RelocPtr == NULL) {
971 return EFI_BUFFER_TOO_SMALL;
972 }
973
974 CopyMem ((VOID *) RelocPtr, (VOID *) (UINTN) TempBlockDesc->Union.DataBlock, (UINTN) TempBlockDesc->Length);
975 DEBUG ((EFI_D_INFO, "Capsule reloc data block from 0x%8X to 0x%8X with size 0x%8X\n",
976 (UINTN) TempBlockDesc->Union.DataBlock, (UINTN) RelocPtr, (UINTN) TempBlockDesc->Length));
977
978 TempBlockDesc->Union.DataBlock = (EFI_PHYSICAL_ADDRESS) (UINTN) RelocPtr;
979 }
980 //
981 // Next descriptor
982 //
983 TempBlockDesc++;
984 }
985 //
986 // Ok, we made it through. Copy the block.
987 // we just support greping one capsule from the lists of block descs list.
988 //
989 CapsuleTimes ++;
990 //
991 //Skip the first block descriptor that filled with EFI_CAPSULE_PEIM_PRIVATE_DATA
992 //
993 if (CapsuleTimes > 1) {
994 //
995 //For every capsule entry point, check its header to determine whether to relocate it.
996 //If it is invalid, skip it and move on to the next capsule. If it is valid, relocate it.
997 //
998 if (CapsuleBeginFlag) {
999 CapsuleBeginFlag = FALSE;
1000 CapsuleHeader = (EFI_CAPSULE_HEADER*)(UINTN)CurrentBlockDesc->Union.DataBlock;
1001 SizeLeft = CapsuleHeader->CapsuleImageSize;
1002 if (!IsCapsuleCorrupted (CapsuleHeader)) {
1003
1004 if (CapsuleIndex > (MAX_SUPPORT_CAPSULE_NUM - 1)) {
1005 DEBUG ((EFI_D_ERROR, "Capsule number exceeds the max number of %d!\n", MAX_SUPPORT_CAPSULE_NUM));
1006 return EFI_BUFFER_TOO_SMALL;
1007 }
1008
1009 //
1010 // Relocate this valid capsule
1011 //
1012 IsCorrupted = FALSE;
1013 CapsuleImageSize += SizeLeft;
1014 //
1015 // Cache the begin offset of this capsule
1016 //
1017 CapsuleOffset[CapsuleIndex++] = (UINT32) (UINTN) DestPtr - (UINT32)(UINTN)NewCapsuleBase - (UINT32)sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA);
1018 }
1019 }
1020
1021 if (CurrentBlockDesc->Length < SizeLeft) {
1022 if (!IsCorrupted) {
1023 CopyMem ((VOID *) DestPtr, (VOID *) (UINTN) (CurrentBlockDesc->Union.DataBlock), (UINTN)CurrentBlockDesc->Length);
1024 DEBUG ((EFI_D_INFO, "Capsule coalesce block no.0x%8X from 0x%8lX to 0x%8lX with size 0x%8X\n",CapsuleTimes,
1025 (UINTN)CurrentBlockDesc->Union.DataBlock, (UINTN)DestPtr, (UINTN)CurrentBlockDesc->Length));
1026 DestPtr += CurrentBlockDesc->Length;
1027 }
1028 SizeLeft -= CurrentBlockDesc->Length;
1029 } else {
1030 //
1031 //Here is the end of the current capsule image.
1032 //
1033 if (!IsCorrupted) {
1034 CopyMem ((VOID *) DestPtr, (VOID *)(UINTN)(CurrentBlockDesc->Union.DataBlock), (UINTN) SizeLeft);
1035 DEBUG ((EFI_D_INFO, "Capsule coalesce block no.0x%8X from 0x%8lX to 0x%8lX with size 0x%8X\n",CapsuleTimes,
1036 (UINTN)CurrentBlockDesc->Union.DataBlock, (UINTN)DestPtr, (UINTN) SizeLeft));
1037 DestPtr += SizeLeft;
1038 }
1039 //
1040 // Start the next cycle
1041 //
1042 SizeLeft = 0;
1043 IsCorrupted = TRUE;
1044 CapsuleBeginFlag = TRUE;
1045 }
1046 } else {
1047 //
1048 //The first entry is the block descriptor for EFI_CAPSULE_PEIM_PRIVATE_DATA.
1049 //
1050 CopyMem ((VOID *) DestPtr, (VOID *) (UINTN) CurrentBlockDesc->Union.DataBlock, (UINTN) CurrentBlockDesc->Length);
1051 DestPtr += CurrentBlockDesc->Length;
1052 }
1053 //
1054 //Walk through the block descriptor list.
1055 //
1056 CurrentBlockDesc++;
1057 }
1058 //
1059 // We return the base of memory we want reserved, and the size.
1060 // The memory peim should handle it appropriately from there.
1061 //
1062 *MemorySize = (UINTN) CapsuleSize;
1063 *MemoryBase = (VOID *) NewCapsuleBase;
1064
1065 //
1066 //Append the offsets of mutiply capsules to the continous buffer
1067 //
1068 DataPtr = (VOID*)((UINTN)NewCapsuleBase + sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA) + (UINTN)CapsuleImageSize);
1069 AddDataPtr = (UINT32*)(((UINTN) DataPtr + sizeof(UINT32) - 1) &~ (UINT32) (sizeof (UINT32) - 1));
1070
1071 *AddDataPtr++ = CapsuleIndex;
1072
1073 CopyMem (AddDataPtr, &CapsuleOffset[0], sizeof (UINT32) * CapsuleIndex);
1074
1075 PrivateDataPtr = (EFI_CAPSULE_PEIM_PRIVATE_DATA *) NewCapsuleBase;
1076 PrivateDataPtr->CapsuleSize = (UINT32) CapsuleImageSize;
1077
1078 return EFI_SUCCESS;
1079 }
EFI Development Kit II mirror for PVE