xref: /freebsd/sys/arm/include/bus.h (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1 /*	$NetBSD: bus.h,v 1.11 2003/07/28 17:35:54 thorpej 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  * SPDX-License-Identifier: BSD-4-Clause
35  *
36  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
37  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
38  *
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  * 1. Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  * 2. Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in the
46  *    documentation and/or other materials provided with the distribution.
47  * 3. All advertising materials mentioning features or use of this software
48  *    must display the following acknowledgement:
49  *      This product includes software developed by Christopher G. Demetriou
50  *	for the NetBSD Project.
51  * 4. The name of the author may not be used to endorse or promote products
52  *    derived from this software without specific prior written permission
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
55  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
56  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
57  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
58  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
59  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
60  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
61  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
62  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
63  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64  *
65  * $FreeBSD$
66  */
67 
68 #ifndef _MACHINE_BUS_H_
69 #define _MACHINE_BUS_H_
70 
71 #include <machine/_bus.h>
72 
73 /*
74  *	int bus_space_map  (bus_space_tag_t t, bus_addr_t addr,
75  *	    bus_size_t size, int flags, bus_space_handle_t *bshp);
76  *
77  * Map a region of bus space.
78  */
79 
80 #define	BUS_SPACE_MAP_CACHEABLE		0x01
81 #define	BUS_SPACE_MAP_LINEAR		0x02
82 #define	BUS_SPACE_MAP_PREFETCHABLE     	0x04
83 
84 /*
85  * Bus space for ARM.
86  *
87  * The functions used most often are grouped together at the beginning to ensure
88  * that all the data fits into a single cache line.  The inline implementations
89  * of single read/write access these values a lot.
90  */
91 struct bus_space {
92 	/* Read/write single and barrier: the most commonly used functions. */
93 	uint8_t	 (*bs_r_1)(bus_space_tag_t, bus_space_handle_t, bus_size_t);
94 	uint32_t (*bs_r_4)(bus_space_tag_t, bus_space_handle_t, bus_size_t);
95 	void	 (*bs_w_1)(bus_space_tag_t, bus_space_handle_t,
96 			   bus_size_t, uint8_t);
97 	void	 (*bs_w_4)(bus_space_tag_t, bus_space_handle_t,
98 			   bus_size_t, uint32_t);
99 	void	 (*bs_barrier)(bus_space_tag_t, bus_space_handle_t,
100 			       bus_size_t, bus_size_t, int);
101 
102 	/* Backlink to parent (if copied), and implementation private data. */
103 	struct bus_space *bs_parent;
104 	void		 *bs_privdata;
105 
106 	/* mapping/unmapping */
107 	int		(*bs_map) (bus_space_tag_t, bus_addr_t, bus_size_t,
108 			    int, bus_space_handle_t *);
109 	void		(*bs_unmap) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
110 	int		(*bs_subregion) (bus_space_tag_t, bus_space_handle_t,
111 			    bus_size_t, bus_size_t, bus_space_handle_t *);
112 
113 	/* allocation/deallocation */
114 	int		(*bs_alloc) (bus_space_tag_t, bus_addr_t, bus_addr_t,
115 			    bus_size_t, bus_size_t, bus_size_t, int,
116 			    bus_addr_t *, bus_space_handle_t *);
117 	void		(*bs_free) (bus_space_tag_t, bus_space_handle_t,
118 			    bus_size_t);
119 
120 	/* Read single, the less commonly used functions. */
121 	uint16_t	(*bs_r_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
122 	uint64_t	(*bs_r_8) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
123 
124 	/* read multiple */
125 	void		(*bs_rm_1) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
126 	    uint8_t *, bus_size_t);
127 	void		(*bs_rm_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
128 	    uint16_t *, bus_size_t);
129 	void		(*bs_rm_4) (bus_space_tag_t, bus_space_handle_t,
130 			    bus_size_t, uint32_t *, bus_size_t);
131 	void		(*bs_rm_8) (bus_space_tag_t, bus_space_handle_t,
132 			    bus_size_t, uint64_t *, bus_size_t);
133 
134 	/* read region */
135 	void		(*bs_rr_1) (bus_space_tag_t, bus_space_handle_t,
136 			    bus_size_t, uint8_t *, bus_size_t);
137 	void		(*bs_rr_2) (bus_space_tag_t, bus_space_handle_t,
138 			    bus_size_t, uint16_t *, bus_size_t);
139 	void		(*bs_rr_4) (bus_space_tag_t, bus_space_handle_t,
140 			    bus_size_t, uint32_t *, bus_size_t);
141 	void		(*bs_rr_8) (bus_space_tag_t, bus_space_handle_t,
142 			    bus_size_t, uint64_t *, bus_size_t);
143 
144 	/* Write single, the less commonly used functions. */
145 	void		(*bs_w_2) (bus_space_tag_t, bus_space_handle_t,
146 			    bus_size_t, uint16_t);
147 	void		(*bs_w_8) (bus_space_tag_t, bus_space_handle_t,
148 			    bus_size_t, uint64_t);
149 
150 	/* write multiple */
151 	void		(*bs_wm_1) (bus_space_tag_t, bus_space_handle_t,
152 			    bus_size_t, const uint8_t *, bus_size_t);
153 	void		(*bs_wm_2) (bus_space_tag_t, bus_space_handle_t,
154 			    bus_size_t, const uint16_t *, bus_size_t);
155 	void		(*bs_wm_4) (bus_space_tag_t, bus_space_handle_t,
156 			    bus_size_t, const uint32_t *, bus_size_t);
157 	void		(*bs_wm_8) (bus_space_tag_t, bus_space_handle_t,
158 			    bus_size_t, const uint64_t *, bus_size_t);
159 
160 	/* write region */
161 	void		(*bs_wr_1) (bus_space_tag_t, bus_space_handle_t,
162 			    bus_size_t, const uint8_t *, bus_size_t);
163 	void		(*bs_wr_2) (bus_space_tag_t, bus_space_handle_t,
164 			    bus_size_t, const uint16_t *, bus_size_t);
165 	void		(*bs_wr_4) (bus_space_tag_t, bus_space_handle_t,
166 			    bus_size_t, const uint32_t *, bus_size_t);
167 	void		(*bs_wr_8) (bus_space_tag_t, bus_space_handle_t,
168 			    bus_size_t, const uint64_t *, bus_size_t);
169 
170 	/* set multiple */
171 	void		(*bs_sm_1) (bus_space_tag_t, bus_space_handle_t,
172 			    bus_size_t, uint8_t, bus_size_t);
173 	void		(*bs_sm_2) (bus_space_tag_t, bus_space_handle_t,
174 			    bus_size_t, uint16_t, bus_size_t);
175 	void		(*bs_sm_4) (bus_space_tag_t, bus_space_handle_t,
176 			    bus_size_t, uint32_t, bus_size_t);
177 	void		(*bs_sm_8) (bus_space_tag_t, bus_space_handle_t,
178 			    bus_size_t, uint64_t, bus_size_t);
179 
180 	/* set region */
181 	void		(*bs_sr_1) (bus_space_tag_t, bus_space_handle_t,
182 			    bus_size_t, uint8_t, bus_size_t);
183 	void		(*bs_sr_2) (bus_space_tag_t, bus_space_handle_t,
184 			    bus_size_t, uint16_t, bus_size_t);
185 	void		(*bs_sr_4) (bus_space_tag_t, bus_space_handle_t,
186 			    bus_size_t, uint32_t, bus_size_t);
187 	void		(*bs_sr_8) (bus_space_tag_t, bus_space_handle_t,
188 			    bus_size_t, uint64_t, bus_size_t);
189 
190 	/* copy */
191 	void		(*bs_c_1) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
192 			    bus_space_handle_t, bus_size_t, bus_size_t);
193 	void		(*bs_c_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
194 			    bus_space_handle_t, bus_size_t, bus_size_t);
195 	void		(*bs_c_4) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
196 			    bus_space_handle_t, bus_size_t, bus_size_t);
197 	void		(*bs_c_8) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
198 			    bus_space_handle_t, bus_size_t, bus_size_t);
199 
200 	/* read stream (single) */
201 	uint8_t	(*bs_r_1_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
202 	uint16_t	(*bs_r_2_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
203 	uint32_t	(*bs_r_4_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
204 	uint64_t	(*bs_r_8_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
205 
206 	/* read multiple stream */
207 	void		(*bs_rm_1_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
208 	    uint8_t *, bus_size_t);
209 	void		(*bs_rm_2_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
210 	    uint16_t *, bus_size_t);
211 	void		(*bs_rm_4_s) (bus_space_tag_t, bus_space_handle_t,
212 			    bus_size_t, uint32_t *, bus_size_t);
213 	void		(*bs_rm_8_s) (bus_space_tag_t, bus_space_handle_t,
214 			    bus_size_t, uint64_t *, bus_size_t);
215 
216 	/* read region stream */
217 	void		(*bs_rr_1_s) (bus_space_tag_t, bus_space_handle_t,
218 			    bus_size_t, uint8_t *, bus_size_t);
219 	void		(*bs_rr_2_s) (bus_space_tag_t, bus_space_handle_t,
220 			    bus_size_t, uint16_t *, bus_size_t);
221 	void		(*bs_rr_4_s) (bus_space_tag_t, bus_space_handle_t,
222 			    bus_size_t, uint32_t *, bus_size_t);
223 	void		(*bs_rr_8_s) (bus_space_tag_t, bus_space_handle_t,
224 			    bus_size_t, uint64_t *, bus_size_t);
225 
226 	/* write stream (single) */
227 	void		(*bs_w_1_s) (bus_space_tag_t, bus_space_handle_t,
228 			    bus_size_t, uint8_t);
229 	void		(*bs_w_2_s) (bus_space_tag_t, bus_space_handle_t,
230 			    bus_size_t, uint16_t);
231 	void		(*bs_w_4_s) (bus_space_tag_t, bus_space_handle_t,
232 			    bus_size_t, uint32_t);
233 	void		(*bs_w_8_s) (bus_space_tag_t, bus_space_handle_t,
234 			    bus_size_t, uint64_t);
235 
236 	/* write multiple stream */
237 	void		(*bs_wm_1_s) (bus_space_tag_t, bus_space_handle_t,
238 			    bus_size_t, const uint8_t *, bus_size_t);
239 	void		(*bs_wm_2_s) (bus_space_tag_t, bus_space_handle_t,
240 			    bus_size_t, const uint16_t *, bus_size_t);
241 	void		(*bs_wm_4_s) (bus_space_tag_t, bus_space_handle_t,
242 			    bus_size_t, const uint32_t *, bus_size_t);
243 	void		(*bs_wm_8_s) (bus_space_tag_t, bus_space_handle_t,
244 			    bus_size_t, const uint64_t *, bus_size_t);
245 
246 	/* write region stream */
247 	void		(*bs_wr_1_s) (bus_space_tag_t, bus_space_handle_t,
248 			    bus_size_t, const uint8_t *, bus_size_t);
249 	void		(*bs_wr_2_s) (bus_space_tag_t, bus_space_handle_t,
250 			    bus_size_t, const uint16_t *, bus_size_t);
251 	void		(*bs_wr_4_s) (bus_space_tag_t, bus_space_handle_t,
252 			    bus_size_t, const uint32_t *, bus_size_t);
253 	void		(*bs_wr_8_s) (bus_space_tag_t, bus_space_handle_t,
254 			    bus_size_t, const uint64_t *, bus_size_t);
255 };
256 
257 #if __ARM_ARCH < 6
258 extern bus_space_tag_t arm_base_bs_tag;
259 #endif
260 
261 /*
262  * Utility macros; INTERNAL USE ONLY.
263  */
264 #define	__bs_c(a,b)		__CONCAT(a,b)
265 #define	__bs_opname(op,size)	__bs_c(__bs_c(__bs_c(bs_,op),_),size)
266 
267 #define	__bs_nonsingle(type, sz, t, h, o, a, c)				\
268 	(*(t)->__bs_opname(type,sz))((t), h, o, a, c)
269 #define	__bs_set(type, sz, t, h, o, v, c)				\
270 	(*(t)->__bs_opname(type,sz))((t), h, o, v, c)
271 #define	__bs_copy(sz, t, h1, o1, h2, o2, cnt)				\
272 	(*(t)->__bs_opname(c,sz))((t), h1, o1, h2, o2, cnt)
273 
274 #define	__bs_opname_s(op,size)	__bs_c(__bs_c(__bs_c(__bs_c(bs_,op),_),size),_s)
275 #define	__bs_rs_s(sz, t, h, o)						\
276 	(*(t)->__bs_opname_s(r,sz))((t), h, o)
277 #define	__bs_ws_s(sz, t, h, o, v)					\
278 	(*(t)->__bs_opname_s(w,sz))((t), h, o, v)
279 #define	__bs_nonsingle_s(type, sz, t, h, o, a, c)			\
280 	(*(t)->__bs_opname_s(type,sz))((t), h, o, a, c)
281 
282 
283 #define __generate_inline_bs_rs(IFN, MBR, TYP)					\
284 	static inline TYP						\
285 	IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o)	\
286 	{								\
287 									\
288 		if (__predict_true(t->MBR == NULL))			\
289 			return (*(volatile TYP *)(h + o));		\
290 		else							\
291 			return (t->MBR(t, h, o));		\
292 	}
293 
294 #define __generate_inline_bs_ws(IFN, MBR, TYP)					\
295 	static inline void						\
296 	IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o, TYP v)\
297 	{								\
298 									\
299 		if (__predict_true(t->MBR == NULL))			\
300 			*(volatile TYP *)(h + o) = v;			\
301 		else							\
302 			t->MBR(t, h, o, v);			\
303 	}
304 
305 /*
306  * Mapping and unmapping operations.
307  */
308 #define	bus_space_map(t, a, s, c, hp)					\
309 	(*(t)->bs_map)((t), (a), (s), (c), (hp))
310 #define	bus_space_unmap(t, h, s)					\
311 	(*(t)->bs_unmap)((t), (h), (s))
312 #define	bus_space_subregion(t, h, o, s, hp)				\
313 	(*(t)->bs_subregion)((t), (h), (o), (s), (hp))
314 
315 
316 /*
317  * Allocation and deallocation operations.
318  */
319 #define	bus_space_alloc(t, rs, re, s, a, b, c, ap, hp)			\
320 	(*(t)->bs_alloc)((t), (rs), (re), (s), (a), (b),	\
321 	    (c), (ap), (hp))
322 #define	bus_space_free(t, h, s)						\
323 	(*(t)->bs_free)((t), (h), (s))
324 
325 /*
326  * Bus barrier operations.
327  */
328 #define	bus_space_barrier(t, h, o, l, f)				\
329 	(*(t)->bs_barrier)((t), (h), (o), (l), (f))
330 
331 #define	BUS_SPACE_BARRIER_READ	0x01
332 #define	BUS_SPACE_BARRIER_WRITE	0x02
333 
334 /*
335  * Bus read (single) operations.
336  */
337 __generate_inline_bs_rs(bus_space_read_1, bs_r_1, uint8_t);
338 __generate_inline_bs_rs(bus_space_read_2, bs_r_2, uint16_t);
339 __generate_inline_bs_rs(bus_space_read_4, bs_r_4, uint32_t);
340 __generate_inline_bs_rs(bus_space_read_8, bs_r_8, uint64_t);
341 
342 __generate_inline_bs_rs(bus_space_read_stream_1, bs_r_1_s, uint8_t);
343 __generate_inline_bs_rs(bus_space_read_stream_2, bs_r_2_s, uint16_t);
344 __generate_inline_bs_rs(bus_space_read_stream_4, bs_r_4_s, uint32_t);
345 __generate_inline_bs_rs(bus_space_read_stream_8, bs_r_8_s, uint64_t);
346 
347 /*
348  * Bus read multiple operations.
349  */
350 #define	bus_space_read_multi_1(t, h, o, a, c)				\
351 	__bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
352 #define	bus_space_read_multi_2(t, h, o, a, c)				\
353 	__bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
354 #define	bus_space_read_multi_4(t, h, o, a, c)				\
355 	__bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
356 #define	bus_space_read_multi_8(t, h, o, a, c)				\
357 	__bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
358 
359 #define	bus_space_read_multi_stream_1(t, h, o, a, c)			\
360 	__bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
361 #define	bus_space_read_multi_stream_2(t, h, o, a, c)			\
362 	__bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
363 #define	bus_space_read_multi_stream_4(t, h, o, a, c)			\
364 	__bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
365 #define	bus_space_read_multi_stream_8(t, h, o, a, c)			\
366 	__bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
367 
368 
369 /*
370  * Bus read region operations.
371  */
372 #define	bus_space_read_region_1(t, h, o, a, c)				\
373 	__bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
374 #define	bus_space_read_region_2(t, h, o, a, c)				\
375 	__bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
376 #define	bus_space_read_region_4(t, h, o, a, c)				\
377 	__bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
378 #define	bus_space_read_region_8(t, h, o, a, c)				\
379 	__bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
380 
381 #define	bus_space_read_region_stream_1(t, h, o, a, c)			\
382 	__bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
383 #define	bus_space_read_region_stream_2(t, h, o, a, c)			\
384 	__bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
385 #define	bus_space_read_region_stream_4(t, h, o, a, c)			\
386 	__bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
387 #define	bus_space_read_region_stream_8(t, h, o, a, c)			\
388 	__bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
389 
390 
391 /*
392  * Bus write (single) operations.
393  */
394 __generate_inline_bs_ws(bus_space_write_1, bs_w_1, uint8_t);
395 __generate_inline_bs_ws(bus_space_write_2, bs_w_2, uint16_t);
396 __generate_inline_bs_ws(bus_space_write_4, bs_w_4, uint32_t);
397 __generate_inline_bs_ws(bus_space_write_8, bs_w_8, uint64_t);
398 
399 __generate_inline_bs_ws(bus_space_write_stream_1, bs_w_1_s, uint8_t);
400 __generate_inline_bs_ws(bus_space_write_stream_2, bs_w_2_s, uint16_t);
401 __generate_inline_bs_ws(bus_space_write_stream_4, bs_w_4_s, uint32_t);
402 __generate_inline_bs_ws(bus_space_write_stream_8, bs_w_8_s, uint64_t);
403 
404 
405 /*
406  * Bus write multiple operations.
407  */
408 #define	bus_space_write_multi_1(t, h, o, a, c)				\
409 	__bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
410 #define	bus_space_write_multi_2(t, h, o, a, c)				\
411 	__bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
412 #define	bus_space_write_multi_4(t, h, o, a, c)				\
413 	__bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
414 #define	bus_space_write_multi_8(t, h, o, a, c)				\
415 	__bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
416 
417 #define	bus_space_write_multi_stream_1(t, h, o, a, c)			\
418 	__bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
419 #define	bus_space_write_multi_stream_2(t, h, o, a, c)			\
420 	__bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
421 #define	bus_space_write_multi_stream_4(t, h, o, a, c)			\
422 	__bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
423 #define	bus_space_write_multi_stream_8(t, h, o, a, c)			\
424 	__bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
425 
426 
427 /*
428  * Bus write region operations.
429  */
430 #define	bus_space_write_region_1(t, h, o, a, c)				\
431 	__bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
432 #define	bus_space_write_region_2(t, h, o, a, c)				\
433 	__bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
434 #define	bus_space_write_region_4(t, h, o, a, c)				\
435 	__bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
436 #define	bus_space_write_region_8(t, h, o, a, c)				\
437 	__bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
438 
439 #define	bus_space_write_region_stream_1(t, h, o, a, c)			\
440 	__bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
441 #define	bus_space_write_region_stream_2(t, h, o, a, c)			\
442 	__bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
443 #define	bus_space_write_region_stream_4(t, h, o, a, c)			\
444 	__bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
445 #define	bus_space_write_region_stream_8(t, h, o, a, c)			\
446 	__bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
447 
448 
449 /*
450  * Set multiple operations.
451  */
452 #define	bus_space_set_multi_1(t, h, o, v, c)				\
453 	__bs_set(sm,1,(t),(h),(o),(v),(c))
454 #define	bus_space_set_multi_2(t, h, o, v, c)				\
455 	__bs_set(sm,2,(t),(h),(o),(v),(c))
456 #define	bus_space_set_multi_4(t, h, o, v, c)				\
457 	__bs_set(sm,4,(t),(h),(o),(v),(c))
458 #define	bus_space_set_multi_8(t, h, o, v, c)				\
459 	__bs_set(sm,8,(t),(h),(o),(v),(c))
460 
461 
462 /*
463  * Set region operations.
464  */
465 #define	bus_space_set_region_1(t, h, o, v, c)				\
466 	__bs_set(sr,1,(t),(h),(o),(v),(c))
467 #define	bus_space_set_region_2(t, h, o, v, c)				\
468 	__bs_set(sr,2,(t),(h),(o),(v),(c))
469 #define	bus_space_set_region_4(t, h, o, v, c)				\
470 	__bs_set(sr,4,(t),(h),(o),(v),(c))
471 #define	bus_space_set_region_8(t, h, o, v, c)				\
472 	__bs_set(sr,8,(t),(h),(o),(v),(c))
473 
474 
475 /*
476  * Copy operations.
477  */
478 #define	bus_space_copy_region_1(t, h1, o1, h2, o2, c)				\
479 	__bs_copy(1, t, h1, o1, h2, o2, c)
480 #define	bus_space_copy_region_2(t, h1, o1, h2, o2, c)				\
481 	__bs_copy(2, t, h1, o1, h2, o2, c)
482 #define	bus_space_copy_region_4(t, h1, o1, h2, o2, c)				\
483 	__bs_copy(4, t, h1, o1, h2, o2, c)
484 #define	bus_space_copy_region_8(t, h1, o1, h2, o2, c)				\
485 	__bs_copy(8, t, h1, o1, h2, o2, c)
486 
487 /*
488  * Macros to provide prototypes for all the functions used in the
489  * bus_space structure
490  */
491 
492 #define bs_map_proto(f)							\
493 int	__bs_c(f,_bs_map) (bus_space_tag_t t, bus_addr_t addr,		\
494 	    bus_size_t size, int cacheable, bus_space_handle_t *bshp);
495 
496 #define bs_unmap_proto(f)						\
497 void	__bs_c(f,_bs_unmap) (bus_space_tag_t t, bus_space_handle_t bsh,		\
498 	    bus_size_t size);
499 
500 #define bs_subregion_proto(f)						\
501 int	__bs_c(f,_bs_subregion) (bus_space_tag_t t, bus_space_handle_t bsh,	\
502 	    bus_size_t offset, bus_size_t size, 			\
503 	    bus_space_handle_t *nbshp);
504 
505 #define bs_alloc_proto(f)						\
506 int	__bs_c(f,_bs_alloc) (bus_space_tag_t t, bus_addr_t rstart,		\
507 	    bus_addr_t rend, bus_size_t size, bus_size_t align,		\
508 	    bus_size_t boundary, int cacheable, bus_addr_t *addrp,	\
509 	    bus_space_handle_t *bshp);
510 
511 #define bs_free_proto(f)						\
512 void	__bs_c(f,_bs_free) (bus_space_tag_t t, bus_space_handle_t bsh,	\
513 	    bus_size_t size);
514 
515 #define bs_mmap_proto(f)						\
516 int	__bs_c(f,_bs_mmap) (struct cdev *, vm_offset_t, vm_paddr_t *, int);
517 
518 #define bs_barrier_proto(f)						\
519 void	__bs_c(f,_bs_barrier) (bus_space_tag_t t, bus_space_handle_t bsh,	\
520 	    bus_size_t offset, bus_size_t len, int flags);
521 
522 #define	bs_r_1_proto(f)							\
523 uint8_t	__bs_c(f,_bs_r_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
524 		    bus_size_t offset);
525 
526 #define	bs_r_2_proto(f)							\
527 uint16_t	__bs_c(f,_bs_r_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
528 		    bus_size_t offset);
529 
530 #define	bs_r_4_proto(f)							\
531 uint32_t	__bs_c(f,_bs_r_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
532 		    bus_size_t offset);
533 
534 #define	bs_r_8_proto(f)							\
535 uint64_t	__bs_c(f,_bs_r_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
536 		    bus_size_t offset);
537 
538 #define	bs_r_1_s_proto(f)						\
539 uint8_t	__bs_c(f,_bs_r_1_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
540 		    bus_size_t offset);
541 
542 #define	bs_r_2_s_proto(f)						\
543 uint16_t	__bs_c(f,_bs_r_2_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
544 		    bus_size_t offset);
545 
546 #define	bs_r_4_s_proto(f)						\
547 uint32_t	__bs_c(f,_bs_r_4_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
548 		    bus_size_t offset);
549 
550 #define	bs_w_1_proto(f)							\
551 void	__bs_c(f,_bs_w_1) (bus_space_tag_t t, bus_space_handle_t bsh,		\
552 	    bus_size_t offset, uint8_t value);
553 
554 #define	bs_w_2_proto(f)							\
555 void	__bs_c(f,_bs_w_2) (bus_space_tag_t t, bus_space_handle_t bsh,		\
556 	    bus_size_t offset, uint16_t value);
557 
558 #define	bs_w_4_proto(f)							\
559 void	__bs_c(f,_bs_w_4) (bus_space_tag_t t, bus_space_handle_t bsh,		\
560 	    bus_size_t offset, uint32_t value);
561 
562 #define	bs_w_8_proto(f)							\
563 void	__bs_c(f,_bs_w_8) (bus_space_tag_t t, bus_space_handle_t bsh,		\
564 	    bus_size_t offset, uint64_t value);
565 
566 #define	bs_w_1_s_proto(f)						\
567 void	__bs_c(f,_bs_w_1_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
568 	    bus_size_t offset, uint8_t value);
569 
570 #define	bs_w_2_s_proto(f)						\
571 void	__bs_c(f,_bs_w_2_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
572 	    bus_size_t offset, uint16_t value);
573 
574 #define	bs_w_4_s_proto(f)						\
575 void	__bs_c(f,_bs_w_4_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
576 	    bus_size_t offset, uint32_t value);
577 
578 #define	bs_rm_1_proto(f)						\
579 void	__bs_c(f,_bs_rm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
580 	    bus_size_t offset, uint8_t *addr, bus_size_t count);
581 
582 #define	bs_rm_2_proto(f)						\
583 void	__bs_c(f,_bs_rm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
584 	    bus_size_t offset, uint16_t *addr, bus_size_t count);
585 
586 #define	bs_rm_4_proto(f)						\
587 void	__bs_c(f,_bs_rm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
588 	    bus_size_t offset, uint32_t *addr, bus_size_t count);
589 
590 #define	bs_rm_8_proto(f)						\
591 void	__bs_c(f,_bs_rm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
592 	    bus_size_t offset, uint64_t *addr, bus_size_t count);
593 
594 #define	bs_wm_1_proto(f)						\
595 void	__bs_c(f,_bs_wm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
596 	    bus_size_t offset, const uint8_t *addr, bus_size_t count);
597 
598 #define	bs_wm_2_proto(f)						\
599 void	__bs_c(f,_bs_wm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
600 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
601 
602 #define	bs_wm_4_proto(f)						\
603 void	__bs_c(f,_bs_wm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
604 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
605 
606 #define	bs_wm_8_proto(f)						\
607 void	__bs_c(f,_bs_wm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
608 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
609 
610 #define	bs_rr_1_proto(f)						\
611 void	__bs_c(f, _bs_rr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
612 	    bus_size_t offset, uint8_t *addr, bus_size_t count);
613 
614 #define	bs_rr_2_proto(f)						\
615 void	__bs_c(f, _bs_rr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
616 	    bus_size_t offset, uint16_t *addr, bus_size_t count);
617 
618 #define	bs_rr_4_proto(f)						\
619 void	__bs_c(f, _bs_rr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
620 	    bus_size_t offset, uint32_t *addr, bus_size_t count);
621 
622 #define	bs_rr_8_proto(f)						\
623 void	__bs_c(f, _bs_rr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
624 	    bus_size_t offset, uint64_t *addr, bus_size_t count);
625 
626 #define	bs_wr_1_proto(f)						\
627 void	__bs_c(f, _bs_wr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
628 	    bus_size_t offset, const uint8_t *addr, bus_size_t count);
629 
630 #define	bs_wr_2_proto(f)						\
631 void	__bs_c(f, _bs_wr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
632 	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
633 
634 #define	bs_wr_4_proto(f)						\
635 void	__bs_c(f, _bs_wr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
636 	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
637 
638 #define	bs_wr_8_proto(f)						\
639 void	__bs_c(f, _bs_wr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
640 	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
641 
642 #define	bs_sm_1_proto(f)						\
643 void	__bs_c(f,_bs_sm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
644 	    bus_size_t offset, uint8_t value, bus_size_t count);
645 
646 #define	bs_sm_2_proto(f)						\
647 void	__bs_c(f,_bs_sm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
648 	    bus_size_t offset, uint16_t value, bus_size_t count);
649 
650 #define	bs_sm_4_proto(f)						\
651 void	__bs_c(f,_bs_sm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
652 	    bus_size_t offset, uint32_t value, bus_size_t count);
653 
654 #define	bs_sm_8_proto(f)						\
655 void	__bs_c(f,_bs_sm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
656 	    bus_size_t offset, uint64_t value, bus_size_t count);
657 
658 #define	bs_sr_1_proto(f)						\
659 void	__bs_c(f,_bs_sr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
660 	    bus_size_t offset, uint8_t value, bus_size_t count);
661 
662 #define	bs_sr_2_proto(f)						\
663 void	__bs_c(f,_bs_sr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
664 	    bus_size_t offset, uint16_t value, bus_size_t count);
665 
666 #define	bs_sr_4_proto(f)						\
667 void	__bs_c(f,_bs_sr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
668 	    bus_size_t offset, uint32_t value, bus_size_t count);
669 
670 #define	bs_sr_8_proto(f)						\
671 void	__bs_c(f,_bs_sr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
672 	    bus_size_t offset, uint64_t value, bus_size_t count);
673 
674 #define	bs_c_1_proto(f)							\
675 void	__bs_c(f,_bs_c_1) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
676 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
677 	    bus_size_t offset2, bus_size_t count);
678 
679 #define	bs_c_2_proto(f)							\
680 void	__bs_c(f,_bs_c_2) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
681 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
682 	    bus_size_t offset2, bus_size_t count);
683 
684 #define	bs_c_4_proto(f)							\
685 void	__bs_c(f,_bs_c_4) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
686 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
687 	    bus_size_t offset2, bus_size_t count);
688 
689 #define	bs_c_8_proto(f)							\
690 void	__bs_c(f,_bs_c_8) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
691 	    bus_size_t offset1, bus_space_handle_t bsh2,		\
692 	    bus_size_t offset2, bus_size_t count);
693 
694 #define bs_protos(f)		\
695 bs_map_proto(f);		\
696 bs_unmap_proto(f);		\
697 bs_subregion_proto(f);		\
698 bs_alloc_proto(f);		\
699 bs_free_proto(f);		\
700 bs_mmap_proto(f);		\
701 bs_barrier_proto(f);		\
702 bs_r_1_proto(f);		\
703 bs_r_2_proto(f);		\
704 bs_r_4_proto(f);		\
705 bs_r_8_proto(f);		\
706 bs_r_1_s_proto(f);		\
707 bs_r_2_s_proto(f);		\
708 bs_r_4_s_proto(f);		\
709 bs_w_1_proto(f);		\
710 bs_w_2_proto(f);		\
711 bs_w_4_proto(f);		\
712 bs_w_8_proto(f);		\
713 bs_w_1_s_proto(f);		\
714 bs_w_2_s_proto(f);		\
715 bs_w_4_s_proto(f);		\
716 bs_rm_1_proto(f);		\
717 bs_rm_2_proto(f);		\
718 bs_rm_4_proto(f);		\
719 bs_rm_8_proto(f);		\
720 bs_wm_1_proto(f);		\
721 bs_wm_2_proto(f);		\
722 bs_wm_4_proto(f);		\
723 bs_wm_8_proto(f);		\
724 bs_rr_1_proto(f);		\
725 bs_rr_2_proto(f);		\
726 bs_rr_4_proto(f);		\
727 bs_rr_8_proto(f);		\
728 bs_wr_1_proto(f);		\
729 bs_wr_2_proto(f);		\
730 bs_wr_4_proto(f);		\
731 bs_wr_8_proto(f);		\
732 bs_sm_1_proto(f);		\
733 bs_sm_2_proto(f);		\
734 bs_sm_4_proto(f);		\
735 bs_sm_8_proto(f);		\
736 bs_sr_1_proto(f);		\
737 bs_sr_2_proto(f);		\
738 bs_sr_4_proto(f);		\
739 bs_sr_8_proto(f);		\
740 bs_c_1_proto(f);		\
741 bs_c_2_proto(f);		\
742 bs_c_4_proto(f);		\
743 bs_c_8_proto(f);
744 
745 void generic_bs_unimplemented(void);
746 #define	BS_UNIMPLEMENTED	(void *)generic_bs_unimplemented
747 
748 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
749 
750 #define BUS_SPACE_MAXADDR_24BIT	0xFFFFFF
751 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
752 #define BUS_SPACE_MAXADDR 	0xFFFFFFFF
753 #define BUS_SPACE_MAXSIZE_24BIT	0xFFFFFF
754 #define BUS_SPACE_MAXSIZE_32BIT	0xFFFFFFFF
755 #define BUS_SPACE_MAXSIZE 	0xFFFFFFFF
756 
757 #define BUS_SPACE_UNRESTRICTED	(~0)
758 
759 #include <machine/bus_dma.h>
760 
761 /*
762  * Get the physical address of a bus space memory-mapped resource.
763  * Doing this as a macro is a temporary solution until a more robust fix is
764  * designed.  It also serves to mark the locations needing that fix.
765  */
766 #define BUS_SPACE_PHYSADDR(res, offs) \
767 	((u_int)(rman_get_start(res)+(offs)))
768 
769 #endif /* _MACHINE_BUS_H_ */
770