xref: /netbsd-src/sys/sys/bus_proto.h (revision cef8759bd76c1b621f8eab8faa6f208faabc2e15)
1 /*	$NetBSD: bus_proto.h,v 1.11 2019/11/14 16:23:53 maxv Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997, 1998, 2001, 2007 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, and by Andrew Doran.
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 
64 #ifndef _SYS_BUS_PROTO_H_
65 #define _SYS_BUS_PROTO_H_
66 
67 #ifdef _KERNEL_OPT
68 #include "opt_kasan.h"
69 #include "opt_kcsan.h"
70 #include "opt_kmsan.h"
71 #endif
72 
73 /*
74  * Forwards needed by prototypes below.
75  */
76 struct mbuf;
77 struct uio;
78 
79 /*
80  * bus_space(9)
81  */
82 
83 /* Map types. */
84 #define	BUS_SPACE_MAP_CACHEABLE		0x01
85 #define	BUS_SPACE_MAP_LINEAR		0x02
86 #define	BUS_SPACE_MAP_PREFETCHABLE	0x04
87 
88 /* Bus read/write barrier methods. */
89 #define	BUS_SPACE_BARRIER_READ	0x01		/* force read barrier */
90 #define	BUS_SPACE_BARRIER_WRITE	0x02		/* force write barrier */
91 
92 int	bus_space_map(bus_space_tag_t, bus_addr_t, bus_size_t, int,
93 		      bus_space_handle_t *);
94 
95 void	bus_space_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t);
96 
97 int	bus_space_subregion(bus_space_tag_t, bus_space_handle_t,
98 			    bus_size_t, bus_size_t, bus_space_handle_t *);
99 
100 int	bus_space_alloc(bus_space_tag_t, bus_addr_t, bus_addr_t,
101 			bus_size_t, bus_size_t, bus_size_t,
102 			int, bus_addr_t *, bus_space_handle_t *);
103 
104 void	bus_space_free(bus_space_tag_t, bus_space_handle_t, bus_size_t);
105 
106 paddr_t	bus_space_mmap(bus_space_tag_t, bus_addr_t, off_t, int, int);
107 
108 void	*bus_space_vaddr(bus_space_tag_t, bus_space_handle_t);
109 
110 void	bus_space_barrier(bus_space_tag_t tag, bus_space_handle_t bsh,
111 			  bus_size_t offset, bus_size_t len, int flags);
112 
113 /*
114  * bus_space(9) accessors
115  */
116 
117 uint8_t	bus_space_read_1(bus_space_tag_t, bus_space_handle_t,
118 			 bus_size_t);
119 uint8_t	bus_space_read_stream_1(bus_space_tag_t, bus_space_handle_t,
120 				bus_size_t);
121 
122 uint16_t bus_space_read_2(bus_space_tag_t, bus_space_handle_t,
123 			  bus_size_t);
124 uint16_t bus_space_read_stream_2(bus_space_tag_t, bus_space_handle_t,
125 				 bus_size_t);
126 
127 uint32_t bus_space_read_4(bus_space_tag_t, bus_space_handle_t,
128 			  bus_size_t);
129 uint32_t bus_space_read_stream_4(bus_space_tag_t, bus_space_handle_t,
130 				 bus_size_t);
131 
132 uint64_t bus_space_read_8(bus_space_tag_t, bus_space_handle_t,
133 			  bus_size_t);
134 uint64_t bus_space_read_stream_8(bus_space_tag_t, bus_space_handle_t,
135 				 bus_size_t);
136 
137 #if defined(KASAN) && defined(__HAVE_KASAN_INSTR_BUS)
138 #define BUS_SPACE_READ_MEM_PROTOS(bytes, bits)					\
139 void kasan_bus_space_read_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
140     bus_size_t, uint##bits##_t *, bus_size_t);					\
141 void kasan_bus_space_read_multi_stream_##bytes(bus_space_tag_t,			\
142     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);		\
143 void kasan_bus_space_read_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
144     bus_size_t, uint##bits##_t *, bus_size_t);					\
145 void kasan_bus_space_read_region_stream_##bytes(bus_space_tag_t,		\
146     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);
147 #define bus_space_read_multi_1 kasan_bus_space_read_multi_1
148 #define bus_space_read_multi_2 kasan_bus_space_read_multi_2
149 #define bus_space_read_multi_4 kasan_bus_space_read_multi_4
150 #define bus_space_read_multi_8 kasan_bus_space_read_multi_8
151 #define bus_space_read_multi_stream_1 kasan_bus_space_read_multi_stream_1
152 #define bus_space_read_multi_stream_2 kasan_bus_space_read_multi_stream_2
153 #define bus_space_read_multi_stream_4 kasan_bus_space_read_multi_stream_4
154 #define bus_space_read_multi_stream_8 kasan_bus_space_read_multi_stream_8
155 #define bus_space_read_region_1 kasan_bus_space_read_region_1
156 #define bus_space_read_region_2 kasan_bus_space_read_region_2
157 #define bus_space_read_region_4 kasan_bus_space_read_region_4
158 #define bus_space_read_region_8 kasan_bus_space_read_region_8
159 #define bus_space_read_region_stream_1 kasan_bus_space_read_region_stream_1
160 #define bus_space_read_region_stream_2 kasan_bus_space_read_region_stream_2
161 #define bus_space_read_region_stream_4 kasan_bus_space_read_region_stream_4
162 #define bus_space_read_region_stream_8 kasan_bus_space_read_region_stream_8
163 #elif defined(KCSAN)
164 #define BUS_SPACE_READ_MEM_PROTOS(bytes, bits)					\
165 void kcsan_bus_space_read_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
166     bus_size_t, uint##bits##_t *, bus_size_t);					\
167 void kcsan_bus_space_read_multi_stream_##bytes(bus_space_tag_t,			\
168     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);		\
169 void kcsan_bus_space_read_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
170     bus_size_t, uint##bits##_t *, bus_size_t);					\
171 void kcsan_bus_space_read_region_stream_##bytes(bus_space_tag_t,		\
172     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);
173 #define bus_space_read_multi_1 kcsan_bus_space_read_multi_1
174 #define bus_space_read_multi_2 kcsan_bus_space_read_multi_2
175 #define bus_space_read_multi_4 kcsan_bus_space_read_multi_4
176 #define bus_space_read_multi_8 kcsan_bus_space_read_multi_8
177 #define bus_space_read_multi_stream_1 kcsan_bus_space_read_multi_stream_1
178 #define bus_space_read_multi_stream_2 kcsan_bus_space_read_multi_stream_2
179 #define bus_space_read_multi_stream_4 kcsan_bus_space_read_multi_stream_4
180 #define bus_space_read_multi_stream_8 kcsan_bus_space_read_multi_stream_8
181 #define bus_space_read_region_1 kcsan_bus_space_read_region_1
182 #define bus_space_read_region_2 kcsan_bus_space_read_region_2
183 #define bus_space_read_region_4 kcsan_bus_space_read_region_4
184 #define bus_space_read_region_8 kcsan_bus_space_read_region_8
185 #define bus_space_read_region_stream_1 kcsan_bus_space_read_region_stream_1
186 #define bus_space_read_region_stream_2 kcsan_bus_space_read_region_stream_2
187 #define bus_space_read_region_stream_4 kcsan_bus_space_read_region_stream_4
188 #define bus_space_read_region_stream_8 kcsan_bus_space_read_region_stream_8
189 #elif defined(KMSAN)
190 #define BUS_SPACE_READ_MEM_PROTOS(bytes, bits)					\
191 void kmsan_bus_space_read_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
192     bus_size_t, uint##bits##_t *, bus_size_t);					\
193 void kmsan_bus_space_read_multi_stream_##bytes(bus_space_tag_t,			\
194     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);		\
195 void kmsan_bus_space_read_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
196     bus_size_t, uint##bits##_t *, bus_size_t);					\
197 void kmsan_bus_space_read_region_stream_##bytes(bus_space_tag_t,		\
198     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);
199 #define bus_space_read_multi_1 kmsan_bus_space_read_multi_1
200 #define bus_space_read_multi_2 kmsan_bus_space_read_multi_2
201 #define bus_space_read_multi_4 kmsan_bus_space_read_multi_4
202 #define bus_space_read_multi_8 kmsan_bus_space_read_multi_8
203 #define bus_space_read_multi_stream_1 kmsan_bus_space_read_multi_stream_1
204 #define bus_space_read_multi_stream_2 kmsan_bus_space_read_multi_stream_2
205 #define bus_space_read_multi_stream_4 kmsan_bus_space_read_multi_stream_4
206 #define bus_space_read_multi_stream_8 kmsan_bus_space_read_multi_stream_8
207 #define bus_space_read_region_1 kmsan_bus_space_read_region_1
208 #define bus_space_read_region_2 kmsan_bus_space_read_region_2
209 #define bus_space_read_region_4 kmsan_bus_space_read_region_4
210 #define bus_space_read_region_8 kmsan_bus_space_read_region_8
211 #define bus_space_read_region_stream_1 kmsan_bus_space_read_region_stream_1
212 #define bus_space_read_region_stream_2 kmsan_bus_space_read_region_stream_2
213 #define bus_space_read_region_stream_4 kmsan_bus_space_read_region_stream_4
214 #define bus_space_read_region_stream_8 kmsan_bus_space_read_region_stream_8
215 #else
216 #define BUS_SPACE_READ_MEM_PROTOS(bytes, bits)				\
217 void bus_space_read_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
218     bus_size_t, uint##bits##_t *, bus_size_t);				\
219 void bus_space_read_multi_stream_##bytes(bus_space_tag_t,		\
220     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);	\
221 void bus_space_read_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
222     bus_size_t, uint##bits##_t *, bus_size_t);				\
223 void bus_space_read_region_stream_##bytes(bus_space_tag_t,		\
224     bus_space_handle_t, bus_size_t, uint##bits##_t *, bus_size_t);
225 #endif
226 
227 BUS_SPACE_READ_MEM_PROTOS(1, 8)
228 BUS_SPACE_READ_MEM_PROTOS(2, 16)
229 BUS_SPACE_READ_MEM_PROTOS(4, 32)
230 BUS_SPACE_READ_MEM_PROTOS(8, 64)
231 
232 void	bus_space_write_1(bus_space_tag_t, bus_space_handle_t,
233 			  bus_size_t, uint8_t);
234 void	bus_space_write_stream_1(bus_space_tag_t, bus_space_handle_t,
235 				 bus_size_t, uint8_t);
236 
237 void	bus_space_write_2(bus_space_tag_t, bus_space_handle_t,
238 			  bus_size_t, uint16_t);
239 void	bus_space_write_stream_2(bus_space_tag_t, bus_space_handle_t,
240 		  		 bus_size_t, uint16_t);
241 
242 void	bus_space_write_4(bus_space_tag_t, bus_space_handle_t,
243 			  bus_size_t, uint32_t);
244 void	bus_space_write_stream_4(bus_space_tag_t, bus_space_handle_t,
245 		  		 bus_size_t, uint32_t);
246 
247 void	bus_space_write_8(bus_space_tag_t, bus_space_handle_t,
248 			  bus_size_t, uint64_t);
249 void	bus_space_write_stream_8(bus_space_tag_t, bus_space_handle_t,
250 		  		 bus_size_t, uint64_t);
251 
252 #if defined(KASAN) && defined(__HAVE_KASAN_INSTR_BUS)
253 #define BUS_SPACE_WRITE_MEM_PROTOS(bytes, bits)					\
254 void kasan_bus_space_write_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
255     bus_size_t, const uint##bits##_t *, bus_size_t);				\
256 void kasan_bus_space_write_multi_stream_##bytes(bus_space_tag_t,		\
257     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);	\
258 void kasan_bus_space_write_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
259     bus_size_t, const uint##bits##_t *, bus_size_t);				\
260 void kasan_bus_space_write_region_stream_##bytes(bus_space_tag_t,		\
261     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);
262 #define bus_space_write_multi_1 kasan_bus_space_write_multi_1
263 #define bus_space_write_multi_2 kasan_bus_space_write_multi_2
264 #define bus_space_write_multi_4 kasan_bus_space_write_multi_4
265 #define bus_space_write_multi_8 kasan_bus_space_write_multi_8
266 #define bus_space_write_multi_stream_1 kasan_bus_space_write_multi_stream_1
267 #define bus_space_write_multi_stream_2 kasan_bus_space_write_multi_stream_2
268 #define bus_space_write_multi_stream_4 kasan_bus_space_write_multi_stream_4
269 #define bus_space_write_multi_stream_8 kasan_bus_space_write_multi_stream_8
270 #define bus_space_write_region_1 kasan_bus_space_write_region_1
271 #define bus_space_write_region_2 kasan_bus_space_write_region_2
272 #define bus_space_write_region_4 kasan_bus_space_write_region_4
273 #define bus_space_write_region_8 kasan_bus_space_write_region_8
274 #define bus_space_write_region_stream_1 kasan_bus_space_write_region_stream_1
275 #define bus_space_write_region_stream_2 kasan_bus_space_write_region_stream_2
276 #define bus_space_write_region_stream_4 kasan_bus_space_write_region_stream_4
277 #define bus_space_write_region_stream_8 kasan_bus_space_write_region_stream_8
278 #elif defined(KCSAN)
279 #define BUS_SPACE_WRITE_MEM_PROTOS(bytes, bits)					\
280 void kcsan_bus_space_write_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
281     bus_size_t, const uint##bits##_t *, bus_size_t);				\
282 void kcsan_bus_space_write_multi_stream_##bytes(bus_space_tag_t,		\
283     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);	\
284 void kcsan_bus_space_write_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
285     bus_size_t, const uint##bits##_t *, bus_size_t);				\
286 void kcsan_bus_space_write_region_stream_##bytes(bus_space_tag_t,		\
287     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);
288 #define bus_space_write_multi_1 kcsan_bus_space_write_multi_1
289 #define bus_space_write_multi_2 kcsan_bus_space_write_multi_2
290 #define bus_space_write_multi_4 kcsan_bus_space_write_multi_4
291 #define bus_space_write_multi_8 kcsan_bus_space_write_multi_8
292 #define bus_space_write_multi_stream_1 kcsan_bus_space_write_multi_stream_1
293 #define bus_space_write_multi_stream_2 kcsan_bus_space_write_multi_stream_2
294 #define bus_space_write_multi_stream_4 kcsan_bus_space_write_multi_stream_4
295 #define bus_space_write_multi_stream_8 kcsan_bus_space_write_multi_stream_8
296 #define bus_space_write_region_1 kcsan_bus_space_write_region_1
297 #define bus_space_write_region_2 kcsan_bus_space_write_region_2
298 #define bus_space_write_region_4 kcsan_bus_space_write_region_4
299 #define bus_space_write_region_8 kcsan_bus_space_write_region_8
300 #define bus_space_write_region_stream_1 kcsan_bus_space_write_region_stream_1
301 #define bus_space_write_region_stream_2 kcsan_bus_space_write_region_stream_2
302 #define bus_space_write_region_stream_4 kcsan_bus_space_write_region_stream_4
303 #define bus_space_write_region_stream_8 kcsan_bus_space_write_region_stream_8
304 #elif defined(KMSAN)
305 #define BUS_SPACE_WRITE_MEM_PROTOS(bytes, bits)					\
306 void kmsan_bus_space_write_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
307     bus_size_t, const uint##bits##_t *, bus_size_t);				\
308 void kmsan_bus_space_write_multi_stream_##bytes(bus_space_tag_t,		\
309     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);	\
310 void kmsan_bus_space_write_region_##bytes(bus_space_tag_t, bus_space_handle_t,	\
311     bus_size_t, const uint##bits##_t *, bus_size_t);				\
312 void kmsan_bus_space_write_region_stream_##bytes(bus_space_tag_t,		\
313     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);
314 #define bus_space_write_multi_1 kmsan_bus_space_write_multi_1
315 #define bus_space_write_multi_2 kmsan_bus_space_write_multi_2
316 #define bus_space_write_multi_4 kmsan_bus_space_write_multi_4
317 #define bus_space_write_multi_8 kmsan_bus_space_write_multi_8
318 #define bus_space_write_multi_stream_1 kmsan_bus_space_write_multi_stream_1
319 #define bus_space_write_multi_stream_2 kmsan_bus_space_write_multi_stream_2
320 #define bus_space_write_multi_stream_4 kmsan_bus_space_write_multi_stream_4
321 #define bus_space_write_multi_stream_8 kmsan_bus_space_write_multi_stream_8
322 #define bus_space_write_region_1 kmsan_bus_space_write_region_1
323 #define bus_space_write_region_2 kmsan_bus_space_write_region_2
324 #define bus_space_write_region_4 kmsan_bus_space_write_region_4
325 #define bus_space_write_region_8 kmsan_bus_space_write_region_8
326 #define bus_space_write_region_stream_1 kmsan_bus_space_write_region_stream_1
327 #define bus_space_write_region_stream_2 kmsan_bus_space_write_region_stream_2
328 #define bus_space_write_region_stream_4 kmsan_bus_space_write_region_stream_4
329 #define bus_space_write_region_stream_8 kmsan_bus_space_write_region_stream_8
330 #else
331 #define BUS_SPACE_WRITE_MEM_PROTOS(bytes, bits)				\
332 void bus_space_write_multi_##bytes(bus_space_tag_t, bus_space_handle_t,	\
333     bus_size_t, const uint##bits##_t *, bus_size_t);			\
334 void bus_space_write_multi_stream_##bytes(bus_space_tag_t,		\
335     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);\
336 void bus_space_write_region_##bytes(bus_space_tag_t, bus_space_handle_t,\
337     bus_size_t, const uint##bits##_t *, bus_size_t);			\
338 void bus_space_write_region_stream_##bytes(bus_space_tag_t,		\
339     bus_space_handle_t, bus_size_t, const uint##bits##_t *, bus_size_t);
340 #endif
341 
342 BUS_SPACE_WRITE_MEM_PROTOS(1, 8)
343 BUS_SPACE_WRITE_MEM_PROTOS(2, 16)
344 BUS_SPACE_WRITE_MEM_PROTOS(4, 32)
345 BUS_SPACE_WRITE_MEM_PROTOS(8, 64)
346 
347 void	bus_space_set_multi_1(bus_space_tag_t, bus_space_handle_t,
348 			      bus_size_t, u_int8_t, bus_size_t);
349 void	bus_space_set_multi_2(bus_space_tag_t, bus_space_handle_t,
350 			      bus_size_t, u_int16_t, bus_size_t);
351 void	bus_space_set_multi_4(bus_space_tag_t, bus_space_handle_t,
352 			      bus_size_t, u_int32_t, bus_size_t);
353 void	bus_space_set_multi_8(bus_space_tag_t, bus_space_handle_t,
354 			      bus_size_t, u_int64_t, bus_size_t);
355 
356 void	bus_space_set_multi_stream_1(bus_space_tag_t, bus_space_handle_t,
357 			      bus_size_t, u_int8_t, bus_size_t);
358 void	bus_space_set_multi_stream_2(bus_space_tag_t, bus_space_handle_t,
359 			      bus_size_t, u_int16_t, bus_size_t);
360 void	bus_space_set_multi_stream_4(bus_space_tag_t, bus_space_handle_t,
361 			      bus_size_t, u_int32_t, bus_size_t);
362 void	bus_space_set_multi_stream_8(bus_space_tag_t, bus_space_handle_t,
363 			      bus_size_t, u_int64_t, bus_size_t);
364 
365 void	bus_space_set_region_1(bus_space_tag_t, bus_space_handle_t,
366 			       bus_size_t, u_int8_t, bus_size_t);
367 void	bus_space_set_region_2(bus_space_tag_t, bus_space_handle_t,
368 			       bus_size_t, u_int16_t, bus_size_t);
369 void	bus_space_set_region_4(bus_space_tag_t, bus_space_handle_t,
370 			       bus_size_t, u_int32_t, bus_size_t);
371 void	bus_space_set_region_8(bus_space_tag_t, bus_space_handle_t,
372 			       bus_size_t, u_int64_t, bus_size_t);
373 
374 void	bus_space_set_region_stream_1(bus_space_tag_t, bus_space_handle_t,
375 			       bus_size_t, u_int8_t, bus_size_t);
376 void	bus_space_set_region_stream_2(bus_space_tag_t, bus_space_handle_t,
377 			       bus_size_t, u_int16_t, bus_size_t);
378 void	bus_space_set_region_stream_4(bus_space_tag_t, bus_space_handle_t,
379 			       bus_size_t, u_int32_t, bus_size_t);
380 void	bus_space_set_region_stream_8(bus_space_tag_t, bus_space_handle_t,
381 			       bus_size_t, u_int64_t, bus_size_t);
382 
383 void	bus_space_copy_region_1(bus_space_tag_t, bus_space_handle_t,
384 				bus_size_t, bus_space_handle_t,
385 				bus_size_t, bus_size_t);
386 void	bus_space_copy_region_2(bus_space_tag_t, bus_space_handle_t,
387 				bus_size_t, bus_space_handle_t,
388 				bus_size_t, bus_size_t);
389 void	bus_space_copy_region_4(bus_space_tag_t, bus_space_handle_t,
390 				bus_size_t, bus_space_handle_t,
391 				bus_size_t, bus_size_t);
392 void	bus_space_copy_region_8(bus_space_tag_t, bus_space_handle_t,
393 				bus_size_t, bus_space_handle_t,
394 				bus_size_t, bus_size_t);
395 
396 void	bus_space_copy_region_stream_1(bus_space_tag_t, bus_space_handle_t,
397 				bus_size_t, bus_space_handle_t,
398 				bus_size_t, bus_size_t);
399 void	bus_space_copy_region_stream_2(bus_space_tag_t, bus_space_handle_t,
400 				bus_size_t, bus_space_handle_t,
401 				bus_size_t, bus_size_t);
402 void	bus_space_copy_region_stream_4(bus_space_tag_t, bus_space_handle_t,
403 				bus_size_t, bus_space_handle_t,
404 				bus_size_t, bus_size_t);
405 void	bus_space_copy_region_stream_8(bus_space_tag_t, bus_space_handle_t,
406 				bus_size_t, bus_space_handle_t,
407 				bus_size_t, bus_size_t);
408 
409 bool	bus_space_is_equal(bus_space_tag_t, bus_space_tag_t);
410 bool	bus_space_handle_is_equal(bus_space_tag_t, bus_space_handle_t,
411     bus_space_handle_t);
412 
413 /*
414  * bus_dma(9)
415  */
416 
417 /* Flags used in various bus DMA methods. */
418 #define	BUS_DMA_WAITOK		0x000	/* safe to sleep (pseudo-flag) */
419 #define	BUS_DMA_NOWAIT		0x001	/* not safe to sleep */
420 #define	BUS_DMA_ALLOCNOW	0x002	/* perform resource allocation now */
421 #define	BUS_DMA_COHERENT	0x004	/* hint: map memory DMA coherent */
422 #define	BUS_DMA_STREAMING	0x008	/* hint: sequential, unidirectional */
423 #define	BUS_DMA_BUS1		0x010	/* placeholders for bus functions... */
424 #define	BUS_DMA_BUS2		0x020
425 #define	BUS_DMA_BUS3		0x040
426 #define	BUS_DMA_BUS4		0x080
427 #define	BUS_DMA_READ		0x100	/* mapping is device -> memory only */
428 #define	BUS_DMA_WRITE		0x200	/* mapping is memory -> device only */
429 #define	BUS_DMA_NOCACHE		0x400	/* hint: map non-cached memory */
430 #define	BUS_DMA_PREFETCHABLE	0x800	/* hint: map non-cached but allow
431 					 * things like write combining */
432 
433 /* Operations performed by bus_dmamap_sync(). */
434 #define	BUS_DMASYNC_PREREAD	0x01	/* pre-read synchronization */
435 #define	BUS_DMASYNC_POSTREAD	0x02	/* post-read synchronization */
436 #define	BUS_DMASYNC_PREWRITE	0x04	/* pre-write synchronization */
437 #define	BUS_DMASYNC_POSTWRITE	0x08	/* post-write synchronization */
438 
439 int	bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t,
440 			  bus_size_t, int, bus_dmamap_t *);
441 void	bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
442 int	bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, bus_size_t,
443 			struct proc *, int);
444 int	bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t,
445 			     struct mbuf *, int);
446 int	bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t,
447 			    struct uio *, int);
448 int	bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
449 			    bus_dma_segment_t *, int, bus_size_t, int);
450 void	bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
451 void	bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
452 			bus_size_t, int);
453 
454 int	bus_dmamem_alloc(bus_dma_tag_t, bus_size_t, bus_size_t,
455 			 bus_size_t, bus_dma_segment_t *,
456 			 int, int *, int);
457 void	bus_dmamem_free(bus_dma_tag_t, bus_dma_segment_t *, int);
458 int	bus_dmamem_map(bus_dma_tag_t, bus_dma_segment_t *, int,
459 		       size_t, void **, int);
460 void	bus_dmamem_unmap(bus_dma_tag_t, void *, size_t);
461 paddr_t	bus_dmamem_mmap(bus_dma_tag_t, bus_dma_segment_t *, int,
462 			off_t, int, int);
463 
464 int	bus_dmatag_subregion(bus_dma_tag_t, bus_addr_t, bus_addr_t,
465 			     bus_dma_tag_t *, int);
466 void	bus_dmatag_destroy(bus_dma_tag_t);
467 
468 #endif	/* _SYS_BUS_PROTO_H_ */
469