Initial import.

[mirror_edk2.git] / EdkModulePkg / Universal / Runtime / RuntimeDxe / Runtime.h

/*++\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:\r
\r
  Runtime.h\r
\r
Abstract:\r
\r
  Runtime Architectural Protocol as defined in the DXE CIS\r
\r
  This code is used to produce the EFI runtime virtual switch over\r
\r
--*/\r
\r
#ifndef _RUNTIME_H_\r
#define _RUNTIME_H_\r
\r
//\r
// Data structures\r
//\r
typedef struct {\r
  LIST_ENTRY            Link;\r
  BOOLEAN               Valid;\r
  EFI_PHYSICAL_ADDRESS  ImageBase;\r
  UINTN                 ImageSize;  // In no. of pages\r
  VOID                  *RelocationData;\r
} RUNTIME_IMAGE_RELOCATION_DATA;\r
\r
typedef struct {\r
  LIST_ENTRY          Link;\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
} RUNTIME_NOTIFY_EVENT_DATA;\r
\r
//\r
// Function Prototypes\r
//\r
VOID\r
RelocatePeImageForRuntime (\r
  RUNTIME_IMAGE_RELOCATION_DATA  *Image\r
  )\r
;\r
\r
EFI_STATUS\r
PeHotRelocateImageEx (\r
  IN UINT16      *Reloc,\r
  IN OUT CHAR8   *Fixup,\r
  IN OUT CHAR8   **FixupData,\r
  IN UINT64      Adjust\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverCalculateCrc32 (\r
  IN  VOID    *Data,\r
  IN  UINTN   DataSize,\r
  OUT UINT32  *CrcOut\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverRegisterImage (\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
EFI_STATUS\r
EFIAPI\r
RuntimeDriverRegisterEvent (\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
EFI_STATUS\r
EFIAPI\r
RuntimeDriverConvertPointer (\r
  IN     UINTN  DebugDisposition,\r
  IN OUT VOID   **ConvertAddress\r
  )\r
;\r
\r
VOID\r
RuntimeDriverInitializeCrc32Table (\r
  VOID\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverInitialize (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  )\r
;\r
\r
\r
//\r
// Cache Flush Routine.\r
//\r
EFI_STATUS\r
FlushCpuCache (\r
  IN EFI_PHYSICAL_ADDRESS          Start,\r
  IN UINT64                        Length\r
  )\r
;\r
\r
#endif\r