xen/interface/event_channel.h

1 /* SPDX-License-Identifier: MIT */
7  * Copyright (c) 2003-2004, K A Fraser.
26  * guests must check the value of the bit after re-enabling event
41  * @cmd  == EVTCHNOP_* (event-channel operation).
42  * @args == struct evtchn_* Operation-specific extra arguments (NULL if none).
85  * EVTCHNOP_bind_interdomain: Construct an interdomain event channel between
91  * In case the peer domain has already tried to set our event channel
93  * the local event channel pending.
96  * handler) is as follows: (Re-enable the event channel for subsequent
114  * EVTCHNOP_bind_virq: Bind a local event channel to VIRQ <irq> on specified
117  *  1. Virtual IRQs are classified as per-vcpu or global. See the VIRQ list
120  *     re-bound via EVTCHNOP_bind_vcpu.
121  *  3. Per-vcpu VIRQs may be bound to at most one event channel per vcpu.
122  *     The allocated event channel is bound to the specified vcpu and the
135  * EVTCHNOP_bind_pirq: Bind a local event channel to a real IRQ (PIRQ <irq>).
137  *  1. A physical IRQ may be bound to at most one event channel per domain.
138  *  2. Only a sufficiently-privileged domain may bind to a physical IRQ.
151  * EVTCHNOP_bind_ipi: Bind a local event channel to receive events.
153  *  1. The allocated event channel is bound to the specified vcpu. The binding
164  * EVTCHNOP_close: Close a local event channel <port>. If the channel is
175  * EVTCHNOP_send: Send an event to the remote end of the channel whose local
185  * EVTCHNOP_status: Get the current status of the communication channel which
189  *  2. Only a sufficiently-privileged domain may obtain the status of an event
190  *     channel for which <dom> is not DOMID_SELF.
197 #define EVTCHNSTAT_closed       0  /* Channel is not in use.                 */
198 #define EVTCHNSTAT_unbound      1  /* Channel is waiting interdom connection.*/
199 #define EVTCHNSTAT_interdomain  2  /* Channel is connected to remote domain. */
200 #define EVTCHNSTAT_pirq         3  /* Channel is bound to a phys IRQ line.   */
201 #define EVTCHNSTAT_virq         4  /* Channel is bound to a virtual IRQ line */
202 #define EVTCHNSTAT_ipi          5  /* Channel is bound to a virtual IPI line */
204     uint32_t vcpu;                 /* VCPU to which this channel is bound.   */
220  * EVTCHNOP_bind_vcpu: Specify which vcpu a channel should notify when an
223  *  1. IPI-bound channels always notify the vcpu specified at bind time.
225  *  2. Per-VCPU VIRQ channels always notify the vcpu specified at bind time.
228  *     the channel is allocated (a port that is freed and subsequently reused
239  * EVTCHNOP_unmask: Unmask the specified local event-channel port and deliver
252  *  2. Only a sufficiently-privileged domain may specify other than DOMID_SELF.
253  *  3. Destroys all control blocks and event array, resets event channel
254  *     operations to 2-level ABI if called with <dom> == DOMID_SELF and FIFO
292  * EVTCHNOP_set_priority: set the priority for an event channel.
326  * 2-level ABI
350 #define EVTCHN_FIFO_LINK_MASK ((1 << EVTCHN_FIFO_LINK_BITS) - 1)
366  * c-file-style: "BSD"
367  * c-basic-offset: 4
368  * tab-width: 4
369  * indent-tabs-mode: nil