2 * Copyright (c) 1997, 1998 Justin T. Gibbs.
3 * Copyright (c) 2013, 2015 The FreeBSD Foundation
6 * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
7 * under sponsorship from the FreeBSD Foundation.
9 * Portions of this software were developed by Semihalf
10 * under sponsorship of the FreeBSD Foundation.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification, immediately at the beginning of the file.
18 * 2. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/malloc.h>
41 #include <sys/kernel.h>
44 #include <sys/memdesc.h>
45 #include <sys/mutex.h>
48 #include <vm/vm_extern.h>
51 #include <machine/bus.h>
52 #include <arm64/include/bus_dma_impl.h>
55 * Convenience function for manipulating driver locks from busdma (during
56 * busdma_swi, for example). Drivers that don't provide their own locks
57 * should specify &Giant to dmat->lockfuncarg. Drivers that use their own
58 * non-mutex locking scheme don't have to use this at all.
61 busdma_lock_mutex(void *arg, bus_dma_lock_op_t op)
65 dmtx = (struct mtx *)arg;
74 panic("Unknown operation 0x%x for busdma_lock_mutex!", op);
79 * dflt_lock should never get called. It gets put into the dma tag when
80 * lockfunc == NULL, which is only valid if the maps that are associated
81 * with the tag are meant to never be defered.
82 * XXX Should have a way to identify which driver is responsible here.
85 bus_dma_dflt_lock(void *arg, bus_dma_lock_op_t op)
88 panic("driver error: busdma dflt_lock called");
92 * Return true if a match is made.
94 * To find a match walk the chain of bus_dma_tag_t's looking for 'paddr'.
96 * If paddr is within the bounds of the dma tag then call the filter callback
97 * to check for a match, if there is no filter callback then assume a match.
100 bus_dma_run_filter(struct bus_dma_tag_common *tc, bus_addr_t paddr)
106 if (((paddr > tc->lowaddr && paddr <= tc->highaddr) ||
107 ((paddr & (tc->alignment - 1)) != 0)) &&
108 (tc->filter == NULL ||
109 (*tc->filter)(tc->filterarg, paddr) != 0))
113 } while (retval == 0 && tc != NULL);
118 common_bus_dma_tag_create(struct bus_dma_tag_common *parent,
119 bus_size_t alignment, bus_addr_t boundary, bus_addr_t lowaddr,
120 bus_addr_t highaddr, bus_dma_filter_t *filter, void *filterarg,
121 bus_size_t maxsize, int nsegments, bus_size_t maxsegsz, int flags,
122 bus_dma_lock_t *lockfunc, void *lockfuncarg, size_t sz, void **dmat)
125 struct bus_dma_tag_common *common;
127 KASSERT(sz >= sizeof(struct bus_dma_tag_common), ("sz"));
128 /* Return a NULL tag on failure */
130 /* Basic sanity checking */
131 if (boundary != 0 && boundary < maxsegsz)
136 newtag = malloc(sz, M_DEVBUF, M_ZERO | M_NOWAIT);
137 if (newtag == NULL) {
138 CTR4(KTR_BUSDMA, "%s returned tag %p tag flags 0x%x error %d",
139 __func__, newtag, 0, ENOMEM);
144 common->impl = &bus_dma_bounce_impl;
145 common->parent = parent;
146 common->alignment = alignment;
147 common->boundary = boundary;
148 common->lowaddr = trunc_page((vm_paddr_t)lowaddr) + (PAGE_SIZE - 1);
149 common->highaddr = trunc_page((vm_paddr_t)highaddr) + (PAGE_SIZE - 1);
150 common->filter = filter;
151 common->filterarg = filterarg;
152 common->maxsize = maxsize;
153 common->nsegments = nsegments;
154 common->maxsegsz = maxsegsz;
155 common->flags = flags;
156 common->ref_count = 1; /* Count ourself */
157 if (lockfunc != NULL) {
158 common->lockfunc = lockfunc;
159 common->lockfuncarg = lockfuncarg;
161 common->lockfunc = bus_dma_dflt_lock;
162 common->lockfuncarg = NULL;
165 /* Take into account any restrictions imposed by our parent tag */
166 if (parent != NULL) {
167 common->impl = parent->impl;
168 common->lowaddr = MIN(parent->lowaddr, common->lowaddr);
169 common->highaddr = MAX(parent->highaddr, common->highaddr);
170 if (common->boundary == 0)
171 common->boundary = parent->boundary;
172 else if (parent->boundary != 0) {
173 common->boundary = MIN(parent->boundary,
176 if (common->filter == NULL) {
178 * Short circuit looking at our parent directly
179 * since we have encapsulated all of its information
181 common->filter = parent->filter;
182 common->filterarg = parent->filterarg;
183 common->parent = parent->parent;
185 atomic_add_int(&parent->ref_count, 1);
192 * Allocate a device specific dma_tag.
195 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
196 bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
197 bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
198 int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
199 void *lockfuncarg, bus_dma_tag_t *dmat)
201 struct bus_dma_tag_common *tc;
204 if (parent == NULL) {
205 error = bus_dma_bounce_impl.tag_create(parent, alignment,
206 boundary, lowaddr, highaddr, filter, filterarg, maxsize,
207 nsegments, maxsegsz, flags, lockfunc, lockfuncarg, dmat);
209 tc = (struct bus_dma_tag_common *)parent;
210 error = tc->impl->tag_create(parent, alignment,
211 boundary, lowaddr, highaddr, filter, filterarg, maxsize,
212 nsegments, maxsegsz, flags, lockfunc, lockfuncarg, dmat);
218 bus_dma_tag_destroy(bus_dma_tag_t dmat)
220 struct bus_dma_tag_common *tc;
222 tc = (struct bus_dma_tag_common *)dmat;
223 return (tc->impl->tag_destroy(dmat));
227 bus_dma_tag_set_domain(bus_dma_tag_t dmat, int domain)