OvmfPkg/XenBusDxe: Add Event Channel into XenBus protocol.

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

/** @file\r
  Event Channel function declaration.\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
#ifndef __XENBUS_EVENT_CHANNEL_H\r
#define __XENBUS_EVENT_CHANNEL_H\r
\r
#include "XenBusDxe.h"\r
\r
#include <IndustryStandard/Xen/event_channel.h>\r
\r
/**\r
  Send an event to the remote end of the channel whose local endpoint is Port.\r
\r
  @param Dev    A pointer to XENBUS_DEVICE.\r
  @param Port   The port to notify.\r
\r
  @return       Return 0 on success, or return the errno code from the hypercall.\r
**/\r
UINT32\r
XenEventChannelNotify (\r
  IN XENBUS_DEVICE *Dev,\r
  IN evtchn_port_t Port\r
  );\r
\r
/*\r
 * XenBus protocol\r
 */\r
\r
/**\r
  Allocate a port that can be bind from domain DomainId.\r
\r
  @param This       A pointer to the XENBUS_PROTOCOL.\r
  @param DomainId   The domain ID that can bind the newly allocated port.\r
  @param Port       A pointer to a evtchn_port_t that will contain the newly\r
                    allocated port.\r
\r
  @retval UINT32    The return value from the hypercall, 0 if success.\r
**/\r
UINT32\r
EFIAPI\r
XenBusEventChannelAllocate (\r
  IN  XENBUS_PROTOCOL *This,\r
  IN  domid_t         DomainId,\r
  OUT evtchn_port_t   *Port\r
  );\r
\r
/**\r
  Send an event to the remote end of the channel whose local endpoint is Port.\r
\r
  @param This       A pointer to the XENBUS_PROTOCOL.\r
  @param Port       Local port to the the event from.\r
\r
  @retval UINT32    The return value from the hypercall, 0 if success.\r
**/\r
UINT32\r
EFIAPI\r
XenBusEventChannelNotify (\r
  IN XENBUS_PROTOCOL *This,\r
  IN evtchn_port_t   Port\r
  );\r
\r
/**\r
  Close a local event channel Port.\r
\r
  @param This       A pointer to the XENBUS_PROTOCOL.\r
  @param Port       The event channel to close.\r
\r
  @retval UINT32    The return value from the hypercall, 0 if success.\r
**/\r
UINT32\r
EFIAPI\r
XenBusEventChannelClose (\r
  IN XENBUS_PROTOCOL *This,\r
  IN evtchn_port_t   Port\r
  );\r
\r
#endif\r