1 /* $NetBSD: bus.h,v 1.11 2003/07/28 17:35:54 thorpej Exp $ */
4 * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
34 * SPDX-License-Identifier: BSD-4-Clause
36 * Copyright (c) 1996 Charles M. Hannum. All rights reserved.
37 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
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
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.
68 #ifndef _MACHINE_BUS_H_
69 #define _MACHINE_BUS_H_
71 #include <machine/_bus.h>
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);
77 * Map a region of bus space.
80 #define BUS_SPACE_MAP_CACHEABLE 0x01
81 #define BUS_SPACE_MAP_LINEAR 0x02
82 #define BUS_SPACE_MAP_PREFETCHABLE 0x04
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.
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,
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);
102 /* Backlink to parent (if copied), and implementation private data. */
103 struct bus_space *bs_parent;
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 *);
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,
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
258 extern bus_space_tag_t arm_base_bs_tag;
262 * Utility macros; INTERNAL USE ONLY.
264 #define __bs_c(a,b) __CONCAT(a,b)
265 #define __bs_opname(op,size) __bs_c(__bs_c(__bs_c(bs_,op),_),size)
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)
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)
282 #define __generate_inline_bs_rs(IFN, MBR, TYP) \
284 IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o) \
287 if (__predict_true(t->MBR == NULL)) \
288 return (*(volatile TYP *)(h + o)); \
290 return (t->MBR(t, h, o)); \
293 #define __generate_inline_bs_ws(IFN, MBR, TYP) \
295 IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o, TYP v)\
298 if (__predict_true(t->MBR == NULL)) \
299 *(volatile TYP *)(h + o) = v; \
301 t->MBR(t, h, o, v); \
305 * Mapping and unmapping operations.
307 #define bus_space_map(t, a, s, c, hp) \
308 (*(t)->bs_map)((t), (a), (s), (c), (hp))
309 #define bus_space_unmap(t, h, s) \
310 (*(t)->bs_unmap)((t), (h), (s))
311 #define bus_space_subregion(t, h, o, s, hp) \
312 (*(t)->bs_subregion)((t), (h), (o), (s), (hp))
315 * Allocation and deallocation operations.
317 #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp) \
318 (*(t)->bs_alloc)((t), (rs), (re), (s), (a), (b), \
320 #define bus_space_free(t, h, s) \
321 (*(t)->bs_free)((t), (h), (s))
324 * Bus barrier operations.
326 #define bus_space_barrier(t, h, o, l, f) \
327 (*(t)->bs_barrier)((t), (h), (o), (l), (f))
329 #define BUS_SPACE_BARRIER_READ 0x01
330 #define BUS_SPACE_BARRIER_WRITE 0x02
333 * Bus read (single) operations.
335 __generate_inline_bs_rs(bus_space_read_1, bs_r_1, uint8_t);
336 __generate_inline_bs_rs(bus_space_read_2, bs_r_2, uint16_t);
337 __generate_inline_bs_rs(bus_space_read_4, bs_r_4, uint32_t);
338 __generate_inline_bs_rs(bus_space_read_8, bs_r_8, uint64_t);
340 __generate_inline_bs_rs(bus_space_read_stream_1, bs_r_1_s, uint8_t);
341 __generate_inline_bs_rs(bus_space_read_stream_2, bs_r_2_s, uint16_t);
342 __generate_inline_bs_rs(bus_space_read_stream_4, bs_r_4_s, uint32_t);
343 __generate_inline_bs_rs(bus_space_read_stream_8, bs_r_8_s, uint64_t);
346 * Bus read multiple operations.
348 #define bus_space_read_multi_1(t, h, o, a, c) \
349 __bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
350 #define bus_space_read_multi_2(t, h, o, a, c) \
351 __bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
352 #define bus_space_read_multi_4(t, h, o, a, c) \
353 __bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
354 #define bus_space_read_multi_8(t, h, o, a, c) \
355 __bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
357 #define bus_space_read_multi_stream_1(t, h, o, a, c) \
358 __bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
359 #define bus_space_read_multi_stream_2(t, h, o, a, c) \
360 __bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
361 #define bus_space_read_multi_stream_4(t, h, o, a, c) \
362 __bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
363 #define bus_space_read_multi_stream_8(t, h, o, a, c) \
364 __bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
367 * Bus read region operations.
369 #define bus_space_read_region_1(t, h, o, a, c) \
370 __bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
371 #define bus_space_read_region_2(t, h, o, a, c) \
372 __bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
373 #define bus_space_read_region_4(t, h, o, a, c) \
374 __bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
375 #define bus_space_read_region_8(t, h, o, a, c) \
376 __bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
378 #define bus_space_read_region_stream_1(t, h, o, a, c) \
379 __bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
380 #define bus_space_read_region_stream_2(t, h, o, a, c) \
381 __bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
382 #define bus_space_read_region_stream_4(t, h, o, a, c) \
383 __bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
384 #define bus_space_read_region_stream_8(t, h, o, a, c) \
385 __bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
388 * Bus write (single) operations.
390 __generate_inline_bs_ws(bus_space_write_1, bs_w_1, uint8_t);
391 __generate_inline_bs_ws(bus_space_write_2, bs_w_2, uint16_t);
392 __generate_inline_bs_ws(bus_space_write_4, bs_w_4, uint32_t);
393 __generate_inline_bs_ws(bus_space_write_8, bs_w_8, uint64_t);
395 __generate_inline_bs_ws(bus_space_write_stream_1, bs_w_1_s, uint8_t);
396 __generate_inline_bs_ws(bus_space_write_stream_2, bs_w_2_s, uint16_t);
397 __generate_inline_bs_ws(bus_space_write_stream_4, bs_w_4_s, uint32_t);
398 __generate_inline_bs_ws(bus_space_write_stream_8, bs_w_8_s, uint64_t);
401 * Bus write multiple operations.
403 #define bus_space_write_multi_1(t, h, o, a, c) \
404 __bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
405 #define bus_space_write_multi_2(t, h, o, a, c) \
406 __bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
407 #define bus_space_write_multi_4(t, h, o, a, c) \
408 __bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
409 #define bus_space_write_multi_8(t, h, o, a, c) \
410 __bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
412 #define bus_space_write_multi_stream_1(t, h, o, a, c) \
413 __bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
414 #define bus_space_write_multi_stream_2(t, h, o, a, c) \
415 __bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
416 #define bus_space_write_multi_stream_4(t, h, o, a, c) \
417 __bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
418 #define bus_space_write_multi_stream_8(t, h, o, a, c) \
419 __bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
422 * Bus write region operations.
424 #define bus_space_write_region_1(t, h, o, a, c) \
425 __bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
426 #define bus_space_write_region_2(t, h, o, a, c) \
427 __bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
428 #define bus_space_write_region_4(t, h, o, a, c) \
429 __bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
430 #define bus_space_write_region_8(t, h, o, a, c) \
431 __bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
433 #define bus_space_write_region_stream_1(t, h, o, a, c) \
434 __bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
435 #define bus_space_write_region_stream_2(t, h, o, a, c) \
436 __bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
437 #define bus_space_write_region_stream_4(t, h, o, a, c) \
438 __bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
439 #define bus_space_write_region_stream_8(t, h, o, a, c) \
440 __bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
443 * Set multiple operations.
445 #define bus_space_set_multi_1(t, h, o, v, c) \
446 __bs_set(sm,1,(t),(h),(o),(v),(c))
447 #define bus_space_set_multi_2(t, h, o, v, c) \
448 __bs_set(sm,2,(t),(h),(o),(v),(c))
449 #define bus_space_set_multi_4(t, h, o, v, c) \
450 __bs_set(sm,4,(t),(h),(o),(v),(c))
451 #define bus_space_set_multi_8(t, h, o, v, c) \
452 __bs_set(sm,8,(t),(h),(o),(v),(c))
455 * Set region operations.
457 #define bus_space_set_region_1(t, h, o, v, c) \
458 __bs_set(sr,1,(t),(h),(o),(v),(c))
459 #define bus_space_set_region_2(t, h, o, v, c) \
460 __bs_set(sr,2,(t),(h),(o),(v),(c))
461 #define bus_space_set_region_4(t, h, o, v, c) \
462 __bs_set(sr,4,(t),(h),(o),(v),(c))
463 #define bus_space_set_region_8(t, h, o, v, c) \
464 __bs_set(sr,8,(t),(h),(o),(v),(c))
469 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c) \
470 __bs_copy(1, t, h1, o1, h2, o2, c)
471 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c) \
472 __bs_copy(2, t, h1, o1, h2, o2, c)
473 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c) \
474 __bs_copy(4, t, h1, o1, h2, o2, c)
475 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c) \
476 __bs_copy(8, t, h1, o1, h2, o2, c)
479 * Macros to provide prototypes for all the functions used in the
480 * bus_space structure
483 #define bs_map_proto(f) \
484 int __bs_c(f,_bs_map) (bus_space_tag_t t, bus_addr_t addr, \
485 bus_size_t size, int cacheable, bus_space_handle_t *bshp);
487 #define bs_unmap_proto(f) \
488 void __bs_c(f,_bs_unmap) (bus_space_tag_t t, bus_space_handle_t bsh, \
491 #define bs_subregion_proto(f) \
492 int __bs_c(f,_bs_subregion) (bus_space_tag_t t, bus_space_handle_t bsh, \
493 bus_size_t offset, bus_size_t size, \
494 bus_space_handle_t *nbshp);
496 #define bs_alloc_proto(f) \
497 int __bs_c(f,_bs_alloc) (bus_space_tag_t t, bus_addr_t rstart, \
498 bus_addr_t rend, bus_size_t size, bus_size_t align, \
499 bus_size_t boundary, int cacheable, bus_addr_t *addrp, \
500 bus_space_handle_t *bshp);
502 #define bs_free_proto(f) \
503 void __bs_c(f,_bs_free) (bus_space_tag_t t, bus_space_handle_t bsh, \
506 #define bs_mmap_proto(f) \
507 int __bs_c(f,_bs_mmap) (struct cdev *, vm_offset_t, vm_paddr_t *, int);
509 #define bs_barrier_proto(f) \
510 void __bs_c(f,_bs_barrier) (bus_space_tag_t t, bus_space_handle_t bsh, \
511 bus_size_t offset, bus_size_t len, int flags);
513 #define bs_r_1_proto(f) \
514 uint8_t __bs_c(f,_bs_r_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
517 #define bs_r_2_proto(f) \
518 uint16_t __bs_c(f,_bs_r_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
521 #define bs_r_4_proto(f) \
522 uint32_t __bs_c(f,_bs_r_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
525 #define bs_r_8_proto(f) \
526 uint64_t __bs_c(f,_bs_r_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
529 #define bs_r_1_s_proto(f) \
530 uint8_t __bs_c(f,_bs_r_1_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
533 #define bs_r_2_s_proto(f) \
534 uint16_t __bs_c(f,_bs_r_2_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
537 #define bs_r_4_s_proto(f) \
538 uint32_t __bs_c(f,_bs_r_4_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
541 #define bs_w_1_proto(f) \
542 void __bs_c(f,_bs_w_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
543 bus_size_t offset, uint8_t value);
545 #define bs_w_2_proto(f) \
546 void __bs_c(f,_bs_w_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
547 bus_size_t offset, uint16_t value);
549 #define bs_w_4_proto(f) \
550 void __bs_c(f,_bs_w_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
551 bus_size_t offset, uint32_t value);
553 #define bs_w_8_proto(f) \
554 void __bs_c(f,_bs_w_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
555 bus_size_t offset, uint64_t value);
557 #define bs_w_1_s_proto(f) \
558 void __bs_c(f,_bs_w_1_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
559 bus_size_t offset, uint8_t value);
561 #define bs_w_2_s_proto(f) \
562 void __bs_c(f,_bs_w_2_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
563 bus_size_t offset, uint16_t value);
565 #define bs_w_4_s_proto(f) \
566 void __bs_c(f,_bs_w_4_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
567 bus_size_t offset, uint32_t value);
569 #define bs_rm_1_proto(f) \
570 void __bs_c(f,_bs_rm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
571 bus_size_t offset, uint8_t *addr, bus_size_t count);
573 #define bs_rm_2_proto(f) \
574 void __bs_c(f,_bs_rm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
575 bus_size_t offset, uint16_t *addr, bus_size_t count);
577 #define bs_rm_4_proto(f) \
578 void __bs_c(f,_bs_rm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
579 bus_size_t offset, uint32_t *addr, bus_size_t count);
581 #define bs_rm_8_proto(f) \
582 void __bs_c(f,_bs_rm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
583 bus_size_t offset, uint64_t *addr, bus_size_t count);
585 #define bs_wm_1_proto(f) \
586 void __bs_c(f,_bs_wm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
587 bus_size_t offset, const uint8_t *addr, bus_size_t count);
589 #define bs_wm_2_proto(f) \
590 void __bs_c(f,_bs_wm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
591 bus_size_t offset, const uint16_t *addr, bus_size_t count);
593 #define bs_wm_4_proto(f) \
594 void __bs_c(f,_bs_wm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
595 bus_size_t offset, const uint32_t *addr, bus_size_t count);
597 #define bs_wm_8_proto(f) \
598 void __bs_c(f,_bs_wm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
599 bus_size_t offset, const uint64_t *addr, bus_size_t count);
601 #define bs_rr_1_proto(f) \
602 void __bs_c(f, _bs_rr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
603 bus_size_t offset, uint8_t *addr, bus_size_t count);
605 #define bs_rr_2_proto(f) \
606 void __bs_c(f, _bs_rr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
607 bus_size_t offset, uint16_t *addr, bus_size_t count);
609 #define bs_rr_4_proto(f) \
610 void __bs_c(f, _bs_rr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
611 bus_size_t offset, uint32_t *addr, bus_size_t count);
613 #define bs_rr_8_proto(f) \
614 void __bs_c(f, _bs_rr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
615 bus_size_t offset, uint64_t *addr, bus_size_t count);
617 #define bs_wr_1_proto(f) \
618 void __bs_c(f, _bs_wr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
619 bus_size_t offset, const uint8_t *addr, bus_size_t count);
621 #define bs_wr_2_proto(f) \
622 void __bs_c(f, _bs_wr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
623 bus_size_t offset, const uint16_t *addr, bus_size_t count);
625 #define bs_wr_4_proto(f) \
626 void __bs_c(f, _bs_wr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
627 bus_size_t offset, const uint32_t *addr, bus_size_t count);
629 #define bs_wr_8_proto(f) \
630 void __bs_c(f, _bs_wr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
631 bus_size_t offset, const uint64_t *addr, bus_size_t count);
633 #define bs_sm_1_proto(f) \
634 void __bs_c(f,_bs_sm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
635 bus_size_t offset, uint8_t value, bus_size_t count);
637 #define bs_sm_2_proto(f) \
638 void __bs_c(f,_bs_sm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
639 bus_size_t offset, uint16_t value, bus_size_t count);
641 #define bs_sm_4_proto(f) \
642 void __bs_c(f,_bs_sm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
643 bus_size_t offset, uint32_t value, bus_size_t count);
645 #define bs_sm_8_proto(f) \
646 void __bs_c(f,_bs_sm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
647 bus_size_t offset, uint64_t value, bus_size_t count);
649 #define bs_sr_1_proto(f) \
650 void __bs_c(f,_bs_sr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
651 bus_size_t offset, uint8_t value, bus_size_t count);
653 #define bs_sr_2_proto(f) \
654 void __bs_c(f,_bs_sr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
655 bus_size_t offset, uint16_t value, bus_size_t count);
657 #define bs_sr_4_proto(f) \
658 void __bs_c(f,_bs_sr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
659 bus_size_t offset, uint32_t value, bus_size_t count);
661 #define bs_sr_8_proto(f) \
662 void __bs_c(f,_bs_sr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
663 bus_size_t offset, uint64_t value, bus_size_t count);
665 #define bs_c_1_proto(f) \
666 void __bs_c(f,_bs_c_1) (bus_space_tag_t t, bus_space_handle_t bsh1, \
667 bus_size_t offset1, bus_space_handle_t bsh2, \
668 bus_size_t offset2, bus_size_t count);
670 #define bs_c_2_proto(f) \
671 void __bs_c(f,_bs_c_2) (bus_space_tag_t t, bus_space_handle_t bsh1, \
672 bus_size_t offset1, bus_space_handle_t bsh2, \
673 bus_size_t offset2, bus_size_t count);
675 #define bs_c_4_proto(f) \
676 void __bs_c(f,_bs_c_4) (bus_space_tag_t t, bus_space_handle_t bsh1, \
677 bus_size_t offset1, bus_space_handle_t bsh2, \
678 bus_size_t offset2, bus_size_t count);
680 #define bs_c_8_proto(f) \
681 void __bs_c(f,_bs_c_8) (bus_space_tag_t t, bus_space_handle_t bsh1, \
682 bus_size_t offset1, bus_space_handle_t bsh2, \
683 bus_size_t offset2, bus_size_t count);
685 #define bs_protos(f) \
688 bs_subregion_proto(f); \
692 bs_barrier_proto(f); \
736 void generic_bs_unimplemented(void);
737 #define BS_UNIMPLEMENTED (void *)generic_bs_unimplemented
739 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
741 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFF
742 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
743 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
744 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFF
745 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
746 #define BUS_SPACE_MAXSIZE 0xFFFFFFFF
748 #define BUS_SPACE_UNRESTRICTED (~0)
750 #define BUS_PEEK_FUNC(width, type) \
752 bus_space_peek_##width(bus_space_tag_t tag, \
753 bus_space_handle_t hnd, bus_size_t offset, type *value) \
756 tmp = bus_space_read_##width(tag, hnd, offset); \
757 *value = (type)tmp; \
760 BUS_PEEK_FUNC(1, uint8_t)
761 BUS_PEEK_FUNC(2, uint16_t)
762 BUS_PEEK_FUNC(4, uint32_t)
763 BUS_PEEK_FUNC(8, uint64_t)
765 #define BUS_POKE_FUNC(width, type) \
767 bus_space_poke_##width(bus_space_tag_t tag, \
768 bus_space_handle_t hnd, bus_size_t offset, type value) \
770 bus_space_write_##width(tag, hnd, offset, value); \
773 BUS_POKE_FUNC(1, uint8_t)
774 BUS_POKE_FUNC(2, uint16_t)
775 BUS_POKE_FUNC(4, uint32_t)
776 BUS_POKE_FUNC(8, uint64_t)
778 #include <machine/bus_dma.h>
781 * Get the physical address of a bus space memory-mapped resource.
782 * Doing this as a macro is a temporary solution until a more robust fix is
783 * designed. It also serves to mark the locations needing that fix.
785 #define BUS_SPACE_PHYSADDR(res, offs) \
786 ((u_int)(rman_get_start(res)+(offs)))
788 #endif /* _MACHINE_BUS_H_ */