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 * Copyright (c) 1996 Charles M. Hannum. All rights reserved.
35 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * 3. All advertising materials mentioning features or use of this software
46 * must display the following acknowledgement:
47 * This product includes software developed by Christopher G. Demetriou
48 * for the NetBSD Project.
49 * 4. The name of the author may not be used to endorse or promote products
50 * derived from this software without specific prior written permission
52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 #ifndef _MACHINE_BUS_H_
67 #define _MACHINE_BUS_H_
69 #include <machine/_bus.h>
71 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
73 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFFUL
74 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFFUL
75 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFFUL
76 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFFUL
79 #define BUS_SPACE_MAXADDR 0xFFFFFFFFFFFFFFFFUL
80 #define BUS_SPACE_MAXSIZE 0xFFFFFFFFFFFFFFFFUL
82 #define BUS_SPACE_MAXADDR 0xFFFFFFFFUL
83 #define BUS_SPACE_MAXSIZE 0xFFFFFFFFUL
86 #define BUS_SPACE_MAP_CACHEABLE 0x01
87 #define BUS_SPACE_MAP_LINEAR 0x02
88 #define BUS_SPACE_MAP_PREFETCHABLE 0x04
90 #define BUS_SPACE_UNRESTRICTED (~0)
92 #define BUS_SPACE_BARRIER_READ 0x01
93 #define BUS_SPACE_BARRIER_WRITE 0x02
95 struct bus_space_access;
98 /* mapping/unmapping */
99 int (*bs_map)(bus_addr_t, bus_size_t, int,
100 bus_space_handle_t *);
101 void (*bs_unmap)(bus_size_t);
102 int (*bs_subregion)(bus_space_handle_t, bus_size_t,
103 bus_size_t, bus_space_handle_t *);
105 /* allocation/deallocation */
106 int (*bs_alloc)(bus_addr_t, bus_addr_t, bus_size_t,
107 bus_size_t, bus_size_t, int, bus_addr_t *, bus_space_handle_t *);
108 void (*bs_free)(bus_space_handle_t, bus_size_t);
110 void (*bs_barrier)(bus_space_handle_t, bus_size_t,
114 uint8_t (*bs_r_1)(bus_space_handle_t, bus_size_t);
115 uint16_t (*bs_r_2)(bus_space_handle_t, bus_size_t);
116 uint32_t (*bs_r_4)(bus_space_handle_t, bus_size_t);
117 uint64_t (*bs_r_8)(bus_space_handle_t, bus_size_t);
119 uint16_t (*bs_r_s_2)(bus_space_handle_t, bus_size_t);
120 uint32_t (*bs_r_s_4)(bus_space_handle_t, bus_size_t);
121 uint64_t (*bs_r_s_8)(bus_space_handle_t, bus_size_t);
124 void (*bs_rm_1)(bus_space_handle_t, bus_size_t, uint8_t *,
126 void (*bs_rm_2)(bus_space_handle_t, bus_size_t, uint16_t *,
128 void (*bs_rm_4)(bus_space_handle_t, bus_size_t, uint32_t *,
130 void (*bs_rm_8)(bus_space_handle_t, bus_size_t, uint64_t *,
133 void (*bs_rm_s_2)(bus_space_handle_t, bus_size_t, uint16_t *,
135 void (*bs_rm_s_4)(bus_space_handle_t, bus_size_t, uint32_t *,
137 void (*bs_rm_s_8)(bus_space_handle_t, bus_size_t, uint64_t *,
141 void (*bs_rr_1)(bus_space_handle_t, bus_size_t, uint8_t *,
143 void (*bs_rr_2)(bus_space_handle_t, bus_size_t, uint16_t *,
145 void (*bs_rr_4)(bus_space_handle_t, bus_size_t, uint32_t *,
147 void (*bs_rr_8)(bus_space_handle_t, bus_size_t, uint64_t *,
150 void (*bs_rr_s_2)(bus_space_handle_t, bus_size_t, uint16_t *,
152 void (*bs_rr_s_4)(bus_space_handle_t, bus_size_t, uint32_t *,
154 void (*bs_rr_s_8)(bus_space_handle_t, bus_size_t, uint64_t *,
158 void (*bs_w_1)(bus_space_handle_t, bus_size_t, uint8_t);
159 void (*bs_w_2)(bus_space_handle_t, bus_size_t, uint16_t);
160 void (*bs_w_4)(bus_space_handle_t, bus_size_t, uint32_t);
161 void (*bs_w_8)(bus_space_handle_t, bus_size_t, uint64_t);
163 void (*bs_w_s_2)(bus_space_handle_t, bus_size_t, uint16_t);
164 void (*bs_w_s_4)(bus_space_handle_t, bus_size_t, uint32_t);
165 void (*bs_w_s_8)(bus_space_handle_t, bus_size_t, uint64_t);
168 void (*bs_wm_1)(bus_space_handle_t, bus_size_t,
169 const uint8_t *, bus_size_t);
170 void (*bs_wm_2)(bus_space_handle_t, bus_size_t,
171 const uint16_t *, bus_size_t);
172 void (*bs_wm_4)(bus_space_handle_t, bus_size_t,
173 const uint32_t *, bus_size_t);
174 void (*bs_wm_8)(bus_space_handle_t, bus_size_t,
175 const uint64_t *, bus_size_t);
177 void (*bs_wm_s_2)(bus_space_handle_t, bus_size_t,
178 const uint16_t *, bus_size_t);
179 void (*bs_wm_s_4)(bus_space_handle_t, bus_size_t,
180 const uint32_t *, bus_size_t);
181 void (*bs_wm_s_8)(bus_space_handle_t, bus_size_t,
182 const uint64_t *, bus_size_t);
185 void (*bs_wr_1)(bus_space_handle_t, bus_size_t,
186 const uint8_t *, bus_size_t);
187 void (*bs_wr_2)(bus_space_handle_t, bus_size_t,
188 const uint16_t *, bus_size_t);
189 void (*bs_wr_4)(bus_space_handle_t, bus_size_t,
190 const uint32_t *, bus_size_t);
191 void (*bs_wr_8)(bus_space_handle_t, bus_size_t,
192 const uint64_t *, bus_size_t);
194 void (*bs_wr_s_2)(bus_space_handle_t, bus_size_t,
195 const uint16_t *, bus_size_t);
196 void (*bs_wr_s_4)(bus_space_handle_t, bus_size_t,
197 const uint32_t *, bus_size_t);
198 void (*bs_wr_s_8)(bus_space_handle_t, bus_size_t,
199 const uint64_t *, bus_size_t);
202 void (*bs_sm_1)(bus_space_handle_t, bus_size_t, uint8_t,
204 void (*bs_sm_2)(bus_space_handle_t, bus_size_t, uint16_t,
206 void (*bs_sm_4)(bus_space_handle_t, bus_size_t, uint32_t,
208 void (*bs_sm_8)(bus_space_handle_t, bus_size_t, uint64_t,
211 void (*bs_sm_s_2)(bus_space_handle_t, bus_size_t, uint16_t,
213 void (*bs_sm_s_4)(bus_space_handle_t, bus_size_t, uint32_t,
215 void (*bs_sm_s_8)(bus_space_handle_t, bus_size_t, uint64_t,
219 void (*bs_sr_1)(bus_space_handle_t, bus_size_t, uint8_t,
221 void (*bs_sr_2)(bus_space_handle_t, bus_size_t, uint16_t,
223 void (*bs_sr_4)(bus_space_handle_t, bus_size_t, uint32_t,
225 void (*bs_sr_8)(bus_space_handle_t, bus_size_t, uint64_t,
228 void (*bs_sr_s_2)(bus_space_handle_t, bus_size_t, uint16_t,
230 void (*bs_sr_s_4)(bus_space_handle_t, bus_size_t, uint32_t,
232 void (*bs_sr_s_8)(bus_space_handle_t, bus_size_t, uint64_t,
236 void (*bs_cr_1)(bus_space_handle_t, bus_size_t,
237 bus_space_handle_t, bus_size_t, bus_size_t);
238 void (*bs_cr_2)(bus_space_handle_t, bus_size_t,
239 bus_space_handle_t, bus_size_t, bus_size_t);
240 void (*bs_cr_4)(bus_space_handle_t, bus_size_t,
241 bus_space_handle_t, bus_size_t, bus_size_t);
242 void (*bs_cr_8)(bus_space_handle_t, bus_size_t,
243 bus_space_handle_t, bus_size_t, bus_size_t);
245 void (*bs_cr_s_2)(bus_space_handle_t, bus_size_t,
246 bus_space_handle_t, bus_size_t, bus_size_t);
247 void (*bs_cr_s_4)(bus_space_handle_t, bus_size_t,
248 bus_space_handle_t, bus_size_t, bus_size_t);
249 void (*bs_cr_s_8)(bus_space_handle_t, bus_size_t,
250 bus_space_handle_t, bus_size_t, bus_size_t);
253 extern struct bus_space bs_be_tag;
254 extern struct bus_space bs_le_tag;
256 #define __bs_c(a,b) __CONCAT(a,b)
257 #define __bs_opname(op,size) __bs_c(__bs_c(__bs_c(bs_,op),_),size)
259 #define __bs_rs(sz, t, h, o) \
260 (*(t)->__bs_opname(r,sz))(h, o)
261 #define __bs_ws(sz, t, h, o, v) \
262 (*(t)->__bs_opname(w,sz))(h, o, v)
263 #define __bs_nonsingle(type, sz, t, h, o, a, c) \
264 (*(t)->__bs_opname(type,sz))(h, o, a, c)
265 #define __bs_set(type, sz, t, h, o, v, c) \
266 (*(t)->__bs_opname(type,sz))(h, o, v, c)
267 #define __bs_copy(sz, t, h1, o1, h2, o2, cnt) \
268 (*(t)->__bs_opname(c,sz))(h1, o1, h2, o2, cnt)
271 * Mapping and unmapping operations.
273 #define bus_space_map(t, a, s, c, hp) (*(t)->bs_map)(a, s, c, hp)
274 #define bus_space_unmap(t, h, s) (*(t)->bs_unmap)(h, s)
275 #define bus_space_subregion(t, h, o, s, hp) (*(t)->bs_subregion)(h, o, s, hp)
278 * Allocation and deallocation operations.
280 #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp) \
281 (*(t)->bs_alloc)(rs, re, s, a, b, c, ap, hp)
282 #define bus_space_free(t, h, s) \
283 (*(t)->bs_free)(h, s)
286 * Bus barrier operations.
288 #define bus_space_barrier(t, h, o, l, f) (*(t)->bs_barrier)(h, o, l, f)
291 * Bus read (single) operations.
293 #define bus_space_read_1(t, h, o) __bs_rs(1,t,h,o)
294 #define bus_space_read_2(t, h, o) __bs_rs(2,t,h,o)
295 #define bus_space_read_4(t, h, o) __bs_rs(4,t,h,o)
296 #define bus_space_read_8(t, h, o) __bs_rs(8,t,h,o)
298 #define bus_space_read_stream_1 bus_space_read_1
299 #define bus_space_read_stream_2(t, h, o) __bs_rs(s_2,t,h,o)
300 #define bus_space_read_stream_4(t, h, o) __bs_rs(s_4,t,h,o)
301 #define bus_space_read_stream_8(t, h, o) __bs_rs(s_8,t,h,o)
304 * Bus read multiple operations.
306 #define bus_space_read_multi_1(t, h, o, a, c) \
307 __bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
308 #define bus_space_read_multi_2(t, h, o, a, c) \
309 __bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
310 #define bus_space_read_multi_4(t, h, o, a, c) \
311 __bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
312 #define bus_space_read_multi_8(t, h, o, a, c) \
313 __bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
315 #define bus_space_read_multi_stream_1 bus_space_read_multi_1
316 #define bus_space_read_multi_stream_2(t, h, o, a, c) \
317 __bs_nonsingle(rm,s_2,(t),(h),(o),(a),(c))
318 #define bus_space_read_multi_stream_4(t, h, o, a, c) \
319 __bs_nonsingle(rm,s_4,(t),(h),(o),(a),(c))
320 #define bus_space_read_multi_stream_8(t, h, o, a, c) \
321 __bs_nonsingle(rm,s_8,(t),(h),(o),(a),(c))
324 * Bus read region operations.
326 #define bus_space_read_region_1(t, h, o, a, c) \
327 __bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
328 #define bus_space_read_region_2(t, h, o, a, c) \
329 __bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
330 #define bus_space_read_region_4(t, h, o, a, c) \
331 __bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
332 #define bus_space_read_region_8(t, h, o, a, c) \
333 __bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
335 #define bus_space_read_region_stream_1 bus_space_read_region_1
336 #define bus_space_read_region_stream_2(t, h, o, a, c) \
337 __bs_nonsingle(rr,s_2,(t),(h),(o),(a),(c))
338 #define bus_space_read_region_stream_4(t, h, o, a, c) \
339 __bs_nonsingle(rr,s_4,(t),(h),(o),(a),(c))
340 #define bus_space_read_region_stream_8(t, h, o, a, c) \
341 __bs_nonsingle(rr,s_8,(t),(h),(o),(a),(c))
344 * Bus write (single) operations.
346 #define bus_space_write_1(t, h, o, v) __bs_ws(1,(t),(h),(o),(v))
347 #define bus_space_write_2(t, h, o, v) __bs_ws(2,(t),(h),(o),(v))
348 #define bus_space_write_4(t, h, o, v) __bs_ws(4,(t),(h),(o),(v))
349 #define bus_space_write_8(t, h, o, v) __bs_ws(8,(t),(h),(o),(v))
351 #define bus_space_write_stream_1 bus_space_write_1
352 #define bus_space_write_stream_2(t, h, o, v) __bs_ws(s_2,(t),(h),(o),(v))
353 #define bus_space_write_stream_4(t, h, o, v) __bs_ws(s_4,(t),(h),(o),(v))
354 #define bus_space_write_stream_8(t, h, o, v) __bs_ws(s_8,(t),(h),(o),(v))
357 * Bus write multiple operations.
359 #define bus_space_write_multi_1(t, h, o, a, c) \
360 __bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
361 #define bus_space_write_multi_2(t, h, o, a, c) \
362 __bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
363 #define bus_space_write_multi_4(t, h, o, a, c) \
364 __bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
365 #define bus_space_write_multi_8(t, h, o, a, c) \
366 __bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
368 #define bus_space_write_multi_stream_1 bus_space_write_multi_1
369 #define bus_space_write_multi_stream_2(t, h, o, a, c) \
370 __bs_nonsingle(wm,s_2,(t),(h),(o),(a),(c))
371 #define bus_space_write_multi_stream_4(t, h, o, a, c) \
372 __bs_nonsingle(wm,s_4,(t),(h),(o),(a),(c))
373 #define bus_space_write_multi_stream_8(t, h, o, a, c) \
374 __bs_nonsingle(wm,s_8,(t),(h),(o),(a),(c))
377 * Bus write region operations.
379 #define bus_space_write_region_1(t, h, o, a, c) \
380 __bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
381 #define bus_space_write_region_2(t, h, o, a, c) \
382 __bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
383 #define bus_space_write_region_4(t, h, o, a, c) \
384 __bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
385 #define bus_space_write_region_8(t, h, o, a, c) \
386 __bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
388 #define bus_space_write_region_stream_1 bus_space_write_region_1
389 #define bus_space_write_region_stream_2(t, h, o, a, c) \
390 __bs_nonsingle(wr,s_2,(t),(h),(o),(a),(c))
391 #define bus_space_write_region_stream_4(t, h, o, a, c) \
392 __bs_nonsingle(wr,s_4,(t),(h),(o),(a),(c))
393 #define bus_space_write_region_stream_8(t, h, o, a, c) \
394 __bs_nonsingle(wr,s_8,(t),(h),(o),(a),(c))
397 * Set multiple operations.
399 #define bus_space_set_multi_1(t, h, o, v, c) \
400 __bs_set(sm,1,(t),(h),(o),(v),(c))
401 #define bus_space_set_multi_2(t, h, o, v, c) \
402 __bs_set(sm,2,(t),(h),(o),(v),(c))
403 #define bus_space_set_multi_4(t, h, o, v, c) \
404 __bs_set(sm,4,(t),(h),(o),(v),(c))
405 #define bus_space_set_multi_8(t, h, o, v, c) \
406 __bs_set(sm,8,(t),(h),(o),(v),(c))
408 #define bus_space_set_multi_stream_1 bus_space_set_multi_1
409 #define bus_space_set_multi_stream_2(t, h, o, v, c) \
410 __bs_set(sm,s_2,(t),(h),(o),(v),(c))
411 #define bus_space_set_multi_stream_4(t, h, o, v, c) \
412 __bs_set(sm,s_4,(t),(h),(o),(v),(c))
413 #define bus_space_set_multi_stream_8(t, h, o, v, c) \
414 __bs_set(sm,s_8,(t),(h),(o),(v),(c))
417 * Set region operations.
419 #define bus_space_set_region_1(t, h, o, v, c) \
420 __bs_set(sr,1,(t),(h),(o),(v),(c))
421 #define bus_space_set_region_2(t, h, o, v, c) \
422 __bs_set(sr,2,(t),(h),(o),(v),(c))
423 #define bus_space_set_region_4(t, h, o, v, c) \
424 __bs_set(sr,4,(t),(h),(o),(v),(c))
425 #define bus_space_set_region_8(t, h, o, v, c) \
426 __bs_set(sr,8,(t),(h),(o),(v),(c))
428 #define bus_space_set_region_stream_1 bus_space_set_region_1
429 #define bus_space_set_region_stream_2(t, h, o, v, c) \
430 __bs_set(sr,s_2,(t),(h),(o),(v),(c))
431 #define bus_space_set_region_stream_4(t, h, o, v, c) \
432 __bs_set(sr,s_4,(t),(h),(o),(v),(c))
433 #define bus_space_set_region_stream_8(t, h, o, v, c) \
434 __bs_set(sr,s_8,(t),(h),(o),(v),(c))
440 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c) \
441 __bs_copy(1, t, h1, o1, h2, o2, c)
442 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c) \
443 __bs_copy(2, t, h1, o1, h2, o2, c)
444 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c) \
445 __bs_copy(4, t, h1, o1, h2, o2, c)
446 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c) \
447 __bs_copy(8, t, h1, o1, h2, o2, c)
449 #define bus_space_copy_region_stream_1 bus_space_copy_region_1
450 #define bus_space_copy_region_stream_2(t, h1, o1, h2, o2, c) \
451 __bs_copy(s_2, t, h1, o1, h2, o2, c)
452 #define bus_space_copy_region_stream_4(t, h1, o1, h2, o2, c) \
453 __bs_copy(s_4, t, h1, o1, h2, o2, c)
454 #define bus_space_copy_region_stream_8(t, h1, o1, h2, o2, c) \
455 __bs_copy(s_8, t, h1, o1, h2, o2, c)
458 #include <machine/bus_dma.h>
460 #endif /* _MACHINE_BUS_H_ */