2 Runtime Architectural Protocol as defined in DXE CIS
4 This code is used to produce the EFI 1.0 runtime virtual switch over
6 This driver must add SetVirtualAddressMap () and ConvertPointer () to
7 the EFI system table. This driver is not responcible for CRCing the
10 This driver will add EFI_RUNTIME_ARCH_PROTOCOL_GUID protocol with a
11 pointer to the Runtime Arch Protocol instance structure. The protocol
12 member functions are used by the DXE core to export information need
13 by this driver to produce the runtime transition to virtual mode
16 Copyright (c) 2006, Intel Corporation
17 All rights reserved. This program and the accompanying materials
18 are licensed and made available under the terms and conditions of the BSD License
19 which accompanies this distribution. The full text of the license may be found at
20 http://opensource.org/licenses/bsd-license.php
22 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
23 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
25 Module Name: Runtime.h
27 @par Revision Reference:
32 #ifndef __ARCH_PROTOCOL_RUNTIME_H__
33 #define __ARCH_PROTOCOL_RUNTIME_H__
36 // Global ID for the Runtime Architectural Protocol
38 #define EFI_RUNTIME_ARCH_PROTOCOL_GUID \
39 { 0xb7dfb4e1, 0x52f, 0x449f, {0x87, 0xbe, 0x98, 0x18, 0xfc, 0x91, 0xb7, 0x33 } }
41 typedef struct _EFI_RUNTIME_ARCH_PROTOCOL EFI_RUNTIME_ARCH_PROTOCOL
;
44 // LIST_ENTRY from BaseType
46 typedef LIST_ENTRY EFI_LIST_ENTRY
;
48 typedef struct _EFI_RUNTIME_IMAGE_ENTRY EFI_RUNTIME_IMAGE_ENTRY
;
50 struct _EFI_RUNTIME_IMAGE_ENTRY
{
58 typedef struct _EFI_RUNTIME_EVENT_ENTRY EFI_RUNTIME_EVENT_ENTRY
;
60 struct _EFI_RUNTIME_EVENT_ENTRY
{
63 EFI_EVENT_NOTIFY NotifyFunction
;
70 // Interface stucture for the Runtime Architectural Protocol
73 @par Protocol Description:
74 Allows the runtime functionality of the DXE Foundation to be contained in a
75 separate driver. It also provides hooks for the DXE Foundation to export
76 information that is needed at runtime. As such, this protocol allows the DXE
77 Foundation to manage runtime drivers and events. This protocol also implies
78 that the runtime services required to transition to virtual mode,
79 SetVirtualAddressMap() and ConvertPointer(), have been registered into the
80 EFI Runtime Table in the EFI System Partition. This protocol must be produced
81 by a runtime DXE driver and may only be consumed by the DXE Foundation.
84 A list of type EFI_RUNTIME_IMAGE_ENTRY.
87 A list of type EFI_RUNTIME_EVENT_ENTRY.
89 @param MemoryDescriptorSize
90 Size of a memory descriptor that is return by GetMemoryMap().
92 @param MemoryDescriptorVersion
93 Version of a memory descriptor that is return by GetMemoryMap().
96 Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
98 @param MemoryMapPhysical
99 Pointer to a runtime buffer that contains a copy of
100 the memory map returned via GetMemoryMap().
102 @param MemoryMapVirtual
103 Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
106 Boolean that is TRUE if SetVirtualAddressMap() has been called.
109 Boolean that is TRUE if ExitBootServices () has been called.
112 struct _EFI_RUNTIME_ARCH_PROTOCOL
{
113 EFI_LIST_ENTRY ImageHead
;
114 EFI_LIST_ENTRY EventHead
;
115 UINTN MemoryDescriptorSize
;
116 UINT32 MemoryDesciptorVersion
;
118 EFI_MEMORY_DESCRIPTOR
*MemoryMapPhysical
;
119 EFI_MEMORY_DESCRIPTOR
*MemoryMapVirtual
;
124 extern EFI_GUID gEfiRuntimeArchProtocolGuid
;