]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - include/linux/irq.h
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[linux-2.6-omap-h63xx.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 struct msi_desc;
72
73 /**
74  * struct irq_chip - hardware interrupt chip descriptor
75  *
76  * @name:               name for /proc/interrupts
77  * @startup:            start up the interrupt (defaults to ->enable if NULL)
78  * @shutdown:           shut down the interrupt (defaults to ->disable if NULL)
79  * @enable:             enable the interrupt (defaults to chip->unmask if NULL)
80  * @disable:            disable the interrupt (defaults to chip->mask if NULL)
81  * @ack:                start of a new interrupt
82  * @mask:               mask an interrupt source
83  * @mask_ack:           ack and mask an interrupt source
84  * @unmask:             unmask an interrupt source
85  * @eoi:                end of interrupt - chip level
86  * @end:                end of interrupt - flow level
87  * @set_affinity:       set the CPU affinity on SMP machines
88  * @retrigger:          resend an IRQ to the CPU
89  * @set_type:           set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
90  * @set_wake:           enable/disable power-management wake-on of an IRQ
91  *
92  * @release:            release function solely used by UML
93  * @typename:           obsoleted by name, kept as migration helper
94  */
95 struct irq_chip {
96         const char      *name;
97         unsigned int    (*startup)(unsigned int irq);
98         void            (*shutdown)(unsigned int irq);
99         void            (*enable)(unsigned int irq);
100         void            (*disable)(unsigned int irq);
101
102         void            (*ack)(unsigned int irq);
103         void            (*mask)(unsigned int irq);
104         void            (*mask_ack)(unsigned int irq);
105         void            (*unmask)(unsigned int irq);
106         void            (*eoi)(unsigned int irq);
107
108         void            (*end)(unsigned int irq);
109         void            (*set_affinity)(unsigned int irq, cpumask_t dest);
110         int             (*retrigger)(unsigned int irq);
111         int             (*set_type)(unsigned int irq, unsigned int flow_type);
112         int             (*set_wake)(unsigned int irq, unsigned int on);
113
114         /* Currently used only by UML, might disappear one day.*/
115 #ifdef CONFIG_IRQ_RELEASE_METHOD
116         void            (*release)(unsigned int irq, void *dev_id);
117 #endif
118         /*
119          * For compatibility, ->typename is copied into ->name.
120          * Will disappear.
121          */
122         const char      *typename;
123 };
124
125 /**
126  * struct irq_desc - interrupt descriptor
127  *
128  * @handle_irq:         highlevel irq-events handler [if NULL, __do_IRQ()]
129  * @chip:               low level interrupt hardware access
130  * @handler_data:       per-IRQ data for the irq_chip methods
131  * @chip_data:          platform-specific per-chip private data for the chip
132  *                      methods, to allow shared chip implementations
133  * @action:             the irq action chain
134  * @status:             status information
135  * @depth:              disable-depth, for nested irq_disable() calls
136  * @wake_depth:         enable depth, for multiple set_irq_wake() callers
137  * @irq_count:          stats field to detect stalled irqs
138  * @irqs_unhandled:     stats field for spurious unhandled interrupts
139  * @lock:               locking for SMP
140  * @affinity:           IRQ affinity on SMP
141  * @cpu:                cpu index useful for balancing
142  * @pending_mask:       pending rebalanced interrupts
143  * @dir:                /proc/irq/ procfs entry
144  * @affinity_entry:     /proc/irq/smp_affinity procfs entry on SMP
145  * @name:               flow handler name for /proc/interrupts output
146  *
147  * Pad this out to 32 bytes for cache and indexing reasons.
148  */
149 struct irq_desc {
150         irq_flow_handler_t      handle_irq;
151         struct irq_chip         *chip;
152         struct msi_desc         *msi_desc;
153         void                    *handler_data;
154         void                    *chip_data;
155         struct irqaction        *action;        /* IRQ action list */
156         unsigned int            status;         /* IRQ status */
157
158         unsigned int            depth;          /* nested irq disables */
159         unsigned int            wake_depth;     /* nested wake enables */
160         unsigned int            irq_count;      /* For detecting broken IRQs */
161         unsigned int            irqs_unhandled;
162         spinlock_t              lock;
163 #ifdef CONFIG_SMP
164         cpumask_t               affinity;
165         unsigned int            cpu;
166 #endif
167 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
168         cpumask_t               pending_mask;
169 #endif
170 #ifdef CONFIG_PROC_FS
171         struct proc_dir_entry   *dir;
172 #endif
173         const char              *name;
174 } ____cacheline_aligned;
175
176 extern struct irq_desc irq_desc[NR_IRQS];
177
178 /*
179  * Migration helpers for obsolete names, they will go away:
180  */
181 #define hw_interrupt_type       irq_chip
182 typedef struct irq_chip         hw_irq_controller;
183 #define no_irq_type             no_irq_chip
184 typedef struct irq_desc         irq_desc_t;
185
186 /*
187  * Pick up the arch-dependent methods:
188  */
189 #include <asm/hw_irq.h>
190
191 extern int setup_irq(unsigned int irq, struct irqaction *new);
192
193 #ifdef CONFIG_GENERIC_HARDIRQS
194
195 #ifndef handle_dynamic_tick
196 # define handle_dynamic_tick(a)         do { } while (0)
197 #endif
198
199 #ifdef CONFIG_SMP
200 static inline void set_native_irq_info(int irq, cpumask_t mask)
201 {
202         irq_desc[irq].affinity = mask;
203 }
204 #else
205 static inline void set_native_irq_info(int irq, cpumask_t mask)
206 {
207 }
208 #endif
209
210 #ifdef CONFIG_SMP
211
212 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
213
214 void set_pending_irq(unsigned int irq, cpumask_t mask);
215 void move_native_irq(int irq);
216 void move_masked_irq(int irq);
217
218 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
219
220 static inline void move_irq(int irq)
221 {
222 }
223
224 static inline void move_native_irq(int irq)
225 {
226 }
227
228 static inline void move_masked_irq(int irq)
229 {
230 }
231
232 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
233 {
234 }
235
236 #endif /* CONFIG_GENERIC_PENDING_IRQ */
237
238 #else /* CONFIG_SMP */
239
240 #define move_native_irq(x)
241 #define move_masked_irq(x)
242
243 #endif /* CONFIG_SMP */
244
245 #ifdef CONFIG_IRQBALANCE
246 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
247 #else
248 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
249 {
250 }
251 #endif
252
253 #ifdef CONFIG_AUTO_IRQ_AFFINITY
254 extern int select_smp_affinity(unsigned int irq);
255 #else
256 static inline int select_smp_affinity(unsigned int irq)
257 {
258         return 1;
259 }
260 #endif
261
262 extern int no_irq_affinity;
263
264 /* Handle irq action chains: */
265 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
266
267 /*
268  * Built-in IRQ handlers for various IRQ types,
269  * callable via desc->chip->handle_irq()
270  */
271 extern void fastcall handle_level_irq(unsigned int irq, struct irq_desc *desc);
272 extern void fastcall handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
273 extern void fastcall handle_edge_irq(unsigned int irq, struct irq_desc *desc);
274 extern void fastcall handle_simple_irq(unsigned int irq, struct irq_desc *desc);
275 extern void fastcall handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
276 extern void fastcall handle_bad_irq(unsigned int irq, struct irq_desc *desc);
277
278 /*
279  * Monolithic do_IRQ implementation.
280  * (is an explicit fastcall, because i386 4KSTACKS calls it from assembly)
281  */
282 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
283 extern fastcall unsigned int __do_IRQ(unsigned int irq);
284 #endif
285
286 /*
287  * Architectures call this to let the generic IRQ layer
288  * handle an interrupt. If the descriptor is attached to an
289  * irqchip-style controller then we call the ->handle_irq() handler,
290  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
291  */
292 static inline void generic_handle_irq(unsigned int irq)
293 {
294         struct irq_desc *desc = irq_desc + irq;
295
296 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
297         desc->handle_irq(irq, desc);
298 #else
299         if (likely(desc->handle_irq))
300                 desc->handle_irq(irq, desc);
301         else
302                 __do_IRQ(irq);
303 #endif
304 }
305
306 /* Handling of unhandled and spurious interrupts: */
307 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
308                            int action_ret);
309
310 /* Resending of interrupts :*/
311 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
312
313 /* Initialize /proc/irq/ */
314 extern void init_irq_proc(void);
315
316 /* Enable/disable irq debugging output: */
317 extern int noirqdebug_setup(char *str);
318
319 /* Checks whether the interrupt can be requested by request_irq(): */
320 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
321
322 /* Dummy irq-chip implementations: */
323 extern struct irq_chip no_irq_chip;
324 extern struct irq_chip dummy_irq_chip;
325
326 extern void
327 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
328                          irq_flow_handler_t handle);
329 extern void
330 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
331                               irq_flow_handler_t handle, const char *name);
332
333 extern void
334 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
335                   const char *name);
336
337 /*
338  * Set a highlevel flow handler for a given IRQ:
339  */
340 static inline void
341 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
342 {
343         __set_irq_handler(irq, handle, 0, NULL);
344 }
345
346 /*
347  * Set a highlevel chained flow handler for a given IRQ.
348  * (a chained handler is automatically enabled and set to
349  *  IRQ_NOREQUEST and IRQ_NOPROBE)
350  */
351 static inline void
352 set_irq_chained_handler(unsigned int irq,
353                         irq_flow_handler_t handle)
354 {
355         __set_irq_handler(irq, handle, 1, NULL);
356 }
357
358 /* Handle dynamic irq creation and destruction */
359 extern int create_irq(void);
360 extern void destroy_irq(unsigned int irq);
361
362 /* Test to see if a driver has successfully requested an irq */
363 static inline int irq_has_action(unsigned int irq)
364 {
365         struct irq_desc *desc = irq_desc + irq;
366         return desc->action != NULL;
367 }
368
369 /* Dynamic irq helper functions */
370 extern void dynamic_irq_init(unsigned int irq);
371 extern void dynamic_irq_cleanup(unsigned int irq);
372
373 /* Set/get chip/data for an IRQ: */
374 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
375 extern int set_irq_data(unsigned int irq, void *data);
376 extern int set_irq_chip_data(unsigned int irq, void *data);
377 extern int set_irq_type(unsigned int irq, unsigned int type);
378 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
379
380 #define get_irq_chip(irq)       (irq_desc[irq].chip)
381 #define get_irq_chip_data(irq)  (irq_desc[irq].chip_data)
382 #define get_irq_data(irq)       (irq_desc[irq].handler_data)
383 #define get_irq_msi(irq)        (irq_desc[irq].msi_desc)
384
385 #endif /* CONFIG_GENERIC_HARDIRQS */
386
387 #endif /* !CONFIG_S390 */
388
389 #endif /* _LINUX_IRQ_H */