xref: /netbsd-src/sys/arch/arm/include/bus_defs.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: bus_defs.h,v 1.11 2018/04/01 04:35:04 ryo 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 
64 #ifndef _ARM_BUS_DEFS_H_
65 #define _ARM_BUS_DEFS_H_
66 
67 #if defined(_KERNEL_OPT)
68 #include "opt_arm_bus_space.h"
69 #endif
70 
71 /*
72  * Addresses (in bus space).
73  */
74 typedef u_long bus_addr_t;
75 typedef u_long bus_size_t;
76 
77 #define	PRIxBUSADDR	"lx"
78 #define	PRIxBUSSIZE	"lx"
79 #define	PRIuBUSSIZE	"lu"
80 
81 /*
82  * Access methods for bus space.
83  */
84 typedef struct bus_space *bus_space_tag_t;
85 typedef u_long bus_space_handle_t;
86 
87 #define	PRIxBSH		"lx"
88 
89 /*
90  *	int bus_space_map(bus_space_tag_t t, bus_addr_t addr,
91  *	    bus_size_t size, int flags, bus_space_handle_t *bshp);
92  *
93  * Map a region of bus space.
94  */
95 
96 #define	BUS_SPACE_MAP_CACHEABLE		0x01
97 #define	BUS_SPACE_MAP_LINEAR		0x02
98 #define	BUS_SPACE_MAP_PREFETCHABLE     	0x04
99 
100 struct bus_space {
101 	/* cookie */
102 	void		*bs_cookie;
103 
104 	/* used for aarch64. require ".bs_cookie = bus_space" */
105 	int		bs_stride;	/* offset <<= bs_stride (if needed) */
106 	int		bs_flags;
107 
108 	/* mapping/unmapping */
109 	int		(*bs_map)(void *, bus_addr_t, bus_size_t,
110 			    int, bus_space_handle_t *);
111 	void		(*bs_unmap)(void *, bus_space_handle_t,
112 			    bus_size_t);
113 	int		(*bs_subregion)(void *, bus_space_handle_t,
114 			    bus_size_t, bus_size_t, bus_space_handle_t *);
115 
116 	/* allocation/deallocation */
117 	int		(*bs_alloc)(void *, bus_addr_t, bus_addr_t,
118 			    bus_size_t, bus_size_t, bus_size_t, int,
119 			    bus_addr_t *, bus_space_handle_t *);
120 	void		(*bs_free)(void *, bus_space_handle_t,
121 			    bus_size_t);
122 
123 	/* get kernel virtual address */
124 	void *		(*bs_vaddr)(void *, bus_space_handle_t);
125 
126 	/* mmap bus space for user */
127 	paddr_t		(*bs_mmap)(void *, bus_addr_t, off_t, int, int);
128 
129 	/* barrier */
130 	void		(*bs_barrier)(void *, bus_space_handle_t,
131 			    bus_size_t, bus_size_t, int);
132 
133 	/* read (single) */
134 	uint8_t		(*bs_r_1)(void *, bus_space_handle_t,
135 			    bus_size_t);
136 	uint16_t	(*bs_r_2)(void *, bus_space_handle_t,
137 			    bus_size_t);
138 	uint32_t	(*bs_r_4)(void *, bus_space_handle_t,
139 			    bus_size_t);
140 	uint64_t	(*bs_r_8)(void *, bus_space_handle_t,
141 			    bus_size_t);
142 
143 	/* read multiple */
144 	void		(*bs_rm_1)(void *, bus_space_handle_t,
145 			    bus_size_t, uint8_t *, bus_size_t);
146 	void		(*bs_rm_2)(void *, bus_space_handle_t,
147 			    bus_size_t, uint16_t *, bus_size_t);
148 	void		(*bs_rm_4)(void *, bus_space_handle_t,
149 			    bus_size_t, uint32_t *, bus_size_t);
150 	void		(*bs_rm_8)(void *, bus_space_handle_t,
151 			    bus_size_t, uint64_t *, bus_size_t);
152 
153 	/* read region */
154 	void		(*bs_rr_1)(void *, bus_space_handle_t,
155 			    bus_size_t, uint8_t *, bus_size_t);
156 	void		(*bs_rr_2)(void *, bus_space_handle_t,
157 			    bus_size_t, uint16_t *, bus_size_t);
158 	void		(*bs_rr_4)(void *, bus_space_handle_t,
159 			    bus_size_t, uint32_t *, bus_size_t);
160 	void		(*bs_rr_8)(void *, bus_space_handle_t,
161 			    bus_size_t, uint64_t *, bus_size_t);
162 
163 	/* write (single) */
164 	void		(*bs_w_1)(void *, bus_space_handle_t,
165 			    bus_size_t, uint8_t);
166 	void		(*bs_w_2)(void *, bus_space_handle_t,
167 			    bus_size_t, uint16_t);
168 	void		(*bs_w_4)(void *, bus_space_handle_t,
169 			    bus_size_t, uint32_t);
170 	void		(*bs_w_8)(void *, bus_space_handle_t,
171 			    bus_size_t, uint64_t);
172 
173 	/* write multiple */
174 	void		(*bs_wm_1)(void *, bus_space_handle_t,
175 			    bus_size_t, const uint8_t *, bus_size_t);
176 	void		(*bs_wm_2)(void *, bus_space_handle_t,
177 			    bus_size_t, const uint16_t *, bus_size_t);
178 	void		(*bs_wm_4)(void *, bus_space_handle_t,
179 			    bus_size_t, const uint32_t *, bus_size_t);
180 	void		(*bs_wm_8)(void *, bus_space_handle_t,
181 			    bus_size_t, const uint64_t *, bus_size_t);
182 
183 	/* write region */
184 	void		(*bs_wr_1)(void *, bus_space_handle_t,
185 			    bus_size_t, const uint8_t *, bus_size_t);
186 	void		(*bs_wr_2)(void *, bus_space_handle_t,
187 			    bus_size_t, const uint16_t *, bus_size_t);
188 	void		(*bs_wr_4)(void *, bus_space_handle_t,
189 			    bus_size_t, const uint32_t *, bus_size_t);
190 	void		(*bs_wr_8)(void *, bus_space_handle_t,
191 			    bus_size_t, const uint64_t *, bus_size_t);
192 
193 	/* set multiple */
194 	void		(*bs_sm_1)(void *, bus_space_handle_t,
195 			    bus_size_t, uint8_t, bus_size_t);
196 	void		(*bs_sm_2)(void *, bus_space_handle_t,
197 			    bus_size_t, uint16_t, bus_size_t);
198 	void		(*bs_sm_4)(void *, bus_space_handle_t,
199 			    bus_size_t, uint32_t, bus_size_t);
200 	void		(*bs_sm_8)(void *, bus_space_handle_t,
201 			    bus_size_t, uint64_t, bus_size_t);
202 
203 	/* set region */
204 	void		(*bs_sr_1)(void *, bus_space_handle_t,
205 			    bus_size_t, uint8_t, bus_size_t);
206 	void		(*bs_sr_2)(void *, bus_space_handle_t,
207 			    bus_size_t, uint16_t, bus_size_t);
208 	void		(*bs_sr_4)(void *, bus_space_handle_t,
209 			    bus_size_t, uint32_t, bus_size_t);
210 	void		(*bs_sr_8)(void *, bus_space_handle_t,
211 			    bus_size_t, uint64_t, bus_size_t);
212 
213 	/* copy */
214 	void		(*bs_c_1)(void *, bus_space_handle_t, bus_size_t,
215 			    bus_space_handle_t, bus_size_t, bus_size_t);
216 	void		(*bs_c_2)(void *, bus_space_handle_t, bus_size_t,
217 			    bus_space_handle_t, bus_size_t, bus_size_t);
218 	void		(*bs_c_4)(void *, bus_space_handle_t, bus_size_t,
219 			    bus_space_handle_t, bus_size_t, bus_size_t);
220 	void		(*bs_c_8)(void *, bus_space_handle_t, bus_size_t,
221 			    bus_space_handle_t, bus_size_t, bus_size_t);
222 
223 #ifdef __BUS_SPACE_HAS_STREAM_METHODS
224 	/* read stream (single) */
225 	uint8_t		(*bs_r_1_s)(void *, bus_space_handle_t,
226 			    bus_size_t);
227 	uint16_t	(*bs_r_2_s)(void *, bus_space_handle_t,
228 			    bus_size_t);
229 	uint32_t	(*bs_r_4_s)(void *, bus_space_handle_t,
230 			    bus_size_t);
231 	uint64_t	(*bs_r_8_s)(void *, bus_space_handle_t,
232 			    bus_size_t);
233 
234 	/* read multiple stream */
235 	void		(*bs_rm_1_s)(void *, bus_space_handle_t,
236 			    bus_size_t, uint8_t *, bus_size_t);
237 	void		(*bs_rm_2_s)(void *, bus_space_handle_t,
238 			    bus_size_t, uint16_t *, bus_size_t);
239 	void		(*bs_rm_4_s)(void *, bus_space_handle_t,
240 			    bus_size_t, uint32_t *, bus_size_t);
241 	void		(*bs_rm_8_s)(void *, bus_space_handle_t,
242 			    bus_size_t, uint64_t *, bus_size_t);
243 
244 	/* read region stream */
245 	void		(*bs_rr_1_s)(void *, bus_space_handle_t,
246 			    bus_size_t, uint8_t *, bus_size_t);
247 	void		(*bs_rr_2_s)(void *, bus_space_handle_t,
248 			    bus_size_t, uint16_t *, bus_size_t);
249 	void		(*bs_rr_4_s)(void *, bus_space_handle_t,
250 			    bus_size_t, uint32_t *, bus_size_t);
251 	void		(*bs_rr_8_s)(void *, bus_space_handle_t,
252 			    bus_size_t, uint64_t *, bus_size_t);
253 
254 	/* write stream (single) */
255 	void		(*bs_w_1_s)(void *, bus_space_handle_t,
256 			    bus_size_t, uint8_t);
257 	void		(*bs_w_2_s)(void *, bus_space_handle_t,
258 			    bus_size_t, uint16_t);
259 	void		(*bs_w_4_s)(void *, bus_space_handle_t,
260 			    bus_size_t, uint32_t);
261 	void		(*bs_w_8_s)(void *, bus_space_handle_t,
262 			    bus_size_t, uint64_t);
263 
264 	/* write multiple stream */
265 	void		(*bs_wm_1_s)(void *, bus_space_handle_t,
266 			    bus_size_t, const uint8_t *, bus_size_t);
267 	void		(*bs_wm_2_s)(void *, bus_space_handle_t,
268 			    bus_size_t, const uint16_t *, bus_size_t);
269 	void		(*bs_wm_4_s)(void *, bus_space_handle_t,
270 			    bus_size_t, const uint32_t *, bus_size_t);
271 	void		(*bs_wm_8_s)(void *, bus_space_handle_t,
272 			    bus_size_t, const uint64_t *, bus_size_t);
273 
274 	/* write region stream */
275 	void		(*bs_wr_1_s)(void *, bus_space_handle_t,
276 			    bus_size_t, const uint8_t *, bus_size_t);
277 	void		(*bs_wr_2_s)(void *, bus_space_handle_t,
278 			    bus_size_t, const uint16_t *, bus_size_t);
279 	void		(*bs_wr_4_s)(void *, bus_space_handle_t,
280 			    bus_size_t, const uint32_t *, bus_size_t);
281 	void		(*bs_wr_8_s)(void *, bus_space_handle_t,
282 			    bus_size_t, const uint64_t *, bus_size_t);
283 #endif	/* __BUS_SPACE_HAS_STREAM_METHODS */
284 
285 #ifdef __BUS_SPACE_HAS_PROBING_METHODS
286 	/* peek */
287 	int		(*bs_pe_1)(void *, bus_space_handle_t,
288 			    bus_size_t, uint8_t *);
289 	int		(*bs_pe_2)(void *, bus_space_handle_t,
290 			    bus_size_t, uint16_t *);
291 	int		(*bs_pe_4)(void *, bus_space_handle_t,
292 			    bus_size_t, uint32_t *);
293 	int		(*bs_pe_8)(void *, bus_space_handle_t,
294 			    bus_size_t, uint64_t *);
295 
296 	/* poke */
297 	int		(*bs_po_1)(void *, bus_space_handle_t,
298 			    bus_size_t, uint8_t);
299 	int		(*bs_po_2)(void *, bus_space_handle_t,
300 			    bus_size_t, uint16_t);
301 	int		(*bs_po_4)(void *, bus_space_handle_t,
302 			    bus_size_t, uint32_t);
303 	int		(*bs_po_8)(void *, bus_space_handle_t,
304 			    bus_size_t, uint64_t);
305 #endif /* __BUS_SPACE_HAS_PROBING_METHODS */
306 };
307 
308 #define	BUS_SPACE_BARRIER_READ	0x01
309 #define	BUS_SPACE_BARRIER_WRITE	0x02
310 
311 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
312 
313 /* Bus Space DMA macros */
314 
315 /*
316  * Flags used in various bus DMA methods.
317  */
318 #define	BUS_DMA_WAITOK		0x000	/* safe to sleep (pseudo-flag) */
319 #define	BUS_DMA_NOWAIT		0x001	/* not safe to sleep */
320 #define	BUS_DMA_ALLOCNOW	0x002	/* perform resource allocation now */
321 #define	BUS_DMA_COHERENT	0x004	/* hint: map memory DMA coherent */
322 #define	BUS_DMA_STREAMING	0x008	/* hint: sequential, unidirectional */
323 #define	BUS_DMA_BUS1		0x010	/* placeholders for bus functions... */
324 #define	BUS_DMA_BUS2		0x020
325 #define	BUS_DMA_BUS3		0x040
326 #define	BUS_DMA_BUS4		0x080
327 #define	BUS_DMA_READ		0x100	/* mapping is device -> memory only */
328 #define	BUS_DMA_WRITE		0x200	/* mapping is memory -> device only */
329 #define	BUS_DMA_NOCACHE		0x400	/* hint: map non-cached memory */
330 
331 /*
332  * Private flags stored in the DMA map.
333  */
334 #define	_BUS_DMAMAP_COHERENT	0x10000	/* no cache flush necessary on sync */
335 #define	_BUS_DMAMAP_IS_BOUNCING	0x20000 /* is bouncing current xfer */
336 #define	_BUS_DMAMAP_NOALLOC	0x40000	/* don't alloc memory from this range */
337 
338 /* Forwards needed by prototypes below. */
339 struct mbuf;
340 struct uio;
341 
342 /*
343  * Operations performed by bus_dmamap_sync().
344  */
345 #define	BUS_DMASYNC_PREREAD	0x01	/* pre-read synchronization */
346 #define	BUS_DMASYNC_POSTREAD	0x02	/* post-read synchronization */
347 #define	BUS_DMASYNC_PREWRITE	0x04	/* pre-write synchronization */
348 #define	BUS_DMASYNC_POSTWRITE	0x08	/* post-write synchronization */
349 
350 typedef struct arm32_bus_dma_tag	*bus_dma_tag_t;
351 typedef struct arm32_bus_dmamap		*bus_dmamap_t;
352 
353 #define BUS_DMA_TAG_VALID(t)    ((t) != (bus_dma_tag_t)0)
354 
355 /*
356  *	bus_dma_segment_t
357  *
358  *	Describes a single contiguous DMA transaction.  Values
359  *	are suitable for programming into DMA registers.
360  */
361 struct arm32_bus_dma_segment {
362 	/*
363 	 * PUBLIC MEMBERS: these are used by machine-independent code.
364 	 */
365 	bus_addr_t	ds_addr;	/* DMA address */
366 	bus_size_t	ds_len;		/* length of transfer */
367 
368 	/*
369 	 * PRIVATE MEMBERS:
370 	 */
371 	uint32_t	_ds_flags;	/* _BUS_DMAMAP_COHERENT */
372 };
373 typedef struct arm32_bus_dma_segment	bus_dma_segment_t;
374 
375 /*
376  *	arm32_dma_range
377  *
378  *	This structure describes a valid DMA range.
379  */
380 struct arm32_dma_range {
381 	bus_addr_t	dr_sysbase;	/* system base address */
382 	bus_addr_t	dr_busbase;	/* appears here on bus */
383 	bus_size_t	dr_len;		/* length of range */
384 	uint32_t	dr_flags;	/* flags for range */
385 };
386 
387 /*
388  *	bus_dma_tag_t
389  *
390  *	A machine-dependent opaque type describing the implementation of
391  *	DMA for a given bus.
392  */
393 
394 struct arm32_bus_dma_tag {
395 	/*
396 	 * DMA range for this tag.  If the page doesn't fall within
397 	 * one of these ranges, an error is returned.  The caller
398 	 * may then decide what to do with the transfer.  If the
399 	 * range pointer is NULL, it is ignored.
400 	 */
401 	struct arm32_dma_range *_ranges;
402 	int _nranges;
403 
404 	/*
405 	 * Opaque cookie for use by back-end.
406 	 */
407 	void *_cookie;
408 
409 	/*
410 	 * DMA mapping methods.
411 	 */
412 	int	(*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
413 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
414 	void	(*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
415 	int	(*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
416 		    bus_size_t, struct proc *, int);
417 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
418 		    struct mbuf *, int);
419 	int	(*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
420 		    struct uio *, int);
421 	int	(*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
422 		    bus_dma_segment_t *, int, bus_size_t, int);
423 	void	(*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
424 	void	(*_dmamap_sync_pre)(bus_dma_tag_t, bus_dmamap_t,
425 		    bus_addr_t, bus_size_t, int);
426 	void	(*_dmamap_sync_post)(bus_dma_tag_t, bus_dmamap_t,
427 		    bus_addr_t, bus_size_t, int);
428 
429 	/*
430 	 * DMA memory utility functions.
431 	 */
432 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
433 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
434 	void	(*_dmamem_free)(bus_dma_tag_t,
435 		    bus_dma_segment_t *, int);
436 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
437 		    int, size_t, void **, int);
438 	void	(*_dmamem_unmap)(bus_dma_tag_t, void *, size_t);
439 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
440 		    int, off_t, int, int);
441 
442 	/*
443 	 * DMA tag utility functions
444 	 */
445 	int	(*_dmatag_subregion)(bus_dma_tag_t, bus_addr_t, bus_addr_t,
446 		     bus_dma_tag_t *, int);
447 	void	(*_dmatag_destroy)(bus_dma_tag_t);
448 
449 	/*
450 	 * State for bounce buffers
451 	 */
452 	int	_tag_needs_free;
453 	int	(*_may_bounce)(bus_dma_tag_t, bus_dmamap_t, int, int *);
454 };
455 
456 /*
457  *	bus_dmamap_t
458  *
459  *	Describes a DMA mapping.
460  */
461 struct arm32_bus_dmamap {
462 	/*
463 	 * PRIVATE MEMBERS: not for use by machine-independent code.
464 	 */
465 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
466 	int		_dm_segcnt;	/* number of segs this map can map */
467 	bus_size_t	_dm_maxmaxsegsz; /* fixed largest possible segment */
468 	bus_size_t	_dm_boundary;	/* don't cross this */
469 	int		_dm_flags;	/* misc. flags */
470 
471 	void		*_dm_origbuf;	/* pointer to original buffer */
472 	int		_dm_buftype;	/* type of buffer */
473 	struct vmspace	*_dm_vmspace;	/* vmspace that owns the mapping */
474 
475 	void		*_dm_cookie;	/* cookie for bus-specific functions */
476 
477 	/*
478 	 * PUBLIC MEMBERS: these are used by machine-independent code.
479 	 */
480 	bus_size_t	dm_maxsegsz;	/* largest possible segment */
481 	bus_size_t	dm_mapsize;	/* size of the mapping */
482 	int		dm_nsegs;	/* # valid segments in mapping */
483 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
484 };
485 
486 /* _dm_buftype */
487 #define	_BUS_DMA_BUFTYPE_INVALID	0
488 #define	_BUS_DMA_BUFTYPE_LINEAR		1
489 #define	_BUS_DMA_BUFTYPE_MBUF		2
490 #define	_BUS_DMA_BUFTYPE_UIO		3
491 #define	_BUS_DMA_BUFTYPE_RAW		4
492 
493 #ifdef _ARM32_BUS_DMA_PRIVATE
494 #define	_BUS_AVAIL_END	physical_end
495 /*
496  * Cookie used for bounce buffers. A pointer to one of these it stashed in
497  * the DMA map.
498  */
499 struct arm32_bus_dma_cookie {
500 	int	id_flags;		/* flags; see below */
501 
502 	/*
503 	 * Information about the original buffer used during
504 	 * DMA map syncs.  Note that origibuflen is only used
505 	 * for ID_BUFTYPE_LINEAR.
506 	 */
507 	union {
508 		void	*un_origbuf;		/* pointer to orig buffer if
509 						   bouncing */
510 		char	*un_linearbuf;
511 		struct mbuf	*un_mbuf;
512 		struct uio	*un_uio;
513 	} id_origbuf_un;
514 #define	id_origbuf		id_origbuf_un.un_origbuf
515 #define	id_origlinearbuf	id_origbuf_un.un_linearbuf
516 #define	id_origmbuf		id_origbuf_un.un_mbuf
517 #define	id_origuio		id_origbuf_un.un_uio
518 	bus_size_t id_origbuflen;	/* ...and size */
519 
520 	void	*id_bouncebuf;		/* pointer to the bounce buffer */
521 	bus_size_t id_bouncebuflen;	/* ...and size */
522 	int	id_nbouncesegs;		/* number of valid bounce segs */
523 	bus_dma_segment_t id_bouncesegs[0]; /* array of bounce buffer
524 					       physical memory segments */
525 };
526 
527 /* id_flags */
528 #define	_BUS_DMA_IS_BOUNCING		0x04	/* is bouncing current xfer */
529 #define	_BUS_DMA_HAS_BOUNCE		0x02	/* has bounce buffers */
530 #endif /* _ARM32_BUS_DMA_PRIVATE */
531 #define	_BUS_DMA_MIGHT_NEED_BOUNCE	0x01	/* may need bounce buffers */
532 
533 #endif /* _ARM_BUS_DEFS_H_ */
534