bus.h revision 277460
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 * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
35 * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
36 *
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
39 * are met:
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
51 *
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.
62 *
63 * $FreeBSD: head/sys/arm/include/bus.h 277460 2015-01-21 01:06:08Z ian $
64 */
65
66#ifndef _MACHINE_BUS_H_
67#define _MACHINE_BUS_H_
68
69#include <machine/_bus.h>
70
71/*
72 *	int bus_space_map  (bus_space_tag_t t, bus_addr_t addr,
73 *	    bus_size_t size, int flags, bus_space_handle_t *bshp);
74 *
75 * Map a region of bus space.
76 */
77
78#define	BUS_SPACE_MAP_CACHEABLE		0x01
79#define	BUS_SPACE_MAP_LINEAR		0x02
80#define	BUS_SPACE_MAP_PREFETCHABLE     	0x04
81
82struct bus_space {
83	/* cookie */
84	void		*bs_privdata;
85
86	/* mapping/unmapping */
87	int		(*bs_map) (bus_space_tag_t, bus_addr_t, bus_size_t,
88			    int, bus_space_handle_t *);
89	void		(*bs_unmap) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
90	int		(*bs_subregion) (bus_space_tag_t, bus_space_handle_t,
91			    bus_size_t, bus_size_t, bus_space_handle_t *);
92
93	/* allocation/deallocation */
94	int		(*bs_alloc) (bus_space_tag_t, bus_addr_t, bus_addr_t,
95			    bus_size_t, bus_size_t, bus_size_t, int,
96			    bus_addr_t *, bus_space_handle_t *);
97	void		(*bs_free) (bus_space_tag_t, bus_space_handle_t,
98			    bus_size_t);
99
100	/* get kernel virtual address */
101	/* barrier */
102	void		(*bs_barrier) (bus_space_tag_t, bus_space_handle_t,
103			    bus_size_t, bus_size_t, int);
104
105	/* read (single) */
106	uint8_t		(*bs_r_1) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
107	uint16_t	(*bs_r_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
108	uint32_t	(*bs_r_4) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
109	uint64_t	(*bs_r_8) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
110
111	/* read multiple */
112	void		(*bs_rm_1) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
113	    uint8_t *, bus_size_t);
114	void		(*bs_rm_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
115	    uint16_t *, bus_size_t);
116	void		(*bs_rm_4) (bus_space_tag_t, bus_space_handle_t,
117			    bus_size_t, uint32_t *, bus_size_t);
118	void		(*bs_rm_8) (bus_space_tag_t, bus_space_handle_t,
119			    bus_size_t, uint64_t *, bus_size_t);
120
121	/* read region */
122	void		(*bs_rr_1) (bus_space_tag_t, bus_space_handle_t,
123			    bus_size_t, uint8_t *, bus_size_t);
124	void		(*bs_rr_2) (bus_space_tag_t, bus_space_handle_t,
125			    bus_size_t, uint16_t *, bus_size_t);
126	void		(*bs_rr_4) (bus_space_tag_t, bus_space_handle_t,
127			    bus_size_t, uint32_t *, bus_size_t);
128	void		(*bs_rr_8) (bus_space_tag_t, bus_space_handle_t,
129			    bus_size_t, uint64_t *, bus_size_t);
130
131	/* write (single) */
132	void		(*bs_w_1) (bus_space_tag_t, bus_space_handle_t,
133			    bus_size_t, uint8_t);
134	void		(*bs_w_2) (bus_space_tag_t, bus_space_handle_t,
135			    bus_size_t, uint16_t);
136	void		(*bs_w_4) (bus_space_tag_t, bus_space_handle_t,
137			    bus_size_t, uint32_t);
138	void		(*bs_w_8) (bus_space_tag_t, bus_space_handle_t,
139			    bus_size_t, uint64_t);
140
141	/* write multiple */
142	void		(*bs_wm_1) (bus_space_tag_t, bus_space_handle_t,
143			    bus_size_t, const uint8_t *, bus_size_t);
144	void		(*bs_wm_2) (bus_space_tag_t, bus_space_handle_t,
145			    bus_size_t, const uint16_t *, bus_size_t);
146	void		(*bs_wm_4) (bus_space_tag_t, bus_space_handle_t,
147			    bus_size_t, const uint32_t *, bus_size_t);
148	void		(*bs_wm_8) (bus_space_tag_t, bus_space_handle_t,
149			    bus_size_t, const uint64_t *, bus_size_t);
150
151	/* write region */
152	void		(*bs_wr_1) (bus_space_tag_t, bus_space_handle_t,
153			    bus_size_t, const uint8_t *, bus_size_t);
154	void		(*bs_wr_2) (bus_space_tag_t, bus_space_handle_t,
155			    bus_size_t, const uint16_t *, bus_size_t);
156	void		(*bs_wr_4) (bus_space_tag_t, bus_space_handle_t,
157			    bus_size_t, const uint32_t *, bus_size_t);
158	void		(*bs_wr_8) (bus_space_tag_t, bus_space_handle_t,
159			    bus_size_t, const uint64_t *, bus_size_t);
160
161	/* set multiple */
162	void		(*bs_sm_1) (bus_space_tag_t, bus_space_handle_t,
163			    bus_size_t, uint8_t, bus_size_t);
164	void		(*bs_sm_2) (bus_space_tag_t, bus_space_handle_t,
165			    bus_size_t, uint16_t, bus_size_t);
166	void		(*bs_sm_4) (bus_space_tag_t, bus_space_handle_t,
167			    bus_size_t, uint32_t, bus_size_t);
168	void		(*bs_sm_8) (bus_space_tag_t, bus_space_handle_t,
169			    bus_size_t, uint64_t, bus_size_t);
170
171	/* set region */
172	void		(*bs_sr_1) (bus_space_tag_t, bus_space_handle_t,
173			    bus_size_t, uint8_t, bus_size_t);
174	void		(*bs_sr_2) (bus_space_tag_t, bus_space_handle_t,
175			    bus_size_t, uint16_t, bus_size_t);
176	void		(*bs_sr_4) (bus_space_tag_t, bus_space_handle_t,
177			    bus_size_t, uint32_t, bus_size_t);
178	void		(*bs_sr_8) (bus_space_tag_t, bus_space_handle_t,
179			    bus_size_t, uint64_t, bus_size_t);
180
181	/* copy */
182	void		(*bs_c_1) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
183			    bus_space_handle_t, bus_size_t, bus_size_t);
184	void		(*bs_c_2) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
185			    bus_space_handle_t, bus_size_t, bus_size_t);
186	void		(*bs_c_4) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
187			    bus_space_handle_t, bus_size_t, bus_size_t);
188	void		(*bs_c_8) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
189			    bus_space_handle_t, bus_size_t, bus_size_t);
190
191	/* read stream (single) */
192	uint8_t	(*bs_r_1_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
193	uint16_t	(*bs_r_2_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
194	uint32_t	(*bs_r_4_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
195	uint64_t	(*bs_r_8_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t);
196
197	/* read multiple stream */
198	void		(*bs_rm_1_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
199	    uint8_t *, bus_size_t);
200	void		(*bs_rm_2_s) (bus_space_tag_t, bus_space_handle_t, bus_size_t,
201	    uint16_t *, bus_size_t);
202	void		(*bs_rm_4_s) (bus_space_tag_t, bus_space_handle_t,
203			    bus_size_t, uint32_t *, bus_size_t);
204	void		(*bs_rm_8_s) (bus_space_tag_t, bus_space_handle_t,
205			    bus_size_t, uint64_t *, bus_size_t);
206
207	/* read region stream */
208	void		(*bs_rr_1_s) (bus_space_tag_t, bus_space_handle_t,
209			    bus_size_t, uint8_t *, bus_size_t);
210	void		(*bs_rr_2_s) (bus_space_tag_t, bus_space_handle_t,
211			    bus_size_t, uint16_t *, bus_size_t);
212	void		(*bs_rr_4_s) (bus_space_tag_t, bus_space_handle_t,
213			    bus_size_t, uint32_t *, bus_size_t);
214	void		(*bs_rr_8_s) (bus_space_tag_t, bus_space_handle_t,
215			    bus_size_t, uint64_t *, bus_size_t);
216
217	/* write stream (single) */
218	void		(*bs_w_1_s) (bus_space_tag_t, bus_space_handle_t,
219			    bus_size_t, uint8_t);
220	void		(*bs_w_2_s) (bus_space_tag_t, bus_space_handle_t,
221			    bus_size_t, uint16_t);
222	void		(*bs_w_4_s) (bus_space_tag_t, bus_space_handle_t,
223			    bus_size_t, uint32_t);
224	void		(*bs_w_8_s) (bus_space_tag_t, bus_space_handle_t,
225			    bus_size_t, uint64_t);
226
227	/* write multiple stream */
228	void		(*bs_wm_1_s) (bus_space_tag_t, bus_space_handle_t,
229			    bus_size_t, const uint8_t *, bus_size_t);
230	void		(*bs_wm_2_s) (bus_space_tag_t, bus_space_handle_t,
231			    bus_size_t, const uint16_t *, bus_size_t);
232	void		(*bs_wm_4_s) (bus_space_tag_t, bus_space_handle_t,
233			    bus_size_t, const uint32_t *, bus_size_t);
234	void		(*bs_wm_8_s) (bus_space_tag_t, bus_space_handle_t,
235			    bus_size_t, const uint64_t *, bus_size_t);
236
237	/* write region stream */
238	void		(*bs_wr_1_s) (bus_space_tag_t, bus_space_handle_t,
239			    bus_size_t, const uint8_t *, bus_size_t);
240	void		(*bs_wr_2_s) (bus_space_tag_t, bus_space_handle_t,
241			    bus_size_t, const uint16_t *, bus_size_t);
242	void		(*bs_wr_4_s) (bus_space_tag_t, bus_space_handle_t,
243			    bus_size_t, const uint32_t *, bus_size_t);
244	void		(*bs_wr_8_s) (bus_space_tag_t, bus_space_handle_t,
245			    bus_size_t, const uint64_t *, bus_size_t);
246};
247
248
249/*
250 * Utility macros; INTERNAL USE ONLY.
251 */
252#define	__bs_c(a,b)		__CONCAT(a,b)
253#define	__bs_opname(op,size)	__bs_c(__bs_c(__bs_c(bs_,op),_),size)
254
255#define	__bs_nonsingle(type, sz, t, h, o, a, c)				\
256	(*(t)->__bs_opname(type,sz))((t), h, o, a, c)
257#define	__bs_set(type, sz, t, h, o, v, c)				\
258	(*(t)->__bs_opname(type,sz))((t), h, o, v, c)
259#define	__bs_copy(sz, t, h1, o1, h2, o2, cnt)				\
260	(*(t)->__bs_opname(c,sz))((t), h1, o1, h2, o2, cnt)
261
262#define	__bs_opname_s(op,size)	__bs_c(__bs_c(__bs_c(__bs_c(bs_,op),_),size),_s)
263#define	__bs_rs_s(sz, t, h, o)						\
264	(*(t)->__bs_opname_s(r,sz))((t), h, o)
265#define	__bs_ws_s(sz, t, h, o, v)					\
266	(*(t)->__bs_opname_s(w,sz))((t), h, o, v)
267#define	__bs_nonsingle_s(type, sz, t, h, o, a, c)			\
268	(*(t)->__bs_opname_s(type,sz))((t), h, o, a, c)
269
270
271#define __generate_inline_bs_rs(IFN, MBR, TYP)					\
272	static inline TYP						\
273	IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o)	\
274	{								\
275									\
276		if (__predict_true(t->MBR == NULL))			\
277			return (*(volatile TYP *)(h + o));		\
278		else							\
279			return (t->MBR(t, h, o));		\
280	}
281
282#define __generate_inline_bs_ws(IFN, MBR, TYP)					\
283	static inline void						\
284	IFN(bus_space_tag_t t, bus_space_handle_t h, bus_size_t o, TYP v)\
285	{								\
286									\
287		if (__predict_true(t->MBR == NULL))			\
288			*(volatile TYP *)(h + o) = v;			\
289		else							\
290			t->MBR(t, h, o, v);			\
291	}
292
293/*
294 * Mapping and unmapping operations.
295 */
296#define	bus_space_map(t, a, s, c, hp)					\
297	(*(t)->bs_map)((t), (a), (s), (c), (hp))
298#define	bus_space_unmap(t, h, s)					\
299	(*(t)->bs_unmap)((t), (h), (s))
300#define	bus_space_subregion(t, h, o, s, hp)				\
301	(*(t)->bs_subregion)((t), (h), (o), (s), (hp))
302
303
304/*
305 * Allocation and deallocation operations.
306 */
307#define	bus_space_alloc(t, rs, re, s, a, b, c, ap, hp)			\
308	(*(t)->bs_alloc)((t), (rs), (re), (s), (a), (b),	\
309	    (c), (ap), (hp))
310#define	bus_space_free(t, h, s)						\
311	(*(t)->bs_free)((t), (h), (s))
312
313/*
314 * Bus barrier operations.
315 */
316#define	bus_space_barrier(t, h, o, l, f)				\
317	(*(t)->bs_barrier)((t), (h), (o), (l), (f))
318
319#define	BUS_SPACE_BARRIER_READ	0x01
320#define	BUS_SPACE_BARRIER_WRITE	0x02
321
322/*
323 * Bus read (single) operations.
324 */
325__generate_inline_bs_rs(bus_space_read_1, bs_r_1, uint8_t);
326__generate_inline_bs_rs(bus_space_read_2, bs_r_2, uint16_t);
327__generate_inline_bs_rs(bus_space_read_4, bs_r_4, uint32_t);
328__generate_inline_bs_rs(bus_space_read_8, bs_r_8, uint64_t);
329
330__generate_inline_bs_rs(bus_space_read_stream_1, bs_r_1_s, uint8_t);
331__generate_inline_bs_rs(bus_space_read_stream_2, bs_r_2_s, uint16_t);
332__generate_inline_bs_rs(bus_space_read_stream_4, bs_r_4_s, uint32_t);
333__generate_inline_bs_rs(bus_space_read_stream_8, bs_r_8_s, uint64_t);
334
335/*
336 * Bus read multiple operations.
337 */
338#define	bus_space_read_multi_1(t, h, o, a, c)				\
339	__bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
340#define	bus_space_read_multi_2(t, h, o, a, c)				\
341	__bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
342#define	bus_space_read_multi_4(t, h, o, a, c)				\
343	__bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
344#define	bus_space_read_multi_8(t, h, o, a, c)				\
345	__bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
346
347#define	bus_space_read_multi_stream_1(t, h, o, a, c)			\
348	__bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
349#define	bus_space_read_multi_stream_2(t, h, o, a, c)			\
350	__bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
351#define	bus_space_read_multi_stream_4(t, h, o, a, c)			\
352	__bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
353#define	bus_space_read_multi_stream_8(t, h, o, a, c)			\
354	__bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
355
356
357/*
358 * Bus read region operations.
359 */
360#define	bus_space_read_region_1(t, h, o, a, c)				\
361	__bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
362#define	bus_space_read_region_2(t, h, o, a, c)				\
363	__bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
364#define	bus_space_read_region_4(t, h, o, a, c)				\
365	__bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
366#define	bus_space_read_region_8(t, h, o, a, c)				\
367	__bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
368
369#define	bus_space_read_region_stream_1(t, h, o, a, c)			\
370	__bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
371#define	bus_space_read_region_stream_2(t, h, o, a, c)			\
372	__bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
373#define	bus_space_read_region_stream_4(t, h, o, a, c)			\
374	__bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
375#define	bus_space_read_region_stream_8(t, h, o, a, c)			\
376	__bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
377
378
379/*
380 * Bus write (single) operations.
381 */
382__generate_inline_bs_ws(bus_space_write_1, bs_w_1, uint8_t);
383__generate_inline_bs_ws(bus_space_write_2, bs_w_2, uint16_t);
384__generate_inline_bs_ws(bus_space_write_4, bs_w_4, uint32_t);
385__generate_inline_bs_ws(bus_space_write_8, bs_w_8, uint64_t);
386
387__generate_inline_bs_ws(bus_space_write_stream_1, bs_w_1_s, uint8_t);
388__generate_inline_bs_ws(bus_space_write_stream_2, bs_w_2_s, uint16_t);
389__generate_inline_bs_ws(bus_space_write_stream_4, bs_w_4_s, uint32_t);
390__generate_inline_bs_ws(bus_space_write_stream_8, bs_w_8_s, uint64_t);
391
392
393/*
394 * Bus write multiple operations.
395 */
396#define	bus_space_write_multi_1(t, h, o, a, c)				\
397	__bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
398#define	bus_space_write_multi_2(t, h, o, a, c)				\
399	__bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
400#define	bus_space_write_multi_4(t, h, o, a, c)				\
401	__bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
402#define	bus_space_write_multi_8(t, h, o, a, c)				\
403	__bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
404
405#define	bus_space_write_multi_stream_1(t, h, o, a, c)			\
406	__bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
407#define	bus_space_write_multi_stream_2(t, h, o, a, c)			\
408	__bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
409#define	bus_space_write_multi_stream_4(t, h, o, a, c)			\
410	__bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
411#define	bus_space_write_multi_stream_8(t, h, o, a, c)			\
412	__bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
413
414
415/*
416 * Bus write region operations.
417 */
418#define	bus_space_write_region_1(t, h, o, a, c)				\
419	__bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
420#define	bus_space_write_region_2(t, h, o, a, c)				\
421	__bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
422#define	bus_space_write_region_4(t, h, o, a, c)				\
423	__bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
424#define	bus_space_write_region_8(t, h, o, a, c)				\
425	__bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
426
427#define	bus_space_write_region_stream_1(t, h, o, a, c)			\
428	__bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
429#define	bus_space_write_region_stream_2(t, h, o, a, c)			\
430	__bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
431#define	bus_space_write_region_stream_4(t, h, o, a, c)			\
432	__bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
433#define	bus_space_write_region_stream_8(t, h, o, a, c)			\
434	__bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
435
436
437/*
438 * Set multiple operations.
439 */
440#define	bus_space_set_multi_1(t, h, o, v, c)				\
441	__bs_set(sm,1,(t),(h),(o),(v),(c))
442#define	bus_space_set_multi_2(t, h, o, v, c)				\
443	__bs_set(sm,2,(t),(h),(o),(v),(c))
444#define	bus_space_set_multi_4(t, h, o, v, c)				\
445	__bs_set(sm,4,(t),(h),(o),(v),(c))
446#define	bus_space_set_multi_8(t, h, o, v, c)				\
447	__bs_set(sm,8,(t),(h),(o),(v),(c))
448
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/*
464 * Copy operations.
465 */
466#define	bus_space_copy_region_1(t, h1, o1, h2, o2, c)				\
467	__bs_copy(1, t, h1, o1, h2, o2, c)
468#define	bus_space_copy_region_2(t, h1, o1, h2, o2, c)				\
469	__bs_copy(2, t, h1, o1, h2, o2, c)
470#define	bus_space_copy_region_4(t, h1, o1, h2, o2, c)				\
471	__bs_copy(4, t, h1, o1, h2, o2, c)
472#define	bus_space_copy_region_8(t, h1, o1, h2, o2, c)				\
473	__bs_copy(8, t, h1, o1, h2, o2, c)
474
475/*
476 * Macros to provide prototypes for all the functions used in the
477 * bus_space structure
478 */
479
480#define bs_map_proto(f)							\
481int	__bs_c(f,_bs_map) (bus_space_tag_t t, bus_addr_t addr,		\
482	    bus_size_t size, int cacheable, bus_space_handle_t *bshp);
483
484#define bs_unmap_proto(f)						\
485void	__bs_c(f,_bs_unmap) (bus_space_tag_t t, bus_space_handle_t bsh,		\
486	    bus_size_t size);
487
488#define bs_subregion_proto(f)						\
489int	__bs_c(f,_bs_subregion) (bus_space_tag_t t, bus_space_handle_t bsh,	\
490	    bus_size_t offset, bus_size_t size, 			\
491	    bus_space_handle_t *nbshp);
492
493#define bs_alloc_proto(f)						\
494int	__bs_c(f,_bs_alloc) (bus_space_tag_t t, bus_addr_t rstart,		\
495	    bus_addr_t rend, bus_size_t size, bus_size_t align,		\
496	    bus_size_t boundary, int cacheable, bus_addr_t *addrp,	\
497	    bus_space_handle_t *bshp);
498
499#define bs_free_proto(f)						\
500void	__bs_c(f,_bs_free) (bus_space_tag_t t, bus_space_handle_t bsh,	\
501	    bus_size_t size);
502
503#define bs_mmap_proto(f)						\
504int	__bs_c(f,_bs_mmap) (struct cdev *, vm_offset_t, vm_paddr_t *, int);
505
506#define bs_barrier_proto(f)						\
507void	__bs_c(f,_bs_barrier) (bus_space_tag_t t, bus_space_handle_t bsh,	\
508	    bus_size_t offset, bus_size_t len, int flags);
509
510#define	bs_r_1_proto(f)							\
511uint8_t	__bs_c(f,_bs_r_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
512		    bus_size_t offset);
513
514#define	bs_r_2_proto(f)							\
515uint16_t	__bs_c(f,_bs_r_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
516		    bus_size_t offset);
517
518#define	bs_r_4_proto(f)							\
519uint32_t	__bs_c(f,_bs_r_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
520		    bus_size_t offset);
521
522#define	bs_r_8_proto(f)							\
523uint64_t	__bs_c(f,_bs_r_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
524		    bus_size_t offset);
525
526#define	bs_r_1_s_proto(f)						\
527uint8_t	__bs_c(f,_bs_r_1_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
528		    bus_size_t offset);
529
530#define	bs_r_2_s_proto(f)						\
531uint16_t	__bs_c(f,_bs_r_2_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
532		    bus_size_t offset);
533
534#define	bs_r_4_s_proto(f)						\
535uint32_t	__bs_c(f,_bs_r_4_s) (bus_space_tag_t t, bus_space_handle_t bsh,	\
536		    bus_size_t offset);
537
538#define	bs_w_1_proto(f)							\
539void	__bs_c(f,_bs_w_1) (bus_space_tag_t t, bus_space_handle_t bsh,		\
540	    bus_size_t offset, uint8_t value);
541
542#define	bs_w_2_proto(f)							\
543void	__bs_c(f,_bs_w_2) (bus_space_tag_t t, bus_space_handle_t bsh,		\
544	    bus_size_t offset, uint16_t value);
545
546#define	bs_w_4_proto(f)							\
547void	__bs_c(f,_bs_w_4) (bus_space_tag_t t, bus_space_handle_t bsh,		\
548	    bus_size_t offset, uint32_t value);
549
550#define	bs_w_8_proto(f)							\
551void	__bs_c(f,_bs_w_8) (bus_space_tag_t t, bus_space_handle_t bsh,		\
552	    bus_size_t offset, uint64_t value);
553
554#define	bs_w_1_s_proto(f)						\
555void	__bs_c(f,_bs_w_1_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
556	    bus_size_t offset, uint8_t value);
557
558#define	bs_w_2_s_proto(f)						\
559void	__bs_c(f,_bs_w_2_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
560	    bus_size_t offset, uint16_t value);
561
562#define	bs_w_4_s_proto(f)						\
563void	__bs_c(f,_bs_w_4_s) (bus_space_tag_t t, bus_space_handle_t bsh,		\
564	    bus_size_t offset, uint32_t value);
565
566#define	bs_rm_1_proto(f)						\
567void	__bs_c(f,_bs_rm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
568	    bus_size_t offset, uint8_t *addr, bus_size_t count);
569
570#define	bs_rm_2_proto(f)						\
571void	__bs_c(f,_bs_rm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
572	    bus_size_t offset, uint16_t *addr, bus_size_t count);
573
574#define	bs_rm_4_proto(f)						\
575void	__bs_c(f,_bs_rm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
576	    bus_size_t offset, uint32_t *addr, bus_size_t count);
577
578#define	bs_rm_8_proto(f)						\
579void	__bs_c(f,_bs_rm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
580	    bus_size_t offset, uint64_t *addr, bus_size_t count);
581
582#define	bs_wm_1_proto(f)						\
583void	__bs_c(f,_bs_wm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
584	    bus_size_t offset, const uint8_t *addr, bus_size_t count);
585
586#define	bs_wm_2_proto(f)						\
587void	__bs_c(f,_bs_wm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
588	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
589
590#define	bs_wm_4_proto(f)						\
591void	__bs_c(f,_bs_wm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
592	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
593
594#define	bs_wm_8_proto(f)						\
595void	__bs_c(f,_bs_wm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
596	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
597
598#define	bs_rr_1_proto(f)						\
599void	__bs_c(f, _bs_rr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
600	    bus_size_t offset, uint8_t *addr, bus_size_t count);
601
602#define	bs_rr_2_proto(f)						\
603void	__bs_c(f, _bs_rr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
604	    bus_size_t offset, uint16_t *addr, bus_size_t count);
605
606#define	bs_rr_4_proto(f)						\
607void	__bs_c(f, _bs_rr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
608	    bus_size_t offset, uint32_t *addr, bus_size_t count);
609
610#define	bs_rr_8_proto(f)						\
611void	__bs_c(f, _bs_rr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
612	    bus_size_t offset, uint64_t *addr, bus_size_t count);
613
614#define	bs_wr_1_proto(f)						\
615void	__bs_c(f, _bs_wr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
616	    bus_size_t offset, const uint8_t *addr, bus_size_t count);
617
618#define	bs_wr_2_proto(f)						\
619void	__bs_c(f, _bs_wr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
620	    bus_size_t offset, const uint16_t *addr, bus_size_t count);
621
622#define	bs_wr_4_proto(f)						\
623void	__bs_c(f, _bs_wr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
624	    bus_size_t offset, const uint32_t *addr, bus_size_t count);
625
626#define	bs_wr_8_proto(f)						\
627void	__bs_c(f, _bs_wr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
628	    bus_size_t offset, const uint64_t *addr, bus_size_t count);
629
630#define	bs_sm_1_proto(f)						\
631void	__bs_c(f,_bs_sm_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
632	    bus_size_t offset, uint8_t value, bus_size_t count);
633
634#define	bs_sm_2_proto(f)						\
635void	__bs_c(f,_bs_sm_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
636	    bus_size_t offset, uint16_t value, bus_size_t count);
637
638#define	bs_sm_4_proto(f)						\
639void	__bs_c(f,_bs_sm_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
640	    bus_size_t offset, uint32_t value, bus_size_t count);
641
642#define	bs_sm_8_proto(f)						\
643void	__bs_c(f,_bs_sm_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
644	    bus_size_t offset, uint64_t value, bus_size_t count);
645
646#define	bs_sr_1_proto(f)						\
647void	__bs_c(f,_bs_sr_1) (bus_space_tag_t t, bus_space_handle_t bsh,	\
648	    bus_size_t offset, uint8_t value, bus_size_t count);
649
650#define	bs_sr_2_proto(f)						\
651void	__bs_c(f,_bs_sr_2) (bus_space_tag_t t, bus_space_handle_t bsh,	\
652	    bus_size_t offset, uint16_t value, bus_size_t count);
653
654#define	bs_sr_4_proto(f)						\
655void	__bs_c(f,_bs_sr_4) (bus_space_tag_t t, bus_space_handle_t bsh,	\
656	    bus_size_t offset, uint32_t value, bus_size_t count);
657
658#define	bs_sr_8_proto(f)						\
659void	__bs_c(f,_bs_sr_8) (bus_space_tag_t t, bus_space_handle_t bsh,	\
660	    bus_size_t offset, uint64_t value, bus_size_t count);
661
662#define	bs_c_1_proto(f)							\
663void	__bs_c(f,_bs_c_1) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
664	    bus_size_t offset1, bus_space_handle_t bsh2,		\
665	    bus_size_t offset2, bus_size_t count);
666
667#define	bs_c_2_proto(f)							\
668void	__bs_c(f,_bs_c_2) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
669	    bus_size_t offset1, bus_space_handle_t bsh2,		\
670	    bus_size_t offset2, bus_size_t count);
671
672#define	bs_c_4_proto(f)							\
673void	__bs_c(f,_bs_c_4) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
674	    bus_size_t offset1, bus_space_handle_t bsh2,		\
675	    bus_size_t offset2, bus_size_t count);
676
677#define	bs_c_8_proto(f)							\
678void	__bs_c(f,_bs_c_8) (bus_space_tag_t t, bus_space_handle_t bsh1,	\
679	    bus_size_t offset1, bus_space_handle_t bsh2,		\
680	    bus_size_t offset2, bus_size_t count);
681
682#define bs_protos(f)		\
683bs_map_proto(f);		\
684bs_unmap_proto(f);		\
685bs_subregion_proto(f);		\
686bs_alloc_proto(f);		\
687bs_free_proto(f);		\
688bs_mmap_proto(f);		\
689bs_barrier_proto(f);		\
690bs_r_1_proto(f);		\
691bs_r_2_proto(f);		\
692bs_r_4_proto(f);		\
693bs_r_8_proto(f);		\
694bs_r_1_s_proto(f);		\
695bs_r_2_s_proto(f);		\
696bs_r_4_s_proto(f);		\
697bs_w_1_proto(f);		\
698bs_w_2_proto(f);		\
699bs_w_4_proto(f);		\
700bs_w_8_proto(f);		\
701bs_w_1_s_proto(f);		\
702bs_w_2_s_proto(f);		\
703bs_w_4_s_proto(f);		\
704bs_rm_1_proto(f);		\
705bs_rm_2_proto(f);		\
706bs_rm_4_proto(f);		\
707bs_rm_8_proto(f);		\
708bs_wm_1_proto(f);		\
709bs_wm_2_proto(f);		\
710bs_wm_4_proto(f);		\
711bs_wm_8_proto(f);		\
712bs_rr_1_proto(f);		\
713bs_rr_2_proto(f);		\
714bs_rr_4_proto(f);		\
715bs_rr_8_proto(f);		\
716bs_wr_1_proto(f);		\
717bs_wr_2_proto(f);		\
718bs_wr_4_proto(f);		\
719bs_wr_8_proto(f);		\
720bs_sm_1_proto(f);		\
721bs_sm_2_proto(f);		\
722bs_sm_4_proto(f);		\
723bs_sm_8_proto(f);		\
724bs_sr_1_proto(f);		\
725bs_sr_2_proto(f);		\
726bs_sr_4_proto(f);		\
727bs_sr_8_proto(f);		\
728bs_c_1_proto(f);		\
729bs_c_2_proto(f);		\
730bs_c_4_proto(f);		\
731bs_c_8_proto(f);
732
733#define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
734
735#define BUS_SPACE_MAXADDR_24BIT	0xFFFFFF
736#define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
737#define BUS_SPACE_MAXADDR 	0xFFFFFFFF
738#define BUS_SPACE_MAXSIZE_24BIT	0xFFFFFF
739#define BUS_SPACE_MAXSIZE_32BIT	0xFFFFFFFF
740#define BUS_SPACE_MAXSIZE 	0xFFFFFFFF
741
742#define BUS_SPACE_UNRESTRICTED	(~0)
743
744#include <machine/bus_dma.h>
745
746/*
747 * Get the physical address of a bus space memory-mapped resource.
748 * Doing this as a macro is a temporary solution until a more robust fix is
749 * designed.  It also serves to mark the locations needing that fix.
750 */
751#define BUS_SPACE_PHYSADDR(res, offs) \
752	((u_int)(rman_get_start(res)+(offs)))
753
754#endif /* _MACHINE_BUS_H_ */
755