Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code-First -- Add new unaccepted memory type describing unaccepted memory. #66

Closed
wants to merge 9 commits into from
Closed

Code-First -- Add new unaccepted memory type describing unaccepted memory. #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
97e9c31
Add new unaccepted memory type describing unaccepted memory.
chris-oo Jul 31, 2020
aa16ee6
Add ECR to git to help track changes & revisions in PR
chris-oo Aug 18, 2020
fb26885
Clear up description of unaccepted memory, add glossary
chris-oo Sep 9, 2020
bffccf3
draft of pi ecr for hob changes
chris-oo Oct 8, 2020
86d956f
add GCD changes, along with PHIT hob
chris-oo Oct 13, 2020
1b17eac
add more line breaks for readability
chris-oo Oct 13, 2020
04afa54
fix a few more markdown errors
chris-oo Oct 13, 2020
1ec33c7
Add section 2.3.4 explicitly calling out pagetable mappings for unacc…
chris-oo Nov 10, 2020
11d70b8
Update verbage to boot target, not guest
chris-oo Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions MdeModulePkg/Core/Dxe/Gcd/Gcd.c
View file
Open in desktop
Expand Up @@ -110,6 +110,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mGcdMemoryTypeNames[] = {
"MMIO ", // EfiGcdMemoryTypeMemoryMappedIo
"PersisMem", // EfiGcdMemoryTypePersistent
"MoreRelia", // EfiGcdMemoryTypeMoreReliable
"Unaccepte", // EfiGcdMemoryTypeUnaccepted
"Unknown " // EfiGcdMemoryTypeMaximum
};

