xref: /linux-6.15/include/linux/irq.h (revision 1795cf48)
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 (*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 #define IRQ_SPURIOUS_DISABLED	0x00800000	/* IRQ was disabled by the spurious trap */
65 
66 #ifdef CONFIG_IRQ_PER_CPU
67 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
68 # define IRQ_NO_BALANCING_MASK	(IRQ_PER_CPU | IRQ_NO_BALANCING)
69 #else
70 # define CHECK_IRQ_PER_CPU(var) 0
71 # define IRQ_NO_BALANCING_MASK	IRQ_NO_BALANCING
72 #endif
73 
74 struct proc_dir_entry;
75 struct msi_desc;
76 
77 /**
78  * struct irq_chip - hardware interrupt chip descriptor
79  *
80  * @name:		name for /proc/interrupts
81  * @startup:		start up the interrupt (defaults to ->enable if NULL)
82  * @shutdown:		shut down the interrupt (defaults to ->disable if NULL)
83  * @enable:		enable the interrupt (defaults to chip->unmask if NULL)
84  * @disable:		disable the interrupt (defaults to chip->mask if NULL)
85  * @ack:		start of a new interrupt
86  * @mask:		mask an interrupt source
87  * @mask_ack:		ack and mask an interrupt source
88  * @unmask:		unmask an interrupt source
89  * @eoi:		end of interrupt - chip level
90  * @end:		end of interrupt - flow level
91  * @set_affinity:	set the CPU affinity on SMP machines
92  * @retrigger:		resend an IRQ to the CPU
93  * @set_type:		set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
94  * @set_wake:		enable/disable power-management wake-on of an IRQ
95  *
96  * @release:		release function solely used by UML
97  * @typename:		obsoleted by name, kept as migration helper
98  */
99 struct irq_chip {
100 	const char	*name;
101 	unsigned int	(*startup)(unsigned int irq);
102 	void		(*shutdown)(unsigned int irq);
103 	void		(*enable)(unsigned int irq);
104 	void		(*disable)(unsigned int irq);
105 
106 	void		(*ack)(unsigned int irq);
107 	void		(*mask)(unsigned int irq);
108 	void		(*mask_ack)(unsigned int irq);
109 	void		(*unmask)(unsigned int irq);
110 	void		(*eoi)(unsigned int irq);
111 
112 	void		(*end)(unsigned int irq);
113 	void		(*set_affinity)(unsigned int irq, cpumask_t dest);
114 	int		(*retrigger)(unsigned int irq);
115 	int		(*set_type)(unsigned int irq, unsigned int flow_type);
116 	int		(*set_wake)(unsigned int irq, unsigned int on);
117 
118 	/* Currently used only by UML, might disappear one day.*/
119 #ifdef CONFIG_IRQ_RELEASE_METHOD
120 	void		(*release)(unsigned int irq, void *dev_id);
121 #endif
122 	/*
123 	 * For compatibility, ->typename is copied into ->name.
124 	 * Will disappear.
125 	 */
126 	const char	*typename;
127 };
128 
129 /**
130  * struct irq_desc - interrupt descriptor
131  *
132  * @handle_irq:		highlevel irq-events handler [if NULL, __do_IRQ()]
133  * @chip:		low level interrupt hardware access
134  * @msi_desc:		MSI descriptor
135  * @handler_data:	per-IRQ data for the irq_chip methods
136  * @chip_data:		platform-specific per-chip private data for the chip
137  *			methods, to allow shared chip implementations
138  * @action:		the irq action chain
139  * @status:		status information
140  * @depth:		disable-depth, for nested irq_disable() calls
141  * @wake_depth:		enable depth, for multiple set_irq_wake() callers
142  * @irq_count:		stats field to detect stalled irqs
143  * @irqs_unhandled:	stats field for spurious unhandled interrupts
144  * @last_unhandled:	aging timer for unhandled count
145  * @lock:		locking for SMP
146  * @affinity:		IRQ affinity on SMP
147  * @cpu:		cpu index useful for balancing
148  * @pending_mask:	pending rebalanced interrupts
149  * @dir:		/proc/irq/ procfs entry
150  * @affinity_entry:	/proc/irq/smp_affinity procfs entry on SMP
151  * @name:		flow handler name for /proc/interrupts output
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 	unsigned long		last_unhandled;	/* Aging timer for unhandled count */
167 	spinlock_t		lock;
168 #ifdef CONFIG_SMP
169 	cpumask_t		affinity;
170 	unsigned int		cpu;
171 #endif
172 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
173 	cpumask_t		pending_mask;
174 #endif
175 #ifdef CONFIG_PROC_FS
176 	struct proc_dir_entry	*dir;
177 #endif
178 	const char		*name;
179 } ____cacheline_internodealigned_in_smp;
180 
181 extern struct irq_desc irq_desc[NR_IRQS];
182 
183 /*
184  * Migration helpers for obsolete names, they will go away:
185  */
186 #define hw_interrupt_type	irq_chip
187 typedef struct irq_chip		hw_irq_controller;
188 #define no_irq_type		no_irq_chip
189 typedef struct irq_desc		irq_desc_t;
190 
191 /*
192  * Pick up the arch-dependent methods:
193  */
194 #include <asm/hw_irq.h>
195 
196 extern int setup_irq(unsigned int irq, struct irqaction *new);
197 
198 #ifdef CONFIG_GENERIC_HARDIRQS
199 
200 #ifndef handle_dynamic_tick
201 # define handle_dynamic_tick(a)		do { } while (0)
202 #endif
203 
204 #ifdef CONFIG_SMP
205 
206 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
207 
208 void set_pending_irq(unsigned int irq, cpumask_t mask);
209 void move_native_irq(int irq);
210 void move_masked_irq(int irq);
211 
212 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
213 
214 static inline void move_irq(int irq)
215 {
216 }
217 
218 static inline void move_native_irq(int irq)
219 {
220 }
221 
222 static inline void move_masked_irq(int irq)
223 {
224 }
225 
226 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
227 {
228 }
229 
230 #endif /* CONFIG_GENERIC_PENDING_IRQ */
231 
232 #else /* CONFIG_SMP */
233 
234 #define move_native_irq(x)
235 #define move_masked_irq(x)
236 
237 #endif /* CONFIG_SMP */
238 
239 #ifdef CONFIG_IRQBALANCE
240 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
241 #else
242 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
243 {
244 }
245 #endif
246 
247 extern int no_irq_affinity;
248 
249 static inline int irq_balancing_disabled(unsigned int irq)
250 {
251 	return irq_desc[irq].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(unsigned int irq)
282 {
283 	struct irq_desc *desc = irq_desc + irq;
284 
285 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
286 	desc->handle_irq(irq, desc);
287 #else
288 	if (likely(desc->handle_irq))
289 		desc->handle_irq(irq, desc);
290 	else
291 		__do_IRQ(irq);
292 #endif
293 }
294 
295 /* Handling of unhandled and spurious interrupts: */
296 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
297 			   int action_ret);
298 
299 /* Resending of interrupts :*/
300 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
301 
302 /* Enable/disable irq debugging output: */
303 extern int noirqdebug_setup(char *str);
304 
305 /* Checks whether the interrupt can be requested by request_irq(): */
306 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
307 
308 /* Dummy irq-chip implementations: */
309 extern struct irq_chip no_irq_chip;
310 extern struct irq_chip dummy_irq_chip;
311 
312 extern void
313 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
314 			 irq_flow_handler_t handle);
315 extern void
316 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
317 			      irq_flow_handler_t handle, const char *name);
318 
319 extern void
320 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
321 		  const char *name);
322 
323 /* caller has locked the irq_desc and both params are valid */
324 static inline void __set_irq_handler_unlocked(int irq,
325 					      irq_flow_handler_t handler)
326 {
327 	irq_desc[irq].handle_irq = handler;
328 }
329 
330 /*
331  * Set a highlevel flow handler for a given IRQ:
332  */
333 static inline void
334 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
335 {
336 	__set_irq_handler(irq, handle, 0, NULL);
337 }
338 
339 /*
340  * Set a highlevel chained flow handler for a given IRQ.
341  * (a chained handler is automatically enabled and set to
342  *  IRQ_NOREQUEST and IRQ_NOPROBE)
343  */
344 static inline void
345 set_irq_chained_handler(unsigned int irq,
346 			irq_flow_handler_t handle)
347 {
348 	__set_irq_handler(irq, handle, 1, NULL);
349 }
350 
351 extern void set_irq_noprobe(unsigned int irq);
352 extern void set_irq_probe(unsigned int irq);
353 
354 /* Handle dynamic irq creation and destruction */
355 extern int create_irq(void);
356 extern void destroy_irq(unsigned int irq);
357 
358 /* Test to see if a driver has successfully requested an irq */
359 static inline int irq_has_action(unsigned int irq)
360 {
361 	struct irq_desc *desc = irq_desc + irq;
362 	return desc->action != NULL;
363 }
364 
365 /* Dynamic irq helper functions */
366 extern void dynamic_irq_init(unsigned int irq);
367 extern void dynamic_irq_cleanup(unsigned int irq);
368 
369 /* Set/get chip/data for an IRQ: */
370 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
371 extern int set_irq_data(unsigned int irq, void *data);
372 extern int set_irq_chip_data(unsigned int irq, void *data);
373 extern int set_irq_type(unsigned int irq, unsigned int type);
374 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
375 
376 #define get_irq_chip(irq)	(irq_desc[irq].chip)
377 #define get_irq_chip_data(irq)	(irq_desc[irq].chip_data)
378 #define get_irq_data(irq)	(irq_desc[irq].handler_data)
379 #define get_irq_msi(irq)	(irq_desc[irq].msi_desc)
380 
381 #endif /* CONFIG_GENERIC_HARDIRQS */
382 
383 #endif /* !CONFIG_S390 */
384 
385 #endif /* _LINUX_IRQ_H */
386