kernel/irq/internals.h

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