tcp: Fix >4GB writes on 64-bit.
[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/smp.h>
15 #include <linux/percpu.h>
16 #include <linux/hrtimer.h>
17
18 #include <asm/atomic.h>
19 #include <asm/ptrace.h>
20 #include <asm/system.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  * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
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  *
57  */
58 #define IRQF_DISABLED           0x00000020
59 #define IRQF_SAMPLE_RANDOM      0x00000040
60 #define IRQF_SHARED             0x00000080
61 #define IRQF_PROBE_SHARED       0x00000100
62 #define __IRQF_TIMER            0x00000200
63 #define IRQF_PERCPU             0x00000400
64 #define IRQF_NOBALANCING        0x00000800
65 #define IRQF_IRQPOLL            0x00001000
66 #define IRQF_ONESHOT            0x00002000
67 #define IRQF_NO_SUSPEND         0x00004000
68
69 #define IRQF_TIMER              (__IRQF_TIMER | IRQF_NO_SUSPEND)
70
71 /*
72  * Bits used by threaded handlers:
73  * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
74  * IRQTF_DIED      - handler thread died
75  * IRQTF_WARNED    - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
76  * IRQTF_AFFINITY  - irq thread is requested to adjust affinity
77  */
78 enum {
79         IRQTF_RUNTHREAD,
80         IRQTF_DIED,
81         IRQTF_WARNED,
82         IRQTF_AFFINITY,
83 };
84
85 typedef irqreturn_t (*irq_handler_t)(int, void *);
86
87 /**
88  * struct irqaction - per interrupt action descriptor
89  * @handler:    interrupt handler function
90  * @flags:      flags (see IRQF_* above)
91  * @name:       name of the device
92  * @dev_id:     cookie to identify the device
93  * @next:       pointer to the next irqaction for shared interrupts
94  * @irq:        interrupt number
95  * @dir:        pointer to the proc/irq/NN/name entry
96  * @thread_fn:  interupt handler function for threaded interrupts
97  * @thread:     thread pointer for threaded interrupts
98  * @thread_flags:       flags related to @thread
99  */
100 struct irqaction {
101         irq_handler_t handler;
102         unsigned long flags;
103         const char *name;
104         void *dev_id;
105         struct irqaction *next;
106         int irq;
107         struct proc_dir_entry *dir;
108         irq_handler_t thread_fn;
109         struct task_struct *thread;
110         unsigned long thread_flags;
111 };
112
113 extern irqreturn_t no_action(int cpl, void *dev_id);
114
115 #ifdef CONFIG_GENERIC_HARDIRQS
116 extern int __must_check
117 request_threaded_irq(unsigned int irq, irq_handler_t handler,
118                      irq_handler_t thread_fn,
119                      unsigned long flags, const char *name, void *dev);
120
121 static inline int __must_check
122 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
123             const char *name, void *dev)
124 {
125         return request_threaded_irq(irq, handler, NULL, flags, name, dev);
126 }
127
128 extern void exit_irq_thread(void);
129 #else
130
131 extern int __must_check
132 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
133             const char *name, void *dev);
134
135 /*
136  * Special function to avoid ifdeffery in kernel/irq/devres.c which
137  * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
138  * m68k). I really love these $@%#!* obvious Makefile references:
139  * ../../../kernel/irq/devres.o
140  */
141 static inline int __must_check
142 request_threaded_irq(unsigned int irq, irq_handler_t handler,
143                      irq_handler_t thread_fn,
144                      unsigned long flags, const char *name, void *dev)
145 {
146         return request_irq(irq, handler, flags, name, dev);
147 }
148
149 static inline void exit_irq_thread(void) { }
150 #endif
151
152 extern void free_irq(unsigned int, void *);
153
154 struct device;
155
156 extern int __must_check
157 devm_request_threaded_irq(struct device *dev, unsigned int irq,
158                           irq_handler_t handler, irq_handler_t thread_fn,
159                           unsigned long irqflags, const char *devname,
160                           void *dev_id);
161
162 static inline int __must_check
163 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
164                  unsigned long irqflags, const char *devname, void *dev_id)
165 {
166         return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
167                                          devname, dev_id);
168 }
169
170 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
171
172 /*
173  * On lockdep we dont want to enable hardirqs in hardirq
174  * context. Use local_irq_enable_in_hardirq() to annotate
175  * kernel code that has to do this nevertheless (pretty much
176  * the only valid case is for old/broken hardware that is
177  * insanely slow).
178  *
179  * NOTE: in theory this might break fragile code that relies
180  * on hardirq delivery - in practice we dont seem to have such
181  * places left. So the only effect should be slightly increased
182  * irqs-off latencies.
183  */
184 #ifdef CONFIG_LOCKDEP
185 # define local_irq_enable_in_hardirq()  do { } while (0)
186 #else
187 # define local_irq_enable_in_hardirq()  local_irq_enable()
188 #endif
189
190 extern void disable_irq_nosync(unsigned int irq);
191 extern void disable_irq(unsigned int irq);
192 extern void enable_irq(unsigned int irq);
193
194 /* The following three functions are for the core kernel use only. */
195 #ifdef CONFIG_GENERIC_HARDIRQS
196 extern void suspend_device_irqs(void);
197 extern void resume_device_irqs(void);
198 #ifdef CONFIG_PM_SLEEP
199 extern int check_wakeup_irqs(void);
200 #else
201 static inline int check_wakeup_irqs(void) { return 0; }
202 #endif
203 #else
204 static inline void suspend_device_irqs(void) { };
205 static inline void resume_device_irqs(void) { };
206 static inline int check_wakeup_irqs(void) { return 0; }
207 #endif
208
209 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
210
211 extern cpumask_var_t irq_default_affinity;
212
213 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
214 extern int irq_can_set_affinity(unsigned int irq);
215 extern int irq_select_affinity(unsigned int irq);
216
217 #else /* CONFIG_SMP */
218
219 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
220 {
221         return -EINVAL;
222 }
223
224 static inline int irq_can_set_affinity(unsigned int irq)
225 {
226         return 0;
227 }
228
229 static inline int irq_select_affinity(unsigned int irq)  { return 0; }
230
231 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
232
233 #ifdef CONFIG_GENERIC_HARDIRQS
234 /*
235  * Special lockdep variants of irq disabling/enabling.
236  * These should be used for locking constructs that
237  * know that a particular irq context which is disabled,
238  * and which is the only irq-context user of a lock,
239  * that it's safe to take the lock in the irq-disabled
240  * section without disabling hardirqs.
241  *
242  * On !CONFIG_LOCKDEP they are equivalent to the normal
243  * irq disable/enable methods.
244  */
245 static inline void disable_irq_nosync_lockdep(unsigned int irq)
246 {
247         disable_irq_nosync(irq);
248 #ifdef CONFIG_LOCKDEP
249         local_irq_disable();
250 #endif
251 }
252
253 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
254 {
255         disable_irq_nosync(irq);
256 #ifdef CONFIG_LOCKDEP
257         local_irq_save(*flags);
258 #endif
259 }
260
261 static inline void disable_irq_lockdep(unsigned int irq)
262 {
263         disable_irq(irq);
264 #ifdef CONFIG_LOCKDEP
265         local_irq_disable();
266 #endif
267 }
268
269 static inline void enable_irq_lockdep(unsigned int irq)
270 {
271 #ifdef CONFIG_LOCKDEP
272         local_irq_enable();
273 #endif
274         enable_irq(irq);
275 }
276
277 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
278 {
279 #ifdef CONFIG_LOCKDEP
280         local_irq_restore(*flags);
281 #endif
282         enable_irq(irq);
283 }
284
285 /* IRQ wakeup (PM) control: */
286 extern int set_irq_wake(unsigned int irq, unsigned int on);
287
288 static inline int enable_irq_wake(unsigned int irq)
289 {
290         return set_irq_wake(irq, 1);
291 }
292
293 static inline int disable_irq_wake(unsigned int irq)
294 {
295         return set_irq_wake(irq, 0);
296 }
297
298 #else /* !CONFIG_GENERIC_HARDIRQS */
299 /*
300  * NOTE: non-genirq architectures, if they want to support the lock
301  * validator need to define the methods below in their asm/irq.h
302  * files, under an #ifdef CONFIG_LOCKDEP section.
303  */
304 #ifndef CONFIG_LOCKDEP
305 #  define disable_irq_nosync_lockdep(irq)       disable_irq_nosync(irq)
306 #  define disable_irq_nosync_lockdep_irqsave(irq, flags) \
307                                                 disable_irq_nosync(irq)
308 #  define disable_irq_lockdep(irq)              disable_irq(irq)
309 #  define enable_irq_lockdep(irq)               enable_irq(irq)
310 #  define enable_irq_lockdep_irqrestore(irq, flags) \
311                                                 enable_irq(irq)
312 # endif
313
314 static inline int enable_irq_wake(unsigned int irq)
315 {
316         return 0;
317 }
318
319 static inline int disable_irq_wake(unsigned int irq)
320 {
321         return 0;
322 }
323 #endif /* CONFIG_GENERIC_HARDIRQS */
324
325 #ifndef __ARCH_SET_SOFTIRQ_PENDING
326 #define set_softirq_pending(x) (local_softirq_pending() = (x))
327 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
328 #endif
329
330 /* Some architectures might implement lazy enabling/disabling of
331  * interrupts. In some cases, such as stop_machine, we might want
332  * to ensure that after a local_irq_disable(), interrupts have
333  * really been disabled in hardware. Such architectures need to
334  * implement the following hook.
335  */
336 #ifndef hard_irq_disable
337 #define hard_irq_disable()      do { } while(0)
338 #endif
339
340 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
341    frequency threaded job scheduling. For almost all the purposes
342    tasklets are more than enough. F.e. all serial device BHs et
343    al. should be converted to tasklets, not to softirqs.
344  */
345
346 enum
347 {
348         HI_SOFTIRQ=0,
349         TIMER_SOFTIRQ,
350         NET_TX_SOFTIRQ,
351         NET_RX_SOFTIRQ,
352         BLOCK_SOFTIRQ,
353         BLOCK_IOPOLL_SOFTIRQ,
354         TASKLET_SOFTIRQ,
355         SCHED_SOFTIRQ,
356         HRTIMER_SOFTIRQ,
357         RCU_SOFTIRQ,    /* Preferable RCU should always be the last softirq */
358
359         NR_SOFTIRQS
360 };
361
362 /* map softirq index to softirq name. update 'softirq_to_name' in
363  * kernel/softirq.c when adding a new softirq.
364  */
365 extern char *softirq_to_name[NR_SOFTIRQS];
366
367 /* softirq mask and active fields moved to irq_cpustat_t in
368  * asm/hardirq.h to get better cache usage.  KAO
369  */
370
371 struct softirq_action
372 {
373         void    (*action)(struct softirq_action *);
374 };
375
376 asmlinkage void do_softirq(void);
377 asmlinkage void __do_softirq(void);
378 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
379 extern void softirq_init(void);
380 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
381 extern void raise_softirq_irqoff(unsigned int nr);
382 extern void raise_softirq(unsigned int nr);
383 extern void wakeup_softirqd(void);
384
385 /* This is the worklist that queues up per-cpu softirq work.
386  *
387  * send_remote_sendirq() adds work to these lists, and
388  * the softirq handler itself dequeues from them.  The queues
389  * are protected by disabling local cpu interrupts and they must
390  * only be accessed by the local cpu that they are for.
391  */
392 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
393
394 /* Try to send a softirq to a remote cpu.  If this cannot be done, the
395  * work will be queued to the local cpu.
396  */
397 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
398
399 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
400  * and compute the current cpu, passed in as 'this_cpu'.
401  */
402 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
403                                   int this_cpu, int softirq);
404
405 /* Tasklets --- multithreaded analogue of BHs.
406
407    Main feature differing them of generic softirqs: tasklet
408    is running only on one CPU simultaneously.
409
410    Main feature differing them of BHs: different tasklets
411    may be run simultaneously on different CPUs.
412
413    Properties:
414    * If tasklet_schedule() is called, then tasklet is guaranteed
415      to be executed on some cpu at least once after this.
416    * If the tasklet is already scheduled, but its excecution is still not
417      started, it will be executed only once.
418    * If this tasklet is already running on another CPU (or schedule is called
419      from tasklet itself), it is rescheduled for later.
420    * Tasklet is strictly serialized wrt itself, but not
421      wrt another tasklets. If client needs some intertask synchronization,
422      he makes it with spinlocks.
423  */
424
425 struct tasklet_struct
426 {
427         struct tasklet_struct *next;
428         unsigned long state;
429         atomic_t count;
430         void (*func)(unsigned long);
431         unsigned long data;
432 };
433
434 #define DECLARE_TASKLET(name, func, data) \
435 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
436
437 #define DECLARE_TASKLET_DISABLED(name, func, data) \
438 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
439
440
441 enum
442 {
443         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
444         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
445 };
446
447 #ifdef CONFIG_SMP
448 static inline int tasklet_trylock(struct tasklet_struct *t)
449 {
450         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
451 }
452
453 static inline void tasklet_unlock(struct tasklet_struct *t)
454 {
455         smp_mb__before_clear_bit(); 
456         clear_bit(TASKLET_STATE_RUN, &(t)->state);
457 }
458
459 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
460 {
461         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
462 }
463 #else
464 #define tasklet_trylock(t) 1
465 #define tasklet_unlock_wait(t) do { } while (0)
466 #define tasklet_unlock(t) do { } while (0)
467 #endif
468
469 extern void __tasklet_schedule(struct tasklet_struct *t);
470
471 static inline void tasklet_schedule(struct tasklet_struct *t)
472 {
473         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
474                 __tasklet_schedule(t);
475 }
476
477 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
478
479 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
480 {
481         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
482                 __tasklet_hi_schedule(t);
483 }
484
485 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
486
487 /*
488  * This version avoids touching any other tasklets. Needed for kmemcheck
489  * in order not to take any page faults while enqueueing this tasklet;
490  * consider VERY carefully whether you really need this or
491  * tasklet_hi_schedule()...
492  */
493 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
494 {
495         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
496                 __tasklet_hi_schedule_first(t);
497 }
498
499
500 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
501 {
502         atomic_inc(&t->count);
503         smp_mb__after_atomic_inc();
504 }
505
506 static inline void tasklet_disable(struct tasklet_struct *t)
507 {
508         tasklet_disable_nosync(t);
509         tasklet_unlock_wait(t);
510         smp_mb();
511 }
512
513 static inline void tasklet_enable(struct tasklet_struct *t)
514 {
515         smp_mb__before_atomic_dec();
516         atomic_dec(&t->count);
517 }
518
519 static inline void tasklet_hi_enable(struct tasklet_struct *t)
520 {
521         smp_mb__before_atomic_dec();
522         atomic_dec(&t->count);
523 }
524
525 extern void tasklet_kill(struct tasklet_struct *t);
526 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
527 extern void tasklet_init(struct tasklet_struct *t,
528                          void (*func)(unsigned long), unsigned long data);
529
530 struct tasklet_hrtimer {
531         struct hrtimer          timer;
532         struct tasklet_struct   tasklet;
533         enum hrtimer_restart    (*function)(struct hrtimer *);
534 };
535
536 extern void
537 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
538                      enum hrtimer_restart (*function)(struct hrtimer *),
539                      clockid_t which_clock, enum hrtimer_mode mode);
540
541 static inline
542 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
543                           const enum hrtimer_mode mode)
544 {
545         return hrtimer_start(&ttimer->timer, time, mode);
546 }
547
548 static inline
549 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
550 {
551         hrtimer_cancel(&ttimer->timer);
552         tasklet_kill(&ttimer->tasklet);
553 }
554
555 /*
556  * Autoprobing for irqs:
557  *
558  * probe_irq_on() and probe_irq_off() provide robust primitives
559  * for accurate IRQ probing during kernel initialization.  They are
560  * reasonably simple to use, are not "fooled" by spurious interrupts,
561  * and, unlike other attempts at IRQ probing, they do not get hung on
562  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
563  *
564  * For reasonably foolproof probing, use them as follows:
565  *
566  * 1. clear and/or mask the device's internal interrupt.
567  * 2. sti();
568  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
569  * 4. enable the device and cause it to trigger an interrupt.
570  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
571  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
572  * 7. service the device to clear its pending interrupt.
573  * 8. loop again if paranoia is required.
574  *
575  * probe_irq_on() returns a mask of allocated irq's.
576  *
577  * probe_irq_off() takes the mask as a parameter,
578  * and returns the irq number which occurred,
579  * or zero if none occurred, or a negative irq number
580  * if more than one irq occurred.
581  */
582
583 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE) 
584 static inline unsigned long probe_irq_on(void)
585 {
586         return 0;
587 }
588 static inline int probe_irq_off(unsigned long val)
589 {
590         return 0;
591 }
592 static inline unsigned int probe_irq_mask(unsigned long val)
593 {
594         return 0;
595 }
596 #else
597 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
598 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
599 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
600 #endif
601
602 #ifdef CONFIG_PROC_FS
603 /* Initialize /proc/irq/ */
604 extern void init_irq_proc(void);
605 #else
606 static inline void init_irq_proc(void)
607 {
608 }
609 #endif
610
611 #if defined(CONFIG_GENERIC_HARDIRQS) && defined(CONFIG_DEBUG_SHIRQ)
612 extern void debug_poll_all_shared_irqs(void);
613 #else
614 static inline void debug_poll_all_shared_irqs(void) { }
615 #endif
616
617 struct seq_file;
618 int show_interrupts(struct seq_file *p, void *v);
619
620 struct irq_desc;
621
622 extern int early_irq_init(void);
623 extern int arch_probe_nr_irqs(void);
624 extern int arch_early_irq_init(void);
625 extern int arch_init_chip_data(struct irq_desc *desc, int node);
626
627 #endif