MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Core / RuntimeDxe / Runtime.h

/** @file\r
  Runtime Architectural Protocol as defined in the DXE CIS.\r
\r
  This code is used to produce the EFI runtime architectural protocol.\r
\r
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _RUNTIME_H_\r
#define _RUNTIME_H_\r
\r
#include <PiDxe.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/Runtime.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/PeCoffLib.h>\r
\r
\r
//\r
// Function Prototypes\r
//\r
/**\r
  Calculate CRC32 for target data.\r
\r
  @param Data            The target data.\r
  @param DataSize        The target data size.\r
  @param CrcOut          The CRC32 for target data.\r
\r
  @retval  EFI_SUCCESS            The CRC32 for target data is calculated successfully.\r
  @retval  EFI_INVALID_PARAMETER  Some parameter is not valid, so the CRC32 is not\r
                                  calculated.\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
  Determines the new virtual address that is to be used on subsequent memory accesses.\r
\r
\r
  @param DebugDisposition Supplies type information for the pointer being converted.\r
  @param ConvertAddress  A pointer to a pointer that is to be fixed to be the value needed\r
                         for the new virtual address mappings being applied.\r
\r
  @retval  EFI_SUCCESS              The pointer pointed to by Address was modified.\r
  @retval  EFI_NOT_FOUND            The pointer pointed to by Address was not found to be part\r
                                    of the current memory map. This is normally fatal.\r
  @retval  EFI_INVALID_PARAMETER    One of the parameters has an invalid value.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverConvertPointer (\r
  IN     UINTN  DebugDisposition,\r
  IN OUT VOID   **ConvertAddress\r
  );\r
\r
/**\r
  Changes the runtime addressing mode of EFI firmware from physical to virtual.\r
\r
  @param  MemoryMapSize   The size in bytes of VirtualMap.\r
  @param  DescriptorSize  The size in bytes of an entry in the VirtualMap.\r
  @param  DescriptorVersion The version of the structure entries in VirtualMap.\r
  @param  VirtualMap      An array of memory descriptors which contain new virtual\r
                         address mapping information for all runtime ranges.\r
\r
  @retval  EFI_SUCCESS            The virtual address map has been applied.\r
  @retval  EFI_UNSUPPORTED        EFI firmware is not at runtime, or the EFI firmware is already in\r
                                  virtual address mapped mode.\r
  @retval  EFI_INVALID_PARAMETER  DescriptorSize or DescriptorVersion is invalid.\r
  @retval  EFI_NO_MAPPING         A virtual address was not supplied for a range in the memory\r
                                  map that requires a mapping.\r
  @retval  EFI_NOT_FOUND          A virtual address was supplied for an address that is not found\r
                                  in the memory map.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverSetVirtualAddressMap (\r
  IN UINTN                  MemoryMapSize,\r
  IN UINTN                  DescriptorSize,\r
  IN UINT32                 DescriptorVersion,\r
  IN EFI_MEMORY_DESCRIPTOR  *VirtualMap\r
  );\r
\r
/**\r
  Install Runtime AP. This code includes the EfiRuntimeLib, but it only\r
  functions at RT in physical mode.\r
\r
  @param  ImageHandle     Image handle of this driver.\r
  @param  SystemTable     Pointer to the EFI System Table.\r
\r
  @retval EFI_SUCEESS  Runtime Driver Architectural Protocol Installed\r
  @return Other value if gBS->InstallMultipleProtocolInterfaces fails. Check\r
           gBS->InstallMultipleProtocolInterfaces for details.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverInitialize (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  );\r
\r
#endif\r