Ovmf/Xen: refactor XenBusDxe hypercall implementation

[mirror_edk2.git] / OvmfPkg / XenBusDxe / XenHypercall.h

/** @file\r
  Functions declarations to make Xen hypercalls.\r
\r
  Copyright (C) 2014, Citrix Ltd.\r
\r
  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
**/\r
\r
#ifndef __XENBUS_DXE_HYPERCALL_H__\r
#define __XENBUS_DXE_HYPERCALL_H__\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     INTN HypercallID,\r
  IN OUT INTN Arg1,\r
  IN OUT INTN Arg2\r
  );\r
\r
/**\r
  Get the page where all hypercall are from the XenInfo hob.\r
\r
  @param Dev    A XENBUS_DEVICE instance.\r
\r
  @retval EFI_NOT_FOUND   hyperpage could not be found.\r
  @retval EFI_SUCCESS     Successfully retrieve the hyperpage pointer.\r
**/\r
EFI_STATUS\r
XenHyperpageInit (\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
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
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
XenHypercallEventChannelOp (\r
  IN     INTN Operation,\r
  IN OUT VOID *Arguments\r
  );\r
\r
#endif\r