OvmfPkg/XenHypercallLib: Enable it in PEIM

[mirror_edk2.git] / OvmfPkg / Include / Library / XenHypercallLib.h

/** @file\r
  Functions declarations to make Xen hypercalls.\r
\r
  Copyright (C) 2014, Citrix Ltd.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __XEN_HYPERCALL_LIB_H__\r
#define __XEN_HYPERCALL_LIB_H__\r
\r
/**\r
  To call when the gEfiXenInfoGuid HOB became available after the library init\r
  function has already been executed.\r
\r
  This allow to make hypercall in the PEIM stage.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
XenHypercallLibInit (\r
  VOID\r
  );\r
\r
/**\r
  Check if the Xen Hypercall library is able to make calls to the Xen\r
  hypervisor.\r
\r
  Client code should call further functions in this library only if, and after,\r
  this function returns TRUE.\r
\r
  @retval TRUE   Hypercalls are available.\r
  @retval FALSE  Hypercalls are not available.\r
**/\r
BOOLEAN\r
EFIAPI\r
XenHypercallIsAvailable (\r
  VOID\r
  );\r
\r
/**\r
  This function will put the two arguments in the right place (registers) and\r
  invoke the hypercall identified by HypercallID.\r
\r
  @param HypercallID    The symbolic ID of the hypercall to be invoked\r
  @param Arg1           First argument.\r
  @param Arg2           Second argument.\r
\r
  @return   Return 0 if success otherwise it return an errno.\r
**/\r
INTN\r
EFIAPI\r
XenHypercall2 (\r
  IN     UINTN  HypercallID,\r
  IN OUT INTN   Arg1,\r
  IN OUT INTN   Arg2\r
  );\r
\r
/**\r
  Return the value of the HVM parameter Index.\r
\r
  @param Index  The parameter to get, e.g. HVM_PARAM_STORE_EVTCHN.\r
\r
  @return   The value of the asked parameter or 0 in case of error.\r
**/\r
UINT64\r
EFIAPI\r
XenHypercallHvmGetParam (\r
  UINT32 Index\r
  );\r
\r
/**\r
  Hypercall to do different operation on the memory.\r
\r
  @param Operation  The operation number, e.g. XENMEM_add_to_physmap.\r
  @param Arguments  The arguments associated to the operation.\r
\r
  @return  Return the return value from the hypercall, 0 in case of success\r
           otherwise, an error code.\r
**/\r
INTN\r
EFIAPI\r
XenHypercallMemoryOp (\r
  IN     UINTN Operation,\r
  IN OUT VOID *Arguments\r
  );\r
\r
/**\r
  Do an operation on the event channels.\r
\r
  @param Operation  The operation number, e.g. EVTCHNOP_send.\r
  @param Arguments  The argument associated to the operation.\r
\r
  @return  Return the return value from the hypercall, 0 in case of success\r
           otherwise, an error code.\r
**/\r
INTN\r
EFIAPI\r
XenHypercallEventChannelOp (\r
  IN     INTN Operation,\r
  IN OUT VOID *Arguments\r
  );\r
\r
#endif\r