xref: /netbsd-src/sys/external/bsd/vchiq/dist/interface/compat/vchi_bsd.h (revision 53b02e147d4ed531c0d2a5ca9b3e8026ba3e99b5)
1 /*-
2  * Copyright (c) 2010 Max Khon <fjoe@freebsd.org>
3  * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@bluezbox.com>
4  * Copyright (c) 2013 Jared D. McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef __VCHI_NETBSD_H__
29 #define __VCHI_NETBSD_H__
30 
31 #include <sys/systm.h>
32 #include <sys/param.h>
33 #include <sys/bus.h>
34 #include <sys/conf.h>
35 #include <sys/lock.h>
36 #include <sys/kernel.h>
37 #include <sys/kthread.h>
38 #include <sys/mutex.h>
39 #include <sys/malloc.h>
40 #include <sys/proc.h>
41 #include <sys/types.h>
42 #include <sys/ioccom.h>
43 #include <sys/atomic.h>
44 #include <sys/rwlock.h>
45 #include <sys/callout.h>
46 
47 #include <linux/completion.h>
48 #include <asm/barrier.h>
49 
50 /*
51  * Copy from/to user API
52  */
53 #define copy_from_user(to, from, n)	copyin((from), (to), (n))
54 #define copy_to_user(to, from, n)	copyout((from), (to), (n))
55 
56 /*
57  * Atomic API
58  */
59 typedef volatile unsigned int atomic_t;
60 
61 #define atomic_set(p, v)	(*(p) = (v))
62 #define atomic_read(p)		(*(volatile int *)(p))
63 #define atomic_inc(p)		atomic_inc_uint(p)
64 #define atomic_dec(p)		atomic_dec_uint(p)
65 #define atomic_dec_and_test(p)	(atomic_dec_uint_nv(p) == 0)
66 #define	atomic_inc_return(v)	atomic_inc_uint_nv(v)
67 #define	atomic_dec_return(v)	atomic_dec_uint_nv(v)
68 #define atomic_add(v, p)	atomic_add_int(p, v)
69 #define atomic_sub(v, p)	atomic_add_int(p, -(v))
70 #define atomic_add_return(v, p)	atomic_add_int_nv(p, v)
71 #define atomic_sub_return(v, p)	atomic_add_int_nv(p, -(v))
72 #define atomic_xchg(p, v)	atomic_swap_uint(p, v)
73 #define atomic_cmpxchg(p, oldv, newv) atomic_cas_uint(p, oldv, newv)
74 
75 #define ATOMIC_INIT(v)		(v)
76 
77 /*
78  * Spinlock API
79  */
80 typedef kmutex_t spinlock_t;
81 
82 /*
83  * NB: Need to initialize these at attach time!
84  */
85 #define DEFINE_SPINLOCK(name)	kmutex_t name
86 
87 #define spin_lock_init(lock)	mutex_init(lock, MUTEX_DEFAULT, IPL_VM)
88 #define spin_lock_destroy(lock)	mutex_destroy(lock)
89 #define spin_lock(lock)		mutex_spin_enter(lock)
90 #define spin_unlock(lock)	mutex_spin_exit(lock)
91 
92 /*
93  * Mutex API
94  */
95 struct mutex {
96 	kmutex_t	mtx;
97 };
98 
99 #define	lmutex_init(lock)	mutex_init(&(lock)->mtx, MUTEX_DEFAULT, IPL_NONE)
100 #define lmutex_destroy(lock)	mutex_destroy(&(lock)->mtx)
101 #define	lmutex_lock(lock)	mutex_enter(&(lock)->mtx)
102 #define	lmutex_lock_interruptible(lock)	(mutex_enter(&(lock)->mtx),0)
103 #define	lmutex_unlock(lock)	mutex_exit(&(lock)->mtx)
104 
105 /*
106  * Rwlock API
107  */
108 typedef kmutex_t rwlock_t;
109 
110 #define DEFINE_RWLOCK(name)	kmutex_t name
111 
112 #define rwlock_init(rwlock)	mutex_init(rwlock, MUTEX_DEFAULT, IPL_VM)
113 #define read_lock(rwlock)	mutex_spin_enter(rwlock)
114 #define read_unlock(rwlock)	mutex_spin_exit(rwlock)
115 
116 #define write_lock(rwlock)	mutex_spin_enter(rwlock)
117 #define write_unlock(rwlock)	mutex_spin_exit(rwlock)
118 
119 #define read_lock_bh(rwlock)	read_lock(rwlock)
120 #define read_unlock_bh(rwlock)	read_unlock(rwlock)
121 #define write_lock_bh(rwlock)	write_lock(rwlock)
122 #define write_unlock_bh(rwlock)	write_unlock(rwlock)
123 
124 /*
125  * Timer API
126  */
127 struct timer_list {
128 	kmutex_t mtx;
129 	callout_t callout;
130 
131 	unsigned long expires;
132 	void (*function)(unsigned long);
133 	unsigned long data;
134 };
135 
136 void init_timer(struct timer_list *t);
137 void setup_timer(struct timer_list *t, void (*function)(unsigned long), unsigned long data);
138 void mod_timer(struct timer_list *t, unsigned long expires);
139 void add_timer(struct timer_list *t);
140 int del_timer(struct timer_list *t);
141 int del_timer_sync(struct timer_list *t);
142 
143 /*
144  * Semaphore API
145  */
146 struct semaphore {
147 	kmutex_t	mtx;
148 	kcondvar_t	cv;
149 	int		value;
150 	int		waiters;
151 };
152 
153 /*
154  * NB: Need to initialize these at attach time!
155  */
156 #define	DEFINE_SEMAPHORE(name)	struct semaphore name
157 
158 void sema_sysinit(void *arg);
159 void _sema_init(struct semaphore *s, int value);
160 void _sema_destroy(struct semaphore *s);
161 void down(struct semaphore *s);
162 int down_interruptible(struct semaphore *s);
163 int down_trylock(struct semaphore *s);
164 void up(struct semaphore *s);
165 
166 /*
167  * Logging and assertions API
168  */
169 void rlprintf(int pps, const char *fmt, ...)
170 	__printflike(2, 3);
171 
172 void
173 device_rlprintf(int pps, device_t dev, const char *fmt, ...)
174 	__printflike(3, 4);
175 
176 #define vchiq_static_assert(cond) CTASSERT(cond)
177 
178 /*
179  * Kernel module API
180  */
181 #define __init
182 #define __exit
183 #define __devinit
184 #define __devexit
185 #define __devinitdata
186 
187 /*
188  * Time API
189  */
190 #if 1
191 /* emulate jiffies */
192 static inline unsigned long
193 _jiffies(void)
194 {
195 	struct timeval tv;
196 
197 	microuptime(&tv);
198 	return tvtohz(&tv);
199 }
200 
201 static inline unsigned long
202 msecs_to_jiffies(unsigned long msecs)
203 {
204 	struct timeval tv;
205 
206 	tv.tv_sec = msecs / 1000000UL;
207 	tv.tv_usec = msecs % 1000000UL;
208 	return tvtohz(&tv);
209 }
210 
211 #define jiffies			_jiffies()
212 #else
213 #define jiffies			ticks
214 #endif
215 #define HZ			hz
216 
217 #define udelay(usec)		DELAY(usec)
218 #define mdelay(msec)		DELAY((msec) * 1000)
219 
220 #define schedule_timeout(jiff)	kpause("dhdslp", false, jiff, NULL)
221 
222 #if defined(msleep)
223 #undef msleep
224 #endif
225 #define msleep(msec)		mdelay(msec)
226 
227 #define time_after(a, b)	((a) > (b))
228 #define time_after_eq(a, b)	((a) >= (b))
229 #define time_before(a, b)	time_after((b), (a))
230 
231 /*
232  * kthread API (we use lwp)
233  */
234 typedef lwp_t * VCHIQ_THREAD_T;
235 
236 VCHIQ_THREAD_T vchiq_thread_create(int (*threadfn)(void *data),
237                                    void *data,
238                                    const char namefmt[], ...);
239 void set_user_nice(VCHIQ_THREAD_T p, int nice);
240 void wake_up_process(VCHIQ_THREAD_T p);
241 
242 /*
243  * Proc APIs
244  */
245 void flush_signals(VCHIQ_THREAD_T);
246 int fatal_signal_pending(VCHIQ_THREAD_T);
247 
248 /*
249  * Misc API
250  */
251 
252 #define __user
253 
254 #define	current			curlwp
255 #define PAGE_ALIGN(addr)	round_page(addr)
256 
257 typedef	void	irqreturn_t;
258 typedef	off_t	loff_t;
259 
260 #define BCM2835_MBOX_CHAN_VCHIQ	3
261 #define bcm_mbox_write	bcmmbox_write
262 
263 #define device_print_prettyname(dev)	device_printf((dev), "")
264 
265 #endif /* __VCHI_NETBSD_H__ */
266