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