OvmfPkg/XenBusDxe/XenHypercall.h

   1 /** @file
   2   Functions declarations to make Xen hypercalls.
   3
   4   Copyright (C) 2014, Citrix Ltd.
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __XENBUS_DXE_HYPERCALL_H__
  17 #define __XENBUS_DXE_HYPERCALL_H__
  18
  19 /**
  20   This function will put the two arguments in the right place (registers) and
  21   invoke the hypercall identified by HypercallID.
  22
  23   @param HypercallID    The symbolic ID of the hypercall to be invoked
  24   @param Arg1           First argument.
  25   @param Arg2           Second argument.
  26
  27   @return   Return 0 if success otherwise it return an errno.
  28 **/
  29 INTN
  30 EFIAPI
  31 XenHypercall2 (
  32   IN     INTN HypercallID,
  33   IN OUT INTN Arg1,
  34   IN OUT INTN Arg2
  35   );
  36
  37 /**
  38   Get the page where all hypercall are from the XenInfo hob.
  39
  40   @param Dev    A XENBUS_DEVICE instance.
  41
  42   @retval EFI_NOT_FOUND   hyperpage could not be found.
  43   @retval EFI_SUCCESS     Successfully retrieve the hyperpage pointer.
  44 **/
  45 EFI_STATUS
  46 XenHyperpageInit (
  47   );
  48
  49 /**
  50   Return the value of the HVM parameter Index.
  51
  52   @param Index  The parameter to get, e.g. HVM_PARAM_STORE_EVTCHN.
  53
  54   @return   The value of the asked parameter or 0 in case of error.
  55 **/
  56 UINT64
  57 XenHypercallHvmGetParam (
  58   UINT32 Index
  59   );
  60
  61 /**
  62   Hypercall to do different operation on the memory.
  63
  64   @param Operation  The operation number, e.g. XENMEM_add_to_physmap.
  65   @param Arguments  The arguments associated to the operation.
  66
  67   @return  Return the return value from the hypercall, 0 in case of success
  68            otherwise, an error code.
  69 **/
  70 INTN
  71 XenHypercallMemoryOp (
  72   IN     UINTN Operation,
  73   IN OUT VOID *Arguments
  74   );
  75
  76 /**
  77   Do an operation on the event channels.
  78
  79   @param Operation  The operation number, e.g. EVTCHNOP_send.
  80   @param Arguments  The argument associated to the operation.
  81
  82   @return  Return the return value from the hypercall, 0 in case of success
  83            otherwise, an error code.
  84 **/
  85 INTN
  86 XenHypercallEventChannelOp (
  87   IN     INTN Operation,
  88   IN OUT VOID *Arguments
  89   );
  90
  91 #endif