summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include/Protocol/Runtime.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Protocol/Runtime.h')
-rw-r--r--MdePkg/Include/Protocol/Runtime.h65
1 files changed, 36 insertions, 29 deletions
diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h
index 32c3359af8..355fa83fee 100644
--- a/MdePkg/Include/Protocol/Runtime.h
+++ b/MdePkg/Include/Protocol/Runtime.h
@@ -74,45 +74,52 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
SetVirtualAddressMap() and ConvertPointer(), have been registered into the
EFI Runtime Table in the EFI System Partition. This protocol must be produced
by a runtime DXE driver and may only be consumed by the DXE Foundation.
-
- @param ImageHead
- A list of type EFI_RUNTIME_IMAGE_ENTRY.
-
- @param EventHead
- A list of type EFI_RUNTIME_EVENT_ENTRY.
-
- @param MemoryDescriptorSize
- Size of a memory descriptor that is return by GetMemoryMap().
-
- @param MemoryDescriptorVersion
- Version of a memory descriptor that is return by GetMemoryMap().
-
- @param MemoryMapSize
- Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
-
- @param MemoryMapPhysical
- Pointer to a runtime buffer that contains a copy of
- the memory map returned via GetMemoryMap().
-
- @param MemoryMapVirtual
- Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
-
- @param VirtualMode
- Boolean that is TRUE if SetVirtualAddressMap() has been called.
-
- @param AtRuntime
- Boolean that is TRUE if ExitBootServices () has been called.
-
**/
struct _EFI_RUNTIME_ARCH_PROTOCOL {
+ ///
+ /// A list of type EFI_RUNTIME_IMAGE_ENTRY.
+ ///
EFI_LIST_ENTRY ImageHead;
+
+ ///
+ /// A list of type EFI_RUNTIME_EVENT_ENTRY.
+ ///
EFI_LIST_ENTRY EventHead;
+
+ ///
+ /// Size of a memory descriptor that is return by GetMemoryMap().
+ ///
UINTN MemoryDescriptorSize;
+
+ ///
+ /// Version of a memory descriptor that is return by GetMemoryMap().
+ ///
UINT32 MemoryDesciptorVersion;
+
+ ///
+ /// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
+ ///
UINTN MemoryMapSize;
+
+ ///
+ /// Pointer to a runtime buffer that contains a copy of
+ /// the memory map returned via GetMemoryMap().
+ ///
EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical;
+
+ ///
+ /// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
+ ///
EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual;
+
+ ///
+ /// Boolean that is TRUE if SetVirtualAddressMap() has been called.
+ ///
BOOLEAN VirtualMode;
+
+ ///
+ /// Boolean that is TRUE if ExitBootServices () has been called.
+ ///
BOOLEAN AtRuntime;
};