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