OvmfPkg/Include/Library/XenPlatformLib.h

   1 /** @file
   2   Get information about Xen
   3
   4   This library simply allow to find out if OVMF is running under Xen and
   5   allow to get more information when it is the case.
   6
   7   Copyright (c) 2019, Citrix Systems, Inc.
   8
   9   SPDX-License-Identifier: BSD-2-Clause-Patent
  10
  11 **/
  12
  13 #ifndef _XEN_PLATFORM_LIB_H_
  14 #define _XEN_PLATFORM_LIB_H_
  15
  16 #include <Guid/XenInfo.h>
  17
  18 /**
  19   This function detects if OVMF is running on Xen.
  20
  21   @retval TRUE    OVMF is running on Xen
  22   @retval FALSE   Xen has not been detected
  23 **/
  24 BOOLEAN
  25 EFIAPI
  26 XenDetected (
  27   VOID
  28   );
  29
  30 /**
  31   This function detect if OVMF have started via the PVH entry point.
  32
  33   @retval TRUE  PVH entry point as been used
  34   @retval FALSE OVMF have started via the HVM route
  35 **/
  36 BOOLEAN
  37 EFIAPI
  38 XenPvhDetected (
  39   VOID
  40   );
  41
  42 /**
  43   This function return a pointer to the XenInfo HOB.
  44
  45   @return  XenInfo pointer or NULL if not available
  46 **/
  47 EFI_XEN_INFO *
  48 EFIAPI
  49 XenGetInfoHOB (
  50   VOID
  51   );
  52
  53 #endif