?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Comments for CoreInitializeMemoryServices should be updated
[edk2.git] / MdeModulePkg / Core / Dxe / Gcd / Gcd.c
blob88a11a6ffc0d3724da75f4960f1c8f163a21c8af
1 /** @file
2 The file contains the GCD related services in the EFI Boot Services Table.
3 The GCD services are used to manage the memory and I/O regions that
4 are accessible to the CPU that is executing the DXE core.
5
6 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
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.
14
15 **/
16
17 #include "DxeMain.h"
18
19 #define MINIMUM_INITIAL_MEMORY_SIZE 0x10000
20
21 #define MEMORY_ATTRIBUTE_MASK (EFI_RESOURCE_ATTRIBUTE_PRESENT | \
22 EFI_RESOURCE_ATTRIBUTE_INITIALIZED | \
23 EFI_RESOURCE_ATTRIBUTE_TESTED | \
24 EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED | \
25 EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED | \
26 EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED | \
27 EFI_RESOURCE_ATTRIBUTE_16_BIT_IO | \
28 EFI_RESOURCE_ATTRIBUTE_32_BIT_IO | \
29 EFI_RESOURCE_ATTRIBUTE_64_BIT_IO )
30
31 #define TESTED_MEMORY_ATTRIBUTES (EFI_RESOURCE_ATTRIBUTE_PRESENT | \
32 EFI_RESOURCE_ATTRIBUTE_INITIALIZED | \
33 EFI_RESOURCE_ATTRIBUTE_TESTED )
34
35 #define INITIALIZED_MEMORY_ATTRIBUTES (EFI_RESOURCE_ATTRIBUTE_PRESENT | \
36 EFI_RESOURCE_ATTRIBUTE_INITIALIZED )
37
38 #define PRESENT_MEMORY_ATTRIBUTES (EFI_RESOURCE_ATTRIBUTE_PRESENT)
39
40 #define INVALID_CPU_ARCH_ATTRIBUTES 0xffffffff
41
42 //
43 // Module Variables
44 //
45 EFI_LOCK mGcdMemorySpaceLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);
46 EFI_LOCK mGcdIoSpaceLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);
47 LIST_ENTRY mGcdMemorySpaceMap = INITIALIZE_LIST_HEAD_VARIABLE (mGcdMemorySpaceMap);
48 LIST_ENTRY mGcdIoSpaceMap = INITIALIZE_LIST_HEAD_VARIABLE (mGcdIoSpaceMap);
49
50 EFI_GCD_MAP_ENTRY mGcdMemorySpaceMapEntryTemplate = {
51 EFI_GCD_MAP_SIGNATURE,
52 {
53 NULL,
54 NULL
55 },
56 0,
57 0,
58 0,
59 0,
60 EfiGcdMemoryTypeNonExistent,
61 (EFI_GCD_IO_TYPE) 0,
62 NULL,
63 NULL
64 };
65
66 EFI_GCD_MAP_ENTRY mGcdIoSpaceMapEntryTemplate = {
67 EFI_GCD_MAP_SIGNATURE,
68 {
69 NULL,
70 NULL
71 },
72 0,
73 0,
74 0,
75 0,
76 (EFI_GCD_MEMORY_TYPE) 0,
77 EfiGcdIoTypeNonExistent,
78 NULL,
79 NULL
80 };
81
82 GCD_ATTRIBUTE_CONVERSION_ENTRY mAttributeConversionTable[] = {
83 { EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE, EFI_MEMORY_UC, TRUE },
84 { EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED, EFI_MEMORY_UCE, TRUE },
85 { EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE, EFI_MEMORY_WC, TRUE },
86 { EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE, EFI_MEMORY_WT, TRUE },
87 { EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE, EFI_MEMORY_WB, TRUE },
88 { EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED, EFI_MEMORY_RP, TRUE },
89 { EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED, EFI_MEMORY_WP, TRUE },
90 { EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED, EFI_MEMORY_XP, TRUE },
91 { EFI_RESOURCE_ATTRIBUTE_PRESENT, EFI_MEMORY_PRESENT, FALSE },
92 { EFI_RESOURCE_ATTRIBUTE_INITIALIZED, EFI_MEMORY_INITIALIZED, FALSE },
93 { EFI_RESOURCE_ATTRIBUTE_TESTED, EFI_MEMORY_TESTED, FALSE },
94 { 0, 0, FALSE }
95 };
96
97
98 /**
99 Acquire memory lock on mGcdMemorySpaceLock.
100
101 **/
102 VOID
103 CoreAcquireGcdMemoryLock (
104 VOID
105 )
106 {
107 CoreAcquireLock (&mGcdMemorySpaceLock);
108 }
109
110
111
112 /**
113 Release memory lock on mGcdMemorySpaceLock.
114
115 **/
116 VOID
117 CoreReleaseGcdMemoryLock (
118 VOID
119 )
120 {
121 CoreReleaseLock (&mGcdMemorySpaceLock);
122 }
123
124
125
126 /**
127 Acquire memory lock on mGcdIoSpaceLock.
128
129 **/
130 VOID
131 CoreAcquireGcdIoLock (
132 VOID
133 )
134 {
135 CoreAcquireLock (&mGcdIoSpaceLock);
136 }
137
138
139 /**
140 Release memory lock on mGcdIoSpaceLock.
141
142 **/
143 VOID
144 CoreReleaseGcdIoLock (
145 VOID
146 )
147 {
148 CoreReleaseLock (&mGcdIoSpaceLock);
149 }
150
151
152
153 //
154 // GCD Initialization Worker Functions
155 //
156 /**
157 Aligns a value to the specified boundary.
158
159 @param Value 64 bit value to align
160 @param Alignment Log base 2 of the boundary to align Value to
161 @param RoundUp TRUE if Value is to be rounded up to the nearest
162 aligned boundary. FALSE is Value is to be
163 rounded down to the nearest aligned boundary.
164
165 @return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.
166
167 **/
168 UINT64
169 AlignValue (
170 IN UINT64 Value,
171 IN UINTN Alignment,
172 IN BOOLEAN RoundUp
173 )
174 {
175 UINT64 AlignmentMask;
176
177 AlignmentMask = LShiftU64 (1, Alignment) - 1;
178 if (RoundUp) {
179 Value += AlignmentMask;
180 }
181 return Value & (~AlignmentMask);
182 }
183
184
185 /**
186 Aligns address to the page boundary.
187
188 @param Value 64 bit address to align
189
190 @return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.
191
192 **/
193 UINT64
194 PageAlignAddress (
195 IN UINT64 Value
196 )
197 {
198 return AlignValue (Value, EFI_PAGE_SHIFT, TRUE);
199 }
200
201
202 /**
203 Aligns length to the page boundary.
204
205 @param Value 64 bit length to align
206
207 @return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.
208
209 **/
210 UINT64
211 PageAlignLength (
212 IN UINT64 Value
213 )
214 {
215 return AlignValue (Value, EFI_PAGE_SHIFT, FALSE);
216 }
217
218 //
219 // GCD Memory Space Worker Functions
220 //
221
222 /**
223 Allocate pool for two entries.
224
225 @param TopEntry An entry of GCD map
226 @param BottomEntry An entry of GCD map
227
228 @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.
229 @retval EFI_SUCCESS Both entries successfully allocated.
230
231 **/
232 EFI_STATUS
233 CoreAllocateGcdMapEntry (
234 IN OUT EFI_GCD_MAP_ENTRY **TopEntry,
235 IN OUT EFI_GCD_MAP_ENTRY **BottomEntry
236 )
237 {
238 *TopEntry = AllocateZeroPool (sizeof (EFI_GCD_MAP_ENTRY));
239 if (*TopEntry == NULL) {
240 return EFI_OUT_OF_RESOURCES;
241 }
242
243 *BottomEntry = AllocateZeroPool (sizeof (EFI_GCD_MAP_ENTRY));
244 if (*BottomEntry == NULL) {
245 CoreFreePool (*TopEntry);
246 return EFI_OUT_OF_RESOURCES;
247 }
248
249 return EFI_SUCCESS;
250 }
251
252
253 /**
254 Internal function. Inserts a new descriptor into a sorted list
255
256 @param Link The linked list to insert the range BaseAddress
257 and Length into
258 @param Entry A pointer to the entry that is inserted
259 @param BaseAddress The base address of the new range
260 @param Length The length of the new range in bytes
261 @param TopEntry Top pad entry to insert if needed.
262 @param BottomEntry Bottom pad entry to insert if needed.
263
264 @retval EFI_SUCCESS The new range was inserted into the linked list
265
266 **/
267 EFI_STATUS
268 CoreInsertGcdMapEntry (
269 IN LIST_ENTRY *Link,
270 IN EFI_GCD_MAP_ENTRY *Entry,
271 IN EFI_PHYSICAL_ADDRESS BaseAddress,
272 IN UINT64 Length,
273 IN EFI_GCD_MAP_ENTRY *TopEntry,
274 IN EFI_GCD_MAP_ENTRY *BottomEntry
275 )
276 {
277 ASSERT (Length != 0);
278 ASSERT (TopEntry->Signature == 0);
279 ASSERT (BottomEntry->Signature == 0);
280
281 if (BaseAddress > Entry->BaseAddress) {
282 CopyMem (BottomEntry, Entry, sizeof (EFI_GCD_MAP_ENTRY));
283 Entry->BaseAddress = BaseAddress;
284 BottomEntry->EndAddress = BaseAddress - 1;
285 InsertTailList (Link, &BottomEntry->Link);
286 }
287
288 if ((BaseAddress + Length - 1) < Entry->EndAddress) {
289 CopyMem (TopEntry, Entry, sizeof (EFI_GCD_MAP_ENTRY));
290 TopEntry->BaseAddress = BaseAddress + Length;
291 Entry->EndAddress = BaseAddress + Length - 1;
292 InsertHeadList (Link, &TopEntry->Link);
293 }
294
295 return EFI_SUCCESS;
296 }
297
298
299 /**
300 Merge the Gcd region specified by Link and its adjacent entry.
301
302 @param Link Specify the entry to be merged (with its
303 adjacent entry).
304 @param Forward Direction (forward or backward).
305 @param Map Boundary.
306
307 @retval EFI_SUCCESS Successfully returned.
308 @retval EFI_UNSUPPORTED These adjacent regions could not merge.
309
310 **/
311 EFI_STATUS
312 CoreMergeGcdMapEntry (
313 IN LIST_ENTRY *Link,
314 IN BOOLEAN Forward,
315 IN LIST_ENTRY *Map
316 )
317 {
318 LIST_ENTRY *AdjacentLink;
319 EFI_GCD_MAP_ENTRY *Entry;
320 EFI_GCD_MAP_ENTRY *AdjacentEntry;
321
322 //
323 // Get adjacent entry
324 //
325 if (Forward) {
326 AdjacentLink = Link->ForwardLink;
327 } else {
328 AdjacentLink = Link->BackLink;
329 }
330
331 //
332 // If AdjacentLink is the head of the list, then no merge can be performed
333 //
334 if (AdjacentLink == Map) {
335 return EFI_SUCCESS;
336 }
337
338 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
339 AdjacentEntry = CR (AdjacentLink, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
340
341 if (Entry->Capabilities != AdjacentEntry->Capabilities) {
342 return EFI_UNSUPPORTED;
343 }
344 if (Entry->Attributes != AdjacentEntry->Attributes) {
345 return EFI_UNSUPPORTED;
346 }
347 if (Entry->GcdMemoryType != AdjacentEntry->GcdMemoryType) {
348 return EFI_UNSUPPORTED;
349 }
350 if (Entry->GcdIoType != AdjacentEntry->GcdIoType) {
351 return EFI_UNSUPPORTED;
352 }
353 if (Entry->ImageHandle != AdjacentEntry->ImageHandle) {
354 return EFI_UNSUPPORTED;
355 }
356 if (Entry->DeviceHandle != AdjacentEntry->DeviceHandle) {
357 return EFI_UNSUPPORTED;
358 }
359
360 if (Forward) {
361 Entry->EndAddress = AdjacentEntry->EndAddress;
362 } else {
363 Entry->BaseAddress = AdjacentEntry->BaseAddress;
364 }
365 RemoveEntryList (AdjacentLink);
366 CoreFreePool (AdjacentEntry);
367
368 return EFI_SUCCESS;
369 }
370
371
372 /**
373 Merge adjacent entries on total chain.
374
375 @param TopEntry Top entry of GCD map.
376 @param BottomEntry Bottom entry of GCD map.
377 @param StartLink Start link of the list for this loop.
378 @param EndLink End link of the list for this loop.
379 @param Map Boundary.
380
381 @retval EFI_SUCCESS GCD map successfully cleaned up.
382
383 **/
384 EFI_STATUS
385 CoreCleanupGcdMapEntry (
386 IN EFI_GCD_MAP_ENTRY *TopEntry,
387 IN EFI_GCD_MAP_ENTRY *BottomEntry,
388 IN LIST_ENTRY *StartLink,
389 IN LIST_ENTRY *EndLink,
390 IN LIST_ENTRY *Map
391 )
392 {
393 LIST_ENTRY *Link;
394
395 if (TopEntry->Signature == 0) {
396 CoreFreePool (TopEntry);
397 }
398 if (BottomEntry->Signature == 0) {
399 CoreFreePool (BottomEntry);
400 }
401
402 Link = StartLink;
403 while (Link != EndLink->ForwardLink) {
404 CoreMergeGcdMapEntry (Link, FALSE, Map);
405 Link = Link->ForwardLink;
406 }
407 CoreMergeGcdMapEntry (EndLink, TRUE, Map);
408
409 return EFI_SUCCESS;
410 }
411
412
413 /**
414 Search a segment of memory space in GCD map. The result is a range of GCD entry list.
415
416 @param BaseAddress The start address of the segment.
417 @param Length The length of the segment.
418 @param StartLink The first GCD entry involves this segment of
419 memory space.
420 @param EndLink The first GCD entry involves this segment of
421 memory space.
422 @param Map Points to the start entry to search.
423
424 @retval EFI_SUCCESS Successfully found the entry.
425 @retval EFI_NOT_FOUND Not found.
426
427 **/
428 EFI_STATUS
429 CoreSearchGcdMapEntry (
430 IN EFI_PHYSICAL_ADDRESS BaseAddress,
431 IN UINT64 Length,
432 OUT LIST_ENTRY **StartLink,
433 OUT LIST_ENTRY **EndLink,
434 IN LIST_ENTRY *Map
435 )
436 {
437 LIST_ENTRY *Link;
438 EFI_GCD_MAP_ENTRY *Entry;
439
440 ASSERT (Length != 0);
441
442 *StartLink = NULL;
443 *EndLink = NULL;
444
445 Link = Map->ForwardLink;
446 while (Link != Map) {
447 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
448 if (BaseAddress >= Entry->BaseAddress && BaseAddress <= Entry->EndAddress) {
449 *StartLink = Link;
450 }
451 if (*StartLink != NULL) {
452 if ((BaseAddress + Length - 1) >= Entry->BaseAddress &&
453 (BaseAddress + Length - 1) <= Entry->EndAddress ) {
454 *EndLink = Link;
455 return EFI_SUCCESS;
456 }
457 }
458 Link = Link->ForwardLink;
459 }
460
461 return EFI_NOT_FOUND;
462 }
463
464
465 /**
466 Count the amount of GCD map entries.
467
468 @param Map Points to the start entry to do the count loop.
469
470 @return The count.
471
472 **/
473 UINTN
474 CoreCountGcdMapEntry (
475 IN LIST_ENTRY *Map
476 )
477 {
478 UINTN Count;
479 LIST_ENTRY *Link;
480
481 Count = 0;
482 Link = Map->ForwardLink;
483 while (Link != Map) {
484 Count++;
485 Link = Link->ForwardLink;
486 }
487
488 return Count;
489 }
490
491
492
493 /**
494 Return the memory attribute specified by Attributes
495
496 @param Attributes A num with some attribute bits on.
497
498 @return The enum value of memory attribute.
499
500 **/
501 UINT64
502 ConverToCpuArchAttributes (
503 UINT64 Attributes
504 )
505 {
506 if ( (Attributes & EFI_MEMORY_UC) == EFI_MEMORY_UC) {
507 return EFI_MEMORY_UC;
508 }
509
510 if ( (Attributes & EFI_MEMORY_WC ) == EFI_MEMORY_WC) {
511 return EFI_MEMORY_WC;
512 }
513
514 if ( (Attributes & EFI_MEMORY_WT ) == EFI_MEMORY_WT) {
515 return EFI_MEMORY_WT;
516 }
517
518 if ( (Attributes & EFI_MEMORY_WB) == EFI_MEMORY_WB) {
519 return EFI_MEMORY_WB;
520 }
521
522 if ( (Attributes & EFI_MEMORY_WP) == EFI_MEMORY_WP) {
523 return EFI_MEMORY_WP;
524 }
525
526 return INVALID_CPU_ARCH_ATTRIBUTES;
527
528 }
529
530
531 /**
532 Do operation on a segment of memory space specified (add, free, remove, change attribute ...).
533
534 @param Operation The type of the operation
535 @param GcdMemoryType Additional information for the operation
536 @param GcdIoType Additional information for the operation
537 @param BaseAddress Start address of the segment
538 @param Length length of the segment
539 @param Capabilities The alterable attributes of a newly added entry
540 @param Attributes The attributes needs to be set
541
542 @retval EFI_INVALID_PARAMETER Length is 0 or address (length) not aligned when
543 setting attribute.
544 @retval EFI_SUCCESS Action successfully done.
545 @retval EFI_UNSUPPORTED Could not find the proper descriptor on this
546 segment or set an upsupported attribute.
547 @retval EFI_ACCESS_DENIED Operate on an space non-exist or is used for an
548 image.
549 @retval EFI_NOT_FOUND Free a non-using space or remove a non-exist
550 space, and so on.
551 @retval EFI_OUT_OF_RESOURCES No buffer could be allocated.
552
553 **/
554 EFI_STATUS
555 CoreConvertSpace (
556 IN UINTN Operation,
557 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
558 IN EFI_GCD_IO_TYPE GcdIoType,
559 IN EFI_PHYSICAL_ADDRESS BaseAddress,
560 IN UINT64 Length,
561 IN UINT64 Capabilities,
562 IN UINT64 Attributes
563 )
564 {
565 EFI_STATUS Status;
566 LIST_ENTRY *Map;
567 LIST_ENTRY *Link;
568 EFI_GCD_MAP_ENTRY *Entry;
569 EFI_GCD_MAP_ENTRY *TopEntry;
570 EFI_GCD_MAP_ENTRY *BottomEntry;
571 LIST_ENTRY *StartLink;
572 LIST_ENTRY *EndLink;
573
574 EFI_CPU_ARCH_PROTOCOL *CpuArch;
575 UINT64 CpuArchAttributes;
576
577 if (Length == 0) {
578 return EFI_INVALID_PARAMETER;
579 }
580
581 Map = NULL;
582 if ((Operation & GCD_MEMORY_SPACE_OPERATION) != 0) {
583 CoreAcquireGcdMemoryLock ();
584 Map = &mGcdMemorySpaceMap;
585 }
586 if ((Operation & GCD_IO_SPACE_OPERATION) != 0) {
587 CoreAcquireGcdIoLock ();
588 Map = &mGcdIoSpaceMap;
589 }
590
591 //
592 // Search for the list of descriptors that cover the range BaseAddress to BaseAddress+Length
593 //
594 Status = CoreSearchGcdMapEntry (BaseAddress, Length, &StartLink, &EndLink, Map);
595 if (EFI_ERROR (Status)) {
596 Status = EFI_UNSUPPORTED;
597
598 goto Done;
599 }
600
601 //
602 // Verify that the list of descriptors are unallocated non-existent memory.
603 //
604 Link = StartLink;
605 while (Link != EndLink->ForwardLink) {
606 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
607 switch (Operation) {
608 //
609 // Add operations
610 //
611 case GCD_ADD_MEMORY_OPERATION:
612 if (Entry->GcdMemoryType != EfiGcdMemoryTypeNonExistent ||
613 Entry->ImageHandle != NULL ) {
614 Status = EFI_ACCESS_DENIED;
615 goto Done;
616 }
617 break;
618 case GCD_ADD_IO_OPERATION:
619 if (Entry->GcdIoType != EfiGcdIoTypeNonExistent ||
620 Entry->ImageHandle != NULL ) {
621 Status = EFI_ACCESS_DENIED;
622 goto Done;
623 }
624 break;
625 //
626 // Free operations
627 //
628 case GCD_FREE_MEMORY_OPERATION:
629 case GCD_FREE_IO_OPERATION:
630 if (Entry->ImageHandle == NULL) {
631 Status = EFI_NOT_FOUND;
632 goto Done;
633 }
634 break;
635 //
636 // Remove operations
637 //
638 case GCD_REMOVE_MEMORY_OPERATION:
639 if (Entry->GcdMemoryType == EfiGcdMemoryTypeNonExistent) {
640 Status = EFI_NOT_FOUND;
641 goto Done;
642 }
643 if (Entry->ImageHandle != NULL) {
644 Status = EFI_ACCESS_DENIED;
645 goto Done;
646 }
647 break;
648 case GCD_REMOVE_IO_OPERATION:
649 if (Entry->GcdIoType == EfiGcdIoTypeNonExistent) {
650 Status = EFI_NOT_FOUND;
651 goto Done;
652 }
653 if (Entry->ImageHandle != NULL) {
654 Status = EFI_ACCESS_DENIED;
655 goto Done;
656 }
657 break;
658 //
659 // Set attribute operations
660 //
661 case GCD_SET_ATTRIBUTES_MEMORY_OPERATION:
662 if ((Attributes & EFI_MEMORY_RUNTIME) != 0) {
663 if ((BaseAddress & EFI_PAGE_MASK) != 0 || (Length & EFI_PAGE_MASK) != 0) {
664 Status = EFI_INVALID_PARAMETER;
665 goto Done;
666 }
667 }
668 if ((Entry->Capabilities & Attributes) != Attributes) {
669 Status = EFI_UNSUPPORTED;
670 goto Done;
671 }
672 break;
673 }
674 Link = Link->ForwardLink;
675 }
676
677 //
678 // Allocate work space to perform this operation
679 //
680 Status = CoreAllocateGcdMapEntry (&TopEntry, &BottomEntry);
681 if (EFI_ERROR (Status)) {
682 Status = EFI_OUT_OF_RESOURCES;
683 goto Done;
684 }
685
686 if (Operation == GCD_SET_ATTRIBUTES_MEMORY_OPERATION) {
687 //
688 // Call CPU Arch Protocol to attempt to set attributes on the range
689 //
690 CpuArchAttributes = ConverToCpuArchAttributes (Attributes);
691 if ( CpuArchAttributes != INVALID_CPU_ARCH_ATTRIBUTES ) {
692 Status = CoreLocateProtocol (&gEfiCpuArchProtocolGuid, NULL, (VOID **)&CpuArch);
693 if (EFI_ERROR (Status)) {
694 Status = EFI_ACCESS_DENIED;
695 goto Done;
696 }
697
698 Status = CpuArch->SetMemoryAttributes (
699 CpuArch,
700 BaseAddress,
701 Length,
702 CpuArchAttributes
703 );
704 if (EFI_ERROR (Status)) {
705 goto Done;
706 }
707 }
708
709 }
710
711 //
712 // Convert/Insert the list of descriptors from StartLink to EndLink
713 //
714 Link = StartLink;
715 while (Link != EndLink->ForwardLink) {
716 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
717 CoreInsertGcdMapEntry (Link, Entry, BaseAddress, Length, TopEntry, BottomEntry);
718 switch (Operation) {
719 //
720 // Add operations
721 //
722 case GCD_ADD_MEMORY_OPERATION:
723 Entry->GcdMemoryType = GcdMemoryType;
724 if (GcdMemoryType == EfiGcdMemoryTypeMemoryMappedIo) {
725 Entry->Capabilities = Capabilities | EFI_MEMORY_RUNTIME | EFI_MEMORY_PORT_IO;
726 } else {
727 Entry->Capabilities = Capabilities | EFI_MEMORY_RUNTIME;
728 }
729 break;
730 case GCD_ADD_IO_OPERATION:
731 Entry->GcdIoType = GcdIoType;
732 break;
733 //
734 // Free operations
735 //
736 case GCD_FREE_MEMORY_OPERATION:
737 case GCD_FREE_IO_OPERATION:
738 Entry->ImageHandle = NULL;
739 Entry->DeviceHandle = NULL;
740 break;
741 //
742 // Remove operations
743 //
744 case GCD_REMOVE_MEMORY_OPERATION:
745 Entry->GcdMemoryType = EfiGcdMemoryTypeNonExistent;
746 Entry->Capabilities = 0;
747 break;
748 case GCD_REMOVE_IO_OPERATION:
749 Entry->GcdIoType = EfiGcdIoTypeNonExistent;
750 break;
751 //
752 // Set attribute operations
753 //
754 case GCD_SET_ATTRIBUTES_MEMORY_OPERATION:
755 Entry->Attributes = Attributes;
756 break;
757 }
758 Link = Link->ForwardLink;
759 }
760
761 //
762 // Cleanup
763 //
764 Status = CoreCleanupGcdMapEntry (TopEntry, BottomEntry, StartLink, EndLink, Map);
765
766 Done:
767 if ((Operation & GCD_MEMORY_SPACE_OPERATION) != 0) {
768 CoreReleaseGcdMemoryLock ();
769 }
770 if ((Operation & GCD_IO_SPACE_OPERATION) != 0) {
771 CoreReleaseGcdIoLock ();
772 }
773
774 return Status;
775 }
776
777
778 /**
779 Check whether an entry could be used to allocate space.
780
781 @param Operation Allocate memory or IO
782 @param Entry The entry to be tested
783 @param GcdMemoryType The desired memory type
784 @param GcdIoType The desired IO type
785
786 @retval EFI_NOT_FOUND The memory type does not match or there's an
787 image handle on the entry.
788 @retval EFI_UNSUPPORTED The operation unsupported.
789 @retval EFI_SUCCESS It's ok for this entry to be used to allocate
790 space.
791
792 **/
793 EFI_STATUS
794 CoreAllocateSpaceCheckEntry (
795 IN UINTN Operation,
796 IN EFI_GCD_MAP_ENTRY *Entry,
797 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
798 IN EFI_GCD_IO_TYPE GcdIoType
799 )
800 {
801 if (Entry->ImageHandle != NULL) {
802 return EFI_NOT_FOUND;
803 }
804 switch (Operation) {
805 case GCD_ALLOCATE_MEMORY_OPERATION:
806 if (Entry->GcdMemoryType != GcdMemoryType) {
807 return EFI_NOT_FOUND;
808 }
809 break;
810 case GCD_ALLOCATE_IO_OPERATION:
811 if (Entry->GcdIoType != GcdIoType) {
812 return EFI_NOT_FOUND;
813 }
814 break;
815 default:
816 return EFI_UNSUPPORTED;
817 }
818 return EFI_SUCCESS;
819 }
820
821
822 /**
823 Allocate space on specified address and length.
824
825 @param Operation The type of operation (memory or IO)
826 @param GcdAllocateType The type of allocate operation
827 @param GcdMemoryType The desired memory type
828 @param GcdIoType The desired IO type
829 @param Alignment Align with 2^Alignment
830 @param Length Length to allocate
831 @param BaseAddress Base address to allocate
832 @param ImageHandle The image handle consume the allocated space.
833 @param DeviceHandle The device handle consume the allocated space.
834
835 @retval EFI_INVALID_PARAMETER Invalid parameter.
836 @retval EFI_NOT_FOUND No descriptor for the desired space exists.
837 @retval EFI_SUCCESS Space successfully allocated.
838
839 **/
840 EFI_STATUS
841 CoreAllocateSpace (
842 IN UINTN Operation,
843 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
844 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
845 IN EFI_GCD_IO_TYPE GcdIoType,
846 IN UINTN Alignment,
847 IN UINT64 Length,
848 IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
849 IN EFI_HANDLE ImageHandle,
850 IN EFI_HANDLE DeviceHandle OPTIONAL
851 )
852 {
853 EFI_STATUS Status;
854 EFI_PHYSICAL_ADDRESS AlignmentMask;
855 EFI_PHYSICAL_ADDRESS MaxAddress;
856 LIST_ENTRY *Map;
857 LIST_ENTRY *Link;
858 LIST_ENTRY *SubLink;
859 EFI_GCD_MAP_ENTRY *Entry;
860 EFI_GCD_MAP_ENTRY *TopEntry;
861 EFI_GCD_MAP_ENTRY *BottomEntry;
862 LIST_ENTRY *StartLink;
863 LIST_ENTRY *EndLink;
864 BOOLEAN Found;
865
866 //
867 // Make sure parameters are valid
868 //
869 if (GcdAllocateType < 0 || GcdAllocateType >= EfiGcdMaxAllocateType) {
870 return EFI_INVALID_PARAMETER;
871 }
872 if (GcdMemoryType < 0 || GcdMemoryType >= EfiGcdMemoryTypeMaximum) {
873 return EFI_INVALID_PARAMETER;
874 }
875 if (GcdIoType < 0 || GcdIoType >= EfiGcdIoTypeMaximum) {
876 return EFI_INVALID_PARAMETER;
877 }
878 if (BaseAddress == NULL) {
879 return EFI_INVALID_PARAMETER;
880 }
881 if (ImageHandle == NULL) {
882 return EFI_INVALID_PARAMETER;
883 }
884 if (Alignment >= 64) {
885 return EFI_NOT_FOUND;
886 }
887 if (Length == 0) {
888 return EFI_INVALID_PARAMETER;
889 }
890
891 Map = NULL;
892 if ((Operation & GCD_MEMORY_SPACE_OPERATION) != 0) {
893 CoreAcquireGcdMemoryLock ();
894 Map = &mGcdMemorySpaceMap;
895 }
896 if ((Operation & GCD_IO_SPACE_OPERATION) != 0) {
897 CoreAcquireGcdIoLock ();
898 Map = &mGcdIoSpaceMap;
899 }
900
901 Found = FALSE;
902 StartLink = NULL;
903 EndLink = NULL;
904 //
905 // Compute alignment bit mask
906 //
907 AlignmentMask = LShiftU64 (1, Alignment) - 1;
908
909 if (GcdAllocateType == EfiGcdAllocateAddress) {
910 //
911 // Verify that the BaseAddress passed in is aligned correctly
912 //
913 if ((*BaseAddress & AlignmentMask) != 0) {
914 Status = EFI_NOT_FOUND;
915 goto Done;
916 }
917
918 //
919 // Search for the list of descriptors that cover the range BaseAddress to BaseAddress+Length
920 //
921 Status = CoreSearchGcdMapEntry (*BaseAddress, Length, &StartLink, &EndLink, Map);
922 if (EFI_ERROR (Status)) {
923 Status = EFI_NOT_FOUND;
924 goto Done;
925 }
926
927 //
928 // Verify that the list of descriptors are unallocated memory matching GcdMemoryType.
929 //
930 Link = StartLink;
931 while (Link != EndLink->ForwardLink) {
932 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
933 Link = Link->ForwardLink;
934 Status = CoreAllocateSpaceCheckEntry (Operation, Entry, GcdMemoryType, GcdIoType);
935 if (EFI_ERROR (Status)) {
936 goto Done;
937 }
938 }
939 Found = TRUE;
940 } else {
941
942 Entry = CR (Map->BackLink, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
943
944 //
945 // Compute the maximum address to use in the search algorithm
946 //
947 if (GcdAllocateType == EfiGcdAllocateMaxAddressSearchBottomUp ||
948 GcdAllocateType == EfiGcdAllocateMaxAddressSearchTopDown ) {
949 MaxAddress = *BaseAddress;
950 } else {
951 MaxAddress = Entry->EndAddress;
952 }
953
954 //
955 // Verify that the list of descriptors are unallocated memory matching GcdMemoryType.
956 //
957 if (GcdAllocateType == EfiGcdAllocateMaxAddressSearchTopDown ||
958 GcdAllocateType == EfiGcdAllocateAnySearchTopDown ) {
959 Link = Map->BackLink;
960 } else {
961 Link = Map->ForwardLink;
962 }
963 while (Link != Map) {
964 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
965
966 if (GcdAllocateType == EfiGcdAllocateMaxAddressSearchTopDown ||
967 GcdAllocateType == EfiGcdAllocateAnySearchTopDown ) {
968 Link = Link->BackLink;
969 } else {
970 Link = Link->ForwardLink;
971 }
972
973 Status = CoreAllocateSpaceCheckEntry (Operation, Entry, GcdMemoryType, GcdIoType);
974 if (EFI_ERROR (Status)) {
975 continue;
976 }
977
978 if (GcdAllocateType == EfiGcdAllocateMaxAddressSearchTopDown ||
979 GcdAllocateType == EfiGcdAllocateAnySearchTopDown) {
980 if ((Entry->BaseAddress + Length) > MaxAddress) {
981 continue;
982 }
983 if (Length > (Entry->EndAddress + 1)) {
984 Status = EFI_NOT_FOUND;
985 goto Done;
986 }
987 if (Entry->EndAddress > MaxAddress) {
988 *BaseAddress = MaxAddress;
989 } else {
990 *BaseAddress = Entry->EndAddress;
991 }
992 *BaseAddress = (*BaseAddress + 1 - Length) & (~AlignmentMask);
993 } else {
994 *BaseAddress = (Entry->BaseAddress + AlignmentMask) & (~AlignmentMask);
995 if ((*BaseAddress + Length - 1) > MaxAddress) {
996 Status = EFI_NOT_FOUND;
997 goto Done;
998 }
999 }
1000
1001 //
1002 // Search for the list of descriptors that cover the range BaseAddress to BaseAddress+Length
1003 //
1004 Status = CoreSearchGcdMapEntry (*BaseAddress, Length, &StartLink, &EndLink, Map);
1005 if (EFI_ERROR (Status)) {
1006 Status = EFI_NOT_FOUND;
1007 goto Done;
1008 }
1009
1010 Link = StartLink;
1011 //
1012 // Verify that the list of descriptors are unallocated memory matching GcdMemoryType.
1013 //
1014 Found = TRUE;
1015 SubLink = StartLink;
1016 while (SubLink != EndLink->ForwardLink) {
1017 Entry = CR (SubLink, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1018 Status = CoreAllocateSpaceCheckEntry (Operation, Entry, GcdMemoryType, GcdIoType);
1019 if (EFI_ERROR (Status)) {
1020 Link = SubLink;
1021 Found = FALSE;
1022 break;
1023 }
1024 SubLink = SubLink->ForwardLink;
1025 }
1026 if (Found) {
1027 break;
1028 }
1029 }
1030 }
1031 if (!Found) {
1032 Status = EFI_NOT_FOUND;
1033 goto Done;
1034 }
1035
1036 //
1037 // Allocate work space to perform this operation
1038 //
1039 Status = CoreAllocateGcdMapEntry (&TopEntry, &BottomEntry);
1040 if (EFI_ERROR (Status)) {
1041 Status = EFI_OUT_OF_RESOURCES;
1042 goto Done;
1043 }
1044
1045 //
1046 // Convert/Insert the list of descriptors from StartLink to EndLink
1047 //
1048 Link = StartLink;
1049 while (Link != EndLink->ForwardLink) {
1050 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1051 CoreInsertGcdMapEntry (Link, Entry, *BaseAddress, Length, TopEntry, BottomEntry);
1052 Entry->ImageHandle = ImageHandle;
1053 Entry->DeviceHandle = DeviceHandle;
1054 Link = Link->ForwardLink;
1055 }
1056
1057 //
1058 // Cleanup
1059 //
1060 Status = CoreCleanupGcdMapEntry (TopEntry, BottomEntry, StartLink, EndLink, Map);
1061
1062 Done:
1063 if ((Operation & GCD_MEMORY_SPACE_OPERATION) != 0) {
1064 CoreReleaseGcdMemoryLock ();
1065 }
1066 if ((Operation & GCD_IO_SPACE_OPERATION) !=0) {
1067 CoreReleaseGcdIoLock ();
1068 }
1069
1070 return Status;
1071 }
1072
1073
1074 /**
1075 Add a segment of memory to GCD map.
1076
1077 @param GcdMemoryType Memory type of the segment.
1078 @param BaseAddress Base address of the segment.
1079 @param Length Length of the segment.
1080 @param Capabilities alterable attributes of the segment.
1081
1082 @retval EFI_INVALID_PARAMETER Invalid parameters.
1083 @retval EFI_SUCCESS Successfully add a segment of memory space.
1084
1085 **/
1086 EFI_STATUS
1087 CoreInternalAddMemorySpace (
1088 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
1089 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1090 IN UINT64 Length,
1091 IN UINT64 Capabilities
1092 )
1093 {
1094 //
1095 // Make sure parameters are valid
1096 //
1097 if (GcdMemoryType <= EfiGcdMemoryTypeNonExistent || GcdMemoryType >= EfiGcdMemoryTypeMaximum) {
1098 return EFI_INVALID_PARAMETER;
1099 }
1100
1101 return CoreConvertSpace (GCD_ADD_MEMORY_OPERATION, GcdMemoryType, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, Capabilities, 0);
1102 }
1103
1104 //
1105 // GCD Core Services
1106 //
1107
1108 /**
1109 Allocates nonexistent memory, reserved memory, system memory, or memorymapped
1110 I/O resources from the global coherency domain of the processor.
1111
1112 @param GcdAllocateType The type of allocate operation
1113 @param GcdMemoryType The desired memory type
1114 @param Alignment Align with 2^Alignment
1115 @param Length Length to allocate
1116 @param BaseAddress Base address to allocate
1117 @param ImageHandle The image handle consume the allocated space.
1118 @param DeviceHandle The device handle consume the allocated space.
1119
1120 @retval EFI_INVALID_PARAMETER Invalid parameter.
1121 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1122 @retval EFI_SUCCESS Memory space successfully allocated.
1123
1124 **/
1125 EFI_STATUS
1126 EFIAPI
1127 CoreAllocateMemorySpace (
1128 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
1129 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
1130 IN UINTN Alignment,
1131 IN UINT64 Length,
1132 IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
1133 IN EFI_HANDLE ImageHandle,
1134 IN EFI_HANDLE DeviceHandle OPTIONAL
1135 )
1136 {
1137 return CoreAllocateSpace (
1138 GCD_ALLOCATE_MEMORY_OPERATION,
1139 GcdAllocateType,
1140 GcdMemoryType,
1141 (EFI_GCD_IO_TYPE) 0,
1142 Alignment,
1143 Length,
1144 BaseAddress,
1145 ImageHandle,
1146 DeviceHandle
1147 );
1148 }
1149
1150
1151 /**
1152 Adds reserved memory, system memory, or memory-mapped I/O resources to the
1153 global coherency domain of the processor.
1154
1155 @param GcdMemoryType Memory type of the memory space.
1156 @param BaseAddress Base address of the memory space.
1157 @param Length Length of the memory space.
1158 @param Capabilities alterable attributes of the memory space.
1159
1160 @retval EFI_SUCCESS Merged this memory space into GCD map.
1161
1162 **/
1163 EFI_STATUS
1164 EFIAPI
1165 CoreAddMemorySpace (
1166 IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
1167 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1168 IN UINT64 Length,
1169 IN UINT64 Capabilities
1170 )
1171 {
1172 EFI_STATUS Status;
1173 EFI_PHYSICAL_ADDRESS PageBaseAddress;
1174 UINT64 PageLength;
1175
1176 Status = CoreInternalAddMemorySpace (GcdMemoryType, BaseAddress, Length, Capabilities);
1177
1178 if (!EFI_ERROR (Status) && GcdMemoryType == EfiGcdMemoryTypeSystemMemory) {
1179
1180 PageBaseAddress = PageAlignLength (BaseAddress);
1181 PageLength = PageAlignLength (BaseAddress + Length - PageBaseAddress);
1182
1183 Status = CoreAllocateMemorySpace (
1184 EfiGcdAllocateAddress,
1185 GcdMemoryType,
1186 EFI_PAGE_SHIFT,
1187 PageLength,
1188 &PageBaseAddress,
1189 gDxeCoreImageHandle,
1190 NULL
1191 );
1192
1193 if (!EFI_ERROR (Status)) {
1194 CoreAddMemoryDescriptor (
1195 EfiConventionalMemory,
1196 PageBaseAddress,
1197 RShiftU64 (PageLength, EFI_PAGE_SHIFT),
1198 Capabilities
1199 );
1200 } else {
1201 for (; PageLength != 0; PageLength -= EFI_PAGE_SIZE, PageBaseAddress += EFI_PAGE_SIZE) {
1202 Status = CoreAllocateMemorySpace (
1203 EfiGcdAllocateAddress,
1204 GcdMemoryType,
1205 EFI_PAGE_SHIFT,
1206 EFI_PAGE_SIZE,
1207 &PageBaseAddress,
1208 gDxeCoreImageHandle,
1209 NULL
1210 );
1211
1212 if (!EFI_ERROR (Status)) {
1213 CoreAddMemoryDescriptor (
1214 EfiConventionalMemory,
1215 PageBaseAddress,
1216 1,
1217 Capabilities
1218 );
1219 }
1220 }
1221 }
1222 }
1223 return Status;
1224 }
1225
1226
1227 /**
1228 Frees nonexistent memory, reserved memory, system memory, or memory-mapped
1229 I/O resources from the global coherency domain of the processor.
1230
1231 @param BaseAddress Base address of the memory space.
1232 @param Length Length of the memory space.
1233
1234 @retval EFI_SUCCESS Space successfully freed.
1235
1236 **/
1237 EFI_STATUS
1238 EFIAPI
1239 CoreFreeMemorySpace (
1240 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1241 IN UINT64 Length
1242 )
1243 {
1244 return CoreConvertSpace (GCD_FREE_MEMORY_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, 0, 0);
1245 }
1246
1247
1248 /**
1249 Removes reserved memory, system memory, or memory-mapped I/O resources from
1250 the global coherency domain of the processor.
1251
1252 @param BaseAddress Base address of the memory space.
1253 @param Length Length of the memory space.
1254
1255 @retval EFI_SUCCESS Successfully remove a segment of memory space.
1256
1257 **/
1258 EFI_STATUS
1259 EFIAPI
1260 CoreRemoveMemorySpace (
1261 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1262 IN UINT64 Length
1263 )
1264 {
1265 return CoreConvertSpace (GCD_REMOVE_MEMORY_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, 0, 0);
1266 }
1267
1268
1269 /**
1270 Build a memory descriptor according to an entry.
1271
1272 @param Descriptor The descriptor to be built
1273 @param Entry According to this entry
1274
1275 **/
1276 VOID
1277 BuildMemoryDescriptor (
1278 IN OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor,
1279 IN EFI_GCD_MAP_ENTRY *Entry
1280 )
1281 {
1282 Descriptor->BaseAddress = Entry->BaseAddress;
1283 Descriptor->Length = Entry->EndAddress - Entry->BaseAddress + 1;
1284 Descriptor->Capabilities = Entry->Capabilities;
1285 Descriptor->Attributes = Entry->Attributes;
1286 Descriptor->GcdMemoryType = Entry->GcdMemoryType;
1287 Descriptor->ImageHandle = Entry->ImageHandle;
1288 Descriptor->DeviceHandle = Entry->DeviceHandle;
1289 }
1290
1291
1292 /**
1293 Retrieves the descriptor for a memory region containing a specified address.
1294
1295 @param BaseAddress Specified start address
1296 @param Descriptor Specified length
1297
1298 @retval EFI_INVALID_PARAMETER Invalid parameter
1299 @retval EFI_SUCCESS Successfully get memory space descriptor.
1300
1301 **/
1302 EFI_STATUS
1303 EFIAPI
1304 CoreGetMemorySpaceDescriptor (
1305 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1306 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor
1307 )
1308 {
1309 EFI_STATUS Status;
1310 LIST_ENTRY *StartLink;
1311 LIST_ENTRY *EndLink;
1312 EFI_GCD_MAP_ENTRY *Entry;
1313
1314 //
1315 // Make sure parameters are valid
1316 //
1317 if (Descriptor == NULL) {
1318 return EFI_INVALID_PARAMETER;
1319 }
1320
1321 CoreAcquireGcdMemoryLock ();
1322
1323 //
1324 // Search for the list of descriptors that contain BaseAddress
1325 //
1326 Status = CoreSearchGcdMapEntry (BaseAddress, 1, &StartLink, &EndLink, &mGcdMemorySpaceMap);
1327 if (EFI_ERROR (Status)) {
1328 Status = EFI_NOT_FOUND;
1329 } else {
1330 //
1331 // Copy the contents of the found descriptor into Descriptor
1332 //
1333 Entry = CR (StartLink, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1334 BuildMemoryDescriptor (Descriptor, Entry);
1335 }
1336
1337 CoreReleaseGcdMemoryLock ();
1338
1339 return Status;
1340 }
1341
1342
1343 /**
1344 Modifies the attributes for a memory region in the global coherency domain of the
1345 processor.
1346
1347 @param BaseAddress Specified start address
1348 @param Length Specified length
1349 @param Attributes Specified attributes
1350
1351 @retval EFI_SUCCESS Successfully set attribute of a segment of
1352 memory space.
1353
1354 **/
1355 EFI_STATUS
1356 EFIAPI
1357 CoreSetMemorySpaceAttributes (
1358 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1359 IN UINT64 Length,
1360 IN UINT64 Attributes
1361 )
1362 {
1363 return CoreConvertSpace (GCD_SET_ATTRIBUTES_MEMORY_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, 0, Attributes);
1364 }
1365
1366
1367 /**
1368 Returns a map of the memory resources in the global coherency domain of the
1369 processor.
1370
1371 @param NumberOfDescriptors Number of descriptors.
1372 @param MemorySpaceMap Descriptor array
1373
1374 @retval EFI_INVALID_PARAMETER Invalid parameter
1375 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1376 @retval EFI_SUCCESS Successfully get memory space map.
1377
1378 **/
1379 EFI_STATUS
1380 EFIAPI
1381 CoreGetMemorySpaceMap (
1382 OUT UINTN *NumberOfDescriptors,
1383 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap
1384 )
1385 {
1386 EFI_STATUS Status;
1387 LIST_ENTRY *Link;
1388 EFI_GCD_MAP_ENTRY *Entry;
1389 EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor;
1390
1391 //
1392 // Make sure parameters are valid
1393 //
1394 if (NumberOfDescriptors == NULL) {
1395 return EFI_INVALID_PARAMETER;
1396 }
1397 if (MemorySpaceMap == NULL) {
1398 return EFI_INVALID_PARAMETER;
1399 }
1400
1401 CoreAcquireGcdMemoryLock ();
1402
1403 //
1404 // Count the number of descriptors
1405 //
1406 *NumberOfDescriptors = CoreCountGcdMapEntry (&mGcdMemorySpaceMap);
1407
1408 //
1409 // Allocate the MemorySpaceMap
1410 //
1411 *MemorySpaceMap = AllocatePool (*NumberOfDescriptors * sizeof (EFI_GCD_MEMORY_SPACE_DESCRIPTOR));
1412 if (*MemorySpaceMap == NULL) {
1413 Status = EFI_OUT_OF_RESOURCES;
1414 goto Done;
1415 }
1416
1417 //
1418 // Fill in the MemorySpaceMap
1419 //
1420 Descriptor = *MemorySpaceMap;
1421 Link = mGcdMemorySpaceMap.ForwardLink;
1422 while (Link != &mGcdMemorySpaceMap) {
1423 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1424 BuildMemoryDescriptor (Descriptor, Entry);
1425 Descriptor++;
1426 Link = Link->ForwardLink;
1427 }
1428 Status = EFI_SUCCESS;
1429
1430 Done:
1431 CoreReleaseGcdMemoryLock ();
1432 return Status;
1433 }
1434
1435
1436 /**
1437 Adds reserved I/O or I/O resources to the global coherency domain of the processor.
1438
1439 @param GcdIoType IO type of the segment.
1440 @param BaseAddress Base address of the segment.
1441 @param Length Length of the segment.
1442
1443 @retval EFI_SUCCESS Merged this segment into GCD map.
1444 @retval EFI_INVALID_PARAMETER Parameter not valid
1445
1446 **/
1447 EFI_STATUS
1448 EFIAPI
1449 CoreAddIoSpace (
1450 IN EFI_GCD_IO_TYPE GcdIoType,
1451 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1452 IN UINT64 Length
1453 )
1454 {
1455 //
1456 // Make sure parameters are valid
1457 //
1458 if (GcdIoType <= EfiGcdIoTypeNonExistent || GcdIoType >= EfiGcdIoTypeMaximum) {
1459 return EFI_INVALID_PARAMETER;
1460 }
1461 return CoreConvertSpace (GCD_ADD_IO_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, GcdIoType, BaseAddress, Length, 0, 0);
1462 }
1463
1464
1465 /**
1466 Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1467 domain of the processor.
1468
1469 @param GcdAllocateType The type of allocate operation
1470 @param GcdIoType The desired IO type
1471 @param Alignment Align with 2^Alignment
1472 @param Length Length to allocate
1473 @param BaseAddress Base address to allocate
1474 @param ImageHandle The image handle consume the allocated space.
1475 @param DeviceHandle The device handle consume the allocated space.
1476
1477 @retval EFI_INVALID_PARAMETER Invalid parameter.
1478 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1479 @retval EFI_SUCCESS IO space successfully allocated.
1480
1481 **/
1482 EFI_STATUS
1483 EFIAPI
1484 CoreAllocateIoSpace (
1485 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
1486 IN EFI_GCD_IO_TYPE GcdIoType,
1487 IN UINTN Alignment,
1488 IN UINT64 Length,
1489 IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
1490 IN EFI_HANDLE ImageHandle,
1491 IN EFI_HANDLE DeviceHandle OPTIONAL
1492 )
1493 {
1494 return CoreAllocateSpace (
1495 GCD_ALLOCATE_IO_OPERATION,
1496 GcdAllocateType,
1497 (EFI_GCD_MEMORY_TYPE) 0,
1498 GcdIoType,
1499 Alignment,
1500 Length,
1501 BaseAddress,
1502 ImageHandle,
1503 DeviceHandle
1504 );
1505 }
1506
1507
1508 /**
1509 Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1510 domain of the processor.
1511
1512 @param BaseAddress Base address of the segment.
1513 @param Length Length of the segment.
1514
1515 @retval EFI_SUCCESS Space successfully freed.
1516
1517 **/
1518 EFI_STATUS
1519 EFIAPI
1520 CoreFreeIoSpace (
1521 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1522 IN UINT64 Length
1523 )
1524 {
1525 return CoreConvertSpace (GCD_FREE_IO_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, 0, 0);
1526 }
1527
1528
1529 /**
1530 Removes reserved I/O or I/O resources from the global coherency domain of the
1531 processor.
1532
1533 @param BaseAddress Base address of the segment.
1534 @param Length Length of the segment.
1535
1536 @retval EFI_SUCCESS Successfully removed a segment of IO space.
1537
1538 **/
1539 EFI_STATUS
1540 EFIAPI
1541 CoreRemoveIoSpace (
1542 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1543 IN UINT64 Length
1544 )
1545 {
1546 return CoreConvertSpace (GCD_REMOVE_IO_OPERATION, (EFI_GCD_MEMORY_TYPE) 0, (EFI_GCD_IO_TYPE) 0, BaseAddress, Length, 0, 0);
1547 }
1548
1549
1550 /**
1551 Build a IO descriptor according to an entry.
1552
1553 @param Descriptor The descriptor to be built
1554 @param Entry According to this entry
1555
1556 **/
1557 VOID
1558 BuildIoDescriptor (
1559 IN EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor,
1560 IN EFI_GCD_MAP_ENTRY *Entry
1561 )
1562 {
1563 Descriptor->BaseAddress = Entry->BaseAddress;
1564 Descriptor->Length = Entry->EndAddress - Entry->BaseAddress + 1;
1565 Descriptor->GcdIoType = Entry->GcdIoType;
1566 Descriptor->ImageHandle = Entry->ImageHandle;
1567 Descriptor->DeviceHandle = Entry->DeviceHandle;
1568 }
1569
1570
1571 /**
1572 Retrieves the descriptor for an I/O region containing a specified address.
1573
1574 @param BaseAddress Specified start address
1575 @param Descriptor Specified length
1576
1577 @retval EFI_INVALID_PARAMETER Descriptor is NULL.
1578 @retval EFI_SUCCESS Successfully get the IO space descriptor.
1579
1580 **/
1581 EFI_STATUS
1582 EFIAPI
1583 CoreGetIoSpaceDescriptor (
1584 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1585 OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor
1586 )
1587 {
1588 EFI_STATUS Status;
1589 LIST_ENTRY *StartLink;
1590 LIST_ENTRY *EndLink;
1591 EFI_GCD_MAP_ENTRY *Entry;
1592
1593 //
1594 // Make sure parameters are valid
1595 //
1596 if (Descriptor == NULL) {
1597 return EFI_INVALID_PARAMETER;
1598 }
1599
1600 CoreAcquireGcdIoLock ();
1601
1602 //
1603 // Search for the list of descriptors that contain BaseAddress
1604 //
1605 Status = CoreSearchGcdMapEntry (BaseAddress, 1, &StartLink, &EndLink, &mGcdIoSpaceMap);
1606 if (EFI_ERROR (Status)) {
1607 Status = EFI_NOT_FOUND;
1608 } else {
1609 //
1610 // Copy the contents of the found descriptor into Descriptor
1611 //
1612 Entry = CR (StartLink, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1613 BuildIoDescriptor (Descriptor, Entry);
1614 }
1615
1616 CoreReleaseGcdIoLock ();
1617
1618 return Status;
1619 }
1620
1621
1622 /**
1623 Returns a map of the I/O resources in the global coherency domain of the processor.
1624
1625 @param NumberOfDescriptors Number of descriptors.
1626 @param IoSpaceMap Descriptor array
1627
1628 @retval EFI_INVALID_PARAMETER Invalid parameter
1629 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1630 @retval EFI_SUCCESS Successfully get IO space map.
1631
1632 **/
1633 EFI_STATUS
1634 EFIAPI
1635 CoreGetIoSpaceMap (
1636 OUT UINTN *NumberOfDescriptors,
1637 OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap
1638 )
1639 {
1640 EFI_STATUS Status;
1641 LIST_ENTRY *Link;
1642 EFI_GCD_MAP_ENTRY *Entry;
1643 EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor;
1644
1645 //
1646 // Make sure parameters are valid
1647 //
1648 if (NumberOfDescriptors == NULL) {
1649 return EFI_INVALID_PARAMETER;
1650 }
1651 if (IoSpaceMap == NULL) {
1652 return EFI_INVALID_PARAMETER;
1653 }
1654
1655 CoreAcquireGcdIoLock ();
1656
1657 //
1658 // Count the number of descriptors
1659 //
1660 *NumberOfDescriptors = CoreCountGcdMapEntry (&mGcdIoSpaceMap);
1661
1662 //
1663 // Allocate the IoSpaceMap
1664 //
1665 *IoSpaceMap = AllocatePool (*NumberOfDescriptors * sizeof (EFI_GCD_IO_SPACE_DESCRIPTOR));
1666 if (*IoSpaceMap == NULL) {
1667 Status = EFI_OUT_OF_RESOURCES;
1668 goto Done;
1669 }
1670
1671 //
1672 // Fill in the IoSpaceMap
1673 //
1674 Descriptor = *IoSpaceMap;
1675 Link = mGcdIoSpaceMap.ForwardLink;
1676 while (Link != &mGcdIoSpaceMap) {
1677 Entry = CR (Link, EFI_GCD_MAP_ENTRY, Link, EFI_GCD_MAP_SIGNATURE);
1678 BuildIoDescriptor (Descriptor, Entry);
1679 Descriptor++;
1680 Link = Link->ForwardLink;
1681 }
1682 Status = EFI_SUCCESS;
1683
1684 Done:
1685 CoreReleaseGcdIoLock ();
1686 return Status;
1687 }
1688
1689
1690 /**
1691 Converts a Resource Descriptor HOB attributes mask to an EFI Memory Descriptor
1692 capabilities mask
1693
1694 @param GcdMemoryType Type of resource in the GCD memory map.
1695 @param Attributes The attribute mask in the Resource Descriptor
1696 HOB.
1697
1698 @return The capabilities mask for an EFI Memory Descriptor.
1699
1700 **/
1701 UINT64
1702 CoreConvertResourceDescriptorHobAttributesToCapabilities (
1703 EFI_GCD_MEMORY_TYPE GcdMemoryType,
1704 UINT64 Attributes
1705 )
1706 {
1707 UINT64 Capabilities;
1708 GCD_ATTRIBUTE_CONVERSION_ENTRY *Conversion;
1709
1710 //
1711 // Convert the Resource HOB Attributes to an EFI Memory Capabilities mask
1712 //
1713 for (Capabilities = 0, Conversion = mAttributeConversionTable; Conversion->Attribute != 0; Conversion++) {
1714 if (Conversion->Memory || (GcdMemoryType != EfiGcdMemoryTypeSystemMemory)) {
1715 if (Attributes & Conversion->Attribute) {
1716 Capabilities |= Conversion->Capability;
1717 }
1718 }
1719 }
1720
1721 return Capabilities;
1722 }
1723
1724
1725 /**
1726 External function. Initializes memory services based on the memory
1727 descriptor HOBs. This function is responsible for priming the memory
1728 map, so memory allocations and resource allocations can be made.
1729 The first part of this function can not depend on any memory services
1730 until at least one memory descriptor is provided to the memory services.
1731
1732 @param HobStart The start address of the HOB.
1733 @param MemoryBaseAddress Start address of memory region found to init DXE
1734 core.
1735 @param MemoryLength Length of memory region found to init DXE core.
1736
1737 @retval EFI_SUCCESS Memory services successfully initialized.
1738
1739 **/
1740 EFI_STATUS
1741 CoreInitializeMemoryServices (
1742 IN VOID **HobStart,
1743 OUT EFI_PHYSICAL_ADDRESS *MemoryBaseAddress,
1744 OUT UINT64 *MemoryLength
1745 )
1746 {
1747 EFI_PEI_HOB_POINTERS Hob;
1748 EFI_MEMORY_TYPE_INFORMATION *EfiMemoryTypeInformation;
1749 UINTN DataSize;
1750 BOOLEAN Found;
1751 EFI_HOB_HANDOFF_INFO_TABLE *PhitHob;
1752 EFI_HOB_RESOURCE_DESCRIPTOR *ResourceHob;
1753 EFI_HOB_RESOURCE_DESCRIPTOR *PhitResourceHob;
1754 EFI_PHYSICAL_ADDRESS BaseAddress;
1755 UINT64 Length;
1756 UINT64 Attributes;
1757 UINT64 Capabilities;
1758 EFI_PHYSICAL_ADDRESS MaxMemoryBaseAddress;
1759 UINT64 MaxMemoryLength;
1760 UINT64 MaxMemoryAttributes;
1761 EFI_PHYSICAL_ADDRESS MaxAddress;
1762 EFI_PHYSICAL_ADDRESS HighAddress;
1763 EFI_HOB_RESOURCE_DESCRIPTOR *MaxResourceHob;
1764 EFI_HOB_GUID_TYPE *GuidHob;
1765
1766 //
1767 // Point at the first HOB. This must be the PHIT HOB.
1768 //
1769 Hob.Raw = *HobStart;
1770 ASSERT (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_HANDOFF);
1771
1772 //
1773 // Initialize the spin locks and maps in the memory services.
1774 // Also fill in the memory services into the EFI Boot Services Table
1775 //
1776 CoreInitializePool ();
1777
1778 //
1779 // Initialize Local Variables
1780 //
1781 PhitResourceHob = NULL;
1782 MaxResourceHob = NULL;
1783 ResourceHob = NULL;
1784 BaseAddress = 0;
1785 Length = 0;
1786 Attributes = 0;
1787 MaxMemoryBaseAddress = 0;
1788 MaxMemoryLength = 0;
1789 MaxMemoryAttributes = 0;
1790
1791 //
1792 // Cache the PHIT HOB for later use
1793 //
1794 PhitHob = Hob.HandoffInformationTable;
1795
1796 //
1797 // See if a Memory Type Information HOB is available
1798 //
1799 GuidHob = GetFirstGuidHob (&gEfiMemoryTypeInformationGuid);
1800 if (GuidHob != NULL) {
1801 EfiMemoryTypeInformation = GET_GUID_HOB_DATA (GuidHob);
1802 DataSize = GET_GUID_HOB_DATA_SIZE (GuidHob);
1803 if (EfiMemoryTypeInformation != NULL && DataSize > 0 && DataSize <= (EfiMaxMemoryType + 1) * sizeof (EFI_MEMORY_TYPE_INFORMATION)) {
1804 CopyMem (&gMemoryTypeInformation, EfiMemoryTypeInformation, DataSize);
1805 }
1806 }
1807
1808 //
1809 // Find the Resource Descriptor HOB that contains range FreeMemoryBaseAddress..FreeMemoryLength
1810 //
1811 Length = 0;
1812 Found = FALSE;
1813 for (Hob.Raw = *HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
1814
1815 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
1816
1817 ResourceHob = Hob.ResourceDescriptor;
1818
1819 if (ResourceHob->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY &&
1820 (ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == TESTED_MEMORY_ATTRIBUTES ) {
1821
1822 if (PhitHob->EfiFreeMemoryBottom >= ResourceHob->PhysicalStart &&
1823 PhitHob->EfiFreeMemoryTop <= (ResourceHob->PhysicalStart + ResourceHob->ResourceLength) ) {
1824
1825 //
1826 // Cache the resource descriptor HOB for the memory region described by the PHIT HOB
1827 //
1828 PhitResourceHob = ResourceHob;
1829 Found = TRUE;
1830
1831 Attributes = PhitResourceHob->ResourceAttribute;
1832 BaseAddress = PageAlignAddress (PhitHob->EfiMemoryTop);
1833 Length = PageAlignLength (ResourceHob->PhysicalStart + ResourceHob->ResourceLength - BaseAddress);
1834 if (Length < MINIMUM_INITIAL_MEMORY_SIZE) {
1835 BaseAddress = PageAlignAddress (PhitHob->EfiFreeMemoryBottom);
1836 Length = PageAlignLength (PhitHob->EfiFreeMemoryTop - BaseAddress);
1837 if (Length < MINIMUM_INITIAL_MEMORY_SIZE) {
1838 BaseAddress = PageAlignAddress (ResourceHob->PhysicalStart);
1839 Length = PageAlignLength ((UINT64)((UINTN)*HobStart - BaseAddress));
1840 }
1841 }
1842 break;
1843 }
1844 }
1845 }
1846 }
1847
1848 //
1849 // Assert if a resource descriptor HOB for the memory region described by the PHIT was not found
1850 //
1851 ASSERT (Found);
1852
1853 //
1854 // Search all the resource descriptor HOBs from the highest possible addresses down for a memory
1855 // region that is big enough to initialize the DXE core. Always skip the PHIT Resource HOB.
1856 // The max address must be within the physically addressible range for the processor.
1857 //
1858 MaxMemoryLength = 0;
1859 MaxAddress = EFI_MAX_ADDRESS;
1860 do {
1861 HighAddress = 0;
1862 Found = FALSE;
1863 //
1864 // Search for a tested memory region that is below MaxAddress
1865 //
1866 for (Hob.Raw = *HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
1867
1868 //
1869 // See if this is a resource descriptor HOB that does not contain the PHIT.
1870 //
1871 if (Hob.ResourceDescriptor != PhitResourceHob && GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
1872
1873 ResourceHob = Hob.ResourceDescriptor;
1874 //
1875 // See if this resource descrior HOB describes tested system memory below MaxAddress
1876 //
1877 if (ResourceHob->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY &&
1878 (ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == TESTED_MEMORY_ATTRIBUTES &&
1879 ResourceHob->PhysicalStart + ResourceHob->ResourceLength <= MaxAddress) {
1880 //
1881 // See if this is the highest tested system memory region below MaxAddress
1882 //
1883 if (ResourceHob->PhysicalStart > HighAddress) {
1884
1885 MaxResourceHob = ResourceHob;
1886 HighAddress = MaxResourceHob->PhysicalStart;
1887 Found = TRUE;
1888 }
1889 }
1890 }
1891 }
1892 if (Found) {
1893 //
1894 // Compute the size of the tested memory region below MaxAddrees
1895 //
1896 MaxMemoryBaseAddress = PageAlignAddress (MaxResourceHob->PhysicalStart);
1897 MaxMemoryLength = PageAlignLength (MaxResourceHob->PhysicalStart + MaxResourceHob->ResourceLength - MaxMemoryBaseAddress);
1898 MaxMemoryAttributes = MaxResourceHob->ResourceAttribute;
1899 }
1900 MaxAddress = ResourceHob->PhysicalStart;
1901 } while (Found && MaxMemoryLength < MINIMUM_INITIAL_MEMORY_SIZE);
1902
1903 if ((Length < MINIMUM_INITIAL_MEMORY_SIZE) ||
1904 (MaxMemoryBaseAddress > BaseAddress && MaxMemoryLength >= MINIMUM_INITIAL_MEMORY_SIZE)) {
1905 BaseAddress = MaxMemoryBaseAddress;
1906 Length = MaxMemoryLength;
1907 Attributes = MaxMemoryAttributes;
1908 }
1909
1910 //
1911 // If no memory regions are found that are big enough to initialize the DXE core, then ASSERT().
1912 //
1913 ASSERT (Length >= MINIMUM_INITIAL_MEMORY_SIZE);
1914
1915 //
1916 // Convert the Resource HOB Attributes to an EFI Memory Capabilities mask
1917 //
1918 Capabilities = CoreConvertResourceDescriptorHobAttributesToCapabilities (EfiGcdMemoryTypeSystemMemory, Attributes);
1919
1920 //
1921 // Declare the very first memory region, so the EFI Memory Services are available.
1922 //
1923 CoreAddMemoryDescriptor (
1924 EfiConventionalMemory,
1925 BaseAddress,
1926 RShiftU64 (Length, EFI_PAGE_SHIFT),
1927 Capabilities
1928 );
1929
1930 *MemoryBaseAddress = BaseAddress;
1931 *MemoryLength = Length;
1932
1933 return EFI_SUCCESS;
1934 }
1935
1936
1937 /**
1938 External function. Initializes the GCD and memory services based on the memory
1939 descriptor HOBs. This function is responsible for priming the GCD map and the
1940 memory map, so memory allocations and resource allocations can be made. The
1941 HobStart will be relocated to a pool buffer.
1942
1943 @param HobStart The start address of the HOB
1944 @param MemoryBaseAddress Start address of memory region found to init DXE
1945 core.
1946 @param MemoryLength Length of memory region found to init DXE core.
1947
1948 @retval EFI_SUCCESS GCD services successfully initialized.
1949
1950 **/
1951 EFI_STATUS
1952 CoreInitializeGcdServices (
1953 IN OUT VOID **HobStart,
1954 IN EFI_PHYSICAL_ADDRESS MemoryBaseAddress,
1955 IN UINT64 MemoryLength
1956 )
1957 {
1958 EFI_PEI_HOB_POINTERS Hob;
1959 VOID *NewHobList;
1960 EFI_HOB_HANDOFF_INFO_TABLE *PhitHob;
1961 UINT8 SizeOfMemorySpace;
1962 UINT8 SizeOfIoSpace;
1963 EFI_HOB_RESOURCE_DESCRIPTOR *ResourceHob;
1964 EFI_PHYSICAL_ADDRESS BaseAddress;
1965 UINT64 Length;
1966 EFI_STATUS Status;
1967 EFI_GCD_MAP_ENTRY *Entry;
1968 EFI_GCD_MEMORY_TYPE GcdMemoryType;
1969 EFI_GCD_IO_TYPE GcdIoType;
1970 EFI_GCD_MEMORY_SPACE_DESCRIPTOR Descriptor;
1971 EFI_HOB_MEMORY_ALLOCATION *MemoryHob;
1972 EFI_HOB_FIRMWARE_VOLUME *FirmwareVolumeHob;
1973 UINTN NumberOfDescriptors;
1974 EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemorySpaceMap;
1975 UINTN Index;
1976 UINT64 Capabilities;
1977 EFI_HOB_CPU * CpuHob;
1978
1979 //
1980 // Cache the PHIT HOB for later use
1981 //
1982 PhitHob = (EFI_HOB_HANDOFF_INFO_TABLE *)(*HobStart);
1983
1984 //
1985 // Get the number of address lines in the I/O and Memory space for the CPU
1986 //
1987 CpuHob = GetFirstHob (EFI_HOB_TYPE_CPU);
1988 ASSERT (CpuHob != NULL);
1989 SizeOfMemorySpace = CpuHob->SizeOfMemorySpace;
1990 SizeOfIoSpace = CpuHob->SizeOfIoSpace;
1991
1992 //
1993 // Initialize the GCD Memory Space Map
1994 //
1995 Entry = AllocateCopyPool (sizeof (EFI_GCD_MAP_ENTRY), &mGcdMemorySpaceMapEntryTemplate);
1996 ASSERT (Entry != NULL);
1997
1998 Entry->EndAddress = LShiftU64 (1, SizeOfMemorySpace) - 1;
1999
2000 InsertHeadList (&mGcdMemorySpaceMap, &Entry->Link);
2001
2002 //
2003 // Initialize the GCD I/O Space Map
2004 //
2005 Entry = AllocateCopyPool (sizeof (EFI_GCD_MAP_ENTRY), &mGcdIoSpaceMapEntryTemplate);
2006 ASSERT (Entry != NULL);
2007
2008 Entry->EndAddress = LShiftU64 (1, SizeOfIoSpace) - 1;
2009
2010 InsertHeadList (&mGcdIoSpaceMap, &Entry->Link);
2011
2012 //
2013 // Walk the HOB list and add all resource descriptors to the GCD
2014 //
2015 for (Hob.Raw = *HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
2016
2017 GcdMemoryType = EfiGcdMemoryTypeNonExistent;
2018 GcdIoType = EfiGcdIoTypeNonExistent;
2019
2020 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_RESOURCE_DESCRIPTOR) {
2021
2022 ResourceHob = Hob.ResourceDescriptor;
2023
2024 switch (ResourceHob->ResourceType) {
2025 case EFI_RESOURCE_SYSTEM_MEMORY:
2026 if ((ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == TESTED_MEMORY_ATTRIBUTES) {
2027 GcdMemoryType = EfiGcdMemoryTypeSystemMemory;
2028 }
2029 if ((ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == INITIALIZED_MEMORY_ATTRIBUTES) {
2030 GcdMemoryType = EfiGcdMemoryTypeReserved;
2031 }
2032 if ((ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == PRESENT_MEMORY_ATTRIBUTES) {
2033 GcdMemoryType = EfiGcdMemoryTypeReserved;
2034 }
2035 break;
2036 case EFI_RESOURCE_MEMORY_MAPPED_IO:
2037 case EFI_RESOURCE_FIRMWARE_DEVICE:
2038 GcdMemoryType = EfiGcdMemoryTypeMemoryMappedIo;
2039 break;
2040 case EFI_RESOURCE_MEMORY_MAPPED_IO_PORT:
2041 case EFI_RESOURCE_MEMORY_RESERVED:
2042 GcdMemoryType = EfiGcdMemoryTypeReserved;
2043 break;
2044 case EFI_RESOURCE_IO:
2045 GcdIoType = EfiGcdIoTypeIo;
2046 break;
2047 case EFI_RESOURCE_IO_RESERVED:
2048 GcdIoType = EfiGcdIoTypeReserved;
2049 break;
2050 }
2051
2052 if (GcdMemoryType != EfiGcdMemoryTypeNonExistent) {
2053 //
2054 // Convert the Resource HOB Attributes to an EFI Memory Capabilities mask
2055 //
2056 Capabilities = CoreConvertResourceDescriptorHobAttributesToCapabilities (
2057 GcdMemoryType,
2058 ResourceHob->ResourceAttribute
2059 );
2060
2061 Status = CoreInternalAddMemorySpace (
2062 GcdMemoryType,
2063 ResourceHob->PhysicalStart,
2064 ResourceHob->ResourceLength,
2065 Capabilities
2066 );
2067 }
2068
2069 if (GcdIoType != EfiGcdIoTypeNonExistent) {
2070 Status = CoreAddIoSpace (
2071 GcdIoType,
2072 ResourceHob->PhysicalStart,
2073 ResourceHob->ResourceLength
2074 );
2075 }
2076 }
2077 }
2078
2079 //
2080 // Allocate first memory region from the GCD by the DXE core
2081 //
2082 Status = CoreAllocateMemorySpace (
2083 EfiGcdAllocateAddress,
2084 EfiGcdMemoryTypeSystemMemory,
2085 0,
2086 MemoryLength,
2087 &MemoryBaseAddress,
2088 gDxeCoreImageHandle,
2089 NULL
2090 );
2091
2092 //
2093 // Walk the HOB list and allocate all memory space that is consumed by memory allocation HOBs,
2094 // and Firmware Volume HOBs. Also update the EFI Memory Map with the memory allocation HOBs.
2095 //
2096 for (Hob.Raw = *HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
2097 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_MEMORY_ALLOCATION) {
2098 MemoryHob = Hob.MemoryAllocation;
2099 BaseAddress = MemoryHob->AllocDescriptor.MemoryBaseAddress;
2100 Status = CoreGetMemorySpaceDescriptor (BaseAddress, &Descriptor);
2101 if (!EFI_ERROR (Status)) {
2102 Status = CoreAllocateMemorySpace (
2103 EfiGcdAllocateAddress,
2104 Descriptor.GcdMemoryType,
2105 0,
2106 MemoryHob->AllocDescriptor.MemoryLength,
2107 &BaseAddress,
2108 gDxeCoreImageHandle,
2109 NULL
2110 );
2111 if (!EFI_ERROR (Status) && Descriptor.GcdMemoryType == EfiGcdMemoryTypeSystemMemory) {
2112 CoreAddMemoryDescriptor (
2113 MemoryHob->AllocDescriptor.MemoryType,
2114 MemoryHob->AllocDescriptor.MemoryBaseAddress,
2115 RShiftU64 (MemoryHob->AllocDescriptor.MemoryLength, EFI_PAGE_SHIFT),
2116 Descriptor.Capabilities & (~EFI_MEMORY_RUNTIME)
2117 );
2118 }
2119 }
2120 }
2121
2122 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV) {
2123 FirmwareVolumeHob = Hob.FirmwareVolume;
2124 BaseAddress = FirmwareVolumeHob->BaseAddress;
2125 Status = CoreAllocateMemorySpace (
2126 EfiGcdAllocateAddress,
2127 EfiGcdMemoryTypeMemoryMappedIo,
2128 0,
2129 FirmwareVolumeHob->Length,
2130 &BaseAddress,
2131 gDxeCoreImageHandle,
2132 NULL
2133 );
2134 }
2135 }
2136
2137 //
2138 // Relocate HOB List to an allocated pool buffer.
2139 //
2140 NewHobList = AllocateCopyPool (
2141 (UINTN)PhitHob->EfiFreeMemoryBottom - (UINTN)(*HobStart),
2142 *HobStart
2143 );
2144 ASSERT (NewHobList != NULL);
2145
2146 *HobStart = NewHobList;
2147 gHobList = NewHobList;
2148
2149 //
2150 // Add and allocate the remaining unallocated system memory to the memory services.
2151 //
2152 Status = CoreGetMemorySpaceMap (&NumberOfDescriptors, &MemorySpaceMap);
2153 for (Index = 0; Index < NumberOfDescriptors; Index++) {
2154 if (MemorySpaceMap[Index].GcdMemoryType == EfiGcdMemoryTypeSystemMemory) {
2155 if (MemorySpaceMap[Index].ImageHandle == NULL) {
2156 BaseAddress = PageAlignAddress (MemorySpaceMap[Index].BaseAddress);
2157 Length = PageAlignLength (MemorySpaceMap[Index].BaseAddress + MemorySpaceMap[Index].Length - BaseAddress);
2158 if (Length == 0 || MemorySpaceMap[Index].BaseAddress + MemorySpaceMap[Index].Length < BaseAddress) {
2159 continue;
2160 }
2161 CoreAddMemoryDescriptor (
2162 EfiConventionalMemory,
2163 BaseAddress,
2164 RShiftU64 (Length, EFI_PAGE_SHIFT),
2165 MemorySpaceMap[Index].Capabilities & (~EFI_MEMORY_RUNTIME)
2166 );
2167 Status = CoreAllocateMemorySpace (
2168 EfiGcdAllocateAddress,
2169 EfiGcdMemoryTypeSystemMemory,
2170 0,
2171 Length,
2172 &BaseAddress,
2173 gDxeCoreImageHandle,
2174 NULL
2175 );
2176 }
2177 }
2178 }
2179 CoreFreePool (MemorySpaceMap);
2180
2181 return EFI_SUCCESS;
2182 }
EDK2 Git Mirror