blob: 875c41b23f2031d6d8e9bd21b682397097b26ad4 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Thomas Gleixnere1447102010-10-01 16:03:45 +02002#ifndef _LINUX_IRQDESC_H
3#define _LINUX_IRQDESC_H
4
Thomas Gleixner425a50722015-12-13 18:02:22 +01005#include <linux/rcupdate.h>
Craig Gallekecb3f392016-09-13 12:14:51 -04006#include <linux/kobject.h>
Thomas Gleixner91140142017-06-29 23:33:37 +02007#include <linux/mutex.h>
Thomas Gleixner425a50722015-12-13 18:02:22 +01008
Thomas Gleixnere1447102010-10-01 16:03:45 +02009/*
10 * Core internal functions to deal with irq descriptors
Thomas Gleixnere1447102010-10-01 16:03:45 +020011 */
12
Ben Hutchingscd7eab42011-01-19 21:01:44 +000013struct irq_affinity_notify;
Thomas Gleixnere1447102010-10-01 16:03:45 +020014struct proc_dir_entry;
Paul Gortmakerec53cf22011-09-19 20:33:19 -040015struct module;
Thomas Gleixner293a7a02012-10-16 15:07:49 -070016struct irq_desc;
Marc Zyngier76ba59f2014-08-26 11:03:16 +010017struct irq_domain;
18struct pt_regs;
Thomas Gleixner293a7a02012-10-16 15:07:49 -070019
Thomas Gleixnere1447102010-10-01 16:03:45 +020020/**
21 * struct irq_desc - interrupt descriptor
Jiang Liu0d0b4c82015-06-01 16:05:12 +080022 * @irq_common_data: per irq and chip data passed down to chip functions
Thomas Gleixnere1447102010-10-01 16:03:45 +020023 * @kstat_irqs: irq stats per cpu
Geert Uytterhoeven77076772011-04-10 11:01:52 +020024 * @handle_irq: highlevel irq-events handler
25 * @preflow_handler: handler called before the flow handler (currently used by sparc)
Thomas Gleixnere1447102010-10-01 16:03:45 +020026 * @action: the irq action chain
27 * @status: status information
Thomas Gleixnerdbec07b2011-02-07 20:19:55 +010028 * @core_internal_state__do_not_mess_with_it: core internal status information
Thomas Gleixnere1447102010-10-01 16:03:45 +020029 * @depth: disable-depth, for nested irq_disable() calls
Geert Uytterhoeven0911f122011-04-10 11:01:51 +020030 * @wake_depth: enable depth, for multiple irq_set_irq_wake() callers
Thomas Gleixnere1447102010-10-01 16:03:45 +020031 * @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
Thomas Gleixner1e77d0a2013-03-07 14:53:45 +010034 * @threads_handled: stats field for deferred spurious detection of threaded handlers
35 * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
Thomas Gleixnere1447102010-10-01 16:03:45 +020036 * @lock: locking for SMP
Geert Uytterhoeven77076772011-04-10 11:01:52 +020037 * @affinity_hint: hint to user space for preferred irq affinity
Ben Hutchingscd7eab42011-01-19 21:01:44 +000038 * @affinity_notify: context for notification of affinity changes
Thomas Gleixnere1447102010-10-01 16:03:45 +020039 * @pending_mask: pending rebalanced interrupts
Thomas Gleixnerb5faba22011-02-23 23:52:13 +000040 * @threads_oneshot: bitfield to handle shared oneshot threads
Thomas Gleixnere1447102010-10-01 16:03:45 +020041 * @threads_active: number of irqaction threads currently running
42 * @wait_for_threads: wait queue for sync_irq to wait for threaded handlers
Thomas Gleixnercab303b2014-08-28 11:44:31 +020043 * @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
Thomas Gleixner425a50722015-12-13 18:02:22 +010048 * @rcu: rcu head for delayed free
Craig Gallekecb3f392016-09-13 12:14:51 -040049 * @kobj: kobject used to represent this struct in sysfs
Thomas Gleixner91140142017-06-29 23:33:37 +020050 * @request_mutex: mutex to protect request/free before locking desc->lock
Thomas Gleixnere1447102010-10-01 16:03:45 +020051 * @dir: /proc/irq/ procfs entry
Thomas Gleixner087cdfb2017-06-20 01:37:17 +020052 * @debugfs_file: dentry for the debugfs file
Thomas Gleixnere1447102010-10-01 16:03:45 +020053 * @name: flow handler name for /proc/interrupts output
54 */
55struct irq_desc {
Jiang Liu0d0b4c82015-06-01 16:05:12 +080056 struct irq_common_data irq_common_data;
Thomas Gleixnere1447102010-10-01 16:03:45 +020057 struct irq_data irq_data;
Eric Dumazet6c9ae002011-01-13 15:45:38 -080058 unsigned int __percpu *kstat_irqs;
Thomas Gleixnere1447102010-10-01 16:03:45 +020059 irq_flow_handler_t handle_irq;
Thomas Gleixner78129572011-02-10 15:14:20 +010060#ifdef CONFIG_IRQ_PREFLOW_FASTEOI
61 irq_preflow_handler_t preflow_handler;
62#endif
Thomas Gleixnere1447102010-10-01 16:03:45 +020063 struct irqaction *action; /* IRQ action list */
Thomas Gleixnera6967ca2011-02-10 22:01:25 +010064 unsigned int status_use_accessors;
Thomas Gleixnerdbec07b2011-02-07 20:19:55 +010065 unsigned int core_internal_state__do_not_mess_with_it;
Thomas Gleixnere1447102010-10-01 16:03:45 +020066 unsigned int depth; /* nested irq disables */
67 unsigned int wake_depth; /* nested wake enables */
Thomas Gleixner1136b072019-02-08 14:48:03 +010068 unsigned int tot_count;
Thomas Gleixnere1447102010-10-01 16:03:45 +020069 unsigned int irq_count; /* For detecting broken IRQs */
70 unsigned long last_unhandled; /* Aging timer for unhandled count */
71 unsigned int irqs_unhandled;
Thomas Gleixner1e77d0a2013-03-07 14:53:45 +010072 atomic_t threads_handled;
73 int threads_handled_last;
Thomas Gleixnere1447102010-10-01 16:03:45 +020074 raw_spinlock_t lock;
Marc Zyngier31d9d9b2011-09-23 17:03:06 +010075 struct cpumask *percpu_enabled;
Marc Zyngier222df542016-04-11 09:57:52 +010076 const struct cpumask *percpu_affinity;
Thomas Gleixnere1447102010-10-01 16:03:45 +020077#ifdef CONFIG_SMP
78 const struct cpumask *affinity_hint;
Ben Hutchingscd7eab42011-01-19 21:01:44 +000079 struct irq_affinity_notify *affinity_notify;
Thomas Gleixnere1447102010-10-01 16:03:45 +020080#ifdef CONFIG_GENERIC_PENDING_IRQ
81 cpumask_var_t pending_mask;
82#endif
83#endif
Thomas Gleixnerb5faba22011-02-23 23:52:13 +000084 unsigned long threads_oneshot;
Thomas Gleixnere1447102010-10-01 16:03:45 +020085 atomic_t threads_active;
86 wait_queue_head_t wait_for_threads;
Thomas Gleixnercab303b2014-08-28 11:44:31 +020087#ifdef CONFIG_PM_SLEEP
88 unsigned int nr_actions;
89 unsigned int no_suspend_depth;
Rafael J. Wysocki17f48032015-02-27 00:07:55 +010090 unsigned int cond_suspend_depth;
Thomas Gleixnercab303b2014-08-28 11:44:31 +020091 unsigned int force_resume_depth;
92#endif
Thomas Gleixnere1447102010-10-01 16:03:45 +020093#ifdef CONFIG_PROC_FS
94 struct proc_dir_entry *dir;
95#endif
Thomas Gleixner087cdfb2017-06-20 01:37:17 +020096#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
97 struct dentry *debugfs_file;
Thomas Gleixner07557cc2017-09-13 23:29:05 +020098 const char *dev_name;
Thomas Gleixner087cdfb2017-06-20 01:37:17 +020099#endif
Thomas Gleixner425a50722015-12-13 18:02:22 +0100100#ifdef CONFIG_SPARSE_IRQ
101 struct rcu_head rcu;
Craig Gallekecb3f392016-09-13 12:14:51 -0400102 struct kobject kobj;
Thomas Gleixner425a50722015-12-13 18:02:22 +0100103#endif
Thomas Gleixner91140142017-06-29 23:33:37 +0200104 struct mutex request_mutex;
Thomas Gleixner293a7a02012-10-16 15:07:49 -0700105 int parent_irq;
Sebastian Andrzej Siewiorb6873802011-07-11 12:17:31 +0200106 struct module *owner;
Thomas Gleixnere1447102010-10-01 16:03:45 +0200107 const char *name;
108} ____cacheline_internodealigned_in_smp;
109
Thomas Gleixnera8994182015-07-05 17:12:30 +0000110#ifdef CONFIG_SPARSE_IRQ
111extern void irq_lock_sparse(void);
112extern void irq_unlock_sparse(void);
113#else
114static inline void irq_lock_sparse(void) { }
115static inline void irq_unlock_sparse(void) { }
Thomas Gleixnere1447102010-10-01 16:03:45 +0200116extern struct irq_desc irq_desc[NR_IRQS];
117#endif
118
Jiang Liu7bbf1dd2015-06-01 16:05:10 +0800119static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
120{
Thomas Gleixner755d1192015-09-16 14:37:12 +0200121 return container_of(data->common, struct irq_desc, irq_common_data);
Jiang Liu7bbf1dd2015-06-01 16:05:10 +0800122}
123
Jiang Liu304adf82015-06-04 12:13:26 +0800124static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
125{
126 return desc->irq_data.irq;
127}
128
Thomas Gleixnerd9936bb2011-03-11 14:15:35 +0100129static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
130{
131 return &desc->irq_data;
132}
133
Thomas Gleixnera0cd9ca2011-02-10 11:36:33 +0100134static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
135{
136 return desc->irq_data.chip;
137}
138
139static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
140{
141 return desc->irq_data.chip_data;
142}
143
144static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
145{
Jiang Liuaf7080e2015-06-01 16:05:21 +0800146 return desc->irq_common_data.handler_data;
Thomas Gleixnera0cd9ca2011-02-10 11:36:33 +0100147}
148
Thomas Gleixnere1447102010-10-01 16:03:45 +0200149/*
Thomas Gleixnere1447102010-10-01 16:03:45 +0200150 * Architectures call this to let the generic IRQ layer
Huang Shijie6584d842015-09-01 10:35:50 +0800151 * handle an interrupt.
Thomas Gleixnere1447102010-10-01 16:03:45 +0200152 */
Thomas Gleixnerbd0b9ac2015-09-14 10:42:37 +0200153static inline void generic_handle_irq_desc(struct irq_desc *desc)
Thomas Gleixnere1447102010-10-01 16:03:45 +0200154{
Thomas Gleixnerbd0b9ac2015-09-14 10:42:37 +0200155 desc->handle_irq(desc);
Thomas Gleixnere1447102010-10-01 16:03:45 +0200156}
157
Thomas Gleixnerfe12bc22011-05-18 12:48:00 +0200158int generic_handle_irq(unsigned int irq);
Thomas Gleixnere1447102010-10-01 16:03:45 +0200159
Marc Zyngier76ba59f2014-08-26 11:03:16 +0100160#ifdef CONFIG_HANDLE_DOMAIN_IRQ
161/*
162 * Convert a HW interrupt number to a logical one using a IRQ domain,
163 * and handle the result interrupt number. Return -EINVAL if
164 * conversion failed. Providing a NULL domain indicates that the
165 * conversion has already been done.
166 */
167int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
168 bool lookup, struct pt_regs *regs);
169
170static inline int handle_domain_irq(struct irq_domain *domain,
171 unsigned int hwirq, struct pt_regs *regs)
172{
173 return __handle_domain_irq(domain, hwirq, true, regs);
174}
175#endif
176
Thomas Gleixnere1447102010-10-01 16:03:45 +0200177/* Test to see if a driver has successfully requested an irq */
Thomas Gleixnerf61ae4f2015-08-02 20:38:26 +0000178static inline int irq_desc_has_action(struct irq_desc *desc)
179{
180 return desc->action != NULL;
181}
182
Thomas Gleixnere1447102010-10-01 16:03:45 +0200183static inline int irq_has_action(unsigned int irq)
184{
Thomas Gleixnerf61ae4f2015-08-02 20:38:26 +0000185 return irq_desc_has_action(irq_to_desc(irq));
Thomas Gleixnere1447102010-10-01 16:03:45 +0200186}
187
Thomas Gleixnerbbc9d212015-06-23 15:01:30 +0200188/**
189 * irq_set_handler_locked - Set irq handler from a locked region
190 * @data: Pointer to the irq_data structure which identifies the irq
191 * @handler: Flow control handler function for this interrupt
192 *
193 * Sets the handler in the irq descriptor associated to @data.
194 *
195 * Must be called with irq_desc locked and valid parameters. Typical
196 * call site is the irq_set_type() callback.
197 */
198static inline void irq_set_handler_locked(struct irq_data *data,
199 irq_flow_handler_t handler)
200{
201 struct irq_desc *desc = irq_data_to_desc(data);
202
203 desc->handle_irq = handler;
204}
205
206/**
207 * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
208 * @data: Pointer to the irq_data structure for which the chip is set
209 * @chip: Pointer to the new irq chip
210 * @handler: Flow control handler function for this interrupt
211 * @name: Name of the interrupt
212 *
213 * Replace the irq chip at the proper hierarchy level in @data and
214 * sets the handler and name in the associated irq descriptor.
215 *
216 * Must be called with irq_desc locked and valid parameters.
217 */
218static inline void
219irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip,
220 irq_flow_handler_t handler, const char *name)
221{
222 struct irq_desc *desc = irq_data_to_desc(data);
223
224 desc->handle_irq = handler;
225 desc->name = name;
226 data->chip = chip;
227}
228
Will Deacon4ce413d2017-12-01 15:29:39 +0000229static inline bool irq_balancing_disabled(unsigned int irq)
Thomas Gleixnere1447102010-10-01 16:03:45 +0200230{
231 struct irq_desc *desc;
232
233 desc = irq_to_desc(irq);
Thomas Gleixner0c6f8a82011-03-28 13:32:20 +0200234 return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
Thomas Gleixnere1447102010-10-01 16:03:45 +0200235}
Thomas Gleixnere1447102010-10-01 16:03:45 +0200236
Will Deacon4ce413d2017-12-01 15:29:39 +0000237static inline bool irq_is_percpu(unsigned int irq)
Vinayak Kale7f4a8e72013-12-04 10:09:50 +0000238{
239 struct irq_desc *desc;
240
241 desc = irq_to_desc(irq);
242 return desc->status_use_accessors & IRQ_PER_CPU;
243}
244
Will Deacon4ce413d2017-12-01 15:29:39 +0000245static inline bool irq_is_percpu_devid(unsigned int irq)
Julien Thierry08395c72017-10-13 12:26:44 +0100246{
247 struct irq_desc *desc;
248
249 desc = irq_to_desc(irq);
250 return desc->status_use_accessors & IRQ_PER_CPU_DEVID;
251}
252
Thomas Gleixnerd3e17de2011-03-22 17:08:15 +0100253static inline void
Andrew Lunn39c3fd52017-12-02 18:11:04 +0100254irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class,
255 struct lock_class_key *request_class)
Thomas Gleixnerd3e17de2011-03-22 17:08:15 +0100256{
257 struct irq_desc *desc = irq_to_desc(irq);
258
Andrew Lunn39c3fd52017-12-02 18:11:04 +0100259 if (desc) {
260 lockdep_set_class(&desc->lock, lock_class);
261 lockdep_set_class(&desc->request_mutex, request_class);
262 }
Thomas Gleixnerd3e17de2011-03-22 17:08:15 +0100263}
264
Thomas Gleixner78129572011-02-10 15:14:20 +0100265#ifdef CONFIG_IRQ_PREFLOW_FASTEOI
266static inline void
267__irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
268{
269 struct irq_desc *desc;
270
271 desc = irq_to_desc(irq);
272 desc->preflow_handler = handler;
273}
274#endif
Thomas Gleixnere1447102010-10-01 16:03:45 +0200275
276#endif