xref: /linux-6.15/include/linux/irq.h (revision ba6e8564)
1 #ifndef _LINUX_IRQ_H
2 #define _LINUX_IRQ_H
3 
4 /*
5  * Please do not include this file in generic code.  There is currently
6  * no requirement for any architecture to implement anything held
7  * within this file.
8  *
9  * Thanks. --rmk
10  */
11 
12 #include <linux/smp.h>
13 
14 #ifndef CONFIG_S390
15 
16 #include <linux/linkage.h>
17 #include <linux/cache.h>
18 #include <linux/spinlock.h>
19 #include <linux/cpumask.h>
20 #include <linux/irqreturn.h>
21 #include <linux/errno.h>
22 
23 #include <asm/irq.h>
24 #include <asm/ptrace.h>
25 #include <asm/irq_regs.h>
26 
27 struct irq_desc;
28 typedef	void fastcall (*irq_flow_handler_t)(unsigned int irq,
29 					    struct irq_desc *desc);
30 
31 
32 /*
33  * IRQ line status.
34  *
35  * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
36  *
37  * IRQ types
38  */
39 #define IRQ_TYPE_NONE		0x00000000	/* Default, unspecified type */
40 #define IRQ_TYPE_EDGE_RISING	0x00000001	/* Edge rising type */
41 #define IRQ_TYPE_EDGE_FALLING	0x00000002	/* Edge falling type */
42 #define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
43 #define IRQ_TYPE_LEVEL_HIGH	0x00000004	/* Level high type */
44 #define IRQ_TYPE_LEVEL_LOW	0x00000008	/* Level low type */
45 #define IRQ_TYPE_SENSE_MASK	0x0000000f	/* Mask of the above */
46 #define IRQ_TYPE_PROBE		0x00000010	/* Probing in progress */
47 
48 /* Internal flags */
49 #define IRQ_INPROGRESS		0x00000100	/* IRQ handler active - do not enter! */
50 #define IRQ_DISABLED		0x00000200	/* IRQ disabled - do not enter! */
51 #define IRQ_PENDING		0x00000400	/* IRQ pending - replay on enable */
52 #define IRQ_REPLAY		0x00000800	/* IRQ has been replayed but not acked yet */
53 #define IRQ_AUTODETECT		0x00001000	/* IRQ is being autodetected */
54 #define IRQ_WAITING		0x00002000	/* IRQ not yet seen - for autodetection */
55 #define IRQ_LEVEL		0x00004000	/* IRQ level triggered */
56 #define IRQ_MASKED		0x00008000	/* IRQ masked - shouldn't be seen again */
57 #define IRQ_PER_CPU		0x00010000	/* IRQ is per CPU */
58 #define IRQ_NOPROBE		0x00020000	/* IRQ is not valid for probing */
59 #define IRQ_NOREQUEST		0x00040000	/* IRQ cannot be requested */
60 #define IRQ_NOAUTOEN		0x00080000	/* IRQ will not be enabled on request irq */
61 #define IRQ_WAKEUP		0x00100000	/* IRQ triggers system wakeup */
62 #define IRQ_MOVE_PENDING	0x00200000	/* need to re-target IRQ destination */
63 #define IRQ_NO_BALANCING	0x00400000	/* IRQ is excluded from balancing */
64 
65 #ifdef CONFIG_IRQ_PER_CPU
66 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
67 # define IRQ_NO_BALANCING_MASK	(IRQ_PER_CPU | IRQ_NO_BALANCING)
68 #else
69 # define CHECK_IRQ_PER_CPU(var) 0
70 # define IRQ_NO_BALANCING_MASK	IRQ_NO_BALANCING
71 #endif
72 
73 struct proc_dir_entry;
74 struct msi_desc;
75 
76 /**
77  * struct irq_chip - hardware interrupt chip descriptor
78  *
79  * @name:		name for /proc/interrupts
80  * @startup:		start up the interrupt (defaults to ->enable if NULL)
81  * @shutdown:		shut down the interrupt (defaults to ->disable if NULL)
82  * @enable:		enable the interrupt (defaults to chip->unmask if NULL)
83  * @disable:		disable the interrupt (defaults to chip->mask if NULL)
84  * @ack:		start of a new interrupt
85  * @mask:		mask an interrupt source
86  * @mask_ack:		ack and mask an interrupt source
87  * @unmask:		unmask an interrupt source
88  * @eoi:		end of interrupt - chip level
89  * @end:		end of interrupt - flow level
90  * @set_affinity:	set the CPU affinity on SMP machines
91  * @retrigger:		resend an IRQ to the CPU
92  * @set_type:		set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
93  * @set_wake:		enable/disable power-management wake-on of an IRQ
94  *
95  * @release:		release function solely used by UML
96  * @typename:		obsoleted by name, kept as migration helper
97  */
98 struct irq_chip {
99 	const char	*name;
100 	unsigned int	(*startup)(unsigned int irq);
101 	void		(*shutdown)(unsigned int irq);
102 	void		(*enable)(unsigned int irq);
103 	void		(*disable)(unsigned int irq);
104 
105 	void		(*ack)(unsigned int irq);
106 	void		(*mask)(unsigned int irq);
107 	void		(*mask_ack)(unsigned int irq);
108 	void		(*unmask)(unsigned int irq);
109 	void		(*eoi)(unsigned int irq);
110 
111 	void		(*end)(unsigned int irq);
112 	void		(*set_affinity)(unsigned int irq, cpumask_t dest);
113 	int		(*retrigger)(unsigned int irq);
114 	int		(*set_type)(unsigned int irq, unsigned int flow_type);
115 	int		(*set_wake)(unsigned int irq, unsigned int on);
116 
117 	/* Currently used only by UML, might disappear one day.*/
118 #ifdef CONFIG_IRQ_RELEASE_METHOD
119 	void		(*release)(unsigned int irq, void *dev_id);
120 #endif
121 	/*
122 	 * For compatibility, ->typename is copied into ->name.
123 	 * Will disappear.
124 	 */
125 	const char	*typename;
126 };
127 
128 /**
129  * struct irq_desc - interrupt descriptor
130  *
131  * @handle_irq:		highlevel irq-events handler [if NULL, __do_IRQ()]
132  * @chip:		low level interrupt hardware access
133  * @msi_desc:		MSI descriptor
134  * @handler_data:	per-IRQ data for the irq_chip methods
135  * @chip_data:		platform-specific per-chip private data for the chip
136  *			methods, to allow shared chip implementations
137  * @action:		the irq action chain
138  * @status:		status information
139  * @depth:		disable-depth, for nested irq_disable() calls
140  * @wake_depth:		enable depth, for multiple set_irq_wake() callers
141  * @irq_count:		stats field to detect stalled irqs
142  * @irqs_unhandled:	stats field for spurious unhandled interrupts
143  * @lock:		locking for SMP
144  * @affinity:		IRQ affinity on SMP
145  * @cpu:		cpu index useful for balancing
146  * @pending_mask:	pending rebalanced interrupts
147  * @dir:		/proc/irq/ procfs entry
148  * @affinity_entry:	/proc/irq/smp_affinity procfs entry on SMP
149  * @name:		flow handler name for /proc/interrupts output
150  *
151  * Pad this out to 32 bytes for cache and indexing reasons.
152  */
153 struct irq_desc {
154 	irq_flow_handler_t	handle_irq;
155 	struct irq_chip		*chip;
156 	struct msi_desc		*msi_desc;
157 	void			*handler_data;
158 	void			*chip_data;
159 	struct irqaction	*action;	/* IRQ action list */
160 	unsigned int		status;		/* IRQ status */
161 
162 	unsigned int		depth;		/* nested irq disables */
163 	unsigned int		wake_depth;	/* nested wake enables */
164 	unsigned int		irq_count;	/* For detecting broken IRQs */
165 	unsigned int		irqs_unhandled;
166 	spinlock_t		lock;
167 #ifdef CONFIG_SMP
168 	cpumask_t		affinity;
169 	unsigned int		cpu;
170 #endif
171 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
172 	cpumask_t		pending_mask;
173 #endif
174 #ifdef CONFIG_PROC_FS
175 	struct proc_dir_entry	*dir;
176 #endif
177 	const char		*name;
178 } ____cacheline_aligned;
179 
180 extern struct irq_desc irq_desc[NR_IRQS];
181 
182 /*
183  * Migration helpers for obsolete names, they will go away:
184  */
185 #define hw_interrupt_type	irq_chip
186 typedef struct irq_chip		hw_irq_controller;
187 #define no_irq_type		no_irq_chip
188 typedef struct irq_desc		irq_desc_t;
189 
190 /*
191  * Pick up the arch-dependent methods:
192  */
193 #include <asm/hw_irq.h>
194 
195 extern int setup_irq(unsigned int irq, struct irqaction *new);
196 
197 #ifdef CONFIG_GENERIC_HARDIRQS
198 
199 #ifndef handle_dynamic_tick
200 # define handle_dynamic_tick(a)		do { } while (0)
201 #endif
202 
203 #ifdef CONFIG_SMP
204 
205 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
206 
207 void set_pending_irq(unsigned int irq, cpumask_t mask);
208 void move_native_irq(int irq);
209 void move_masked_irq(int irq);
210 
211 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
212 
213 static inline void move_irq(int irq)
214 {
215 }
216 
217 static inline void move_native_irq(int irq)
218 {
219 }
220 
221 static inline void move_masked_irq(int irq)
222 {
223 }
224 
225 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
226 {
227 }
228 
229 #endif /* CONFIG_GENERIC_PENDING_IRQ */
230 
231 extern int irq_set_affinity(unsigned int irq, cpumask_t cpumask);
232 extern int irq_can_set_affinity(unsigned int irq);
233 
234 #else /* CONFIG_SMP */
235 
236 #define move_native_irq(x)
237 #define move_masked_irq(x)
238 
239 static inline int irq_set_affinity(unsigned int irq, cpumask_t cpumask)
240 {
241 	return -EINVAL;
242 }
243 
244 static inline int irq_can_set_affinity(unsigned int irq) { return 0; }
245 
246 #endif /* CONFIG_SMP */
247 
248 #ifdef CONFIG_IRQBALANCE
249 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
250 #else
251 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
252 {
253 }
254 #endif
255 
256 #ifdef CONFIG_AUTO_IRQ_AFFINITY
257 extern int select_smp_affinity(unsigned int irq);
258 #else
259 static inline int select_smp_affinity(unsigned int irq)
260 {
261 	return 1;
262 }
263 #endif
264 
265 extern int no_irq_affinity;
266 
267 static inline int irq_balancing_disabled(unsigned int irq)
268 {
269 	return irq_desc[irq].status & IRQ_NO_BALANCING_MASK;
270 }
271 
272 /* Handle irq action chains: */
273 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
274 
275 /*
276  * Built-in IRQ handlers for various IRQ types,
277  * callable via desc->chip->handle_irq()
278  */
279 extern void fastcall handle_level_irq(unsigned int irq, struct irq_desc *desc);
280 extern void fastcall handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
281 extern void fastcall handle_edge_irq(unsigned int irq, struct irq_desc *desc);
282 extern void fastcall handle_simple_irq(unsigned int irq, struct irq_desc *desc);
283 extern void fastcall handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
284 extern void fastcall handle_bad_irq(unsigned int irq, struct irq_desc *desc);
285 
286 /*
287  * Monolithic do_IRQ implementation.
288  * (is an explicit fastcall, because i386 4KSTACKS calls it from assembly)
289  */
290 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
291 extern fastcall unsigned int __do_IRQ(unsigned int irq);
292 #endif
293 
294 /*
295  * Architectures call this to let the generic IRQ layer
296  * handle an interrupt. If the descriptor is attached to an
297  * irqchip-style controller then we call the ->handle_irq() handler,
298  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
299  */
300 static inline void generic_handle_irq(unsigned int irq)
301 {
302 	struct irq_desc *desc = irq_desc + irq;
303 
304 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
305 	desc->handle_irq(irq, desc);
306 #else
307 	if (likely(desc->handle_irq))
308 		desc->handle_irq(irq, desc);
309 	else
310 		__do_IRQ(irq);
311 #endif
312 }
313 
314 /* Handling of unhandled and spurious interrupts: */
315 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
316 			   int action_ret);
317 
318 /* Resending of interrupts :*/
319 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
320 
321 /* Enable/disable irq debugging output: */
322 extern int noirqdebug_setup(char *str);
323 
324 /* Checks whether the interrupt can be requested by request_irq(): */
325 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
326 
327 /* Dummy irq-chip implementations: */
328 extern struct irq_chip no_irq_chip;
329 extern struct irq_chip dummy_irq_chip;
330 
331 extern void
332 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
333 			 irq_flow_handler_t handle);
334 extern void
335 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
336 			      irq_flow_handler_t handle, const char *name);
337 
338 extern void
339 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
340 		  const char *name);
341 
342 /*
343  * Set a highlevel flow handler for a given IRQ:
344  */
345 static inline void
346 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
347 {
348 	__set_irq_handler(irq, handle, 0, NULL);
349 }
350 
351 /*
352  * Set a highlevel chained flow handler for a given IRQ.
353  * (a chained handler is automatically enabled and set to
354  *  IRQ_NOREQUEST and IRQ_NOPROBE)
355  */
356 static inline void
357 set_irq_chained_handler(unsigned int irq,
358 			irq_flow_handler_t handle)
359 {
360 	__set_irq_handler(irq, handle, 1, NULL);
361 }
362 
363 /* Handle dynamic irq creation and destruction */
364 extern int create_irq(void);
365 extern void destroy_irq(unsigned int irq);
366 
367 /* Test to see if a driver has successfully requested an irq */
368 static inline int irq_has_action(unsigned int irq)
369 {
370 	struct irq_desc *desc = irq_desc + irq;
371 	return desc->action != NULL;
372 }
373 
374 /* Dynamic irq helper functions */
375 extern void dynamic_irq_init(unsigned int irq);
376 extern void dynamic_irq_cleanup(unsigned int irq);
377 
378 /* Set/get chip/data for an IRQ: */
379 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
380 extern int set_irq_data(unsigned int irq, void *data);
381 extern int set_irq_chip_data(unsigned int irq, void *data);
382 extern int set_irq_type(unsigned int irq, unsigned int type);
383 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
384 
385 #define get_irq_chip(irq)	(irq_desc[irq].chip)
386 #define get_irq_chip_data(irq)	(irq_desc[irq].chip_data)
387 #define get_irq_data(irq)	(irq_desc[irq].handler_data)
388 #define get_irq_msi(irq)	(irq_desc[irq].msi_desc)
389 
390 #endif /* CONFIG_GENERIC_HARDIRQS */
391 
392 #endif /* !CONFIG_S390 */
393 
394 #endif /* _LINUX_IRQ_H */
395