FreeBSD/Linux Kernel Cross Reference
sys/arm/include/bus.h
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 /*
258 * Utility macros; INTERNAL USE ONLY.
259 */
260 #define __bs_c(a,b) __CONCAT(a,b)
261 #define __bs_opname(op,size) __bs_c(__bs_c(__bs_c(bs_,op),_),size)
262
263 #define __bs_nonsingle(type, sz, t, h, o, a, c) \
264 (*(t)->__bs_opname(type,sz))((t), h, o, a, c)
265 #define __bs_set(type, sz, t, h, o, v, c) \
266 (*(t)->__bs_opname(type,sz))((t), h, o, v, c)
267 #define __bs_copy(sz, t, h1, o1, h2, o2, cnt) \
268 (*(t)->__bs_opname(c,sz))((t), h1, o1, h2, o2, cnt)
269
270 #define __bs_opname_s(op,size) __bs_c(__bs_c(__bs_c(__bs_c(bs_,op),_),size),_s)
271 #define __bs_rs_s(sz, t, h, o) \
272 (*(t)->__bs_opname_s(r,sz))((t), h, o)
273 #define __bs_ws_s(sz, t, h, o, v) \
274 (*(t)->__bs_opname_s(w,sz))((t), h, o, v)
275 #define __bs_nonsingle_s(type, sz, t, h, o, a, c) \
276 (*(t)->__bs_opname_s(type,sz))((t), h, o, a, c)
277
278 #define __generate_inline_bs_rs(IFN, MBR, TYP) \
279 static inline TYP \
280 IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o) \
281 { \
282 \
283 if (__predict_true(t->MBR == NULL)) \
284 return (*(volatile TYP *)(h + o)); \
285 else \
286 return (t->MBR(t, h, o)); \
287 }
288
289 #define __generate_inline_bs_ws(IFN, MBR, TYP) \
290 static inline void \
291 IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o, TYP v)\
292 { \
293 \
294 if (__predict_true(t->MBR == NULL)) \
295 *(volatile TYP *)(h + o) = v; \
296 else \
297 t->MBR(t, h, o, v); \
298 }
299
300 /*
301 * Mapping and unmapping operations.
302 */
303 #define bus_space_map(t, a, s, c, hp) \
304 (*(t)->bs_map)((t), (a), (s), (c), (hp))
305 #define bus_space_unmap(t, h, s) \
306 (*(t)->bs_unmap)((t), (h), (s))
307 #define bus_space_subregion(t, h, o, s, hp) \
308 (*(t)->bs_subregion)((t), (h), (o), (s), (hp))
309
310 /*
311 * Allocation and deallocation operations.
312 */
313 #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp) \
314 (*(t)->bs_alloc)((t), (rs), (re), (s), (a), (b), \
315 (c), (ap), (hp))
316 #define bus_space_free(t, h, s) \
317 (*(t)->bs_free)((t), (h), (s))
318
319 /*
320 * Bus barrier operations.
321 */
322 #define bus_space_barrier(t, h, o, l, f) \
323 (*(t)->bs_barrier)((t), (h), (o), (l), (f))
324
325 #define BUS_SPACE_BARRIER_READ 0x01
326 #define BUS_SPACE_BARRIER_WRITE 0x02
327
328 /*
329 * Bus read (single) operations.
330 */
331 __generate_inline_bs_rs(bus_space_read_1, bs_r_1, uint8_t);
332 __generate_inline_bs_rs(bus_space_read_2, bs_r_2, uint16_t);
333 __generate_inline_bs_rs(bus_space_read_4, bs_r_4, uint32_t);
334 __generate_inline_bs_rs(bus_space_read_8, bs_r_8, uint64_t);
335
336 __generate_inline_bs_rs(bus_space_read_stream_1, bs_r_1_s, uint8_t);
337 __generate_inline_bs_rs(bus_space_read_stream_2, bs_r_2_s, uint16_t);
338 __generate_inline_bs_rs(bus_space_read_stream_4, bs_r_4_s, uint32_t);
339 __generate_inline_bs_rs(bus_space_read_stream_8, bs_r_8_s, uint64_t);
340
341 /*
342 * Bus read multiple operations.
343 */
344 #define bus_space_read_multi_1(t, h, o, a, c) \
345 __bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
346 #define bus_space_read_multi_2(t, h, o, a, c) \
347 __bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
348 #define bus_space_read_multi_4(t, h, o, a, c) \
349 __bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
350 #define bus_space_read_multi_8(t, h, o, a, c) \
351 __bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
352
353 #define bus_space_read_multi_stream_1(t, h, o, a, c) \
354 __bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
355 #define bus_space_read_multi_stream_2(t, h, o, a, c) \
356 __bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
357 #define bus_space_read_multi_stream_4(t, h, o, a, c) \
358 __bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
359 #define bus_space_read_multi_stream_8(t, h, o, a, c) \
360 __bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
361
362 /*
363 * Bus read region operations.
364 */
365 #define bus_space_read_region_1(t, h, o, a, c) \
366 __bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
367 #define bus_space_read_region_2(t, h, o, a, c) \
368 __bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
369 #define bus_space_read_region_4(t, h, o, a, c) \
370 __bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
371 #define bus_space_read_region_8(t, h, o, a, c) \
372 __bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
373
374 #define bus_space_read_region_stream_1(t, h, o, a, c) \
375 __bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
376 #define bus_space_read_region_stream_2(t, h, o, a, c) \
377 __bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
378 #define bus_space_read_region_stream_4(t, h, o, a, c) \
379 __bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
380 #define bus_space_read_region_stream_8(t, h, o, a, c) \
381 __bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
382
383 /*
384 * Bus write (single) operations.
385 */
386 __generate_inline_bs_ws(bus_space_write_1, bs_w_1, uint8_t);
387 __generate_inline_bs_ws(bus_space_write_2, bs_w_2, uint16_t);
388 __generate_inline_bs_ws(bus_space_write_4, bs_w_4, uint32_t);
389 __generate_inline_bs_ws(bus_space_write_8, bs_w_8, uint64_t);
390
391 __generate_inline_bs_ws(bus_space_write_stream_1, bs_w_1_s, uint8_t);
392 __generate_inline_bs_ws(bus_space_write_stream_2, bs_w_2_s, uint16_t);
393 __generate_inline_bs_ws(bus_space_write_stream_4, bs_w_4_s, uint32_t);
394 __generate_inline_bs_ws(bus_space_write_stream_8, bs_w_8_s, uint64_t);
395
396 /*
397 * Bus write multiple operations.
398 */
399 #define bus_space_write_multi_1(t, h, o, a, c) \
400 __bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
401 #define bus_space_write_multi_2(t, h, o, a, c) \
402 __bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
403 #define bus_space_write_multi_4(t, h, o, a, c) \
404 __bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
405 #define bus_space_write_multi_8(t, h, o, a, c) \
406 __bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
407
408 #define bus_space_write_multi_stream_1(t, h, o, a, c) \
409 __bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
410 #define bus_space_write_multi_stream_2(t, h, o, a, c) \
411 __bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
412 #define bus_space_write_multi_stream_4(t, h, o, a, c) \
413 __bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
414 #define bus_space_write_multi_stream_8(t, h, o, a, c) \
415 __bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
416
417 /*
418 * Bus write region operations.
419 */
420 #define bus_space_write_region_1(t, h, o, a, c) \
421 __bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
422 #define bus_space_write_region_2(t, h, o, a, c) \
423 __bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
424 #define bus_space_write_region_4(t, h, o, a, c) \
425 __bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
426 #define bus_space_write_region_8(t, h, o, a, c) \
427 __bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
428
429 #define bus_space_write_region_stream_1(t, h, o, a, c) \
430 __bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
431 #define bus_space_write_region_stream_2(t, h, o, a, c) \
432 __bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
433 #define bus_space_write_region_stream_4(t, h, o, a, c) \
434 __bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
435 #define bus_space_write_region_stream_8(t, h, o, a, c) \
436 __bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
437
438 /*
439 * Set multiple operations.
440 */
441 #define bus_space_set_multi_1(t, h, o, v, c) \
442 __bs_set(sm,1,(t),(h),(o),(v),(c))
443 #define bus_space_set_multi_2(t, h, o, v, c) \
444 __bs_set(sm,2,(t),(h),(o),(v),(c))
445 #define bus_space_set_multi_4(t, h, o, v, c) \
446 __bs_set(sm,4,(t),(h),(o),(v),(c))
447 #define bus_space_set_multi_8(t, h, o, v, c) \
448 __bs_set(sm,8,(t),(h),(o),(v),(c))
449
450 /*
451 * Set region operations.
452 */
453 #define bus_space_set_region_1(t, h, o, v, c) \
454 __bs_set(sr,1,(t),(h),(o),(v),(c))
455 #define bus_space_set_region_2(t, h, o, v, c) \
456 __bs_set(sr,2,(t),(h),(o),(v),(c))
457 #define bus_space_set_region_4(t, h, o, v, c) \
458 __bs_set(sr,4,(t),(h),(o),(v),(c))
459 #define bus_space_set_region_8(t, h, o, v, c) \
460 __bs_set(sr,8,(t),(h),(o),(v),(c))
461
462 /*
463 * Copy operations.
464 */
465 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c) \
466 __bs_copy(1, t, h1, o1, h2, o2, c)
467 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c) \
468 __bs_copy(2, t, h1, o1, h2, o2, c)
469 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c) \
470 __bs_copy(4, t, h1, o1, h2, o2, c)
471 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c) \
472 __bs_copy(8, t, h1, o1, h2, o2, c)
473
474 /*
475 * Macros to provide prototypes for all the functions used in the
476 * bus_space structure
477 */
478
479 #define bs_map_proto(f) \
480 int __bs_c(f,_bs_map) (bus_space_tag_t t, bus_addr_t addr, \
481 bus_size_t size, int cacheable, bus_space_handle_t *bshp);
482
483 #define bs_unmap_proto(f) \
484 void __bs_c(f,_bs_unmap) (bus_space_tag_t t, bus_space_handle_t bsh, \
485 bus_size_t size);
486
487 #define bs_subregion_proto(f) \
488 int __bs_c(f,_bs_subregion) (bus_space_tag_t t, bus_space_handle_t bsh, \
489 bus_size_t offset, bus_size_t size, \
490 bus_space_handle_t *nbshp);
491
492 #define bs_alloc_proto(f) \
493 int __bs_c(f,_bs_alloc) (bus_space_tag_t t, bus_addr_t rstart, \
494 bus_addr_t rend, bus_size_t size, bus_size_t align, \
495 bus_size_t boundary, int cacheable, bus_addr_t *addrp, \
496 bus_space_handle_t *bshp);
497
498 #define bs_free_proto(f) \
499 void __bs_c(f,_bs_free) (bus_space_tag_t t, bus_space_handle_t bsh, \
500 bus_size_t size);
501
502 #define bs_mmap_proto(f) \
503 int __bs_c(f,_bs_mmap) (struct cdev *, vm_offset_t, vm_paddr_t *, int);
504
505 #define bs_barrier_proto(f) \
506 void __bs_c(f,_bs_barrier) (bus_space_tag_t t, bus_space_handle_t bsh, \
507 bus_size_t offset, bus_size_t len, int flags);
508
509 #define bs_r_1_proto(f) \
510 uint8_t __bs_c(f,_bs_r_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
511 bus_size_t offset);
512
513 #define bs_r_2_proto(f) \
514 uint16_t __bs_c(f,_bs_r_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
515 bus_size_t offset);
516
517 #define bs_r_4_proto(f) \
518 uint32_t __bs_c(f,_bs_r_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
519 bus_size_t offset);
520
521 #define bs_r_8_proto(f) \
522 uint64_t __bs_c(f,_bs_r_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
523 bus_size_t offset);
524
525 #define bs_r_1_s_proto(f) \
526 uint8_t __bs_c(f,_bs_r_1_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
527 bus_size_t offset);
528
529 #define bs_r_2_s_proto(f) \
530 uint16_t __bs_c(f,_bs_r_2_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
531 bus_size_t offset);
532
533 #define bs_r_4_s_proto(f) \
534 uint32_t __bs_c(f,_bs_r_4_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
535 bus_size_t offset);
536
537 #define bs_w_1_proto(f) \
538 void __bs_c(f,_bs_w_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
539 bus_size_t offset, uint8_t value);
540
541 #define bs_w_2_proto(f) \
542 void __bs_c(f,_bs_w_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
543 bus_size_t offset, uint16_t value);
544
545 #define bs_w_4_proto(f) \
546 void __bs_c(f,_bs_w_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
547 bus_size_t offset, uint32_t value);
548
549 #define bs_w_8_proto(f) \
550 void __bs_c(f,_bs_w_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
551 bus_size_t offset, uint64_t value);
552
553 #define bs_w_1_s_proto(f) \
554 void __bs_c(f,_bs_w_1_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
555 bus_size_t offset, uint8_t value);
556
557 #define bs_w_2_s_proto(f) \
558 void __bs_c(f,_bs_w_2_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
559 bus_size_t offset, uint16_t value);
560
561 #define bs_w_4_s_proto(f) \
562 void __bs_c(f,_bs_w_4_s) (bus_space_tag_t t, bus_space_handle_t bsh, \
563 bus_size_t offset, uint32_t value);
564
565 #define bs_rm_1_proto(f) \
566 void __bs_c(f,_bs_rm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
567 bus_size_t offset, uint8_t *addr, bus_size_t count);
568
569 #define bs_rm_2_proto(f) \
570 void __bs_c(f,_bs_rm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
571 bus_size_t offset, uint16_t *addr, bus_size_t count);
572
573 #define bs_rm_4_proto(f) \
574 void __bs_c(f,_bs_rm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
575 bus_size_t offset, uint32_t *addr, bus_size_t count);
576
577 #define bs_rm_8_proto(f) \
578 void __bs_c(f,_bs_rm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
579 bus_size_t offset, uint64_t *addr, bus_size_t count);
580
581 #define bs_wm_1_proto(f) \
582 void __bs_c(f,_bs_wm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
583 bus_size_t offset, const uint8_t *addr, bus_size_t count);
584
585 #define bs_wm_2_proto(f) \
586 void __bs_c(f,_bs_wm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
587 bus_size_t offset, const uint16_t *addr, bus_size_t count);
588
589 #define bs_wm_4_proto(f) \
590 void __bs_c(f,_bs_wm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
591 bus_size_t offset, const uint32_t *addr, bus_size_t count);
592
593 #define bs_wm_8_proto(f) \
594 void __bs_c(f,_bs_wm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
595 bus_size_t offset, const uint64_t *addr, bus_size_t count);
596
597 #define bs_rr_1_proto(f) \
598 void __bs_c(f, _bs_rr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
599 bus_size_t offset, uint8_t *addr, bus_size_t count);
600
601 #define bs_rr_2_proto(f) \
602 void __bs_c(f, _bs_rr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
603 bus_size_t offset, uint16_t *addr, bus_size_t count);
604
605 #define bs_rr_4_proto(f) \
606 void __bs_c(f, _bs_rr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
607 bus_size_t offset, uint32_t *addr, bus_size_t count);
608
609 #define bs_rr_8_proto(f) \
610 void __bs_c(f, _bs_rr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
611 bus_size_t offset, uint64_t *addr, bus_size_t count);
612
613 #define bs_wr_1_proto(f) \
614 void __bs_c(f, _bs_wr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
615 bus_size_t offset, const uint8_t *addr, bus_size_t count);
616
617 #define bs_wr_2_proto(f) \
618 void __bs_c(f, _bs_wr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
619 bus_size_t offset, const uint16_t *addr, bus_size_t count);
620
621 #define bs_wr_4_proto(f) \
622 void __bs_c(f, _bs_wr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
623 bus_size_t offset, const uint32_t *addr, bus_size_t count);
624
625 #define bs_wr_8_proto(f) \
626 void __bs_c(f, _bs_wr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
627 bus_size_t offset, const uint64_t *addr, bus_size_t count);
628
629 #define bs_sm_1_proto(f) \
630 void __bs_c(f,_bs_sm_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
631 bus_size_t offset, uint8_t value, bus_size_t count);
632
633 #define bs_sm_2_proto(f) \
634 void __bs_c(f,_bs_sm_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
635 bus_size_t offset, uint16_t value, bus_size_t count);
636
637 #define bs_sm_4_proto(f) \
638 void __bs_c(f,_bs_sm_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
639 bus_size_t offset, uint32_t value, bus_size_t count);
640
641 #define bs_sm_8_proto(f) \
642 void __bs_c(f,_bs_sm_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
643 bus_size_t offset, uint64_t value, bus_size_t count);
644
645 #define bs_sr_1_proto(f) \
646 void __bs_c(f,_bs_sr_1) (bus_space_tag_t t, bus_space_handle_t bsh, \
647 bus_size_t offset, uint8_t value, bus_size_t count);
648
649 #define bs_sr_2_proto(f) \
650 void __bs_c(f,_bs_sr_2) (bus_space_tag_t t, bus_space_handle_t bsh, \
651 bus_size_t offset, uint16_t value, bus_size_t count);
652
653 #define bs_sr_4_proto(f) \
654 void __bs_c(f,_bs_sr_4) (bus_space_tag_t t, bus_space_handle_t bsh, \
655 bus_size_t offset, uint32_t value, bus_size_t count);
656
657 #define bs_sr_8_proto(f) \
658 void __bs_c(f,_bs_sr_8) (bus_space_tag_t t, bus_space_handle_t bsh, \
659 bus_size_t offset, uint64_t value, bus_size_t count);
660
661 #define bs_c_1_proto(f) \
662 void __bs_c(f,_bs_c_1) (bus_space_tag_t t, bus_space_handle_t bsh1, \
663 bus_size_t offset1, bus_space_handle_t bsh2, \
664 bus_size_t offset2, bus_size_t count);
665
666 #define bs_c_2_proto(f) \
667 void __bs_c(f,_bs_c_2) (bus_space_tag_t t, bus_space_handle_t bsh1, \
668 bus_size_t offset1, bus_space_handle_t bsh2, \
669 bus_size_t offset2, bus_size_t count);
670
671 #define bs_c_4_proto(f) \
672 void __bs_c(f,_bs_c_4) (bus_space_tag_t t, bus_space_handle_t bsh1, \
673 bus_size_t offset1, bus_space_handle_t bsh2, \
674 bus_size_t offset2, bus_size_t count);
675
676 #define bs_c_8_proto(f) \
677 void __bs_c(f,_bs_c_8) (bus_space_tag_t t, bus_space_handle_t bsh1, \
678 bus_size_t offset1, bus_space_handle_t bsh2, \
679 bus_size_t offset2, bus_size_t count);
680
681 #define bs_protos(f) \
682 bs_map_proto(f); \
683 bs_unmap_proto(f); \
684 bs_subregion_proto(f); \
685 bs_alloc_proto(f); \
686 bs_free_proto(f); \
687 bs_mmap_proto(f); \
688 bs_barrier_proto(f); \
689 bs_r_1_proto(f); \
690 bs_r_2_proto(f); \
691 bs_r_4_proto(f); \
692 bs_r_8_proto(f); \
693 bs_r_1_s_proto(f); \
694 bs_r_2_s_proto(f); \
695 bs_r_4_s_proto(f); \
696 bs_w_1_proto(f); \
697 bs_w_2_proto(f); \
698 bs_w_4_proto(f); \
699 bs_w_8_proto(f); \
700 bs_w_1_s_proto(f); \
701 bs_w_2_s_proto(f); \
702 bs_w_4_s_proto(f); \
703 bs_rm_1_proto(f); \
704 bs_rm_2_proto(f); \
705 bs_rm_4_proto(f); \
706 bs_rm_8_proto(f); \
707 bs_wm_1_proto(f); \
708 bs_wm_2_proto(f); \
709 bs_wm_4_proto(f); \
710 bs_wm_8_proto(f); \
711 bs_rr_1_proto(f); \
712 bs_rr_2_proto(f); \
713 bs_rr_4_proto(f); \
714 bs_rr_8_proto(f); \
715 bs_wr_1_proto(f); \
716 bs_wr_2_proto(f); \
717 bs_wr_4_proto(f); \
718 bs_wr_8_proto(f); \
719 bs_sm_1_proto(f); \
720 bs_sm_2_proto(f); \
721 bs_sm_4_proto(f); \
722 bs_sm_8_proto(f); \
723 bs_sr_1_proto(f); \
724 bs_sr_2_proto(f); \
725 bs_sr_4_proto(f); \
726 bs_sr_8_proto(f); \
727 bs_c_1_proto(f); \
728 bs_c_2_proto(f); \
729 bs_c_4_proto(f); \
730 bs_c_8_proto(f);
731
732 void generic_bs_unimplemented(void);
733 #define BS_UNIMPLEMENTED (void *)generic_bs_unimplemented
734
735 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
736
737 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFF
738 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
739 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
740 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFF
741 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
742 #define BUS_SPACE_MAXSIZE 0xFFFFFFFF
743
744 #define BUS_SPACE_UNRESTRICTED (~0)
745
746 #define BUS_PEEK_FUNC(width, type) \
747 static inline int \
748 bus_space_peek_##width(bus_space_tag_t tag, \
749 bus_space_handle_t hnd, bus_size_t offset, type *value) \
750 { \
751 type tmp; \
752 tmp = bus_space_read_##width(tag, hnd, offset); \
753 *value = (type)tmp; \
754 return (0); \
755 }
756 BUS_PEEK_FUNC(1, uint8_t)
757 BUS_PEEK_FUNC(2, uint16_t)
758 BUS_PEEK_FUNC(4, uint32_t)
759 BUS_PEEK_FUNC(8, uint64_t)
760
761 #define BUS_POKE_FUNC(width, type) \
762 static inline int \
763 bus_space_poke_##width(bus_space_tag_t tag, \
764 bus_space_handle_t hnd, bus_size_t offset, type value) \
765 { \
766 bus_space_write_##width(tag, hnd, offset, value); \
767 return (0); \
768 }
769 BUS_POKE_FUNC(1, uint8_t)
770 BUS_POKE_FUNC(2, uint16_t)
771 BUS_POKE_FUNC(4, uint32_t)
772 BUS_POKE_FUNC(8, uint64_t)
773
774 #include <machine/bus_dma.h>
775
776 /*
777 * Get the physical address of a bus space memory-mapped resource.
778 * Doing this as a macro is a temporary solution until a more robust fix is
779 * designed. It also serves to mark the locations needing that fix.
780 */
781 #define BUS_SPACE_PHYSADDR(res, offs) \
782 ((u_int)(rman_get_start(res)+(offs)))
783
784 #endif /* _MACHINE_BUS_H_ */
Cache object: 277c637b6f66495149996db67a782c44
|