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