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