xref: /linux-6.15/kernel/irq/internals.h (revision 4001d8e8)
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 IRQ_BITMAP_BITS	(NR_IRQS + 8196)
16 #else
17 # define IRQ_BITMAP_BITS	NR_IRQS
18 #endif
19 
20 #define istate core_internal_state__do_not_mess_with_it
21 
22 extern bool noirqdebug;
23 
24 extern struct irqaction chained_action;
25 
26 /*
27  * Bits used by threaded handlers:
28  * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
29  * IRQTF_WARNED    - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
30  * IRQTF_AFFINITY  - irq thread is requested to adjust affinity
31  * IRQTF_FORCED_THREAD  - irq action is force threaded
32  */
33 enum {
34 	IRQTF_RUNTHREAD,
35 	IRQTF_WARNED,
36 	IRQTF_AFFINITY,
37 	IRQTF_FORCED_THREAD,
38 };
39 
40 /*
41  * Bit masks for desc->core_internal_state__do_not_mess_with_it
42  *
43  * IRQS_AUTODETECT		- autodetection in progress
44  * IRQS_SPURIOUS_DISABLED	- was disabled due to spurious interrupt
45  *				  detection
46  * IRQS_POLL_INPROGRESS		- polling in progress
47  * IRQS_ONESHOT			- irq is not unmasked in primary handler
48  * IRQS_REPLAY			- irq is replayed
49  * IRQS_WAITING			- irq is waiting
50  * IRQS_PENDING			- irq is pending and replayed later
51  * IRQS_SUSPENDED		- irq is suspended
52  * IRQS_NMI			- irq line is used to deliver NMIs
53  */
54 enum {
55 	IRQS_AUTODETECT		= 0x00000001,
56 	IRQS_SPURIOUS_DISABLED	= 0x00000002,
57 	IRQS_POLL_INPROGRESS	= 0x00000008,
58 	IRQS_ONESHOT		= 0x00000020,
59 	IRQS_REPLAY		= 0x00000040,
60 	IRQS_WAITING		= 0x00000080,
61 	IRQS_PENDING		= 0x00000200,
62 	IRQS_SUSPENDED		= 0x00000800,
63 	IRQS_TIMINGS		= 0x00001000,
64 	IRQS_NMI		= 0x00002000,
65 };
66 
67 #include "debug.h"
68 #include "settings.h"
69 
70 extern int __irq_set_trigger(struct irq_desc *desc, unsigned long flags);
71 extern void __disable_irq(struct irq_desc *desc);
72 extern void __enable_irq(struct irq_desc *desc);
73 
74 #define IRQ_RESEND	true
75 #define IRQ_NORESEND	false
76 
77 #define IRQ_START_FORCE	true
78 #define IRQ_START_COND	false
79 
80 extern int irq_activate(struct irq_desc *desc);
81 extern int irq_activate_and_startup(struct irq_desc *desc, bool resend);
82 extern int irq_startup(struct irq_desc *desc, bool resend, bool force);
83 
84 extern void irq_shutdown(struct irq_desc *desc);
85 extern void irq_shutdown_and_deactivate(struct irq_desc *desc);
86 extern void irq_enable(struct irq_desc *desc);
87 extern void irq_disable(struct irq_desc *desc);
88 extern void irq_percpu_enable(struct irq_desc *desc, unsigned int cpu);
89 extern void irq_percpu_disable(struct irq_desc *desc, unsigned int cpu);
90 extern void mask_irq(struct irq_desc *desc);
91 extern void unmask_irq(struct irq_desc *desc);
92 extern void unmask_threaded_irq(struct irq_desc *desc);
93 
94 #ifdef CONFIG_SPARSE_IRQ
95 static inline void irq_mark_irq(unsigned int irq) { }
96 #else
97 extern void irq_mark_irq(unsigned int irq);
98 #endif
99 
100 extern void init_kstat_irqs(struct irq_desc *desc, int node, int nr);
101 
102 irqreturn_t __handle_irq_event_percpu(struct irq_desc *desc, unsigned int *flags);
103 irqreturn_t handle_irq_event_percpu(struct irq_desc *desc);
104 irqreturn_t handle_irq_event(struct irq_desc *desc);
105 
106 /* Resending of interrupts :*/
107 void check_irq_resend(struct irq_desc *desc);
108 bool irq_wait_for_poll(struct irq_desc *desc);
109 void __irq_wake_thread(struct irq_desc *desc, struct irqaction *action);
110 
111 #ifdef CONFIG_PROC_FS
112 extern void register_irq_proc(unsigned int irq, struct irq_desc *desc);
113 extern void unregister_irq_proc(unsigned int irq, struct irq_desc *desc);
114 extern void register_handler_proc(unsigned int irq, struct irqaction *action);
115 extern void unregister_handler_proc(unsigned int irq, struct irqaction *action);
116 #else
117 static inline void register_irq_proc(unsigned int irq, struct irq_desc *desc) { }
118 static inline void unregister_irq_proc(unsigned int irq, struct irq_desc *desc) { }
119 static inline void register_handler_proc(unsigned int irq,
120 					 struct irqaction *action) { }
121 static inline void unregister_handler_proc(unsigned int irq,
122 					   struct irqaction *action) { }
123 #endif
124 
125 extern bool irq_can_set_affinity_usr(unsigned int irq);
126 
127 extern int irq_select_affinity_usr(unsigned int irq);
128 
129 extern void irq_set_thread_affinity(struct irq_desc *desc);
130 
131 extern int irq_do_set_affinity(struct irq_data *data,
132 			       const struct cpumask *dest, bool force);
133 
134 #ifdef CONFIG_SMP
135 extern int irq_setup_affinity(struct irq_desc *desc);
136 #else
137 static inline int irq_setup_affinity(struct irq_desc *desc) { return 0; }
138 #endif
139 
140 /* Inline functions for support of irq chips on slow busses */
141 static inline void chip_bus_lock(struct irq_desc *desc)
142 {
143 	if (unlikely(desc->irq_data.chip->irq_bus_lock))
144 		desc->irq_data.chip->irq_bus_lock(&desc->irq_data);
145 }
146 
147 static inline void chip_bus_sync_unlock(struct irq_desc *desc)
148 {
149 	if (unlikely(desc->irq_data.chip->irq_bus_sync_unlock))
150 		desc->irq_data.chip->irq_bus_sync_unlock(&desc->irq_data);
151 }
152 
153 #define _IRQ_DESC_CHECK		(1 << 0)
154 #define _IRQ_DESC_PERCPU	(1 << 1)
155 
156 #define IRQ_GET_DESC_CHECK_GLOBAL	(_IRQ_DESC_CHECK)
157 #define IRQ_GET_DESC_CHECK_PERCPU	(_IRQ_DESC_CHECK | _IRQ_DESC_PERCPU)
158 
159 #define for_each_action_of_desc(desc, act)			\
160 	for (act = desc->action; act; act = act->next)
161 
162 struct irq_desc *
163 __irq_get_desc_lock(unsigned int irq, unsigned long *flags, bool bus,
164 		    unsigned int check);
165 void __irq_put_desc_unlock(struct irq_desc *desc, unsigned long flags, bool bus);
166 
167 static inline struct irq_desc *
168 irq_get_desc_buslock(unsigned int irq, unsigned long *flags, unsigned int check)
169 {
170 	return __irq_get_desc_lock(irq, flags, true, check);
171 }
172 
173 static inline void
174 irq_put_desc_busunlock(struct irq_desc *desc, unsigned long flags)
175 {
176 	__irq_put_desc_unlock(desc, flags, true);
177 }
178 
179 static inline struct irq_desc *
180 irq_get_desc_lock(unsigned int irq, unsigned long *flags, unsigned int check)
181 {
182 	return __irq_get_desc_lock(irq, flags, false, check);
183 }
184 
185 static inline void
186 irq_put_desc_unlock(struct irq_desc *desc, unsigned long flags)
187 {
188 	__irq_put_desc_unlock(desc, flags, false);
189 }
190 
191 #define __irqd_to_state(d) ACCESS_PRIVATE((d)->common, state_use_accessors)
192 
193 static inline unsigned int irqd_get(struct irq_data *d)
194 {
195 	return __irqd_to_state(d);
196 }
197 
198 /*
199  * Manipulation functions for irq_data.state
200  */
201 static inline void irqd_set_move_pending(struct irq_data *d)
202 {
203 	__irqd_to_state(d) |= IRQD_SETAFFINITY_PENDING;
204 }
205 
206 static inline void irqd_clr_move_pending(struct irq_data *d)
207 {
208 	__irqd_to_state(d) &= ~IRQD_SETAFFINITY_PENDING;
209 }
210 
211 static inline void irqd_set_managed_shutdown(struct irq_data *d)
212 {
213 	__irqd_to_state(d) |= IRQD_MANAGED_SHUTDOWN;
214 }
215 
216 static inline void irqd_clr_managed_shutdown(struct irq_data *d)
217 {
218 	__irqd_to_state(d) &= ~IRQD_MANAGED_SHUTDOWN;
219 }
220 
221 static inline void irqd_clear(struct irq_data *d, unsigned int mask)
222 {
223 	__irqd_to_state(d) &= ~mask;
224 }
225 
226 static inline void irqd_set(struct irq_data *d, unsigned int mask)
227 {
228 	__irqd_to_state(d) |= mask;
229 }
230 
231 static inline bool irqd_has_set(struct irq_data *d, unsigned int mask)
232 {
233 	return __irqd_to_state(d) & mask;
234 }
235 
236 static inline void irq_state_set_disabled(struct irq_desc *desc)
237 {
238 	irqd_set(&desc->irq_data, IRQD_IRQ_DISABLED);
239 }
240 
241 static inline void irq_state_set_masked(struct irq_desc *desc)
242 {
243 	irqd_set(&desc->irq_data, IRQD_IRQ_MASKED);
244 }
245 
246 #undef __irqd_to_state
247 
248 static inline void __kstat_incr_irqs_this_cpu(struct irq_desc *desc)
249 {
250 	__this_cpu_inc(*desc->kstat_irqs);
251 	__this_cpu_inc(kstat.irqs_sum);
252 }
253 
254 static inline void kstat_incr_irqs_this_cpu(struct irq_desc *desc)
255 {
256 	__kstat_incr_irqs_this_cpu(desc);
257 	desc->tot_count++;
258 }
259 
260 static inline int irq_desc_get_node(struct irq_desc *desc)
261 {
262 	return irq_common_data_get_node(&desc->irq_common_data);
263 }
264 
265 static inline int irq_desc_is_chained(struct irq_desc *desc)
266 {
267 	return (desc->action && desc->action == &chained_action);
268 }
269 
270 #ifdef CONFIG_PM_SLEEP
271 bool irq_pm_check_wakeup(struct irq_desc *desc);
272 void irq_pm_install_action(struct irq_desc *desc, struct irqaction *action);
273 void irq_pm_remove_action(struct irq_desc *desc, struct irqaction *action);
274 #else
275 static inline bool irq_pm_check_wakeup(struct irq_desc *desc) { return false; }
276 static inline void
277 irq_pm_install_action(struct irq_desc *desc, struct irqaction *action) { }
278 static inline void
279 irq_pm_remove_action(struct irq_desc *desc, struct irqaction *action) { }
280 #endif
281 
282 #ifdef CONFIG_IRQ_TIMINGS
283 
284 #define IRQ_TIMINGS_SHIFT	5
285 #define IRQ_TIMINGS_SIZE	(1 << IRQ_TIMINGS_SHIFT)
286 #define IRQ_TIMINGS_MASK	(IRQ_TIMINGS_SIZE - 1)
287 
288 /**
289  * struct irq_timings - irq timings storing structure
290  * @values: a circular buffer of u64 encoded <timestamp,irq> values
291  * @count: the number of elements in the array
292  */
293 struct irq_timings {
294 	u64	values[IRQ_TIMINGS_SIZE];
295 	int	count;
296 };
297 
298 DECLARE_PER_CPU(struct irq_timings, irq_timings);
299 
300 extern void irq_timings_free(int irq);
301 extern int irq_timings_alloc(int irq);
302 
303 static inline void irq_remove_timings(struct irq_desc *desc)
304 {
305 	desc->istate &= ~IRQS_TIMINGS;
306 
307 	irq_timings_free(irq_desc_get_irq(desc));
308 }
309 
310 static inline void irq_setup_timings(struct irq_desc *desc, struct irqaction *act)
311 {
312 	int irq = irq_desc_get_irq(desc);
313 	int ret;
314 
315 	/*
316 	 * We don't need the measurement because the idle code already
317 	 * knows the next expiry event.
318 	 */
319 	if (act->flags & __IRQF_TIMER)
320 		return;
321 
322 	/*
323 	 * In case the timing allocation fails, we just want to warn,
324 	 * not fail, so letting the system boot anyway.
325 	 */
326 	ret = irq_timings_alloc(irq);
327 	if (ret) {
328 		pr_warn("Failed to allocate irq timing stats for irq%d (%d)",
329 			irq, ret);
330 		return;
331 	}
332 
333 	desc->istate |= IRQS_TIMINGS;
334 }
335 
336 extern void irq_timings_enable(void);
337 extern void irq_timings_disable(void);
338 
339 DECLARE_STATIC_KEY_FALSE(irq_timing_enabled);
340 
341 /*
342  * The interrupt number and the timestamp are encoded into a single
343  * u64 variable to optimize the size.
344  * 48 bit time stamp and 16 bit IRQ number is way sufficient.
345  *  Who cares an IRQ after 78 hours of idle time?
346  */
347 static inline u64 irq_timing_encode(u64 timestamp, int irq)
348 {
349 	return (timestamp << 16) | irq;
350 }
351 
352 static inline int irq_timing_decode(u64 value, u64 *timestamp)
353 {
354 	*timestamp = value >> 16;
355 	return value & U16_MAX;
356 }
357 
358 /*
359  * The function record_irq_time is only called in one place in the
360  * interrupts handler. We want this function always inline so the code
361  * inside is embedded in the function and the static key branching
362  * code can act at the higher level. Without the explicit
363  * __always_inline we can end up with a function call and a small
364  * overhead in the hotpath for nothing.
365  */
366 static __always_inline void record_irq_time(struct irq_desc *desc)
367 {
368 	if (!static_branch_likely(&irq_timing_enabled))
369 		return;
370 
371 	if (desc->istate & IRQS_TIMINGS) {
372 		struct irq_timings *timings = this_cpu_ptr(&irq_timings);
373 
374 		timings->values[timings->count & IRQ_TIMINGS_MASK] =
375 			irq_timing_encode(local_clock(),
376 					  irq_desc_get_irq(desc));
377 
378 		timings->count++;
379 	}
380 }
381 #else
382 static inline void irq_remove_timings(struct irq_desc *desc) {}
383 static inline void irq_setup_timings(struct irq_desc *desc,
384 				     struct irqaction *act) {};
385 static inline void record_irq_time(struct irq_desc *desc) {}
386 #endif /* CONFIG_IRQ_TIMINGS */
387 
388 
389 #ifdef CONFIG_GENERIC_IRQ_CHIP
390 void irq_init_generic_chip(struct irq_chip_generic *gc, const char *name,
391 			   int num_ct, unsigned int irq_base,
392 			   void __iomem *reg_base, irq_flow_handler_t handler);
393 #else
394 static inline void
395 irq_init_generic_chip(struct irq_chip_generic *gc, const char *name,
396 		      int num_ct, unsigned int irq_base,
397 		      void __iomem *reg_base, irq_flow_handler_t handler) { }
398 #endif /* CONFIG_GENERIC_IRQ_CHIP */
399 
400 #ifdef CONFIG_GENERIC_PENDING_IRQ
401 static inline bool irq_can_move_pcntxt(struct irq_data *data)
402 {
403 	return irqd_can_move_in_process_context(data);
404 }
405 static inline bool irq_move_pending(struct irq_data *data)
406 {
407 	return irqd_is_setaffinity_pending(data);
408 }
409 static inline void
410 irq_copy_pending(struct irq_desc *desc, const struct cpumask *mask)
411 {
412 	cpumask_copy(desc->pending_mask, mask);
413 }
414 static inline void
415 irq_get_pending(struct cpumask *mask, struct irq_desc *desc)
416 {
417 	cpumask_copy(mask, desc->pending_mask);
418 }
419 static inline struct cpumask *irq_desc_get_pending_mask(struct irq_desc *desc)
420 {
421 	return desc->pending_mask;
422 }
423 bool irq_fixup_move_pending(struct irq_desc *desc, bool force_clear);
424 #else /* CONFIG_GENERIC_PENDING_IRQ */
425 static inline bool irq_can_move_pcntxt(struct irq_data *data)
426 {
427 	return true;
428 }
429 static inline bool irq_move_pending(struct irq_data *data)
430 {
431 	return false;
432 }
433 static inline void
434 irq_copy_pending(struct irq_desc *desc, const struct cpumask *mask)
435 {
436 }
437 static inline void
438 irq_get_pending(struct cpumask *mask, struct irq_desc *desc)
439 {
440 }
441 static inline struct cpumask *irq_desc_get_pending_mask(struct irq_desc *desc)
442 {
443 	return NULL;
444 }
445 static inline bool irq_fixup_move_pending(struct irq_desc *desc, bool fclear)
446 {
447 	return false;
448 }
449 #endif /* !CONFIG_GENERIC_PENDING_IRQ */
450 
451 #if !defined(CONFIG_IRQ_DOMAIN) || !defined(CONFIG_IRQ_DOMAIN_HIERARCHY)
452 static inline int irq_domain_activate_irq(struct irq_data *data, bool reserve)
453 {
454 	irqd_set_activated(data);
455 	return 0;
456 }
457 static inline void irq_domain_deactivate_irq(struct irq_data *data)
458 {
459 	irqd_clr_activated(data);
460 }
461 #endif
462 
463 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
464 #include <linux/debugfs.h>
465 
466 void irq_add_debugfs_entry(unsigned int irq, struct irq_desc *desc);
467 static inline void irq_remove_debugfs_entry(struct irq_desc *desc)
468 {
469 	debugfs_remove(desc->debugfs_file);
470 	kfree(desc->dev_name);
471 }
472 void irq_debugfs_copy_devname(int irq, struct device *dev);
473 # ifdef CONFIG_IRQ_DOMAIN
474 void irq_domain_debugfs_init(struct dentry *root);
475 # else
476 static inline void irq_domain_debugfs_init(struct dentry *root)
477 {
478 }
479 # endif
480 #else /* CONFIG_GENERIC_IRQ_DEBUGFS */
481 static inline void irq_add_debugfs_entry(unsigned int irq, struct irq_desc *d)
482 {
483 }
484 static inline void irq_remove_debugfs_entry(struct irq_desc *d)
485 {
486 }
487 static inline void irq_debugfs_copy_devname(int irq, struct device *dev)
488 {
489 }
490 #endif /* CONFIG_GENERIC_IRQ_DEBUGFS */
491