Expand Down Expand Up @@ -2486,6 +2487,9 @@ CoreInitializeGcdServices (
case EFI_RESOURCE_MEMORY_RESERVED:
GcdMemoryType = EfiGcdMemoryTypeReserved;
break;
case EFI_RESOURCE_MEMORY_UNACCEPTED:
GcdMemoryType = EfiGcdMemoryTypeUnaccepted;
break;
case EFI_RESOURCE_IO:
GcdIoType = EfiGcdIoTypeIo;
break;
Expand Down
29 changes: 29 additions & 0 deletions MdeModulePkg/Core/Dxe/Mem/Page.c
View file
Open in desktop
Expand Up @@ -61,6 +61,7 @@ EFI_MEMORY_TYPE_STATISTICS mMemoryTypeStatistics[EfiMaxMemoryType + 1] = {
{ 0, MAX_ALLOC_ADDRESS, 0, 0, EfiMaxMemoryType, FALSE, FALSE }, // EfiMemoryMappedIOPortSpace
{ 0, MAX_ALLOC_ADDRESS, 0, 0, EfiMaxMemoryType, TRUE, TRUE }, // EfiPalCode
{ 0, MAX_ALLOC_ADDRESS, 0, 0, EfiMaxMemoryType, FALSE, FALSE }, // EfiPersistentMemory
{ 0, MAX_ALLOC_ADDRESS, 0, 0, EfiMaxMemoryType, TRUE, FALSE }, // EfiUnacceptedMemory
{ 0, MAX_ALLOC_ADDRESS, 0, 0, EfiMaxMemoryType, FALSE, FALSE } // EfiMaxMemoryType
};

Expand All @@ -83,6 +84,7 @@ EFI_MEMORY_TYPE_INFORMATION gMemoryTypeInformation[EfiMaxMemoryType + 1] = {
{ EfiMemoryMappedIOPortSpace, 0 },
{ EfiPalCode, 0 },
{ EfiPersistentMemory, 0 },
{ EfiUnacceptedMemory, 0 },
{ EfiMaxMemoryType, 0 }
};
//
Expand Down Expand Up @@ -1903,6 +1905,33 @@ CoreGetMemoryMap (
//
MemoryMap = MergeMemoryMapDescriptor (MemoryMapStart, MemoryMap, Size);
}

if (MergeGcdMapEntry.GcdMemoryType == EfiGcdMemoryTypeUnaccepted) {
//
// Page Align GCD range is required. When it is converted to EFI_MEMORY_DESCRIPTOR,
// it will be recorded as page PhysicalStart and NumberOfPages.
//
ASSERT ((MergeGcdMapEntry.BaseAddress & EFI_PAGE_MASK) == 0);
ASSERT (((MergeGcdMapEntry.EndAddress - MergeGcdMapEntry.BaseAddress + 1) & EFI_PAGE_MASK) == 0);

//
// Create EFI_MEMORY_DESCRIPTOR for every Unaccepted GCD entries
//
MemoryMap->PhysicalStart = MergeGcdMapEntry.BaseAddress;
MemoryMap->VirtualStart = 0;
MemoryMap->NumberOfPages = RShiftU64 ((MergeGcdMapEntry.EndAddress - MergeGcdMapEntry.BaseAddress + 1), EFI_PAGE_SHIFT);
MemoryMap->Attribute = MergeGcdMapEntry.Attributes |
(MergeGcdMapEntry.Capabilities & (EFI_MEMORY_RP | EFI_MEMORY_WP | EFI_MEMORY_XP | EFI_MEMORY_RO |
EFI_MEMORY_UC | EFI_MEMORY_UCE | EFI_MEMORY_WC | EFI_MEMORY_WT | EFI_MEMORY_WB));
MemoryMap->Type = EfiUnacceptedMemory;

//
// Check to see if the new Memory Map Descriptor can be merged with an
// existing descriptor if they are adjacent and have the same attributes
//
MemoryMap = MergeMemoryMapDescriptor (MemoryMapStart, MemoryMap, Size);
}

if (Link == &mGcdMemorySpaceMap) {
//
// break loop when arrive at head.
Expand Down
1 change: 1 addition & 0 deletions MdePkg/Include/Pi/PiDxeCis.h
View file
Open in desktop
Expand Up @@ -56,6 +56,7 @@ typedef enum {
/// system. If all memory has the same reliability, then this bit is not used.
///
EfiGcdMemoryTypeMoreReliable,
EfiGcdMemoryTypeUnaccepted,
EfiGcdMemoryTypeMaximum
} EFI_GCD_MEMORY_TYPE;

Expand Down
3 changes: 2 additions & 1 deletion MdePkg/Include/Pi/PiHob.h
View file
Open in desktop
Expand Up @@ -234,7 +234,8 @@ typedef UINT32 EFI_RESOURCE_TYPE;
#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
#define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
#define EFI_RESOURCE_IO_RESERVED 0x00000006
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
#define EFI_RESOURCE_MEMORY_UNACCEPTED 0x00000007
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000008

///
/// A type of recount attribute type.
Expand Down
5 changes: 5 additions & 0 deletions MdePkg/Include/Uefi/UefiMultiPhase.h
View file
Open in desktop
Expand Up @@ -103,6 +103,11 @@ typedef enum {
/// however it happens to also support byte-addressable non-volatility.
///
EfiPersistentMemory,
///
/// A memory region that describes system memory that has not been accepted
/// by a corresponding call to the underlying isolation architecture.
///
EfiUnacceptedMemory,
EfiMaxMemoryType,
//
// MU_CHANGE: moved the MEMORY_TYPE_* defines into enum from MdeModulePkg\Core\Dxe\Mem\Imem.h
Expand Down
142 changes: 142 additions & 0 deletions Unaccepted Memory PI ECR.md
View file
Open in desktop
@@ -0,0 +1,142 @@
# Unified Extensible Firmware Interface Engineering Change Request (ECR)
SPDX-License-Identifier: CC-BY-4.0
# ***Draft for Review***

## Title: Unaccepted Memory Type Addition to PI HOB Resource types and GcdMemoryType
Document: PI V1.8

Sponsors:<br>
***Chris Oo, Microsoft***<br>
***Jon Lange, Microsoft***<br>
***Sean Brogan, Microsoft***<br>
***Brijesh Singh, AMD***<br>
***Thomas Lendacky, AMD***<br>
***Jiewen Yao, Intel***<br>
<br>
**Submission for Review Date: x/xx/2020**<br>
**Review Approval Date: x/xx/2020**<br>
**Submission for Technical Editing Date: x/xx/2020**<br>
**Submission for Draft Review Date: xx/xx/2020**<br>
**Verification Date: x/xx/2020**<br>
**Verifiers: TBD**<br>

## Summary
### Summary of Change
This ECR supports the introduction of a new memory type, unaccepted memory, with updates to the corresponding PI HOB Resource types and GcdMemoryTypes. See the corresponding ECR introducing a new memory type to the EFI_MEMORY_TYPE for more information on unaccepted memory.

### Benefits of the Change
This change allows PEI to reflect the current state of accepted memory to DXE so that it can be used correctly, along with reporting it to the OS loader.

### References

See the following PR for the latest version of this ECR and the corresponding UEFI ECR, at https://github.com/microsoft/mu_basecore/pull/66.

## Detailed Description of the Change and Special Instructions

### Summary of Changes:
- Update Section 7.2.4 Platform Initialization Specification, Vol. 2, Services - DXE Services with AddMemorySpace new unaccepted type
- Update Section 9.8.4 Platform Initialization Specification, Vol. 2, DXE Foundation with Resource Descriptor HOBs Table 2-20 adding a new row describing unaccepted memory
- Update Section 5.3 Platform Initialization Specification, Vol. 3, HOB Code definitions with PHIT version revision
- Update Section 5.5 Platform Initialization Specification, Vol. 3, HOB Code definitions with new resource type

~~Text Removed~~, Text Added ***Text Added*** , New Sections ***New Section***, Discussion/Mode Edits needed ***DME***

#### 7.2.4 Global Coherency Domain Services

**AddMemorySpace()**<br>
...<br>
**Parameters**<br>

**GcdMemoryType**<br>
The type of memory resource being added. Type EFI_GCD_MEMORY_TYPE is defined in “Related Definitions” below. The only types allowed are EfiGcdMemoryTypeReserved, EfiGcdMemoryTypeSystemMemory, EfiGcdMemoryTypePersistent, EfiGcdMemoryTypeMoreReliable, EfiGcdMemoryTypeUnaccepted, and EfiGcdMemoryTypeMemoryMappedIo. ***Text Added***<br>
...<br>
**Description**<br>
...<br>
If GcdMemoryType is not EfiGcdMemoryTypeReserved, EfiGcdMemoryTypeSystemMemory, EfiGcdMemoryTypeMemoryMappedIo, EfiGcdMemoryPersistent, ~~or~~ EfiGcdMemoryTypeMoreReliable or EfiGcdMemoryTypeUnaccepted then EFI_INVALID_PARAMETER is returned. ***Text Added***<br>
...<br>
**Related Definitions**<br>
``` c
//*******************************************************
// EFI_GCD_MEMORY_TYPE
//*******************************************************
typedef enum {
EfiGcdMemoryTypeNonExistent,
EfiGcdMemoryTypeReserved,
EfiGcdMemoryTypeSystemMemory,
EfiGcdMemoryTypeMemoryMappedIo,
EfiGcdMemoryTypePersistent,
EfiGcdMemoryTypeMoreReliable,
EfiGcdMemoryTypeUnaccepted,
EfiGcdMemoryTypeMaximum
} EFI_GCD_MEMORY_TYPE;
```
...<br>
**EfiGcdMemoryTypeMoreReliable**<br>
A memory region that provides higher reliability relative to other memory in the system. If all memory has the same reliability, then this bit is not used.<br>

***Text Added***<br>
**EfiGcdMemoryTypeUnaccepted**<br>
A memory region that is unaccepted. This region must be accepted before it can be converted to system memory.<br>
***Text Added***<br>
...<br>

#### 9.8.4 Resource Descriptor HOBs
...<br>
**Table 2-20: Resource Descriptor HOB to GCD Type Mapping**<br>
| Resource Descriptor HOB | | GCD Map | |
|---------------------------|------------|-----------------------------|----------|
| Resource Type | Attributes | Memory Type | I/O Type |
| System Memory | Present | Reserved | |
| … | … | … | … |
| Memory Reserved | | Reserved | |
| Unaccepted Memory | | Unaccepted ***Text Added*** | |
| … | … | … | … |
...<br>

#### 5.3 PHIT HOB
...<br>
**Related Definitions**<br>
``` c
//*****************************************************
// Version values
//*****************************************************
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x000a // Text Edited
```
...<br>
#### 5.5 Resource Descriptor HOB
...<br>

**Related Definitions**<br>
There can only be a single ResourceType field, characterized as follows.
``` c
//*********************************************************
// EFI_RESOURCE_TYPE
//*********************************************************

typedef UINT32 EFI_RESOURCE_TYPE;

#define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
#define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
#define EFI_RESOURCE_IO 0x00000002
#define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
#define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
#define EFI_RESOURCE_IO_RESERVED 0x00000006
#define EFI_RESOURCE_MEMORY_UNACCEPTED 0x00000007 // Text Added
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000008 // Text Edited
```

The following table describes the fields listed in the above definition.
| EFI_RESOURCE_SYSTEM_MEMORY | Memory that persists out of the HOB producer phase. |
|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| EFI_RESOURCE_MEMORY_MAPPED_IO | Memory-mapped I/O that is programmed in the HOB producer phase. |
| EFI_RESOURCE_IO | Processor I/O space. |
| EFI_RESOURCE_FIRMWARE_DEVICE | Memory-mapped firmware devices. |
| EFI_RESOURCE_MEMORY_MAPPED_IO_PORT | Memory that is decoded to produce I/O cycles. |
| EFI_RESOURCE_MEMORY_RESERVED | Reserved memory address space. |
| EFI_RESOURCE_IO_RESERVED | Reserved I/O address space. |
| EFI_RESOURCE_MEMORY_UNACCEPTED | Memory that is unaccepted. ***Text Added*** |
| EFI_RESOURCE_MAX_MEMORY_TYPE | Any reported HOB value of this type or greater should be deemed illegal. This value could increase with successive revisions of this specification, so the “illegality” will also be based upon the revision field of the PHIT HOB |

### Special Instructions:
#### Discussions / Opens