1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_IRQDESC_H 3 #define _LINUX_IRQDESC_H 4 5 #include <linux/rcupdate.h> 6 #include <linux/kobject.h> 7 #include <linux/mutex.h> 8 9 /* 10 * Core internal functions to deal with irq descriptors 11 */ 12 13 struct irq_affinity_notify; 14 struct proc_dir_entry; 15 struct module; 16 struct irq_desc; 17 struct irq_domain; 18 struct pt_regs; 19 20 /** 21 * struct irq_desc - interrupt descriptor 22 * @irq_common_data: per irq and chip data passed down to chip functions 23 * @kstat_irqs: irq stats per cpu 24 * @handle_irq: highlevel irq-events handler 25 * @action: the irq action chain 26 * @status_use_accessors: status information 27 * @core_internal_state__do_not_mess_with_it: core internal status information 28 * @depth: disable-depth, for nested irq_disable() calls 29 * @wake_depth: enable depth, for multiple irq_set_irq_wake() callers 30 * @tot_count: stats field for non-percpu irqs 31 * @irq_count: stats field to detect stalled irqs 32 * @last_unhandled: aging timer for unhandled count 33 * @irqs_unhandled: stats field for spurious unhandled interrupts 34 * @threads_handled: stats field for deferred spurious detection of threaded handlers 35 * @threads_handled_last: comparator field for deferred spurious detection of threaded handlers 36 * @lock: locking for SMP 37 * @affinity_hint: hint to user space for preferred irq affinity 38 * @affinity_notify: context for notification of affinity changes 39 * @pending_mask: pending rebalanced interrupts 40 * @threads_oneshot: bitfield to handle shared oneshot threads 41 * @threads_active: number of irqaction threads currently running 42 * @wait_for_threads: wait queue for sync_irq to wait for threaded handlers 43 * @nr_actions: number of installed actions on this descriptor 44 * @no_suspend_depth: number of irqactions on a irq descriptor with 45 * IRQF_NO_SUSPEND set 46 * @force_resume_depth: number of irqactions on a irq descriptor with 47 * IRQF_FORCE_RESUME set 48 * @rcu: rcu head for delayed free 49 * @kobj: kobject used to represent this struct in sysfs 50 * @request_mutex: mutex to protect request/free before locking desc->lock 51 * @dir: /proc/irq/ procfs entry 52 * @debugfs_file: dentry for the debugfs file 53 * @name: flow handler name for /proc/interrupts output 54 */ 55 struct irq_desc { 56 struct irq_common_data irq_common_data; 57 struct irq_data irq_data; 58 unsigned int __percpu *kstat_irqs; 59 irq_flow_handler_t handle_irq; 60 struct irqaction *action; /* IRQ action list */ 61 unsigned int status_use_accessors; 62 unsigned int core_internal_state__do_not_mess_with_it; 63 unsigned int depth; /* nested irq disables */ 64 unsigned int wake_depth; /* nested wake enables */ 65 unsigned int tot_count; 66 unsigned int irq_count; /* For detecting broken IRQs */ 67 unsigned long last_unhandled; /* Aging timer for unhandled count */ 68 unsigned int irqs_unhandled; 69 atomic_t threads_handled; 70 int threads_handled_last; 71 raw_spinlock_t lock; 72 struct cpumask *percpu_enabled; 73 const struct cpumask *percpu_affinity; 74 #ifdef CONFIG_SMP 75 const struct cpumask *affinity_hint; 76 struct irq_affinity_notify *affinity_notify; 77 #ifdef CONFIG_GENERIC_PENDING_IRQ 78 cpumask_var_t pending_mask; 79 #endif 80 #endif 81 unsigned long threads_oneshot; 82 atomic_t threads_active; 83 wait_queue_head_t wait_for_threads; 84 #ifdef CONFIG_PM_SLEEP 85 unsigned int nr_actions; 86 unsigned int no_suspend_depth; 87 unsigned int cond_suspend_depth; 88 unsigned int force_resume_depth; 89 #endif 90 #ifdef CONFIG_PROC_FS 91 struct proc_dir_entry *dir; 92 #endif 93 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS 94 struct dentry *debugfs_file; 95 const char *dev_name; 96 #endif 97 #ifdef CONFIG_SPARSE_IRQ 98 struct rcu_head rcu; 99 struct kobject kobj; 100 #endif 101 struct mutex request_mutex; 102 int parent_irq; 103 struct module *owner; 104 const char *name; 105 } ____cacheline_internodealigned_in_smp; 106 107 #ifdef CONFIG_SPARSE_IRQ 108 extern void irq_lock_sparse(void); 109 extern void irq_unlock_sparse(void); 110 #else 111 static inline void irq_lock_sparse(void) { } 112 static inline void irq_unlock_sparse(void) { } 113 extern struct irq_desc irq_desc[NR_IRQS]; 114 #endif 115 116 static inline unsigned int irq_desc_kstat_cpu(struct irq_desc *desc, 117 unsigned int cpu) 118 { 119 return desc->kstat_irqs ? *per_cpu_ptr(desc->kstat_irqs, cpu) : 0; 120 } 121 122 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data) 123 { 124 return container_of(data->common, struct irq_desc, irq_common_data); 125 } 126 127 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc) 128 { 129 return desc->irq_data.irq; 130 } 131 132 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc) 133 { 134 return &desc->irq_data; 135 } 136 137 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc) 138 { 139 return desc->irq_data.chip; 140 } 141 142 static inline void *irq_desc_get_chip_data(struct irq_desc *desc) 143 { 144 return desc->irq_data.chip_data; 145 } 146 147 static inline void *irq_desc_get_handler_data(struct irq_desc *desc) 148 { 149 return desc->irq_common_data.handler_data; 150 } 151 152 /* 153 * Architectures call this to let the generic IRQ layer 154 * handle an interrupt. 155 */ 156 static inline void generic_handle_irq_desc(struct irq_desc *desc) 157 { 158 desc->handle_irq(desc); 159 } 160 161 int handle_irq_desc(struct irq_desc *desc); 162 int generic_handle_irq(unsigned int irq); 163 int generic_handle_irq_safe(unsigned int irq); 164 165 #ifdef CONFIG_IRQ_DOMAIN 166 /* 167 * Convert a HW interrupt number to a logical one using a IRQ domain, 168 * and handle the result interrupt number. Return -EINVAL if 169 * conversion failed. 170 */ 171 int generic_handle_domain_irq(struct irq_domain *domain, unsigned int hwirq); 172 int generic_handle_domain_irq_safe(struct irq_domain *domain, unsigned int hwirq); 173 int generic_handle_domain_nmi(struct irq_domain *domain, unsigned int hwirq); 174 #endif 175 176 /* Test to see if a driver has successfully requested an irq */ 177 static inline int irq_desc_has_action(struct irq_desc *desc) 178 { 179 return desc && desc->action != NULL; 180 } 181 182 /** 183 * irq_set_handler_locked - Set irq handler from a locked region 184 * @data: Pointer to the irq_data structure which identifies the irq 185 * @handler: Flow control handler function for this interrupt 186 * 187 * Sets the handler in the irq descriptor associated to @data. 188 * 189 * Must be called with irq_desc locked and valid parameters. Typical 190 * call site is the irq_set_type() callback. 191 */ 192 static inline void irq_set_handler_locked(struct irq_data *data, 193 irq_flow_handler_t handler) 194 { 195 struct irq_desc *desc = irq_data_to_desc(data); 196 197 desc->handle_irq = handler; 198 } 199 200 /** 201 * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region 202 * @data: Pointer to the irq_data structure for which the chip is set 203 * @chip: Pointer to the new irq chip 204 * @handler: Flow control handler function for this interrupt 205 * @name: Name of the interrupt 206 * 207 * Replace the irq chip at the proper hierarchy level in @data and 208 * sets the handler and name in the associated irq descriptor. 209 * 210 * Must be called with irq_desc locked and valid parameters. 211 */ 212 static inline void 213 irq_set_chip_handler_name_locked(struct irq_data *data, 214 const struct irq_chip *chip, 215 irq_flow_handler_t handler, const char *name) 216 { 217 struct irq_desc *desc = irq_data_to_desc(data); 218 219 desc->handle_irq = handler; 220 desc->name = name; 221 data->chip = (struct irq_chip *)chip; 222 } 223 224 bool irq_check_status_bit(unsigned int irq, unsigned int bitmask); 225 226 static inline bool irq_balancing_disabled(unsigned int irq) 227 { 228 return irq_check_status_bit(irq, IRQ_NO_BALANCING_MASK); 229 } 230 231 static inline bool irq_is_percpu(unsigned int irq) 232 { 233 return irq_check_status_bit(irq, IRQ_PER_CPU); 234 } 235 236 static inline bool irq_is_percpu_devid(unsigned int irq) 237 { 238 return irq_check_status_bit(irq, IRQ_PER_CPU_DEVID); 239 } 240 241 void __irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class, 242 struct lock_class_key *request_class); 243 static inline void 244 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class, 245 struct lock_class_key *request_class) 246 { 247 if (IS_ENABLED(CONFIG_LOCKDEP)) 248 __irq_set_lockdep_class(irq, lock_class, request_class); 249 } 250 251 #endif 252