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 struct irq_domain;
16 struct pt_regs;
17 
18 /**
19  * struct irq_desc - interrupt descriptor
20  * @irq_data:		per irq and chip data passed down to chip functions
21  * @kstat_irqs:		irq stats per cpu
22  * @handle_irq:		highlevel irq-events handler
23  * @preflow_handler:	handler called before the flow handler (currently used by sparc)
24  * @action:		the irq action chain
25  * @status:		status information
26  * @core_internal_state__do_not_mess_with_it: core internal status information
27  * @depth:		disable-depth, for nested irq_disable() calls
28  * @wake_depth:		enable depth, for multiple irq_set_irq_wake() callers
29  * @irq_count:		stats field to detect stalled irqs
30  * @last_unhandled:	aging timer for unhandled count
31  * @irqs_unhandled:	stats field for spurious unhandled interrupts
32  * @threads_handled:	stats field for deferred spurious detection of threaded handlers
33  * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
34  * @lock:		locking for SMP
35  * @affinity_hint:	hint to user space for preferred irq affinity
36  * @affinity_notify:	context for notification of affinity changes
37  * @pending_mask:	pending rebalanced interrupts
38  * @threads_oneshot:	bitfield to handle shared oneshot threads
39  * @threads_active:	number of irqaction threads currently running
40  * @wait_for_threads:	wait queue for sync_irq to wait for threaded handlers
41  * @nr_actions:		number of installed actions on this descriptor
42  * @no_suspend_depth:	number of irqactions on a irq descriptor with
43  *			IRQF_NO_SUSPEND set
44  * @force_resume_depth:	number of irqactions on a irq descriptor with
45  *			IRQF_FORCE_RESUME set
46  * @dir:		/proc/irq/ procfs entry
47  * @name:		flow handler name for /proc/interrupts output
48  */
49 struct irq_desc {
50 	struct irq_data		irq_data;
51 	unsigned int __percpu	*kstat_irqs;
52 	irq_flow_handler_t	handle_irq;
53 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
54 	irq_preflow_handler_t	preflow_handler;
55 #endif
56 	struct irqaction	*action;	/* IRQ action list */
57 	unsigned int		status_use_accessors;
58 	unsigned int		core_internal_state__do_not_mess_with_it;
59 	unsigned int		depth;		/* nested irq disables */
60 	unsigned int		wake_depth;	/* nested wake enables */
61 	unsigned int		irq_count;	/* For detecting broken IRQs */
62 	unsigned long		last_unhandled;	/* Aging timer for unhandled count */
63 	unsigned int		irqs_unhandled;
64 	atomic_t		threads_handled;
65 	int			threads_handled_last;
66 	raw_spinlock_t		lock;
67 	struct cpumask		*percpu_enabled;
68 #ifdef CONFIG_SMP
69 	const struct cpumask	*affinity_hint;
70 	struct irq_affinity_notify *affinity_notify;
71 #ifdef CONFIG_GENERIC_PENDING_IRQ
72 	cpumask_var_t		pending_mask;
73 #endif
74 #endif
75 	unsigned long		threads_oneshot;
76 	atomic_t		threads_active;
77 	wait_queue_head_t       wait_for_threads;
78 #ifdef CONFIG_PM_SLEEP
79 	unsigned int		nr_actions;
80 	unsigned int		no_suspend_depth;
81 	unsigned int		cond_suspend_depth;
82 	unsigned int		force_resume_depth;
83 #endif
84 #ifdef CONFIG_PROC_FS
85 	struct proc_dir_entry	*dir;
86 #endif
87 	int			parent_irq;
88 	struct module		*owner;
89 	const char		*name;
90 } ____cacheline_internodealigned_in_smp;
91 
92 #ifndef CONFIG_SPARSE_IRQ
93 extern struct irq_desc irq_desc[NR_IRQS];
94 #endif
95 
irq_desc_get_irq_data(struct irq_desc * desc)96 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
97 {
98 	return &desc->irq_data;
99 }
100 
irq_desc_get_chip(struct irq_desc * desc)101 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
102 {
103 	return desc->irq_data.chip;
104 }
105 
irq_desc_get_chip_data(struct irq_desc * desc)106 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
107 {
108 	return desc->irq_data.chip_data;
109 }
110 
irq_desc_get_handler_data(struct irq_desc * desc)111 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
112 {
113 	return desc->irq_data.handler_data;
114 }
115 
irq_desc_get_msi_desc(struct irq_desc * desc)116 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
117 {
118 	return desc->irq_data.msi_desc;
119 }
120 
121 /*
122  * Architectures call this to let the generic IRQ layer
123  * handle an interrupt. If the descriptor is attached to an
124  * irqchip-style controller then we call the ->handle_irq() handler,
125  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
126  */
generic_handle_irq_desc(unsigned int irq,struct irq_desc * desc)127 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
128 {
129 	desc->handle_irq(irq, desc);
130 }
131 
132 int generic_handle_irq(unsigned int irq);
133 
134 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
135 /*
136  * Convert a HW interrupt number to a logical one using a IRQ domain,
137  * and handle the result interrupt number. Return -EINVAL if
138  * conversion failed. Providing a NULL domain indicates that the
139  * conversion has already been done.
140  */
141 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
142 			bool lookup, struct pt_regs *regs);
143 
handle_domain_irq(struct irq_domain * domain,unsigned int hwirq,struct pt_regs * regs)144 static inline int handle_domain_irq(struct irq_domain *domain,
145 				    unsigned int hwirq, struct pt_regs *regs)
146 {
147 	return __handle_domain_irq(domain, hwirq, true, regs);
148 }
149 #endif
150 
151 /* Test to see if a driver has successfully requested an irq */
irq_has_action(unsigned int irq)152 static inline int irq_has_action(unsigned int irq)
153 {
154 	struct irq_desc *desc = irq_to_desc(irq);
155 	return desc->action != NULL;
156 }
157 
158 /* caller has locked the irq_desc and both params are valid */
__irq_set_handler_locked(unsigned int irq,irq_flow_handler_t handler)159 static inline void __irq_set_handler_locked(unsigned int irq,
160 					    irq_flow_handler_t handler)
161 {
162 	struct irq_desc *desc;
163 
164 	desc = irq_to_desc(irq);
165 	desc->handle_irq = handler;
166 }
167 
168 /* caller has locked the irq_desc and both params are valid */
169 static inline void
__irq_set_chip_handler_name_locked(unsigned int irq,struct irq_chip * chip,irq_flow_handler_t handler,const char * name)170 __irq_set_chip_handler_name_locked(unsigned int irq, struct irq_chip *chip,
171 				   irq_flow_handler_t handler, const char *name)
172 {
173 	struct irq_desc *desc;
174 
175 	desc = irq_to_desc(irq);
176 	irq_desc_get_irq_data(desc)->chip = chip;
177 	desc->handle_irq = handler;
178 	desc->name = name;
179 }
180 
irq_balancing_disabled(unsigned int irq)181 static inline int irq_balancing_disabled(unsigned int irq)
182 {
183 	struct irq_desc *desc;
184 
185 	desc = irq_to_desc(irq);
186 	return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
187 }
188 
irq_is_percpu(unsigned int irq)189 static inline int irq_is_percpu(unsigned int irq)
190 {
191 	struct irq_desc *desc;
192 
193 	desc = irq_to_desc(irq);
194 	return desc->status_use_accessors & IRQ_PER_CPU;
195 }
196 
197 static inline void
irq_set_lockdep_class(unsigned int irq,struct lock_class_key * class)198 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
199 {
200 	struct irq_desc *desc = irq_to_desc(irq);
201 
202 	if (desc)
203 		lockdep_set_class(&desc->lock, class);
204 }
205 
206 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
207 static inline void
__irq_set_preflow_handler(unsigned int irq,irq_preflow_handler_t handler)208 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
209 {
210 	struct irq_desc *desc;
211 
212 	desc = irq_to_desc(irq);
213 	desc->preflow_handler = handler;
214 }
215 #endif
216 
217 #endif
218