include/xen/events.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _XEN_EVENTS_H
   3 #define _XEN_EVENTS_H
   4
   5 #include <linux/interrupt.h>
   6 #include <linux/irq.h>
   7 #ifdef CONFIG_PCI_MSI
   8 #include <linux/msi.h>
   9 #endif
  10
  11 #include <xen/interface/event_channel.h>
  12 #include <asm/xen/hypercall.h>
  13 #include <asm/xen/events.h>
  14
  15 unsigned xen_evtchn_nr_channels(void);
  16
  17 int bind_evtchn_to_irq(evtchn_port_t evtchn);
  18 int bind_evtchn_to_irq_lateeoi(evtchn_port_t evtchn);
  19 int bind_evtchn_to_irqhandler(evtchn_port_t evtchn,
  20                               irq_handler_t handler,
  21                               unsigned long irqflags, const char *devname,
  22                               void *dev_id);
  23 int bind_evtchn_to_irqhandler_lateeoi(evtchn_port_t evtchn,
  24                                       irq_handler_t handler,
  25                                       unsigned long irqflags, const char *devname,
  26                                       void *dev_id);
  27 int bind_virq_to_irq(unsigned int virq, unsigned int cpu, bool percpu);
  28 int bind_virq_to_irqhandler(unsigned int virq, unsigned int cpu,
  29                             irq_handler_t handler,
  30                             unsigned long irqflags, const char *devname,
  31                             void *dev_id);
  32 int bind_ipi_to_irqhandler(enum ipi_vector ipi,
  33                            unsigned int cpu,
  34                            irq_handler_t handler,
  35                            unsigned long irqflags,
  36                            const char *devname,
  37                            void *dev_id);
  38 int bind_interdomain_evtchn_to_irq(unsigned int remote_domain,
  39                                    evtchn_port_t remote_port);
  40 int bind_interdomain_evtchn_to_irq_lateeoi(unsigned int remote_domain,
  41                                            evtchn_port_t remote_port);
  42 int bind_interdomain_evtchn_to_irqhandler(unsigned int remote_domain,
  43                                           evtchn_port_t remote_port,
  44                                           irq_handler_t handler,
  45                                           unsigned long irqflags,
  46                                           const char *devname,
  47                                           void *dev_id);
  48 int bind_interdomain_evtchn_to_irqhandler_lateeoi(unsigned int remote_domain,
  49                                                   evtchn_port_t remote_port,
  50                                                   irq_handler_t handler,
  51                                                   unsigned long irqflags,
  52                                                   const char *devname,
  53                                                   void *dev_id);
  54
  55 /*
  56  * Common unbind function for all event sources. Takes IRQ to unbind from.
  57  * Automatically closes the underlying event channel (even for bindings
  58  * made with bind_evtchn_to_irqhandler()).
  59  */
  60 void unbind_from_irqhandler(unsigned int irq, void *dev_id);
  61
  62 /*
  63  * Send late EOI for an IRQ bound to an event channel via one of the *_lateeoi
  64  * functions above.
  65  */
  66 void xen_irq_lateeoi(unsigned int irq, unsigned int eoi_flags);
  67 /* Signal an event was spurious, i.e. there was no action resulting from it. */
  68 #define XEN_EOI_FLAG_SPURIOUS   0x00000001
  69
  70 #define XEN_IRQ_PRIORITY_MAX     EVTCHN_FIFO_PRIORITY_MAX
  71 #define XEN_IRQ_PRIORITY_DEFAULT EVTCHN_FIFO_PRIORITY_DEFAULT
  72 #define XEN_IRQ_PRIORITY_MIN     EVTCHN_FIFO_PRIORITY_MIN
  73 int xen_set_irq_priority(unsigned irq, unsigned priority);
  74
  75 /*
  76  * Allow extra references to event channels exposed to userspace by evtchn
  77  */
  78 int evtchn_make_refcounted(unsigned int evtchn);
  79 int evtchn_get(unsigned int evtchn);
  80 void evtchn_put(unsigned int evtchn);
  81
  82 void xen_send_IPI_one(unsigned int cpu, enum ipi_vector vector);
  83 void rebind_evtchn_irq(int evtchn, int irq);
  84 int xen_set_affinity_evtchn(struct irq_desc *desc, unsigned int tcpu);
  85
  86 static inline void notify_remote_via_evtchn(int port)
  87 {
  88         struct evtchn_send send = { .port = port };
  89         (void)HYPERVISOR_event_channel_op(EVTCHNOP_send, &send);
  90 }
  91
  92 void notify_remote_via_irq(int irq);
  93
  94 void xen_irq_resume(void);
  95
  96 /* Clear an irq's pending state, in preparation for polling on it */
  97 void xen_clear_irq_pending(int irq);
  98 void xen_set_irq_pending(int irq);
  99 bool xen_test_irq_pending(int irq);
 100
 101 /* Poll waiting for an irq to become pending.  In the usual case, the
 102    irq will be disabled so it won't deliver an interrupt. */
 103 void xen_poll_irq(int irq);
 104
 105 /* Poll waiting for an irq to become pending with a timeout.  In the usual case,
 106  * the irq will be disabled so it won't deliver an interrupt. */
 107 void xen_poll_irq_timeout(int irq, u64 timeout);
 108
 109 /* Determine the IRQ which is bound to an event channel */
 110 unsigned irq_from_evtchn(unsigned int evtchn);
 111 int irq_from_virq(unsigned int cpu, unsigned int virq);
 112 unsigned int evtchn_from_irq(unsigned irq);
 113
 114 /* Xen HVM evtchn vector callback */
 115 void xen_hvm_callback_vector(void);
 116 #ifdef CONFIG_TRACING
 117 #define trace_xen_hvm_callback_vector xen_hvm_callback_vector
 118 #endif
 119 int xen_set_callback_via(uint64_t via);
 120 void xen_evtchn_do_upcall(struct pt_regs *regs);
 121 void xen_hvm_evtchn_do_upcall(void);
 122
 123 /* Bind a pirq for a physical interrupt to an irq. */
 124 int xen_bind_pirq_gsi_to_irq(unsigned gsi,
 125                              unsigned pirq, int shareable, char *name);
 126
 127 #ifdef CONFIG_PCI_MSI
 128 /* Allocate a pirq for a MSI style physical interrupt. */
 129 int xen_allocate_pirq_msi(struct pci_dev *dev, struct msi_desc *msidesc);
 130 /* Bind an PSI pirq to an irq. */
 131 int xen_bind_pirq_msi_to_irq(struct pci_dev *dev, struct msi_desc *msidesc,
 132                              int pirq, int nvec, const char *name, domid_t domid);
 133 #endif
 134
 135 /* De-allocates the above mentioned physical interrupt. */
 136 int xen_destroy_irq(int irq);
 137
 138 /* Return irq from pirq */
 139 int xen_irq_from_pirq(unsigned pirq);
 140
 141 /* Return the pirq allocated to the irq. */
 142 int xen_pirq_from_irq(unsigned irq);
 143
 144 /* Return the irq allocated to the gsi */
 145 int xen_irq_from_gsi(unsigned gsi);
 146
 147 /* Determine whether to ignore this IRQ if it is passed to a guest. */
 148 int xen_test_irq_shared(int irq);
 149
 150 /* initialize Xen IRQ subsystem */
 151 void xen_init_IRQ(void);
 152 #endif  /* _XEN_EVENTS_H */