76c8eda67295ceaafec8a38cc398b53057495350
[linux-2.6.git] / kernel / irq / manage.c
1 /*
2  * linux/kernel/irq/manage.c
3  *
4  * Copyright (C) 1992, 1998-2004 Linus Torvalds, Ingo Molnar
5  *
6  * This file contains driver APIs to the irq subsystem.
7  */
8
9 #include <linux/config.h>
10 #include <linux/irq.h>
11 #include <linux/module.h>
12 #include <linux/random.h>
13 #include <linux/interrupt.h>
14
15 #include "internals.h"
16
17 #ifdef CONFIG_SMP
18
19 /**
20  *      synchronize_irq - wait for pending IRQ handlers (on other CPUs)
21  *      @irq: interrupt number to wait for
22  *
23  *      This function waits for any pending IRQ handlers for this interrupt
24  *      to complete before returning. If you use this function while
25  *      holding a resource the IRQ handler may need you will deadlock.
26  *
27  *      This function may be called - with care - from IRQ context.
28  */
29 void synchronize_irq(unsigned int irq)
30 {
31         struct irq_desc *desc = irq_desc + irq;
32
33         if (irq >= NR_IRQS)
34                 return;
35
36         while (desc->status & IRQ_INPROGRESS)
37                 cpu_relax();
38 }
39 EXPORT_SYMBOL(synchronize_irq);
40
41 #endif
42
43 /**
44  *      disable_irq_nosync - disable an irq without waiting
45  *      @irq: Interrupt to disable
46  *
47  *      Disable the selected interrupt line.  Disables and Enables are
48  *      nested.
49  *      Unlike disable_irq(), this function does not ensure existing
50  *      instances of the IRQ handler have completed before returning.
51  *
52  *      This function may be called from IRQ context.
53  */
54 void disable_irq_nosync(unsigned int irq)
55 {
56         struct irq_desc *desc = irq_desc + irq;
57         unsigned long flags;
58
59         if (irq >= NR_IRQS)
60                 return;
61
62         spin_lock_irqsave(&desc->lock, flags);
63         if (!desc->depth++) {
64                 desc->status |= IRQ_DISABLED;
65                 desc->chip->disable(irq);
66         }
67         spin_unlock_irqrestore(&desc->lock, flags);
68 }
69 EXPORT_SYMBOL(disable_irq_nosync);
70
71 /**
72  *      disable_irq - disable an irq and wait for completion
73  *      @irq: Interrupt to disable
74  *
75  *      Disable the selected interrupt line.  Enables and Disables are
76  *      nested.
77  *      This function waits for any pending IRQ handlers for this interrupt
78  *      to complete before returning. If you use this function while
79  *      holding a resource the IRQ handler may need you will deadlock.
80  *
81  *      This function may be called - with care - from IRQ context.
82  */
83 void disable_irq(unsigned int irq)
84 {
85         struct irq_desc *desc = irq_desc + irq;
86
87         if (irq >= NR_IRQS)
88                 return;
89
90         disable_irq_nosync(irq);
91         if (desc->action)
92                 synchronize_irq(irq);
93 }
94 EXPORT_SYMBOL(disable_irq);
95
96 /**
97  *      enable_irq - enable handling of an irq
98  *      @irq: Interrupt to enable
99  *
100  *      Undoes the effect of one call to disable_irq().  If this
101  *      matches the last disable, processing of interrupts on this
102  *      IRQ line is re-enabled.
103  *
104  *      This function may be called from IRQ context.
105  */
106 void enable_irq(unsigned int irq)
107 {
108         struct irq_desc *desc = irq_desc + irq;
109         unsigned long flags;
110
111         if (irq >= NR_IRQS)
112                 return;
113
114         spin_lock_irqsave(&desc->lock, flags);
115         switch (desc->depth) {
116         case 0:
117                 printk(KERN_WARNING "Unablanced enable_irq(%d)\n", irq);
118                 WARN_ON(1);
119                 break;
120         case 1: {
121                 unsigned int status = desc->status & ~IRQ_DISABLED;
122
123                 desc->status = status;
124                 if ((status & (IRQ_PENDING | IRQ_REPLAY)) == IRQ_PENDING) {
125                         desc->status = status | IRQ_REPLAY;
126                         hw_resend_irq(desc->chip,irq);
127                 }
128                 desc->chip->enable(irq);
129                 /* fall-through */
130         }
131         default:
132                 desc->depth--;
133         }
134         spin_unlock_irqrestore(&desc->lock, flags);
135 }
136 EXPORT_SYMBOL(enable_irq);
137
138 /*
139  * Internal function that tells the architecture code whether a
140  * particular irq has been exclusively allocated or is available
141  * for driver use.
142  */
143 int can_request_irq(unsigned int irq, unsigned long irqflags)
144 {
145         struct irqaction *action;
146
147         if (irq >= NR_IRQS)
148                 return 0;
149
150         action = irq_desc[irq].action;
151         if (action)
152                 if (irqflags & action->flags & SA_SHIRQ)
153                         action = NULL;
154
155         return !action;
156 }
157
158 /*
159  * Internal function to register an irqaction - typically used to
160  * allocate special interrupts that are part of the architecture.
161  */
162 int setup_irq(unsigned int irq, struct irqaction *new)
163 {
164         struct irq_desc *desc = irq_desc + irq;
165         struct irqaction *old, **p;
166         unsigned long flags;
167         int shared = 0;
168
169         if (irq >= NR_IRQS)
170                 return -EINVAL;
171
172         if (desc->chip == &no_irq_type)
173                 return -ENOSYS;
174         /*
175          * Some drivers like serial.c use request_irq() heavily,
176          * so we have to be careful not to interfere with a
177          * running system.
178          */
179         if (new->flags & SA_SAMPLE_RANDOM) {
180                 /*
181                  * This function might sleep, we want to call it first,
182                  * outside of the atomic block.
183                  * Yes, this might clear the entropy pool if the wrong
184                  * driver is attempted to be loaded, without actually
185                  * installing a new handler, but is this really a problem,
186                  * only the sysadmin is able to do this.
187                  */
188                 rand_initialize_irq(irq);
189         }
190
191         /*
192          * The following block of code has to be executed atomically
193          */
194         spin_lock_irqsave(&desc->lock, flags);
195         p = &desc->action;
196         old = *p;
197         if (old) {
198                 /* Can't share interrupts unless both agree to */
199                 if (!(old->flags & new->flags & SA_SHIRQ))
200                         goto mismatch;
201
202 #if defined(CONFIG_IRQ_PER_CPU) && defined(SA_PERCPU_IRQ)
203                 /* All handlers must agree on per-cpuness */
204                 if ((old->flags & IRQ_PER_CPU) != (new->flags & IRQ_PER_CPU))
205                         goto mismatch;
206 #endif
207
208                 /* add new interrupt at end of irq queue */
209                 do {
210                         p = &old->next;
211                         old = *p;
212                 } while (old);
213                 shared = 1;
214         }
215
216         *p = new;
217 #if defined(CONFIG_IRQ_PER_CPU) && defined(SA_PERCPU_IRQ)
218         if (new->flags & SA_PERCPU_IRQ)
219                 desc->status |= IRQ_PER_CPU;
220 #endif
221         if (!shared) {
222                 desc->depth = 0;
223                 desc->status &= ~(IRQ_DISABLED | IRQ_AUTODETECT |
224                                   IRQ_WAITING | IRQ_INPROGRESS);
225                 if (desc->chip->startup)
226                         desc->chip->startup(irq);
227                 else
228                         desc->chip->enable(irq);
229         }
230         spin_unlock_irqrestore(&desc->lock, flags);
231
232         new->irq = irq;
233         register_irq_proc(irq);
234         new->dir = NULL;
235         register_handler_proc(irq, new);
236
237         return 0;
238
239 mismatch:
240         spin_unlock_irqrestore(&desc->lock, flags);
241         if (!(new->flags & SA_PROBEIRQ)) {
242                 printk(KERN_ERR "%s: irq handler mismatch\n", __FUNCTION__);
243                 dump_stack();
244         }
245         return -EBUSY;
246 }
247
248 /**
249  *      free_irq - free an interrupt
250  *      @irq: Interrupt line to free
251  *      @dev_id: Device identity to free
252  *
253  *      Remove an interrupt handler. The handler is removed and if the
254  *      interrupt line is no longer in use by any driver it is disabled.
255  *      On a shared IRQ the caller must ensure the interrupt is disabled
256  *      on the card it drives before calling this function. The function
257  *      does not return until any executing interrupts for this IRQ
258  *      have completed.
259  *
260  *      This function must not be called from interrupt context.
261  */
262 void free_irq(unsigned int irq, void *dev_id)
263 {
264         struct irq_desc *desc;
265         struct irqaction **p;
266         unsigned long flags;
267
268         WARN_ON(in_interrupt());
269         if (irq >= NR_IRQS)
270                 return;
271
272         desc = irq_desc + irq;
273         spin_lock_irqsave(&desc->lock, flags);
274         p = &desc->action;
275         for (;;) {
276                 struct irqaction *action = *p;
277
278                 if (action) {
279                         struct irqaction **pp = p;
280
281                         p = &action->next;
282                         if (action->dev_id != dev_id)
283                                 continue;
284
285                         /* Found it - now remove it from the list of entries */
286                         *pp = action->next;
287
288                         /* Currently used only by UML, might disappear one day.*/
289 #ifdef CONFIG_IRQ_RELEASE_METHOD
290                         if (desc->chip->release)
291                                 desc->chip->release(irq, dev_id);
292 #endif
293
294                         if (!desc->action) {
295                                 desc->status |= IRQ_DISABLED;
296                                 if (desc->chip->shutdown)
297                                         desc->chip->shutdown(irq);
298                                 else
299                                         desc->chip->disable(irq);
300                         }
301                         spin_unlock_irqrestore(&desc->lock, flags);
302                         unregister_handler_proc(irq, action);
303
304                         /* Make sure it's not being used on another CPU */
305                         synchronize_irq(irq);
306                         kfree(action);
307                         return;
308                 }
309                 printk(KERN_ERR "Trying to free free IRQ%d\n", irq);
310                 spin_unlock_irqrestore(&desc->lock, flags);
311                 return;
312         }
313 }
314 EXPORT_SYMBOL(free_irq);
315
316 /**
317  *      request_irq - allocate an interrupt line
318  *      @irq: Interrupt line to allocate
319  *      @handler: Function to be called when the IRQ occurs
320  *      @irqflags: Interrupt type flags
321  *      @devname: An ascii name for the claiming device
322  *      @dev_id: A cookie passed back to the handler function
323  *
324  *      This call allocates interrupt resources and enables the
325  *      interrupt line and IRQ handling. From the point this
326  *      call is made your handler function may be invoked. Since
327  *      your handler function must clear any interrupt the board
328  *      raises, you must take care both to initialise your hardware
329  *      and to set up the interrupt handler in the right order.
330  *
331  *      Dev_id must be globally unique. Normally the address of the
332  *      device data structure is used as the cookie. Since the handler
333  *      receives this value it makes sense to use it.
334  *
335  *      If your interrupt is shared you must pass a non NULL dev_id
336  *      as this is required when freeing the interrupt.
337  *
338  *      Flags:
339  *
340  *      SA_SHIRQ                Interrupt is shared
341  *      SA_INTERRUPT            Disable local interrupts while processing
342  *      SA_SAMPLE_RANDOM        The interrupt can be used for entropy
343  *
344  */
345 int request_irq(unsigned int irq,
346                 irqreturn_t (*handler)(int, void *, struct pt_regs *),
347                 unsigned long irqflags, const char *devname, void *dev_id)
348 {
349         struct irqaction *action;
350         int retval;
351
352         /*
353          * Sanity-check: shared interrupts must pass in a real dev-ID,
354          * otherwise we'll have trouble later trying to figure out
355          * which interrupt is which (messes up the interrupt freeing
356          * logic etc).
357          */
358         if ((irqflags & SA_SHIRQ) && !dev_id)
359                 return -EINVAL;
360         if (irq >= NR_IRQS)
361                 return -EINVAL;
362         if (!handler)
363                 return -EINVAL;
364
365         action = kmalloc(sizeof(struct irqaction), GFP_ATOMIC);
366         if (!action)
367                 return -ENOMEM;
368
369         action->handler = handler;
370         action->flags = irqflags;
371         cpus_clear(action->mask);
372         action->name = devname;
373         action->next = NULL;
374         action->dev_id = dev_id;
375
376         select_smp_affinity(irq);
377
378         retval = setup_irq(irq, action);
379         if (retval)
380                 kfree(action);
381
382         return retval;
383 }
384 EXPORT_SYMBOL(request_irq);
385