genirq: Provide status modifier
[deliverable/linux.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>
503e5763 20#include <linux/gfp.h>
908dcecd 21#include <linux/irqreturn.h>
dd3a1db9 22#include <linux/irqnr.h>
77904fd6 23#include <linux/errno.h>
503e5763 24#include <linux/topology.h>
3aa551c9 25#include <linux/wait.h>
1da177e4
LT
26
27#include <asm/irq.h>
28#include <asm/ptrace.h>
7d12e780 29#include <asm/irq_regs.h>
1da177e4 30
57a58a94 31struct irq_desc;
ec701584 32typedef void (*irq_flow_handler_t)(unsigned int irq,
7d12e780 33 struct irq_desc *desc);
57a58a94
DH
34
35
1da177e4
LT
36/*
37 * IRQ line status.
6e213616 38 *
950f4427 39 * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
6e213616
TG
40 *
41 * IRQ types
1da177e4 42 */
6e213616
TG
43#define IRQ_TYPE_NONE 0x00000000 /* Default, unspecified type */
44#define IRQ_TYPE_EDGE_RISING 0x00000001 /* Edge rising type */
45#define IRQ_TYPE_EDGE_FALLING 0x00000002 /* Edge falling type */
46#define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
47#define IRQ_TYPE_LEVEL_HIGH 0x00000004 /* Level high type */
48#define IRQ_TYPE_LEVEL_LOW 0x00000008 /* Level low type */
49#define IRQ_TYPE_SENSE_MASK 0x0000000f /* Mask of the above */
50#define IRQ_TYPE_PROBE 0x00000010 /* Probing in progress */
51
52/* Internal flags */
950f4427
TG
53#define IRQ_INPROGRESS 0x00000100 /* IRQ handler active - do not enter! */
54#define IRQ_DISABLED 0x00000200 /* IRQ disabled - do not enter! */
55#define IRQ_PENDING 0x00000400 /* IRQ pending - replay on enable */
56#define IRQ_REPLAY 0x00000800 /* IRQ has been replayed but not acked yet */
57#define IRQ_AUTODETECT 0x00001000 /* IRQ is being autodetected */
58#define IRQ_WAITING 0x00002000 /* IRQ not yet seen - for autodetection */
59#define IRQ_LEVEL 0x00004000 /* IRQ level triggered */
60#define IRQ_MASKED 0x00008000 /* IRQ masked - shouldn't be seen again */
61#define IRQ_PER_CPU 0x00010000 /* IRQ is per CPU */
62#define IRQ_NOPROBE 0x00020000 /* IRQ is not valid for probing */
63#define IRQ_NOREQUEST 0x00040000 /* IRQ cannot be requested */
64#define IRQ_NOAUTOEN 0x00080000 /* IRQ will not be enabled on request irq */
d7e25f33
IM
65#define IRQ_WAKEUP 0x00100000 /* IRQ triggers system wakeup */
66#define IRQ_MOVE_PENDING 0x00200000 /* need to re-target IRQ destination */
67#define IRQ_NO_BALANCING 0x00400000 /* IRQ is excluded from balancing */
1adb0850 68#define IRQ_SPURIOUS_DISABLED 0x00800000 /* IRQ was disabled by the spurious trap */
f6d87f4b
TG
69#define IRQ_MOVE_PCNTXT 0x01000000 /* IRQ migration from process context */
70#define IRQ_AFFINITY_SET 0x02000000 /* IRQ affinity was set from userspace*/
0a0c5168 71#define IRQ_SUSPENDED 0x04000000 /* IRQ has gone through suspend sequence */
b25c340c 72#define IRQ_ONESHOT 0x08000000 /* IRQ is not unmasked after hardirq */
399b5da2 73#define IRQ_NESTED_THREAD 0x10000000 /* IRQ is nested into another, no own handler thread */
950f4427 74
44247184
TG
75#define IRQF_MODIFY_MASK \
76 (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
77 IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL)
78
0d7012a9 79#ifdef CONFIG_IRQ_PER_CPU
f26fdd59 80# define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
950f4427 81# define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU | IRQ_NO_BALANCING)
f26fdd59
KW
82#else
83# define CHECK_IRQ_PER_CPU(var) 0
950f4427 84# define IRQ_NO_BALANCING_MASK IRQ_NO_BALANCING
f26fdd59 85#endif
1da177e4 86
5b912c10 87struct msi_desc;
6a6de9ef 88
ff7dcd44
TG
89/**
90 * struct irq_data - per irq and irq chip data passed down to chip functions
91 * @irq: interrupt number
92 * @node: node index useful for balancing
93 * @chip: low level interrupt hardware access
94 * @handler_data: per-IRQ data for the irq_chip methods
95 * @chip_data: platform-specific per-chip private data for the chip
96 * methods, to allow shared chip implementations
97 * @msi_desc: MSI descriptor
98 * @affinity: IRQ affinity on SMP
99 * @irq_2_iommu: iommu with this irq
100 *
101 * The fields here need to overlay the ones in irq_desc until we
102 * cleaned up the direct references and switched everything over to
103 * irq_data.
104 */
105struct irq_data {
106 unsigned int irq;
107 unsigned int node;
108 struct irq_chip *chip;
109 void *handler_data;
110 void *chip_data;
111 struct msi_desc *msi_desc;
112#ifdef CONFIG_SMP
113 cpumask_var_t affinity;
114#endif
115#ifdef CONFIG_INTR_REMAP
116 struct irq_2_iommu *irq_2_iommu;
117#endif
118};
119
8fee5c36 120/**
6a6de9ef 121 * struct irq_chip - hardware interrupt chip descriptor
8fee5c36
IM
122 *
123 * @name: name for /proc/interrupts
f8822657
TG
124 * @startup: deprecated, replaced by irq_startup
125 * @shutdown: deprecated, replaced by irq_shutdown
126 * @enable: deprecated, replaced by irq_enable
127 * @disable: deprecated, replaced by irq_disable
128 * @ack: deprecated, replaced by irq_ack
129 * @mask: deprecated, replaced by irq_mask
130 * @mask_ack: deprecated, replaced by irq_mask_ack
131 * @unmask: deprecated, replaced by irq_unmask
132 * @eoi: deprecated, replaced by irq_eoi
133 * @end: deprecated, will go away with __do_IRQ()
134 * @set_affinity: deprecated, replaced by irq_set_affinity
135 * @retrigger: deprecated, replaced by irq_retrigger
136 * @set_type: deprecated, replaced by irq_set_type
137 * @set_wake: deprecated, replaced by irq_wake
138 * @bus_lock: deprecated, replaced by irq_bus_lock
139 * @bus_sync_unlock: deprecated, replaced by irq_bus_sync_unlock
8fee5c36 140 *
f8822657
TG
141 * @irq_startup: start up the interrupt (defaults to ->enable if NULL)
142 * @irq_shutdown: shut down the interrupt (defaults to ->disable if NULL)
143 * @irq_enable: enable the interrupt (defaults to chip->unmask if NULL)
144 * @irq_disable: disable the interrupt
145 * @irq_ack: start of a new interrupt
146 * @irq_mask: mask an interrupt source
147 * @irq_mask_ack: ack and mask an interrupt source
148 * @irq_unmask: unmask an interrupt source
149 * @irq_eoi: end of interrupt
150 * @irq_set_affinity: set the CPU affinity on SMP machines
151 * @irq_retrigger: resend an IRQ to the CPU
152 * @irq_set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
153 * @irq_set_wake: enable/disable power-management wake-on of an IRQ
154 * @irq_bus_lock: function to lock access to slow bus (i2c) chips
155 * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
70aedd24 156 *
8fee5c36 157 * @release: release function solely used by UML
1da177e4 158 */
6a6de9ef
TG
159struct irq_chip {
160 const char *name;
bd151412 161#ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
71d218b7
IM
162 unsigned int (*startup)(unsigned int irq);
163 void (*shutdown)(unsigned int irq);
164 void (*enable)(unsigned int irq);
165 void (*disable)(unsigned int irq);
6a6de9ef 166
71d218b7 167 void (*ack)(unsigned int irq);
6a6de9ef
TG
168 void (*mask)(unsigned int irq);
169 void (*mask_ack)(unsigned int irq);
170 void (*unmask)(unsigned int irq);
47c2a3aa 171 void (*eoi)(unsigned int irq);
6a6de9ef 172
71d218b7 173 void (*end)(unsigned int irq);
d5dedd45 174 int (*set_affinity)(unsigned int irq,
0de26520 175 const struct cpumask *dest);
c0ad90a3 176 int (*retrigger)(unsigned int irq);
6a6de9ef
TG
177 int (*set_type)(unsigned int irq, unsigned int flow_type);
178 int (*set_wake)(unsigned int irq, unsigned int on);
c0ad90a3 179
70aedd24
TG
180 void (*bus_lock)(unsigned int irq);
181 void (*bus_sync_unlock)(unsigned int irq);
bd151412 182#endif
f8822657
TG
183 unsigned int (*irq_startup)(struct irq_data *data);
184 void (*irq_shutdown)(struct irq_data *data);
185 void (*irq_enable)(struct irq_data *data);
186 void (*irq_disable)(struct irq_data *data);
187
188 void (*irq_ack)(struct irq_data *data);
189 void (*irq_mask)(struct irq_data *data);
190 void (*irq_mask_ack)(struct irq_data *data);
191 void (*irq_unmask)(struct irq_data *data);
192 void (*irq_eoi)(struct irq_data *data);
193
194 int (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
195 int (*irq_retrigger)(struct irq_data *data);
196 int (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
197 int (*irq_set_wake)(struct irq_data *data, unsigned int on);
198
199 void (*irq_bus_lock)(struct irq_data *data);
200 void (*irq_bus_sync_unlock)(struct irq_data *data);
201
b77d6adc
PBG
202 /* Currently used only by UML, might disappear one day.*/
203#ifdef CONFIG_IRQ_RELEASE_METHOD
71d218b7 204 void (*release)(unsigned int irq, void *dev_id);
b77d6adc 205#endif
1da177e4
LT
206};
207
e144710b
TG
208/* This include will go away once we isolated irq_desc usage to core code */
209#include <linux/irqdesc.h>
0b8f1efa 210
34ffdb72
IM
211/*
212 * Pick up the arch-dependent methods:
213 */
214#include <asm/hw_irq.h>
1da177e4 215
e144710b 216struct irqaction;
06fcb0c6 217extern int setup_irq(unsigned int irq, struct irqaction *new);
cbf94f06 218extern void remove_irq(unsigned int irq, struct irqaction *act);
1da177e4
LT
219
220#ifdef CONFIG_GENERIC_HARDIRQS
06fcb0c6 221
3a3856d0 222#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
c777ac55 223void move_native_irq(int irq);
e7b946e9 224void move_masked_irq(int irq);
e144710b
TG
225#else
226static inline void move_native_irq(int irq) { }
227static inline void move_masked_irq(int irq) { }
228#endif
54d5d424 229
1da177e4 230extern int no_irq_affinity;
1da177e4 231
6a6de9ef 232/* Handle irq action chains: */
bedd30d9 233extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
6a6de9ef
TG
234
235/*
236 * Built-in IRQ handlers for various IRQ types,
bebd04cc 237 * callable via desc->handle_irq()
6a6de9ef 238 */
ec701584
HH
239extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
240extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
241extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
242extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
243extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
244extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
31b47cf7 245extern void handle_nested_irq(unsigned int irq);
6a6de9ef 246
6a6de9ef 247/* Handling of unhandled and spurious interrupts: */
34ffdb72 248extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
bedd30d9 249 irqreturn_t action_ret);
1da177e4 250
a4633adc 251
6a6de9ef
TG
252/* Enable/disable irq debugging output: */
253extern int noirqdebug_setup(char *str);
254
255/* Checks whether the interrupt can be requested by request_irq(): */
256extern int can_request_irq(unsigned int irq, unsigned long irqflags);
257
f8b5473f 258/* Dummy irq-chip implementations: */
6a6de9ef 259extern struct irq_chip no_irq_chip;
f8b5473f 260extern struct irq_chip dummy_irq_chip;
6a6de9ef 261
145fc655
IM
262extern void
263set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
264 irq_flow_handler_t handle);
6a6de9ef 265extern void
a460e745
IM
266set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
267 irq_flow_handler_t handle, const char *name);
268
6a6de9ef 269extern void
a460e745
IM
270__set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
271 const char *name);
1da177e4 272
6a6de9ef
TG
273/*
274 * Set a highlevel flow handler for a given IRQ:
275 */
276static inline void
57a58a94 277set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef 278{
a460e745 279 __set_irq_handler(irq, handle, 0, NULL);
6a6de9ef
TG
280}
281
282/*
283 * Set a highlevel chained flow handler for a given IRQ.
284 * (a chained handler is automatically enabled and set to
285 * IRQ_NOREQUEST and IRQ_NOPROBE)
286 */
287static inline void
288set_irq_chained_handler(unsigned int irq,
57a58a94 289 irq_flow_handler_t handle)
6a6de9ef 290{
a460e745 291 __set_irq_handler(irq, handle, 1, NULL);
6a6de9ef
TG
292}
293
399b5da2
TG
294extern void set_irq_nested_thread(unsigned int irq, int nest);
295
44247184
TG
296void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
297
298static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
299{
300 irq_modify_status(irq, 0, set);
301}
302
303static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
304{
305 irq_modify_status(irq, clr, 0);
306}
307
308static inline void set_irq_noprobe(unsigned int irq)
309{
310 irq_modify_status(irq, 0, IRQ_NOPROBE);
311}
312
313static inline void set_irq_probe(unsigned int irq)
314{
315 irq_modify_status(irq, IRQ_NOPROBE, 0);
316}
46f4f8f6 317
3a16d713 318/* Handle dynamic irq creation and destruction */
d047f53a 319extern unsigned int create_irq_nr(unsigned int irq_want, int node);
3a16d713
EB
320extern int create_irq(void);
321extern void destroy_irq(unsigned int irq);
322
323/* Dynamic irq helper functions */
324extern void dynamic_irq_init(unsigned int irq);
ced5b697 325void dynamic_irq_init_keep_chip_data(unsigned int irq);
3a16d713 326extern void dynamic_irq_cleanup(unsigned int irq);
ced5b697 327void dynamic_irq_cleanup_keep_chip_data(unsigned int irq);
dd87eb3a 328
3a16d713 329/* Set/get chip/data for an IRQ: */
dd87eb3a
TG
330extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
331extern int set_irq_data(unsigned int irq, void *data);
332extern int set_irq_chip_data(unsigned int irq, void *data);
333extern int set_irq_type(unsigned int irq, unsigned int type);
5b912c10 334extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
dd87eb3a 335
ff7dcd44
TG
336#define get_irq_chip(irq) (irq_to_desc(irq)->irq_data.chip)
337#define get_irq_chip_data(irq) (irq_to_desc(irq)->irq_data.chip_data)
338#define get_irq_data(irq) (irq_to_desc(irq)->irq_data.handler_data)
339#define get_irq_msi(irq) (irq_to_desc(irq)->irq_data.msi_desc)
dd87eb3a 340
6a6de9ef 341#endif /* CONFIG_GENERIC_HARDIRQS */
1da177e4 342
06fcb0c6 343#endif /* !CONFIG_S390 */
1da177e4 344
06fcb0c6 345#endif /* _LINUX_IRQ_H */
This page took 0.713122 seconds and 5 git commands to generate.