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