e86895d9e4
This patch adds three event channel related functions: - EventChannelAllocate: Allocate an event channel port that can be bind from a specified domain. - EventChannelNotify: Send an event to the remote end of a channel. - EventChannelClose: Close a local event channel port. Change in V3: - eventchannel, update protocol to return error code. - expand patch description - Add comments in the XenBus Protocol header. Change in V2: - coding style - adding comment to functions - Rename Xenbus to XenBus. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Anthony PERARD <anthony.perard@citrix.com> Reviewed-by: Jordan Justen <jordan.l.justen@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16271 6f19259b-4bc3-4df7-8a09-765794883524
89 lines
2.3 KiB
C
89 lines
2.3 KiB
C
/** @file
|
|
Event Channel function declaration.
|
|
|
|
Copyright (C) 2014, Citrix Ltd.
|
|
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
#ifndef __XENBUS_EVENT_CHANNEL_H
|
|
#define __XENBUS_EVENT_CHANNEL_H
|
|
|
|
#include "XenBusDxe.h"
|
|
|
|
#include <IndustryStandard/Xen/event_channel.h>
|
|
|
|
/**
|
|
Send an event to the remote end of the channel whose local endpoint is Port.
|
|
|
|
@param Dev A pointer to XENBUS_DEVICE.
|
|
@param Port The port to notify.
|
|
|
|
@return Return 0 on success, or return the errno code from the hypercall.
|
|
**/
|
|
UINT32
|
|
XenEventChannelNotify (
|
|
IN XENBUS_DEVICE *Dev,
|
|
IN evtchn_port_t Port
|
|
);
|
|
|
|
/*
|
|
* XenBus protocol
|
|
*/
|
|
|
|
/**
|
|
Allocate a port that can be bind from domain DomainId.
|
|
|
|
@param This A pointer to the XENBUS_PROTOCOL.
|
|
@param DomainId The domain ID that can bind the newly allocated port.
|
|
@param Port A pointer to a evtchn_port_t that will contain the newly
|
|
allocated port.
|
|
|
|
@retval UINT32 The return value from the hypercall, 0 if success.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
XenBusEventChannelAllocate (
|
|
IN XENBUS_PROTOCOL *This,
|
|
IN domid_t DomainId,
|
|
OUT evtchn_port_t *Port
|
|
);
|
|
|
|
/**
|
|
Send an event to the remote end of the channel whose local endpoint is Port.
|
|
|
|
@param This A pointer to the XENBUS_PROTOCOL.
|
|
@param Port Local port to the the event from.
|
|
|
|
@retval UINT32 The return value from the hypercall, 0 if success.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
XenBusEventChannelNotify (
|
|
IN XENBUS_PROTOCOL *This,
|
|
IN evtchn_port_t Port
|
|
);
|
|
|
|
/**
|
|
Close a local event channel Port.
|
|
|
|
@param This A pointer to the XENBUS_PROTOCOL.
|
|
@param Port The event channel to close.
|
|
|
|
@retval UINT32 The return value from the hypercall, 0 if success.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
XenBusEventChannelClose (
|
|
IN XENBUS_PROTOCOL *This,
|
|
IN evtchn_port_t Port
|
|
);
|
|
|
|
#endif
|