x86: move kstat_irqs from kstat to irq_desc
[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 #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 struct timer_rand_state;
131 /**
132  * struct irq_desc - interrupt descriptor
133  *
134  * @handle_irq:         highlevel irq-events handler [if NULL, __do_IRQ()]
135  * @chip:               low level interrupt hardware access
136  * @msi_desc:           MSI descriptor
137  * @handler_data:       per-IRQ data for the irq_chip methods
138  * @chip_data:          platform-specific per-chip private data for the chip
139  *                      methods, to allow shared chip implementations
140  * @action:             the irq action chain
141  * @status:             status information
142  * @depth:              disable-depth, for nested irq_disable() calls
143  * @wake_depth:         enable depth, for multiple set_irq_wake() callers
144  * @irq_count:          stats field to detect stalled irqs
145  * @irqs_unhandled:     stats field for spurious unhandled interrupts
146  * @last_unhandled:     aging timer for unhandled count
147  * @lock:               locking for SMP
148  * @affinity:           IRQ affinity on SMP
149  * @cpu:                cpu index useful for balancing
150  * @pending_mask:       pending rebalanced interrupts
151  * @dir:                /proc/irq/ procfs entry
152  * @affinity_entry:     /proc/irq/smp_affinity procfs entry on SMP
153  * @name:               flow handler name for /proc/interrupts output
154  */
155 struct irq_desc {
156         unsigned int            irq;
157 #ifdef CONFIG_HAVE_SPARSE_IRQ
158         struct irq_desc         *next;
159         struct timer_rand_state *timer_rand_state;
160 #endif
161 #ifdef CONFIG_HAVE_DYN_ARRAY
162         unsigned int            *kstat_irqs;
163 #else
164         unsigned int            kstat_irqs[NR_CPUS];
165 #endif
166         irq_flow_handler_t      handle_irq;
167         struct irq_chip         *chip;
168         struct msi_desc         *msi_desc;
169         void                    *handler_data;
170         void                    *chip_data;
171         struct irqaction        *action;        /* IRQ action list */
172         unsigned int            status;         /* IRQ status */
173
174         unsigned int            depth;          /* nested irq disables */
175         unsigned int            wake_depth;     /* nested wake enables */
176         unsigned int            irq_count;      /* For detecting broken IRQs */
177         unsigned int            irqs_unhandled;
178         unsigned long           last_unhandled; /* Aging timer for unhandled count */
179         spinlock_t              lock;
180 #ifdef CONFIG_SMP
181         cpumask_t               affinity;
182         unsigned int            cpu;
183 #endif
184 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
185         cpumask_t               pending_mask;
186 #endif
187 #ifdef CONFIG_PROC_FS
188         struct proc_dir_entry   *dir;
189 #endif
190         const char              *name;
191 } ____cacheline_internodealigned_in_smp;
192
193 extern struct irq_desc *irq_to_desc(unsigned int irq);
194 #ifndef CONFIG_HAVE_DYN_ARRAY
195 /* could be removed if we get rid of all irq_desc reference */
196 extern struct irq_desc irq_desc[NR_IRQS];
197 #endif
198 #define kstat_irqs_this_cpu(DESC) \
199         ((DESC)->kstat_irqs[smp_processor_id()])
200
201 /*
202  * Migration helpers for obsolete names, they will go away:
203  */
204 #define hw_interrupt_type       irq_chip
205 typedef struct irq_chip         hw_irq_controller;
206 #define no_irq_type             no_irq_chip
207 typedef struct irq_desc         irq_desc_t;
208
209 /*
210  * Pick up the arch-dependent methods:
211  */
212 #include <asm/hw_irq.h>
213
214 extern int setup_irq(unsigned int irq, struct irqaction *new);
215
216 #ifdef CONFIG_GENERIC_HARDIRQS
217
218 #ifdef CONFIG_SMP
219
220 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
221
222 void set_pending_irq(unsigned int irq, cpumask_t mask);
223 void move_native_irq(int irq);
224 void move_masked_irq(int irq);
225
226 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
227
228 static inline void move_irq(int irq)
229 {
230 }
231
232 static inline void move_native_irq(int irq)
233 {
234 }
235
236 static inline void move_masked_irq(int irq)
237 {
238 }
239
240 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
241 {
242 }
243
244 #endif /* CONFIG_GENERIC_PENDING_IRQ */
245
246 #else /* CONFIG_SMP */
247
248 #define move_native_irq(x)
249 #define move_masked_irq(x)
250
251 #endif /* CONFIG_SMP */
252
253 #ifdef CONFIG_IRQBALANCE
254 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
255 #else
256 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
257 {
258 }
259 #endif
260
261 extern int no_irq_affinity;
262
263 static inline int irq_balancing_disabled(unsigned int irq)
264 {
265         struct irq_desc *desc;
266
267         desc = irq_to_desc(irq);
268         return desc->status & IRQ_NO_BALANCING_MASK;
269 }
270
271 /* Handle irq action chains: */
272 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
273
274 /*
275  * Built-in IRQ handlers for various IRQ types,
276  * callable via desc->chip->handle_irq()
277  */
278 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
279 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
280 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
281 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
282 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
283 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
284
285 /*
286  * Monolithic do_IRQ implementation.
287  */
288 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
289 extern unsigned int __do_IRQ(unsigned int irq);
290 #endif
291
292 /*
293  * Architectures call this to let the generic IRQ layer
294  * handle an interrupt. If the descriptor is attached to an
295  * irqchip-style controller then we call the ->handle_irq() handler,
296  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
297  */
298 static inline void generic_handle_irq(unsigned int irq)
299 {
300         struct irq_desc *desc = irq_to_desc(irq);
301
302 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
303         desc->handle_irq(irq, desc);
304 #else
305         if (likely(desc->handle_irq))
306                 desc->handle_irq(irq, desc);
307         else
308                 __do_IRQ(irq);
309 #endif
310 }
311
312 /* Handling of unhandled and spurious interrupts: */
313 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
314                            int action_ret);
315
316 /* Resending of interrupts :*/
317 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
318
319 /* Enable/disable irq debugging output: */
320 extern int noirqdebug_setup(char *str);
321
322 /* Checks whether the interrupt can be requested by request_irq(): */
323 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
324
325 /* Dummy irq-chip implementations: */
326 extern struct irq_chip no_irq_chip;
327 extern struct irq_chip dummy_irq_chip;
328
329 extern void
330 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
331                          irq_flow_handler_t handle);
332 extern void
333 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
334                               irq_flow_handler_t handle, const char *name);
335
336 extern void
337 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
338                   const char *name);
339
340 /* caller has locked the irq_desc and both params are valid */
341 static inline void __set_irq_handler_unlocked(int irq,
342                                               irq_flow_handler_t handler)
343 {
344         struct irq_desc *desc;
345
346         desc = irq_to_desc(irq);
347         desc->handle_irq = handler;
348 }
349
350 /*
351  * Set a highlevel flow handler for a given IRQ:
352  */
353 static inline void
354 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
355 {
356         __set_irq_handler(irq, handle, 0, NULL);
357 }
358
359 /*
360  * Set a highlevel chained flow handler for a given IRQ.
361  * (a chained handler is automatically enabled and set to
362  *  IRQ_NOREQUEST and IRQ_NOPROBE)
363  */
364 static inline void
365 set_irq_chained_handler(unsigned int irq,
366                         irq_flow_handler_t handle)
367 {
368         __set_irq_handler(irq, handle, 1, NULL);
369 }
370
371 extern void set_irq_noprobe(unsigned int irq);
372 extern void set_irq_probe(unsigned int irq);
373
374 /* Handle dynamic irq creation and destruction */
375 extern int create_irq(void);
376 extern void destroy_irq(unsigned int irq);
377
378 /* Test to see if a driver has successfully requested an irq */
379 static inline int irq_has_action(unsigned int irq)
380 {
381         struct irq_desc *desc = irq_to_desc(irq);
382         return desc->action != NULL;
383 }
384
385 /* Dynamic irq helper functions */
386 extern void dynamic_irq_init(unsigned int irq);
387 extern void dynamic_irq_cleanup(unsigned int irq);
388
389 /* Set/get chip/data for an IRQ: */
390 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
391 extern int set_irq_data(unsigned int irq, void *data);
392 extern int set_irq_chip_data(unsigned int irq, void *data);
393 extern int set_irq_type(unsigned int irq, unsigned int type);
394 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
395
396 #define get_irq_chip(irq)       (irq_to_desc(irq)->chip)
397 #define get_irq_chip_data(irq)  (irq_to_desc(irq)->chip_data)
398 #define get_irq_data(irq)       (irq_to_desc(irq)->handler_data)
399 #define get_irq_msi(irq)        (irq_to_desc(irq)->msi_desc)
400
401 #endif /* CONFIG_GENERIC_HARDIRQS */
402
403 #endif /* !CONFIG_S390 */
404
405 #endif /* _LINUX_IRQ_H */