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 * @preflow_handler: handler called before the flow handler (currently used by sparc) 26 * @action: the irq action chain 27 * @status: status information 28 * @core_internal_state__do_not_mess_with_it: core internal status information 29 * @depth: disable-depth, for nested irq_disable() calls 30 * @wake_depth: enable depth, for multiple irq_set_irq_wake() callers 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 theraded 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 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI 61 irq_preflow_handler_t preflow_handler; 62 #endif 63 struct irqaction *action; /* IRQ action list */ 64 unsigned int status_use_accessors; 65 unsigned int core_internal_state__do_not_mess_with_it; 66 unsigned int depth; /* nested irq disables */ 67 unsigned int wake_depth; /* nested wake enables */ 68 unsigned int irq_count; /* For detecting broken IRQs */ 69 unsigned long last_unhandled; /* Aging timer for unhandled count */ 70 unsigned int irqs_unhandled; 71 atomic_t threads_handled; 72 int threads_handled_last; 73 raw_spinlock_t lock; 74 struct cpumask *percpu_enabled; 75 const struct cpumask *percpu_affinity; 76 #ifdef CONFIG_SMP 77 const struct cpumask *affinity_hint; 78 struct irq_affinity_notify *affinity_notify; 79 #ifdef CONFIG_GENERIC_PENDING_IRQ 80 cpumask_var_t pending_mask; 81 #endif 82 #endif 83 unsigned long threads_oneshot; 84 atomic_t threads_active; 85 wait_queue_head_t wait_for_threads; 86 #ifdef CONFIG_PM_SLEEP 87 unsigned int nr_actions; 88 unsigned int no_suspend_depth; 89 unsigned int cond_suspend_depth; 90 unsigned int force_resume_depth; 91 #endif 92 #ifdef CONFIG_PROC_FS 93 struct proc_dir_entry *dir; 94 #endif 95 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS 96 struct dentry *debugfs_file; 97 const char *dev_name; 98 #endif 99 #ifdef CONFIG_SPARSE_IRQ 100 struct rcu_head rcu; 101 struct kobject kobj; 102 #endif 103 struct mutex request_mutex; 104 int parent_irq; 105 struct module *owner; 106 const char *name; 107 } ____cacheline_internodealigned_in_smp; 108 109 #ifdef CONFIG_SPARSE_IRQ 110 extern void irq_lock_sparse(void); 111 extern void irq_unlock_sparse(void); 112 #else 113 static inline void irq_lock_sparse(void) { } 114 static inline void irq_unlock_sparse(void) { } 115 extern struct irq_desc irq_desc[NR_IRQS]; 116 #endif 117 118 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data) 119 { 120 return container_of(data->common, struct irq_desc, irq_common_data); 121 } 122 123 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc) 124 { 125 return desc->irq_data.irq; 126 } 127 128 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc) 129 { 130 return &desc->irq_data; 131 } 132 133 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc) 134 { 135 return desc->irq_data.chip; 136 } 137 138 static inline void *irq_desc_get_chip_data(struct irq_desc *desc) 139 { 140 return desc->irq_data.chip_data; 141 } 142 143 static inline void *irq_desc_get_handler_data(struct irq_desc *desc) 144 { 145 return desc->irq_common_data.handler_data; 146 } 147 148 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc) 149 { 150 return desc->irq_common_data.msi_desc; 151 } 152 153 /* 154 * Architectures call this to let the generic IRQ layer 155 * handle an interrupt. 156 */ 157 static inline void generic_handle_irq_desc(struct irq_desc *desc) 158 { 159 desc->handle_irq(desc); 160 } 161 162 int generic_handle_irq(unsigned int irq); 163 164 #ifdef CONFIG_HANDLE_DOMAIN_IRQ 165 /* 166 * Convert a HW interrupt number to a logical one using a IRQ domain, 167 * and handle the result interrupt number. Return -EINVAL if 168 * conversion failed. Providing a NULL domain indicates that the 169 * conversion has already been done. 170 */ 171 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq, 172 bool lookup, struct pt_regs *regs); 173 174 static inline int handle_domain_irq(struct irq_domain *domain, 175 unsigned int hwirq, struct pt_regs *regs) 176 { 177 return __handle_domain_irq(domain, hwirq, true, regs); 178 } 179 #endif 180 181 /* Test to see if a driver has successfully requested an irq */ 182 static inline int irq_desc_has_action(struct irq_desc *desc) 183 { 184 return desc->action != NULL; 185 } 186 187 static inline int irq_has_action(unsigned int irq) 188 { 189 return irq_desc_has_action(irq_to_desc(irq)); 190 } 191 192 /** 193 * irq_set_handler_locked - Set irq handler from a locked region 194 * @data: Pointer to the irq_data structure which identifies the irq 195 * @handler: Flow control handler function for this interrupt 196 * 197 * Sets the handler in the irq descriptor associated to @data. 198 * 199 * Must be called with irq_desc locked and valid parameters. Typical 200 * call site is the irq_set_type() callback. 201 */ 202 static inline void irq_set_handler_locked(struct irq_data *data, 203 irq_flow_handler_t handler) 204 { 205 struct irq_desc *desc = irq_data_to_desc(data); 206 207 desc->handle_irq = handler; 208 } 209 210 /** 211 * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region 212 * @data: Pointer to the irq_data structure for which the chip is set 213 * @chip: Pointer to the new irq chip 214 * @handler: Flow control handler function for this interrupt 215 * @name: Name of the interrupt 216 * 217 * Replace the irq chip at the proper hierarchy level in @data and 218 * sets the handler and name in the associated irq descriptor. 219 * 220 * Must be called with irq_desc locked and valid parameters. 221 */ 222 static inline void 223 irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip, 224 irq_flow_handler_t handler, const char *name) 225 { 226 struct irq_desc *desc = irq_data_to_desc(data); 227 228 desc->handle_irq = handler; 229 desc->name = name; 230 data->chip = chip; 231 } 232 233 static inline bool irq_balancing_disabled(unsigned int irq) 234 { 235 struct irq_desc *desc; 236 237 desc = irq_to_desc(irq); 238 return desc->status_use_accessors & IRQ_NO_BALANCING_MASK; 239 } 240 241 static inline bool irq_is_percpu(unsigned int irq) 242 { 243 struct irq_desc *desc; 244 245 desc = irq_to_desc(irq); 246 return desc->status_use_accessors & IRQ_PER_CPU; 247 } 248 249 static inline bool irq_is_percpu_devid(unsigned int irq) 250 { 251 struct irq_desc *desc; 252 253 desc = irq_to_desc(irq); 254 return desc->status_use_accessors & IRQ_PER_CPU_DEVID; 255 } 256 257 static inline void 258 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class, 259 struct lock_class_key *request_class) 260 { 261 struct irq_desc *desc = irq_to_desc(irq); 262 263 if (desc) { 264 lockdep_set_class(&desc->lock, lock_class); 265 lockdep_set_class(&desc->request_mutex, request_class); 266 } 267 } 268 269 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI 270 static inline void 271 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler) 272 { 273 struct irq_desc *desc; 274 275 desc = irq_to_desc(irq); 276 desc->preflow_handler = handler; 277 } 278 #endif 279 280 #endif 281