UefiCpuPkg PiSmmCpuDxeSmm: Refine some comments about SmmMemoryAttribute
[mirror_edk2.git] / UefiCpuPkg / PiSmmCpuDxeSmm / SmmCpuMemoryManagement.c
1 /** @file
2
3 Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 **/
13
14 #include "PiSmmCpuDxeSmm.h"
15
16 #define NEXT_MEMORY_DESCRIPTOR(MemoryDescriptor, Size) \
17 ((EFI_MEMORY_DESCRIPTOR *)((UINT8 *)(MemoryDescriptor) + (Size)))
18
19 #define PREVIOUS_MEMORY_DESCRIPTOR(MemoryDescriptor, Size) \
20 ((EFI_MEMORY_DESCRIPTOR *)((UINT8 *)(MemoryDescriptor) - (Size)))
21
22 EFI_MEMORY_DESCRIPTOR *mUefiMemoryMap;
23 UINTN mUefiMemoryMapSize;
24 UINTN mUefiDescriptorSize;
25
26 PAGE_ATTRIBUTE_TABLE mPageAttributeTable[] = {
27 {Page4K, SIZE_4KB, PAGING_4K_ADDRESS_MASK_64},
28 {Page2M, SIZE_2MB, PAGING_2M_ADDRESS_MASK_64},
29 {Page1G, SIZE_1GB, PAGING_1G_ADDRESS_MASK_64},
30 };
31
32 /**
33 Return page table base.
34
35 @return page table base.
36 **/
37 UINTN
38 GetPageTableBase (
39 VOID
40 )
41 {
42 return (AsmReadCr3 () & PAGING_4K_ADDRESS_MASK_64);
43 }
44
45 /**
46 Return length according to page attributes.
47
48 @param[in] PageAttributes The page attribute of the page entry.
49
50 @return The length of page entry.
51 **/
52 UINTN
53 PageAttributeToLength (
54 IN PAGE_ATTRIBUTE PageAttribute
55 )
56 {
57 UINTN Index;
58 for (Index = 0; Index < sizeof(mPageAttributeTable)/sizeof(mPageAttributeTable[0]); Index++) {
59 if (PageAttribute == mPageAttributeTable[Index].Attribute) {
60 return (UINTN)mPageAttributeTable[Index].Length;
61 }
62 }
63 return 0;
64 }
65
66 /**
67 Return address mask according to page attributes.
68
69 @param[in] PageAttributes The page attribute of the page entry.
70
71 @return The address mask of page entry.
72 **/
73 UINTN
74 PageAttributeToMask (
75 IN PAGE_ATTRIBUTE PageAttribute
76 )
77 {
78 UINTN Index;
79 for (Index = 0; Index < sizeof(mPageAttributeTable)/sizeof(mPageAttributeTable[0]); Index++) {
80 if (PageAttribute == mPageAttributeTable[Index].Attribute) {
81 return (UINTN)mPageAttributeTable[Index].AddressMask;
82 }
83 }
84 return 0;
85 }
86
87 /**
88 Return page table entry to match the address.
89
90 @param[in] Address The address to be checked.
91 @param[out] PageAttributes The page attribute of the page entry.
92
93 @return The page entry.
94 **/
95 VOID *
96 GetPageTableEntry (
97 IN PHYSICAL_ADDRESS Address,
98 OUT PAGE_ATTRIBUTE *PageAttribute
99 )
100 {
101 UINTN Index1;
102 UINTN Index2;
103 UINTN Index3;
104 UINTN Index4;
105 UINT64 *L1PageTable;
106 UINT64 *L2PageTable;
107 UINT64 *L3PageTable;
108 UINT64 *L4PageTable;
109
110 Index4 = ((UINTN)RShiftU64 (Address, 39)) & PAGING_PAE_INDEX_MASK;
111 Index3 = ((UINTN)Address >> 30) & PAGING_PAE_INDEX_MASK;
112 Index2 = ((UINTN)Address >> 21) & PAGING_PAE_INDEX_MASK;
113 Index1 = ((UINTN)Address >> 12) & PAGING_PAE_INDEX_MASK;
114
115 if (sizeof(UINTN) == sizeof(UINT64)) {
116 L4PageTable = (UINT64 *)GetPageTableBase ();
117 if (L4PageTable[Index4] == 0) {
118 *PageAttribute = PageNone;
119 return NULL;
120 }
121
122 L3PageTable = (UINT64 *)(UINTN)(L4PageTable[Index4] & ~mAddressEncMask & PAGING_4K_ADDRESS_MASK_64);
123 } else {
124 L3PageTable = (UINT64 *)GetPageTableBase ();
125 }
126 if (L3PageTable[Index3] == 0) {
127 *PageAttribute = PageNone;
128 return NULL;
129 }
130 if ((L3PageTable[Index3] & IA32_PG_PS) != 0) {
131 // 1G
132 *PageAttribute = Page1G;
133 return &L3PageTable[Index3];
134 }
135
136 L2PageTable = (UINT64 *)(UINTN)(L3PageTable[Index3] & ~mAddressEncMask & PAGING_4K_ADDRESS_MASK_64);
137 if (L2PageTable[Index2] == 0) {
138 *PageAttribute = PageNone;
139 return NULL;
140 }
141 if ((L2PageTable[Index2] & IA32_PG_PS) != 0) {
142 // 2M
143 *PageAttribute = Page2M;
144 return &L2PageTable[Index2];
145 }
146
147 // 4k
148 L1PageTable = (UINT64 *)(UINTN)(L2PageTable[Index2] & ~mAddressEncMask & PAGING_4K_ADDRESS_MASK_64);
149 if ((L1PageTable[Index1] == 0) && (Address != 0)) {
150 *PageAttribute = PageNone;
151 return NULL;
152 }
153 *PageAttribute = Page4K;
154 return &L1PageTable[Index1];
155 }
156
157 /**
158 Return memory attributes of page entry.
159
160 @param[in] PageEntry The page entry.
161
162 @return Memory attributes of page entry.
163 **/
164 UINT64
165 GetAttributesFromPageEntry (
166 IN UINT64 *PageEntry
167 )
168 {
169 UINT64 Attributes;
170 Attributes = 0;
171 if ((*PageEntry & IA32_PG_P) == 0) {
172 Attributes |= EFI_MEMORY_RP;
173 }
174 if ((*PageEntry & IA32_PG_RW) == 0) {
175 Attributes |= EFI_MEMORY_RO;
176 }
177 if ((*PageEntry & IA32_PG_NX) != 0) {
178 Attributes |= EFI_MEMORY_XP;
179 }
180 return Attributes;
181 }
182
183 /**
184 Modify memory attributes of page entry.
185
186 @param[in] PageEntry The page entry.
187 @param[in] Attributes The bit mask of attributes to modify for the memory region.
188 @param[in] IsSet TRUE means to set attributes. FALSE means to clear attributes.
189 @param[out] IsModified TRUE means page table modified. FALSE means page table not modified.
190 **/
191 VOID
192 ConvertPageEntryAttribute (
193 IN UINT64 *PageEntry,
194 IN UINT64 Attributes,
195 IN BOOLEAN IsSet,
196 OUT BOOLEAN *IsModified
197 )
198 {
199 UINT64 CurrentPageEntry;
200 UINT64 NewPageEntry;
201
202 CurrentPageEntry = *PageEntry;
203 NewPageEntry = CurrentPageEntry;
204 if ((Attributes & EFI_MEMORY_RP) != 0) {
205 if (IsSet) {
206 NewPageEntry &= ~(UINT64)IA32_PG_P;
207 } else {
208 NewPageEntry |= IA32_PG_P;
209 }
210 }
211 if ((Attributes & EFI_MEMORY_RO) != 0) {
212 if (IsSet) {
213 NewPageEntry &= ~(UINT64)IA32_PG_RW;
214 } else {
215 NewPageEntry |= IA32_PG_RW;
216 }
217 }
218 if ((Attributes & EFI_MEMORY_XP) != 0) {
219 if (mXdSupported) {
220 if (IsSet) {
221 NewPageEntry |= IA32_PG_NX;
222 } else {
223 NewPageEntry &= ~IA32_PG_NX;
224 }
225 }
226 }
227 *PageEntry = NewPageEntry;
228 if (CurrentPageEntry != NewPageEntry) {
229 *IsModified = TRUE;
230 DEBUG ((DEBUG_VERBOSE, "ConvertPageEntryAttribute 0x%lx", CurrentPageEntry));
231 DEBUG ((DEBUG_VERBOSE, "->0x%lx\n", NewPageEntry));
232 } else {
233 *IsModified = FALSE;
234 }
235 }
236
237 /**
238 This function returns if there is need to split page entry.
239
240 @param[in] BaseAddress The base address to be checked.
241 @param[in] Length The length to be checked.
242 @param[in] PageEntry The page entry to be checked.
243 @param[in] PageAttribute The page attribute of the page entry.
244
245 @retval SplitAttributes on if there is need to split page entry.
246 **/
247 PAGE_ATTRIBUTE
248 NeedSplitPage (
249 IN PHYSICAL_ADDRESS BaseAddress,
250 IN UINT64 Length,
251 IN UINT64 *PageEntry,
252 IN PAGE_ATTRIBUTE PageAttribute
253 )
254 {
255 UINT64 PageEntryLength;
256
257 PageEntryLength = PageAttributeToLength (PageAttribute);
258
259 if (((BaseAddress & (PageEntryLength - 1)) == 0) && (Length >= PageEntryLength)) {
260 return PageNone;
261 }
262
263 if (((BaseAddress & PAGING_2M_MASK) != 0) || (Length < SIZE_2MB)) {
264 return Page4K;
265 }
266
267 return Page2M;
268 }
269
270 /**
271 This function splits one page entry to small page entries.
272
273 @param[in] PageEntry The page entry to be splitted.
274 @param[in] PageAttribute The page attribute of the page entry.
275 @param[in] SplitAttribute How to split the page entry.
276
277 @retval RETURN_SUCCESS The page entry is splitted.
278 @retval RETURN_UNSUPPORTED The page entry does not support to be splitted.
279 @retval RETURN_OUT_OF_RESOURCES No resource to split page entry.
280 **/
281 RETURN_STATUS
282 SplitPage (
283 IN UINT64 *PageEntry,
284 IN PAGE_ATTRIBUTE PageAttribute,
285 IN PAGE_ATTRIBUTE SplitAttribute
286 )
287 {
288 UINT64 BaseAddress;
289 UINT64 *NewPageEntry;
290 UINTN Index;
291
292 ASSERT (PageAttribute == Page2M || PageAttribute == Page1G);
293
294 if (PageAttribute == Page2M) {
295 //
296 // Split 2M to 4K
297 //
298 ASSERT (SplitAttribute == Page4K);
299 if (SplitAttribute == Page4K) {
300 NewPageEntry = AllocatePageTableMemory (1);
301 DEBUG ((DEBUG_VERBOSE, "Split - 0x%x\n", NewPageEntry));
302 if (NewPageEntry == NULL) {
303 return RETURN_OUT_OF_RESOURCES;
304 }
305 BaseAddress = *PageEntry & PAGING_2M_ADDRESS_MASK_64;
306 for (Index = 0; Index < SIZE_4KB / sizeof(UINT64); Index++) {
307 NewPageEntry[Index] = (BaseAddress + SIZE_4KB * Index) | mAddressEncMask | ((*PageEntry) & PAGE_PROGATE_BITS);
308 }
309 (*PageEntry) = (UINT64)(UINTN)NewPageEntry | mAddressEncMask | PAGE_ATTRIBUTE_BITS;
310 return RETURN_SUCCESS;
311 } else {
312 return RETURN_UNSUPPORTED;
313 }
314 } else if (PageAttribute == Page1G) {
315 //
316 // Split 1G to 2M
317 // No need support 1G->4K directly, we should use 1G->2M, then 2M->4K to get more compact page table.
318 //
319 ASSERT (SplitAttribute == Page2M || SplitAttribute == Page4K);
320 if ((SplitAttribute == Page2M || SplitAttribute == Page4K)) {
321 NewPageEntry = AllocatePageTableMemory (1);
322 DEBUG ((DEBUG_VERBOSE, "Split - 0x%x\n", NewPageEntry));
323 if (NewPageEntry == NULL) {
324 return RETURN_OUT_OF_RESOURCES;
325 }
326 BaseAddress = *PageEntry & PAGING_1G_ADDRESS_MASK_64;
327 for (Index = 0; Index < SIZE_4KB / sizeof(UINT64); Index++) {
328 NewPageEntry[Index] = (BaseAddress + SIZE_2MB * Index) | mAddressEncMask | IA32_PG_PS | ((*PageEntry) & PAGE_PROGATE_BITS);
329 }
330 (*PageEntry) = (UINT64)(UINTN)NewPageEntry | mAddressEncMask | PAGE_ATTRIBUTE_BITS;
331 return RETURN_SUCCESS;
332 } else {
333 return RETURN_UNSUPPORTED;
334 }
335 } else {
336 return RETURN_UNSUPPORTED;
337 }
338 }
339
340 /**
341 This function modifies the page attributes for the memory region specified by BaseAddress and
342 Length from their current attributes to the attributes specified by Attributes.
343
344 Caller should make sure BaseAddress and Length is at page boundary.
345
346 @param[in] BaseAddress The physical address that is the start address of a memory region.
347 @param[in] Length The size in bytes of the memory region.
348 @param[in] Attributes The bit mask of attributes to modify for the memory region.
349 @param[in] IsSet TRUE means to set attributes. FALSE means to clear attributes.
350 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
351 @param[out] IsModified TRUE means page table modified. FALSE means page table not modified.
352
353 @retval RETURN_SUCCESS The attributes were modified for the memory region.
354 @retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by
355 BaseAddress and Length cannot be modified.
356 @retval RETURN_INVALID_PARAMETER Length is zero.
357 Attributes specified an illegal combination of attributes that
358 cannot be set together.
359 @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
360 the memory resource range.
361 @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the memory
362 resource range specified by BaseAddress and Length.
363 The bit mask of attributes is not support for the memory resource
364 range specified by BaseAddress and Length.
365 **/
366 RETURN_STATUS
367 EFIAPI
368 ConvertMemoryPageAttributes (
369 IN PHYSICAL_ADDRESS BaseAddress,
370 IN UINT64 Length,
371 IN UINT64 Attributes,
372 IN BOOLEAN IsSet,
373 OUT BOOLEAN *IsSplitted, OPTIONAL
374 OUT BOOLEAN *IsModified OPTIONAL
375 )
376 {
377 UINT64 *PageEntry;
378 PAGE_ATTRIBUTE PageAttribute;
379 UINTN PageEntryLength;
380 PAGE_ATTRIBUTE SplitAttribute;
381 RETURN_STATUS Status;
382 BOOLEAN IsEntryModified;
383 EFI_PHYSICAL_ADDRESS MaximumSupportMemAddress;
384
385 ASSERT (Attributes != 0);
386 ASSERT ((Attributes & ~(EFI_MEMORY_RP | EFI_MEMORY_RO | EFI_MEMORY_XP)) == 0);
387
388 ASSERT ((BaseAddress & (SIZE_4KB - 1)) == 0);
389 ASSERT ((Length & (SIZE_4KB - 1)) == 0);
390
391 if (Length == 0) {
392 return RETURN_INVALID_PARAMETER;
393 }
394
395 MaximumSupportMemAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)(LShiftU64 (1, mPhysicalAddressBits) - 1);
396 if (BaseAddress > MaximumSupportMemAddress) {
397 return RETURN_UNSUPPORTED;
398 }
399 if (Length > MaximumSupportMemAddress) {
400 return RETURN_UNSUPPORTED;
401 }
402 if ((Length != 0) && (BaseAddress > MaximumSupportMemAddress - (Length - 1))) {
403 return RETURN_UNSUPPORTED;
404 }
405
406 // DEBUG ((DEBUG_ERROR, "ConvertMemoryPageAttributes(%x) - %016lx, %016lx, %02lx\n", IsSet, BaseAddress, Length, Attributes));
407
408 if (IsSplitted != NULL) {
409 *IsSplitted = FALSE;
410 }
411 if (IsModified != NULL) {
412 *IsModified = FALSE;
413 }
414
415 //
416 // Below logic is to check 2M/4K page to make sure we donot waist memory.
417 //
418 while (Length != 0) {
419 PageEntry = GetPageTableEntry (BaseAddress, &PageAttribute);
420 if (PageEntry == NULL) {
421 return RETURN_UNSUPPORTED;
422 }
423 PageEntryLength = PageAttributeToLength (PageAttribute);
424 SplitAttribute = NeedSplitPage (BaseAddress, Length, PageEntry, PageAttribute);
425 if (SplitAttribute == PageNone) {
426 ConvertPageEntryAttribute (PageEntry, Attributes, IsSet, &IsEntryModified);
427 if (IsEntryModified) {
428 if (IsModified != NULL) {
429 *IsModified = TRUE;
430 }
431 }
432 //
433 // Convert success, move to next
434 //
435 BaseAddress += PageEntryLength;
436 Length -= PageEntryLength;
437 } else {
438 Status = SplitPage (PageEntry, PageAttribute, SplitAttribute);
439 if (RETURN_ERROR (Status)) {
440 return RETURN_UNSUPPORTED;
441 }
442 if (IsSplitted != NULL) {
443 *IsSplitted = TRUE;
444 }
445 if (IsModified != NULL) {
446 *IsModified = TRUE;
447 }
448 //
449 // Just split current page
450 // Convert success in next around
451 //
452 }
453 }
454
455 return RETURN_SUCCESS;
456 }
457
458 /**
459 FlushTlb on current processor.
460
461 @param[in,out] Buffer Pointer to private data buffer.
462 **/
463 VOID
464 EFIAPI
465 FlushTlbOnCurrentProcessor (
466 IN OUT VOID *Buffer
467 )
468 {
469 CpuFlushTlb ();
470 }
471
472 /**
473 FlushTlb for all processors.
474 **/
475 VOID
476 FlushTlbForAll (
477 VOID
478 )
479 {
480 UINTN Index;
481
482 FlushTlbOnCurrentProcessor (NULL);
483
484 for (Index = 0; Index < gSmst->NumberOfCpus; Index++) {
485 if (Index != gSmst->CurrentlyExecutingCpu) {
486 // Force to start up AP in blocking mode,
487 SmmBlockingStartupThisAp (FlushTlbOnCurrentProcessor, Index, NULL);
488 // Do not check return status, because AP might not be present in some corner cases.
489 }
490 }
491 }
492
493 /**
494 This function sets the attributes for the memory region specified by BaseAddress and
495 Length from their current attributes to the attributes specified by Attributes.
496
497 @param[in] BaseAddress The physical address that is the start address of a memory region.
498 @param[in] Length The size in bytes of the memory region.
499 @param[in] Attributes The bit mask of attributes to set for the memory region.
500 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
501
502 @retval EFI_SUCCESS The attributes were set for the memory region.
503 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
504 BaseAddress and Length cannot be modified.
505 @retval EFI_INVALID_PARAMETER Length is zero.
506 Attributes specified an illegal combination of attributes that
507 cannot be set together.
508 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
509 the memory resource range.
510 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
511 resource range specified by BaseAddress and Length.
512 The bit mask of attributes is not support for the memory resource
513 range specified by BaseAddress and Length.
514
515 **/
516 EFI_STATUS
517 EFIAPI
518 SmmSetMemoryAttributesEx (
519 IN EFI_PHYSICAL_ADDRESS BaseAddress,
520 IN UINT64 Length,
521 IN UINT64 Attributes,
522 OUT BOOLEAN *IsSplitted OPTIONAL
523 )
524 {
525 EFI_STATUS Status;
526 BOOLEAN IsModified;
527
528 Status = ConvertMemoryPageAttributes (BaseAddress, Length, Attributes, TRUE, IsSplitted, &IsModified);
529 if (!EFI_ERROR(Status)) {
530 if (IsModified) {
531 //
532 // Flush TLB as last step
533 //
534 FlushTlbForAll();
535 }
536 }
537
538 return Status;
539 }
540
541 /**
542 This function clears the attributes for the memory region specified by BaseAddress and
543 Length from their current attributes to the attributes specified by Attributes.
544
545 @param[in] BaseAddress The physical address that is the start address of a memory region.
546 @param[in] Length The size in bytes of the memory region.
547 @param[in] Attributes The bit mask of attributes to clear for the memory region.
548 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
549
550 @retval EFI_SUCCESS The attributes were cleared for the memory region.
551 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
552 BaseAddress and Length cannot be modified.
553 @retval EFI_INVALID_PARAMETER Length is zero.
554 Attributes specified an illegal combination of attributes that
555 cannot be cleared together.
556 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
557 the memory resource range.
558 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
559 resource range specified by BaseAddress and Length.
560 The bit mask of attributes is not supported for the memory resource
561 range specified by BaseAddress and Length.
562
563 **/
564 EFI_STATUS
565 EFIAPI
566 SmmClearMemoryAttributesEx (
567 IN EFI_PHYSICAL_ADDRESS BaseAddress,
568 IN UINT64 Length,
569 IN UINT64 Attributes,
570 OUT BOOLEAN *IsSplitted OPTIONAL
571 )
572 {
573 EFI_STATUS Status;
574 BOOLEAN IsModified;
575
576 Status = ConvertMemoryPageAttributes (BaseAddress, Length, Attributes, FALSE, IsSplitted, &IsModified);
577 if (!EFI_ERROR(Status)) {
578 if (IsModified) {
579 //
580 // Flush TLB as last step
581 //
582 FlushTlbForAll();
583 }
584 }
585
586 return Status;
587 }
588
589 /**
590 This function sets the attributes for the memory region specified by BaseAddress and
591 Length from their current attributes to the attributes specified by Attributes.
592
593 @param[in] BaseAddress The physical address that is the start address of a memory region.
594 @param[in] Length The size in bytes of the memory region.
595 @param[in] Attributes The bit mask of attributes to set for the memory region.
596
597 @retval EFI_SUCCESS The attributes were set for the memory region.
598 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
599 BaseAddress and Length cannot be modified.
600 @retval EFI_INVALID_PARAMETER Length is zero.
601 Attributes specified an illegal combination of attributes that
602 cannot be set together.
603 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
604 the memory resource range.
605 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
606 resource range specified by BaseAddress and Length.
607 The bit mask of attributes is not supported for the memory resource
608 range specified by BaseAddress and Length.
609
610 **/
611 EFI_STATUS
612 EFIAPI
613 SmmSetMemoryAttributes (
614 IN EFI_PHYSICAL_ADDRESS BaseAddress,
615 IN UINT64 Length,
616 IN UINT64 Attributes
617 )
618 {
619 return SmmSetMemoryAttributesEx (BaseAddress, Length, Attributes, NULL);
620 }
621
622 /**
623 This function clears the attributes for the memory region specified by BaseAddress and
624 Length from their current attributes to the attributes specified by Attributes.
625
626 @param[in] BaseAddress The physical address that is the start address of a memory region.
627 @param[in] Length The size in bytes of the memory region.
628 @param[in] Attributes The bit mask of attributes to clear for the memory region.
629
630 @retval EFI_SUCCESS The attributes were cleared for the memory region.
631 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
632 BaseAddress and Length cannot be modified.
633 @retval EFI_INVALID_PARAMETER Length is zero.
634 Attributes specified an illegal combination of attributes that
635 cannot be cleared together.
636 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
637 the memory resource range.
638 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
639 resource range specified by BaseAddress and Length.
640 The bit mask of attributes is not supported for the memory resource
641 range specified by BaseAddress and Length.
642
643 **/
644 EFI_STATUS
645 EFIAPI
646 SmmClearMemoryAttributes (
647 IN EFI_PHYSICAL_ADDRESS BaseAddress,
648 IN UINT64 Length,
649 IN UINT64 Attributes
650 )
651 {
652 return SmmClearMemoryAttributesEx (BaseAddress, Length, Attributes, NULL);
653 }
654
655
656
657 /**
658 Retrieves a pointer to the system configuration table from the SMM System Table
659 based on a specified GUID.
660
661 @param[in] TableGuid The pointer to table's GUID type.
662 @param[out] Table The pointer to the table associated with TableGuid in the EFI System Table.
663
664 @retval EFI_SUCCESS A configuration table matching TableGuid was found.
665 @retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found.
666
667 **/
668 EFI_STATUS
669 EFIAPI
670 SmmGetSystemConfigurationTable (
671 IN EFI_GUID *TableGuid,
672 OUT VOID **Table
673 )
674 {
675 UINTN Index;
676
677 ASSERT (TableGuid != NULL);
678 ASSERT (Table != NULL);
679
680 *Table = NULL;
681 for (Index = 0; Index < gSmst->NumberOfTableEntries; Index++) {
682 if (CompareGuid (TableGuid, &(gSmst->SmmConfigurationTable[Index].VendorGuid))) {
683 *Table = gSmst->SmmConfigurationTable[Index].VendorTable;
684 return EFI_SUCCESS;
685 }
686 }
687
688 return EFI_NOT_FOUND;
689 }
690
691 /**
692 This function sets SMM save state buffer to be RW and XP.
693 **/
694 VOID
695 PatchSmmSaveStateMap (
696 VOID
697 )
698 {
699 UINTN Index;
700 UINTN TileCodeSize;
701 UINTN TileDataSize;
702 UINTN TileSize;
703
704 TileCodeSize = GetSmiHandlerSize ();
705 TileCodeSize = ALIGN_VALUE(TileCodeSize, SIZE_4KB);
706 TileDataSize = (SMRAM_SAVE_STATE_MAP_OFFSET - SMM_PSD_OFFSET) + sizeof (SMRAM_SAVE_STATE_MAP);
707 TileDataSize = ALIGN_VALUE(TileDataSize, SIZE_4KB);
708 TileSize = TileDataSize + TileCodeSize - 1;
709 TileSize = 2 * GetPowerOfTwo32 ((UINT32)TileSize);
710
711 DEBUG ((DEBUG_INFO, "PatchSmmSaveStateMap:\n"));
712 for (Index = 0; Index < mMaxNumberOfCpus - 1; Index++) {
713 //
714 // Code
715 //
716 SmmSetMemoryAttributes (
717 mCpuHotPlugData.SmBase[Index] + SMM_HANDLER_OFFSET,
718 TileCodeSize,
719 EFI_MEMORY_RO
720 );
721 SmmClearMemoryAttributes (
722 mCpuHotPlugData.SmBase[Index] + SMM_HANDLER_OFFSET,
723 TileCodeSize,
724 EFI_MEMORY_XP
725 );
726
727 //
728 // Data
729 //
730 SmmClearMemoryAttributes (
731 mCpuHotPlugData.SmBase[Index] + SMM_HANDLER_OFFSET + TileCodeSize,
732 TileSize - TileCodeSize,
733 EFI_MEMORY_RO
734 );
735 SmmSetMemoryAttributes (
736 mCpuHotPlugData.SmBase[Index] + SMM_HANDLER_OFFSET + TileCodeSize,
737 TileSize - TileCodeSize,
738 EFI_MEMORY_XP
739 );
740 }
741
742 //
743 // Code
744 //
745 SmmSetMemoryAttributes (
746 mCpuHotPlugData.SmBase[mMaxNumberOfCpus - 1] + SMM_HANDLER_OFFSET,
747 TileCodeSize,
748 EFI_MEMORY_RO
749 );
750 SmmClearMemoryAttributes (
751 mCpuHotPlugData.SmBase[mMaxNumberOfCpus - 1] + SMM_HANDLER_OFFSET,
752 TileCodeSize,
753 EFI_MEMORY_XP
754 );
755
756 //
757 // Data
758 //
759 SmmClearMemoryAttributes (
760 mCpuHotPlugData.SmBase[mMaxNumberOfCpus - 1] + SMM_HANDLER_OFFSET + TileCodeSize,
761 SIZE_32KB - TileCodeSize,
762 EFI_MEMORY_RO
763 );
764 SmmSetMemoryAttributes (
765 mCpuHotPlugData.SmBase[mMaxNumberOfCpus - 1] + SMM_HANDLER_OFFSET + TileCodeSize,
766 SIZE_32KB - TileCodeSize,
767 EFI_MEMORY_XP
768 );
769 }
770
771 /**
772 This function sets GDT/IDT buffer to be RO and XP.
773 **/
774 VOID
775 PatchGdtIdtMap (
776 VOID
777 )
778 {
779 EFI_PHYSICAL_ADDRESS BaseAddress;
780 UINTN Size;
781
782 //
783 // GDT
784 //
785 DEBUG ((DEBUG_INFO, "PatchGdtIdtMap - GDT:\n"));
786
787 BaseAddress = mGdtBuffer;
788 Size = ALIGN_VALUE(mGdtBufferSize, SIZE_4KB);
789 //
790 // The range should have been set to RO
791 // if it is allocated with EfiRuntimeServicesCode.
792 //
793 SmmSetMemoryAttributes (
794 BaseAddress,
795 Size,
796 EFI_MEMORY_XP
797 );
798
799 //
800 // IDT
801 //
802 DEBUG ((DEBUG_INFO, "PatchGdtIdtMap - IDT:\n"));
803
804 BaseAddress = gcSmiIdtr.Base;
805 Size = ALIGN_VALUE(gcSmiIdtr.Limit + 1, SIZE_4KB);
806 //
807 // The range should have been set to RO
808 // if it is allocated with EfiRuntimeServicesCode.
809 //
810 SmmSetMemoryAttributes (
811 BaseAddress,
812 Size,
813 EFI_MEMORY_XP
814 );
815 }
816
817 /**
818 This function sets memory attribute according to MemoryAttributesTable.
819 **/
820 VOID
821 SetMemMapAttributes (
822 VOID
823 )
824 {
825 EFI_MEMORY_DESCRIPTOR *MemoryMap;
826 EFI_MEMORY_DESCRIPTOR *MemoryMapStart;
827 UINTN MemoryMapEntryCount;
828 UINTN DescriptorSize;
829 UINTN Index;
830 EDKII_PI_SMM_MEMORY_ATTRIBUTES_TABLE *MemoryAttributesTable;
831
832 SmmGetSystemConfigurationTable (&gEdkiiPiSmmMemoryAttributesTableGuid, (VOID **)&MemoryAttributesTable);
833 if (MemoryAttributesTable == NULL) {
834 DEBUG ((DEBUG_INFO, "MemoryAttributesTable - NULL\n"));
835 return ;
836 }
837
838 DEBUG ((DEBUG_INFO, "MemoryAttributesTable:\n"));
839 DEBUG ((DEBUG_INFO, " Version - 0x%08x\n", MemoryAttributesTable->Version));
840 DEBUG ((DEBUG_INFO, " NumberOfEntries - 0x%08x\n", MemoryAttributesTable->NumberOfEntries));
841 DEBUG ((DEBUG_INFO, " DescriptorSize - 0x%08x\n", MemoryAttributesTable->DescriptorSize));
842
843 MemoryMapEntryCount = MemoryAttributesTable->NumberOfEntries;
844 DescriptorSize = MemoryAttributesTable->DescriptorSize;
845 MemoryMapStart = (EFI_MEMORY_DESCRIPTOR *)(MemoryAttributesTable + 1);
846 MemoryMap = MemoryMapStart;
847 for (Index = 0; Index < MemoryMapEntryCount; Index++) {
848 DEBUG ((DEBUG_INFO, "Entry (0x%x)\n", MemoryMap));
849 DEBUG ((DEBUG_INFO, " Type - 0x%x\n", MemoryMap->Type));
850 DEBUG ((DEBUG_INFO, " PhysicalStart - 0x%016lx\n", MemoryMap->PhysicalStart));
851 DEBUG ((DEBUG_INFO, " VirtualStart - 0x%016lx\n", MemoryMap->VirtualStart));
852 DEBUG ((DEBUG_INFO, " NumberOfPages - 0x%016lx\n", MemoryMap->NumberOfPages));
853 DEBUG ((DEBUG_INFO, " Attribute - 0x%016lx\n", MemoryMap->Attribute));
854 MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, DescriptorSize);
855 }
856
857 MemoryMap = MemoryMapStart;
858 for (Index = 0; Index < MemoryMapEntryCount; Index++) {
859 DEBUG ((DEBUG_VERBOSE, "SetAttribute: Memory Entry - 0x%lx, 0x%x\n", MemoryMap->PhysicalStart, MemoryMap->NumberOfPages));
860 switch (MemoryMap->Type) {
861 case EfiRuntimeServicesCode:
862 SmmSetMemoryAttributes (
863 MemoryMap->PhysicalStart,
864 EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages),
865 EFI_MEMORY_RO
866 );
867 break;
868 case EfiRuntimeServicesData:
869 SmmSetMemoryAttributes (
870 MemoryMap->PhysicalStart,
871 EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages),
872 EFI_MEMORY_XP
873 );
874 break;
875 default:
876 SmmSetMemoryAttributes (
877 MemoryMap->PhysicalStart,
878 EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages),
879 EFI_MEMORY_XP
880 );
881 break;
882 }
883 MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, DescriptorSize);
884 }
885
886 PatchSmmSaveStateMap ();
887 PatchGdtIdtMap ();
888
889 return ;
890 }
891
892 /**
893 Sort memory map entries based upon PhysicalStart, from low to high.
894
895 @param MemoryMap A pointer to the buffer in which firmware places
896 the current memory map.
897 @param MemoryMapSize Size, in bytes, of the MemoryMap buffer.
898 @param DescriptorSize Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
899 **/
900 STATIC
901 VOID
902 SortMemoryMap (
903 IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
904 IN UINTN MemoryMapSize,
905 IN UINTN DescriptorSize
906 )
907 {
908 EFI_MEMORY_DESCRIPTOR *MemoryMapEntry;
909 EFI_MEMORY_DESCRIPTOR *NextMemoryMapEntry;
910 EFI_MEMORY_DESCRIPTOR *MemoryMapEnd;
911 EFI_MEMORY_DESCRIPTOR TempMemoryMap;
912
913 MemoryMapEntry = MemoryMap;
914 NextMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
915 MemoryMapEnd = (EFI_MEMORY_DESCRIPTOR *) ((UINT8 *) MemoryMap + MemoryMapSize);
916 while (MemoryMapEntry < MemoryMapEnd) {
917 while (NextMemoryMapEntry < MemoryMapEnd) {
918 if (MemoryMapEntry->PhysicalStart > NextMemoryMapEntry->PhysicalStart) {
919 CopyMem (&TempMemoryMap, MemoryMapEntry, sizeof(EFI_MEMORY_DESCRIPTOR));
920 CopyMem (MemoryMapEntry, NextMemoryMapEntry, sizeof(EFI_MEMORY_DESCRIPTOR));
921 CopyMem (NextMemoryMapEntry, &TempMemoryMap, sizeof(EFI_MEMORY_DESCRIPTOR));
922 }
923
924 NextMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (NextMemoryMapEntry, DescriptorSize);
925 }
926
927 MemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
928 NextMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
929 }
930 }
931
932 /**
933 Return if a UEFI memory page should be marked as not present in SMM page table.
934 If the memory map entries type is
935 EfiLoaderCode/Data, EfiBootServicesCode/Data, EfiConventionalMemory,
936 EfiUnusableMemory, EfiACPIReclaimMemory, return TRUE.
937 Or return FALSE.
938
939 @param[in] MemoryMap A pointer to the memory descriptor.
940
941 @return TRUE The memory described will be marked as not present in SMM page table.
942 @return FALSE The memory described will not be marked as not present in SMM page table.
943 **/
944 BOOLEAN
945 IsUefiPageNotPresent (
946 IN EFI_MEMORY_DESCRIPTOR *MemoryMap
947 )
948 {
949 switch (MemoryMap->Type) {
950 case EfiLoaderCode:
951 case EfiLoaderData:
952 case EfiBootServicesCode:
953 case EfiBootServicesData:
954 case EfiConventionalMemory:
955 case EfiUnusableMemory:
956 case EfiACPIReclaimMemory:
957 return TRUE;
958 default:
959 return FALSE;
960 }
961 }
962
963 /**
964 Merge continous memory map entries whose type is
965 EfiLoaderCode/Data, EfiBootServicesCode/Data, EfiConventionalMemory,
966 EfiUnusableMemory, EfiACPIReclaimMemory, because the memory described by
967 these entries will be set as NOT present in SMM page table.
968
969 @param[in, out] MemoryMap A pointer to the buffer in which firmware places
970 the current memory map.
971 @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the
972 MemoryMap buffer. On input, this is the size of
973 the current memory map. On output,
974 it is the size of new memory map after merge.
975 @param[in] DescriptorSize Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
976 **/
977 STATIC
978 VOID
979 MergeMemoryMapForNotPresentEntry (
980 IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
981 IN OUT UINTN *MemoryMapSize,
982 IN UINTN DescriptorSize
983 )
984 {
985 EFI_MEMORY_DESCRIPTOR *MemoryMapEntry;
986 EFI_MEMORY_DESCRIPTOR *MemoryMapEnd;
987 UINT64 MemoryBlockLength;
988 EFI_MEMORY_DESCRIPTOR *NewMemoryMapEntry;
989 EFI_MEMORY_DESCRIPTOR *NextMemoryMapEntry;
990
991 MemoryMapEntry = MemoryMap;
992 NewMemoryMapEntry = MemoryMap;
993 MemoryMapEnd = (EFI_MEMORY_DESCRIPTOR *) ((UINT8 *) MemoryMap + *MemoryMapSize);
994 while ((UINTN)MemoryMapEntry < (UINTN)MemoryMapEnd) {
995 CopyMem (NewMemoryMapEntry, MemoryMapEntry, sizeof(EFI_MEMORY_DESCRIPTOR));
996 NextMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
997
998 do {
999 MemoryBlockLength = (UINT64) (EFI_PAGES_TO_SIZE((UINTN)MemoryMapEntry->NumberOfPages));
1000 if (((UINTN)NextMemoryMapEntry < (UINTN)MemoryMapEnd) &&
1001 IsUefiPageNotPresent(MemoryMapEntry) && IsUefiPageNotPresent(NextMemoryMapEntry) &&
1002 ((MemoryMapEntry->PhysicalStart + MemoryBlockLength) == NextMemoryMapEntry->PhysicalStart)) {
1003 MemoryMapEntry->NumberOfPages += NextMemoryMapEntry->NumberOfPages;
1004 if (NewMemoryMapEntry != MemoryMapEntry) {
1005 NewMemoryMapEntry->NumberOfPages += NextMemoryMapEntry->NumberOfPages;
1006 }
1007
1008 NextMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (NextMemoryMapEntry, DescriptorSize);
1009 continue;
1010 } else {
1011 MemoryMapEntry = PREVIOUS_MEMORY_DESCRIPTOR (NextMemoryMapEntry, DescriptorSize);
1012 break;
1013 }
1014 } while (TRUE);
1015
1016 MemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
1017 NewMemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (NewMemoryMapEntry, DescriptorSize);
1018 }
1019
1020 *MemoryMapSize = (UINTN)NewMemoryMapEntry - (UINTN)MemoryMap;
1021
1022 return ;
1023 }
1024
1025 /**
1026 This function caches the UEFI memory map information.
1027 **/
1028 VOID
1029 GetUefiMemoryMap (
1030 VOID
1031 )
1032 {
1033 EFI_STATUS Status;
1034 UINTN MapKey;
1035 UINT32 DescriptorVersion;
1036 EFI_MEMORY_DESCRIPTOR *MemoryMap;
1037 UINTN UefiMemoryMapSize;
1038
1039 DEBUG ((DEBUG_INFO, "GetUefiMemoryMap\n"));
1040
1041 UefiMemoryMapSize = 0;
1042 MemoryMap = NULL;
1043 Status = gBS->GetMemoryMap (
1044 &UefiMemoryMapSize,
1045 MemoryMap,
1046 &MapKey,
1047 &mUefiDescriptorSize,
1048 &DescriptorVersion
1049 );
1050 ASSERT (Status == EFI_BUFFER_TOO_SMALL);
1051
1052 do {
1053 Status = gBS->AllocatePool (EfiBootServicesData, UefiMemoryMapSize, (VOID **)&MemoryMap);
1054 ASSERT (MemoryMap != NULL);
1055 if (MemoryMap == NULL) {
1056 return ;
1057 }
1058
1059 Status = gBS->GetMemoryMap (
1060 &UefiMemoryMapSize,
1061 MemoryMap,
1062 &MapKey,
1063 &mUefiDescriptorSize,
1064 &DescriptorVersion
1065 );
1066 if (EFI_ERROR (Status)) {
1067 gBS->FreePool (MemoryMap);
1068 MemoryMap = NULL;
1069 }
1070 } while (Status == EFI_BUFFER_TOO_SMALL);
1071
1072 if (MemoryMap == NULL) {
1073 return ;
1074 }
1075
1076 SortMemoryMap (MemoryMap, UefiMemoryMapSize, mUefiDescriptorSize);
1077 MergeMemoryMapForNotPresentEntry (MemoryMap, &UefiMemoryMapSize, mUefiDescriptorSize);
1078
1079 mUefiMemoryMapSize = UefiMemoryMapSize;
1080 mUefiMemoryMap = AllocateCopyPool (UefiMemoryMapSize, MemoryMap);
1081 ASSERT (mUefiMemoryMap != NULL);
1082
1083 gBS->FreePool (MemoryMap);
1084 }
1085
1086 /**
1087 This function sets UEFI memory attribute according to UEFI memory map.
1088
1089 The normal memory region is marked as not present, such as
1090 EfiLoaderCode/Data, EfiBootServicesCode/Data, EfiConventionalMemory,
1091 EfiUnusableMemory, EfiACPIReclaimMemory.
1092 **/
1093 VOID
1094 SetUefiMemMapAttributes (
1095 VOID
1096 )
1097 {
1098 EFI_STATUS Status;
1099 EFI_MEMORY_DESCRIPTOR *MemoryMap;
1100 UINTN MemoryMapEntryCount;
1101 UINTN Index;
1102
1103 DEBUG ((DEBUG_INFO, "SetUefiMemMapAttributes\n"));
1104
1105 if (mUefiMemoryMap == NULL) {
1106 DEBUG ((DEBUG_INFO, "UefiMemoryMap - NULL\n"));
1107 return ;
1108 }
1109
1110 MemoryMapEntryCount = mUefiMemoryMapSize/mUefiDescriptorSize;
1111 MemoryMap = mUefiMemoryMap;
1112 for (Index = 0; Index < MemoryMapEntryCount; Index++) {
1113 if (IsUefiPageNotPresent(MemoryMap)) {
1114 Status = SmmSetMemoryAttributes (
1115 MemoryMap->PhysicalStart,
1116 EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages),
1117 EFI_MEMORY_RP
1118 );
1119 DEBUG ((
1120 DEBUG_INFO,
1121 "UefiMemory protection: 0x%lx - 0x%lx %r\n",
1122 MemoryMap->PhysicalStart,
1123 MemoryMap->PhysicalStart + (UINT64)EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages),
1124 Status
1125 ));
1126 }
1127 MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, mUefiDescriptorSize);
1128 }
1129
1130 //
1131 // Do free mUefiMemoryMap, it will be checked in IsSmmCommBufferForbiddenAddress().
1132 //
1133 }
1134
1135 /**
1136 Return if the Address is forbidden as SMM communication buffer.
1137
1138 @param[in] Address the address to be checked
1139
1140 @return TRUE The address is forbidden as SMM communication buffer.
1141 @return FALSE The address is allowed as SMM communication buffer.
1142 **/
1143 BOOLEAN
1144 IsSmmCommBufferForbiddenAddress (
1145 IN UINT64 Address
1146 )
1147 {
1148 EFI_MEMORY_DESCRIPTOR *MemoryMap;
1149 UINTN MemoryMapEntryCount;
1150 UINTN Index;
1151
1152 if (mUefiMemoryMap == NULL) {
1153 return FALSE;
1154 }
1155
1156 MemoryMap = mUefiMemoryMap;
1157 MemoryMapEntryCount = mUefiMemoryMapSize/mUefiDescriptorSize;
1158 for (Index = 0; Index < MemoryMapEntryCount; Index++) {
1159 if (IsUefiPageNotPresent (MemoryMap)) {
1160 if ((Address >= MemoryMap->PhysicalStart) &&
1161 (Address < MemoryMap->PhysicalStart + EFI_PAGES_TO_SIZE((UINTN)MemoryMap->NumberOfPages)) ) {
1162 return TRUE;
1163 }
1164 }
1165 MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, mUefiDescriptorSize);
1166 }
1167 return FALSE;
1168 }
1169
1170 /**
1171 This function set given attributes of the memory region specified by
1172 BaseAddress and Length.
1173
1174 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1175 @param BaseAddress The physical address that is the start address of
1176 a memory region.
1177 @param Length The size in bytes of the memory region.
1178 @param Attributes The bit mask of attributes to set for the memory
1179 region.
1180
1181 @retval EFI_SUCCESS The attributes were set for the memory region.
1182 @retval EFI_INVALID_PARAMETER Length is zero.
1183 Attributes specified an illegal combination of
1184 attributes that cannot be set together.
1185 @retval EFI_UNSUPPORTED The processor does not support one or more
1186 bytes of the memory resource range specified
1187 by BaseAddress and Length.
1188 The bit mask of attributes is not supported for
1189 the memory resource range specified by
1190 BaseAddress and Length.
1191
1192 **/
1193 EFI_STATUS
1194 EFIAPI
1195 EdkiiSmmSetMemoryAttributes (
1196 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,
1197 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1198 IN UINT64 Length,
1199 IN UINT64 Attributes
1200 )
1201 {
1202 return SmmSetMemoryAttributes (BaseAddress, Length, Attributes);
1203 }
1204
1205 /**
1206 This function clears given attributes of the memory region specified by
1207 BaseAddress and Length.
1208
1209 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1210 @param BaseAddress The physical address that is the start address of
1211 a memory region.
1212 @param Length The size in bytes of the memory region.
1213 @param Attributes The bit mask of attributes to clear for the memory
1214 region.
1215
1216 @retval EFI_SUCCESS The attributes were cleared for the memory region.
1217 @retval EFI_INVALID_PARAMETER Length is zero.
1218 Attributes specified an illegal combination of
1219 attributes that cannot be cleared together.
1220 @retval EFI_UNSUPPORTED The processor does not support one or more
1221 bytes of the memory resource range specified
1222 by BaseAddress and Length.
1223 The bit mask of attributes is not supported for
1224 the memory resource range specified by
1225 BaseAddress and Length.
1226
1227 **/
1228 EFI_STATUS
1229 EFIAPI
1230 EdkiiSmmClearMemoryAttributes (
1231 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,
1232 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1233 IN UINT64 Length,
1234 IN UINT64 Attributes
1235 )
1236 {
1237 return SmmClearMemoryAttributes (BaseAddress, Length, Attributes);
1238 }
1239
1240 /**
1241 This function retrieves the attributes of the memory region specified by
1242 BaseAddress and Length. If different attributes are got from different part
1243 of the memory region, EFI_NO_MAPPING will be returned.
1244
1245 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1246 @param BaseAddress The physical address that is the start address of
1247 a memory region.
1248 @param Length The size in bytes of the memory region.
1249 @param Attributes Pointer to attributes returned.
1250
1251 @retval EFI_SUCCESS The attributes got for the memory region.
1252 @retval EFI_INVALID_PARAMETER Length is zero.
1253 Attributes is NULL.
1254 @retval EFI_NO_MAPPING Attributes are not consistent cross the memory
1255 region.
1256 @retval EFI_UNSUPPORTED The processor does not support one or more
1257 bytes of the memory resource range specified
1258 by BaseAddress and Length.
1259
1260 **/
1261 EFI_STATUS
1262 EFIAPI
1263 EdkiiSmmGetMemoryAttributes (
1264 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,
1265 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1266 IN UINT64 Length,
1267 OUT UINT64 *Attributes
1268 )
1269 {
1270 EFI_PHYSICAL_ADDRESS Address;
1271 UINT64 *PageEntry;
1272 UINT64 MemAttr;
1273 PAGE_ATTRIBUTE PageAttr;
1274 INT64 Size;
1275
1276 if (Length < SIZE_4KB || Attributes == NULL) {
1277 return EFI_INVALID_PARAMETER;
1278 }
1279
1280 Size = (INT64)Length;
1281 MemAttr = (UINT64)-1;
1282
1283 do {
1284
1285 PageEntry = GetPageTableEntry (BaseAddress, &PageAttr);
1286 if (PageEntry == NULL || PageAttr == PageNone) {
1287 return EFI_UNSUPPORTED;
1288 }
1289
1290 //
1291 // If the memory range is cross page table boundary, make sure they
1292 // share the same attribute. Return EFI_NO_MAPPING if not.
1293 //
1294 *Attributes = GetAttributesFromPageEntry (PageEntry);
1295 if (MemAttr != (UINT64)-1 && *Attributes != MemAttr) {
1296 return EFI_NO_MAPPING;
1297 }
1298
1299 switch (PageAttr) {
1300 case Page4K:
1301 Address = *PageEntry & ~mAddressEncMask & PAGING_4K_ADDRESS_MASK_64;
1302 Size -= (SIZE_4KB - (BaseAddress - Address));
1303 BaseAddress += (SIZE_4KB - (BaseAddress - Address));
1304 break;
1305
1306 case Page2M:
1307 Address = *PageEntry & ~mAddressEncMask & PAGING_2M_ADDRESS_MASK_64;
1308 Size -= SIZE_2MB - (BaseAddress - Address);
1309 BaseAddress += SIZE_2MB - (BaseAddress - Address);
1310 break;
1311
1312 case Page1G:
1313 Address = *PageEntry & ~mAddressEncMask & PAGING_1G_ADDRESS_MASK_64;
1314 Size -= SIZE_1GB - (BaseAddress - Address);
1315 BaseAddress += SIZE_1GB - (BaseAddress - Address);
1316 break;
1317
1318 default:
1319 return EFI_UNSUPPORTED;
1320 }
1321
1322 MemAttr = *Attributes;
1323
1324 } while (Size > 0);
1325
1326 return EFI_SUCCESS;
1327 }
1328