genirq: Provide !SMP stub for irq_set_affinity_notifier()
[firefly-linux-kernel-4.4.55.git] / include / linux / interrupt.h
1 /* interrupt.h */
2 #ifndef _LINUX_INTERRUPT_H
3 #define _LINUX_INTERRUPT_H
4
5 #include <linux/kernel.h>
6 #include <linux/linkage.h>
7 #include <linux/bitops.h>
8 #include <linux/preempt.h>
9 #include <linux/cpumask.h>
10 #include <linux/irqreturn.h>
11 #include <linux/irqnr.h>
12 #include <linux/hardirq.h>
13 #include <linux/irqflags.h>
14 #include <linux/hrtimer.h>
15 #include <linux/kref.h>
16 #include <linux/workqueue.h>
17
18 #include <linux/atomic.h>
19 #include <asm/ptrace.h>
20 #include <asm/irq.h>
21
22 /*
23  * These correspond to the IORESOURCE_IRQ_* defines in
24  * linux/ioport.h to select the interrupt line behaviour.  When
25  * requesting an interrupt without specifying a IRQF_TRIGGER, the
26  * setting should be assumed to be "as already configured", which
27  * may be as per machine or firmware initialisation.
28  */
29 #define IRQF_TRIGGER_NONE       0x00000000
30 #define IRQF_TRIGGER_RISING     0x00000001
31 #define IRQF_TRIGGER_FALLING    0x00000002
32 #define IRQF_TRIGGER_HIGH       0x00000004
33 #define IRQF_TRIGGER_LOW        0x00000008
34 #define IRQF_TRIGGER_MASK       (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
35                                  IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
36 #define IRQF_TRIGGER_PROBE      0x00000010
37
38 /*
39  * These flags used only by the kernel as part of the
40  * irq handling routines.
41  *
42  * IRQF_DISABLED - keep irqs disabled when calling the action handler.
43  *                 DEPRECATED. This flag is a NOOP and scheduled to be removed
44  * IRQF_SHARED - allow sharing the irq among several devices
45  * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
46  * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
47  * IRQF_PERCPU - Interrupt is per cpu
48  * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
49  * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
50  *                registered first in an shared interrupt is considered for
51  *                performance reasons)
52  * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
53  *                Used by threaded interrupts which need to keep the
54  *                irq line disabled until the threaded handler has been run.
55  * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
56  * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
57  * IRQF_NO_THREAD - Interrupt cannot be threaded
58  * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
59  *                resume time.
60  */
61 #define IRQF_DISABLED           0x00000020
62 #define IRQF_SHARED             0x00000080
63 #define IRQF_PROBE_SHARED       0x00000100
64 #define __IRQF_TIMER            0x00000200
65 #define IRQF_PERCPU             0x00000400
66 #define IRQF_NOBALANCING        0x00000800
67 #define IRQF_IRQPOLL            0x00001000
68 #define IRQF_ONESHOT            0x00002000
69 #define IRQF_NO_SUSPEND         0x00004000
70 #define IRQF_FORCE_RESUME       0x00008000
71 #define IRQF_NO_THREAD          0x00010000
72 #define IRQF_EARLY_RESUME       0x00020000
73
74 #define IRQF_TIMER              (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
75
76 /*
77  * These values can be returned by request_any_context_irq() and
78  * describe the context the interrupt will be run in.
79  *
80  * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
81  * IRQC_IS_NESTED - interrupt runs in a nested threaded context
82  */
83 enum {
84         IRQC_IS_HARDIRQ = 0,
85         IRQC_IS_NESTED,
86 };
87
88 typedef irqreturn_t (*irq_handler_t)(int, void *);
89
90 /**
91  * struct irqaction - per interrupt action descriptor
92  * @handler:    interrupt handler function
93  * @name:       name of the device
94  * @dev_id:     cookie to identify the device
95  * @percpu_dev_id:      cookie to identify the device
96  * @next:       pointer to the next irqaction for shared interrupts
97  * @irq:        interrupt number
98  * @flags:      flags (see IRQF_* above)
99  * @thread_fn:  interrupt handler function for threaded interrupts
100  * @thread:     thread pointer for threaded interrupts
101  * @thread_flags:       flags related to @thread
102  * @thread_mask:        bitmask for keeping track of @thread activity
103  * @dir:        pointer to the proc/irq/NN/name entry
104  */
105 struct irqaction {
106         irq_handler_t           handler;
107         void                    *dev_id;
108         void __percpu           *percpu_dev_id;
109         struct irqaction        *next;
110         irq_handler_t           thread_fn;
111         struct task_struct      *thread;
112         unsigned int            irq;
113         unsigned int            flags;
114         unsigned long           thread_flags;
115         unsigned long           thread_mask;
116         const char              *name;
117         struct proc_dir_entry   *dir;
118 } ____cacheline_internodealigned_in_smp;
119
120 extern irqreturn_t no_action(int cpl, void *dev_id);
121
122 extern int __must_check
123 request_threaded_irq(unsigned int irq, irq_handler_t handler,
124                      irq_handler_t thread_fn,
125                      unsigned long flags, const char *name, void *dev);
126
127 static inline int __must_check
128 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
129             const char *name, void *dev)
130 {
131         return request_threaded_irq(irq, handler, NULL, flags, name, dev);
132 }
133
134 extern int __must_check
135 request_any_context_irq(unsigned int irq, irq_handler_t handler,
136                         unsigned long flags, const char *name, void *dev_id);
137
138 extern int __must_check
139 request_percpu_irq(unsigned int irq, irq_handler_t handler,
140                    const char *devname, void __percpu *percpu_dev_id);
141
142 extern void free_irq(unsigned int, void *);
143 extern void free_percpu_irq(unsigned int, void __percpu *);
144
145 struct device;
146
147 extern int __must_check
148 devm_request_threaded_irq(struct device *dev, unsigned int irq,
149                           irq_handler_t handler, irq_handler_t thread_fn,
150                           unsigned long irqflags, const char *devname,
151                           void *dev_id);
152
153 static inline int __must_check
154 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
155                  unsigned long irqflags, const char *devname, void *dev_id)
156 {
157         return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
158                                          devname, dev_id);
159 }
160
161 extern int __must_check
162 devm_request_any_context_irq(struct device *dev, unsigned int irq,
163                  irq_handler_t handler, unsigned long irqflags,
164                  const char *devname, void *dev_id);
165
166 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
167
168 /*
169  * On lockdep we dont want to enable hardirqs in hardirq
170  * context. Use local_irq_enable_in_hardirq() to annotate
171  * kernel code that has to do this nevertheless (pretty much
172  * the only valid case is for old/broken hardware that is
173  * insanely slow).
174  *
175  * NOTE: in theory this might break fragile code that relies
176  * on hardirq delivery - in practice we dont seem to have such
177  * places left. So the only effect should be slightly increased
178  * irqs-off latencies.
179  */
180 #ifdef CONFIG_LOCKDEP
181 # define local_irq_enable_in_hardirq()  do { } while (0)
182 #else
183 # define local_irq_enable_in_hardirq()  local_irq_enable()
184 #endif
185
186 extern void disable_irq_nosync(unsigned int irq);
187 extern void disable_irq(unsigned int irq);
188 extern void disable_percpu_irq(unsigned int irq);
189 extern void enable_irq(unsigned int irq);
190 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
191 extern void irq_wake_thread(unsigned int irq, void *dev_id);
192
193 /* The following three functions are for the core kernel use only. */
194 extern void suspend_device_irqs(void);
195 extern void resume_device_irqs(void);
196 #ifdef CONFIG_PM_SLEEP
197 extern int check_wakeup_irqs(void);
198 #else
199 static inline int check_wakeup_irqs(void) { return 0; }
200 #endif
201
202 /**
203  * struct irq_affinity_notify - context for notification of IRQ affinity changes
204  * @irq:                Interrupt to which notification applies
205  * @kref:               Reference count, for internal use
206  * @work:               Work item, for internal use
207  * @notify:             Function to be called on change.  This will be
208  *                      called in process context.
209  * @release:            Function to be called on release.  This will be
210  *                      called in process context.  Once registered, the
211  *                      structure must only be freed when this function is
212  *                      called or later.
213  */
214 struct irq_affinity_notify {
215         unsigned int irq;
216         struct kref kref;
217         struct work_struct work;
218         void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
219         void (*release)(struct kref *ref);
220 };
221
222 #if defined(CONFIG_SMP)
223
224 extern cpumask_var_t irq_default_affinity;
225
226 /* Internal implementation. Use the helpers below */
227 extern int __irq_set_affinity(unsigned int irq, const struct cpumask *cpumask,
228                               bool force);
229
230 /**
231  * irq_set_affinity - Set the irq affinity of a given irq
232  * @irq:        Interrupt to set affinity
233  * @cpumask:    cpumask
234  *
235  * Fails if cpumask does not contain an online CPU
236  */
237 static inline int
238 irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
239 {
240         return __irq_set_affinity(irq, cpumask, false);
241 }
242
243 /**
244  * irq_force_affinity - Force the irq affinity of a given irq
245  * @irq:        Interrupt to set affinity
246  * @cpumask:    cpumask
247  *
248  * Same as irq_set_affinity, but without checking the mask against
249  * online cpus.
250  *
251  * Solely for low level cpu hotplug code, where we need to make per
252  * cpu interrupts affine before the cpu becomes online.
253  */
254 static inline int
255 irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
256 {
257         return __irq_set_affinity(irq, cpumask, true);
258 }
259
260 extern int irq_can_set_affinity(unsigned int irq);
261 extern int irq_select_affinity(unsigned int irq);
262
263 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
264
265 extern int
266 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
267
268 #else /* CONFIG_SMP */
269
270 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
271 {
272         return -EINVAL;
273 }
274
275 static inline int irq_can_set_affinity(unsigned int irq)
276 {
277         return 0;
278 }
279
280 static inline int irq_select_affinity(unsigned int irq)  { return 0; }
281
282 static inline int irq_set_affinity_hint(unsigned int irq,
283                                         const struct cpumask *m)
284 {
285         return -EINVAL;
286 }
287
288 static inline int
289 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
290 {
291         return 0;
292 }
293 #endif /* CONFIG_SMP */
294
295 /*
296  * Special lockdep variants of irq disabling/enabling.
297  * These should be used for locking constructs that
298  * know that a particular irq context which is disabled,
299  * and which is the only irq-context user of a lock,
300  * that it's safe to take the lock in the irq-disabled
301  * section without disabling hardirqs.
302  *
303  * On !CONFIG_LOCKDEP they are equivalent to the normal
304  * irq disable/enable methods.
305  */
306 static inline void disable_irq_nosync_lockdep(unsigned int irq)
307 {
308         disable_irq_nosync(irq);
309 #ifdef CONFIG_LOCKDEP
310         local_irq_disable();
311 #endif
312 }
313
314 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
315 {
316         disable_irq_nosync(irq);
317 #ifdef CONFIG_LOCKDEP
318         local_irq_save(*flags);
319 #endif
320 }
321
322 static inline void disable_irq_lockdep(unsigned int irq)
323 {
324         disable_irq(irq);
325 #ifdef CONFIG_LOCKDEP
326         local_irq_disable();
327 #endif
328 }
329
330 static inline void enable_irq_lockdep(unsigned int irq)
331 {
332 #ifdef CONFIG_LOCKDEP
333         local_irq_enable();
334 #endif
335         enable_irq(irq);
336 }
337
338 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
339 {
340 #ifdef CONFIG_LOCKDEP
341         local_irq_restore(*flags);
342 #endif
343         enable_irq(irq);
344 }
345
346 /* IRQ wakeup (PM) control: */
347 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
348
349 static inline int enable_irq_wake(unsigned int irq)
350 {
351         return irq_set_irq_wake(irq, 1);
352 }
353
354 static inline int disable_irq_wake(unsigned int irq)
355 {
356         return irq_set_irq_wake(irq, 0);
357 }
358
359
360 #ifdef CONFIG_IRQ_FORCED_THREADING
361 extern bool force_irqthreads;
362 #else
363 #define force_irqthreads        (0)
364 #endif
365
366 #ifndef __ARCH_SET_SOFTIRQ_PENDING
367 #define set_softirq_pending(x) (local_softirq_pending() = (x))
368 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
369 #endif
370
371 /* Some architectures might implement lazy enabling/disabling of
372  * interrupts. In some cases, such as stop_machine, we might want
373  * to ensure that after a local_irq_disable(), interrupts have
374  * really been disabled in hardware. Such architectures need to
375  * implement the following hook.
376  */
377 #ifndef hard_irq_disable
378 #define hard_irq_disable()      do { } while(0)
379 #endif
380
381 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
382    frequency threaded job scheduling. For almost all the purposes
383    tasklets are more than enough. F.e. all serial device BHs et
384    al. should be converted to tasklets, not to softirqs.
385  */
386
387 enum
388 {
389         HI_SOFTIRQ=0,
390         TIMER_SOFTIRQ,
391         NET_TX_SOFTIRQ,
392         NET_RX_SOFTIRQ,
393         BLOCK_SOFTIRQ,
394         BLOCK_IOPOLL_SOFTIRQ,
395         TASKLET_SOFTIRQ,
396         SCHED_SOFTIRQ,
397         HRTIMER_SOFTIRQ,
398         RCU_SOFTIRQ,    /* Preferable RCU should always be the last softirq */
399
400         NR_SOFTIRQS
401 };
402
403 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
404
405 /* map softirq index to softirq name. update 'softirq_to_name' in
406  * kernel/softirq.c when adding a new softirq.
407  */
408 extern const char * const softirq_to_name[NR_SOFTIRQS];
409
410 /* softirq mask and active fields moved to irq_cpustat_t in
411  * asm/hardirq.h to get better cache usage.  KAO
412  */
413
414 struct softirq_action
415 {
416         void    (*action)(struct softirq_action *);
417 };
418
419 asmlinkage void do_softirq(void);
420 asmlinkage void __do_softirq(void);
421
422 #ifdef __ARCH_HAS_DO_SOFTIRQ
423 void do_softirq_own_stack(void);
424 #else
425 static inline void do_softirq_own_stack(void)
426 {
427         __do_softirq();
428 }
429 #endif
430
431 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
432 extern void softirq_init(void);
433 extern void __raise_softirq_irqoff(unsigned int nr);
434
435 extern void raise_softirq_irqoff(unsigned int nr);
436 extern void raise_softirq(unsigned int nr);
437
438 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
439
440 static inline struct task_struct *this_cpu_ksoftirqd(void)
441 {
442         return this_cpu_read(ksoftirqd);
443 }
444
445 /* Tasklets --- multithreaded analogue of BHs.
446
447    Main feature differing them of generic softirqs: tasklet
448    is running only on one CPU simultaneously.
449
450    Main feature differing them of BHs: different tasklets
451    may be run simultaneously on different CPUs.
452
453    Properties:
454    * If tasklet_schedule() is called, then tasklet is guaranteed
455      to be executed on some cpu at least once after this.
456    * If the tasklet is already scheduled, but its execution is still not
457      started, it will be executed only once.
458    * If this tasklet is already running on another CPU (or schedule is called
459      from tasklet itself), it is rescheduled for later.
460    * Tasklet is strictly serialized wrt itself, but not
461      wrt another tasklets. If client needs some intertask synchronization,
462      he makes it with spinlocks.
463  */
464
465 struct tasklet_struct
466 {
467         struct tasklet_struct *next;
468         unsigned long state;
469         atomic_t count;
470         void (*func)(unsigned long);
471         unsigned long data;
472 };
473
474 #define DECLARE_TASKLET(name, func, data) \
475 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
476
477 #define DECLARE_TASKLET_DISABLED(name, func, data) \
478 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
479
480
481 enum
482 {
483         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
484         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
485 };
486
487 #ifdef CONFIG_SMP
488 static inline int tasklet_trylock(struct tasklet_struct *t)
489 {
490         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
491 }
492
493 static inline void tasklet_unlock(struct tasklet_struct *t)
494 {
495         smp_mb__before_clear_bit(); 
496         clear_bit(TASKLET_STATE_RUN, &(t)->state);
497 }
498
499 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
500 {
501         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
502 }
503 #else
504 #define tasklet_trylock(t) 1
505 #define tasklet_unlock_wait(t) do { } while (0)
506 #define tasklet_unlock(t) do { } while (0)
507 #endif
508
509 extern void __tasklet_schedule(struct tasklet_struct *t);
510
511 static inline void tasklet_schedule(struct tasklet_struct *t)
512 {
513         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
514                 __tasklet_schedule(t);
515 }
516
517 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
518
519 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
520 {
521         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
522                 __tasklet_hi_schedule(t);
523 }
524
525 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
526
527 /*
528  * This version avoids touching any other tasklets. Needed for kmemcheck
529  * in order not to take any page faults while enqueueing this tasklet;
530  * consider VERY carefully whether you really need this or
531  * tasklet_hi_schedule()...
532  */
533 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
534 {
535         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
536                 __tasklet_hi_schedule_first(t);
537 }
538
539
540 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
541 {
542         atomic_inc(&t->count);
543         smp_mb__after_atomic_inc();
544 }
545
546 static inline void tasklet_disable(struct tasklet_struct *t)
547 {
548         tasklet_disable_nosync(t);
549         tasklet_unlock_wait(t);
550         smp_mb();
551 }
552
553 static inline void tasklet_enable(struct tasklet_struct *t)
554 {
555         smp_mb__before_atomic_dec();
556         atomic_dec(&t->count);
557 }
558
559 static inline void tasklet_hi_enable(struct tasklet_struct *t)
560 {
561         smp_mb__before_atomic_dec();
562         atomic_dec(&t->count);
563 }
564
565 extern void tasklet_kill(struct tasklet_struct *t);
566 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
567 extern void tasklet_init(struct tasklet_struct *t,
568                          void (*func)(unsigned long), unsigned long data);
569
570 struct tasklet_hrtimer {
571         struct hrtimer          timer;
572         struct tasklet_struct   tasklet;
573         enum hrtimer_restart    (*function)(struct hrtimer *);
574 };
575
576 extern void
577 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
578                      enum hrtimer_restart (*function)(struct hrtimer *),
579                      clockid_t which_clock, enum hrtimer_mode mode);
580
581 static inline
582 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
583                           const enum hrtimer_mode mode)
584 {
585         return hrtimer_start(&ttimer->timer, time, mode);
586 }
587
588 static inline
589 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
590 {
591         hrtimer_cancel(&ttimer->timer);
592         tasklet_kill(&ttimer->tasklet);
593 }
594
595 /*
596  * Autoprobing for irqs:
597  *
598  * probe_irq_on() and probe_irq_off() provide robust primitives
599  * for accurate IRQ probing during kernel initialization.  They are
600  * reasonably simple to use, are not "fooled" by spurious interrupts,
601  * and, unlike other attempts at IRQ probing, they do not get hung on
602  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
603  *
604  * For reasonably foolproof probing, use them as follows:
605  *
606  * 1. clear and/or mask the device's internal interrupt.
607  * 2. sti();
608  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
609  * 4. enable the device and cause it to trigger an interrupt.
610  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
611  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
612  * 7. service the device to clear its pending interrupt.
613  * 8. loop again if paranoia is required.
614  *
615  * probe_irq_on() returns a mask of allocated irq's.
616  *
617  * probe_irq_off() takes the mask as a parameter,
618  * and returns the irq number which occurred,
619  * or zero if none occurred, or a negative irq number
620  * if more than one irq occurred.
621  */
622
623 #if !defined(CONFIG_GENERIC_IRQ_PROBE) 
624 static inline unsigned long probe_irq_on(void)
625 {
626         return 0;
627 }
628 static inline int probe_irq_off(unsigned long val)
629 {
630         return 0;
631 }
632 static inline unsigned int probe_irq_mask(unsigned long val)
633 {
634         return 0;
635 }
636 #else
637 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
638 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
639 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
640 #endif
641
642 #ifdef CONFIG_PROC_FS
643 /* Initialize /proc/irq/ */
644 extern void init_irq_proc(void);
645 #else
646 static inline void init_irq_proc(void)
647 {
648 }
649 #endif
650
651 struct seq_file;
652 int show_interrupts(struct seq_file *p, void *v);
653 int arch_show_interrupts(struct seq_file *p, int prec);
654
655 extern int early_irq_init(void);
656 extern int arch_probe_nr_irqs(void);
657 extern int arch_early_irq_init(void);
658
659 #endif