]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/irq.h
i2c.h kernel-doc additions
[mirror_ubuntu-zesty-kernel.git] / include / linux / irq.h
CommitLineData
06fcb0c6
IM
1#ifndef _LINUX_IRQ_H
2#define _LINUX_IRQ_H
1da177e4
LT
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
23f9b317 12#include <linux/smp.h>
1da177e4 13
06fcb0c6 14#ifndef CONFIG_S390
1da177e4
LT
15
16#include <linux/linkage.h>
17#include <linux/cache.h>
18#include <linux/spinlock.h>
19#include <linux/cpumask.h>
908dcecd 20#include <linux/irqreturn.h>
77904fd6 21#include <linux/errno.h>
1da177e4
LT
22
23#include <asm/irq.h>
24#include <asm/ptrace.h>
7d12e780 25#include <asm/irq_regs.h>
1da177e4 26
57a58a94
DH
27struct irq_desc;
28typedef void fastcall (*irq_flow_handler_t)(unsigned int irq,
7d12e780 29 struct irq_desc *desc);
57a58a94
DH
30
31
1da177e4
LT
32/*
33 * IRQ line status.
6e213616 34 *
950f4427 35 * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
6e213616
TG
36 *
37 * IRQ types
1da177e4 38 */
6e213616
TG
39#define IRQ_TYPE_NONE 0x00000000 /* Default, unspecified type */
40#define IRQ_TYPE_EDGE_RISING 0x00000001 /* Edge rising type */
41#define IRQ_TYPE_EDGE_FALLING 0x00000002 /* Edge falling type */
42#define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
43#define IRQ_TYPE_LEVEL_HIGH 0x00000004 /* Level high type */
44#define IRQ_TYPE_LEVEL_LOW 0x00000008 /* Level low type */
45#define IRQ_TYPE_SENSE_MASK 0x0000000f /* Mask of the above */
46#define IRQ_TYPE_PROBE 0x00000010 /* Probing in progress */
47
48/* Internal flags */
950f4427
TG
49#define IRQ_INPROGRESS 0x00000100 /* IRQ handler active - do not enter! */
50#define IRQ_DISABLED 0x00000200 /* IRQ disabled - do not enter! */
51#define IRQ_PENDING 0x00000400 /* IRQ pending - replay on enable */
52#define IRQ_REPLAY 0x00000800 /* IRQ has been replayed but not acked yet */
53#define IRQ_AUTODETECT 0x00001000 /* IRQ is being autodetected */
54#define IRQ_WAITING 0x00002000 /* IRQ not yet seen - for autodetection */
55#define IRQ_LEVEL 0x00004000 /* IRQ level triggered */
56#define IRQ_MASKED 0x00008000 /* IRQ masked - shouldn't be seen again */
57#define IRQ_PER_CPU 0x00010000 /* IRQ is per CPU */
58#define IRQ_NOPROBE 0x00020000 /* IRQ is not valid for probing */
59#define IRQ_NOREQUEST 0x00040000 /* IRQ cannot be requested */
60#define IRQ_NOAUTOEN 0x00080000 /* IRQ will not be enabled on request irq */
d7e25f33
IM
61#define IRQ_WAKEUP 0x00100000 /* IRQ triggers system wakeup */
62#define IRQ_MOVE_PENDING 0x00200000 /* need to re-target IRQ destination */
63#define IRQ_NO_BALANCING 0x00400000 /* IRQ is excluded from balancing */
950f4427 64
0d7012a9 65#ifdef CONFIG_IRQ_PER_CPU
f26fdd59 66# define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
950f4427 67# define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU | IRQ_NO_BALANCING)
f26fdd59
KW
68#else
69# define CHECK_IRQ_PER_CPU(var) 0
950f4427 70# define IRQ_NO_BALANCING_MASK IRQ_NO_BALANCING
f26fdd59 71#endif
1da177e4 72
6a6de9ef 73struct proc_dir_entry;
5b912c10 74struct msi_desc;
6a6de9ef 75
8fee5c36 76/**
6a6de9ef 77 * struct irq_chip - hardware interrupt chip descriptor
8fee5c36
IM
78 *
79 * @name: name for /proc/interrupts
80 * @startup: start up the interrupt (defaults to ->enable if NULL)
81 * @shutdown: shut down the interrupt (defaults to ->disable if NULL)
82 * @enable: enable the interrupt (defaults to chip->unmask if NULL)
83 * @disable: disable the interrupt (defaults to chip->mask if NULL)
8fee5c36
IM
84 * @ack: start of a new interrupt
85 * @mask: mask an interrupt source
86 * @mask_ack: ack and mask an interrupt source
87 * @unmask: unmask an interrupt source
47c2a3aa
IM
88 * @eoi: end of interrupt - chip level
89 * @end: end of interrupt - flow level
8fee5c36
IM
90 * @set_affinity: set the CPU affinity on SMP machines
91 * @retrigger: resend an IRQ to the CPU
92 * @set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
93 * @set_wake: enable/disable power-management wake-on of an IRQ
94 *
95 * @release: release function solely used by UML
6a6de9ef 96 * @typename: obsoleted by name, kept as migration helper
1da177e4 97 */
6a6de9ef
TG
98struct irq_chip {
99 const char *name;
71d218b7
IM
100 unsigned int (*startup)(unsigned int irq);
101 void (*shutdown)(unsigned int irq);
102 void (*enable)(unsigned int irq);
103 void (*disable)(unsigned int irq);
6a6de9ef 104
71d218b7 105 void (*ack)(unsigned int irq);
6a6de9ef
TG
106 void (*mask)(unsigned int irq);
107 void (*mask_ack)(unsigned int irq);
108 void (*unmask)(unsigned int irq);
47c2a3aa 109 void (*eoi)(unsigned int irq);
6a6de9ef 110
71d218b7
IM
111 void (*end)(unsigned int irq);
112 void (*set_affinity)(unsigned int irq, cpumask_t dest);
c0ad90a3 113 int (*retrigger)(unsigned int irq);
6a6de9ef
TG
114 int (*set_type)(unsigned int irq, unsigned int flow_type);
115 int (*set_wake)(unsigned int irq, unsigned int on);
c0ad90a3 116
b77d6adc
PBG
117 /* Currently used only by UML, might disappear one day.*/
118#ifdef CONFIG_IRQ_RELEASE_METHOD
71d218b7 119 void (*release)(unsigned int irq, void *dev_id);
b77d6adc 120#endif
6a6de9ef
TG
121 /*
122 * For compatibility, ->typename is copied into ->name.
123 * Will disappear.
124 */
125 const char *typename;
1da177e4
LT
126};
127
8fee5c36
IM
128/**
129 * struct irq_desc - interrupt descriptor
130 *
6a6de9ef
TG
131 * @handle_irq: highlevel irq-events handler [if NULL, __do_IRQ()]
132 * @chip: low level interrupt hardware access
472900b8 133 * @msi_desc: MSI descriptor
6a6de9ef
TG
134 * @handler_data: per-IRQ data for the irq_chip methods
135 * @chip_data: platform-specific per-chip private data for the chip
136 * methods, to allow shared chip implementations
8fee5c36
IM
137 * @action: the irq action chain
138 * @status: status information
139 * @depth: disable-depth, for nested irq_disable() calls
15a647eb 140 * @wake_depth: enable depth, for multiple set_irq_wake() callers
8fee5c36
IM
141 * @irq_count: stats field to detect stalled irqs
142 * @irqs_unhandled: stats field for spurious unhandled interrupts
143 * @lock: locking for SMP
144 * @affinity: IRQ affinity on SMP
6a6de9ef 145 * @cpu: cpu index useful for balancing
8fee5c36 146 * @pending_mask: pending rebalanced interrupts
8fee5c36
IM
147 * @dir: /proc/irq/ procfs entry
148 * @affinity_entry: /proc/irq/smp_affinity procfs entry on SMP
a460e745 149 * @name: flow handler name for /proc/interrupts output
1da177e4 150 */
34ffdb72 151struct irq_desc {
57a58a94 152 irq_flow_handler_t handle_irq;
6a6de9ef 153 struct irq_chip *chip;
5b912c10 154 struct msi_desc *msi_desc;
6a6de9ef 155 void *handler_data;
71d218b7
IM
156 void *chip_data;
157 struct irqaction *action; /* IRQ action list */
158 unsigned int status; /* IRQ status */
6a6de9ef 159
71d218b7 160 unsigned int depth; /* nested irq disables */
15a647eb 161 unsigned int wake_depth; /* nested wake enables */
71d218b7
IM
162 unsigned int irq_count; /* For detecting broken IRQs */
163 unsigned int irqs_unhandled;
4f27c00b 164 unsigned long last_unhandled; /* Aging timer for unhandled count */
71d218b7 165 spinlock_t lock;
a53da52f 166#ifdef CONFIG_SMP
71d218b7 167 cpumask_t affinity;
6a6de9ef 168 unsigned int cpu;
a53da52f 169#endif
06fcb0c6 170#if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
cd916d31 171 cpumask_t pending_mask;
54d5d424 172#endif
4a733ee1 173#ifdef CONFIG_PROC_FS
a460e745 174 struct proc_dir_entry *dir;
4a733ee1 175#endif
a460e745 176 const char *name;
e729aa16 177} ____cacheline_internodealigned_in_smp;
1da177e4 178
34ffdb72 179extern struct irq_desc irq_desc[NR_IRQS];
1da177e4 180
34ffdb72
IM
181/*
182 * Migration helpers for obsolete names, they will go away:
183 */
6a6de9ef
TG
184#define hw_interrupt_type irq_chip
185typedef struct irq_chip hw_irq_controller;
186#define no_irq_type no_irq_chip
34ffdb72
IM
187typedef struct irq_desc irq_desc_t;
188
189/*
190 * Pick up the arch-dependent methods:
191 */
192#include <asm/hw_irq.h>
1da177e4 193
06fcb0c6 194extern int setup_irq(unsigned int irq, struct irqaction *new);
1da177e4
LT
195
196#ifdef CONFIG_GENERIC_HARDIRQS
06fcb0c6 197
d061daa0
TG
198#ifndef handle_dynamic_tick
199# define handle_dynamic_tick(a) do { } while (0)
200#endif
201
54d5d424
AR
202#ifdef CONFIG_SMP
203
06fcb0c6 204#if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
54d5d424 205
c777ac55
AM
206void set_pending_irq(unsigned int irq, cpumask_t mask);
207void move_native_irq(int irq);
e7b946e9 208void move_masked_irq(int irq);
54d5d424 209
06fcb0c6
IM
210#else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
211
212static inline void move_irq(int irq)
213{
214}
215
216static inline void move_native_irq(int irq)
217{
218}
219
e7b946e9
EB
220static inline void move_masked_irq(int irq)
221{
222}
223
06fcb0c6
IM
224static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
225{
226}
54d5d424 227
06fcb0c6 228#endif /* CONFIG_GENERIC_PENDING_IRQ */
54d5d424 229
771ee3b0
TG
230extern int irq_set_affinity(unsigned int irq, cpumask_t cpumask);
231extern int irq_can_set_affinity(unsigned int irq);
232
06fcb0c6 233#else /* CONFIG_SMP */
54d5d424 234
54d5d424 235#define move_native_irq(x)
e7b946e9 236#define move_masked_irq(x)
54d5d424 237
771ee3b0
TG
238static inline int irq_set_affinity(unsigned int irq, cpumask_t cpumask)
239{
240 return -EINVAL;
241}
242
243static inline int irq_can_set_affinity(unsigned int irq) { return 0; }
244
06fcb0c6 245#endif /* CONFIG_SMP */
54d5d424 246
1b61b910
ZY
247#ifdef CONFIG_IRQBALANCE
248extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
249#else
250static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
251{
252}
253#endif
254
71d218b7
IM
255#ifdef CONFIG_AUTO_IRQ_AFFINITY
256extern int select_smp_affinity(unsigned int irq);
257#else
258static inline int select_smp_affinity(unsigned int irq)
259{
260 return 1;
261}
262#endif
263
1da177e4 264extern int no_irq_affinity;
1da177e4 265
950f4427
TG
266static inline int irq_balancing_disabled(unsigned int irq)
267{
268 return irq_desc[irq].status & IRQ_NO_BALANCING_MASK;
269}
270
6a6de9ef 271/* Handle irq action chains: */
7d12e780 272extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
6a6de9ef
TG
273
274/*
275 * Built-in IRQ handlers for various IRQ types,
276 * callable via desc->chip->handle_irq()
277 */
7d12e780
DH
278extern void fastcall handle_level_irq(unsigned int irq, struct irq_desc *desc);
279extern void fastcall handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
280extern void fastcall handle_edge_irq(unsigned int irq, struct irq_desc *desc);
281extern void fastcall handle_simple_irq(unsigned int irq, struct irq_desc *desc);
282extern void fastcall handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
283extern void fastcall handle_bad_irq(unsigned int irq, struct irq_desc *desc);
6a6de9ef 284
2e60bbb6 285/*
6a6de9ef
TG
286 * Monolithic do_IRQ implementation.
287 * (is an explicit fastcall, because i386 4KSTACKS calls it from assembly)
2e60bbb6 288 */
af8c65b5 289#ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
7d12e780 290extern fastcall unsigned int __do_IRQ(unsigned int irq);
af8c65b5 291#endif
2e60bbb6 292
dae86204
IM
293/*
294 * Architectures call this to let the generic IRQ layer
295 * handle an interrupt. If the descriptor is attached to an
296 * irqchip-style controller then we call the ->handle_irq() handler,
297 * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
298 */
7d12e780 299static inline void generic_handle_irq(unsigned int irq)
dae86204
IM
300{
301 struct irq_desc *desc = irq_desc + irq;
302
af8c65b5 303#ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
7d12e780 304 desc->handle_irq(irq, desc);
af8c65b5 305#else
dae86204 306 if (likely(desc->handle_irq))
7d12e780 307 desc->handle_irq(irq, desc);
dae86204 308 else
7d12e780 309 __do_IRQ(irq);
af8c65b5 310#endif
dae86204
IM
311}
312
6a6de9ef 313/* Handling of unhandled and spurious interrupts: */
34ffdb72 314extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
7d12e780 315 int action_ret);
1da177e4 316
a4633adc
TG
317/* Resending of interrupts :*/
318void check_irq_resend(struct irq_desc *desc, unsigned int irq);
319
6a6de9ef
TG
320/* Enable/disable irq debugging output: */
321extern int noirqdebug_setup(char *str);
322
323/* Checks whether the interrupt can be requested by request_irq(): */
324extern int can_request_irq(unsigned int irq, unsigned long irqflags);
325
f8b5473f 326/* Dummy irq-chip implementations: */
6a6de9ef 327extern struct irq_chip no_irq_chip;
f8b5473f 328extern struct irq_chip dummy_irq_chip;
6a6de9ef 329
145fc655
IM
330extern void
331set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
332 irq_flow_handler_t handle);
6a6de9ef 333extern void
a460e745
IM
334set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
335 irq_flow_handler_t handle, const char *name);
336
6a6de9ef 337extern void
a460e745
IM
338__set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
339 const char *name);
1da177e4 340
6a6de9ef
TG
341/*
342 * Set a highlevel flow handler for a given IRQ:
343 */
344static inline void
57a58a94 345set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef 346{
a460e745 347 __set_irq_handler(irq, handle, 0, NULL);
6a6de9ef
TG
348}
349
350/*
351 * Set a highlevel chained flow handler for a given IRQ.
352 * (a chained handler is automatically enabled and set to
353 * IRQ_NOREQUEST and IRQ_NOPROBE)
354 */
355static inline void
356set_irq_chained_handler(unsigned int irq,
57a58a94 357 irq_flow_handler_t handle)
6a6de9ef 358{
a460e745 359 __set_irq_handler(irq, handle, 1, NULL);
6a6de9ef
TG
360}
361
3a16d713
EB
362/* Handle dynamic irq creation and destruction */
363extern int create_irq(void);
364extern void destroy_irq(unsigned int irq);
365
1f80025e
EB
366/* Test to see if a driver has successfully requested an irq */
367static inline int irq_has_action(unsigned int irq)
368{
369 struct irq_desc *desc = irq_desc + irq;
370 return desc->action != NULL;
371}
372
3a16d713
EB
373/* Dynamic irq helper functions */
374extern void dynamic_irq_init(unsigned int irq);
375extern void dynamic_irq_cleanup(unsigned int irq);
dd87eb3a 376
3a16d713 377/* Set/get chip/data for an IRQ: */
dd87eb3a
TG
378extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
379extern int set_irq_data(unsigned int irq, void *data);
380extern int set_irq_chip_data(unsigned int irq, void *data);
381extern int set_irq_type(unsigned int irq, unsigned int type);
5b912c10 382extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
dd87eb3a
TG
383
384#define get_irq_chip(irq) (irq_desc[irq].chip)
385#define get_irq_chip_data(irq) (irq_desc[irq].chip_data)
386#define get_irq_data(irq) (irq_desc[irq].handler_data)
5b912c10 387#define get_irq_msi(irq) (irq_desc[irq].msi_desc)
dd87eb3a 388
6a6de9ef 389#endif /* CONFIG_GENERIC_HARDIRQS */
1da177e4 390
06fcb0c6 391#endif /* !CONFIG_S390 */
1da177e4 392
06fcb0c6 393#endif /* _LINUX_IRQ_H */