1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Xen Event Channels (internal header)
4  *
5  * Copyright (C) 2013 Citrix Systems R&D Ltd.
6  */
7 #ifndef __EVENTS_INTERNAL_H__
8 #define __EVENTS_INTERNAL_H__
9 
10 struct evtchn_loop_ctrl;
11 
12 struct evtchn_ops {
13 	unsigned (*max_channels)(void);
14 	unsigned (*nr_channels)(void);
15 
16 	int (*setup)(evtchn_port_t port);
17 	void (*bind_to_cpu)(evtchn_port_t evtchn, unsigned int cpu,
18 			    unsigned int old_cpu);
19 
20 	void (*clear_pending)(evtchn_port_t port);
21 	void (*set_pending)(evtchn_port_t port);
22 	bool (*is_pending)(evtchn_port_t port);
23 	bool (*test_and_set_mask)(evtchn_port_t port);
24 	void (*mask)(evtchn_port_t port);
25 	void (*unmask)(evtchn_port_t port);
26 
27 	void (*handle_events)(unsigned cpu, struct evtchn_loop_ctrl *ctrl);
28 	void (*resume)(void);
29 
30 	int (*percpu_init)(unsigned int cpu);
31 	int (*percpu_deinit)(unsigned int cpu);
32 };
33 
34 extern const struct evtchn_ops *evtchn_ops;
35 
36 int get_evtchn_to_irq(evtchn_port_t evtchn);
37 void handle_irq_for_port(evtchn_port_t port, struct evtchn_loop_ctrl *ctrl);
38 
39 unsigned int cpu_from_evtchn(evtchn_port_t evtchn);
40 
41 static inline unsigned xen_evtchn_max_channels(void)
42 {
43 	return evtchn_ops->max_channels();
44 }
45 
46 /*
47  * Do any ABI specific setup for a bound event channel before it can
48  * be unmasked and used.
49  */
50 static inline int xen_evtchn_port_setup(evtchn_port_t evtchn)
51 {
52 	if (evtchn_ops->setup)
53 		return evtchn_ops->setup(evtchn);
54 	return 0;
55 }
56 
57 static inline void xen_evtchn_port_bind_to_cpu(evtchn_port_t evtchn,
58 					       unsigned int cpu,
59 					       unsigned int old_cpu)
60 {
61 	evtchn_ops->bind_to_cpu(evtchn, cpu, old_cpu);
62 }
63 
64 static inline void clear_evtchn(evtchn_port_t port)
65 {
66 	evtchn_ops->clear_pending(port);
67 }
68 
69 static inline void set_evtchn(evtchn_port_t port)
70 {
71 	evtchn_ops->set_pending(port);
72 }
73 
74 static inline bool test_evtchn(evtchn_port_t port)
75 {
76 	return evtchn_ops->is_pending(port);
77 }
78 
79 static inline bool test_and_set_mask(evtchn_port_t port)
80 {
81 	return evtchn_ops->test_and_set_mask(port);
82 }
83 
84 static inline void mask_evtchn(evtchn_port_t port)
85 {
86 	return evtchn_ops->mask(port);
87 }
88 
89 static inline void unmask_evtchn(evtchn_port_t port)
90 {
91 	return evtchn_ops->unmask(port);
92 }
93 
94 static inline void xen_evtchn_handle_events(unsigned cpu,
95 					    struct evtchn_loop_ctrl *ctrl)
96 {
97 	return evtchn_ops->handle_events(cpu, ctrl);
98 }
99 
100 static inline void xen_evtchn_resume(void)
101 {
102 	if (evtchn_ops->resume)
103 		evtchn_ops->resume();
104 }
105 
106 void xen_evtchn_2l_init(void);
107 int xen_evtchn_fifo_init(void);
108 
109 #endif /* #ifndef __EVENTS_INTERNAL_H__ */
110