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