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