xref: /openbmc/linux/include/xen/events.h (revision 585c91f4)
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(unsigned int evtchn);
18 int bind_evtchn_to_irqhandler(unsigned int evtchn,
19 			      irq_handler_t handler,
20 			      unsigned long irqflags, const char *devname,
21 			      void *dev_id);
22 int bind_virq_to_irq(unsigned int virq, unsigned int cpu, bool percpu);
23 int bind_virq_to_irqhandler(unsigned int virq, unsigned int cpu,
24 			    irq_handler_t handler,
25 			    unsigned long irqflags, const char *devname,
26 			    void *dev_id);
27 int bind_ipi_to_irqhandler(enum ipi_vector ipi,
28 			   unsigned int cpu,
29 			   irq_handler_t handler,
30 			   unsigned long irqflags,
31 			   const char *devname,
32 			   void *dev_id);
33 int bind_interdomain_evtchn_to_irq(unsigned int remote_domain,
34 				   unsigned int remote_port);
35 int bind_interdomain_evtchn_to_irqhandler(unsigned int remote_domain,
36 					  unsigned int remote_port,
37 					  irq_handler_t handler,
38 					  unsigned long irqflags,
39 					  const char *devname,
40 					  void *dev_id);
41 
42 /*
43  * Common unbind function for all event sources. Takes IRQ to unbind from.
44  * Automatically closes the underlying event channel (even for bindings
45  * made with bind_evtchn_to_irqhandler()).
46  */
47 void unbind_from_irqhandler(unsigned int irq, void *dev_id);
48 
49 #define XEN_IRQ_PRIORITY_MAX     EVTCHN_FIFO_PRIORITY_MAX
50 #define XEN_IRQ_PRIORITY_DEFAULT EVTCHN_FIFO_PRIORITY_DEFAULT
51 #define XEN_IRQ_PRIORITY_MIN     EVTCHN_FIFO_PRIORITY_MIN
52 int xen_set_irq_priority(unsigned irq, unsigned priority);
53 
54 /*
55  * Allow extra references to event channels exposed to userspace by evtchn
56  */
57 int evtchn_make_refcounted(unsigned int evtchn);
58 int evtchn_get(unsigned int evtchn);
59 void evtchn_put(unsigned int evtchn);
60 
61 void xen_send_IPI_one(unsigned int cpu, enum ipi_vector vector);
62 void rebind_evtchn_irq(int evtchn, int irq);
63 int xen_set_affinity_evtchn(struct irq_desc *desc, unsigned int tcpu);
64 
65 static inline void notify_remote_via_evtchn(int port)
66 {
67 	struct evtchn_send send = { .port = port };
68 	(void)HYPERVISOR_event_channel_op(EVTCHNOP_send, &send);
69 }
70 
71 void notify_remote_via_irq(int irq);
72 
73 void xen_irq_resume(void);
74 
75 /* Clear an irq's pending state, in preparation for polling on it */
76 void xen_clear_irq_pending(int irq);
77 void xen_set_irq_pending(int irq);
78 bool xen_test_irq_pending(int irq);
79 
80 /* Poll waiting for an irq to become pending.  In the usual case, the
81    irq will be disabled so it won't deliver an interrupt. */
82 void xen_poll_irq(int irq);
83 
84 /* Poll waiting for an irq to become pending with a timeout.  In the usual case,
85  * the irq will be disabled so it won't deliver an interrupt. */
86 void xen_poll_irq_timeout(int irq, u64 timeout);
87 
88 /* Determine the IRQ which is bound to an event channel */
89 unsigned irq_from_evtchn(unsigned int evtchn);
90 int irq_from_virq(unsigned int cpu, unsigned int virq);
91 unsigned int evtchn_from_irq(unsigned irq);
92 
93 #ifdef CONFIG_XEN_PVHVM
94 /* Xen HVM evtchn vector callback */
95 void xen_hvm_callback_vector(void);
96 #ifdef CONFIG_TRACING
97 #define trace_xen_hvm_callback_vector xen_hvm_callback_vector
98 #endif
99 #endif
100 int xen_set_callback_via(uint64_t via);
101 void xen_evtchn_do_upcall(struct pt_regs *regs);
102 void xen_hvm_evtchn_do_upcall(void);
103 
104 /* Bind a pirq for a physical interrupt to an irq. */
105 int xen_bind_pirq_gsi_to_irq(unsigned gsi,
106 			     unsigned pirq, int shareable, char *name);
107 
108 #ifdef CONFIG_PCI_MSI
109 /* Allocate a pirq for a MSI style physical interrupt. */
110 int xen_allocate_pirq_msi(struct pci_dev *dev, struct msi_desc *msidesc);
111 /* Bind an PSI pirq to an irq. */
112 int xen_bind_pirq_msi_to_irq(struct pci_dev *dev, struct msi_desc *msidesc,
113 			     int pirq, int nvec, const char *name, domid_t domid);
114 #endif
115 
116 /* De-allocates the above mentioned physical interrupt. */
117 int xen_destroy_irq(int irq);
118 
119 /* Return irq from pirq */
120 int xen_irq_from_pirq(unsigned pirq);
121 
122 /* Return the pirq allocated to the irq. */
123 int xen_pirq_from_irq(unsigned irq);
124 
125 /* Return the irq allocated to the gsi */
126 int xen_irq_from_gsi(unsigned gsi);
127 
128 /* Determine whether to ignore this IRQ if it is passed to a guest. */
129 int xen_test_irq_shared(int irq);
130 
131 /* initialize Xen IRQ subsystem */
132 void xen_init_IRQ(void);
133 #endif	/* _XEN_EVENTS_H */
134