1 /* $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $ */
4 * Copyright (c) 1996, 1997 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.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
41 * Copyright (c) 1996 Charles M. Hannum. All rights reserved.
42 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by Christopher G. Demetriou
55 * for the NetBSD Project.
56 * 4. The name of the author may not be used to endorse or promote products
57 * derived from this software without specific prior written permission
59 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
60 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
61 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
62 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
63 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
64 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
65 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
66 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
67 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
68 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
75 #include <sys/_bus_dma.h>
78 * Machine independent interface for mapping physical addresses to peripheral
79 * bus 'physical' addresses, and assisting with DMA operations.
81 * XXX This file is always included from <machine/bus_dma.h> and should not
82 * (yet) be included directly.
86 * Flags used in various bus DMA methods.
88 #define BUS_DMA_WAITOK 0x00 /* safe to sleep (pseudo-flag) */
89 #define BUS_DMA_NOWAIT 0x01 /* not safe to sleep */
90 #define BUS_DMA_ALLOCNOW 0x02 /* perform resource allocation now */
91 #define BUS_DMA_COHERENT 0x04 /* hint: map memory in a coherent way */
92 #define BUS_DMA_ZERO 0x08 /* allocate zero'ed memory */
93 #define BUS_DMA_BUS1 0x10 /* placeholders for bus functions... */
94 #define BUS_DMA_BUS2 0x20
95 #define BUS_DMA_BUS3 0x40
96 #define BUS_DMA_BUS4 0x80
99 * The following two flags are non-standard or specific to only certain
102 #define BUS_DMA_NOWRITE 0x100
103 #define BUS_DMA_NOCACHE 0x200
106 * The following flag is a DMA tag hint that the page offset of the
107 * loaded kernel virtual address must be preserved in the first
108 * physical segment address, when the KVA is loaded into DMA.
110 #define BUS_DMA_KEEP_PG_OFFSET 0x400
112 /* Forwards needed by prototypes below. */
117 * Operations performed by bus_dmamap_sync().
119 #define BUS_DMASYNC_PREREAD 1
120 #define BUS_DMASYNC_POSTREAD 2
121 #define BUS_DMASYNC_PREWRITE 4
122 #define BUS_DMASYNC_POSTWRITE 8
127 * Describes a single contiguous DMA transaction. Values
128 * are suitable for programming into DMA registers.
130 typedef struct bus_dma_segment {
131 bus_addr_t ds_addr; /* DMA address */
132 bus_size_t ds_len; /* length of transfer */
136 * A function that returns 1 if the address cannot be accessed by
137 * a device and 0 if it can be.
139 typedef int bus_dma_filter_t(void *, bus_addr_t);
142 * Generic helper function for manipulating mutexes.
144 void busdma_lock_mutex(void *arg, bus_dma_lock_op_t op);
147 * Allocate a device specific dma_tag encapsulating the constraints of
148 * the parent tag in addition to other restrictions specified:
150 * alignment: Alignment for segments.
151 * boundary: Boundary that segments cannot cross.
152 * lowaddr: Low restricted address that cannot appear in a mapping.
153 * highaddr: High restricted address that cannot appear in a mapping.
154 * filtfunc: An optional function to further test if an address
155 * within the range of lowaddr and highaddr cannot appear
157 * filtfuncarg: An argument that will be passed to filtfunc in addition
158 * to the address to test.
159 * maxsize: Maximum mapping size supported by this tag.
160 * nsegments: Number of discontinuities allowed in maps.
161 * maxsegsz: Maximum size of a segment in the map.
162 * flags: Bus DMA flags.
163 * lockfunc: An optional function to handle driver-defined lock
165 * lockfuncarg: An argument that will be passed to lockfunc in addition
166 * to the lock operation.
167 * dmat: A pointer to set to a valid dma tag should the return
168 * value of this function indicate success.
170 /* XXX Should probably allow specification of alignment */
171 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
172 bus_size_t boundary, bus_addr_t lowaddr,
173 bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
174 void *filtfuncarg, bus_size_t maxsize, int nsegments,
175 bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
176 void *lockfuncarg, bus_dma_tag_t *dmat);
178 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
181 * A function that processes a successfully loaded dma map or an error
182 * from a delayed load map.
184 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
187 * Like bus_dmamap_callback but includes map size in bytes. This is
188 * defined as a separate interface to maintain compatibility for users
189 * of bus_dmamap_callback_t--at some point these interfaces should be merged.
191 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
194 * XXX sparc64 uses the same interface, but a much different implementation.
195 * <machine/bus_dma.h> for the sparc64 arch contains the equivalent
198 #if !defined(__sparc64__)
201 * Allocate a handle for mapping from kva/uva/physical
202 * address space into bus device space.
204 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
207 * Destroy a handle for mapping from kva/uva/physical
208 * address space into bus device space.
210 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
213 * Allocate a piece of memory that can be efficiently mapped into
214 * bus device space based on the constraints listed in the dma tag.
215 * A dmamap to for use with dmamap_load is also allocated.
217 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
221 * Free a piece of memory and its allocated dmamap, that was allocated
222 * via bus_dmamem_alloc.
224 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
227 * Map the buffer buf into bus space using the dmamap map.
229 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
230 bus_size_t buflen, bus_dmamap_callback_t *callback,
231 void *callback_arg, int flags);
234 * Like bus_dmamap_load but for mbufs. Note the use of the
235 * bus_dmamap_callback2_t interface.
237 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
239 bus_dmamap_callback2_t *callback, void *callback_arg,
242 int bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
243 struct mbuf *mbuf, bus_dma_segment_t *segs,
244 int *nsegs, int flags);
247 * Like bus_dmamap_load but for uios. Note the use of the
248 * bus_dmamap_callback2_t interface.
250 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
252 bus_dmamap_callback2_t *callback, void *callback_arg,
256 * Perform a synchronization operation on the given map.
258 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
259 #define bus_dmamap_sync(dmat, dmamap, op) \
261 if ((dmamap) != NULL) \
262 _bus_dmamap_sync(dmat, dmamap, op); \
266 * Release the mapping held by map.
268 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
269 #define bus_dmamap_unload(dmat, dmamap) \
271 if ((dmamap) != NULL) \
272 _bus_dmamap_unload(dmat, dmamap); \
275 #endif /* __sparc64__ */
277 #endif /* _BUS_DMA_H_ */