2 * Copyright (c) 1997, 1998 Justin T. Gibbs.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/i386/i386/busdma_machdep.c,v 1.16.2.2 2003/01/23 00:55:27 scottl Exp $
27 * $DragonFly: src/sys/platform/pc32/i386/busdma_machdep.c,v 1.23 2008/06/05 18:06:32 swildner Exp $
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
35 #include <sys/thread2.h>
36 #include <sys/bus_dma.h>
37 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
41 #include <vm/vm_page.h>
43 /* XXX needed for to access pmap to convert per-proc virtual to physical */
46 #include <vm/vm_map.h>
48 #include <machine/md_var.h>
50 #define MAX_BPAGES 1024
58 bus_dma_filter_t *filter;
66 bus_dma_segment_t *segments;
70 vm_offset_t vaddr; /* kva of bounce buffer */
71 bus_addr_t busaddr; /* Physical address */
72 vm_offset_t datavaddr; /* kva of client data */
73 bus_size_t datacount; /* client data count */
74 STAILQ_ENTRY(bounce_page) links;
77 int busdma_swi_pending;
79 static STAILQ_HEAD(bp_list, bounce_page) bounce_page_list;
80 static int free_bpages;
81 static int reserved_bpages;
82 static int active_bpages;
83 static int total_bpages;
84 static bus_addr_t bounce_lowaddr = BUS_SPACE_MAXADDR;
87 struct bp_list bpages;
91 void *buf; /* unmapped buffer pointer */
92 bus_size_t buflen; /* unmapped buffer length */
93 bus_dmamap_callback_t *callback;
95 STAILQ_ENTRY(bus_dmamap) links;
98 static STAILQ_HEAD(, bus_dmamap) bounce_map_waitinglist;
99 static STAILQ_HEAD(, bus_dmamap) bounce_map_callbacklist;
100 static struct bus_dmamap nobounce_dmamap;
102 static int alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages);
103 static int reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map);
104 static bus_addr_t add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map,
105 vm_offset_t vaddr, bus_size_t size);
106 static void free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage);
107 static __inline int run_filter(bus_dma_tag_t dmat, bus_addr_t paddr);
109 SYSCTL_NODE(_hw, OID_AUTO, busdma, CTLFLAG_RD, 0, "Busdma parameters");
110 SYSCTL_INT(_hw_busdma, OID_AUTO, total_bpages, CTLFLAG_RD, &total_bpages, 0,
111 "Total bounce pages");
114 run_filter(bus_dma_tag_t dmat, bus_addr_t paddr)
120 if (paddr > dmat->lowaddr
121 && paddr <= dmat->highaddr
122 && (dmat->filter == NULL
123 || (*dmat->filter)(dmat->filterarg, paddr) != 0))
127 } while (retval == 0 && dmat != NULL);
131 #define BUS_DMA_MIN_ALLOC_COMP BUS_DMA_BUS4
133 * Allocate a device specific dma_tag.
136 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
137 bus_size_t boundary, bus_addr_t lowaddr,
138 bus_addr_t highaddr, bus_dma_filter_t *filter,
139 void *filterarg, bus_size_t maxsize, int nsegments,
140 bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat)
142 bus_dma_tag_t newtag;
145 /* Return a NULL tag on failure */
148 newtag = kmalloc(sizeof(*newtag), M_DEVBUF, M_INTWAIT);
150 newtag->parent = parent;
151 newtag->alignment = alignment;
152 newtag->boundary = boundary;
153 newtag->lowaddr = trunc_page((vm_paddr_t)lowaddr) + (PAGE_SIZE - 1);
154 newtag->highaddr = trunc_page((vm_paddr_t)highaddr) + (PAGE_SIZE - 1);
155 newtag->filter = filter;
156 newtag->filterarg = filterarg;
157 newtag->maxsize = maxsize;
158 newtag->nsegments = nsegments;
159 newtag->maxsegsz = maxsegsz;
160 newtag->flags = flags;
161 newtag->ref_count = 1; /* Count ourself */
162 newtag->map_count = 0;
163 newtag->segments = NULL;
165 /* Take into account any restrictions imposed by our parent tag */
166 if (parent != NULL) {
167 newtag->lowaddr = MIN(parent->lowaddr, newtag->lowaddr);
168 newtag->highaddr = MAX(parent->highaddr, newtag->highaddr);
170 * XXX Not really correct??? Probably need to honor boundary
171 * all the way up the inheritence chain.
173 newtag->boundary = MAX(parent->boundary, newtag->boundary);
174 if (newtag->filter == NULL) {
176 * Short circuit looking at our parent directly
177 * since we have encapsulated all of its information
179 newtag->filter = parent->filter;
180 newtag->filterarg = parent->filterarg;
181 newtag->parent = parent->parent;
183 if (newtag->parent != NULL) {
188 if (newtag->lowaddr < ptoa(Maxmem) &&
189 (flags & BUS_DMA_ALLOCNOW) != 0) {
192 if (lowaddr > bounce_lowaddr) {
194 * Go through the pool and kill any pages
195 * that don't reside below lowaddr.
197 panic("bus_dma_tag_create: page reallocation "
200 if (ptoa(total_bpages) < maxsize) {
203 pages = atop(maxsize) - total_bpages;
205 /* Add pages to our bounce pool */
206 if (alloc_bounce_pages(newtag, pages) < pages)
209 /* Performed initial allocation */
210 newtag->flags |= BUS_DMA_MIN_ALLOC_COMP;
214 kfree(newtag, M_DEVBUF);
222 bus_dma_tag_destroy(bus_dma_tag_t dmat)
226 if (dmat->map_count != 0)
229 while (dmat != NULL) {
230 bus_dma_tag_t parent;
232 parent = dmat->parent;
234 if (dmat->ref_count == 0) {
235 if (dmat->segments != NULL)
236 kfree(dmat->segments, M_DEVBUF);
237 kfree(dmat, M_DEVBUF);
239 * Last reference count, so
240 * release our reference
241 * count on our parent.
252 * Allocate a handle for mapping from kva/uva/physical
253 * address space into bus device space.
256 bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
262 if (dmat->segments == NULL) {
263 KKASSERT(dmat->nsegments && dmat->nsegments < 16384);
264 dmat->segments = kmalloc(sizeof(bus_dma_segment_t) *
265 dmat->nsegments, M_DEVBUF, M_INTWAIT);
268 if (dmat->lowaddr < ptoa(Maxmem)) {
272 *mapp = kmalloc(sizeof(**mapp), M_DEVBUF, M_INTWAIT | M_ZERO);
275 /* Initialize the new map */
276 STAILQ_INIT(&((*mapp)->bpages));
278 * Attempt to add pages to our pool on a per-instance
279 * basis up to a sane limit.
281 maxpages = MIN(MAX_BPAGES, Maxmem - atop(dmat->lowaddr));
282 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0
283 || (dmat->map_count > 0
284 && total_bpages < maxpages)) {
287 if (dmat->lowaddr > bounce_lowaddr) {
289 * Go through the pool and kill any pages
290 * that don't reside below lowaddr.
292 panic("bus_dmamap_create: page reallocation "
296 pages = MAX(atop(dmat->maxsize), 1);
297 pages = MIN(maxpages - total_bpages, pages);
298 pages = MAX(pages, 1);
299 if (alloc_bounce_pages(dmat, pages) < pages)
302 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0) {
304 dmat->flags |= BUS_DMA_MIN_ALLOC_COMP;
318 * Destroy a handle for mapping from kva/uva/physical
319 * address space into bus device space.
322 bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
325 if (STAILQ_FIRST(&map->bpages) != NULL)
327 kfree(map, M_DEVBUF);
335 * Allocate a piece of memory that can be efficiently mapped into
336 * bus device space based on the constraints lited in the dma tag.
338 * mapp is degenerate. By definition this allocation should not require
339 * bounce buffers so do not allocate a dma map.
342 bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
346 /* If we succeed, no mapping/bouncing will be required */
349 if (dmat->segments == NULL) {
350 KKASSERT(dmat->nsegments < 16384);
351 dmat->segments = kmalloc(sizeof(bus_dma_segment_t) *
352 dmat->nsegments, M_DEVBUF, M_INTWAIT);
355 if (flags & BUS_DMA_NOWAIT)
359 if (flags & BUS_DMA_ZERO)
362 if ((dmat->maxsize <= PAGE_SIZE) &&
363 dmat->lowaddr >= ptoa(Maxmem)) {
364 *vaddr = kmalloc(dmat->maxsize, M_DEVBUF, mflags);
366 * XXX Check whether the allocation crossed a page boundary
367 * and retry with power-of-2 alignment in that case.
369 if ((((intptr_t)*vaddr) & PAGE_MASK) !=
370 (((intptr_t)*vaddr + dmat->maxsize) & PAGE_MASK)) {
372 kfree(*vaddr, M_DEVBUF);
373 /* XXX check for overflow? */
374 for (size = 1; size <= dmat->maxsize; size <<= 1)
376 *vaddr = kmalloc(size, M_DEVBUF, mflags);
380 * XXX Use Contigmalloc until it is merged into this facility
381 * and handles multi-seg allocations. Nobody is doing
382 * multi-seg allocations yet though.
384 *vaddr = contigmalloc(dmat->maxsize, M_DEVBUF, mflags,
385 0ul, dmat->lowaddr, dmat->alignment? dmat->alignment : 1ul,
394 * Free a piece of memory and it's allociated dmamap, that was allocated
395 * via bus_dmamem_alloc. Make the same choice for free/contigfree.
398 bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
401 * dmamem does not need to be bounced, so the map should be
405 panic("bus_dmamem_free: Invalid map freed\n");
406 if ((dmat->maxsize <= PAGE_SIZE) &&
407 dmat->lowaddr >= ptoa(Maxmem))
408 kfree(vaddr, M_DEVBUF);
410 contigfree(vaddr, dmat->maxsize, M_DEVBUF);
413 #define BUS_DMAMAP_NSEGS ((BUS_SPACE_MAXSIZE / PAGE_SIZE) + 1)
416 * Map the buffer buf into bus space using the dmamap map.
419 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
420 bus_size_t buflen, bus_dmamap_callback_t *callback,
421 void *callback_arg, int flags)
425 bus_dma_segment_t *sg;
428 vm_paddr_t nextpaddr;
432 map = &nobounce_dmamap;
436 * If we are being called during a callback, pagesneeded will
437 * be non-zero, so we can avoid doing the work twice.
439 if (dmat->lowaddr < ptoa(Maxmem) &&
440 map->pagesneeded == 0) {
441 vm_offset_t vendaddr;
444 * Count the number of bounce pages
445 * needed in order to complete this transfer
447 vaddr = trunc_page((vm_offset_t)buf);
448 vendaddr = (vm_offset_t)buf + buflen;
450 while (vaddr < vendaddr) {
451 paddr = pmap_kextract(vaddr);
452 if (run_filter(dmat, paddr) != 0) {
460 /* Reserve Necessary Bounce Pages */
461 if (map->pagesneeded != 0) {
463 if (reserve_bounce_pages(dmat, map) != 0) {
465 /* Queue us for resources */
468 map->buflen = buflen;
469 map->callback = callback;
470 map->callback_arg = callback_arg;
472 STAILQ_INSERT_TAIL(&bounce_map_waitinglist, map, links);
475 return (EINPROGRESS);
480 vaddr = (vm_offset_t)buf;
485 bmask = ~(dmat->boundary - 1); /* note: will be 0 if boundary is 0 */
487 /* force at least one segment */
494 paddr = pmap_kextract(vaddr);
495 size = PAGE_SIZE - (paddr & PAGE_MASK);
498 if (map->pagesneeded != 0 && run_filter(dmat, paddr)) {
500 * note: this paddr has the same in-page offset
501 * as vaddr and thus the paddr above, so the
502 * size does not have to be recalculated
504 paddr = add_bounce_page(dmat, map, vaddr, size);
508 * Fill in the bus_dma_segment
510 if (sg->ds_len == 0) {
513 } else if (paddr == nextpaddr) {
518 if (seg > dmat->nsegments)
523 nextpaddr = paddr + size;
526 * Handle maxsegsz and boundary issues with a nested loop
532 * Limit to the boundary and maximum segment size
534 if (((nextpaddr - 1) ^ sg->ds_addr) & bmask) {
535 tmpsize = dmat->boundary -
536 (sg->ds_addr & ~bmask);
537 if (tmpsize > dmat->maxsegsz)
538 tmpsize = dmat->maxsegsz;
539 KKASSERT(tmpsize < sg->ds_len);
540 } else if (sg->ds_len > dmat->maxsegsz) {
541 tmpsize = dmat->maxsegsz;
547 * Futz, split the data into a new segment.
549 if (seg >= dmat->nsegments)
551 sg[1].ds_len = sg[0].ds_len - tmpsize;
552 sg[1].ds_addr = sg[0].ds_addr + tmpsize;
553 sg[0].ds_len = tmpsize;
563 } while (buflen > 0);
567 kprintf("bus_dmamap_load: Too many segs! buf_len = 0x%lx\n",
572 (*callback)(callback_arg, dmat->segments, seg, error);
578 * Utility function to load a linear buffer. lastaddrp holds state
579 * between invocations (for multiple-buffer loads). segp contains
580 * the starting segment on entrace, and the ending segment on exit.
581 * first indicates if this is the first invocation of this function.
584 _bus_dmamap_load_buffer(bus_dma_tag_t dmat,
585 void *buf, bus_size_t buflen,
588 vm_offset_t *lastaddrp,
592 bus_dma_segment_t *segs;
594 bus_addr_t curaddr, lastaddr, baddr, bmask;
595 vm_offset_t vaddr = (vm_offset_t)buf;
599 if (td->td_proc != NULL)
600 pmap = vmspace_pmap(td->td_proc->p_vmspace);
604 segs = dmat->segments;
605 lastaddr = *lastaddrp;
606 bmask = ~(dmat->boundary - 1);
608 for (seg = *segp; buflen > 0 ; ) {
610 * Get the physical address for this segment.
613 curaddr = pmap_extract(pmap, vaddr);
615 curaddr = pmap_kextract(vaddr);
618 * Compute the segment size, and adjust counts.
620 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK);
625 * Make sure we don't cross any boundaries.
627 if (dmat->boundary > 0) {
628 baddr = (curaddr + dmat->boundary) & bmask;
629 if (sgsize > (baddr - curaddr))
630 sgsize = (baddr - curaddr);
634 * Insert chunk into a segment, coalescing with
635 * previous segment if possible.
638 segs[seg].ds_addr = curaddr;
639 segs[seg].ds_len = sgsize;
642 if (curaddr == lastaddr &&
643 (segs[seg].ds_len + sgsize) <= dmat->maxsegsz &&
644 (dmat->boundary == 0 ||
645 (segs[seg].ds_addr & bmask) == (curaddr & bmask)))
646 segs[seg].ds_len += sgsize;
648 if (++seg >= dmat->nsegments)
650 segs[seg].ds_addr = curaddr;
651 segs[seg].ds_len = sgsize;
655 lastaddr = curaddr + sgsize;
661 *lastaddrp = lastaddr;
666 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
670 * Like _bus_dmamap_load(), but for mbufs.
673 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
675 bus_dmamap_callback2_t *callback, void *callback_arg,
680 KASSERT(dmat->lowaddr >= ptoa(Maxmem) || map != NULL,
681 ("bus_dmamap_load_mbuf: No support for bounce pages!"));
682 KASSERT(m0->m_flags & M_PKTHDR,
683 ("bus_dmamap_load_mbuf: no packet header"));
687 if (m0->m_pkthdr.len <= dmat->maxsize) {
689 vm_offset_t lastaddr = 0;
692 for (m = m0; m != NULL && error == 0; m = m->m_next) {
695 error = _bus_dmamap_load_buffer(dmat,
697 curthread, flags, &lastaddr,
706 /* force "no valid mappings" in callback */
707 (*callback)(callback_arg, dmat->segments, 0, 0, error);
709 (*callback)(callback_arg, dmat->segments,
710 nsegs+1, m0->m_pkthdr.len, error);
716 * Like _bus_dmamap_load(), but for uios.
719 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
721 bus_dmamap_callback2_t *callback, void *callback_arg,
724 vm_offset_t lastaddr;
725 int nsegs, error, first, i;
728 struct thread *td = NULL;
730 KASSERT(dmat->lowaddr >= ptoa(Maxmem) || map != NULL,
731 ("bus_dmamap_load_uio: No support for bounce pages!"));
733 resid = uio->uio_resid;
736 if (uio->uio_segflg == UIO_USERSPACE) {
738 KASSERT(td != NULL && td->td_proc != NULL,
739 ("bus_dmamap_load_uio: USERSPACE but no proc"));
745 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
747 * Now at the first iovec to load. Load each iovec
748 * until we have exhausted the residual count.
751 resid < iov[i].iov_len ? resid : iov[i].iov_len;
752 caddr_t addr = (caddr_t) iov[i].iov_base;
754 error = _bus_dmamap_load_buffer(dmat,
756 td, flags, &lastaddr, &nsegs, first);
763 /* force "no valid mappings" in callback */
764 (*callback)(callback_arg, dmat->segments, 0, 0, error);
766 (*callback)(callback_arg, dmat->segments,
767 nsegs+1, uio->uio_resid, error);
773 * Release the mapping held by map.
776 _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
778 struct bounce_page *bpage;
780 while ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
781 STAILQ_REMOVE_HEAD(&map->bpages, links);
782 free_bounce_page(dmat, bpage);
787 _bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op)
789 struct bounce_page *bpage;
791 if ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
794 * Handle data bouncing. We might also
795 * want to add support for invalidating
796 * the caches on broken hardware
799 case BUS_DMASYNC_PREWRITE:
800 while (bpage != NULL) {
801 bcopy((void *)bpage->datavaddr,
802 (void *)bpage->vaddr,
804 bpage = STAILQ_NEXT(bpage, links);
808 case BUS_DMASYNC_POSTREAD:
809 while (bpage != NULL) {
810 bcopy((void *)bpage->vaddr,
811 (void *)bpage->datavaddr,
813 bpage = STAILQ_NEXT(bpage, links);
816 case BUS_DMASYNC_PREREAD:
817 case BUS_DMASYNC_POSTWRITE:
825 alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages)
830 if (total_bpages == 0) {
831 STAILQ_INIT(&bounce_page_list);
832 STAILQ_INIT(&bounce_map_waitinglist);
833 STAILQ_INIT(&bounce_map_callbacklist);
836 while (numpages > 0) {
837 struct bounce_page *bpage;
839 bpage = (struct bounce_page *)kmalloc(sizeof(*bpage), M_DEVBUF,
844 bpage->vaddr = (vm_offset_t)contigmalloc(PAGE_SIZE, M_DEVBUF,
849 if (bpage->vaddr == 0) {
850 kfree(bpage, M_DEVBUF);
853 bpage->busaddr = pmap_kextract(bpage->vaddr);
855 STAILQ_INSERT_TAIL(&bounce_page_list, bpage, links);
866 reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map)
870 pages = MIN(free_bpages, map->pagesneeded - map->pagesreserved);
871 free_bpages -= pages;
872 reserved_bpages += pages;
873 map->pagesreserved += pages;
874 pages = map->pagesneeded - map->pagesreserved;
880 add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map, vm_offset_t vaddr,
883 struct bounce_page *bpage;
885 if (map->pagesneeded == 0)
886 panic("add_bounce_page: map doesn't need any pages");
889 if (map->pagesreserved == 0)
890 panic("add_bounce_page: map doesn't need any pages");
891 map->pagesreserved--;
894 bpage = STAILQ_FIRST(&bounce_page_list);
896 panic("add_bounce_page: free page list is empty");
898 STAILQ_REMOVE_HEAD(&bounce_page_list, links);
903 bpage->datavaddr = vaddr;
904 bpage->datacount = size;
905 STAILQ_INSERT_TAIL(&(map->bpages), bpage, links);
906 return (bpage->busaddr);
910 free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage)
912 struct bus_dmamap *map;
914 bpage->datavaddr = 0;
915 bpage->datacount = 0;
918 STAILQ_INSERT_HEAD(&bounce_page_list, bpage, links);
921 if ((map = STAILQ_FIRST(&bounce_map_waitinglist)) != NULL) {
922 if (reserve_bounce_pages(map->dmat, map) == 0) {
923 STAILQ_REMOVE_HEAD(&bounce_map_waitinglist, links);
924 STAILQ_INSERT_TAIL(&bounce_map_callbacklist,
926 busdma_swi_pending = 1;
936 struct bus_dmamap *map;
939 while ((map = STAILQ_FIRST(&bounce_map_callbacklist)) != NULL) {
940 STAILQ_REMOVE_HEAD(&bounce_map_callbacklist, links);
942 bus_dmamap_load(map->dmat, map, map->buf, map->buflen,
943 map->callback, map->callback_arg, /*flags*/0);