3eab46f590a992cdc840f9591a43997519fa8ddb
[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
25 /*
26  * IRQ line status.
27  *
28  * Bits 0-16 are reserved for the IRQF_* bits in linux/interrupt.h
29  *
30  * IRQ types
31  */
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 */
50 #define IRQ_PER_CPU             0x01000000      /* IRQ is per CPU */
51 #ifdef CONFIG_IRQ_PER_CPU
52 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
53 #else
54 # define CHECK_IRQ_PER_CPU(var) 0
55 #endif
56
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. */
61 #define IRQ_WAKEUP              0x20000000      /* IRQ triggers system wakeup */
62 #define IRQ_MOVE_PENDING        0x40000000      /* need to re-target IRQ destination */
63
64 struct proc_dir_entry;
65
66 /**
67  * struct irq_chip - hardware interrupt chip descriptor
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)
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
78  * @eoi:                end of interrupt - chip level
79  * @end:                end of interrupt - flow level
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
86  * @typename:           obsoleted by name, kept as migration helper
87  */
88 struct irq_chip {
89         const char      *name;
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);
94
95         void            (*ack)(unsigned int irq);
96         void            (*mask)(unsigned int irq);
97         void            (*mask_ack)(unsigned int irq);
98         void            (*unmask)(unsigned int irq);
99         void            (*eoi)(unsigned int irq);
100
101         void            (*end)(unsigned int irq);
102         void            (*set_affinity)(unsigned int irq, cpumask_t dest);
103         int             (*retrigger)(unsigned int irq);
104         int             (*set_type)(unsigned int irq, unsigned int flow_type);
105         int             (*set_wake)(unsigned int irq, unsigned int on);
106
107         /* Currently used only by UML, might disappear one day.*/
108 #ifdef CONFIG_IRQ_RELEASE_METHOD
109         void            (*release)(unsigned int irq, void *dev_id);
110 #endif
111         /*
112          * For compatibility, ->typename is copied into ->name.
113          * Will disappear.
114          */
115         const char      *typename;
116 };
117
118 /**
119  * struct irq_desc - interrupt descriptor
120  *
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
126  * @action:             the irq action chain
127  * @status:             status information
128  * @depth:              disable-depth, for nested irq_disable() calls
129  * @wake_depth:         enable depth, for multiple set_irq_wake() callers
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
134  * @cpu:                cpu index useful for balancing
135  * @pending_mask:       pending rebalanced interrupts
136  * @dir:                /proc/irq/ procfs entry
137  * @affinity_entry:     /proc/irq/smp_affinity procfs entry on SMP
138  *
139  * Pad this out to 32 bytes for cache and indexing reasons.
140  */
141 struct irq_desc {
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;
147         void                    *chip_data;
148         struct irqaction        *action;        /* IRQ action list */
149         unsigned int            status;         /* IRQ status */
150
151         unsigned int            depth;          /* nested irq disables */
152         unsigned int            wake_depth;     /* nested wake enables */
153         unsigned int            irq_count;      /* For detecting broken IRQs */
154         unsigned int            irqs_unhandled;
155         spinlock_t              lock;
156 #ifdef CONFIG_SMP
157         cpumask_t               affinity;
158         unsigned int            cpu;
159 #endif
160 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
161         cpumask_t               pending_mask;
162 #endif
163 #ifdef CONFIG_PROC_FS
164         struct proc_dir_entry *dir;
165 #endif
166 } ____cacheline_aligned;
167
168 extern struct irq_desc irq_desc[NR_IRQS];
169
170 /*
171  * Migration helpers for obsolete names, they will go away:
172  */
173 #define hw_interrupt_type       irq_chip
174 typedef struct irq_chip         hw_irq_controller;
175 #define no_irq_type             no_irq_chip
176 typedef struct irq_desc         irq_desc_t;
177
178 /*
179  * Pick up the arch-dependent methods:
180  */
181 #include <asm/hw_irq.h>
182
183 extern int setup_irq(unsigned int irq, struct irqaction *new);
184
185 #ifdef CONFIG_GENERIC_HARDIRQS
186
187 #ifndef handle_dynamic_tick
188 # define handle_dynamic_tick(a)         do { } while (0)
189 #endif
190
191 #ifdef CONFIG_SMP
192 static inline void set_native_irq_info(int irq, cpumask_t mask)
193 {
194         irq_desc[irq].affinity = mask;
195 }
196 #else
197 static inline void set_native_irq_info(int irq, cpumask_t mask)
198 {
199 }
200 #endif
201
202 #ifdef CONFIG_SMP
203
204 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
205
206 void set_pending_irq(unsigned int irq, cpumask_t mask);
207 void move_native_irq(int irq);
208
209 #ifdef CONFIG_PCI_MSI
210 /*
211  * Wonder why these are dummies?
212  * For e.g the set_ioapic_affinity_vector() calls the set_ioapic_affinity_irq()
213  * counter part after translating the vector to irq info. We need to perform
214  * this operation on the real irq, when we dont use vector, i.e when
215  * pci_use_vector() is false.
216  */
217 static inline void move_irq(int irq)
218 {
219 }
220
221 static inline void set_irq_info(int irq, cpumask_t mask)
222 {
223 }
224
225 #else /* CONFIG_PCI_MSI */
226
227 static inline void move_irq(int irq)
228 {
229         move_native_irq(irq);
230 }
231
232 static inline void set_irq_info(int irq, cpumask_t mask)
233 {
234         set_native_irq_info(irq, mask);
235 }
236
237 #endif /* CONFIG_PCI_MSI */
238
239 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
240
241 static inline void move_irq(int irq)
242 {
243 }
244
245 static inline void move_native_irq(int irq)
246 {
247 }
248
249 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
250 {
251 }
252
253 static inline void set_irq_info(int irq, cpumask_t mask)
254 {
255         set_native_irq_info(irq, mask);
256 }
257
258 #endif /* CONFIG_GENERIC_PENDING_IRQ */
259
260 #else /* CONFIG_SMP */
261
262 #define move_irq(x)
263 #define move_native_irq(x)
264
265 #endif /* CONFIG_SMP */
266
267 #ifdef CONFIG_IRQBALANCE
268 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
269 #else
270 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
271 {
272 }
273 #endif
274
275 #ifdef CONFIG_AUTO_IRQ_AFFINITY
276 extern int select_smp_affinity(unsigned int irq);
277 #else
278 static inline int select_smp_affinity(unsigned int irq)
279 {
280         return 1;
281 }
282 #endif
283
284 extern int no_irq_affinity;
285
286 /* Handle irq action chains: */
287 extern int handle_IRQ_event(unsigned int irq, struct pt_regs *regs,
288                             struct irqaction *action);
289
290 /*
291  * Built-in IRQ handlers for various IRQ types,
292  * callable via desc->chip->handle_irq()
293  */
294 extern void fastcall
295 handle_level_irq(unsigned int irq, struct irq_desc *desc, struct pt_regs *regs);
296 extern void fastcall
297 handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc,
298                          struct pt_regs *regs);
299 extern void fastcall
300 handle_edge_irq(unsigned int irq, struct irq_desc *desc, struct pt_regs *regs);
301 extern void fastcall
302 handle_simple_irq(unsigned int irq, struct irq_desc *desc,
303                   struct pt_regs *regs);
304 extern void fastcall
305 handle_percpu_irq(unsigned int irq, struct irq_desc *desc,
306                   struct pt_regs *regs);
307 extern void fastcall
308 handle_bad_irq(unsigned int irq, struct irq_desc *desc, struct pt_regs *regs);
309
310 /*
311  * Get a descriptive string for the highlevel handler, for
312  * /proc/interrupts output:
313  */
314 extern const char *
315 handle_irq_name(void fastcall (*handle)(unsigned int, struct irq_desc *,
316                                         struct pt_regs *));
317
318 /*
319  * Monolithic do_IRQ implementation.
320  * (is an explicit fastcall, because i386 4KSTACKS calls it from assembly)
321  */
322 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
323 extern fastcall unsigned int __do_IRQ(unsigned int irq, struct pt_regs *regs);
324 #endif
325
326 /*
327  * Architectures call this to let the generic IRQ layer
328  * handle an interrupt. If the descriptor is attached to an
329  * irqchip-style controller then we call the ->handle_irq() handler,
330  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
331  */
332 static inline void generic_handle_irq(unsigned int irq, struct pt_regs *regs)
333 {
334         struct irq_desc *desc = irq_desc + irq;
335
336 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
337         desc->handle_irq(irq, desc, regs);
338 #else
339         if (likely(desc->handle_irq))
340                 desc->handle_irq(irq, desc, regs);
341         else
342                 __do_IRQ(irq, regs);
343 #endif
344 }
345
346 /* Handling of unhandled and spurious interrupts: */
347 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
348                            int action_ret, struct pt_regs *regs);
349
350 /* Resending of interrupts :*/
351 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
352
353 /* Initialize /proc/irq/ */
354 extern void init_irq_proc(void);
355
356 /* Enable/disable irq debugging output: */
357 extern int noirqdebug_setup(char *str);
358
359 /* Checks whether the interrupt can be requested by request_irq(): */
360 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
361
362 /* Dummy irq-chip implementations: */
363 extern struct irq_chip no_irq_chip;
364 extern struct irq_chip dummy_irq_chip;
365
366 extern void
367 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
368                          void fastcall (*handle)(unsigned int,
369                                                  struct irq_desc *,
370                                                  struct pt_regs *));
371 extern void
372 __set_irq_handler(unsigned int irq,
373                   void fastcall (*handle)(unsigned int, struct irq_desc *,
374                                           struct pt_regs *),
375                   int is_chained);
376
377 /*
378  * Set a highlevel flow handler for a given IRQ:
379  */
380 static inline void
381 set_irq_handler(unsigned int irq,
382                 void fastcall (*handle)(unsigned int, struct irq_desc *,
383                                         struct pt_regs *))
384 {
385         __set_irq_handler(irq, handle, 0);
386 }
387
388 /*
389  * Set a highlevel chained flow handler for a given IRQ.
390  * (a chained handler is automatically enabled and set to
391  *  IRQ_NOREQUEST and IRQ_NOPROBE)
392  */
393 static inline void
394 set_irq_chained_handler(unsigned int irq,
395                         void fastcall (*handle)(unsigned int, struct irq_desc *,
396                                                 struct pt_regs *))
397 {
398         __set_irq_handler(irq, handle, 1);
399 }
400
401 /* Set/get chip/data for an IRQ: */
402
403 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
404 extern int set_irq_data(unsigned int irq, void *data);
405 extern int set_irq_chip_data(unsigned int irq, void *data);
406 extern int set_irq_type(unsigned int irq, unsigned int type);
407
408 #define get_irq_chip(irq)       (irq_desc[irq].chip)
409 #define get_irq_chip_data(irq)  (irq_desc[irq].chip_data)
410 #define get_irq_data(irq)       (irq_desc[irq].handler_data)
411
412 #endif /* CONFIG_GENERIC_HARDIRQS */
413
414 #endif /* !CONFIG_S390 */
415
416 #endif /* _LINUX_IRQ_H */