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.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
41 * Copyright (c) 1996 Charles M. Hannum. All rights reserved.
42 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by Christopher G. Demetriou
55 * for the NetBSD Project.
56 * 4. The name of the author may not be used to endorse or promote products
57 * derived from this software without specific prior written permission
59 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
60 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
61 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
62 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
63 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
64 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
65 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
66 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
67 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
68 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 #ifndef _MACHINE_BUS_H_
74 #define _MACHINE_BUS_H_
76 #include <machine/_bus.h>
78 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
80 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFF
81 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
82 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
83 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFF
84 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
85 #define BUS_SPACE_MAXSIZE 0xFFFFFFFF
87 #define BUS_SPACE_MAP_CACHEABLE 0x01
88 #define BUS_SPACE_MAP_LINEAR 0x02
89 #define BUS_SPACE_MAP_PREFETCHABLE 0x04
91 #define BUS_SPACE_UNRESTRICTED (~0)
93 #define BUS_SPACE_BARRIER_READ 0x01
94 #define BUS_SPACE_BARRIER_WRITE 0x02
96 struct bus_space_access;
99 /* mapping/unmapping */
100 int (*bs_map)(bus_addr_t, bus_size_t, int,
101 bus_space_handle_t *);
102 void (*bs_unmap)(bus_size_t);
103 int (*bs_subregion)(bus_space_handle_t, bus_size_t,
104 bus_size_t, bus_space_handle_t *);
106 /* allocation/deallocation */
107 int (*bs_alloc)(bus_addr_t, bus_addr_t, bus_size_t,
108 bus_size_t, bus_size_t, int, bus_addr_t *, bus_space_handle_t *);
109 void (*bs_free)(bus_space_handle_t, bus_size_t);
111 void (*bs_barrier)(bus_space_handle_t, bus_size_t,
115 uint8_t (*bs_r_1)(bus_space_handle_t, bus_size_t);
116 uint16_t (*bs_r_2)(bus_space_handle_t, bus_size_t);
117 uint32_t (*bs_r_4)(bus_space_handle_t, bus_size_t);
118 uint64_t (*bs_r_8)(bus_space_handle_t, bus_size_t);
120 uint16_t (*bs_r_s_2)(bus_space_handle_t, bus_size_t);
121 uint32_t (*bs_r_s_4)(bus_space_handle_t, bus_size_t);
122 uint64_t (*bs_r_s_8)(bus_space_handle_t, bus_size_t);
125 void (*bs_rm_1)(bus_space_handle_t, bus_size_t, uint8_t *,
127 void (*bs_rm_2)(bus_space_handle_t, bus_size_t, uint16_t *,
129 void (*bs_rm_4)(bus_space_handle_t, bus_size_t, uint32_t *,
131 void (*bs_rm_8)(bus_space_handle_t, bus_size_t, uint64_t *,
134 void (*bs_rm_s_2)(bus_space_handle_t, bus_size_t, uint16_t *,
136 void (*bs_rm_s_4)(bus_space_handle_t, bus_size_t, uint32_t *,
138 void (*bs_rm_s_8)(bus_space_handle_t, bus_size_t, uint64_t *,
142 void (*bs_rr_1)(bus_space_handle_t, bus_size_t, uint8_t *,
144 void (*bs_rr_2)(bus_space_handle_t, bus_size_t, uint16_t *,
146 void (*bs_rr_4)(bus_space_handle_t, bus_size_t, uint32_t *,
148 void (*bs_rr_8)(bus_space_handle_t, bus_size_t, uint64_t *,
151 void (*bs_rr_s_2)(bus_space_handle_t, bus_size_t, uint16_t *,
153 void (*bs_rr_s_4)(bus_space_handle_t, bus_size_t, uint32_t *,
155 void (*bs_rr_s_8)(bus_space_handle_t, bus_size_t, uint64_t *,
159 void (*bs_w_1)(bus_space_handle_t, bus_size_t, uint8_t);
160 void (*bs_w_2)(bus_space_handle_t, bus_size_t, uint16_t);
161 void (*bs_w_4)(bus_space_handle_t, bus_size_t, uint32_t);
162 void (*bs_w_8)(bus_space_handle_t, bus_size_t, uint64_t);
164 void (*bs_w_s_2)(bus_space_handle_t, bus_size_t, uint16_t);
165 void (*bs_w_s_4)(bus_space_handle_t, bus_size_t, uint32_t);
166 void (*bs_w_s_8)(bus_space_handle_t, bus_size_t, uint64_t);
169 void (*bs_wm_1)(bus_space_handle_t, bus_size_t,
170 const uint8_t *, bus_size_t);
171 void (*bs_wm_2)(bus_space_handle_t, bus_size_t,
172 const uint16_t *, bus_size_t);
173 void (*bs_wm_4)(bus_space_handle_t, bus_size_t,
174 const uint32_t *, bus_size_t);
175 void (*bs_wm_8)(bus_space_handle_t, bus_size_t,
176 const uint64_t *, bus_size_t);
178 void (*bs_wm_s_2)(bus_space_handle_t, bus_size_t,
179 const uint16_t *, bus_size_t);
180 void (*bs_wm_s_4)(bus_space_handle_t, bus_size_t,
181 const uint32_t *, bus_size_t);
182 void (*bs_wm_s_8)(bus_space_handle_t, bus_size_t,
183 const uint64_t *, bus_size_t);
186 void (*bs_wr_1)(bus_space_handle_t, bus_size_t,
187 const uint8_t *, bus_size_t);
188 void (*bs_wr_2)(bus_space_handle_t, bus_size_t,
189 const uint16_t *, bus_size_t);
190 void (*bs_wr_4)(bus_space_handle_t, bus_size_t,
191 const uint32_t *, bus_size_t);
192 void (*bs_wr_8)(bus_space_handle_t, bus_size_t,
193 const uint64_t *, bus_size_t);
195 void (*bs_wr_s_2)(bus_space_handle_t, bus_size_t,
196 const uint16_t *, bus_size_t);
197 void (*bs_wr_s_4)(bus_space_handle_t, bus_size_t,
198 const uint32_t *, bus_size_t);
199 void (*bs_wr_s_8)(bus_space_handle_t, bus_size_t,
200 const uint64_t *, bus_size_t);
203 void (*bs_sm_1)(bus_space_handle_t, bus_size_t, uint8_t,
205 void (*bs_sm_2)(bus_space_handle_t, bus_size_t, uint16_t,
207 void (*bs_sm_4)(bus_space_handle_t, bus_size_t, uint32_t,
209 void (*bs_sm_8)(bus_space_handle_t, bus_size_t, uint64_t,
212 void (*bs_sm_s_2)(bus_space_handle_t, bus_size_t, uint16_t,
214 void (*bs_sm_s_4)(bus_space_handle_t, bus_size_t, uint32_t,
216 void (*bs_sm_s_8)(bus_space_handle_t, bus_size_t, uint64_t,
220 void (*bs_sr_1)(bus_space_handle_t, bus_size_t, uint8_t,
222 void (*bs_sr_2)(bus_space_handle_t, bus_size_t, uint16_t,
224 void (*bs_sr_4)(bus_space_handle_t, bus_size_t, uint32_t,
226 void (*bs_sr_8)(bus_space_handle_t, bus_size_t, uint64_t,
229 void (*bs_sr_s_2)(bus_space_handle_t, bus_size_t, uint16_t,
231 void (*bs_sr_s_4)(bus_space_handle_t, bus_size_t, uint32_t,
233 void (*bs_sr_s_8)(bus_space_handle_t, bus_size_t, uint64_t,
237 void (*bs_cr_1)(bus_space_handle_t, bus_size_t,
238 bus_space_handle_t, bus_size_t, bus_size_t);
239 void (*bs_cr_2)(bus_space_handle_t, bus_size_t,
240 bus_space_handle_t, bus_size_t, bus_size_t);
241 void (*bs_cr_4)(bus_space_handle_t, bus_size_t,
242 bus_space_handle_t, bus_size_t, bus_size_t);
243 void (*bs_cr_8)(bus_space_handle_t, bus_size_t,
244 bus_space_handle_t, bus_size_t, bus_size_t);
246 void (*bs_cr_s_2)(bus_space_handle_t, bus_size_t,
247 bus_space_handle_t, bus_size_t, bus_size_t);
248 void (*bs_cr_s_4)(bus_space_handle_t, bus_size_t,
249 bus_space_handle_t, bus_size_t, bus_size_t);
250 void (*bs_cr_s_8)(bus_space_handle_t, bus_size_t,
251 bus_space_handle_t, bus_size_t, bus_size_t);
254 extern struct bus_space bs_be_tag;
255 extern struct bus_space bs_le_tag;
257 #define __bs_c(a,b) __CONCAT(a,b)
258 #define __bs_opname(op,size) __bs_c(__bs_c(__bs_c(bs_,op),_),size)
260 #define __bs_rs(sz, t, h, o) \
261 (*(t)->__bs_opname(r,sz))(h, o)
262 #define __bs_ws(sz, t, h, o, v) \
263 (*(t)->__bs_opname(w,sz))(h, o, v)
264 #define __bs_nonsingle(type, sz, t, h, o, a, c) \
265 (*(t)->__bs_opname(type,sz))(h, o, a, c)
266 #define __bs_set(type, sz, t, h, o, v, c) \
267 (*(t)->__bs_opname(type,sz))(h, o, v, c)
268 #define __bs_copy(sz, t, h1, o1, h2, o2, cnt) \
269 (*(t)->__bs_opname(c,sz))(h1, o1, h2, o2, cnt)
272 * Mapping and unmapping operations.
274 #define bus_space_map(t, a, s, c, hp) (*(t)->bs_map)(a, s, c, hp)
275 #define bus_space_unmap(t, h, s) (*(t)->bs_unmap)(h, s)
276 #define bus_space_subregion(t, h, o, s, hp) (*(t)->bs_subregion)(h, o, s, hp)
279 * Allocation and deallocation operations.
281 #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp) \
282 (*(t)->bs_alloc)(rs, re, s, a, b, c, ap, hp)
283 #define bus_space_free(t, h, s) \
284 (*(t)->bs_free)(h, s)
287 * Bus barrier operations.
289 #define bus_space_barrier(t, h, o, l, f) (*(t)->bs_barrier)(h, o, l, f)
292 * Bus read (single) operations.
294 #define bus_space_read_1(t, h, o) __bs_rs(1,t,h,o)
295 #define bus_space_read_2(t, h, o) __bs_rs(2,t,h,o)
296 #define bus_space_read_4(t, h, o) __bs_rs(4,t,h,o)
297 #define bus_space_read_8(t, h, o) __bs_rs(8,t,h,o)
299 #define bus_space_read_stream_1 bus_space_read_1
300 #define bus_space_read_stream_2(t, h, o) __bs_rs(s_2,t,h,o)
301 #define bus_space_read_stream_4(t, h, o) __bs_rs(s_4,t,h,o)
302 #define bus_space_read_stream_8(t, h, o) __bs_rs(s_8,t,h,o)
305 * Bus read multiple operations.
307 #define bus_space_read_multi_1(t, h, o, a, c) \
308 __bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
309 #define bus_space_read_multi_2(t, h, o, a, c) \
310 __bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
311 #define bus_space_read_multi_4(t, h, o, a, c) \
312 __bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
313 #define bus_space_read_multi_8(t, h, o, a, c) \
314 __bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
316 #define bus_space_read_multi_stream_1 bus_space_read_multi_1
317 #define bus_space_read_multi_stream_2(t, h, o, a, c) \
318 __bs_nonsingle(rm,s_2,(t),(h),(o),(a),(c))
319 #define bus_space_read_multi_stream_4(t, h, o, a, c) \
320 __bs_nonsingle(rm,s_4,(t),(h),(o),(a),(c))
321 #define bus_space_read_multi_stream_8(t, h, o, a, c) \
322 __bs_nonsingle(rm,s_8,(t),(h),(o),(a),(c))
325 * Bus read region operations.
327 #define bus_space_read_region_1(t, h, o, a, c) \
328 __bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
329 #define bus_space_read_region_2(t, h, o, a, c) \
330 __bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
331 #define bus_space_read_region_4(t, h, o, a, c) \
332 __bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
333 #define bus_space_read_region_8(t, h, o, a, c) \
334 __bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
336 #define bus_space_read_region_stream_1 bus_space_read_region_1
337 #define bus_space_read_region_stream_2(t, h, o, a, c) \
338 __bs_nonsingle(rr,s_2,(t),(h),(o),(a),(c))
339 #define bus_space_read_region_stream_4(t, h, o, a, c) \
340 __bs_nonsingle(rr,s_4,(t),(h),(o),(a),(c))
341 #define bus_space_read_region_stream_8(t, h, o, a, c) \
342 __bs_nonsingle(rr,s_8,(t),(h),(o),(a),(c))
345 * Bus write (single) operations.
347 #define bus_space_write_1(t, h, o, v) __bs_ws(1,(t),(h),(o),(v))
348 #define bus_space_write_2(t, h, o, v) __bs_ws(2,(t),(h),(o),(v))
349 #define bus_space_write_4(t, h, o, v) __bs_ws(4,(t),(h),(o),(v))
350 #define bus_space_write_8(t, h, o, v) __bs_ws(8,(t),(h),(o),(v))
352 #define bus_space_write_stream_1 bus_space_write_1
353 #define bus_space_write_stream_2(t, h, o, v) __bs_ws(s_2,(t),(h),(o),(v))
354 #define bus_space_write_stream_4(t, h, o, v) __bs_ws(s_4,(t),(h),(o),(v))
355 #define bus_space_write_stream_8(t, h, o, v) __bs_ws(s_8,(t),(h),(o),(v))
358 * Bus write multiple operations.
360 #define bus_space_write_multi_1(t, h, o, a, c) \
361 __bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
362 #define bus_space_write_multi_2(t, h, o, a, c) \
363 __bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
364 #define bus_space_write_multi_4(t, h, o, a, c) \
365 __bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
366 #define bus_space_write_multi_8(t, h, o, a, c) \
367 __bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
369 #define bus_space_write_multi_stream_1 bus_space_write_multi_1
370 #define bus_space_write_multi_stream_2(t, h, o, a, c) \
371 __bs_nonsingle(wm,s_2,(t),(h),(o),(a),(c))
372 #define bus_space_write_multi_stream_4(t, h, o, a, c) \
373 __bs_nonsingle(wm,s_4,(t),(h),(o),(a),(c))
374 #define bus_space_write_multi_stream_8(t, h, o, a, c) \
375 __bs_nonsingle(wm,s_8,(t),(h),(o),(a),(c))
378 * Bus write region operations.
380 #define bus_space_write_region_1(t, h, o, a, c) \
381 __bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
382 #define bus_space_write_region_2(t, h, o, a, c) \
383 __bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
384 #define bus_space_write_region_4(t, h, o, a, c) \
385 __bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
386 #define bus_space_write_region_8(t, h, o, a, c) \
387 __bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
389 #define bus_space_write_region_stream_1 bus_space_write_region_1
390 #define bus_space_write_region_stream_2(t, h, o, a, c) \
391 __bs_nonsingle(wr,s_2,(t),(h),(o),(a),(c))
392 #define bus_space_write_region_stream_4(t, h, o, a, c) \
393 __bs_nonsingle(wr,s_4,(t),(h),(o),(a),(c))
394 #define bus_space_write_region_stream_8(t, h, o, a, c) \
395 __bs_nonsingle(wr,s_8,(t),(h),(o),(a),(c))
398 * Set multiple operations.
400 #define bus_space_set_multi_1(t, h, o, v, c) \
401 __bs_set(sm,1,(t),(h),(o),(v),(c))
402 #define bus_space_set_multi_2(t, h, o, v, c) \
403 __bs_set(sm,2,(t),(h),(o),(v),(c))
404 #define bus_space_set_multi_4(t, h, o, v, c) \
405 __bs_set(sm,4,(t),(h),(o),(v),(c))
406 #define bus_space_set_multi_8(t, h, o, v, c) \
407 __bs_set(sm,8,(t),(h),(o),(v),(c))
409 #define bus_space_set_multi_stream_1 bus_space_set_multi_1
410 #define bus_space_set_multi_stream_2(t, h, o, v, c) \
411 __bs_set(sm,s_2,(t),(h),(o),(v),(c))
412 #define bus_space_set_multi_stream_4(t, h, o, v, c) \
413 __bs_set(sm,s_4,(t),(h),(o),(v),(c))
414 #define bus_space_set_multi_stream_8(t, h, o, v, c) \
415 __bs_set(sm,s_8,(t),(h),(o),(v),(c))
418 * Set region operations.
420 #define bus_space_set_region_1(t, h, o, v, c) \
421 __bs_set(sr,1,(t),(h),(o),(v),(c))
422 #define bus_space_set_region_2(t, h, o, v, c) \
423 __bs_set(sr,2,(t),(h),(o),(v),(c))
424 #define bus_space_set_region_4(t, h, o, v, c) \
425 __bs_set(sr,4,(t),(h),(o),(v),(c))
426 #define bus_space_set_region_8(t, h, o, v, c) \
427 __bs_set(sr,8,(t),(h),(o),(v),(c))
429 #define bus_space_set_region_stream_1 bus_space_set_region_1
430 #define bus_space_set_region_stream_2(t, h, o, v, c) \
431 __bs_set(sr,s_2,(t),(h),(o),(v),(c))
432 #define bus_space_set_region_stream_4(t, h, o, v, c) \
433 __bs_set(sr,s_4,(t),(h),(o),(v),(c))
434 #define bus_space_set_region_stream_8(t, h, o, v, c) \
435 __bs_set(sr,s_8,(t),(h),(o),(v),(c))
441 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c) \
442 __bs_copy(1, t, h1, o1, h2, o2, c)
443 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c) \
444 __bs_copy(2, t, h1, o1, h2, o2, c)
445 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c) \
446 __bs_copy(4, t, h1, o1, h2, o2, c)
447 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c) \
448 __bs_copy(8, t, h1, o1, h2, o2, c)
450 #define bus_space_copy_region_stream_1 bus_space_copy_region_1
451 #define bus_space_copy_region_stream_2(t, h1, o1, h2, o2, c) \
452 __bs_copy(s_2, t, h1, o1, h2, o2, c)
453 #define bus_space_copy_region_stream_4(t, h1, o1, h2, o2, c) \
454 __bs_copy(s_4, t, h1, o1, h2, o2, c)
455 #define bus_space_copy_region_stream_8(t, h1, o1, h2, o2, c) \
456 __bs_copy(s_8, t, h1, o1, h2, o2, c)
459 #include <machine/bus_dma.h>
461 #endif /* _MACHINE_BUS_H_ */