Merge tag 'regulator-v3.15-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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 #if defined(CONFIG_SMP)
203
204 extern cpumask_var_t irq_default_affinity;
205
206 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
207 extern int irq_can_set_affinity(unsigned int irq);
208 extern int irq_select_affinity(unsigned int irq);
209
210 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
211
212 /**
213  * struct irq_affinity_notify - context for notification of IRQ affinity changes
214  * @irq:                Interrupt to which notification applies
215  * @kref:               Reference count, for internal use
216  * @work:               Work item, for internal use
217  * @notify:             Function to be called on change.  This will be
218  *                      called in process context.
219  * @release:            Function to be called on release.  This will be
220  *                      called in process context.  Once registered, the
221  *                      structure must only be freed when this function is
222  *                      called or later.
223  */
224 struct irq_affinity_notify {
225         unsigned int irq;
226         struct kref kref;
227         struct work_struct work;
228         void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
229         void (*release)(struct kref *ref);
230 };
231
232 extern int
233 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
234
235 #else /* CONFIG_SMP */
236
237 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
238 {
239         return -EINVAL;
240 }
241
242 static inline int irq_can_set_affinity(unsigned int irq)
243 {
244         return 0;
245 }
246
247 static inline int irq_select_affinity(unsigned int irq)  { return 0; }
248
249 static inline int irq_set_affinity_hint(unsigned int irq,
250                                         const struct cpumask *m)
251 {
252         return -EINVAL;
253 }
254 #endif /* CONFIG_SMP */
255
256 /*
257  * Special lockdep variants of irq disabling/enabling.
258  * These should be used for locking constructs that
259  * know that a particular irq context which is disabled,
260  * and which is the only irq-context user of a lock,
261  * that it's safe to take the lock in the irq-disabled
262  * section without disabling hardirqs.
263  *
264  * On !CONFIG_LOCKDEP they are equivalent to the normal
265  * irq disable/enable methods.
266  */
267 static inline void disable_irq_nosync_lockdep(unsigned int irq)
268 {
269         disable_irq_nosync(irq);
270 #ifdef CONFIG_LOCKDEP
271         local_irq_disable();
272 #endif
273 }
274
275 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
276 {
277         disable_irq_nosync(irq);
278 #ifdef CONFIG_LOCKDEP
279         local_irq_save(*flags);
280 #endif
281 }
282
283 static inline void disable_irq_lockdep(unsigned int irq)
284 {
285         disable_irq(irq);
286 #ifdef CONFIG_LOCKDEP
287         local_irq_disable();
288 #endif
289 }
290
291 static inline void enable_irq_lockdep(unsigned int irq)
292 {
293 #ifdef CONFIG_LOCKDEP
294         local_irq_enable();
295 #endif
296         enable_irq(irq);
297 }
298
299 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
300 {
301 #ifdef CONFIG_LOCKDEP
302         local_irq_restore(*flags);
303 #endif
304         enable_irq(irq);
305 }
306
307 /* IRQ wakeup (PM) control: */
308 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
309
310 static inline int enable_irq_wake(unsigned int irq)
311 {
312         return irq_set_irq_wake(irq, 1);
313 }
314
315 static inline int disable_irq_wake(unsigned int irq)
316 {
317         return irq_set_irq_wake(irq, 0);
318 }
319
320
321 #ifdef CONFIG_IRQ_FORCED_THREADING
322 extern bool force_irqthreads;
323 #else
324 #define force_irqthreads        (0)
325 #endif
326
327 #ifndef __ARCH_SET_SOFTIRQ_PENDING
328 #define set_softirq_pending(x) (local_softirq_pending() = (x))
329 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
330 #endif
331
332 /* Some architectures might implement lazy enabling/disabling of
333  * interrupts. In some cases, such as stop_machine, we might want
334  * to ensure that after a local_irq_disable(), interrupts have
335  * really been disabled in hardware. Such architectures need to
336  * implement the following hook.
337  */
338 #ifndef hard_irq_disable
339 #define hard_irq_disable()      do { } while(0)
340 #endif
341
342 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
343    frequency threaded job scheduling. For almost all the purposes
344    tasklets are more than enough. F.e. all serial device BHs et
345    al. should be converted to tasklets, not to softirqs.
346  */
347
348 enum
349 {
350         HI_SOFTIRQ=0,
351         TIMER_SOFTIRQ,
352         NET_TX_SOFTIRQ,
353         NET_RX_SOFTIRQ,
354         BLOCK_SOFTIRQ,
355         BLOCK_IOPOLL_SOFTIRQ,
356         TASKLET_SOFTIRQ,
357         SCHED_SOFTIRQ,
358         HRTIMER_SOFTIRQ,
359         RCU_SOFTIRQ,    /* Preferable RCU should always be the last softirq */
360
361         NR_SOFTIRQS
362 };
363
364 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
365
366 /* map softirq index to softirq name. update 'softirq_to_name' in
367  * kernel/softirq.c when adding a new softirq.
368  */
369 extern const char * const softirq_to_name[NR_SOFTIRQS];
370
371 /* softirq mask and active fields moved to irq_cpustat_t in
372  * asm/hardirq.h to get better cache usage.  KAO
373  */
374
375 struct softirq_action
376 {
377         void    (*action)(struct softirq_action *);
378 };
379
380 asmlinkage void do_softirq(void);
381 asmlinkage void __do_softirq(void);
382
383 #ifdef __ARCH_HAS_DO_SOFTIRQ
384 void do_softirq_own_stack(void);
385 #else
386 static inline void do_softirq_own_stack(void)
387 {
388         __do_softirq();
389 }
390 #endif
391
392 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
393 extern void softirq_init(void);
394 extern void __raise_softirq_irqoff(unsigned int nr);
395
396 extern void raise_softirq_irqoff(unsigned int nr);
397 extern void raise_softirq(unsigned int nr);
398
399 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
400
401 static inline struct task_struct *this_cpu_ksoftirqd(void)
402 {
403         return this_cpu_read(ksoftirqd);
404 }
405
406 /* Tasklets --- multithreaded analogue of BHs.
407
408    Main feature differing them of generic softirqs: tasklet
409    is running only on one CPU simultaneously.
410
411    Main feature differing them of BHs: different tasklets
412    may be run simultaneously on different CPUs.
413
414    Properties:
415    * If tasklet_schedule() is called, then tasklet is guaranteed
416      to be executed on some cpu at least once after this.
417    * If the tasklet is already scheduled, but its execution is still not
418      started, it will be executed only once.
419    * If this tasklet is already running on another CPU (or schedule is called
420      from tasklet itself), it is rescheduled for later.
421    * Tasklet is strictly serialized wrt itself, but not
422      wrt another tasklets. If client needs some intertask synchronization,
423      he makes it with spinlocks.
424  */
425
426 struct tasklet_struct
427 {
428         struct tasklet_struct *next;
429         unsigned long state;
430         atomic_t count;
431         void (*func)(unsigned long);
432         unsigned long data;
433 };
434
435 #define DECLARE_TASKLET(name, func, data) \
436 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
437
438 #define DECLARE_TASKLET_DISABLED(name, func, data) \
439 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
440
441
442 enum
443 {
444         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
445         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
446 };
447
448 #ifdef CONFIG_SMP
449 static inline int tasklet_trylock(struct tasklet_struct *t)
450 {
451         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
452 }
453
454 static inline void tasklet_unlock(struct tasklet_struct *t)
455 {
456         smp_mb__before_clear_bit(); 
457         clear_bit(TASKLET_STATE_RUN, &(t)->state);
458 }
459
460 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
461 {
462         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
463 }
464 #else
465 #define tasklet_trylock(t) 1
466 #define tasklet_unlock_wait(t) do { } while (0)
467 #define tasklet_unlock(t) do { } while (0)
468 #endif
469
470 extern void __tasklet_schedule(struct tasklet_struct *t);
471
472 static inline void tasklet_schedule(struct tasklet_struct *t)
473 {
474         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
475                 __tasklet_schedule(t);
476 }
477
478 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
479
480 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
481 {
482         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
483                 __tasklet_hi_schedule(t);
484 }
485
486 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
487
488 /*
489  * This version avoids touching any other tasklets. Needed for kmemcheck
490  * in order not to take any page faults while enqueueing this tasklet;
491  * consider VERY carefully whether you really need this or
492  * tasklet_hi_schedule()...
493  */
494 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
495 {
496         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
497                 __tasklet_hi_schedule_first(t);
498 }
499
500
501 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
502 {
503         atomic_inc(&t->count);
504         smp_mb__after_atomic_inc();
505 }
506
507 static inline void tasklet_disable(struct tasklet_struct *t)
508 {
509         tasklet_disable_nosync(t);
510         tasklet_unlock_wait(t);
511         smp_mb();
512 }
513
514 static inline void tasklet_enable(struct tasklet_struct *t)
515 {
516         smp_mb__before_atomic_dec();
517         atomic_dec(&t->count);
518 }
519
520 static inline void tasklet_hi_enable(struct tasklet_struct *t)
521 {
522         smp_mb__before_atomic_dec();
523         atomic_dec(&t->count);
524 }
525
526 extern void tasklet_kill(struct tasklet_struct *t);
527 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
528 extern void tasklet_init(struct tasklet_struct *t,
529                          void (*func)(unsigned long), unsigned long data);
530
531 struct tasklet_hrtimer {
532         struct hrtimer          timer;
533         struct tasklet_struct   tasklet;
534         enum hrtimer_restart    (*function)(struct hrtimer *);
535 };
536
537 extern void
538 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
539                      enum hrtimer_restart (*function)(struct hrtimer *),
540                      clockid_t which_clock, enum hrtimer_mode mode);
541
542 static inline
543 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
544                           const enum hrtimer_mode mode)
545 {
546         return hrtimer_start(&ttimer->timer, time, mode);
547 }
548
549 static inline
550 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
551 {
552         hrtimer_cancel(&ttimer->timer);
553         tasklet_kill(&ttimer->tasklet);
554 }
555
556 /*
557  * Autoprobing for irqs:
558  *
559  * probe_irq_on() and probe_irq_off() provide robust primitives
560  * for accurate IRQ probing during kernel initialization.  They are
561  * reasonably simple to use, are not "fooled" by spurious interrupts,
562  * and, unlike other attempts at IRQ probing, they do not get hung on
563  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
564  *
565  * For reasonably foolproof probing, use them as follows:
566  *
567  * 1. clear and/or mask the device's internal interrupt.
568  * 2. sti();
569  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
570  * 4. enable the device and cause it to trigger an interrupt.
571  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
572  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
573  * 7. service the device to clear its pending interrupt.
574  * 8. loop again if paranoia is required.
575  *
576  * probe_irq_on() returns a mask of allocated irq's.
577  *
578  * probe_irq_off() takes the mask as a parameter,
579  * and returns the irq number which occurred,
580  * or zero if none occurred, or a negative irq number
581  * if more than one irq occurred.
582  */
583
584 #if !defined(CONFIG_GENERIC_IRQ_PROBE) 
585 static inline unsigned long probe_irq_on(void)
586 {
587         return 0;
588 }
589 static inline int probe_irq_off(unsigned long val)
590 {
591         return 0;
592 }
593 static inline unsigned int probe_irq_mask(unsigned long val)
594 {
595         return 0;
596 }
597 #else
598 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
599 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
600 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
601 #endif
602
603 #ifdef CONFIG_PROC_FS
604 /* Initialize /proc/irq/ */
605 extern void init_irq_proc(void);
606 #else
607 static inline void init_irq_proc(void)
608 {
609 }
610 #endif
611
612 struct seq_file;
613 int show_interrupts(struct seq_file *p, void *v);
614 int arch_show_interrupts(struct seq_file *p, int prec);
615
616 extern int early_irq_init(void);
617 extern int arch_probe_nr_irqs(void);
618 extern int arch_early_irq_init(void);
619
620 #endif