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