xref: /dflybsd-src/sys/dev/drm/include/linux/interrupt.h (revision 49ecae83bf6e5a8f787f7d801ddf305dce90cde5)
1 /*
2  * Copyright (c) 2017 François Tigeot
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _LINUX_INTERRUPT_H_
28 #define _LINUX_INTERRUPT_H_
29 
30 #include <linux/kernel.h>
31 #include <linux/bitops.h>
32 #include <linux/irqreturn.h>
33 #include <linux/hardirq.h>
34 #include <linux/irqflags.h>
35 #include <linux/hrtimer.h>
36 #include <linux/kref.h>
37 
38 #include <linux/atomic.h>
39 
40 struct tasklet_struct {
41 	unsigned long state;
42 	void (*func)(unsigned long);
43 	unsigned long data;
44 	struct lock lock;
45 };
46 
47 enum {
48 	TASKLET_STATE_SCHED,
49 	TASKLET_STATE_RUN
50 };
51 
52 /*
53  * TODO: verify these points:
54  * - tasklets that have the same type cannot be run on multiple processors at the same time
55  * - tasklets always run on the processor from which they were originally
56  *   submitted
57  * - when a tasklet is scheduled, its state is set to TASKLET_STATE_SCHED, and the tasklet
58  *   added to a queue
59  * - during the execution of its function, the tasklet state is set to TASKLET_STATE_RUN
60  *   and the TASKLET_STATE_SCHED state is removed
61  */
62 
63 /* XXX scheduling and execution should be handled separately */
64 static inline void
65 tasklet_schedule(struct tasklet_struct *t)
66 {
67 	set_bit(TASKLET_STATE_SCHED, &t->state);
68 
69 	lockmgr(&t->lock, LK_EXCLUSIVE);
70 	clear_bit(TASKLET_STATE_SCHED, &t->state);
71 
72 	set_bit(TASKLET_STATE_RUN, &t->state);
73 	if (t->func)
74 		t->func(t->data);
75 	clear_bit(TASKLET_STATE_RUN, &t->state);
76 
77 	lockmgr(&t->lock, LK_RELEASE);
78 }
79 
80 /* This function ensures that the tasklet is not scheduled to run again */
81 /* XXX this doesn't kill anything */
82 static inline void
83 tasklet_kill(struct tasklet_struct *t)
84 {
85 	lockmgr(&t->lock, LK_EXCLUSIVE);
86 	clear_bit(TASKLET_STATE_SCHED, &t->state);
87 	lockmgr(&t->lock, LK_RELEASE);
88 }
89 
90 static inline void
91 tasklet_init(struct tasklet_struct *t, void (*func)(unsigned long), unsigned long data)
92 {
93 	lockinit(&t->lock, "ltasklet", 0, LK_CANRECURSE);
94 	t->state = 0;
95 	t->func = func;
96 	t->data = data;
97 }
98 
99 #endif	/* _LINUX_INTERRUPT_H_ */
100