Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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#include <linux/linkage.h>
14#include <linux/cache.h>
15#include <linux/spinlock.h>
16#include <linux/cpumask.h>
17#include <linux/gfp.h>
18#include <linux/irqhandler.h>
19#include <linux/irqreturn.h>
20#include <linux/irqnr.h>
21#include <linux/errno.h>
22#include <linux/topology.h>
23#include <linux/wait.h>
24#include <linux/io.h>
25
26#include <asm/irq.h>
27#include <asm/ptrace.h>
28#include <asm/irq_regs.h>
29
30struct seq_file;
31struct module;
32struct msi_msg;
33enum irqchip_irq_state;
34
35/*
36 * IRQ line status.
37 *
38 * Bits 0-7 are the same as the IRQF_* bits in linux/interrupt.h
39 *
40 * IRQ_TYPE_NONE - default, unspecified type
41 * IRQ_TYPE_EDGE_RISING - rising edge triggered
42 * IRQ_TYPE_EDGE_FALLING - falling edge triggered
43 * IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
44 * IRQ_TYPE_LEVEL_HIGH - high level triggered
45 * IRQ_TYPE_LEVEL_LOW - low level triggered
46 * IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
47 * IRQ_TYPE_SENSE_MASK - Mask for all the above bits
48 * IRQ_TYPE_DEFAULT - For use by some PICs to ask irq_set_type
49 * to setup the HW to a sane default (used
50 * by irqdomain map() callbacks to synchronize
51 * the HW state and SW flags for a newly
52 * allocated descriptor).
53 *
54 * IRQ_TYPE_PROBE - Special flag for probing in progress
55 *
56 * Bits which can be modified via irq_set/clear/modify_status_flags()
57 * IRQ_LEVEL - Interrupt is level type. Will be also
58 * updated in the code when the above trigger
59 * bits are modified via irq_set_irq_type()
60 * IRQ_PER_CPU - Mark an interrupt PER_CPU. Will protect
61 * it from affinity setting
62 * IRQ_NOPROBE - Interrupt cannot be probed by autoprobing
63 * IRQ_NOREQUEST - Interrupt cannot be requested via
64 * request_irq()
65 * IRQ_NOTHREAD - Interrupt cannot be threaded
66 * IRQ_NOAUTOEN - Interrupt is not automatically enabled in
67 * request/setup_irq()
68 * IRQ_NO_BALANCING - Interrupt cannot be balanced (affinity set)
69 * IRQ_MOVE_PCNTXT - Interrupt can be migrated from process context
70 * IRQ_NESTED_THREAD - Interrupt nests into another thread
71 * IRQ_PER_CPU_DEVID - Dev_id is a per-cpu variable
72 * IRQ_IS_POLLED - Always polled by another interrupt. Exclude
73 * it from the spurious interrupt detection
74 * mechanism and from core side polling.
75 * IRQ_DISABLE_UNLAZY - Disable lazy irq disable
76 */
77enum {
78 IRQ_TYPE_NONE = 0x00000000,
79 IRQ_TYPE_EDGE_RISING = 0x00000001,
80 IRQ_TYPE_EDGE_FALLING = 0x00000002,
81 IRQ_TYPE_EDGE_BOTH = (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING),
82 IRQ_TYPE_LEVEL_HIGH = 0x00000004,
83 IRQ_TYPE_LEVEL_LOW = 0x00000008,
84 IRQ_TYPE_LEVEL_MASK = (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH),
85 IRQ_TYPE_SENSE_MASK = 0x0000000f,
86 IRQ_TYPE_DEFAULT = IRQ_TYPE_SENSE_MASK,
87
88 IRQ_TYPE_PROBE = 0x00000010,
89
90 IRQ_LEVEL = (1 << 8),
91 IRQ_PER_CPU = (1 << 9),
92 IRQ_NOPROBE = (1 << 10),
93 IRQ_NOREQUEST = (1 << 11),
94 IRQ_NOAUTOEN = (1 << 12),
95 IRQ_NO_BALANCING = (1 << 13),
96 IRQ_MOVE_PCNTXT = (1 << 14),
97 IRQ_NESTED_THREAD = (1 << 15),
98 IRQ_NOTHREAD = (1 << 16),
99 IRQ_PER_CPU_DEVID = (1 << 17),
100 IRQ_IS_POLLED = (1 << 18),
101 IRQ_DISABLE_UNLAZY = (1 << 19),
102};
103
104#define IRQF_MODIFY_MASK \
105 (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
106 IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
107 IRQ_PER_CPU | IRQ_NESTED_THREAD | IRQ_NOTHREAD | IRQ_PER_CPU_DEVID | \
108 IRQ_IS_POLLED | IRQ_DISABLE_UNLAZY)
109
110#define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU | IRQ_NO_BALANCING)
111
112/*
113 * Return value for chip->irq_set_affinity()
114 *
115 * IRQ_SET_MASK_OK - OK, core updates irq_common_data.affinity
116 * IRQ_SET_MASK_NOCPY - OK, chip did update irq_common_data.affinity
117 * IRQ_SET_MASK_OK_DONE - Same as IRQ_SET_MASK_OK for core. Special code to
118 * support stacked irqchips, which indicates skipping
119 * all descendent irqchips.
120 */
121enum {
122 IRQ_SET_MASK_OK = 0,
123 IRQ_SET_MASK_OK_NOCOPY,
124 IRQ_SET_MASK_OK_DONE,
125};
126
127struct msi_desc;
128struct irq_domain;
129
130/**
131 * struct irq_common_data - per irq data shared by all irqchips
132 * @state_use_accessors: status information for irq chip functions.
133 * Use accessor functions to deal with it
134 * @node: node index useful for balancing
135 * @handler_data: per-IRQ data for the irq_chip methods
136 * @affinity: IRQ affinity on SMP. If this is an IPI
137 * related irq, then this is the mask of the
138 * CPUs to which an IPI can be sent.
139 * @msi_desc: MSI descriptor
140 * @ipi_offset: Offset of first IPI target cpu in @affinity. Optional.
141 */
142struct irq_common_data {
143 unsigned int __private state_use_accessors;
144#ifdef CONFIG_NUMA
145 unsigned int node;
146#endif
147 void *handler_data;
148 struct msi_desc *msi_desc;
149 cpumask_var_t affinity;
150#ifdef CONFIG_GENERIC_IRQ_IPI
151 unsigned int ipi_offset;
152#endif
153};
154
155/**
156 * struct irq_data - per irq chip data passed down to chip functions
157 * @mask: precomputed bitmask for accessing the chip registers
158 * @irq: interrupt number
159 * @hwirq: hardware interrupt number, local to the interrupt domain
160 * @common: point to data shared by all irqchips
161 * @chip: low level interrupt hardware access
162 * @domain: Interrupt translation domain; responsible for mapping
163 * between hwirq number and linux irq number.
164 * @parent_data: pointer to parent struct irq_data to support hierarchy
165 * irq_domain
166 * @chip_data: platform-specific per-chip private data for the chip
167 * methods, to allow shared chip implementations
168 */
169struct irq_data {
170 u32 mask;
171 unsigned int irq;
172 unsigned long hwirq;
173 struct irq_common_data *common;
174 struct irq_chip *chip;
175 struct irq_domain *domain;
176#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
177 struct irq_data *parent_data;
178#endif
179 void *chip_data;
180};
181
182/*
183 * Bit masks for irq_common_data.state_use_accessors
184 *
185 * IRQD_TRIGGER_MASK - Mask for the trigger type bits
186 * IRQD_SETAFFINITY_PENDING - Affinity setting is pending
187 * IRQD_NO_BALANCING - Balancing disabled for this IRQ
188 * IRQD_PER_CPU - Interrupt is per cpu
189 * IRQD_AFFINITY_SET - Interrupt affinity was set
190 * IRQD_LEVEL - Interrupt is level triggered
191 * IRQD_WAKEUP_STATE - Interrupt is configured for wakeup
192 * from suspend
193 * IRDQ_MOVE_PCNTXT - Interrupt can be moved in process
194 * context
195 * IRQD_IRQ_DISABLED - Disabled state of the interrupt
196 * IRQD_IRQ_MASKED - Masked state of the interrupt
197 * IRQD_IRQ_INPROGRESS - In progress state of the interrupt
198 * IRQD_WAKEUP_ARMED - Wakeup mode armed
199 * IRQD_FORWARDED_TO_VCPU - The interrupt is forwarded to a VCPU
200 */
201enum {
202 IRQD_TRIGGER_MASK = 0xf,
203 IRQD_SETAFFINITY_PENDING = (1 << 8),
204 IRQD_NO_BALANCING = (1 << 10),
205 IRQD_PER_CPU = (1 << 11),
206 IRQD_AFFINITY_SET = (1 << 12),
207 IRQD_LEVEL = (1 << 13),
208 IRQD_WAKEUP_STATE = (1 << 14),
209 IRQD_MOVE_PCNTXT = (1 << 15),
210 IRQD_IRQ_DISABLED = (1 << 16),
211 IRQD_IRQ_MASKED = (1 << 17),
212 IRQD_IRQ_INPROGRESS = (1 << 18),
213 IRQD_WAKEUP_ARMED = (1 << 19),
214 IRQD_FORWARDED_TO_VCPU = (1 << 20),
215};
216
217#define __irqd_to_state(d) ACCESS_PRIVATE((d)->common, state_use_accessors)
218
219static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
220{
221 return __irqd_to_state(d) & IRQD_SETAFFINITY_PENDING;
222}
223
224static inline bool irqd_is_per_cpu(struct irq_data *d)
225{
226 return __irqd_to_state(d) & IRQD_PER_CPU;
227}
228
229static inline bool irqd_can_balance(struct irq_data *d)
230{
231 return !(__irqd_to_state(d) & (IRQD_PER_CPU | IRQD_NO_BALANCING));
232}
233
234static inline bool irqd_affinity_was_set(struct irq_data *d)
235{
236 return __irqd_to_state(d) & IRQD_AFFINITY_SET;
237}
238
239static inline void irqd_mark_affinity_was_set(struct irq_data *d)
240{
241 __irqd_to_state(d) |= IRQD_AFFINITY_SET;
242}
243
244static inline u32 irqd_get_trigger_type(struct irq_data *d)
245{
246 return __irqd_to_state(d) & IRQD_TRIGGER_MASK;
247}
248
249/*
250 * Must only be called inside irq_chip.irq_set_type() functions.
251 */
252static inline void irqd_set_trigger_type(struct irq_data *d, u32 type)
253{
254 __irqd_to_state(d) &= ~IRQD_TRIGGER_MASK;
255 __irqd_to_state(d) |= type & IRQD_TRIGGER_MASK;
256}
257
258static inline bool irqd_is_level_type(struct irq_data *d)
259{
260 return __irqd_to_state(d) & IRQD_LEVEL;
261}
262
263static inline bool irqd_is_wakeup_set(struct irq_data *d)
264{
265 return __irqd_to_state(d) & IRQD_WAKEUP_STATE;
266}
267
268static inline bool irqd_can_move_in_process_context(struct irq_data *d)
269{
270 return __irqd_to_state(d) & IRQD_MOVE_PCNTXT;
271}
272
273static inline bool irqd_irq_disabled(struct irq_data *d)
274{
275 return __irqd_to_state(d) & IRQD_IRQ_DISABLED;
276}
277
278static inline bool irqd_irq_masked(struct irq_data *d)
279{
280 return __irqd_to_state(d) & IRQD_IRQ_MASKED;
281}
282
283static inline bool irqd_irq_inprogress(struct irq_data *d)
284{
285 return __irqd_to_state(d) & IRQD_IRQ_INPROGRESS;
286}
287
288static inline bool irqd_is_wakeup_armed(struct irq_data *d)
289{
290 return __irqd_to_state(d) & IRQD_WAKEUP_ARMED;
291}
292
293static inline bool irqd_is_forwarded_to_vcpu(struct irq_data *d)
294{
295 return __irqd_to_state(d) & IRQD_FORWARDED_TO_VCPU;
296}
297
298static inline void irqd_set_forwarded_to_vcpu(struct irq_data *d)
299{
300 __irqd_to_state(d) |= IRQD_FORWARDED_TO_VCPU;
301}
302
303static inline void irqd_clr_forwarded_to_vcpu(struct irq_data *d)
304{
305 __irqd_to_state(d) &= ~IRQD_FORWARDED_TO_VCPU;
306}
307
308#undef __irqd_to_state
309
310static inline irq_hw_number_t irqd_to_hwirq(struct irq_data *d)
311{
312 return d->hwirq;
313}
314
315/**
316 * struct irq_chip - hardware interrupt chip descriptor
317 *
318 * @name: name for /proc/interrupts
319 * @irq_startup: start up the interrupt (defaults to ->enable if NULL)
320 * @irq_shutdown: shut down the interrupt (defaults to ->disable if NULL)
321 * @irq_enable: enable the interrupt (defaults to chip->unmask if NULL)
322 * @irq_disable: disable the interrupt
323 * @irq_ack: start of a new interrupt
324 * @irq_mask: mask an interrupt source
325 * @irq_mask_ack: ack and mask an interrupt source
326 * @irq_unmask: unmask an interrupt source
327 * @irq_eoi: end of interrupt
328 * @irq_set_affinity: set the CPU affinity on SMP machines
329 * @irq_retrigger: resend an IRQ to the CPU
330 * @irq_set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
331 * @irq_set_wake: enable/disable power-management wake-on of an IRQ
332 * @irq_bus_lock: function to lock access to slow bus (i2c) chips
333 * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
334 * @irq_cpu_online: configure an interrupt source for a secondary CPU
335 * @irq_cpu_offline: un-configure an interrupt source for a secondary CPU
336 * @irq_suspend: function called from core code on suspend once per
337 * chip, when one or more interrupts are installed
338 * @irq_resume: function called from core code on resume once per chip,
339 * when one ore more interrupts are installed
340 * @irq_pm_shutdown: function called from core code on shutdown once per chip
341 * @irq_calc_mask: Optional function to set irq_data.mask for special cases
342 * @irq_print_chip: optional to print special chip info in show_interrupts
343 * @irq_request_resources: optional to request resources before calling
344 * any other callback related to this irq
345 * @irq_release_resources: optional to release resources acquired with
346 * irq_request_resources
347 * @irq_compose_msi_msg: optional to compose message content for MSI
348 * @irq_write_msi_msg: optional to write message content for MSI
349 * @irq_get_irqchip_state: return the internal state of an interrupt
350 * @irq_set_irqchip_state: set the internal state of a interrupt
351 * @irq_set_vcpu_affinity: optional to target a vCPU in a virtual machine
352 * @ipi_send_single: send a single IPI to destination cpus
353 * @ipi_send_mask: send an IPI to destination cpus in cpumask
354 * @flags: chip specific flags
355 */
356struct irq_chip {
357 const char *name;
358 unsigned int (*irq_startup)(struct irq_data *data);
359 void (*irq_shutdown)(struct irq_data *data);
360 void (*irq_enable)(struct irq_data *data);
361 void (*irq_disable)(struct irq_data *data);
362
363 void (*irq_ack)(struct irq_data *data);
364 void (*irq_mask)(struct irq_data *data);
365 void (*irq_mask_ack)(struct irq_data *data);
366 void (*irq_unmask)(struct irq_data *data);
367 void (*irq_eoi)(struct irq_data *data);
368
369 int (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
370 int (*irq_retrigger)(struct irq_data *data);
371 int (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
372 int (*irq_set_wake)(struct irq_data *data, unsigned int on);
373
374 void (*irq_bus_lock)(struct irq_data *data);
375 void (*irq_bus_sync_unlock)(struct irq_data *data);
376
377 void (*irq_cpu_online)(struct irq_data *data);
378 void (*irq_cpu_offline)(struct irq_data *data);
379
380 void (*irq_suspend)(struct irq_data *data);
381 void (*irq_resume)(struct irq_data *data);
382 void (*irq_pm_shutdown)(struct irq_data *data);
383
384 void (*irq_calc_mask)(struct irq_data *data);
385
386 void (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
387 int (*irq_request_resources)(struct irq_data *data);
388 void (*irq_release_resources)(struct irq_data *data);
389
390 void (*irq_compose_msi_msg)(struct irq_data *data, struct msi_msg *msg);
391 void (*irq_write_msi_msg)(struct irq_data *data, struct msi_msg *msg);
392
393 int (*irq_get_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool *state);
394 int (*irq_set_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool state);
395
396 int (*irq_set_vcpu_affinity)(struct irq_data *data, void *vcpu_info);
397
398 void (*ipi_send_single)(struct irq_data *data, unsigned int cpu);
399 void (*ipi_send_mask)(struct irq_data *data, const struct cpumask *dest);
400
401 unsigned long flags;
402};
403
404/*
405 * irq_chip specific flags
406 *
407 * IRQCHIP_SET_TYPE_MASKED: Mask before calling chip.irq_set_type()
408 * IRQCHIP_EOI_IF_HANDLED: Only issue irq_eoi() when irq was handled
409 * IRQCHIP_MASK_ON_SUSPEND: Mask non wake irqs in the suspend path
410 * IRQCHIP_ONOFFLINE_ENABLED: Only call irq_on/off_line callbacks
411 * when irq enabled
412 * IRQCHIP_SKIP_SET_WAKE: Skip chip.irq_set_wake(), for this irq chip
413 * IRQCHIP_ONESHOT_SAFE: One shot does not require mask/unmask
414 * IRQCHIP_EOI_THREADED: Chip requires eoi() on unmask in threaded mode
415 */
416enum {
417 IRQCHIP_SET_TYPE_MASKED = (1 << 0),
418 IRQCHIP_EOI_IF_HANDLED = (1 << 1),
419 IRQCHIP_MASK_ON_SUSPEND = (1 << 2),
420 IRQCHIP_ONOFFLINE_ENABLED = (1 << 3),
421 IRQCHIP_SKIP_SET_WAKE = (1 << 4),
422 IRQCHIP_ONESHOT_SAFE = (1 << 5),
423 IRQCHIP_EOI_THREADED = (1 << 6),
424};
425
426#include <linux/irqdesc.h>
427
428/*
429 * Pick up the arch-dependent methods:
430 */
431#include <asm/hw_irq.h>
432
433#ifndef NR_IRQS_LEGACY
434# define NR_IRQS_LEGACY 0
435#endif
436
437#ifndef ARCH_IRQ_INIT_FLAGS
438# define ARCH_IRQ_INIT_FLAGS 0
439#endif
440
441#define IRQ_DEFAULT_INIT_FLAGS ARCH_IRQ_INIT_FLAGS
442
443struct irqaction;
444extern int setup_irq(unsigned int irq, struct irqaction *new);
445extern void remove_irq(unsigned int irq, struct irqaction *act);
446extern int setup_percpu_irq(unsigned int irq, struct irqaction *new);
447extern void remove_percpu_irq(unsigned int irq, struct irqaction *act);
448
449extern void irq_cpu_online(void);
450extern void irq_cpu_offline(void);
451extern int irq_set_affinity_locked(struct irq_data *data,
452 const struct cpumask *cpumask, bool force);
453extern int irq_set_vcpu_affinity(unsigned int irq, void *vcpu_info);
454
455extern void irq_migrate_all_off_this_cpu(void);
456
457#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
458void irq_move_irq(struct irq_data *data);
459void irq_move_masked_irq(struct irq_data *data);
460#else
461static inline void irq_move_irq(struct irq_data *data) { }
462static inline void irq_move_masked_irq(struct irq_data *data) { }
463#endif
464
465extern int no_irq_affinity;
466
467#ifdef CONFIG_HARDIRQS_SW_RESEND
468int irq_set_parent(int irq, int parent_irq);
469#else
470static inline int irq_set_parent(int irq, int parent_irq)
471{
472 return 0;
473}
474#endif
475
476/*
477 * Built-in IRQ handlers for various IRQ types,
478 * callable via desc->handle_irq()
479 */
480extern void handle_level_irq(struct irq_desc *desc);
481extern void handle_fasteoi_irq(struct irq_desc *desc);
482extern void handle_edge_irq(struct irq_desc *desc);
483extern void handle_edge_eoi_irq(struct irq_desc *desc);
484extern void handle_simple_irq(struct irq_desc *desc);
485extern void handle_percpu_irq(struct irq_desc *desc);
486extern void handle_percpu_devid_irq(struct irq_desc *desc);
487extern void handle_bad_irq(struct irq_desc *desc);
488extern void handle_nested_irq(unsigned int irq);
489
490extern int irq_chip_compose_msi_msg(struct irq_data *data, struct msi_msg *msg);
491#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
492extern void irq_chip_enable_parent(struct irq_data *data);
493extern void irq_chip_disable_parent(struct irq_data *data);
494extern void irq_chip_ack_parent(struct irq_data *data);
495extern int irq_chip_retrigger_hierarchy(struct irq_data *data);
496extern void irq_chip_mask_parent(struct irq_data *data);
497extern void irq_chip_unmask_parent(struct irq_data *data);
498extern void irq_chip_eoi_parent(struct irq_data *data);
499extern int irq_chip_set_affinity_parent(struct irq_data *data,
500 const struct cpumask *dest,
501 bool force);
502extern int irq_chip_set_wake_parent(struct irq_data *data, unsigned int on);
503extern int irq_chip_set_vcpu_affinity_parent(struct irq_data *data,
504 void *vcpu_info);
505extern int irq_chip_set_type_parent(struct irq_data *data, unsigned int type);
506#endif
507
508/* Handling of unhandled and spurious interrupts: */
509extern void note_interrupt(struct irq_desc *desc, irqreturn_t action_ret);
510
511
512/* Enable/disable irq debugging output: */
513extern int noirqdebug_setup(char *str);
514
515/* Checks whether the interrupt can be requested by request_irq(): */
516extern int can_request_irq(unsigned int irq, unsigned long irqflags);
517
518/* Dummy irq-chip implementations: */
519extern struct irq_chip no_irq_chip;
520extern struct irq_chip dummy_irq_chip;
521
522extern void
523irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
524 irq_flow_handler_t handle, const char *name);
525
526static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
527 irq_flow_handler_t handle)
528{
529 irq_set_chip_and_handler_name(irq, chip, handle, NULL);
530}
531
532extern int irq_set_percpu_devid(unsigned int irq);
533
534extern void
535__irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
536 const char *name);
537
538static inline void
539irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
540{
541 __irq_set_handler(irq, handle, 0, NULL);
542}
543
544/*
545 * Set a highlevel chained flow handler for a given IRQ.
546 * (a chained handler is automatically enabled and set to
547 * IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
548 */
549static inline void
550irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
551{
552 __irq_set_handler(irq, handle, 1, NULL);
553}
554
555/*
556 * Set a highlevel chained flow handler and its data for a given IRQ.
557 * (a chained handler is automatically enabled and set to
558 * IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
559 */
560void
561irq_set_chained_handler_and_data(unsigned int irq, irq_flow_handler_t handle,
562 void *data);
563
564void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
565
566static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
567{
568 irq_modify_status(irq, 0, set);
569}
570
571static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
572{
573 irq_modify_status(irq, clr, 0);
574}
575
576static inline void irq_set_noprobe(unsigned int irq)
577{
578 irq_modify_status(irq, 0, IRQ_NOPROBE);
579}
580
581static inline void irq_set_probe(unsigned int irq)
582{
583 irq_modify_status(irq, IRQ_NOPROBE, 0);
584}
585
586static inline void irq_set_nothread(unsigned int irq)
587{
588 irq_modify_status(irq, 0, IRQ_NOTHREAD);
589}
590
591static inline void irq_set_thread(unsigned int irq)
592{
593 irq_modify_status(irq, IRQ_NOTHREAD, 0);
594}
595
596static inline void irq_set_nested_thread(unsigned int irq, bool nest)
597{
598 if (nest)
599 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
600 else
601 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
602}
603
604static inline void irq_set_percpu_devid_flags(unsigned int irq)
605{
606 irq_set_status_flags(irq,
607 IRQ_NOAUTOEN | IRQ_PER_CPU | IRQ_NOTHREAD |
608 IRQ_NOPROBE | IRQ_PER_CPU_DEVID);
609}
610
611/* Set/get chip/data for an IRQ: */
612extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
613extern int irq_set_handler_data(unsigned int irq, void *data);
614extern int irq_set_chip_data(unsigned int irq, void *data);
615extern int irq_set_irq_type(unsigned int irq, unsigned int type);
616extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
617extern int irq_set_msi_desc_off(unsigned int irq_base, unsigned int irq_offset,
618 struct msi_desc *entry);
619extern struct irq_data *irq_get_irq_data(unsigned int irq);
620
621static inline struct irq_chip *irq_get_chip(unsigned int irq)
622{
623 struct irq_data *d = irq_get_irq_data(irq);
624 return d ? d->chip : NULL;
625}
626
627static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
628{
629 return d->chip;
630}
631
632static inline void *irq_get_chip_data(unsigned int irq)
633{
634 struct irq_data *d = irq_get_irq_data(irq);
635 return d ? d->chip_data : NULL;
636}
637
638static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
639{
640 return d->chip_data;
641}
642
643static inline void *irq_get_handler_data(unsigned int irq)
644{
645 struct irq_data *d = irq_get_irq_data(irq);
646 return d ? d->common->handler_data : NULL;
647}
648
649static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
650{
651 return d->common->handler_data;
652}
653
654static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
655{
656 struct irq_data *d = irq_get_irq_data(irq);
657 return d ? d->common->msi_desc : NULL;
658}
659
660static inline struct msi_desc *irq_data_get_msi_desc(struct irq_data *d)
661{
662 return d->common->msi_desc;
663}
664
665static inline u32 irq_get_trigger_type(unsigned int irq)
666{
667 struct irq_data *d = irq_get_irq_data(irq);
668 return d ? irqd_get_trigger_type(d) : 0;
669}
670
671static inline int irq_common_data_get_node(struct irq_common_data *d)
672{
673#ifdef CONFIG_NUMA
674 return d->node;
675#else
676 return 0;
677#endif
678}
679
680static inline int irq_data_get_node(struct irq_data *d)
681{
682 return irq_common_data_get_node(d->common);
683}
684
685static inline struct cpumask *irq_get_affinity_mask(int irq)
686{
687 struct irq_data *d = irq_get_irq_data(irq);
688
689 return d ? d->common->affinity : NULL;
690}
691
692static inline struct cpumask *irq_data_get_affinity_mask(struct irq_data *d)
693{
694 return d->common->affinity;
695}
696
697unsigned int arch_dynirq_lower_bound(unsigned int from);
698
699int __irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node,
700 struct module *owner);
701
702/* use macros to avoid needing export.h for THIS_MODULE */
703#define irq_alloc_descs(irq, from, cnt, node) \
704 __irq_alloc_descs(irq, from, cnt, node, THIS_MODULE)
705
706#define irq_alloc_desc(node) \
707 irq_alloc_descs(-1, 0, 1, node)
708
709#define irq_alloc_desc_at(at, node) \
710 irq_alloc_descs(at, at, 1, node)
711
712#define irq_alloc_desc_from(from, node) \
713 irq_alloc_descs(-1, from, 1, node)
714
715#define irq_alloc_descs_from(from, cnt, node) \
716 irq_alloc_descs(-1, from, cnt, node)
717
718void irq_free_descs(unsigned int irq, unsigned int cnt);
719static inline void irq_free_desc(unsigned int irq)
720{
721 irq_free_descs(irq, 1);
722}
723
724#ifdef CONFIG_GENERIC_IRQ_LEGACY_ALLOC_HWIRQ
725unsigned int irq_alloc_hwirqs(int cnt, int node);
726static inline unsigned int irq_alloc_hwirq(int node)
727{
728 return irq_alloc_hwirqs(1, node);
729}
730void irq_free_hwirqs(unsigned int from, int cnt);
731static inline void irq_free_hwirq(unsigned int irq)
732{
733 return irq_free_hwirqs(irq, 1);
734}
735int arch_setup_hwirq(unsigned int irq, int node);
736void arch_teardown_hwirq(unsigned int irq);
737#endif
738
739#ifdef CONFIG_GENERIC_IRQ_LEGACY
740void irq_init_desc(unsigned int irq);
741#endif
742
743/**
744 * struct irq_chip_regs - register offsets for struct irq_gci
745 * @enable: Enable register offset to reg_base
746 * @disable: Disable register offset to reg_base
747 * @mask: Mask register offset to reg_base
748 * @ack: Ack register offset to reg_base
749 * @eoi: Eoi register offset to reg_base
750 * @type: Type configuration register offset to reg_base
751 * @polarity: Polarity configuration register offset to reg_base
752 */
753struct irq_chip_regs {
754 unsigned long enable;
755 unsigned long disable;
756 unsigned long mask;
757 unsigned long ack;
758 unsigned long eoi;
759 unsigned long type;
760 unsigned long polarity;
761};
762
763/**
764 * struct irq_chip_type - Generic interrupt chip instance for a flow type
765 * @chip: The real interrupt chip which provides the callbacks
766 * @regs: Register offsets for this chip
767 * @handler: Flow handler associated with this chip
768 * @type: Chip can handle these flow types
769 * @mask_cache_priv: Cached mask register private to the chip type
770 * @mask_cache: Pointer to cached mask register
771 *
772 * A irq_generic_chip can have several instances of irq_chip_type when
773 * it requires different functions and register offsets for different
774 * flow types.
775 */
776struct irq_chip_type {
777 struct irq_chip chip;
778 struct irq_chip_regs regs;
779 irq_flow_handler_t handler;
780 u32 type;
781 u32 mask_cache_priv;
782 u32 *mask_cache;
783};
784
785/**
786 * struct irq_chip_generic - Generic irq chip data structure
787 * @lock: Lock to protect register and cache data access
788 * @reg_base: Register base address (virtual)
789 * @reg_readl: Alternate I/O accessor (defaults to readl if NULL)
790 * @reg_writel: Alternate I/O accessor (defaults to writel if NULL)
791 * @suspend: Function called from core code on suspend once per
792 * chip; can be useful instead of irq_chip::suspend to
793 * handle chip details even when no interrupts are in use
794 * @resume: Function called from core code on resume once per chip;
795 * can be useful instead of irq_chip::suspend to handle
796 * chip details even when no interrupts are in use
797 * @irq_base: Interrupt base nr for this chip
798 * @irq_cnt: Number of interrupts handled by this chip
799 * @mask_cache: Cached mask register shared between all chip types
800 * @type_cache: Cached type register
801 * @polarity_cache: Cached polarity register
802 * @wake_enabled: Interrupt can wakeup from suspend
803 * @wake_active: Interrupt is marked as an wakeup from suspend source
804 * @num_ct: Number of available irq_chip_type instances (usually 1)
805 * @private: Private data for non generic chip callbacks
806 * @installed: bitfield to denote installed interrupts
807 * @unused: bitfield to denote unused interrupts
808 * @domain: irq domain pointer
809 * @list: List head for keeping track of instances
810 * @chip_types: Array of interrupt irq_chip_types
811 *
812 * Note, that irq_chip_generic can have multiple irq_chip_type
813 * implementations which can be associated to a particular irq line of
814 * an irq_chip_generic instance. That allows to share and protect
815 * state in an irq_chip_generic instance when we need to implement
816 * different flow mechanisms (level/edge) for it.
817 */
818struct irq_chip_generic {
819 raw_spinlock_t lock;
820 void __iomem *reg_base;
821 u32 (*reg_readl)(void __iomem *addr);
822 void (*reg_writel)(u32 val, void __iomem *addr);
823 void (*suspend)(struct irq_chip_generic *gc);
824 void (*resume)(struct irq_chip_generic *gc);
825 unsigned int irq_base;
826 unsigned int irq_cnt;
827 u32 mask_cache;
828 u32 type_cache;
829 u32 polarity_cache;
830 u32 wake_enabled;
831 u32 wake_active;
832 unsigned int num_ct;
833 void *private;
834 unsigned long installed;
835 unsigned long unused;
836 struct irq_domain *domain;
837 struct list_head list;
838 struct irq_chip_type chip_types[0];
839};
840
841/**
842 * enum irq_gc_flags - Initialization flags for generic irq chips
843 * @IRQ_GC_INIT_MASK_CACHE: Initialize the mask_cache by reading mask reg
844 * @IRQ_GC_INIT_NESTED_LOCK: Set the lock class of the irqs to nested for
845 * irq chips which need to call irq_set_wake() on
846 * the parent irq. Usually GPIO implementations
847 * @IRQ_GC_MASK_CACHE_PER_TYPE: Mask cache is chip type private
848 * @IRQ_GC_NO_MASK: Do not calculate irq_data->mask
849 * @IRQ_GC_BE_IO: Use big-endian register accesses (default: LE)
850 */
851enum irq_gc_flags {
852 IRQ_GC_INIT_MASK_CACHE = 1 << 0,
853 IRQ_GC_INIT_NESTED_LOCK = 1 << 1,
854 IRQ_GC_MASK_CACHE_PER_TYPE = 1 << 2,
855 IRQ_GC_NO_MASK = 1 << 3,
856 IRQ_GC_BE_IO = 1 << 4,
857};
858
859/*
860 * struct irq_domain_chip_generic - Generic irq chip data structure for irq domains
861 * @irqs_per_chip: Number of interrupts per chip
862 * @num_chips: Number of chips
863 * @irq_flags_to_set: IRQ* flags to set on irq setup
864 * @irq_flags_to_clear: IRQ* flags to clear on irq setup
865 * @gc_flags: Generic chip specific setup flags
866 * @gc: Array of pointers to generic interrupt chips
867 */
868struct irq_domain_chip_generic {
869 unsigned int irqs_per_chip;
870 unsigned int num_chips;
871 unsigned int irq_flags_to_clear;
872 unsigned int irq_flags_to_set;
873 enum irq_gc_flags gc_flags;
874 struct irq_chip_generic *gc[0];
875};
876
877/* Generic chip callback functions */
878void irq_gc_noop(struct irq_data *d);
879void irq_gc_mask_disable_reg(struct irq_data *d);
880void irq_gc_mask_set_bit(struct irq_data *d);
881void irq_gc_mask_clr_bit(struct irq_data *d);
882void irq_gc_unmask_enable_reg(struct irq_data *d);
883void irq_gc_ack_set_bit(struct irq_data *d);
884void irq_gc_ack_clr_bit(struct irq_data *d);
885void irq_gc_mask_disable_reg_and_ack(struct irq_data *d);
886void irq_gc_eoi(struct irq_data *d);
887int irq_gc_set_wake(struct irq_data *d, unsigned int on);
888
889/* Setup functions for irq_chip_generic */
890int irq_map_generic_chip(struct irq_domain *d, unsigned int virq,
891 irq_hw_number_t hw_irq);
892struct irq_chip_generic *
893irq_alloc_generic_chip(const char *name, int nr_ct, unsigned int irq_base,
894 void __iomem *reg_base, irq_flow_handler_t handler);
895void irq_setup_generic_chip(struct irq_chip_generic *gc, u32 msk,
896 enum irq_gc_flags flags, unsigned int clr,
897 unsigned int set);
898int irq_setup_alt_chip(struct irq_data *d, unsigned int type);
899void irq_remove_generic_chip(struct irq_chip_generic *gc, u32 msk,
900 unsigned int clr, unsigned int set);
901
902struct irq_chip_generic *irq_get_domain_generic_chip(struct irq_domain *d, unsigned int hw_irq);
903int irq_alloc_domain_generic_chips(struct irq_domain *d, int irqs_per_chip,
904 int num_ct, const char *name,
905 irq_flow_handler_t handler,
906 unsigned int clr, unsigned int set,
907 enum irq_gc_flags flags);
908
909
910static inline struct irq_chip_type *irq_data_get_chip_type(struct irq_data *d)
911{
912 return container_of(d->chip, struct irq_chip_type, chip);
913}
914
915#define IRQ_MSK(n) (u32)((n) < 32 ? ((1 << (n)) - 1) : UINT_MAX)
916
917#ifdef CONFIG_SMP
918static inline void irq_gc_lock(struct irq_chip_generic *gc)
919{
920 raw_spin_lock(&gc->lock);
921}
922
923static inline void irq_gc_unlock(struct irq_chip_generic *gc)
924{
925 raw_spin_unlock(&gc->lock);
926}
927#else
928static inline void irq_gc_lock(struct irq_chip_generic *gc) { }
929static inline void irq_gc_unlock(struct irq_chip_generic *gc) { }
930#endif
931
932static inline void irq_reg_writel(struct irq_chip_generic *gc,
933 u32 val, int reg_offset)
934{
935 if (gc->reg_writel)
936 gc->reg_writel(val, gc->reg_base + reg_offset);
937 else
938 writel(val, gc->reg_base + reg_offset);
939}
940
941static inline u32 irq_reg_readl(struct irq_chip_generic *gc,
942 int reg_offset)
943{
944 if (gc->reg_readl)
945 return gc->reg_readl(gc->reg_base + reg_offset);
946 else
947 return readl(gc->reg_base + reg_offset);
948}
949
950/* Contrary to Linux irqs, for hardware irqs the irq number 0 is valid */
951#define INVALID_HWIRQ (~0UL)
952irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu);
953int __ipi_send_single(struct irq_desc *desc, unsigned int cpu);
954int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest);
955int ipi_send_single(unsigned int virq, unsigned int cpu);
956int ipi_send_mask(unsigned int virq, const struct cpumask *dest);
957
958#endif /* _LINUX_IRQ_H */