xref: /netbsd-src/sys/arch/arm/include/bus_funcs.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: bus_funcs.h,v 1.9 2020/04/13 07:09:51 maxv Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
35  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *      This product includes software developed by Christopher G. Demetriou
48  *	for the NetBSD Project.
49  * 4. The name of the author may not be used to endorse or promote products
50  *    derived from this software without specific prior written permission
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  */
63 
64 #ifndef _ARM_BUS_FUNCS_H_
65 #define _ARM_BUS_FUNCS_H_
66 
67 #ifdef _KERNEL_OPT
68 #include "opt_cputypes.h"
69 #endif
70 
71 /*
72  * Utility macros; INTERNAL USE ONLY.
73  */
74 #define	__bs_c(a,b)		__CONCAT(a,b)
75 #define	__bs_opname(op,size)	__bs_c(__bs_c(__bs_c(bs_,op),_),size)
76 
77 #define	__bs_rs(sz, t, h, o)						\
78 	(*(t)->__bs_opname(r,sz))((t)->bs_cookie, h, o)
79 #define	__bs_ws(sz, t, h, o, v)						\
80 	(*(t)->__bs_opname(w,sz))((t)->bs_cookie, h, o, v)
81 #define	__bs_nonsingle(type, sz, t, h, o, a, c)				\
82 	(*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, a, c)
83 #define	__bs_set(type, sz, t, h, o, v, c)				\
84 	(*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, v, c)
85 #define	__bs_copy(sz, t, h1, o1, h2, o2, cnt)				\
86 	(*(t)->__bs_opname(c,sz))((t)->bs_cookie, h1, o1, h2, o2, cnt)
87 
88 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
89 #define	__bs_opname_s(op,size)	__bs_c(__bs_c(__bs_c(__bs_c(bs_,op),_),size),_s)
90 #define	__bs_rs_s(sz, t, h, o)						\
91 	(*(t)->__bs_opname_s(r,sz))((t)->bs_cookie, h, o)
92 #define	__bs_ws_s(sz, t, h, o, v)					\
93 	(*(t)->__bs_opname_s(w,sz))((t)->bs_cookie, h, o, v)
94 #define	__bs_nonsingle_s(type, sz, t, h, o, a, c)			\
95 	(*(t)->__bs_opname_s(type,sz))((t)->bs_cookie, h, o, a, c)
96 #define	__bs_set_s(type, sz, t, h, o, v, c)				\
97 	(*(t)->__bs_opname_s(type,sz))((t)->bs_cookie, h, o, v, c)
98 #define	__bs_copy_s(sz, t, h1, o1, h2, o2, cnt)				\
99 	(*(t)->__bs_opname_s(c,sz))((t)->bs_cookie, h1, o1, h2, o2, cnt)
100 #endif
101 
102 #ifdef __BUS_SPACE_HAS_PROBING_METHODS
103 #define	__bs_pe(sz, t, h, o, v)						\
104 	(*(t)->__bs_opname(pe,sz))((t)->bs_cookie, h, o, v)
105 #define	__bs_po(sz, t, h, o, v)						\
106 	(*(t)->__bs_opname(po,sz))((t)->bs_cookie, h, o, v)
107 #endif
108 
109 /*
110  * Mapping and unmapping operations.
111  */
112 #define	bus_space_map(t, a, s, c, hp)					\
113 	(*(t)->bs_map)((t)->bs_cookie, (a), (s), (c), (hp))
114 #define	bus_space_unmap(t, h, s)					\
115 	(*(t)->bs_unmap)((t)->bs_cookie, (h), (s))
116 #define	bus_space_subregion(t, h, o, s, hp)				\
117 	(*(t)->bs_subregion)((t)->bs_cookie, (h), (o), (s), (hp))
118 
119 
120 /*
121  * Allocation and deallocation operations.
122  */
123 #define	bus_space_alloc(t, rs, re, s, a, b, c, ap, hp)			\
124 	(*(t)->bs_alloc)((t)->bs_cookie, (rs), (re), (s), (a), (b),	\
125 	    (c), (ap), (hp))
126 #define	bus_space_free(t, h, s)						\
127 	(*(t)->bs_free)((t)->bs_cookie, (h), (s))
128 
129 /*
130  * Get kernel virtual address for ranges mapped BUS_SPACE_MAP_LINEAR.
131  */
132 #define	bus_space_vaddr(t, h)						\
133 	(*(t)->bs_vaddr)((t)->bs_cookie, (h))
134 
135 /*
136  * MMap bus space for a user application.
137  */
138 #define bus_space_mmap(t, a, o, p, f)					\
139 	(*(t)->bs_mmap)((t)->bs_cookie, (a), (o), (p), (f))
140 
141 /*
142  * Bus barrier operations.
143  */
144 #define	bus_space_barrier(t, h, o, l, f)				\
145 	(*(t)->bs_barrier)((t)->bs_cookie, (h), (o), (l), (f))
146 
147 /*
148  * Bus read (single) operations.
149  */
150 #define	bus_space_read_1(t, h, o)	__bs_rs(1,(t),(h),(o))
151 #define	bus_space_read_2(t, h, o)	__bs_rs(2,(t),(h),(o))
152 #define	bus_space_read_4(t, h, o)	__bs_rs(4,(t),(h),(o))
153 #define	bus_space_read_8(t, h, o)	__bs_rs(8,(t),(h),(o))
154 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
155 #define	bus_space_read_stream_1(t, h, o)	__bs_rs_s(1,(t),(h),(o))
156 #define	bus_space_read_stream_2(t, h, o)	__bs_rs_s(2,(t),(h),(o))
157 #define	bus_space_read_stream_4(t, h, o)	__bs_rs_s(4,(t),(h),(o))
158 #define	bus_space_read_stream_8(t, h, o)	__bs_rs_s(8,(t),(h),(o))
159 #endif
160 
161 
162 /*
163  * Bus read multiple operations.
164  */
165 #define	bus_space_read_multi_1(t, h, o, a, c)				\
166 	__bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
167 #define	bus_space_read_multi_2(t, h, o, a, c)				\
168 	__bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
169 #define	bus_space_read_multi_4(t, h, o, a, c)				\
170 	__bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
171 #define	bus_space_read_multi_8(t, h, o, a, c)				\
172 	__bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
173 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
174 #define	bus_space_read_multi_stream_1(t, h, o, a, c)			\
175 	__bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
176 #define	bus_space_read_multi_stream_2(t, h, o, a, c)			\
177 	__bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
178 #define	bus_space_read_multi_stream_4(t, h, o, a, c)			\
179 	__bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
180 #define	bus_space_read_multi_stream_8(t, h, o, a, c)			\
181 	__bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
182 #endif
183 
184 
185 /*
186  * Bus read region operations.
187  */
188 #define	bus_space_read_region_1(t, h, o, a, c)				\
189 	__bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
190 #define	bus_space_read_region_2(t, h, o, a, c)				\
191 	__bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
192 #define	bus_space_read_region_4(t, h, o, a, c)				\
193 	__bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
194 #define	bus_space_read_region_8(t, h, o, a, c)				\
195 	__bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
196 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
197 #define	bus_space_read_region_stream_1(t, h, o, a, c)			\
198 	__bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
199 #define	bus_space_read_region_stream_2(t, h, o, a, c)			\
200 	__bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
201 #define	bus_space_read_region_stream_4(t, h, o, a, c)			\
202 	__bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
203 #define	bus_space_read_region_stream_8(t, h, o, a, c)			\
204 	__bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
205 #endif
206 
207 
208 /*
209  * Bus write (single) operations.
210  */
211 #define	bus_space_write_1(t, h, o, v)	__bs_ws(1,(t),(h),(o),(v))
212 #define	bus_space_write_2(t, h, o, v)	__bs_ws(2,(t),(h),(o),(v))
213 #define	bus_space_write_4(t, h, o, v)	__bs_ws(4,(t),(h),(o),(v))
214 #define	bus_space_write_8(t, h, o, v)	__bs_ws(8,(t),(h),(o),(v))
215 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
216 #define	bus_space_write_stream_1(t, h, o, v)	__bs_ws_s(1,(t),(h),(o),(v))
217 #define	bus_space_write_stream_2(t, h, o, v)	__bs_ws_s(2,(t),(h),(o),(v))
218 #define	bus_space_write_stream_4(t, h, o, v)	__bs_ws_s(4,(t),(h),(o),(v))
219 #define	bus_space_write_stream_8(t, h, o, v)	__bs_ws_s(8,(t),(h),(o),(v))
220 #endif
221 
222 
223 /*
224  * Bus write multiple operations.
225  */
226 #define	bus_space_write_multi_1(t, h, o, a, c)				\
227 	__bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
228 #define	bus_space_write_multi_2(t, h, o, a, c)				\
229 	__bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
230 #define	bus_space_write_multi_4(t, h, o, a, c)				\
231 	__bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
232 #define	bus_space_write_multi_8(t, h, o, a, c)				\
233 	__bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
234 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
235 #define	bus_space_write_multi_stream_1(t, h, o, a, c)			\
236 	__bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
237 #define	bus_space_write_multi_stream_2(t, h, o, a, c)			\
238 	__bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
239 #define	bus_space_write_multi_stream_4(t, h, o, a, c)			\
240 	__bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
241 #define	bus_space_write_multi_stream_8(t, h, o, a, c)			\
242 	__bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
243 #endif
244 
245 
246 /*
247  * Bus write region operations.
248  */
249 #define	bus_space_write_region_1(t, h, o, a, c)				\
250 	__bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
251 #define	bus_space_write_region_2(t, h, o, a, c)				\
252 	__bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
253 #define	bus_space_write_region_4(t, h, o, a, c)				\
254 	__bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
255 #define	bus_space_write_region_8(t, h, o, a, c)				\
256 	__bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
257 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
258 #define	bus_space_write_region_stream_1(t, h, o, a, c)			\
259 	__bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
260 #define	bus_space_write_region_stream_2(t, h, o, a, c)			\
261 	__bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
262 #define	bus_space_write_region_stream_4(t, h, o, a, c)			\
263 	__bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
264 #define	bus_space_write_region_stream_8(t, h, o, a, c)			\
265 	__bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
266 #endif
267 
268 
269 /*
270  * Set multiple operations.
271  */
272 #define	bus_space_set_multi_1(t, h, o, v, c)				\
273 	__bs_set(sm,1,(t),(h),(o),(v),(c))
274 #define	bus_space_set_multi_2(t, h, o, v, c)				\
275 	__bs_set(sm,2,(t),(h),(o),(v),(c))
276 #define	bus_space_set_multi_4(t, h, o, v, c)				\
277 	__bs_set(sm,4,(t),(h),(o),(v),(c))
278 #define	bus_space_set_multi_8(t, h, o, v, c)				\
279 	__bs_set(sm,8,(t),(h),(o),(v),(c))
280 
281 /*
282  * Set region operations.
283  */
284 #define	bus_space_set_region_1(t, h, o, v, c)				\
285 	__bs_set(sr,1,(t),(h),(o),(v),(c))
286 #define	bus_space_set_region_2(t, h, o, v, c)				\
287 	__bs_set(sr,2,(t),(h),(o),(v),(c))
288 #define	bus_space_set_region_4(t, h, o, v, c)				\
289 	__bs_set(sr,4,(t),(h),(o),(v),(c))
290 #define	bus_space_set_region_8(t, h, o, v, c)				\
291 	__bs_set(sr,8,(t),(h),(o),(v),(c))
292 
293 /*
294  * Copy operations.
295  */
296 #define	bus_space_copy_region_1(t, h1, o1, h2, o2, c)				\
297 	__bs_copy(1, t, h1, o1, h2, o2, c)
298 #define	bus_space_copy_region_2(t, h1, o1, h2, o2, c)				\
299 	__bs_copy(2, t, h1, o1, h2, o2, c)
300 #define	bus_space_copy_region_4(t, h1, o1, h2, o2, c)				\
301 	__bs_copy(4, t, h1, o1, h2, o2, c)
302 #define	bus_space_copy_region_8(t, h1, o1, h2, o2, c)				\
303 	__bs_copy(8, t, h1, o1, h2, o2, c)
304 
305 /*
306  * Probing operations.
307  */
308 #ifdef __BUS_SPACE_HAS_PROBING_METHODS
309 #define	bus_space_peek_1(t, h, o, p)	__bs_pe(1,(t),(h),(o),(p))
310 #define	bus_space_peek_2(t, h, o, p)	__bs_pe(2,(t),(h),(o),(p))
311 #define	bus_space_peek_4(t, h, o, p)	__bs_pe(4,(t),(h),(o),(p))
312 #define	bus_space_peek_8(t, h, o, p)	__bs_pe(8,(t),(h),(o),(p))
313 
314 #define	bus_space_poke_1(t, h, o, v)	__bs_po(1,(t),(h),(o),(v))
315 #define	bus_space_poke_2(t, h, o, v)	__bs_po(2,(t),(h),(o),(v))
316 #define	bus_space_poke_4(t, h, o, v)	__bs_po(4,(t),(h),(o),(v))
317 #define	bus_space_poke_8(t, h, o, v)	__bs_po(8,(t),(h),(o),(v))
318 #endif
319 
320 /*
321  * Macros to provide prototypes for all the functions used in the
322  * bus_space structure
323  */
324 
325 #define bs_map_proto(f)							\
326 int	__bs_c(f,_bs_map)(void *t, bus_addr_t addr,		\
327 	    bus_size_t size, int cacheable, bus_space_handle_t *bshp);
328 
329 #define bs_unmap_proto(f)						\
330 void	__bs_c(f,_bs_unmap)(void *t, bus_space_handle_t bsh,	\
331 	    bus_size_t size);
332 
333 #define bs_subregion_proto(f)						\
334 int	__bs_c(f,_bs_subregion)(void *t, bus_space_handle_t bsh,	\
335 	    bus_size_t offset, bus_size_t size, 			\
336 	    bus_space_handle_t *nbshp);
337 
338 #define bs_alloc_proto(f)						\
339 int	__bs_c(f,_bs_alloc)(void *t, bus_addr_t rstart,		\
340 	    bus_addr_t rend, bus_size_t size, bus_size_t align,		\
341 	    bus_size_t boundary, int cacheable, bus_addr_t *addrp,	\
342 	    bus_space_handle_t *bshp);
343 
344 #define bs_free_proto(f)						\
345 void	__bs_c(f,_bs_free)(void *t, bus_space_handle_t bsh,	\
346 	    bus_size_t size);
347 
348 #define bs_vaddr_proto(f)						\
349 void *	__bs_c(f,_bs_vaddr)(void *t, bus_space_handle_t bsh);
350 
351 #define bs_mmap_proto(f)						\
352 paddr_t	__bs_c(f,_bs_mmap)(void *, bus_addr_t, off_t, int, int);
353 
354 #define bs_barrier_proto(f)						\
355 void	__bs_c(f,_bs_barrier)(void *t, bus_space_handle_t bsh,	\
356 	    bus_size_t offset, bus_size_t len, int flags);
357 
358 #define	bs_r_1_proto(f)							\
359 uint8_t	__bs_c(f,_bs_r_1)(void *t, bus_space_handle_t bsh,	\
360 		    bus_size_t offset);
361 
362 #define	bs_r_2_proto(f)							\
363 uint16_t	__bs_c(f,_bs_r_2)(void *t, bus_space_handle_t bsh,	\
364 		    bus_size_t offset);					\
365 uint16_t	__bs_c(f,_bs_r_2_swap)(void *t, bus_space_handle_t bsh,	\
366 		    bus_size_t offset);
367 
368 #define	bs_r_4_proto(f)							\
369 uint32_t	__bs_c(f,_bs_r_4)(void *t, bus_space_handle_t bsh,	\
370 		    bus_size_t offset);					\
371 uint32_t	__bs_c(f,_bs_r_4_swap)(void *t, bus_space_handle_t bsh,	\
372 		    bus_size_t offset);
373 
374 #define	bs_r_8_proto(f)							\
375 uint64_t	__bs_c(f,_bs_r_8)(void *t, bus_space_handle_t bsh,	\
376 		    bus_size_t offset);					\
377 uint64_t	__bs_c(f,_bs_r_8_swap)(void *t, bus_space_handle_t bsh,	\
378 		    bus_size_t offset);
379 
380 #define	bs_w_1_proto(f)							\
381 void	__bs_c(f,_bs_w_1)(void *t, bus_space_handle_t bsh,		\
382 	    bus_size_t offset, uint8_t value);
383 
384 #define	bs_w_2_proto(f)							\
385 void	__bs_c(f,_bs_w_2)(void *t, bus_space_handle_t bsh,		\
386 	    bus_size_t offset, uint16_t value);				\
387 void	__bs_c(f,_bs_w_2_swap)(void *t, bus_space_handle_t bsh,		\
388 	    bus_size_t offset, uint16_t value);
389 
390 #define	bs_w_4_proto(f)							\
391 void	__bs_c(f,_bs_w_4)(void *t, bus_space_handle_t bsh,		\
392 	    bus_size_t offset, uint32_t value);				\
393 void	__bs_c(f,_bs_w_4_swap)(void *t, bus_space_handle_t bsh,		\
394 	    bus_size_t offset, uint32_t value);
395 
396 #define	bs_w_8_proto(f)							\
397 void	__bs_c(f,_bs_w_8)(void *t, bus_space_handle_t bsh,		\
398 	    bus_size_t offset, uint64_t value);				\
399 void	__bs_c(f,_bs_w_8_swap)(void *t, bus_space_handle_t bsh,		\
400 	    bus_size_t offset, uint64_t value);
401 
402 #define	bs_rm_1_proto(f)						\
403 void	__bs_c(f,_bs_rm_1)(void *t, bus_space_handle_t bsh,		\
404 	    bus_size_t offset, uint8_t *addr, bus_size_t count);
405 
406 #define	bs_rm_2_proto(f)						\
407 void	__bs_c(f,_bs_rm_2)(void *t, bus_space_handle_t bsh,		\
408 	    bus_size_t offset, uint16_t *addr, bus_size_t count);	\
409 void	__bs_c(f,_bs_rm_2_swap)(void *t, bus_space_handle_t bsh,	\
410 	    bus_size_t offset, uint16_t *addr, bus_size_t count);
411 
412 #define	bs_rm_4_proto(f)						\
413 void	__bs_c(f,_bs_rm_4)(void *t, bus_space_handle_t bsh,		\
414 	    bus_size_t offset, uint32_t *addr, bus_size_t count);	\
415 void	__bs_c(f,_bs_rm_4_swap)(void *t, bus_space_handle_t bsh,	\
416 	    bus_size_t offset, uint32_t *addr, bus_size_t count);
417 
418 #define	bs_rm_8_proto(f)						\
419 void	__bs_c(f,_bs_rm_8)(void *t, bus_space_handle_t bsh,		\
420 	    bus_size_t offset, uint64_t *addr, bus_size_t count);	\
421 void	__bs_c(f,_bs_rm_8_swap)(void *t, bus_space_handle_t bsh,	\
422 	    bus_size_t offset, uint64_t *addr, bus_size_t count);
423 
424 #define	bs_wm_1_proto(f)						\
425 void	__bs_c(f,_bs_wm_1)(void *t, bus_space_handle_t bsh,		\
426 	    bus_size_t offset, const uint8_t *addr, bus_size_t count);	\
427 
428 #define	bs_wm_2_proto(f)						\
429 void	__bs_c(f,_bs_wm_2)(void *t, bus_space_handle_t bsh,		\
430 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);	\
431 void	__bs_c(f,_bs_wm_2_swap)(void *t, bus_space_handle_t bsh,	\
432 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
433 
434 #define	bs_wm_4_proto(f)						\
435 void	__bs_c(f,_bs_wm_4)(void *t, bus_space_handle_t bsh,		\
436 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);	\
437 void	__bs_c(f,_bs_wm_4_swap)(void *t, bus_space_handle_t bsh,	\
438 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
439 
440 #define	bs_wm_8_proto(f)						\
441 void	__bs_c(f,_bs_wm_8)(void *t, bus_space_handle_t bsh,		\
442 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);	\
443 void	__bs_c(f,_bs_wm_8_swap)(void *t, bus_space_handle_t bsh,	\
444 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
445 
446 #define	bs_rr_1_proto(f)						\
447 void	__bs_c(f, _bs_rr_1)(void *t, bus_space_handle_t bsh,		\
448 	    bus_size_t offset, uint8_t *addr, bus_size_t count);
449 
450 #define	bs_rr_2_proto(f)						\
451 void	__bs_c(f, _bs_rr_2)(void *t, bus_space_handle_t bsh,		\
452 	    bus_size_t offset, uint16_t *addr, bus_size_t count);	\
453 void	__bs_c(f, _bs_rr_2_swap)(void *t, bus_space_handle_t bsh,	\
454 	    bus_size_t offset, uint16_t *addr, bus_size_t count);
455 
456 #define	bs_rr_4_proto(f)						\
457 void	__bs_c(f, _bs_rr_4)(void *t, bus_space_handle_t bsh,		\
458 	    bus_size_t offset, uint32_t *addr, bus_size_t count);	\
459 void	__bs_c(f, _bs_rr_4_swap)(void *t, bus_space_handle_t bsh,	\
460 	    bus_size_t offset, uint32_t *addr, bus_size_t count);
461 
462 #define	bs_rr_8_proto(f)						\
463 void	__bs_c(f, _bs_rr_8)(void *t, bus_space_handle_t bsh,		\
464 	    bus_size_t offset, uint64_t *addr, bus_size_t count);	\
465 void	__bs_c(f, _bs_rr_8_swap)(void *t, bus_space_handle_t bsh,	\
466 	    bus_size_t offset, uint64_t *addr, bus_size_t count);
467 
468 #define	bs_wr_1_proto(f)						\
469 void	__bs_c(f, _bs_wr_1)(void *t, bus_space_handle_t bsh,		\
470 	    bus_size_t offset, const uint8_t *addr, bus_size_t count);
471 
472 #define	bs_wr_2_proto(f)						\
473 void	__bs_c(f, _bs_wr_2)(void *t, bus_space_handle_t bsh,		\
474 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);	\
475 void	__bs_c(f, _bs_wr_2_swap)(void *t, bus_space_handle_t bsh,	\
476 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
477 
478 #define	bs_wr_4_proto(f)						\
479 void	__bs_c(f, _bs_wr_4)(void *t, bus_space_handle_t bsh,		\
480 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);	\
481 void	__bs_c(f, _bs_wr_4_swap)(void *t, bus_space_handle_t bsh,	\
482 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
483 
484 #define	bs_wr_8_proto(f)						\
485 void	__bs_c(f, _bs_wr_8)(void *t, bus_space_handle_t bsh,		\
486 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);	\
487 void	__bs_c(f, _bs_wr_8_swap)(void *t, bus_space_handle_t bsh,	\
488 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
489 
490 #define	bs_sm_1_proto(f)						\
491 void	__bs_c(f,_bs_sm_1)(void *t, bus_space_handle_t bsh,		\
492 	    bus_size_t offset, uint8_t value, bus_size_t count);
493 
494 #define	bs_sm_2_proto(f)						\
495 void	__bs_c(f,_bs_sm_2)(void *t, bus_space_handle_t bsh,		\
496 	    bus_size_t offset, uint16_t value, bus_size_t count);
497 
498 #define	bs_sm_4_proto(f)						\
499 void	__bs_c(f,_bs_sm_4)(void *t, bus_space_handle_t bsh,		\
500 	    bus_size_t offset, uint32_t value, bus_size_t count);
501 
502 #define	bs_sm_8_proto(f)						\
503 void	__bs_c(f,_bs_sm_8)(void *t, bus_space_handle_t bsh,		\
504 	    bus_size_t offset, uint64_t value, bus_size_t count);
505 
506 #define	bs_sr_1_proto(f)						\
507 void	__bs_c(f,_bs_sr_1)(void *t, bus_space_handle_t bsh,		\
508 	    bus_size_t offset, uint8_t value, bus_size_t count);
509 
510 #define	bs_sr_2_proto(f)						\
511 void	__bs_c(f,_bs_sr_2)(void *t, bus_space_handle_t bsh,		\
512 	    bus_size_t offset, uint16_t value, bus_size_t count);	\
513 void	__bs_c(f,_bs_sr_2_swap)(void *t, bus_space_handle_t bsh,	\
514 	    bus_size_t offset, uint16_t value, bus_size_t count);
515 
516 #define	bs_sr_4_proto(f)						\
517 void	__bs_c(f,_bs_sr_4)(void *t, bus_space_handle_t bsh,		\
518 	    bus_size_t offset, uint32_t value, bus_size_t count);	\
519 void	__bs_c(f,_bs_sr_4_swap)(void *t, bus_space_handle_t bsh,	\
520 	    bus_size_t offset, uint32_t value, bus_size_t count);
521 
522 #define	bs_sr_8_proto(f)						\
523 void	__bs_c(f,_bs_sr_8)(void *t, bus_space_handle_t bsh,		\
524 	    bus_size_t offset, uint64_t value, bus_size_t count);	\
525 void	__bs_c(f,_bs_sr_8_swap)(void *t, bus_space_handle_t bsh,	\
526 	    bus_size_t offset, uint64_t value, bus_size_t count);
527 
528 #define	bs_c_1_proto(f)							\
529 void	__bs_c(f,_bs_c_1)(void *t, bus_space_handle_t bsh1,		\
530 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
531 	    bus_size_t offset2, bus_size_t count);
532 
533 #define	bs_c_2_proto(f)							\
534 void	__bs_c(f,_bs_c_2)(void *t, bus_space_handle_t bsh1,		\
535 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
536 	    bus_size_t offset2, bus_size_t count);
537 
538 #define	bs_c_4_proto(f)							\
539 void	__bs_c(f,_bs_c_4)(void *t, bus_space_handle_t bsh1,		\
540 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
541 	    bus_size_t offset2, bus_size_t count);
542 
543 #define	bs_c_8_proto(f)							\
544 void	__bs_c(f,_bs_c_8)(void *t, bus_space_handle_t bsh1,		\
545 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
546 	    bus_size_t offset2, bus_size_t count);
547 
548 #define	bs_pe_1_proto(f)						\
549 int	__bs_c(f,_bs_pe_1)(void *t, bus_space_handle_t bsh,		\
550 	    bus_size_t offset, uint8_t *datap);
551 
552 #define	bs_pe_2_proto(f)						\
553 int	__bs_c(f,_bs_pe_2)(void *t, bus_space_handle_t bsh,		\
554 	    bus_size_t offset, uint16_t *datap);			\
555 
556 #define	bs_pe_4_proto(f)						\
557 int	__bs_c(f,_bs_pe_4)(void *t, bus_space_handle_t bsh,		\
558 	    bus_size_t offset, uint32_t *datap);			\
559 
560 #define	bs_pe_8_proto(f)						\
561 int	__bs_c(f,_bs_pe_8)(void *t, bus_space_handle_t bsh,		\
562 	    bus_size_t offset, uint64_t *datap);			\
563 
564 #define	bs_po_1_proto(f)						\
565 int	__bs_c(f,_bs_po_1)(void *t, bus_space_handle_t bsh,		\
566 	    bus_size_t offset, uint8_t value);
567 
568 #define	bs_po_2_proto(f)						\
569 int	__bs_c(f,_bs_po_2)(void *t, bus_space_handle_t bsh,		\
570 	    bus_size_t offset, uint16_t value);				\
571 
572 #define	bs_po_4_proto(f)						\
573 int	__bs_c(f,_bs_po_4)(void *t, bus_space_handle_t bsh,		\
574 	    bus_size_t offset, uint32_t value);				\
575 
576 #define	bs_po_8_proto(f)						\
577 int	__bs_c(f,_bs_po_8)(void *t, bus_space_handle_t bsh,		\
578 	    bus_size_t offset, uint64_t value);				\
579 
580 
581 #define bs_protos(f)		\
582 bs_map_proto(f);		\
583 bs_unmap_proto(f);		\
584 bs_subregion_proto(f);		\
585 bs_alloc_proto(f);		\
586 bs_free_proto(f);		\
587 bs_vaddr_proto(f);		\
588 bs_mmap_proto(f);		\
589 bs_barrier_proto(f);		\
590 bs_r_1_proto(f);		\
591 bs_r_2_proto(f);		\
592 bs_r_4_proto(f);		\
593 bs_r_8_proto(f);		\
594 bs_w_1_proto(f);		\
595 bs_w_2_proto(f);		\
596 bs_w_4_proto(f);		\
597 bs_w_8_proto(f);		\
598 bs_rm_1_proto(f);		\
599 bs_rm_2_proto(f);		\
600 bs_rm_4_proto(f);		\
601 bs_rm_8_proto(f);		\
602 bs_wm_1_proto(f);		\
603 bs_wm_2_proto(f);		\
604 bs_wm_4_proto(f);		\
605 bs_wm_8_proto(f);		\
606 bs_rr_1_proto(f);		\
607 bs_rr_2_proto(f);		\
608 bs_rr_4_proto(f);		\
609 bs_rr_8_proto(f);		\
610 bs_wr_1_proto(f);		\
611 bs_wr_2_proto(f);		\
612 bs_wr_4_proto(f);		\
613 bs_wr_8_proto(f);		\
614 bs_sm_1_proto(f);		\
615 bs_sm_2_proto(f);		\
616 bs_sm_4_proto(f);		\
617 bs_sm_8_proto(f);		\
618 bs_sr_1_proto(f);		\
619 bs_sr_2_proto(f);		\
620 bs_sr_4_proto(f);		\
621 bs_sr_8_proto(f);		\
622 bs_c_1_proto(f);		\
623 bs_c_2_proto(f);		\
624 bs_c_4_proto(f);		\
625 bs_c_8_proto(f);		\
626 bs_pe_1_proto(f);		\
627 bs_pe_2_proto(f);		\
628 bs_pe_4_proto(f);		\
629 bs_pe_8_proto(f);		\
630 bs_po_1_proto(f);		\
631 bs_po_2_proto(f);		\
632 bs_po_4_proto(f);		\
633 bs_po_8_proto(f);
634 
635 /* Bus Space DMA macros */
636 
637 /* Forwards needed by prototypes below. */
638 struct mbuf;
639 struct uio;
640 
641 int bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t, bus_size_t,
642     int, bus_dmamap_t *);
643 void bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
644 int bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, bus_size_t,
645     struct proc *, int);
646 int bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, struct mbuf *, int);
647 int bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, struct uio *, int);
648 int bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t, bus_dma_segment_t *,
649     int, bus_size_t, int);
650 void bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
651 void bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t, bus_size_t, int);
652 
653 #define	bus_dmamem_alloc(t, s, a, b, sg, n, r, f)		\
654 	(*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
655 #define	bus_dmamem_free(t, sg, n)				\
656 	(*(t)->_dmamem_free)((t), (sg), (n))
657 #define	bus_dmamem_map(t, sg, n, s, k, f)			\
658 	(*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
659 #define	bus_dmamem_unmap(t, k, s)				\
660 	(*(t)->_dmamem_unmap)((t), (k), (s))
661 #define	bus_dmamem_mmap(t, sg, n, o, p, f)			\
662 	(*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))
663 
664 #define	bus_dmatag_subregion(t, mna, mxa, nt, f)		\
665 	(*(t)->_dmatag_subregion)((t), (mna), (mxa), (nt), (f))
666 #define	bus_dmatag_destroy(t)					\
667 	(*(t)->_dmatag_destroy)(t)
668 
669 #ifdef _ARM32_BUS_DMA_PRIVATE
670 
671 extern paddr_t physical_start, physical_end;
672 
673 int	arm32_dma_range_intersect(struct arm32_dma_range *, int,
674 	    paddr_t pa, psize_t size, paddr_t *pap, psize_t *sizep);
675 
676 int	_bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t,
677 	    bus_size_t, int, bus_dmamap_t *);
678 void	_bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
679 int	_bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *,
680 	    bus_size_t, struct proc *, int);
681 int	_bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t,
682 	    struct mbuf *, int);
683 int	_bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t,
684 	    struct uio *, int);
685 int	_bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
686 	    bus_dma_segment_t *, int, bus_size_t, int);
687 void	_bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
688 void	_bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
689 	    bus_size_t, int);
690 
691 #if defined(_ARM32_NEED_BUS_DMA_BOUNCE) || defined(CPU_CORTEX)
692 #define	_BUS_DMAMAP_SYNC_FUNCS \
693 	._dmamap_sync_pre = _bus_dmamap_sync,	\
694 	._dmamap_sync_post = _bus_dmamap_sync
695 #else
696 #define	_BUS_DMAMAP_SYNC_FUNCS \
697 	._dmamap_sync_pre = _bus_dmamap_sync
698 #endif
699 
700 #define	_BUS_DMAMAP_FUNCS \
701 	._dmamap_create = _bus_dmamap_create,		\
702 	._dmamap_destroy = _bus_dmamap_destroy,		\
703 	._dmamap_load = _bus_dmamap_load,		\
704 	._dmamap_load_mbuf = _bus_dmamap_load_mbuf,	\
705 	._dmamap_load_raw = _bus_dmamap_load_raw,	\
706 	._dmamap_load_uio = _bus_dmamap_load_uio,	\
707 	._dmamap_unload = _bus_dmamap_unload,		\
708 	_BUS_DMAMAP_SYNC_FUNCS
709 
710 int	_bus_dmamem_alloc(bus_dma_tag_t tag, bus_size_t size,
711 	    bus_size_t alignment, bus_size_t boundary,
712 	    bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags);
713 void	_bus_dmamem_free(bus_dma_tag_t tag, bus_dma_segment_t *segs,
714 	    int nsegs);
715 int	_bus_dmamem_map(bus_dma_tag_t tag, bus_dma_segment_t *segs,
716 	    int nsegs, size_t size, void **kvap, int flags);
717 void	_bus_dmamem_unmap(bus_dma_tag_t tag, void *kva,
718 	    size_t size);
719 paddr_t	_bus_dmamem_mmap(bus_dma_tag_t tag, bus_dma_segment_t *segs,
720 	    int nsegs, off_t off, int prot, int flags);
721 
722 #define	_BUS_DMAMEM_FUNCS \
723 	._dmamem_alloc = _bus_dmamem_alloc,	\
724 	._dmamem_free = _bus_dmamem_free,	\
725 	._dmamem_map = _bus_dmamem_map,		\
726 	._dmamem_unmap = _bus_dmamem_unmap,	\
727 	._dmamem_mmap = _bus_dmamem_mmap
728 
729 int	_bus_dmamem_alloc_range(bus_dma_tag_t tag, bus_size_t size,
730 	    bus_size_t alignment, bus_size_t boundary,
731 	    bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags,
732 	    vaddr_t low, vaddr_t high);
733 
734 int	_bus_dmatag_subregion(bus_dma_tag_t, bus_addr_t, bus_addr_t,
735 	    bus_dma_tag_t *, int);
736 void 	_bus_dmatag_destroy(bus_dma_tag_t);
737 
738 #define	_BUS_DMATAG_FUNCS \
739 	._dmatag_subregion = _bus_dmatag_subregion,	\
740 	._dmatag_destroy = _bus_dmatag_destroy
741 
742 #endif /* _ARM32_BUS_DMA_PRIVATE */
743 
744 #endif /* _ARM_BUS_FUNCS_H_ */
745