2 * linux/kernel/irq/manage.c
4 * Copyright (C) 1992, 1998-2006 Linus Torvalds, Ingo Molnar
5 * Copyright (C) 2005-2006 Thomas Gleixner
7 * This file contains driver APIs to the irq subsystem.
10 #include <linux/irq.h>
11 #include <linux/kthread.h>
12 #include <linux/module.h>
13 #include <linux/random.h>
14 #include <linux/interrupt.h>
15 #include <linux/slab.h>
16 #include <linux/sched.h>
18 #include "internals.h"
21 * synchronize_irq - wait for pending IRQ handlers (on other CPUs)
22 * @irq: interrupt number to wait for
24 * This function waits for any pending IRQ handlers for this interrupt
25 * to complete before returning. If you use this function while
26 * holding a resource the IRQ handler may need you will deadlock.
28 * This function may be called - with care - from IRQ context.
30 void synchronize_irq(unsigned int irq)
32 struct irq_desc *desc = irq_to_desc(irq);
42 * Wait until we're out of the critical section. This might
43 * give the wrong answer due to the lack of memory barriers.
45 while (desc->status & IRQ_INPROGRESS)
48 /* Ok, that indicated we're done: double-check carefully. */
49 spin_lock_irqsave(&desc->lock, flags);
50 status = desc->status;
51 spin_unlock_irqrestore(&desc->lock, flags);
53 /* Oops, that failed? */
54 } while (status & IRQ_INPROGRESS);
57 * We made sure that no hardirq handler is running. Now verify
58 * that no threaded handlers are active.
60 wait_event(desc->wait_for_threads, !atomic_read(&desc->threads_active));
62 EXPORT_SYMBOL(synchronize_irq);
65 cpumask_var_t irq_default_affinity;
68 * irq_can_set_affinity - Check if the affinity of a given irq can be set
69 * @irq: Interrupt to check
72 int irq_can_set_affinity(unsigned int irq)
74 struct irq_desc *desc = irq_to_desc(irq);
76 if (CHECK_IRQ_PER_CPU(desc->status) || !desc->chip ||
77 !desc->chip->set_affinity)
84 irq_set_thread_affinity(struct irq_desc *desc, const struct cpumask *cpumask)
86 struct irqaction *action = desc->action;
90 set_cpus_allowed_ptr(action->thread, cpumask);
91 action = action->next;
96 * irq_set_affinity - Set the irq affinity of a given irq
97 * @irq: Interrupt to set affinity
101 int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
103 struct irq_desc *desc = irq_to_desc(irq);
106 if (!desc->chip->set_affinity)
109 spin_lock_irqsave(&desc->lock, flags);
111 #ifdef CONFIG_GENERIC_PENDING_IRQ
112 if (desc->status & IRQ_MOVE_PCNTXT) {
113 if (!desc->chip->set_affinity(irq, cpumask)) {
114 cpumask_copy(desc->affinity, cpumask);
115 irq_set_thread_affinity(desc, cpumask);
119 desc->status |= IRQ_MOVE_PENDING;
120 cpumask_copy(desc->pending_mask, cpumask);
123 if (!desc->chip->set_affinity(irq, cpumask)) {
124 cpumask_copy(desc->affinity, cpumask);
125 irq_set_thread_affinity(desc, cpumask);
128 desc->status |= IRQ_AFFINITY_SET;
129 spin_unlock_irqrestore(&desc->lock, flags);
133 #ifndef CONFIG_AUTO_IRQ_AFFINITY
135 * Generic version of the affinity autoselector.
137 static int setup_affinity(unsigned int irq, struct irq_desc *desc)
139 if (!irq_can_set_affinity(irq))
143 * Preserve an userspace affinity setup, but make sure that
144 * one of the targets is online.
146 if (desc->status & (IRQ_AFFINITY_SET | IRQ_NO_BALANCING)) {
147 if (cpumask_any_and(desc->affinity, cpu_online_mask)
151 desc->status &= ~IRQ_AFFINITY_SET;
154 cpumask_and(desc->affinity, cpu_online_mask, irq_default_affinity);
156 desc->chip->set_affinity(irq, desc->affinity);
161 static inline int setup_affinity(unsigned int irq, struct irq_desc *d)
163 return irq_select_affinity(irq);
168 * Called when affinity is set via /proc/irq
170 int irq_select_affinity_usr(unsigned int irq)
172 struct irq_desc *desc = irq_to_desc(irq);
176 spin_lock_irqsave(&desc->lock, flags);
177 ret = setup_affinity(irq, desc);
179 irq_set_thread_affinity(desc, desc->affinity);
180 spin_unlock_irqrestore(&desc->lock, flags);
186 static inline int setup_affinity(unsigned int irq, struct irq_desc *desc)
192 void __disable_irq(struct irq_desc *desc, unsigned int irq, bool suspend)
195 if (!desc->action || (desc->action->flags & IRQF_TIMER))
197 desc->status |= IRQ_SUSPENDED;
200 if (!desc->depth++) {
201 desc->status |= IRQ_DISABLED;
202 desc->chip->disable(irq);
207 * disable_irq_nosync - disable an irq without waiting
208 * @irq: Interrupt to disable
210 * Disable the selected interrupt line. Disables and Enables are
212 * Unlike disable_irq(), this function does not ensure existing
213 * instances of the IRQ handler have completed before returning.
215 * This function may be called from IRQ context.
217 void disable_irq_nosync(unsigned int irq)
219 struct irq_desc *desc = irq_to_desc(irq);
225 spin_lock_irqsave(&desc->lock, flags);
226 __disable_irq(desc, irq, false);
227 spin_unlock_irqrestore(&desc->lock, flags);
229 EXPORT_SYMBOL(disable_irq_nosync);
232 * disable_irq - disable an irq and wait for completion
233 * @irq: Interrupt to disable
235 * Disable the selected interrupt line. Enables and Disables are
237 * This function waits for any pending IRQ handlers for this interrupt
238 * to complete before returning. If you use this function while
239 * holding a resource the IRQ handler may need you will deadlock.
241 * This function may be called - with care - from IRQ context.
243 void disable_irq(unsigned int irq)
245 struct irq_desc *desc = irq_to_desc(irq);
250 disable_irq_nosync(irq);
252 synchronize_irq(irq);
254 EXPORT_SYMBOL(disable_irq);
256 void __enable_irq(struct irq_desc *desc, unsigned int irq, bool resume)
259 desc->status &= ~IRQ_SUSPENDED;
261 switch (desc->depth) {
264 WARN(1, KERN_WARNING "Unbalanced enable for IRQ %d\n", irq);
267 unsigned int status = desc->status & ~IRQ_DISABLED;
269 if (desc->status & IRQ_SUSPENDED)
271 /* Prevent probing on this irq: */
272 desc->status = status | IRQ_NOPROBE;
273 check_irq_resend(desc, irq);
282 * enable_irq - enable handling of an irq
283 * @irq: Interrupt to enable
285 * Undoes the effect of one call to disable_irq(). If this
286 * matches the last disable, processing of interrupts on this
287 * IRQ line is re-enabled.
289 * This function may be called from IRQ context.
291 void enable_irq(unsigned int irq)
293 struct irq_desc *desc = irq_to_desc(irq);
299 spin_lock_irqsave(&desc->lock, flags);
300 __enable_irq(desc, irq, false);
301 spin_unlock_irqrestore(&desc->lock, flags);
303 EXPORT_SYMBOL(enable_irq);
305 static int set_irq_wake_real(unsigned int irq, unsigned int on)
307 struct irq_desc *desc = irq_to_desc(irq);
310 if (desc->chip->set_wake)
311 ret = desc->chip->set_wake(irq, on);
317 * set_irq_wake - control irq power management wakeup
318 * @irq: interrupt to control
319 * @on: enable/disable power management wakeup
321 * Enable/disable power management wakeup mode, which is
322 * disabled by default. Enables and disables must match,
323 * just as they match for non-wakeup mode support.
325 * Wakeup mode lets this IRQ wake the system from sleep
326 * states like "suspend to RAM".
328 int set_irq_wake(unsigned int irq, unsigned int on)
330 struct irq_desc *desc = irq_to_desc(irq);
334 /* wakeup-capable irqs can be shared between drivers that
335 * don't need to have the same sleep mode behaviors.
337 spin_lock_irqsave(&desc->lock, flags);
339 if (desc->wake_depth++ == 0) {
340 ret = set_irq_wake_real(irq, on);
342 desc->wake_depth = 0;
344 desc->status |= IRQ_WAKEUP;
347 if (desc->wake_depth == 0) {
348 WARN(1, "Unbalanced IRQ %d wake disable\n", irq);
349 } else if (--desc->wake_depth == 0) {
350 ret = set_irq_wake_real(irq, on);
352 desc->wake_depth = 1;
354 desc->status &= ~IRQ_WAKEUP;
358 spin_unlock_irqrestore(&desc->lock, flags);
361 EXPORT_SYMBOL(set_irq_wake);
364 * Internal function that tells the architecture code whether a
365 * particular irq has been exclusively allocated or is available
368 int can_request_irq(unsigned int irq, unsigned long irqflags)
370 struct irq_desc *desc = irq_to_desc(irq);
371 struct irqaction *action;
376 if (desc->status & IRQ_NOREQUEST)
379 action = desc->action;
381 if (irqflags & action->flags & IRQF_SHARED)
387 void compat_irq_chip_set_default_handler(struct irq_desc *desc)
390 * If the architecture still has not overriden
391 * the flow handler then zap the default. This
392 * should catch incorrect flow-type setting.
394 if (desc->handle_irq == &handle_bad_irq)
395 desc->handle_irq = NULL;
398 int __irq_set_trigger(struct irq_desc *desc, unsigned int irq,
402 struct irq_chip *chip = desc->chip;
404 if (!chip || !chip->set_type) {
406 * IRQF_TRIGGER_* but the PIC does not support multiple
409 pr_debug("No set_type function for IRQ %d (%s)\n", irq,
410 chip ? (chip->name ? : "unknown") : "unknown");
414 /* caller masked out all except trigger mode flags */
415 ret = chip->set_type(irq, flags);
418 pr_err("setting trigger mode %d for irq %u failed (%pF)\n",
419 (int)flags, irq, chip->set_type);
421 if (flags & (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH))
423 /* note that IRQF_TRIGGER_MASK == IRQ_TYPE_SENSE_MASK */
424 desc->status &= ~(IRQ_LEVEL | IRQ_TYPE_SENSE_MASK);
425 desc->status |= flags;
431 static int irq_wait_for_interrupt(struct irqaction *action)
433 while (!kthread_should_stop()) {
434 set_current_state(TASK_INTERRUPTIBLE);
436 if (test_and_clear_bit(IRQTF_RUNTHREAD,
437 &action->thread_flags)) {
438 __set_current_state(TASK_RUNNING);
447 * Interrupt handler thread
449 static int irq_thread(void *data)
451 struct sched_param param = { .sched_priority = MAX_USER_RT_PRIO/2, };
452 struct irqaction *action = data;
453 struct irq_desc *desc = irq_to_desc(action->irq);
456 sched_setscheduler(current, SCHED_FIFO, ¶m);
457 current->irqaction = action;
459 while (!irq_wait_for_interrupt(action)) {
461 atomic_inc(&desc->threads_active);
463 spin_lock_irq(&desc->lock);
464 if (unlikely(desc->status & IRQ_DISABLED)) {
466 * CHECKME: We might need a dedicated
467 * IRQ_THREAD_PENDING flag here, which
468 * retriggers the thread in check_irq_resend()
469 * but AFAICT IRQ_PENDING should be fine as it
470 * retriggers the interrupt itself --- tglx
472 desc->status |= IRQ_PENDING;
473 spin_unlock_irq(&desc->lock);
475 spin_unlock_irq(&desc->lock);
477 action->thread_fn(action->irq, action->dev_id);
480 wake = atomic_dec_and_test(&desc->threads_active);
482 if (wake && waitqueue_active(&desc->wait_for_threads))
483 wake_up(&desc->wait_for_threads);
487 * Clear irqaction. Otherwise exit_irq_thread() would make
488 * fuzz about an active irq thread going into nirvana.
490 current->irqaction = NULL;
495 * Called from do_exit()
497 void exit_irq_thread(void)
499 struct task_struct *tsk = current;
505 "exiting task \"%s\" (%d) is an active IRQ thread (irq %d)\n",
506 tsk->comm ? tsk->comm : "", tsk->pid, tsk->irqaction->irq);
509 * Set the THREAD DIED flag to prevent further wakeups of the
510 * soon to be gone threaded handler.
512 set_bit(IRQTF_DIED, &tsk->irqaction->flags);
516 * Internal function to register an irqaction - typically used to
517 * allocate special interrupts that are part of the architecture.
520 __setup_irq(unsigned int irq, struct irq_desc *desc, struct irqaction *new)
522 struct irqaction *old, **old_ptr;
523 const char *old_name = NULL;
531 if (desc->chip == &no_irq_chip)
534 * Some drivers like serial.c use request_irq() heavily,
535 * so we have to be careful not to interfere with a
538 if (new->flags & IRQF_SAMPLE_RANDOM) {
540 * This function might sleep, we want to call it first,
541 * outside of the atomic block.
542 * Yes, this might clear the entropy pool if the wrong
543 * driver is attempted to be loaded, without actually
544 * installing a new handler, but is this really a problem,
545 * only the sysadmin is able to do this.
547 rand_initialize_irq(irq);
553 if (new->thread_fn) {
554 struct task_struct *t;
556 t = kthread_create(irq_thread, new, "irq/%d-%s", irq,
561 * We keep the reference to the task struct even if
562 * the thread dies to avoid that the interrupt code
563 * references an already freed task_struct.
571 * The following block of code has to be executed atomically
573 spin_lock_irqsave(&desc->lock, flags);
574 old_ptr = &desc->action;
578 * Can't share interrupts unless both agree to and are
579 * the same type (level, edge, polarity). So both flag
580 * fields must have IRQF_SHARED set and the bits which
581 * set the trigger type must match.
583 if (!((old->flags & new->flags) & IRQF_SHARED) ||
584 ((old->flags ^ new->flags) & IRQF_TRIGGER_MASK)) {
585 old_name = old->name;
589 #if defined(CONFIG_IRQ_PER_CPU)
590 /* All handlers must agree on per-cpuness */
591 if ((old->flags & IRQF_PERCPU) !=
592 (new->flags & IRQF_PERCPU))
596 /* add new interrupt at end of irq queue */
598 old_ptr = &old->next;
605 irq_chip_set_defaults(desc->chip);
607 init_waitqueue_head(&desc->wait_for_threads);
609 /* Setup the type (level, edge polarity) if configured: */
610 if (new->flags & IRQF_TRIGGER_MASK) {
611 ret = __irq_set_trigger(desc, irq,
612 new->flags & IRQF_TRIGGER_MASK);
617 compat_irq_chip_set_default_handler(desc);
618 #if defined(CONFIG_IRQ_PER_CPU)
619 if (new->flags & IRQF_PERCPU)
620 desc->status |= IRQ_PER_CPU;
623 desc->status &= ~(IRQ_AUTODETECT | IRQ_WAITING |
624 IRQ_INPROGRESS | IRQ_SPURIOUS_DISABLED);
626 if (!(desc->status & IRQ_NOAUTOEN)) {
628 desc->status &= ~IRQ_DISABLED;
629 desc->chip->startup(irq);
631 /* Undo nested disables: */
634 /* Exclude IRQ from balancing if requested */
635 if (new->flags & IRQF_NOBALANCING)
636 desc->status |= IRQ_NO_BALANCING;
638 /* Set default affinity mask once everything is setup */
639 setup_affinity(irq, desc);
641 } else if ((new->flags & IRQF_TRIGGER_MASK)
642 && (new->flags & IRQF_TRIGGER_MASK)
643 != (desc->status & IRQ_TYPE_SENSE_MASK)) {
644 /* hope the handler works with the actual trigger mode... */
645 pr_warning("IRQ %d uses trigger mode %d; requested %d\n",
646 irq, (int)(desc->status & IRQ_TYPE_SENSE_MASK),
647 (int)(new->flags & IRQF_TRIGGER_MASK));
652 /* Reset broken irq detection when installing new handler */
654 desc->irqs_unhandled = 0;
657 * Check whether we disabled the irq via the spurious handler
658 * before. Reenable it and give it another chance.
660 if (shared && (desc->status & IRQ_SPURIOUS_DISABLED)) {
661 desc->status &= ~IRQ_SPURIOUS_DISABLED;
662 __enable_irq(desc, irq, false);
665 spin_unlock_irqrestore(&desc->lock, flags);
668 register_irq_proc(irq, desc);
670 register_handler_proc(irq, new);
675 #ifdef CONFIG_DEBUG_SHIRQ
676 if (!(new->flags & IRQF_PROBE_SHARED)) {
677 printk(KERN_ERR "IRQ handler type mismatch for IRQ %d\n", irq);
679 printk(KERN_ERR "current handler: %s\n", old_name);
686 spin_unlock_irqrestore(&desc->lock, flags);
688 struct task_struct *t = new->thread;
691 if (likely(!test_bit(IRQTF_DIED, &new->thread_flags)))
699 * setup_irq - setup an interrupt
700 * @irq: Interrupt line to setup
701 * @act: irqaction for the interrupt
703 * Used to statically setup interrupts in the early boot process.
705 int setup_irq(unsigned int irq, struct irqaction *act)
707 struct irq_desc *desc = irq_to_desc(irq);
709 return __setup_irq(irq, desc, act);
711 EXPORT_SYMBOL_GPL(setup_irq);
714 * Internal function to unregister an irqaction - used to free
715 * regular and special interrupts that are part of the architecture.
717 static struct irqaction *__free_irq(unsigned int irq, void *dev_id)
719 struct irq_desc *desc = irq_to_desc(irq);
720 struct irqaction *action, **action_ptr;
721 struct task_struct *irqthread;
724 WARN(in_interrupt(), "Trying to free IRQ %d from IRQ context!\n", irq);
729 spin_lock_irqsave(&desc->lock, flags);
732 * There can be multiple actions per IRQ descriptor, find the right
733 * one based on the dev_id:
735 action_ptr = &desc->action;
737 action = *action_ptr;
740 WARN(1, "Trying to free already-free IRQ %d\n", irq);
741 spin_unlock_irqrestore(&desc->lock, flags);
746 if (action->dev_id == dev_id)
748 action_ptr = &action->next;
751 /* Found it - now remove it from the list of entries: */
752 *action_ptr = action->next;
754 /* Currently used only by UML, might disappear one day: */
755 #ifdef CONFIG_IRQ_RELEASE_METHOD
756 if (desc->chip->release)
757 desc->chip->release(irq, dev_id);
760 /* If this was the last handler, shut down the IRQ line: */
762 desc->status |= IRQ_DISABLED;
763 if (desc->chip->shutdown)
764 desc->chip->shutdown(irq);
766 desc->chip->disable(irq);
769 irqthread = action->thread;
770 action->thread = NULL;
772 spin_unlock_irqrestore(&desc->lock, flags);
774 unregister_handler_proc(irq, action);
776 /* Make sure it's not being used on another CPU: */
777 synchronize_irq(irq);
780 if (!test_bit(IRQTF_DIED, &action->thread_flags))
781 kthread_stop(irqthread);
782 put_task_struct(irqthread);
785 #ifdef CONFIG_DEBUG_SHIRQ
787 * It's a shared IRQ -- the driver ought to be prepared for an IRQ
788 * event to happen even now it's being freed, so let's make sure that
789 * is so by doing an extra call to the handler ....
791 * ( We do this after actually deregistering it, to make sure that a
792 * 'real' IRQ doesn't run in * parallel with our fake. )
794 if (action->flags & IRQF_SHARED) {
795 local_irq_save(flags);
796 action->handler(irq, dev_id);
797 local_irq_restore(flags);
804 * remove_irq - free an interrupt
805 * @irq: Interrupt line to free
806 * @act: irqaction for the interrupt
808 * Used to remove interrupts statically setup by the early boot process.
810 void remove_irq(unsigned int irq, struct irqaction *act)
812 __free_irq(irq, act->dev_id);
814 EXPORT_SYMBOL_GPL(remove_irq);
817 * free_irq - free an interrupt allocated with request_irq
818 * @irq: Interrupt line to free
819 * @dev_id: Device identity to free
821 * Remove an interrupt handler. The handler is removed and if the
822 * interrupt line is no longer in use by any driver it is disabled.
823 * On a shared IRQ the caller must ensure the interrupt is disabled
824 * on the card it drives before calling this function. The function
825 * does not return until any executing interrupts for this IRQ
828 * This function must not be called from interrupt context.
830 void free_irq(unsigned int irq, void *dev_id)
832 kfree(__free_irq(irq, dev_id));
834 EXPORT_SYMBOL(free_irq);
837 * request_threaded_irq - allocate an interrupt line
838 * @irq: Interrupt line to allocate
839 * @handler: Function to be called when the IRQ occurs.
840 * Primary handler for threaded interrupts
841 * @thread_fn: Function called from the irq handler thread
842 * If NULL, no irq thread is created
843 * @irqflags: Interrupt type flags
844 * @devname: An ascii name for the claiming device
845 * @dev_id: A cookie passed back to the handler function
847 * This call allocates interrupt resources and enables the
848 * interrupt line and IRQ handling. From the point this
849 * call is made your handler function may be invoked. Since
850 * your handler function must clear any interrupt the board
851 * raises, you must take care both to initialise your hardware
852 * and to set up the interrupt handler in the right order.
854 * If you want to set up a threaded irq handler for your device
855 * then you need to supply @handler and @thread_fn. @handler ist
856 * still called in hard interrupt context and has to check
857 * whether the interrupt originates from the device. If yes it
858 * needs to disable the interrupt on the device and return
859 * IRQ_THREAD_WAKE which will wake up the handler thread and run
860 * @thread_fn. This split handler design is necessary to support
863 * Dev_id must be globally unique. Normally the address of the
864 * device data structure is used as the cookie. Since the handler
865 * receives this value it makes sense to use it.
867 * If your interrupt is shared you must pass a non NULL dev_id
868 * as this is required when freeing the interrupt.
872 * IRQF_SHARED Interrupt is shared
873 * IRQF_DISABLED Disable local interrupts while processing
874 * IRQF_SAMPLE_RANDOM The interrupt can be used for entropy
875 * IRQF_TRIGGER_* Specify active edge(s) or level
878 int request_threaded_irq(unsigned int irq, irq_handler_t handler,
879 irq_handler_t thread_fn, unsigned long irqflags,
880 const char *devname, void *dev_id)
882 struct irqaction *action;
883 struct irq_desc *desc;
887 * handle_IRQ_event() always ignores IRQF_DISABLED except for
888 * the _first_ irqaction (sigh). That can cause oopsing, but
889 * the behavior is classified as "will not fix" so we need to
890 * start nudging drivers away from using that idiom.
892 if ((irqflags & (IRQF_SHARED|IRQF_DISABLED)) ==
893 (IRQF_SHARED|IRQF_DISABLED)) {
895 "IRQ %d/%s: IRQF_DISABLED is not guaranteed on shared IRQs\n",
899 #ifdef CONFIG_LOCKDEP
901 * Lockdep wants atomic interrupt handlers:
903 irqflags |= IRQF_DISABLED;
906 * Sanity-check: shared interrupts must pass in a real dev-ID,
907 * otherwise we'll have trouble later trying to figure out
908 * which interrupt is which (messes up the interrupt freeing
911 if ((irqflags & IRQF_SHARED) && !dev_id)
914 desc = irq_to_desc(irq);
918 if (desc->status & IRQ_NOREQUEST)
923 action = kzalloc(sizeof(struct irqaction), GFP_KERNEL);
927 action->handler = handler;
928 action->thread_fn = thread_fn;
929 action->flags = irqflags;
930 action->name = devname;
931 action->dev_id = dev_id;
933 retval = __setup_irq(irq, desc, action);
937 #ifdef CONFIG_DEBUG_SHIRQ
938 if (irqflags & IRQF_SHARED) {
940 * It's a shared IRQ -- the driver ought to be prepared for it
941 * to happen immediately, so let's make sure....
942 * We disable the irq to make sure that a 'real' IRQ doesn't
943 * run in parallel with our fake.
948 local_irq_save(flags);
950 handler(irq, dev_id);
952 local_irq_restore(flags);
958 EXPORT_SYMBOL(request_threaded_irq);