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