xref: /linux/kernel/irq/internals.h (revision dd9f6d30c64001ca4dde973ac04d8d155e856743)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * IRQ subsystem internal functions and variables:
4  *
5  * Do not ever include this file from anything else than
6  * kernel/irq/. Do not even think about using any information outside
7  * of this file for your non core code.
8  */
9 #include <linux/irqdesc.h>
10 #include <linux/kernel_stat.h>
11 #include <linux/pm_runtime.h>
12 #include <linux/sched/clock.h>
13 
14 #ifdef CONFIG_SPARSE_IRQ
15 # define MAX_SPARSE_IRQS	INT_MAX
16 #else
17 # define MAX_SPARSE_IRQS	NR_IRQS
18 #endif
19 
20 #define istate core_internal_state__do_not_mess_with_it
21 
22 extern bool noirqdebug;
23 extern int irq_poll_cpu;
24 
25 extern struct irqaction chained_action;
26 
27 /*
28  * Bits used by threaded handlers:
29  * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
30  * IRQTF_WARNED    - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
31  * IRQTF_AFFINITY  - irq thread is requested to adjust affinity
32  * IRQTF_FORCED_THREAD  - irq action is force threaded
33  * IRQTF_READY     - signals that irq thread is ready
34  */
35 enum {
36 	IRQTF_RUNTHREAD,
37 	IRQTF_WARNED,
38 	IRQTF_AFFINITY,
39 	IRQTF_FORCED_THREAD,
40 	IRQTF_READY,
41 };
42 
43 /*
44  * Bit masks for desc->core_internal_state__do_not_mess_with_it
45  *
46  * IRQS_AUTODETECT		- autodetection in progress
47  * IRQS_SPURIOUS_DISABLED	- was disabled due to spurious interrupt
48  *				  detection
49  * IRQS_POLL_INPROGRESS		- polling in progress
50  * IRQS_ONESHOT			- irq is not unmasked in primary handler
51  * IRQS_REPLAY			- irq has been resent and will not be resent
52  * 				  again until the handler has run and cleared
53  * 				  this flag.
54  * IRQS_WAITING			- irq is waiting
55  * IRQS_PENDING			- irq needs to be resent and should be resent
56  * 				  at the next available opportunity.
57  * IRQS_SUSPENDED		- irq is suspended
58  * IRQS_NMI			- irq line is used to deliver NMIs
59  * IRQS_SYSFS			- descriptor has been added to sysfs
60  */
61 enum {
62 	IRQS_AUTODETECT		= 0x00000001,
63 	IRQS_SPURIOUS_DISABLED	= 0x00000002,
64 	IRQS_POLL_INPROGRESS	= 0x00000008,
65 	IRQS_ONESHOT		= 0x00000020,
66 	IRQS_REPLAY		= 0x00000040,
67 	IRQS_WAITING		= 0x00000080,
68 	IRQS_PENDING		= 0x00000200,
69 	IRQS_SUSPENDED		= 0x00000800,
70 	IRQS_TIMINGS		= 0x00001000,
71 	IRQS_NMI		= 0x00002000,
72 	IRQS_SYSFS		= 0x00004000,
73 };
74 
75 #include "debug.h"
76 #include "settings.h"
77 
78 extern int __irq_set_trigger(struct irq_desc *desc, unsigned long flags);
79 extern void __disable_irq(struct irq_desc *desc);
80 extern void __enable_irq(struct irq_desc *desc);
81 
82 #define IRQ_RESEND	true
83 #define IRQ_NORESEND	false
84 
85 #define IRQ_START_FORCE	true
86 #define IRQ_START_COND	false
87 
88 extern int irq_activate(struct irq_desc *desc);
89 extern int irq_activate_and_startup(struct irq_desc *desc, bool resend);
90 extern int irq_startup(struct irq_desc *desc, bool resend, bool force);
91 extern void irq_startup_managed(struct irq_desc *desc);
92 
93 extern void irq_shutdown(struct irq_desc *desc);
94 extern void irq_shutdown_and_deactivate(struct irq_desc *desc);
95 extern void irq_disable(struct irq_desc *desc);
96 extern void irq_percpu_enable(struct irq_desc *desc, unsigned int cpu);
97 extern void irq_percpu_disable(struct irq_desc *desc, unsigned int cpu);
98 extern void mask_irq(struct irq_desc *desc);
99 extern void unmask_irq(struct irq_desc *desc);
100 extern void unmask_threaded_irq(struct irq_desc *desc);
101 
102 #ifdef CONFIG_SPARSE_IRQ
103 static inline void irq_mark_irq(unsigned int irq) { }
104 #else
105 extern void irq_mark_irq(unsigned int irq);
106 #endif
107 
108 irqreturn_t __handle_irq_event_percpu(struct irq_desc *desc);
109 irqreturn_t handle_irq_event_percpu(struct irq_desc *desc);
110 irqreturn_t handle_irq_event(struct irq_desc *desc);
111 
112 /* Resending of interrupts :*/
113 int check_irq_resend(struct irq_desc *desc, bool inject);
114 void clear_irq_resend(struct irq_desc *desc);
115 void irq_resend_init(struct irq_desc *desc);
116 void __irq_wake_thread(struct irq_desc *desc, struct irqaction *action);
117 
118 void wake_threads_waitq(struct irq_desc *desc);
119 
120 #ifdef CONFIG_PROC_FS
121 extern void register_irq_proc(unsigned int irq, struct irq_desc *desc);
122 extern void unregister_irq_proc(unsigned int irq, struct irq_desc *desc);
123 extern void register_handler_proc(unsigned int irq, struct irqaction *action);
124 extern void unregister_handler_proc(unsigned int irq, struct irqaction *action);
125 #else
126 static inline void register_irq_proc(unsigned int irq, struct irq_desc *desc) { }
127 static inline void unregister_irq_proc(unsigned int irq, struct irq_desc *desc) { }
128 static inline void register_handler_proc(unsigned int irq,
129 					 struct irqaction *action) { }
130 static inline void unregister_handler_proc(unsigned int irq,
131 					   struct irqaction *action) { }
132 #endif
133 
134 extern bool irq_can_set_affinity_usr(unsigned int irq);
135 
136 extern int irq_do_set_affinity(struct irq_data *data,
137 			       const struct cpumask *dest, bool force);
138 extern void irq_affinity_schedule_notify_work(struct irq_desc *desc);
139 
140 #ifdef CONFIG_SMP
141 extern int irq_setup_affinity(struct irq_desc *desc);
142 #else
143 static inline int irq_setup_affinity(struct irq_desc *desc) { return 0; }
144 #endif
145 
146 #define for_each_action_of_desc(desc, act)			\
147 	for (act = desc->action; act; act = act->next)
148 
149 /* Inline functions for support of irq chips on slow busses */
150 static inline void chip_bus_lock(struct irq_desc *desc)
151 {
152 	if (unlikely(desc->irq_data.chip->irq_bus_lock))
153 		desc->irq_data.chip->irq_bus_lock(&desc->irq_data);
154 }
155 
156 static inline void chip_bus_sync_unlock(struct irq_desc *desc)
157 {
158 	if (unlikely(desc->irq_data.chip->irq_bus_sync_unlock))
159 		desc->irq_data.chip->irq_bus_sync_unlock(&desc->irq_data);
160 }
161 
162 #define _IRQ_DESC_CHECK		(1 << 0)
163 #define _IRQ_DESC_PERCPU	(1 << 1)
164 
165 #define IRQ_GET_DESC_CHECK_GLOBAL	(_IRQ_DESC_CHECK)
166 #define IRQ_GET_DESC_CHECK_PERCPU	(_IRQ_DESC_CHECK | _IRQ_DESC_PERCPU)
167 
168 struct irq_desc *__irq_get_desc_lock(unsigned int irq, unsigned long *flags, bool bus,
169 				     unsigned int check);
170 void __irq_put_desc_unlock(struct irq_desc *desc, unsigned long flags, bool bus);
171 
172 __DEFINE_CLASS_IS_CONDITIONAL(irqdesc_lock, true);
173 __DEFINE_UNLOCK_GUARD(irqdesc_lock, struct irq_desc,
174 		      __irq_put_desc_unlock(_T->lock, _T->flags, _T->bus),
175 		      unsigned long flags; bool bus);
176 
177 static inline class_irqdesc_lock_t class_irqdesc_lock_constructor(unsigned int irq, bool bus,
178 								  unsigned int check)
179 {
180 	class_irqdesc_lock_t _t = { .bus = bus, };
181 
182 	_t.lock = __irq_get_desc_lock(irq, &_t.flags, bus, check);
183 
184 	return _t;
185 }
186 
187 #define scoped_irqdesc_get_and_lock(_irq, _check)		\
188 	scoped_guard(irqdesc_lock, _irq, false, _check)
189 
190 #define scoped_irqdesc_get_and_buslock(_irq, _check)		\
191 	scoped_guard(irqdesc_lock, _irq, true, _check)
192 
193 #define scoped_irqdesc		((struct irq_desc *)(__guard_ptr(irqdesc_lock)(&scope)))
194 
195 #define __irqd_to_state(d) ACCESS_PRIVATE((d)->common, state_use_accessors)
196 
197 static inline unsigned int irqd_get(struct irq_data *d)
198 {
199 	return __irqd_to_state(d);
200 }
201 
202 /*
203  * Manipulation functions for irq_data.state
204  */
205 static inline void irqd_set_move_pending(struct irq_data *d)
206 {
207 	__irqd_to_state(d) |= IRQD_SETAFFINITY_PENDING;
208 }
209 
210 static inline void irqd_clr_move_pending(struct irq_data *d)
211 {
212 	__irqd_to_state(d) &= ~IRQD_SETAFFINITY_PENDING;
213 }
214 
215 static inline void irqd_set_managed_shutdown(struct irq_data *d)
216 {
217 	__irqd_to_state(d) |= IRQD_MANAGED_SHUTDOWN;
218 }
219 
220 static inline void irqd_clr_managed_shutdown(struct irq_data *d)
221 {
222 	__irqd_to_state(d) &= ~IRQD_MANAGED_SHUTDOWN;
223 }
224 
225 static inline void irqd_clear(struct irq_data *d, unsigned int mask)
226 {
227 	__irqd_to_state(d) &= ~mask;
228 }
229 
230 static inline void irqd_set(struct irq_data *d, unsigned int mask)
231 {
232 	__irqd_to_state(d) |= mask;
233 }
234 
235 static inline bool irqd_has_set(struct irq_data *d, unsigned int mask)
236 {
237 	return __irqd_to_state(d) & mask;
238 }
239 
240 static inline void irq_state_set_disabled(struct irq_desc *desc)
241 {
242 	irqd_set(&desc->irq_data, IRQD_IRQ_DISABLED);
243 }
244 
245 static inline void irq_state_set_masked(struct irq_desc *desc)
246 {
247 	irqd_set(&desc->irq_data, IRQD_IRQ_MASKED);
248 }
249 
250 #undef __irqd_to_state
251 
252 static inline void __kstat_incr_irqs_this_cpu(struct irq_desc *desc)
253 {
254 	__this_cpu_inc(desc->kstat_irqs->cnt);
255 	__this_cpu_inc(kstat.irqs_sum);
256 }
257 
258 static inline void kstat_incr_irqs_this_cpu(struct irq_desc *desc)
259 {
260 	__kstat_incr_irqs_this_cpu(desc);
261 	desc->tot_count++;
262 }
263 
264 static inline int irq_desc_get_node(struct irq_desc *desc)
265 {
266 	return irq_common_data_get_node(&desc->irq_common_data);
267 }
268 
269 static inline int irq_desc_is_chained(struct irq_desc *desc)
270 {
271 	return (desc->action && desc->action == &chained_action);
272 }
273 
274 static inline bool irq_is_nmi(struct irq_desc *desc)
275 {
276 	return desc->istate & IRQS_NMI;
277 }
278 
279 #ifdef CONFIG_PM_SLEEP
280 void irq_pm_handle_wakeup(struct irq_desc *desc);
281 void irq_pm_install_action(struct irq_desc *desc, struct irqaction *action);
282 void irq_pm_remove_action(struct irq_desc *desc, struct irqaction *action);
283 #else
284 static inline void irq_pm_handle_wakeup(struct irq_desc *desc) { }
285 static inline void
286 irq_pm_install_action(struct irq_desc *desc, struct irqaction *action) { }
287 static inline void
288 irq_pm_remove_action(struct irq_desc *desc, struct irqaction *action) { }
289 #endif
290 
291 #ifdef CONFIG_GENERIC_IRQ_CHIP
292 void irq_init_generic_chip(struct irq_chip_generic *gc, const char *name,
293 			   int num_ct, unsigned int irq_base,
294 			   void __iomem *reg_base, irq_flow_handler_t handler);
295 #else
296 static inline void
297 irq_init_generic_chip(struct irq_chip_generic *gc, const char *name,
298 		      int num_ct, unsigned int irq_base,
299 		      void __iomem *reg_base, irq_flow_handler_t handler) { }
300 #endif /* CONFIG_GENERIC_IRQ_CHIP */
301 
302 #ifdef CONFIG_GENERIC_PENDING_IRQ
303 static inline bool irq_can_move_pcntxt(struct irq_data *data)
304 {
305 	return !(data->chip->flags & IRQCHIP_MOVE_DEFERRED);
306 }
307 static inline bool irq_move_pending(struct irq_data *data)
308 {
309 	return irqd_is_setaffinity_pending(data);
310 }
311 static inline void
312 irq_copy_pending(struct irq_desc *desc, const struct cpumask *mask)
313 {
314 	cpumask_copy(desc->pending_mask, mask);
315 }
316 static inline void
317 irq_get_pending(struct cpumask *mask, struct irq_desc *desc)
318 {
319 	cpumask_copy(mask, desc->pending_mask);
320 }
321 static inline struct cpumask *irq_desc_get_pending_mask(struct irq_desc *desc)
322 {
323 	return desc->pending_mask;
324 }
325 bool irq_fixup_move_pending(struct irq_desc *desc, bool force_clear);
326 void irq_force_complete_move(struct irq_desc *desc);
327 #else /* CONFIG_GENERIC_PENDING_IRQ */
328 static inline bool irq_can_move_pcntxt(struct irq_data *data)
329 {
330 	return true;
331 }
332 static inline bool irq_move_pending(struct irq_data *data)
333 {
334 	return false;
335 }
336 static inline void
337 irq_copy_pending(struct irq_desc *desc, const struct cpumask *mask)
338 {
339 }
340 static inline void
341 irq_get_pending(struct cpumask *mask, struct irq_desc *desc)
342 {
343 }
344 static inline struct cpumask *irq_desc_get_pending_mask(struct irq_desc *desc)
345 {
346 	return NULL;
347 }
348 static inline bool irq_fixup_move_pending(struct irq_desc *desc, bool fclear)
349 {
350 	return false;
351 }
352 static inline void irq_force_complete_move(struct irq_desc *desc) { }
353 #endif /* !CONFIG_GENERIC_PENDING_IRQ */
354 
355 #if !defined(CONFIG_IRQ_DOMAIN) || !defined(CONFIG_IRQ_DOMAIN_HIERARCHY)
356 static inline int irq_domain_activate_irq(struct irq_data *data, bool reserve)
357 {
358 	irqd_set_activated(data);
359 	return 0;
360 }
361 static inline void irq_domain_deactivate_irq(struct irq_data *data)
362 {
363 	irqd_clr_activated(data);
364 }
365 #endif
366 
367 static inline struct irq_data *irqd_get_parent_data(struct irq_data *irqd)
368 {
369 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
370 	return irqd->parent_data;
371 #else
372 	return NULL;
373 #endif
374 }
375 
376 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
377 #include <linux/debugfs.h>
378 
379 struct irq_bit_descr {
380 	unsigned int	mask;
381 	char		*name;
382 };
383 
384 #define BIT_MASK_DESCR(m)	{ .mask = m, .name = #m }
385 
386 void irq_debug_show_bits(struct seq_file *m, int ind, unsigned int state,
387 			 const struct irq_bit_descr *sd, int size);
388 
389 void irq_add_debugfs_entry(unsigned int irq, struct irq_desc *desc);
390 static inline void irq_remove_debugfs_entry(struct irq_desc *desc)
391 {
392 	debugfs_remove(desc->debugfs_file);
393 	kfree(desc->dev_name);
394 }
395 void irq_debugfs_copy_devname(int irq, struct device *dev);
396 # ifdef CONFIG_IRQ_DOMAIN
397 void irq_domain_debugfs_init(struct dentry *root);
398 # else
399 static inline void irq_domain_debugfs_init(struct dentry *root)
400 {
401 }
402 # endif
403 #else /* CONFIG_GENERIC_IRQ_DEBUGFS */
404 static inline void irq_add_debugfs_entry(unsigned int irq, struct irq_desc *d)
405 {
406 }
407 static inline void irq_remove_debugfs_entry(struct irq_desc *d)
408 {
409 }
410 static inline void irq_debugfs_copy_devname(int irq, struct device *dev)
411 {
412 }
413 #endif /* CONFIG_GENERIC_IRQ_DEBUGFS */
414