2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/domainset.h>
35 #include <sys/malloc.h>
37 #include <sys/interrupt.h>
38 #include <sys/kernel.h>
42 #include <sys/memdesc.h>
43 #include <sys/mutex.h>
44 #include <sys/sysctl.h>
48 #include <vm/vm_extern.h>
49 #include <vm/vm_kern.h>
50 #include <vm/vm_page.h>
51 #include <vm/vm_map.h>
53 #include <machine/atomic.h>
54 #include <machine/bus.h>
55 #include <machine/md_var.h>
56 #include <machine/specialreg.h>
57 #include <x86/include/busdma_impl.h>
60 #define MAX_BPAGES (Maxmem > atop(0x100000000ULL) ? 8192 : 512)
62 #define MAX_BPAGES 8192
66 BUS_DMA_COULD_BOUNCE = 0x01,
67 BUS_DMA_MIN_ALLOC_COMP = 0x02,
68 BUS_DMA_KMEM_ALLOC = 0x04,
74 struct bus_dma_tag_common common;
77 bus_dma_segment_t *segments;
78 struct bounce_zone *bounce_zone;
82 vm_offset_t vaddr; /* kva of bounce buffer */
83 bus_addr_t busaddr; /* Physical address */
84 vm_offset_t datavaddr; /* kva of client data */
85 vm_offset_t dataoffs; /* page offset of client data */
86 vm_page_t datapage[2]; /* physical page(s) of client data */
87 bus_size_t datacount; /* client data count */
88 STAILQ_ENTRY(bounce_page) links;
92 STAILQ_ENTRY(bounce_zone) links;
93 STAILQ_HEAD(bp_list, bounce_page) bounce_page_list;
102 bus_size_t alignment;
106 struct sysctl_ctx_list sysctl_tree;
107 struct sysctl_oid *sysctl_tree_top;
110 static struct mtx bounce_lock;
111 static int total_bpages;
112 static int busdma_zonecount;
113 static STAILQ_HEAD(, bounce_zone) bounce_zone_list;
114 static void *busdma_ih;
116 static SYSCTL_NODE(_hw, OID_AUTO, busdma, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
117 "Busdma parameters");
118 SYSCTL_INT(_hw_busdma, OID_AUTO, total_bpages, CTLFLAG_RD, &total_bpages, 0,
119 "Total bounce pages");
122 struct bp_list bpages;
127 bus_dmamap_callback_t *callback;
129 STAILQ_ENTRY(bus_dmamap) links;
132 static STAILQ_HEAD(, bus_dmamap) bounce_map_waitinglist;
133 static STAILQ_HEAD(, bus_dmamap) bounce_map_callbacklist;
134 static struct bus_dmamap nobounce_dmamap;
136 static void init_bounce_pages(void *dummy);
137 static int alloc_bounce_zone(bus_dma_tag_t dmat);
138 static int alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages);
139 static int reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map,
141 static bus_addr_t add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map,
142 vm_offset_t vaddr, vm_paddr_t addr1, vm_paddr_t addr2, bus_size_t size);
143 static void free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage);
144 static bool _bus_dmamap_pagesneeded(bus_dma_tag_t dmat, vm_paddr_t buf,
145 bus_size_t buflen, int *pagesneeded);
146 static void _bus_dmamap_count_pages(bus_dma_tag_t dmat, bus_dmamap_t map,
147 pmap_t pmap, void *buf, bus_size_t buflen, int flags);
148 static void _bus_dmamap_count_phys(bus_dma_tag_t dmat, bus_dmamap_t map,
149 vm_paddr_t buf, bus_size_t buflen, int flags);
150 static int _bus_dmamap_reserve_pages(bus_dma_tag_t dmat, bus_dmamap_t map,
154 bounce_bus_dma_zone_setup(bus_dma_tag_t dmat)
156 struct bounce_zone *bz;
160 if ((error = alloc_bounce_zone(dmat)) != 0)
162 bz = dmat->bounce_zone;
164 if (ptoa(bz->total_bpages) < dmat->common.maxsize) {
167 pages = atop(dmat->common.maxsize) - bz->total_bpages;
169 /* Add pages to our bounce pool */
170 if (alloc_bounce_pages(dmat, pages) < pages)
173 /* Performed initial allocation */
174 dmat->bounce_flags |= BUS_DMA_MIN_ALLOC_COMP;
180 * Allocate a device specific dma_tag.
183 bounce_bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
184 bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
185 bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
186 int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
187 void *lockfuncarg, bus_dma_tag_t *dmat)
189 bus_dma_tag_t newtag;
193 error = common_bus_dma_tag_create(parent != NULL ? &parent->common :
194 NULL, alignment, boundary, lowaddr, highaddr, filter, filterarg,
195 maxsize, nsegments, maxsegsz, flags, lockfunc, lockfuncarg,
196 sizeof (struct bus_dma_tag), (void **)&newtag);
200 newtag->common.impl = &bus_dma_bounce_impl;
201 newtag->map_count = 0;
202 newtag->segments = NULL;
204 if (parent != NULL && (newtag->common.filter != NULL ||
205 (parent->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0))
206 newtag->bounce_flags |= BUS_DMA_COULD_BOUNCE;
208 if (newtag->common.lowaddr < ptoa((vm_paddr_t)Maxmem) ||
209 newtag->common.alignment > 1)
210 newtag->bounce_flags |= BUS_DMA_COULD_BOUNCE;
212 if ((newtag->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0 &&
213 (flags & BUS_DMA_ALLOCNOW) != 0)
214 error = bounce_bus_dma_zone_setup(newtag);
219 free(newtag, M_DEVBUF);
222 CTR4(KTR_BUSDMA, "%s returned tag %p tag flags 0x%x error %d",
223 __func__, newtag, (newtag != NULL ? newtag->common.flags : 0),
229 bounce_bus_dma_id_mapped(bus_dma_tag_t dmat, vm_paddr_t buf, bus_size_t buflen)
232 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) == 0)
234 return (!_bus_dmamap_pagesneeded(dmat, buf, buflen, NULL));
238 * Update the domain for the tag. We may need to reallocate the zone and
242 bounce_bus_dma_tag_set_domain(bus_dma_tag_t dmat)
245 KASSERT(dmat->map_count == 0,
246 ("bounce_bus_dma_tag_set_domain: Domain set after use.\n"));
247 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) == 0 ||
248 dmat->bounce_zone == NULL)
250 dmat->bounce_flags &= ~BUS_DMA_MIN_ALLOC_COMP;
251 return (bounce_bus_dma_zone_setup(dmat));
255 bounce_bus_dma_tag_destroy(bus_dma_tag_t dmat)
257 bus_dma_tag_t dmat_copy, parent;
264 if (dmat->map_count != 0) {
268 while (dmat != NULL) {
269 parent = (bus_dma_tag_t)dmat->common.parent;
270 atomic_subtract_int(&dmat->common.ref_count, 1);
271 if (dmat->common.ref_count == 0) {
272 if (dmat->segments != NULL)
273 free(dmat->segments, M_DEVBUF);
274 free(dmat, M_DEVBUF);
276 * Last reference count, so
277 * release our reference
278 * count on our parent.
286 CTR3(KTR_BUSDMA, "%s tag %p error %d", __func__, dmat_copy, error);
291 * Allocate a handle for mapping from kva/uva/physical
292 * address space into bus device space.
295 bounce_bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
297 struct bounce_zone *bz;
298 int error, maxpages, pages;
302 if (dmat->segments == NULL) {
303 dmat->segments = (bus_dma_segment_t *)malloc_domainset(
304 sizeof(bus_dma_segment_t) * dmat->common.nsegments,
305 M_DEVBUF, DOMAINSET_PREF(dmat->common.domain), M_NOWAIT);
306 if (dmat->segments == NULL) {
307 CTR3(KTR_BUSDMA, "%s: tag %p error %d",
308 __func__, dmat, ENOMEM);
314 * Bouncing might be required if the driver asks for an active
315 * exclusion region, a data alignment that is stricter than 1, and/or
316 * an active address boundary.
318 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0) {
320 if (dmat->bounce_zone == NULL) {
321 if ((error = alloc_bounce_zone(dmat)) != 0)
324 bz = dmat->bounce_zone;
326 *mapp = (bus_dmamap_t)malloc_domainset(sizeof(**mapp), M_DEVBUF,
327 DOMAINSET_PREF(dmat->common.domain), M_NOWAIT | M_ZERO);
329 CTR3(KTR_BUSDMA, "%s: tag %p error %d",
330 __func__, dmat, ENOMEM);
334 /* Initialize the new map */
335 STAILQ_INIT(&((*mapp)->bpages));
338 * Attempt to add pages to our pool on a per-instance
339 * basis up to a sane limit.
341 if (dmat->common.alignment > 1)
342 maxpages = MAX_BPAGES;
344 maxpages = MIN(MAX_BPAGES, Maxmem -
345 atop(dmat->common.lowaddr));
346 if ((dmat->bounce_flags & BUS_DMA_MIN_ALLOC_COMP) == 0 ||
347 (bz->map_count > 0 && bz->total_bpages < maxpages)) {
348 pages = MAX(atop(dmat->common.maxsize), 1);
349 pages = MIN(maxpages - bz->total_bpages, pages);
350 pages = MAX(pages, 1);
351 if (alloc_bounce_pages(dmat, pages) < pages)
353 if ((dmat->bounce_flags & BUS_DMA_MIN_ALLOC_COMP)
356 dmat->bounce_flags |=
357 BUS_DMA_MIN_ALLOC_COMP;
368 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
369 __func__, dmat, dmat->common.flags, error);
374 * Destroy a handle for mapping from kva/uva/physical
375 * address space into bus device space.
378 bounce_bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
381 if (map != NULL && map != &nobounce_dmamap) {
382 if (STAILQ_FIRST(&map->bpages) != NULL) {
383 CTR3(KTR_BUSDMA, "%s: tag %p error %d",
384 __func__, dmat, EBUSY);
387 if (dmat->bounce_zone)
388 dmat->bounce_zone->map_count--;
392 CTR2(KTR_BUSDMA, "%s: tag %p error 0", __func__, dmat);
397 * Allocate a piece of memory that can be efficiently mapped into
398 * bus device space based on the constraints lited in the dma tag.
399 * A dmamap to for use with dmamap_load is also allocated.
402 bounce_bus_dmamem_alloc(bus_dma_tag_t dmat, void **vaddr, int flags,
408 if (flags & BUS_DMA_NOWAIT)
413 /* If we succeed, no mapping/bouncing will be required */
416 if (dmat->segments == NULL) {
417 dmat->segments = (bus_dma_segment_t *)malloc_domainset(
418 sizeof(bus_dma_segment_t) * dmat->common.nsegments,
419 M_DEVBUF, DOMAINSET_PREF(dmat->common.domain), mflags);
420 if (dmat->segments == NULL) {
421 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
422 __func__, dmat, dmat->common.flags, ENOMEM);
426 if (flags & BUS_DMA_ZERO)
428 if (flags & BUS_DMA_NOCACHE)
429 attr = VM_MEMATTR_UNCACHEABLE;
431 attr = VM_MEMATTR_DEFAULT;
434 * Allocate the buffer from the malloc(9) allocator if...
435 * - It's small enough to fit into a single page.
436 * - Its alignment requirement is also smaller than the page size.
437 * - The low address requirement is fulfilled.
438 * - Default cache attributes are requested (WB).
439 * else allocate non-contiguous pages if...
440 * - The page count that could get allocated doesn't exceed
441 * nsegments also when the maximum segment size is less
443 * - The alignment constraint isn't larger than a page boundary.
444 * - There are no boundary-crossing constraints.
445 * else allocate a block of contiguous pages because one or more of the
446 * constraints is something that only the contig allocator can fulfill.
448 * Warn the user if malloc gets it wrong.
450 if (dmat->common.maxsize <= PAGE_SIZE &&
451 dmat->common.alignment <= PAGE_SIZE &&
452 dmat->common.lowaddr >= ptoa((vm_paddr_t)Maxmem) &&
453 attr == VM_MEMATTR_DEFAULT) {
454 *vaddr = malloc_domainset_aligned(dmat->common.maxsize,
455 dmat->common.alignment, M_DEVBUF,
456 DOMAINSET_PREF(dmat->common.domain), mflags);
457 KASSERT(*vaddr == NULL || ((uintptr_t)*vaddr & PAGE_MASK) +
458 dmat->common.maxsize <= PAGE_SIZE,
459 ("bounce_bus_dmamem_alloc: multi-page alloc %p maxsize "
460 "%#jx align %#jx", *vaddr, (uintmax_t)dmat->common.maxsize,
461 (uintmax_t)dmat->common.alignment));
462 } else if (dmat->common.nsegments >=
463 howmany(dmat->common.maxsize, MIN(dmat->common.maxsegsz,
465 dmat->common.alignment <= PAGE_SIZE &&
466 (dmat->common.boundary % PAGE_SIZE) == 0) {
467 /* Page-based multi-segment allocations allowed */
468 *vaddr = (void *)kmem_alloc_attr_domainset(
469 DOMAINSET_PREF(dmat->common.domain), dmat->common.maxsize,
470 mflags, 0ul, dmat->common.lowaddr, attr);
471 dmat->bounce_flags |= BUS_DMA_KMEM_ALLOC;
473 *vaddr = (void *)kmem_alloc_contig_domainset(
474 DOMAINSET_PREF(dmat->common.domain), dmat->common.maxsize,
475 mflags, 0ul, dmat->common.lowaddr,
476 dmat->common.alignment != 0 ? dmat->common.alignment : 1ul,
477 dmat->common.boundary, attr);
478 dmat->bounce_flags |= BUS_DMA_KMEM_ALLOC;
480 if (*vaddr == NULL) {
481 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
482 __func__, dmat, dmat->common.flags, ENOMEM);
484 } else if (!vm_addr_align_ok(vtophys(*vaddr), dmat->common.alignment)) {
485 printf("bus_dmamem_alloc failed to align memory properly.\n");
487 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
488 __func__, dmat, dmat->common.flags, 0);
493 * Free a piece of memory and its associated dmamap, that was allocated
494 * via bus_dmamem_alloc. Make the same choice for free/contigfree.
497 bounce_bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
500 * dmamem does not need to be bounced, so the map should be
501 * NULL and the BUS_DMA_KMEM_ALLOC flag cleared if malloc()
502 * was used and set if kmem_alloc_contig() was used.
505 panic("bus_dmamem_free: Invalid map freed\n");
506 if ((dmat->bounce_flags & BUS_DMA_KMEM_ALLOC) == 0)
507 free(vaddr, M_DEVBUF);
509 kmem_free((vm_offset_t)vaddr, dmat->common.maxsize);
510 CTR3(KTR_BUSDMA, "%s: tag %p flags 0x%x", __func__, dmat,
515 _bus_dmamap_pagesneeded(bus_dma_tag_t dmat, vm_paddr_t buf, bus_size_t buflen,
523 * Count the number of bounce pages needed in order to
524 * complete this transfer
528 while (buflen != 0) {
529 sgsize = MIN(buflen, dmat->common.maxsegsz);
530 if (bus_dma_run_filter(&dmat->common, curaddr)) {
532 PAGE_SIZE - (curaddr & PAGE_MASK));
533 if (pagesneeded == NULL)
541 if (pagesneeded != NULL)
542 *pagesneeded = count;
547 _bus_dmamap_count_phys(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t buf,
548 bus_size_t buflen, int flags)
551 if (map != &nobounce_dmamap && map->pagesneeded == 0) {
552 _bus_dmamap_pagesneeded(dmat, buf, buflen, &map->pagesneeded);
553 CTR1(KTR_BUSDMA, "pagesneeded= %d\n", map->pagesneeded);
558 _bus_dmamap_count_pages(bus_dma_tag_t dmat, bus_dmamap_t map, pmap_t pmap,
559 void *buf, bus_size_t buflen, int flags)
562 vm_offset_t vendaddr;
566 if (map != &nobounce_dmamap && map->pagesneeded == 0) {
567 CTR4(KTR_BUSDMA, "lowaddr= %d Maxmem= %d, boundary= %d, "
568 "alignment= %d", dmat->common.lowaddr,
569 ptoa((vm_paddr_t)Maxmem),
570 dmat->common.boundary, dmat->common.alignment);
571 CTR3(KTR_BUSDMA, "map= %p, nobouncemap= %p, pagesneeded= %d",
572 map, &nobounce_dmamap, map->pagesneeded);
574 * Count the number of bounce pages
575 * needed in order to complete this transfer
577 vaddr = (vm_offset_t)buf;
578 vendaddr = (vm_offset_t)buf + buflen;
580 while (vaddr < vendaddr) {
581 sg_len = PAGE_SIZE - ((vm_offset_t)vaddr & PAGE_MASK);
582 if (pmap == kernel_pmap)
583 paddr = pmap_kextract(vaddr);
585 paddr = pmap_extract(pmap, vaddr);
586 if (bus_dma_run_filter(&dmat->common, paddr) != 0) {
587 sg_len = roundup2(sg_len,
588 dmat->common.alignment);
593 CTR1(KTR_BUSDMA, "pagesneeded= %d\n", map->pagesneeded);
598 _bus_dmamap_count_ma(bus_dma_tag_t dmat, bus_dmamap_t map, struct vm_page **ma,
599 int ma_offs, bus_size_t buflen, int flags)
601 bus_size_t sg_len, max_sgsize;
605 if (map != &nobounce_dmamap && map->pagesneeded == 0) {
606 CTR4(KTR_BUSDMA, "lowaddr= %d Maxmem= %d, boundary= %d, "
607 "alignment= %d", dmat->common.lowaddr,
608 ptoa((vm_paddr_t)Maxmem),
609 dmat->common.boundary, dmat->common.alignment);
610 CTR3(KTR_BUSDMA, "map= %p, nobouncemap= %p, pagesneeded= %d",
611 map, &nobounce_dmamap, map->pagesneeded);
614 * Count the number of bounce pages
615 * needed in order to complete this transfer
619 paddr = VM_PAGE_TO_PHYS(ma[page_index]) + ma_offs;
620 sg_len = PAGE_SIZE - ma_offs;
621 max_sgsize = MIN(buflen, dmat->common.maxsegsz);
622 sg_len = MIN(sg_len, max_sgsize);
623 if (bus_dma_run_filter(&dmat->common, paddr) != 0) {
624 sg_len = roundup2(sg_len,
625 dmat->common.alignment);
626 sg_len = MIN(sg_len, max_sgsize);
627 KASSERT(vm_addr_align_ok(sg_len,
628 dmat->common.alignment),
629 ("Segment size is not aligned"));
632 if (((ma_offs + sg_len) & ~PAGE_MASK) != 0)
634 ma_offs = (ma_offs + sg_len) & PAGE_MASK;
635 KASSERT(buflen >= sg_len,
636 ("Segment length overruns original buffer"));
639 CTR1(KTR_BUSDMA, "pagesneeded= %d\n", map->pagesneeded);
644 _bus_dmamap_reserve_pages(bus_dma_tag_t dmat, bus_dmamap_t map, int flags)
647 /* Reserve Necessary Bounce Pages */
648 mtx_lock(&bounce_lock);
649 if (flags & BUS_DMA_NOWAIT) {
650 if (reserve_bounce_pages(dmat, map, 0) != 0) {
651 mtx_unlock(&bounce_lock);
655 if (reserve_bounce_pages(dmat, map, 1) != 0) {
656 /* Queue us for resources */
657 STAILQ_INSERT_TAIL(&bounce_map_waitinglist, map, links);
658 mtx_unlock(&bounce_lock);
659 return (EINPROGRESS);
662 mtx_unlock(&bounce_lock);
668 * Add a single contiguous physical range to the segment list.
671 _bus_dmamap_addseg(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t curaddr,
672 bus_size_t sgsize, bus_dma_segment_t *segs, int *segp)
676 KASSERT(curaddr <= BUS_SPACE_MAXADDR,
677 ("ds_addr %#jx > BUS_SPACE_MAXADDR %#jx; dmat %p fl %#x low %#jx "
679 (uintmax_t)curaddr, (uintmax_t)BUS_SPACE_MAXADDR,
680 dmat, dmat->bounce_flags, (uintmax_t)dmat->common.lowaddr,
681 (uintmax_t)dmat->common.highaddr));
684 * Make sure we don't cross any boundaries.
686 if (!vm_addr_bound_ok(curaddr, sgsize, dmat->common.boundary))
687 sgsize = roundup2(curaddr, dmat->common.boundary) - curaddr;
690 * Insert chunk into a segment, coalescing with
691 * previous segment if possible.
696 segs[seg].ds_addr = curaddr;
697 segs[seg].ds_len = sgsize;
699 if (curaddr == segs[seg].ds_addr + segs[seg].ds_len &&
700 (segs[seg].ds_len + sgsize) <= dmat->common.maxsegsz &&
701 vm_addr_bound_ok(segs[seg].ds_addr,
702 segs[seg].ds_len + sgsize, dmat->common.boundary))
703 segs[seg].ds_len += sgsize;
705 if (++seg >= dmat->common.nsegments)
707 segs[seg].ds_addr = curaddr;
708 segs[seg].ds_len = sgsize;
716 * Utility function to load a physical buffer. segp contains
717 * the starting segment on entrace, and the ending segment on exit.
720 bounce_bus_dmamap_load_phys(bus_dma_tag_t dmat, bus_dmamap_t map,
721 vm_paddr_t buf, bus_size_t buflen, int flags, bus_dma_segment_t *segs,
729 map = &nobounce_dmamap;
732 segs = dmat->segments;
734 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0) {
735 _bus_dmamap_count_phys(dmat, map, buf, buflen, flags);
736 if (map->pagesneeded != 0) {
737 error = _bus_dmamap_reserve_pages(dmat, map, flags);
745 sgsize = MIN(buflen, dmat->common.maxsegsz);
746 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0 &&
747 map->pagesneeded != 0 &&
748 bus_dma_run_filter(&dmat->common, curaddr)) {
749 sgsize = MIN(sgsize, PAGE_SIZE - (curaddr & PAGE_MASK));
750 curaddr = add_bounce_page(dmat, map, 0, curaddr, 0,
753 sgsize = _bus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
764 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
768 * Utility function to load a linear buffer. segp contains
769 * the starting segment on entrace, and the ending segment on exit.
772 bounce_bus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
773 bus_size_t buflen, pmap_t pmap, int flags, bus_dma_segment_t *segs,
776 bus_size_t sgsize, max_sgsize;
778 vm_offset_t kvaddr, vaddr;
782 map = &nobounce_dmamap;
785 segs = dmat->segments;
787 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0) {
788 _bus_dmamap_count_pages(dmat, map, pmap, buf, buflen, flags);
789 if (map->pagesneeded != 0) {
790 error = _bus_dmamap_reserve_pages(dmat, map, flags);
796 vaddr = (vm_offset_t)buf;
799 * Get the physical address for this segment.
801 if (pmap == kernel_pmap) {
802 curaddr = pmap_kextract(vaddr);
805 curaddr = pmap_extract(pmap, vaddr);
810 * Compute the segment size, and adjust counts.
812 max_sgsize = MIN(buflen, dmat->common.maxsegsz);
813 sgsize = PAGE_SIZE - (curaddr & PAGE_MASK);
814 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0 &&
815 map->pagesneeded != 0 &&
816 bus_dma_run_filter(&dmat->common, curaddr)) {
817 sgsize = roundup2(sgsize, dmat->common.alignment);
818 sgsize = MIN(sgsize, max_sgsize);
819 curaddr = add_bounce_page(dmat, map, kvaddr, curaddr, 0,
822 sgsize = MIN(sgsize, max_sgsize);
824 sgsize = _bus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
835 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
839 bounce_bus_dmamap_load_ma(bus_dma_tag_t dmat, bus_dmamap_t map,
840 struct vm_page **ma, bus_size_t buflen, int ma_offs, int flags,
841 bus_dma_segment_t *segs, int *segp)
843 vm_paddr_t paddr, next_paddr;
844 int error, page_index;
845 bus_size_t sgsize, max_sgsize;
847 if (dmat->common.flags & BUS_DMA_KEEP_PG_OFFSET) {
849 * If we have to keep the offset of each page this function
850 * is not suitable, switch back to bus_dmamap_load_ma_triv
851 * which is going to do the right thing in this case.
853 error = bus_dmamap_load_ma_triv(dmat, map, ma, buflen, ma_offs,
859 map = &nobounce_dmamap;
862 segs = dmat->segments;
864 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0) {
865 _bus_dmamap_count_ma(dmat, map, ma, ma_offs, buflen, flags);
866 if (map->pagesneeded != 0) {
867 error = _bus_dmamap_reserve_pages(dmat, map, flags);
876 * Compute the segment size, and adjust counts.
878 paddr = VM_PAGE_TO_PHYS(ma[page_index]) + ma_offs;
879 max_sgsize = MIN(buflen, dmat->common.maxsegsz);
880 sgsize = PAGE_SIZE - ma_offs;
881 if ((dmat->bounce_flags & BUS_DMA_COULD_BOUNCE) != 0 &&
882 map->pagesneeded != 0 &&
883 bus_dma_run_filter(&dmat->common, paddr)) {
884 sgsize = roundup2(sgsize, dmat->common.alignment);
885 sgsize = MIN(sgsize, max_sgsize);
886 KASSERT(vm_addr_align_ok(sgsize,
887 dmat->common.alignment),
888 ("Segment size is not aligned"));
890 * Check if two pages of the user provided buffer
893 if ((ma_offs + sgsize) > PAGE_SIZE)
895 VM_PAGE_TO_PHYS(ma[page_index + 1]);
898 paddr = add_bounce_page(dmat, map, 0, paddr,
901 sgsize = MIN(sgsize, max_sgsize);
903 sgsize = _bus_dmamap_addseg(dmat, map, paddr, sgsize, segs,
907 KASSERT(buflen >= sgsize,
908 ("Segment length overruns original buffer"));
910 if (((ma_offs + sgsize) & ~PAGE_MASK) != 0)
912 ma_offs = (ma_offs + sgsize) & PAGE_MASK;
918 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
922 bounce_bus_dmamap_waitok(bus_dma_tag_t dmat, bus_dmamap_t map,
923 struct memdesc *mem, bus_dmamap_callback_t *callback, void *callback_arg)
930 map->callback = callback;
931 map->callback_arg = callback_arg;
934 static bus_dma_segment_t *
935 bounce_bus_dmamap_complete(bus_dma_tag_t dmat, bus_dmamap_t map,
936 bus_dma_segment_t *segs, int nsegs, int error)
940 segs = dmat->segments;
945 * Release the mapping held by map.
948 bounce_bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
950 struct bounce_page *bpage;
955 while ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
956 STAILQ_REMOVE_HEAD(&map->bpages, links);
957 free_bounce_page(dmat, bpage);
962 bounce_bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map,
965 struct bounce_page *bpage;
966 vm_offset_t datavaddr, tempvaddr;
967 bus_size_t datacount1, datacount2;
969 if (map == NULL || (bpage = STAILQ_FIRST(&map->bpages)) == NULL)
973 * Handle data bouncing. We might also want to add support for
974 * invalidating the caches on broken hardware.
976 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x op 0x%x "
977 "performing bounce", __func__, dmat, dmat->common.flags, op);
979 if ((op & BUS_DMASYNC_PREWRITE) != 0) {
980 while (bpage != NULL) {
982 datavaddr = bpage->datavaddr;
983 datacount1 = bpage->datacount;
984 if (datavaddr == 0) {
986 pmap_quick_enter_page(bpage->datapage[0]);
987 datavaddr = tempvaddr | bpage->dataoffs;
988 datacount1 = min(PAGE_SIZE - bpage->dataoffs,
992 bcopy((void *)datavaddr,
993 (void *)bpage->vaddr, datacount1);
996 pmap_quick_remove_page(tempvaddr);
998 if (bpage->datapage[1] == 0) {
999 KASSERT(datacount1 == bpage->datacount,
1000 ("Mismatch between data size and provided memory space"));
1005 * We are dealing with an unmapped buffer that expands
1008 datavaddr = pmap_quick_enter_page(bpage->datapage[1]);
1009 datacount2 = bpage->datacount - datacount1;
1010 bcopy((void *)datavaddr,
1011 (void *)(bpage->vaddr + datacount1), datacount2);
1012 pmap_quick_remove_page(datavaddr);
1015 bpage = STAILQ_NEXT(bpage, links);
1017 dmat->bounce_zone->total_bounced++;
1020 if ((op & BUS_DMASYNC_POSTREAD) != 0) {
1021 while (bpage != NULL) {
1023 datavaddr = bpage->datavaddr;
1024 datacount1 = bpage->datacount;
1025 if (datavaddr == 0) {
1027 pmap_quick_enter_page(bpage->datapage[0]);
1028 datavaddr = tempvaddr | bpage->dataoffs;
1029 datacount1 = min(PAGE_SIZE - bpage->dataoffs,
1033 bcopy((void *)bpage->vaddr, (void *)datavaddr,
1037 pmap_quick_remove_page(tempvaddr);
1039 if (bpage->datapage[1] == 0) {
1040 KASSERT(datacount1 == bpage->datacount,
1041 ("Mismatch between data size and provided memory space"));
1046 * We are dealing with an unmapped buffer that expands
1049 datavaddr = pmap_quick_enter_page(bpage->datapage[1]);
1050 datacount2 = bpage->datacount - datacount1;
1051 bcopy((void *)(bpage->vaddr + datacount1),
1052 (void *)datavaddr, datacount2);
1053 pmap_quick_remove_page(datavaddr);
1056 bpage = STAILQ_NEXT(bpage, links);
1058 dmat->bounce_zone->total_bounced++;
1061 atomic_thread_fence_rel();
1065 init_bounce_pages(void *dummy __unused)
1069 STAILQ_INIT(&bounce_zone_list);
1070 STAILQ_INIT(&bounce_map_waitinglist);
1071 STAILQ_INIT(&bounce_map_callbacklist);
1072 mtx_init(&bounce_lock, "bounce pages lock", NULL, MTX_DEF);
1074 SYSINIT(bpages, SI_SUB_LOCK, SI_ORDER_ANY, init_bounce_pages, NULL);
1076 static struct sysctl_ctx_list *
1077 busdma_sysctl_tree(struct bounce_zone *bz)
1080 return (&bz->sysctl_tree);
1083 static struct sysctl_oid *
1084 busdma_sysctl_tree_top(struct bounce_zone *bz)
1087 return (bz->sysctl_tree_top);
1091 alloc_bounce_zone(bus_dma_tag_t dmat)
1093 struct bounce_zone *bz;
1095 /* Check to see if we already have a suitable zone */
1096 STAILQ_FOREACH(bz, &bounce_zone_list, links) {
1097 if (dmat->common.alignment <= bz->alignment &&
1098 dmat->common.lowaddr >= bz->lowaddr &&
1099 dmat->common.domain == bz->domain) {
1100 dmat->bounce_zone = bz;
1105 if ((bz = (struct bounce_zone *)malloc(sizeof(*bz), M_DEVBUF,
1106 M_NOWAIT | M_ZERO)) == NULL)
1109 STAILQ_INIT(&bz->bounce_page_list);
1110 bz->free_bpages = 0;
1111 bz->reserved_bpages = 0;
1112 bz->active_bpages = 0;
1113 bz->lowaddr = dmat->common.lowaddr;
1114 bz->alignment = MAX(dmat->common.alignment, PAGE_SIZE);
1116 bz->domain = dmat->common.domain;
1117 snprintf(bz->zoneid, 8, "zone%d", busdma_zonecount);
1119 snprintf(bz->lowaddrid, 18, "%#jx", (uintmax_t)bz->lowaddr);
1120 STAILQ_INSERT_TAIL(&bounce_zone_list, bz, links);
1121 dmat->bounce_zone = bz;
1123 sysctl_ctx_init(&bz->sysctl_tree);
1124 bz->sysctl_tree_top = SYSCTL_ADD_NODE(&bz->sysctl_tree,
1125 SYSCTL_STATIC_CHILDREN(_hw_busdma), OID_AUTO, bz->zoneid,
1126 CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "");
1127 if (bz->sysctl_tree_top == NULL) {
1128 sysctl_ctx_free(&bz->sysctl_tree);
1129 return (0); /* XXX error code? */
1132 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1133 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1134 "total_bpages", CTLFLAG_RD, &bz->total_bpages, 0,
1135 "Total bounce pages");
1136 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1137 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1138 "free_bpages", CTLFLAG_RD, &bz->free_bpages, 0,
1139 "Free bounce pages");
1140 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1141 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1142 "reserved_bpages", CTLFLAG_RD, &bz->reserved_bpages, 0,
1143 "Reserved bounce pages");
1144 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1145 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1146 "active_bpages", CTLFLAG_RD, &bz->active_bpages, 0,
1147 "Active bounce pages");
1148 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1149 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1150 "total_bounced", CTLFLAG_RD, &bz->total_bounced, 0,
1151 "Total bounce requests");
1152 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1153 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1154 "total_deferred", CTLFLAG_RD, &bz->total_deferred, 0,
1155 "Total bounce requests that were deferred");
1156 SYSCTL_ADD_STRING(busdma_sysctl_tree(bz),
1157 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1158 "lowaddr", CTLFLAG_RD, bz->lowaddrid, 0, "");
1159 SYSCTL_ADD_UAUTO(busdma_sysctl_tree(bz),
1160 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1161 "alignment", CTLFLAG_RD, &bz->alignment, "");
1162 SYSCTL_ADD_INT(busdma_sysctl_tree(bz),
1163 SYSCTL_CHILDREN(busdma_sysctl_tree_top(bz)), OID_AUTO,
1164 "domain", CTLFLAG_RD, &bz->domain, 0,
1171 alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages)
1173 struct bounce_zone *bz;
1176 bz = dmat->bounce_zone;
1178 while (numpages > 0) {
1179 struct bounce_page *bpage;
1181 bpage = malloc_domainset(sizeof(*bpage), M_DEVBUF,
1182 DOMAINSET_PREF(dmat->common.domain), M_NOWAIT | M_ZERO);
1186 bpage->vaddr = (vm_offset_t)contigmalloc_domainset(PAGE_SIZE,
1187 M_DEVBUF, DOMAINSET_PREF(dmat->common.domain), M_NOWAIT,
1188 0ul, bz->lowaddr, PAGE_SIZE, 0);
1189 if (bpage->vaddr == 0) {
1190 free(bpage, M_DEVBUF);
1193 bpage->busaddr = pmap_kextract(bpage->vaddr);
1194 mtx_lock(&bounce_lock);
1195 STAILQ_INSERT_TAIL(&bz->bounce_page_list, bpage, links);
1199 mtx_unlock(&bounce_lock);
1207 reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map, int commit)
1209 struct bounce_zone *bz;
1212 mtx_assert(&bounce_lock, MA_OWNED);
1213 bz = dmat->bounce_zone;
1214 pages = MIN(bz->free_bpages, map->pagesneeded - map->pagesreserved);
1215 if (commit == 0 && map->pagesneeded > (map->pagesreserved + pages))
1216 return (map->pagesneeded - (map->pagesreserved + pages));
1217 bz->free_bpages -= pages;
1218 bz->reserved_bpages += pages;
1219 map->pagesreserved += pages;
1220 pages = map->pagesneeded - map->pagesreserved;
1226 add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map, vm_offset_t vaddr,
1227 vm_paddr_t addr1, vm_paddr_t addr2, bus_size_t size)
1229 struct bounce_zone *bz;
1230 struct bounce_page *bpage;
1232 KASSERT(dmat->bounce_zone != NULL, ("no bounce zone in dma tag"));
1233 KASSERT(map != NULL && map != &nobounce_dmamap,
1234 ("add_bounce_page: bad map %p", map));
1236 bz = dmat->bounce_zone;
1237 if (map->pagesneeded == 0)
1238 panic("add_bounce_page: map doesn't need any pages");
1241 if (map->pagesreserved == 0)
1242 panic("add_bounce_page: map doesn't need any pages");
1243 map->pagesreserved--;
1245 mtx_lock(&bounce_lock);
1246 bpage = STAILQ_FIRST(&bz->bounce_page_list);
1248 panic("add_bounce_page: free page list is empty");
1250 STAILQ_REMOVE_HEAD(&bz->bounce_page_list, links);
1251 bz->reserved_bpages--;
1252 bz->active_bpages++;
1253 mtx_unlock(&bounce_lock);
1255 if (dmat->common.flags & BUS_DMA_KEEP_PG_OFFSET) {
1256 /* Page offset needs to be preserved. */
1257 bpage->vaddr |= addr1 & PAGE_MASK;
1258 bpage->busaddr |= addr1 & PAGE_MASK;
1260 ("Trying to bounce multiple pages with BUS_DMA_KEEP_PG_OFFSET"));
1262 bpage->datavaddr = vaddr;
1263 bpage->datapage[0] = PHYS_TO_VM_PAGE(addr1);
1264 KASSERT((addr2 & PAGE_MASK) == 0, ("Second page is not aligned"));
1265 bpage->datapage[1] = PHYS_TO_VM_PAGE(addr2);
1266 bpage->dataoffs = addr1 & PAGE_MASK;
1267 bpage->datacount = size;
1268 STAILQ_INSERT_TAIL(&(map->bpages), bpage, links);
1269 return (bpage->busaddr);
1273 free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage)
1275 struct bus_dmamap *map;
1276 struct bounce_zone *bz;
1279 bz = dmat->bounce_zone;
1280 bpage->datavaddr = 0;
1281 bpage->datacount = 0;
1282 if (dmat->common.flags & BUS_DMA_KEEP_PG_OFFSET) {
1284 * Reset the bounce page to start at offset 0. Other uses
1285 * of this bounce page may need to store a full page of
1286 * data and/or assume it starts on a page boundary.
1288 bpage->vaddr &= ~PAGE_MASK;
1289 bpage->busaddr &= ~PAGE_MASK;
1292 schedule_swi = false;
1293 mtx_lock(&bounce_lock);
1294 STAILQ_INSERT_HEAD(&bz->bounce_page_list, bpage, links);
1296 bz->active_bpages--;
1297 if ((map = STAILQ_FIRST(&bounce_map_waitinglist)) != NULL) {
1298 if (reserve_bounce_pages(map->dmat, map, 1) == 0) {
1299 STAILQ_REMOVE_HEAD(&bounce_map_waitinglist, links);
1300 STAILQ_INSERT_TAIL(&bounce_map_callbacklist,
1302 bz->total_deferred++;
1303 schedule_swi = true;
1306 mtx_unlock(&bounce_lock);
1308 swi_sched(busdma_ih, 0);
1312 busdma_swi(void *dummy __unused)
1315 struct bus_dmamap *map;
1317 mtx_lock(&bounce_lock);
1318 while ((map = STAILQ_FIRST(&bounce_map_callbacklist)) != NULL) {
1319 STAILQ_REMOVE_HEAD(&bounce_map_callbacklist, links);
1320 mtx_unlock(&bounce_lock);
1322 (dmat->common.lockfunc)(dmat->common.lockfuncarg, BUS_DMA_LOCK);
1323 bus_dmamap_load_mem(map->dmat, map, &map->mem,
1324 map->callback, map->callback_arg, BUS_DMA_WAITOK);
1325 (dmat->common.lockfunc)(dmat->common.lockfuncarg,
1327 mtx_lock(&bounce_lock);
1329 mtx_unlock(&bounce_lock);
1333 start_busdma_swi(void *dummy __unused)
1335 if (swi_add(NULL, "busdma", busdma_swi, NULL, SWI_BUSDMA, INTR_MPSAFE,
1337 panic("died while creating busdma swi ithread");
1339 SYSINIT(start_busdma_swi, SI_SUB_SOFTINTR, SI_ORDER_ANY, start_busdma_swi,
1342 struct bus_dma_impl bus_dma_bounce_impl = {
1343 .tag_create = bounce_bus_dma_tag_create,
1344 .tag_destroy = bounce_bus_dma_tag_destroy,
1345 .tag_set_domain = bounce_bus_dma_tag_set_domain,
1346 .id_mapped = bounce_bus_dma_id_mapped,
1347 .map_create = bounce_bus_dmamap_create,
1348 .map_destroy = bounce_bus_dmamap_destroy,
1349 .mem_alloc = bounce_bus_dmamem_alloc,
1350 .mem_free = bounce_bus_dmamem_free,
1351 .load_phys = bounce_bus_dmamap_load_phys,
1352 .load_buffer = bounce_bus_dmamap_load_buffer,
1353 .load_ma = bounce_bus_dmamap_load_ma,
1354 .map_waitok = bounce_bus_dmamap_waitok,
1355 .map_complete = bounce_bus_dmamap_complete,
1356 .map_unload = bounce_bus_dmamap_unload,
1357 .map_sync = bounce_bus_dmamap_sync,