irq: add remove_irq() for freeing of setup_irq() irqs
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / linux / irq.h
blob56f9988362ec52badc48920c5d979343befb0d3b
1 #ifndef _LINUX_IRQ_H
2 #define _LINUX_IRQ_H
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.
9 * Thanks. --rmk
12 #include <linux/smp.h>
14 #ifndef CONFIG_S390
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>
24 #include <asm/irq.h>
25 #include <asm/ptrace.h>
26 #include <asm/irq_regs.h>
28 struct irq_desc;
29 typedef void (*irq_flow_handler_t)(unsigned int irq,
30 struct irq_desc *desc);
34 * IRQ line status.
36 * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
38 * IRQ types
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 */
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*/
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
77 struct proc_dir_entry;
78 struct msi_desc;
80 /**
81 * struct irq_chip - hardware interrupt chip descriptor
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
99 * @release: release function solely used by UML
100 * @typename: obsoleted by name, kept as migration helper
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);
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);
115 void (*end)(unsigned int irq);
116 void (*set_affinity)(unsigned int irq,
117 const struct cpumask *dest);
118 int (*retrigger)(unsigned int irq);
119 int (*set_type)(unsigned int irq, unsigned int flow_type);
120 int (*set_wake)(unsigned int irq, unsigned int on);
122 /* Currently used only by UML, might disappear one day.*/
123 #ifdef CONFIG_IRQ_RELEASE_METHOD
124 void (*release)(unsigned int irq, void *dev_id);
125 #endif
127 * For compatibility, ->typename is copied into ->name.
128 * Will disappear.
130 const char *typename;
133 struct timer_rand_state;
134 struct irq_2_iommu;
136 * struct irq_desc - interrupt descriptor
137 * @irq: interrupt number for this descriptor
138 * @timer_rand_state: pointer to timer rand state struct
139 * @kstat_irqs: irq stats per cpu
140 * @irq_2_iommu: iommu with this irq
141 * @handle_irq: highlevel irq-events handler [if NULL, __do_IRQ()]
142 * @chip: low level interrupt hardware access
143 * @msi_desc: MSI descriptor
144 * @handler_data: per-IRQ data for the irq_chip methods
145 * @chip_data: platform-specific per-chip private data for the chip
146 * methods, to allow shared chip implementations
147 * @action: the irq action chain
148 * @status: status information
149 * @depth: disable-depth, for nested irq_disable() calls
150 * @wake_depth: enable depth, for multiple set_irq_wake() callers
151 * @irq_count: stats field to detect stalled irqs
152 * @last_unhandled: aging timer for unhandled count
153 * @irqs_unhandled: stats field for spurious unhandled interrupts
154 * @lock: locking for SMP
155 * @affinity: IRQ affinity on SMP
156 * @cpu: cpu index useful for balancing
157 * @pending_mask: pending rebalanced interrupts
158 * @dir: /proc/irq/ procfs entry
159 * @name: flow handler name for /proc/interrupts output
161 struct irq_desc {
162 unsigned int irq;
163 #ifdef CONFIG_SPARSE_IRQ
164 struct timer_rand_state *timer_rand_state;
165 unsigned int *kstat_irqs;
166 # ifdef CONFIG_INTR_REMAP
167 struct irq_2_iommu *irq_2_iommu;
168 # endif
169 #endif
170 irq_flow_handler_t handle_irq;
171 struct irq_chip *chip;
172 struct msi_desc *msi_desc;
173 void *handler_data;
174 void *chip_data;
175 struct irqaction *action; /* IRQ action list */
176 unsigned int status; /* IRQ status */
178 unsigned int depth; /* nested irq disables */
179 unsigned int wake_depth; /* nested wake enables */
180 unsigned int irq_count; /* For detecting broken IRQs */
181 unsigned long last_unhandled; /* Aging timer for unhandled count */
182 unsigned int irqs_unhandled;
183 spinlock_t lock;
184 #ifdef CONFIG_SMP
185 cpumask_t affinity;
186 unsigned int cpu;
187 #endif
188 #ifdef CONFIG_GENERIC_PENDING_IRQ
189 cpumask_t pending_mask;
190 #endif
191 #ifdef CONFIG_PROC_FS
192 struct proc_dir_entry *dir;
193 #endif
194 const char *name;
195 } ____cacheline_internodealigned_in_smp;
197 extern void arch_init_copy_chip_data(struct irq_desc *old_desc,
198 struct irq_desc *desc, int cpu);
199 extern void arch_free_chip_data(struct irq_desc *old_desc, struct irq_desc *desc);
201 #ifndef CONFIG_SPARSE_IRQ
202 extern struct irq_desc irq_desc[NR_IRQS];
203 #else /* CONFIG_SPARSE_IRQ */
204 extern struct irq_desc *move_irq_desc(struct irq_desc *old_desc, int cpu);
206 #define kstat_irqs_this_cpu(DESC) \
207 ((DESC)->kstat_irqs[smp_processor_id()])
208 #define kstat_incr_irqs_this_cpu(irqno, DESC) \
209 ((DESC)->kstat_irqs[smp_processor_id()]++)
211 #endif /* CONFIG_SPARSE_IRQ */
213 extern struct irq_desc *irq_to_desc_alloc_cpu(unsigned int irq, int cpu);
215 static inline struct irq_desc *
216 irq_remap_to_desc(unsigned int irq, struct irq_desc *desc)
218 #ifdef CONFIG_NUMA_MIGRATE_IRQ_DESC
219 return irq_to_desc(irq);
220 #else
221 return desc;
222 #endif
226 * Migration helpers for obsolete names, they will go away:
228 #define hw_interrupt_type irq_chip
229 typedef struct irq_chip hw_irq_controller;
230 #define no_irq_type no_irq_chip
231 typedef struct irq_desc irq_desc_t;
234 * Pick up the arch-dependent methods:
236 #include <asm/hw_irq.h>
238 extern int setup_irq(unsigned int irq, struct irqaction *new);
239 extern struct irqaction *remove_irq(unsigned int irq, void *dev_id);
241 #ifdef CONFIG_GENERIC_HARDIRQS
243 #ifdef CONFIG_SMP
245 #ifdef CONFIG_GENERIC_PENDING_IRQ
247 void move_native_irq(int irq);
248 void move_masked_irq(int irq);
250 #else /* CONFIG_GENERIC_PENDING_IRQ */
252 static inline void move_irq(int irq)
256 static inline void move_native_irq(int irq)
260 static inline void move_masked_irq(int irq)
264 #endif /* CONFIG_GENERIC_PENDING_IRQ */
266 #else /* CONFIG_SMP */
268 #define move_native_irq(x)
269 #define move_masked_irq(x)
271 #endif /* CONFIG_SMP */
273 extern int no_irq_affinity;
275 static inline int irq_balancing_disabled(unsigned int irq)
277 struct irq_desc *desc;
279 desc = irq_to_desc(irq);
280 return desc->status & IRQ_NO_BALANCING_MASK;
283 /* Handle irq action chains: */
284 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
287 * Built-in IRQ handlers for various IRQ types,
288 * callable via desc->chip->handle_irq()
290 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
291 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
292 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
293 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
294 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
295 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
298 * Monolithic do_IRQ implementation.
300 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
301 extern unsigned int __do_IRQ(unsigned int irq);
302 #endif
305 * Architectures call this to let the generic IRQ layer
306 * handle an interrupt. If the descriptor is attached to an
307 * irqchip-style controller then we call the ->handle_irq() handler,
308 * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
310 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
312 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
313 desc->handle_irq(irq, desc);
314 #else
315 if (likely(desc->handle_irq))
316 desc->handle_irq(irq, desc);
317 else
318 __do_IRQ(irq);
319 #endif
322 static inline void generic_handle_irq(unsigned int irq)
324 generic_handle_irq_desc(irq, irq_to_desc(irq));
327 /* Handling of unhandled and spurious interrupts: */
328 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
329 int action_ret);
331 /* Resending of interrupts :*/
332 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
334 /* Enable/disable irq debugging output: */
335 extern int noirqdebug_setup(char *str);
337 /* Checks whether the interrupt can be requested by request_irq(): */
338 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
340 /* Dummy irq-chip implementations: */
341 extern struct irq_chip no_irq_chip;
342 extern struct irq_chip dummy_irq_chip;
344 extern void
345 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
346 irq_flow_handler_t handle);
347 extern void
348 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
349 irq_flow_handler_t handle, const char *name);
351 extern void
352 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
353 const char *name);
355 /* caller has locked the irq_desc and both params are valid */
356 static inline void __set_irq_handler_unlocked(int irq,
357 irq_flow_handler_t handler)
359 struct irq_desc *desc;
361 desc = irq_to_desc(irq);
362 desc->handle_irq = handler;
366 * Set a highlevel flow handler for a given IRQ:
368 static inline void
369 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
371 __set_irq_handler(irq, handle, 0, NULL);
375 * Set a highlevel chained flow handler for a given IRQ.
376 * (a chained handler is automatically enabled and set to
377 * IRQ_NOREQUEST and IRQ_NOPROBE)
379 static inline void
380 set_irq_chained_handler(unsigned int irq,
381 irq_flow_handler_t handle)
383 __set_irq_handler(irq, handle, 1, NULL);
386 extern void set_irq_noprobe(unsigned int irq);
387 extern void set_irq_probe(unsigned int irq);
389 /* Handle dynamic irq creation and destruction */
390 extern unsigned int create_irq_nr(unsigned int irq_want);
391 extern int create_irq(void);
392 extern void destroy_irq(unsigned int irq);
394 /* Test to see if a driver has successfully requested an irq */
395 static inline int irq_has_action(unsigned int irq)
397 struct irq_desc *desc = irq_to_desc(irq);
398 return desc->action != NULL;
401 /* Dynamic irq helper functions */
402 extern void dynamic_irq_init(unsigned int irq);
403 extern void dynamic_irq_cleanup(unsigned int irq);
405 /* Set/get chip/data for an IRQ: */
406 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
407 extern int set_irq_data(unsigned int irq, void *data);
408 extern int set_irq_chip_data(unsigned int irq, void *data);
409 extern int set_irq_type(unsigned int irq, unsigned int type);
410 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
412 #define get_irq_chip(irq) (irq_to_desc(irq)->chip)
413 #define get_irq_chip_data(irq) (irq_to_desc(irq)->chip_data)
414 #define get_irq_data(irq) (irq_to_desc(irq)->handler_data)
415 #define get_irq_msi(irq) (irq_to_desc(irq)->msi_desc)
417 #define get_irq_desc_chip(desc) ((desc)->chip)
418 #define get_irq_desc_chip_data(desc) ((desc)->chip_data)
419 #define get_irq_desc_data(desc) ((desc)->handler_data)
420 #define get_irq_desc_msi(desc) ((desc)->msi_desc)
422 #endif /* CONFIG_GENERIC_HARDIRQS */
424 #endif /* !CONFIG_S390 */
426 #endif /* _LINUX_IRQ_H */