/** @file
Runtime Architectural Protocol as defined in PI Specification VOLUME 2 DXE
Allows the runtime functionality of the DXE Foundation to be contained
in a separate driver. It also provides hooks for the DXE Foundation to
export information that is needed at runtime. As such, this protocol allows
services to the DXE Foundation to manage runtime drivers and events.
This protocol also implies that the runtime services required to transition
to virtual mode, SetVirtualAddressMap() and ConvertPointer(), have been
registered into the UEFI Runtime Table in the UEFI System Table. This protocol
must be produced by a runtime DXE driver and may only be consumed by the DXE Foundation.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __ARCH_PROTOCOL_RUNTIME_H__
#define __ARCH_PROTOCOL_RUNTIME_H__
///
/// Global ID for the Runtime Architectural Protocol
///
#define EFI_RUNTIME_ARCH_PROTOCOL_GUID \
{ 0xb7dfb4e1, 0x52f, 0x449f, {0x87, 0xbe, 0x98, 0x18, 0xfc, 0x91, 0xb7, 0x33 } }
///
/// LIST_ENTRY from BaseType
///
///
/// EFI_RUNTIME_IMAGE_ENTRY
///
struct _EFI_RUNTIME_IMAGE_ENTRY {
///
/// Start of image that has been loaded in memory. It is a pointer
/// to either the DOS header or PE header of the image.
///
///
/// Size in bytes of the image represented by ImageBase.
///
///
/// Information about the fix-ups that were performed on ImageBase when it was
/// loaded into memory.
///
///
/// The ImageHandle passed into ImageBase when it was loaded.
///
///
/// Entry for this node in the EFI_RUNTIME_ARCHITECTURE_PROTOCOL.ImageHead list.
///
};
///
/// EFI_RUNTIME_EVENT_ENTRY
///
struct _EFI_RUNTIME_EVENT_ENTRY {
///
/// The same as Type passed into CreateEvent().
///
///
/// The same as NotifyTpl passed into CreateEvent().
///
///
/// The same as NotifyFunction passed into CreateEvent().
///
///
/// The same as NotifyContext passed into CreateEvent().
///
///
/// The EFI_EVENT returned by CreateEvent(). Event must be in runtime memory.
///
///
/// Entry for this node in the
/// EFI_RUNTIME_ARCHITECTURE_PROTOCOL.EventHead list.
///
};
///
/// Allows the runtime functionality of the DXE Foundation to be contained in a
/// separate driver. It also provides hooks for the DXE Foundation to export
/// information that is needed at runtime. As such, this protocol allows the DXE
/// Foundation to manage runtime drivers and events. This protocol also implies
/// that the runtime services required to transition to virtual mode,
/// 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.
///
struct _EFI_RUNTIME_ARCH_PROTOCOL {
UINT32 MemoryDesciptorVersion; ///< Version of a memory descriptor that is returned by GetMemoryMap().
UINTN MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
///< the memory map returned via GetMemoryMap().
EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual; ///< Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
};
extern EFI_GUID gEfiRuntimeArchProtocolGuid;
#endif