ee786e40e8
xen/hypervisor.h: - Remove unused helpers: MULTI_update_va_mapping, is_initial_xendomain, is_running_on_xen - Remove unused define CONFIG_X86_PAE - Remove unused variable xen_start_info: note that it's used inpcifront which is not built at all - Remove forward declaration of HYPERVISOR_crash xen/xen-os.h: - Remove unused define CONFIG_X86_PAE - Drop unused helpers: test_and_clear_bit, clear_bit, force_evtchn_callback - Implement a generic version (based on ofed/include/linux/bitops.h) of set_bit and test_bit and prefix them by xen_ to avoid any use by other code than Xen. Note that It would be worth to investigate a generic implementation in FreeBSD. - Replace barrier() by __compiler_membar() - Replace cpu_relax() by cpu_spinwait(): it's exactly the same as rep;nop = pause xen/xen_intr.h: - Move the prototype of xen_intr_handle_upcall in it: Use by all the platform x86/xen/xen_intr.c: - Use BITSET* for the enabledbits: Avoid to use custom helpers - test_bit/set_bit has been renamed to xen_test_bit/xen_set_bit - Don't export the variable xen_intr_pcpu dev/xen/blkback/blkback.c: - Fix the string format when XBB_DEBUG is enabled: host_addr is typed uint64_t dev/xen/balloon/balloon.c: - Remove set but not used variable - Use the correct type for frame_list: xen_pfn_t represents the frame number on any architecture dev/xen/control/control.c: - Return BUS_PROBE_WILDCARD in xs_probe: Returning 0 in a probe callback means the driver can handle this device. If by any chance xenstore is the first driver, every new device with the driver is unset will use xenstore. dev/xen/grant-table/grant_table.c: - Remove unused cmpxchg - Drop unused include opt_pmap.h: Doesn't exist on ARM64 and it doesn't contain anything required for the code on x86 dev/xen/netfront/netfront.c: - Use the correct type for rx_pfn_array: xen_pfn_t represents the frame number on any architecture dev/xen/netback/netback.c: - Use the correct type for gmfn: xen_pfn_t represents the frame number on any architecture dev/xen/xenstore/xenstore.c: - Return BUS_PROBE_WILDCARD in xctrl_probe: Returning 0 in a probe callback means the driver can handle this device. If by any chance xenstore is the first driver, every new device with the driver is unset will use xenstore. Note that with the changes, x86/include/xen/xen-os.h doesn't contain anymore arch-specific code. Although, a new series will add some helpers that differ between x86 and ARM64, so I've kept the headers for now. Submitted by: Julien Grall <julien.grall@citrix.com> Reviewed by: royger Differential Revision: https://reviews.freebsd.org/D3921 Sponsored by: Citrix Systems R&D
267 lines
10 KiB
C
267 lines
10 KiB
C
/******************************************************************************
|
|
* xen_intr.h
|
|
*
|
|
* APIs for managing Xen event channel, virtual IRQ, and physical IRQ
|
|
* notifications.
|
|
*
|
|
* Copyright (c) 2004, K A Fraser
|
|
* Copyright (c) 2012, Spectra Logic Corporation
|
|
*
|
|
* This file may be distributed separately from the Linux kernel, or
|
|
* incorporated into other software packages, subject to the following license:
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this source file (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use, copy, modify,
|
|
* merge, publish, distribute, sublicense, and/or sell copies of the Software,
|
|
* and to permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
#ifndef _XEN_INTR_H_
|
|
#define _XEN_INTR_H_
|
|
|
|
#include <xen/interface/event_channel.h>
|
|
|
|
/** Registered Xen interrupt callback handle. */
|
|
typedef void * xen_intr_handle_t;
|
|
|
|
/** If non-zero, the hypervisor has been configured to use a direct vector */
|
|
extern int xen_vector_callback_enabled;
|
|
|
|
void xen_intr_handle_upcall(struct trapframe *trap_frame);
|
|
|
|
/**
|
|
* Associate an already allocated local event channel port an interrupt
|
|
* handler.
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param local_port The event channel to bind.
|
|
* \param filter An interrupt filter handler. Specify NULL
|
|
* to always dispatch to the ithread handler.
|
|
* \param handler An interrupt ithread handler. Optional (can
|
|
* specify NULL) if all necessary event actions
|
|
* are performed by filter.
|
|
* \param arg Argument to present to both filter and handler.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handlep Pointer to an opaque handle used to manage this
|
|
* registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_bind_local_port(device_t dev, evtchn_port_t local_port,
|
|
driver_filter_t filter, driver_intr_t handler, void *arg,
|
|
enum intr_type irqflags, xen_intr_handle_t *handlep);
|
|
|
|
/**
|
|
* Allocate a local event channel port, accessible by the specified
|
|
* remote/foreign domain and, if successful, associate the port with
|
|
* the specified interrupt handler.
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param remote_domain Remote domain grant permission to signal the
|
|
* newly allocated local port.
|
|
* \param filter An interrupt filter handler. Specify NULL
|
|
* to always dispatch to the ithread handler.
|
|
* \param handler An interrupt ithread handler. Optional (can
|
|
* specify NULL) if all necessary event actions
|
|
* are performed by filter.
|
|
* \param arg Argument to present to both filter and handler.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handlep Pointer to an opaque handle used to manage this
|
|
* registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_alloc_and_bind_local_port(device_t dev,
|
|
u_int remote_domain, driver_filter_t filter, driver_intr_t handler,
|
|
void *arg, enum intr_type irqflags, xen_intr_handle_t *handlep);
|
|
|
|
/**
|
|
* Associate the specified interrupt handler with the remote event
|
|
* channel port specified by remote_domain and remote_port.
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param remote_domain The domain peer for this event channel connection.
|
|
* \param remote_port Remote domain's local port number for this event
|
|
* channel port.
|
|
* \param filter An interrupt filter handler. Specify NULL
|
|
* to always dispatch to the ithread handler.
|
|
* \param handler An interrupt ithread handler. Optional (can
|
|
* specify NULL) if all necessary event actions
|
|
* are performed by filter.
|
|
* \param arg Argument to present to both filter and handler.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handlep Pointer to an opaque handle used to manage this
|
|
* registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_bind_remote_port(device_t dev, u_int remote_domain,
|
|
evtchn_port_t remote_port, driver_filter_t filter,
|
|
driver_intr_t handler, void *arg, enum intr_type irqflags,
|
|
xen_intr_handle_t *handlep);
|
|
|
|
/**
|
|
* Associate the specified interrupt handler with the specified Xen
|
|
* virtual interrupt source.
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param virq The Xen virtual IRQ number for the Xen interrupt
|
|
* source being hooked.
|
|
* \param cpu The cpu on which interrupt events should be delivered.
|
|
* \param filter An interrupt filter handler. Specify NULL
|
|
* to always dispatch to the ithread handler.
|
|
* \param handler An interrupt ithread handler. Optional (can
|
|
* specify NULL) if all necessary event actions
|
|
* are performed by filter.
|
|
* \param arg Argument to present to both filter and handler.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handlep Pointer to an opaque handle used to manage this
|
|
* registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_bind_virq(device_t dev, u_int virq, u_int cpu,
|
|
driver_filter_t filter, driver_intr_t handler,
|
|
void *arg, enum intr_type irqflags, xen_intr_handle_t *handlep);
|
|
|
|
/**
|
|
* Allocate a local event channel port for servicing interprocessor
|
|
* interupts and, if successful, associate the port with the specified
|
|
* interrupt handler.
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param cpu The cpu receiving the IPI.
|
|
* \param filter The interrupt filter servicing this IPI.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handlep Pointer to an opaque handle used to manage this
|
|
* registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_alloc_and_bind_ipi(device_t dev, u_int cpu,
|
|
driver_filter_t filter, enum intr_type irqflags,
|
|
xen_intr_handle_t *handlep);
|
|
|
|
/**
|
|
* Register a physical interrupt vector and setup the interrupt source.
|
|
*
|
|
* \param vector The global vector to use.
|
|
* \param trig Default trigger method.
|
|
* \param pol Default polarity of the interrupt.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_register_pirq(int vector, enum intr_trigger trig,
|
|
enum intr_polarity pol);
|
|
|
|
/**
|
|
* Unbind an interrupt handler from its interrupt source.
|
|
*
|
|
* \param handlep A pointer to the opaque handle that was initialized
|
|
* at the time the interrupt source was bound.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*
|
|
* \note The event channel, if any, that was allocated at bind time is
|
|
* closed upon successful return of this method.
|
|
*
|
|
* \note It is always safe to call xen_intr_unbind() on a handle that
|
|
* has been initilized to NULL.
|
|
*/
|
|
void xen_intr_unbind(xen_intr_handle_t *handle);
|
|
|
|
/**
|
|
* Add a description to an interrupt handler.
|
|
*
|
|
* \param handle The opaque handle that was initialized at the time
|
|
* the interrupt source was bound.
|
|
*
|
|
* \param fmt The sprintf compatible format string for the description,
|
|
* followed by optional sprintf arguments.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int
|
|
xen_intr_describe(xen_intr_handle_t port_handle, const char *fmt, ...)
|
|
__attribute__((format(printf, 2, 3)));
|
|
|
|
/**
|
|
* Signal the remote peer of an interrupt source associated with an
|
|
* event channel port.
|
|
*
|
|
* \param handle The opaque handle that was initialized at the time
|
|
* the interrupt source was bound.
|
|
*
|
|
* \note For xen interrupt sources other than event channel ports,
|
|
* this method takes no action.
|
|
*/
|
|
void xen_intr_signal(xen_intr_handle_t handle);
|
|
|
|
/**
|
|
* Get the local event channel port number associated with this interrupt
|
|
* source.
|
|
*
|
|
* \param handle The opaque handle that was initialized at the time
|
|
* the interrupt source was bound.
|
|
*
|
|
* \returns 0 if the handle is invalid, otherwise positive port number.
|
|
*/
|
|
evtchn_port_t xen_intr_port(xen_intr_handle_t handle);
|
|
|
|
/**
|
|
* Setup MSI vector interrupt(s).
|
|
*
|
|
* \param dev The device that requests the binding.
|
|
*
|
|
* \param vector Requested initial vector to bind the MSI interrupt(s) to.
|
|
*
|
|
* \param count Number of vectors to allocate.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_register_msi(device_t dev, int vector, int count);
|
|
|
|
/**
|
|
* Teardown a MSI vector interrupt.
|
|
*
|
|
* \param vector Requested vector to release.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_release_msi(int vector);
|
|
|
|
/**
|
|
* Bind an event channel port with a handler
|
|
*
|
|
* \param dev The device making this bind request.
|
|
* \param filter An interrupt filter handler. Specify NULL
|
|
* to always dispatch to the ithread handler.
|
|
* \param handler An interrupt ithread handler. Optional (can
|
|
* specify NULL) if all necessary event actions
|
|
* are performed by filter.
|
|
* \param arg Argument to present to both filter and handler.
|
|
* \param irqflags Interrupt handler flags. See sys/bus.h.
|
|
* \param handle Opaque handle used to manage this registration.
|
|
*
|
|
* \returns 0 on success, otherwise an errno.
|
|
*/
|
|
int xen_intr_add_handler(device_t dev, driver_filter_t filter,
|
|
driver_intr_t handler, void *arg, enum intr_type flags,
|
|
xen_intr_handle_t handle);
|
|
|
|
#endif /* _XEN_INTR_H_ */
|