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