genirq: Avoid summation loops for /proc/stat
[muen/linux.git] / include / linux / irqdesc.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_IRQDESC_H
3 #define _LINUX_IRQDESC_H
4
5 #include <linux/rcupdate.h>
6 #include <linux/kobject.h>
7 #include <linux/mutex.h>
8
9 /*
10  * Core internal functions to deal with irq descriptors
11  */
12
13 struct irq_affinity_notify;
14 struct proc_dir_entry;
15 struct module;
16 struct irq_desc;
17 struct irq_domain;
18 struct pt_regs;
19
20 /**
21  * struct irq_desc - interrupt descriptor
22  * @irq_common_data:    per irq and chip data passed down to chip functions
23  * @kstat_irqs:         irq stats per cpu
24  * @handle_irq:         highlevel irq-events handler
25  * @preflow_handler:    handler called before the flow handler (currently used by sparc)
26  * @action:             the irq action chain
27  * @status:             status information
28  * @core_internal_state__do_not_mess_with_it: core internal status information
29  * @depth:              disable-depth, for nested irq_disable() calls
30  * @wake_depth:         enable depth, for multiple irq_set_irq_wake() callers
31  * @irq_count:          stats field to detect stalled irqs
32  * @last_unhandled:     aging timer for unhandled count
33  * @irqs_unhandled:     stats field for spurious unhandled interrupts
34  * @threads_handled:    stats field for deferred spurious detection of threaded handlers
35  * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
36  * @lock:               locking for SMP
37  * @affinity_hint:      hint to user space for preferred irq affinity
38  * @affinity_notify:    context for notification of affinity changes
39  * @pending_mask:       pending rebalanced interrupts
40  * @threads_oneshot:    bitfield to handle shared oneshot threads
41  * @threads_active:     number of irqaction threads currently running
42  * @wait_for_threads:   wait queue for sync_irq to wait for threaded handlers
43  * @nr_actions:         number of installed actions on this descriptor
44  * @no_suspend_depth:   number of irqactions on a irq descriptor with
45  *                      IRQF_NO_SUSPEND set
46  * @force_resume_depth: number of irqactions on a irq descriptor with
47  *                      IRQF_FORCE_RESUME set
48  * @rcu:                rcu head for delayed free
49  * @kobj:               kobject used to represent this struct in sysfs
50  * @request_mutex:      mutex to protect request/free before locking desc->lock
51  * @dir:                /proc/irq/ procfs entry
52  * @debugfs_file:       dentry for the debugfs file
53  * @name:               flow handler name for /proc/interrupts output
54  */
55 struct irq_desc {
56         struct irq_common_data  irq_common_data;
57         struct irq_data         irq_data;
58         unsigned int __percpu   *kstat_irqs;
59         irq_flow_handler_t      handle_irq;
60 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
61         irq_preflow_handler_t   preflow_handler;
62 #endif
63         struct irqaction        *action;        /* IRQ action list */
64         unsigned int            status_use_accessors;
65         unsigned int            core_internal_state__do_not_mess_with_it;
66         unsigned int            depth;          /* nested irq disables */
67         unsigned int            wake_depth;     /* nested wake enables */
68         unsigned int            tot_count;
69         unsigned int            irq_count;      /* For detecting broken IRQs */
70         unsigned long           last_unhandled; /* Aging timer for unhandled count */
71         unsigned int            irqs_unhandled;
72         atomic_t                threads_handled;
73         int                     threads_handled_last;
74         raw_spinlock_t          lock;
75         struct cpumask          *percpu_enabled;
76         const struct cpumask    *percpu_affinity;
77 #ifdef CONFIG_SMP
78         const struct cpumask    *affinity_hint;
79         struct irq_affinity_notify *affinity_notify;
80 #ifdef CONFIG_GENERIC_PENDING_IRQ
81         cpumask_var_t           pending_mask;
82 #endif
83 #endif
84         unsigned long           threads_oneshot;
85         atomic_t                threads_active;
86         wait_queue_head_t       wait_for_threads;
87 #ifdef CONFIG_PM_SLEEP
88         unsigned int            nr_actions;
89         unsigned int            no_suspend_depth;
90         unsigned int            cond_suspend_depth;
91         unsigned int            force_resume_depth;
92 #endif
93 #ifdef CONFIG_PROC_FS
94         struct proc_dir_entry   *dir;
95 #endif
96 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
97         struct dentry           *debugfs_file;
98         const char              *dev_name;
99 #endif
100 #ifdef CONFIG_SPARSE_IRQ
101         struct rcu_head         rcu;
102         struct kobject          kobj;
103 #endif
104         struct mutex            request_mutex;
105         int                     parent_irq;
106         struct module           *owner;
107         const char              *name;
108 } ____cacheline_internodealigned_in_smp;
109
110 #ifdef CONFIG_SPARSE_IRQ
111 extern void irq_lock_sparse(void);
112 extern void irq_unlock_sparse(void);
113 #else
114 static inline void irq_lock_sparse(void) { }
115 static inline void irq_unlock_sparse(void) { }
116 extern struct irq_desc irq_desc[NR_IRQS];
117 #endif
118
119 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
120 {
121         return container_of(data->common, struct irq_desc, irq_common_data);
122 }
123
124 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
125 {
126         return desc->irq_data.irq;
127 }
128
129 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
130 {
131         return &desc->irq_data;
132 }
133
134 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
135 {
136         return desc->irq_data.chip;
137 }
138
139 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
140 {
141         return desc->irq_data.chip_data;
142 }
143
144 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
145 {
146         return desc->irq_common_data.handler_data;
147 }
148
149 /*
150  * Architectures call this to let the generic IRQ layer
151  * handle an interrupt.
152  */
153 static inline void generic_handle_irq_desc(struct irq_desc *desc)
154 {
155         desc->handle_irq(desc);
156 }
157
158 int generic_handle_irq(unsigned int irq);
159
160 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
161 /*
162  * Convert a HW interrupt number to a logical one using a IRQ domain,
163  * and handle the result interrupt number. Return -EINVAL if
164  * conversion failed. Providing a NULL domain indicates that the
165  * conversion has already been done.
166  */
167 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
168                         bool lookup, struct pt_regs *regs);
169
170 static inline int handle_domain_irq(struct irq_domain *domain,
171                                     unsigned int hwirq, struct pt_regs *regs)
172 {
173         return __handle_domain_irq(domain, hwirq, true, regs);
174 }
175 #endif
176
177 /* Test to see if a driver has successfully requested an irq */
178 static inline int irq_desc_has_action(struct irq_desc *desc)
179 {
180         return desc->action != NULL;
181 }
182
183 static inline int irq_has_action(unsigned int irq)
184 {
185         return irq_desc_has_action(irq_to_desc(irq));
186 }
187
188 /**
189  * irq_set_handler_locked - Set irq handler from a locked region
190  * @data:       Pointer to the irq_data structure which identifies the irq
191  * @handler:    Flow control handler function for this interrupt
192  *
193  * Sets the handler in the irq descriptor associated to @data.
194  *
195  * Must be called with irq_desc locked and valid parameters. Typical
196  * call site is the irq_set_type() callback.
197  */
198 static inline void irq_set_handler_locked(struct irq_data *data,
199                                           irq_flow_handler_t handler)
200 {
201         struct irq_desc *desc = irq_data_to_desc(data);
202
203         desc->handle_irq = handler;
204 }
205
206 /**
207  * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
208  * @data:       Pointer to the irq_data structure for which the chip is set
209  * @chip:       Pointer to the new irq chip
210  * @handler:    Flow control handler function for this interrupt
211  * @name:       Name of the interrupt
212  *
213  * Replace the irq chip at the proper hierarchy level in @data and
214  * sets the handler and name in the associated irq descriptor.
215  *
216  * Must be called with irq_desc locked and valid parameters.
217  */
218 static inline void
219 irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip,
220                                  irq_flow_handler_t handler, const char *name)
221 {
222         struct irq_desc *desc = irq_data_to_desc(data);
223
224         desc->handle_irq = handler;
225         desc->name = name;
226         data->chip = chip;
227 }
228
229 static inline bool irq_balancing_disabled(unsigned int irq)
230 {
231         struct irq_desc *desc;
232
233         desc = irq_to_desc(irq);
234         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
235 }
236
237 static inline bool irq_is_percpu(unsigned int irq)
238 {
239         struct irq_desc *desc;
240
241         desc = irq_to_desc(irq);
242         return desc->status_use_accessors & IRQ_PER_CPU;
243 }
244
245 static inline bool irq_is_percpu_devid(unsigned int irq)
246 {
247         struct irq_desc *desc;
248
249         desc = irq_to_desc(irq);
250         return desc->status_use_accessors & IRQ_PER_CPU_DEVID;
251 }
252
253 static inline void
254 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class,
255                       struct lock_class_key *request_class)
256 {
257         struct irq_desc *desc = irq_to_desc(irq);
258
259         if (desc) {
260                 lockdep_set_class(&desc->lock, lock_class);
261                 lockdep_set_class(&desc->request_mutex, request_class);
262         }
263 }
264
265 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
266 static inline void
267 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
268 {
269         struct irq_desc *desc;
270
271         desc = irq_to_desc(irq);
272         desc->preflow_handler = handler;
273 }
274 #endif
275
276 #endif