kernel/irq/internals.h

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