Sync this file with MiscSubClass spec and add some struture alias to use them more...

[mirror_edk2.git] / MdePkg / Include / Dxe / ArchProtocol / Runtime.h

/** @file\r
  Runtime Architectural Protocol as defined in DXE CIS\r
\r
  This code is used to produce the EFI 1.0 runtime virtual switch over\r
\r
  This driver must add SetVirtualAddressMap () and ConvertPointer () to\r
  the EFI system table. This driver is not responcible for CRCing the \r
  EFI system table.\r
\r
  This driver will add EFI_RUNTIME_ARCH_PROTOCOL_GUID protocol with a \r
  pointer to the Runtime Arch Protocol instance structure. The protocol\r
  member functions are used by the DXE core to export information need\r
  by this driver to produce the runtime transition to virtual mode\r
  calling.\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  Module Name:  Runtime.h\r
\r
  @par Revision Reference:\r
  Version 0.90.\r
\r
**/\r
\r
#ifndef __ARCH_PROTOCOL_RUNTIME_H__\r
#define __ARCH_PROTOCOL_RUNTIME_H__\r
\r
//\r
// Global ID for the Runtime Architectural Protocol\r
//\r
#define EFI_RUNTIME_ARCH_PROTOCOL_GUID \\r
  { 0x96d08253, 0x8483, 0x11d4, {0xbc, 0xf1, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
\r
typedef struct _EFI_RUNTIME_ARCH_PROTOCOL   EFI_RUNTIME_ARCH_PROTOCOL;\r
\r
/**\r
  When a SetVirtualAddressMap() is performed all the runtime images loaded by \r
  DXE must be fixed up with the new virtual address map. To facilitate this the \r
  Runtime Architectural Protocol needs to be informed of every runtime driver \r
  that is registered.  All the runtime images loaded by DXE should be registered \r
  with this service by the DXE Core when ExitBootServices() is called.  The \r
  images that are registered with this service must have successfully been \r
  loaded into memory with the Boot Service LoadImage().  As a result, no \r
  parameter checking needs to be performed.\r
\r
  @param  This             The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
  @param  ImageBase        Start of image that has been loaded in memory. It is either\r
                           a pointer to the DOS or PE header of the image.\r
  @param  ImageSize        Size of the image in bytes.\r
  @param  RelocationData   Information about the fixups that were performed on ImageBase\r
                           when it was loaded into memory. This information is needed\r
                           when the virtual mode fix-ups are reapplied so that data that\r
                           has been programmatically updated will not be fixed up. If\r
                           code updates a global variable the code is responsible for\r
                           fixing up the variable for virtual mode.\r
\r
  @retval EFI_SUCCESS           The ImageBase has been registered.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to register ImageBase.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_RUNTIME_REGISTER_IMAGE) (\r
  IN EFI_RUNTIME_ARCH_PROTOCOL  *This,\r
  IN  EFI_PHYSICAL_ADDRESS              ImageBase,   \r
  IN  UINTN                             ImageSize,     \r
  IN  VOID                              *RelocationData    \r
  );\r
\r
\r
/**\r
  This function is used to support the required runtime events. Currently only \r
  runtime events of type EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE needs to be \r
  registered with this service.  All the runtime events that exist in the DXE \r
  Core should be registered with this service when ExitBootServices() is called.  \r
  All the events that are registered with this service must have been created \r
  with the Boot Service CreateEvent().  As a result, no parameter checking needs \r
  to be performed.\r
\r
  @param  This             The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
  @param  Type             The same as Type passed into CreateEvent().\r
  @param  NotifyTpl        The same as NotifyTpl passed into CreateEvent().\r
  @param  NotifyFunction   The same as NotifyFunction passed into CreateEvent().\r
  @param  NotifyContext    The same as NotifyContext passed into CreateEvent().\r
  @param  Event            The EFI_EVENT returned by CreateEvent(). Event must be in\r
                           runtime memory.\r
\r
  @retval EFI_SUCCESS           The Event has been registered.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to register Event.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_RUNTIME_REGISTER_EVENT) (\r
  IN EFI_RUNTIME_ARCH_PROTOCOL  *This,\r
  IN UINT32                             Type,\r
  IN EFI_TPL                            NotifyTpl,\r
  IN EFI_EVENT_NOTIFY                   NotifyFunction,\r
  IN VOID                               *NotifyContext,\r
  IN EFI_EVENT                          *Event\r
  );\r
\r
//\r
// Interface stucture for the Runtime Architectural Protocol\r
//\r
/**\r
  @par Protocol Description:\r
  The DXE driver that produces this protocol must be a runtime driver.  This \r
  driver is responsible for initializing the SetVirtualAddressMap() and \r
  ConvertPointer() fields of the EFI Runtime Services Table and the \r
  CalculateCrc32() field of the EFI Boot Services Table.  See the Runtime \r
  Services chapter and the Boot Services chapter for details on these services.\r
  After the two fields of the EFI Runtime Services Table and the one field of \r
  the EFI Boot Services Table have been initialized, the driver must install \r
  the EFI_RUNTIME_ARCH_PROTOCOL_GUID on a new handle with an EFI_RUNTIME_ARCH_ \r
  PROTOCOL interface pointer.  The installation of this protocol informs the \r
  DXE core that the virtual memory services and the 32-bit CRC services are \r
  now available, and the DXE core must update the 32-bit CRC of the EFI Runtime \r
  Services Table and the 32-bit CRC of the EFI Boot Services Table.\r
\r
  All runtime core services are provided by the EFI_RUNTIME_ARCH_PROTOCOL.  \r
  This includes the support for registering runtime images that must be \r
  re-fixed up when a transition is made from physical mode to virtual mode. \r
  This protocol also supports all events that are defined to fire at runtime. \r
  This protocol also contains a CRC-32 function that will be used by the DXE \r
  core as a boot service. The EFI_RUNTIME_ARCH_PROTOCOL needs the CRC-32 \r
  function when a transition is made from physical mode to virtual mode and \r
  the EFI System Table and EFI Runtime Table are fixed up with virtual pointers.\r
\r
  @param RegisterRuntimeImage\r
  Register a runtime image so it can be converted to virtual mode if the EFI Runtime Services \r
  SetVirtualAddressMap() is called.\r
\r
  @param RegisterRuntimeEvent\r
  Register an event than needs to be notified at runtime. \r
\r
**/\r
struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
  EFI_RUNTIME_REGISTER_IMAGE  RegisterImage;\r
  EFI_RUNTIME_REGISTER_EVENT  RegisterEvent;\r
};\r
\r
extern EFI_GUID gEfiRuntimeArchProtocolGuid;\r
\r
#endif\r