/* $OpenBSD: bus.h,v 1.10 1998/01/20 18:40:09 niklas Exp $ */ /* $NetBSD: bus.h,v 1.10 1996/12/02 22:19:32 cgd Exp $ */ /* * Copyright (c) 1996 Carnegie-Mellon University. * All rights reserved. * * Author: Chris G. Demetriou * * Permission to use, copy, modify and distribute this software and * its documentation is hereby granted, provided that both the copyright * notice and this permission notice appear in all copies of the * software, derivative works or modified versions, and any portions * thereof, and that both notices appear in supporting documentation. * * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. * * Carnegie Mellon requests users of this software to return to * * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU * School of Computer Science * Carnegie Mellon University * Pittsburgh PA 15213-3890 * * any improvements or extensions that they make and grant Carnegie the * rights to redistribute these changes. */ #ifndef _ALPHA_BUS_H_ #define _ALPHA_BUS_H_ /* * Addresses (in bus space). */ typedef u_long bus_addr_t; typedef u_long bus_size_t; /* * Access methods for bus space. */ typedef struct alpha_bus_space *bus_space_tag_t; typedef u_long bus_space_handle_t; struct alpha_bus_space { /* cookie */ void *abs_cookie; /* mapping/unmapping */ int (*abs_map) __P((void *, bus_addr_t, bus_size_t, int, bus_space_handle_t *)); void (*abs_unmap) __P((void *, bus_space_handle_t, bus_size_t)); int (*abs_subregion) __P((void *, bus_space_handle_t, bus_size_t, bus_size_t, bus_space_handle_t *)); /* allocation/deallocation */ int (*abs_alloc) __P((void *, bus_addr_t, bus_addr_t, bus_size_t, bus_size_t, bus_size_t, int, bus_addr_t *, bus_space_handle_t *)); void (*abs_free) __P((void *, bus_space_handle_t, bus_size_t)); /* barrier */ void (*abs_barrier) __P((void *, bus_space_handle_t, bus_size_t, bus_size_t, int)); /* read (single) */ u_int8_t (*abs_r_1) __P((void *, bus_space_handle_t, bus_size_t)); u_int16_t (*abs_r_2) __P((void *, bus_space_handle_t, bus_size_t)); u_int32_t (*abs_r_4) __P((void *, bus_space_handle_t, bus_size_t)); u_int64_t (*abs_r_8) __P((void *, bus_space_handle_t, bus_size_t)); /* read multiple */ void (*abs_rm_1) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t *, bus_size_t)); void (*abs_rm_2) __P((void *, bus_space_handle_t, bus_size_t, u_int16_t *, bus_size_t)); void (*abs_rm_4) __P((void *, bus_space_handle_t, bus_size_t, u_int32_t *, bus_size_t)); void (*abs_rm_8) __P((void *, bus_space_handle_t, bus_size_t, u_int64_t *, bus_size_t)); /* read region */ void (*abs_rr_1) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t *, bus_size_t)); void (*abs_rr_2) __P((void *, bus_space_handle_t, bus_size_t, u_int16_t *, bus_size_t)); void (*abs_rr_4) __P((void *, bus_space_handle_t, bus_size_t, u_int32_t *, bus_size_t)); void (*abs_rr_8) __P((void *, bus_space_handle_t, bus_size_t, u_int64_t *, bus_size_t)); /* write (single) */ void (*abs_w_1) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t)); void (*abs_w_2) __P((void *, bus_space_handle_t, bus_size_t, u_int16_t)); void (*abs_w_4) __P((void *, bus_space_handle_t, bus_size_t, u_int32_t)); void (*abs_w_8) __P((void *, bus_space_handle_t, bus_size_t, u_int64_t)); /* write multiple */ void (*abs_wm_1) __P((void *, bus_space_handle_t, bus_size_t, const u_int8_t *, bus_size_t)); void (*abs_wm_2) __P((void *, bus_space_handle_t, bus_size_t, const u_int16_t *, bus_size_t)); void (*abs_wm_4) __P((void *, bus_space_handle_t, bus_size_t, const u_int32_t *, bus_size_t)); void (*abs_wm_8) __P((void *, bus_space_handle_t, bus_size_t, const u_int64_t *, bus_size_t)); /* write region */ void (*abs_wr_1) __P((void *, bus_space_handle_t, bus_size_t, const u_int8_t *, bus_size_t)); void (*abs_wr_2) __P((void *, bus_space_handle_t, bus_size_t, const u_int16_t *, bus_size_t)); void (*abs_wr_4) __P((void *, bus_space_handle_t, bus_size_t, const u_int32_t *, bus_size_t)); void (*abs_wr_8) __P((void *, bus_space_handle_t, bus_size_t, const u_int64_t *, bus_size_t)); /* set multiple */ void (*abs_sm_1) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t, bus_size_t)); void (*abs_sm_2) __P((void *, bus_space_handle_t, bus_size_t, u_int16_t, bus_size_t)); void (*abs_sm_4) __P((void *, bus_space_handle_t, bus_size_t, u_int32_t, bus_size_t)); void (*abs_sm_8) __P((void *, bus_space_handle_t, bus_size_t, u_int64_t, bus_size_t)); /* set region */ void (*abs_sr_1) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t, bus_size_t)); void (*abs_sr_2) __P((void *, bus_space_handle_t, bus_size_t, u_int16_t, bus_size_t)); void (*abs_sr_4) __P((void *, bus_space_handle_t, bus_size_t, u_int32_t, bus_size_t)); void (*abs_sr_8) __P((void *, bus_space_handle_t, bus_size_t, u_int64_t, bus_size_t)); /* copy */ void (*abs_c_1) __P((void *, bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t, bus_size_t)); void (*abs_c_2) __P((void *, bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t, bus_size_t)); void (*abs_c_4) __P((void *, bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t, bus_size_t)); void (*abs_c_8) __P((void *, bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t, bus_size_t)); /* OpenBSD extensions follows */ /* read multiple raw */ void (*abs_rrm_2) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t *, bus_size_t)); void (*abs_rrm_4) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t *, bus_size_t)); void (*abs_rrm_8) __P((void *, bus_space_handle_t, bus_size_t, u_int8_t *, bus_size_t)); /* write multiple raw */ void (*abs_wrm_2) __P((void *, bus_space_handle_t, bus_size_t, const u_int8_t *, bus_size_t)); void (*abs_wrm_4) __P((void *, bus_space_handle_t, bus_size_t, const u_int8_t *, bus_size_t)); void (*abs_wrm_8) __P((void *, bus_space_handle_t, bus_size_t, const u_int8_t *, bus_size_t)); }; /* * Utility macros; INTERNAL USE ONLY. */ #define __abs_c(a,b) __CONCAT(a,b) #define __abs_opname(op,size) __abs_c(__abs_c(__abs_c(abs_,op),_),size) #define __abs_rs(sz, t, h, o) \ (*(t)->__abs_opname(r,sz))((t)->abs_cookie, h, o) #define __abs_ws(sz, t, h, o, v) \ (*(t)->__abs_opname(w,sz))((t)->abs_cookie, h, o, v) #define __abs_nonsingle(type, sz, t, h, o, a, c) \ (*(t)->__abs_opname(type,sz))((t)->abs_cookie, h, o, a, c) #ifndef DEBUG #define __abs_aligned_nonsingle(type, sz, t, h, o, a, c) \ __abs_nonsingle(type, sz, (t), (h), (o), (a), (c)) #else #define __abs_aligned_nonsingle(type, sz, t, h, o, a, c) \ do { \ if (((unsigned long)a & (sz - 1)) != 0) \ panic("bus non-single %d-byte unaligned (to %p) at %s:%d", \ sz, a, __FILE__, __LINE__); \ (*(t)->__abs_opname(type,sz))((t)->abs_cookie, h, o, a, c); \ } while (0) #endif #define __abs_set(type, sz, t, h, o, v, c) \ (*(t)->__abs_opname(type,sz))((t)->abs_cookie, h, o, v, c) #define __abs_copy(sz, t, h1, o1, h2, o2, cnt) \ (*(t)->__abs_opname(c,sz))((t)->abs_cookie, h1, o1, h2, o2, cnt) /* * Mapping and unmapping operations. */ #define bus_space_map(t, a, s, c, hp) \ (*(t)->abs_map)((t)->abs_cookie, (a), (s), (c), (hp)) #define bus_space_unmap(t, h, s) \ (*(t)->abs_unmap)((t)->abs_cookie, (h), (s)) #define bus_space_subregion(t, h, o, s, hp) \ (*(t)->abs_subregion)((t)->abs_cookie, (h), (o), (s), (hp)) /* * Allocation and deallocation operations. */ #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp) \ (*(t)->abs_alloc)((t)->abs_cookie, (rs), (re), (s), (a), (b), \ (c), (ap), (hp)) #define bus_space_free(t, h, s) \ (*(t)->abs_free)((t)->abs_cookie, (h), (s)) /* * Bus barrier operations. */ #define bus_space_barrier(t, h, o, l, f) \ (*(t)->abs_barrier)((t)->abs_cookie, (h), (o), (l), (f)) #define BUS_BARRIER_READ 0x01 #define BUS_BARRIER_WRITE 0x02 /* * Bus read (single) operations. */ #define bus_space_read_1(t, h, o) __abs_rs(1,(t),(h),(o)) #define bus_space_read_2(t, h, o) __abs_rs(2,(t),(h),(o)) #define bus_space_read_4(t, h, o) __abs_rs(4,(t),(h),(o)) #define bus_space_read_8(t, h, o) __abs_rs(8,(t),(h),(o)) /* * Bus read multiple operations. */ #define bus_space_read_multi_1(t, h, o, a, c) \ __abs_nonsingle(rm,1,(t),(h),(o),(a),(c)) #define bus_space_read_multi_2(t, h, o, a, c) \ __abs_aligned_nonsingle(rm,2,(t),(h),(o),(a),(c)) #define bus_space_read_multi_4(t, h, o, a, c) \ __abs_aligned_nonsingle(rm,4,(t),(h),(o),(a),(c)) #define bus_space_read_multi_8(t, h, o, a, c) \ __abs_aligned_nonsingle(rm,8,(t),(h),(o),(a),(c)) /* * void bus_space_read_raw_multi_N __P((bus_space_tag_t tag, * bus_space_handle_t bsh, bus_size_t offset, * u_int8_t *addr, size_t count)); * * Read `count' bytes in 2, 4 or 8 byte wide quantities from bus space * described by tag/handle/offset and copy into buffer provided. The buffer * must have proper alignment for the N byte wide entities. Furthermore * possible byte-swapping should be done by these functions. */ #define bus_space_read_raw_multi_2(t, h, o, a, c) \ __abs_nonsingle(rrm,2,(t),(h),(o),(a),(c)) #define bus_space_read_raw_multi_4(t, h, o, a, c) \ __abs_nonsingle(rrm,4,(t),(h),(o),(a),(c)) #define bus_space_read_raw_multi_8(t, h, o, a, c) \ __abs_nonsingle(rrm,8,(t),(h),(o),(a),(c)) /* * Bus read region operations. */ #define bus_space_read_region_1(t, h, o, a, c) \ __abs_nonsingle(rr,1,(t),(h),(o),(a),(c)) #define bus_space_read_region_2(t, h, o, a, c) \ __abs_aligned_nonsingle(rr,2,(t),(h),(o),(a),(c)) #define bus_space_read_region_4(t, h, o, a, c) \ __abs_aligned_nonsingle(rr,4,(t),(h),(o),(a),(c)) #define bus_space_read_region_8(t, h, o, a, c) \ __abs_aligned_nonsingle(rr,8,(t),(h),(o),(a),(c)) /* * Bus write (single) operations. */ #define bus_space_write_1(t, h, o, v) __abs_ws(1,(t),(h),(o),(v)) #define bus_space_write_2(t, h, o, v) __abs_ws(2,(t),(h),(o),(v)) #define bus_space_write_4(t, h, o, v) __abs_ws(4,(t),(h),(o),(v)) #define bus_space_write_8(t, h, o, v) __abs_ws(8,(t),(h),(o),(v)) /* * Bus write multiple operations. */ #define bus_space_write_multi_1(t, h, o, a, c) \ __abs_nonsingle(wm,1,(t),(h),(o),(a),(c)) #define bus_space_write_multi_2(t, h, o, a, c) \ __abs_aligned_nonsingle(wm,2,(t),(h),(o),(a),(c)) #define bus_space_write_multi_4(t, h, o, a, c) \ __abs_aligned_nonsingle(wm,4,(t),(h),(o),(a),(c)) #define bus_space_write_multi_8(t, h, o, a, c) \ __abs_aligned_nonsingle(wm,8,(t),(h),(o),(a),(c)) /* * void bus_space_write_raw_multi_N __P((bus_space_tag_t tag, * bus_space_handle_t bsh, bus_size_t offset, * u_int8_t *addr, size_t count)); * * Write `count' bytes in 2, 4 or 8 byte wide quantities from the buffer * provided to bus space described by tag/handle/offset. The buffer * must have proper alignment for the N byte wide entities. Furthermore * possible byte-swapping should be done by these functions. */ #define bus_space_write_raw_multi_2(t, h, o, a, c) \ __abs_nonsingle(wrm,2,(t),(h),(o),(a),(c)) #define bus_space_write_raw_multi_4(t, h, o, a, c) \ __abs_nonsingle(wrm,4,(t),(h),(o),(a),(c)) #define bus_space_write_raw_multi_8(t, h, o, a, c) \ __abs_nonsingle(wrm,8,(t),(h),(o),(a),(c)) /* * Bus write region operations. */ #define bus_space_write_region_1(t, h, o, a, c) \ __abs_nonsingle(wr,1,(t),(h),(o),(a),(c)) #define bus_space_write_region_2(t, h, o, a, c) \ __abs_aligned_nonsingle(wr,2,(t),(h),(o),(a),(c)) #define bus_space_write_region_4(t, h, o, a, c) \ __abs_aligned_nonsingle(wr,4,(t),(h),(o),(a),(c)) #define bus_space_write_region_8(t, h, o, a, c) \ __abs_aligned_nonsingle(wr,8,(t),(h),(o),(a),(c)) /* * Set multiple operations. */ #define bus_space_set_multi_1(t, h, o, v, c) \ __abs_set(sm,1,(t),(h),(o),(v),(c)) #define bus_space_set_multi_2(t, h, o, v, c) \ __abs_set(sm,2,(t),(h),(o),(v),(c)) #define bus_space_set_multi_4(t, h, o, v, c) \ __abs_set(sm,4,(t),(h),(o),(v),(c)) #define bus_space_set_multi_8(t, h, o, v, c) \ __abs_set(sm,8,(t),(h),(o),(v),(c)) /* * Set region operations. */ #define bus_space_set_region_1(t, h, o, v, c) \ __abs_set(sr,1,(t),(h),(o),(v),(c)) #define bus_space_set_region_2(t, h, o, v, c) \ __abs_set(sr,2,(t),(h),(o),(v),(c)) #define bus_space_set_region_4(t, h, o, v, c) \ __abs_set(sr,4,(t),(h),(o),(v),(c)) #define bus_space_set_region_8(t, h, o, v, c) \ __abs_set(sr,8,(t),(h),(o),(v),(c)) /* * Copy operations. */ #define bus_space_copy_1(t, h1, o1, h2, o2, c) \ __abs_copy(1, t, h1, o1, h2, o2, c) #define bus_space_copy_2(t, h1, o1, h2, o2, c) \ __abs_copy(2, t, h1, o1, h2, o2, c) #define bus_space_copy_4(t, h1, o1, h2, o2, c) \ __abs_copy(4, t, h1, o1, h2, o2, c) #define bus_space_copy_8(t, h1, o1, h2, o2, c) \ __abs_copy(8, t, h1, o1, h2, o2, c) /* XXX placeholders */ typedef void *bus_dma_tag_t; typedef void *bus_dmamap_t; #endif /* _ALPHA_BUS_H_ */