xref: /linux-6.15/include/linux/irqdesc.h (revision ef264cf0)
1 #ifndef _LINUX_IRQDESC_H
2 #define _LINUX_IRQDESC_H
3 
4 /*
5  * Core internal functions to deal with irq descriptors
6  *
7  * This include will move to kernel/irq once we cleaned up the tree.
8  * For now it's included from <linux/irq.h>
9  */
10 
11 struct irq_affinity_notify;
12 struct proc_dir_entry;
13 struct module;
14 struct irq_desc;
15 
16 /**
17  * struct irq_desc - interrupt descriptor
18  * @irq_data:		per irq and chip data passed down to chip functions
19  * @kstat_irqs:		irq stats per cpu
20  * @handle_irq:		highlevel irq-events handler
21  * @preflow_handler:	handler called before the flow handler (currently used by sparc)
22  * @action:		the irq action chain
23  * @status:		status information
24  * @core_internal_state__do_not_mess_with_it: core internal status information
25  * @depth:		disable-depth, for nested irq_disable() calls
26  * @wake_depth:		enable depth, for multiple irq_set_irq_wake() callers
27  * @irq_count:		stats field to detect stalled irqs
28  * @last_unhandled:	aging timer for unhandled count
29  * @irqs_unhandled:	stats field for spurious unhandled interrupts
30  * @threads_handled:	stats field for deferred spurious detection of threaded handlers
31  * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
32  * @lock:		locking for SMP
33  * @affinity_hint:	hint to user space for preferred irq affinity
34  * @affinity_notify:	context for notification of affinity changes
35  * @pending_mask:	pending rebalanced interrupts
36  * @threads_oneshot:	bitfield to handle shared oneshot threads
37  * @threads_active:	number of irqaction threads currently running
38  * @wait_for_threads:	wait queue for sync_irq to wait for threaded handlers
39  * @dir:		/proc/irq/ procfs entry
40  * @name:		flow handler name for /proc/interrupts output
41  */
42 struct irq_desc {
43 	struct irq_data		irq_data;
44 	unsigned int __percpu	*kstat_irqs;
45 	irq_flow_handler_t	handle_irq;
46 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
47 	irq_preflow_handler_t	preflow_handler;
48 #endif
49 	struct irqaction	*action;	/* IRQ action list */
50 	unsigned int		status_use_accessors;
51 	unsigned int		core_internal_state__do_not_mess_with_it;
52 	unsigned int		depth;		/* nested irq disables */
53 	unsigned int		wake_depth;	/* nested wake enables */
54 	unsigned int		irq_count;	/* For detecting broken IRQs */
55 	unsigned long		last_unhandled;	/* Aging timer for unhandled count */
56 	unsigned int		irqs_unhandled;
57 	atomic_t		threads_handled;
58 	int			threads_handled_last;
59 	raw_spinlock_t		lock;
60 	struct cpumask		*percpu_enabled;
61 #ifdef CONFIG_SMP
62 	const struct cpumask	*affinity_hint;
63 	struct irq_affinity_notify *affinity_notify;
64 #ifdef CONFIG_GENERIC_PENDING_IRQ
65 	cpumask_var_t		pending_mask;
66 #endif
67 #endif
68 	unsigned long		threads_oneshot;
69 	atomic_t		threads_active;
70 	wait_queue_head_t       wait_for_threads;
71 #ifdef CONFIG_PROC_FS
72 	struct proc_dir_entry	*dir;
73 #endif
74 	int			parent_irq;
75 	struct module		*owner;
76 	const char		*name;
77 } ____cacheline_internodealigned_in_smp;
78 
79 #ifndef CONFIG_SPARSE_IRQ
80 extern struct irq_desc irq_desc[NR_IRQS];
81 #endif
82 
83 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
84 {
85 	return &desc->irq_data;
86 }
87 
88 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
89 {
90 	return desc->irq_data.chip;
91 }
92 
93 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
94 {
95 	return desc->irq_data.chip_data;
96 }
97 
98 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
99 {
100 	return desc->irq_data.handler_data;
101 }
102 
103 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
104 {
105 	return desc->irq_data.msi_desc;
106 }
107 
108 /*
109  * Architectures call this to let the generic IRQ layer
110  * handle an interrupt. If the descriptor is attached to an
111  * irqchip-style controller then we call the ->handle_irq() handler,
112  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
113  */
114 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
115 {
116 	desc->handle_irq(irq, desc);
117 }
118 
119 int generic_handle_irq(unsigned int irq);
120 
121 /* Test to see if a driver has successfully requested an irq */
122 static inline int irq_has_action(unsigned int irq)
123 {
124 	struct irq_desc *desc = irq_to_desc(irq);
125 	return desc->action != NULL;
126 }
127 
128 /* caller has locked the irq_desc and both params are valid */
129 static inline void __irq_set_handler_locked(unsigned int irq,
130 					    irq_flow_handler_t handler)
131 {
132 	struct irq_desc *desc;
133 
134 	desc = irq_to_desc(irq);
135 	desc->handle_irq = handler;
136 }
137 
138 /* caller has locked the irq_desc and both params are valid */
139 static inline void
140 __irq_set_chip_handler_name_locked(unsigned int irq, struct irq_chip *chip,
141 				   irq_flow_handler_t handler, const char *name)
142 {
143 	struct irq_desc *desc;
144 
145 	desc = irq_to_desc(irq);
146 	irq_desc_get_irq_data(desc)->chip = chip;
147 	desc->handle_irq = handler;
148 	desc->name = name;
149 }
150 
151 static inline int irq_balancing_disabled(unsigned int irq)
152 {
153 	struct irq_desc *desc;
154 
155 	desc = irq_to_desc(irq);
156 	return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
157 }
158 
159 static inline int irq_is_percpu(unsigned int irq)
160 {
161 	struct irq_desc *desc;
162 
163 	desc = irq_to_desc(irq);
164 	return desc->status_use_accessors & IRQ_PER_CPU;
165 }
166 
167 static inline void
168 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
169 {
170 	struct irq_desc *desc = irq_to_desc(irq);
171 
172 	if (desc)
173 		lockdep_set_class(&desc->lock, class);
174 }
175 
176 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
177 static inline void
178 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
179 {
180 	struct irq_desc *desc;
181 
182 	desc = irq_to_desc(irq);
183 	desc->preflow_handler = handler;
184 }
185 #endif
186 
187 #endif
188