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 $
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/malloc.h>
36 #include <vm/vm_page.h>
38 /* XXX needed for to access pmap to convert per-proc virtual to physical */
41 #include <vm/vm_map.h>
43 #include <machine/bus.h>
44 #include <machine/md_var.h>
46 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
47 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
48 #define MAX_BPAGES 128
56 bus_dma_filter_t *filter;
67 vm_offset_t vaddr; /* kva of bounce buffer */
68 bus_addr_t busaddr; /* Physical address */
69 vm_offset_t datavaddr; /* kva of client data */
70 bus_size_t datacount; /* client data count */
71 STAILQ_ENTRY(bounce_page) links;
74 int busdma_swi_pending;
76 static STAILQ_HEAD(bp_list, bounce_page) bounce_page_list;
77 static int free_bpages;
78 static int reserved_bpages;
79 static int active_bpages;
80 static int total_bpages;
81 static bus_addr_t bounce_lowaddr = BUS_SPACE_MAXADDR;
84 struct bp_list bpages;
88 void *buf; /* unmapped buffer pointer */
89 bus_size_t buflen; /* unmapped buffer length */
90 bus_dmamap_callback_t *callback;
92 STAILQ_ENTRY(bus_dmamap) links;
95 static STAILQ_HEAD(, bus_dmamap) bounce_map_waitinglist;
96 static STAILQ_HEAD(, bus_dmamap) bounce_map_callbacklist;
97 static struct bus_dmamap nobounce_dmamap;
99 static int alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages);
100 static int reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map);
101 static vm_offset_t add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map,
102 vm_offset_t vaddr, bus_size_t size);
103 static void free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage);
104 static __inline int run_filter(bus_dma_tag_t dmat, bus_addr_t paddr);
107 run_filter(bus_dma_tag_t dmat, bus_addr_t paddr)
113 if (paddr > dmat->lowaddr
114 && paddr <= dmat->highaddr
115 && (dmat->filter == NULL
116 || (*dmat->filter)(dmat->filterarg, paddr) != 0))
120 } while (retval == 0 && dmat != NULL);
124 #define BUS_DMA_MIN_ALLOC_COMP BUS_DMA_BUS4
126 * Allocate a device specific dma_tag.
129 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
130 bus_size_t boundary, bus_addr_t lowaddr,
131 bus_addr_t highaddr, bus_dma_filter_t *filter,
132 void *filterarg, bus_size_t maxsize, int nsegments,
133 bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat)
135 bus_dma_tag_t newtag;
138 /* Return a NULL tag on failure */
141 newtag = (bus_dma_tag_t)malloc(sizeof(*newtag), M_DEVBUF, M_NOWAIT);
145 newtag->parent = parent;
146 newtag->alignment = alignment;
147 newtag->boundary = boundary;
148 newtag->lowaddr = trunc_page((vm_offset_t)lowaddr) + (PAGE_SIZE - 1);
149 newtag->highaddr = trunc_page((vm_offset_t)highaddr) + (PAGE_SIZE - 1);
150 newtag->filter = filter;
151 newtag->filterarg = filterarg;
152 newtag->maxsize = maxsize;
153 newtag->nsegments = nsegments;
154 newtag->maxsegsz = maxsegsz;
155 newtag->flags = flags;
156 newtag->ref_count = 1; /* Count ourself */
157 newtag->map_count = 0;
159 /* Take into account any restrictions imposed by our parent tag */
160 if (parent != NULL) {
161 newtag->lowaddr = MIN(parent->lowaddr, newtag->lowaddr);
162 newtag->highaddr = MAX(parent->highaddr, newtag->highaddr);
164 * XXX Not really correct??? Probably need to honor boundary
165 * all the way up the inheritence chain.
167 newtag->boundary = MAX(parent->boundary, newtag->boundary);
168 if (newtag->filter == NULL) {
170 * Short circuit looking at our parent directly
171 * since we have encapsulated all of its information
173 newtag->filter = parent->filter;
174 newtag->filterarg = parent->filterarg;
175 newtag->parent = parent->parent;
177 if (newtag->parent != NULL) {
182 if (newtag->lowaddr < ptoa(Maxmem) && (flags & BUS_DMA_ALLOCNOW) != 0) {
185 if (lowaddr > bounce_lowaddr) {
187 * Go through the pool and kill any pages
188 * that don't reside below lowaddr.
190 panic("bus_dma_tag_create: page reallocation "
193 if (ptoa(total_bpages) < maxsize) {
196 pages = atop(maxsize) - total_bpages;
198 /* Add pages to our bounce pool */
199 if (alloc_bounce_pages(newtag, pages) < pages)
202 /* Performed initial allocation */
203 newtag->flags |= BUS_DMA_MIN_ALLOC_COMP;
207 free(newtag, M_DEVBUF);
215 bus_dma_tag_destroy(bus_dma_tag_t dmat)
219 if (dmat->map_count != 0)
222 while (dmat != NULL) {
223 bus_dma_tag_t parent;
225 parent = dmat->parent;
227 if (dmat->ref_count == 0) {
228 free(dmat, M_DEVBUF);
230 * Last reference count, so
231 * release our reference
232 * count on our parent.
243 * Allocate a handle for mapping from kva/uva/physical
244 * address space into bus device space.
247 bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
253 if (dmat->lowaddr < ptoa(Maxmem)) {
257 *mapp = (bus_dmamap_t)malloc(sizeof(**mapp), M_DEVBUF,
262 /* Initialize the new map */
263 bzero(*mapp, sizeof(**mapp));
264 STAILQ_INIT(&((*mapp)->bpages));
267 * Attempt to add pages to our pool on a per-instance
268 * basis up to a sane limit.
270 maxpages = MIN(MAX_BPAGES, Maxmem - atop(dmat->lowaddr));
271 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0
272 || (dmat->map_count > 0
273 && total_bpages < maxpages)) {
276 if (dmat->lowaddr > bounce_lowaddr) {
278 * Go through the pool and kill any pages
279 * that don't reside below lowaddr.
281 panic("bus_dmamap_create: page reallocation "
284 pages = atop(dmat->maxsize);
285 pages = MIN(maxpages - total_bpages, pages);
286 error = alloc_bounce_pages(dmat, pages);
288 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0) {
290 dmat->flags |= BUS_DMA_MIN_ALLOC_COMP;
304 * Destroy a handle for mapping from kva/uva/physical
305 * address space into bus device space.
308 bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
311 if (STAILQ_FIRST(&map->bpages) != NULL)
321 * Allocate a piece of memory that can be efficiently mapped into
322 * bus device space based on the constraints lited in the dma tag.
323 * A dmamap to for use with dmamap_load is also allocated.
326 bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
329 /* If we succeed, no mapping/bouncing will be required */
332 if ((dmat->maxsize <= PAGE_SIZE) && dmat->lowaddr >= ptoa(Maxmem)) {
333 *vaddr = malloc(dmat->maxsize, M_DEVBUF,
334 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK);
337 * XXX Use Contigmalloc until it is merged into this facility
338 * and handles multi-seg allocations. Nobody is doing
339 * multi-seg allocations yet though.
341 *vaddr = contigmalloc(dmat->maxsize, M_DEVBUF,
342 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK,
343 0ul, dmat->lowaddr, dmat->alignment? dmat->alignment : 1ul,
352 * Free a piece of memory and it's allociated dmamap, that was allocated
353 * via bus_dmamem_alloc. Make the same choice for free/contigfree.
356 bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
359 * dmamem does not need to be bounced, so the map should be
363 panic("bus_dmamem_free: Invalid map freed\n");
364 if ((dmat->maxsize <= PAGE_SIZE) && dmat->lowaddr >= ptoa(Maxmem))
365 free(vaddr, M_DEVBUF);
367 contigfree(vaddr, dmat->maxsize, M_DEVBUF);
370 #define BUS_DMAMAP_NSEGS ((BUS_SPACE_MAXSIZE / PAGE_SIZE) + 1)
373 * Map the buffer buf into bus space using the dmamap map.
376 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
377 bus_size_t buflen, bus_dmamap_callback_t *callback,
378 void *callback_arg, int flags)
383 bus_dma_segment_t dm_segments[dmat->nsegments];
385 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS];
387 bus_dma_segment_t *sg;
390 vm_offset_t nextpaddr;
393 map = &nobounce_dmamap;
397 * If we are being called during a callback, pagesneeded will
398 * be non-zero, so we can avoid doing the work twice.
400 if (dmat->lowaddr < ptoa(Maxmem) && map->pagesneeded == 0) {
401 vm_offset_t vendaddr;
404 * Count the number of bounce pages
405 * needed in order to complete this transfer
407 vaddr = trunc_page((vm_offset_t)buf);
408 vendaddr = (vm_offset_t)buf + buflen;
410 while (vaddr < vendaddr) {
411 paddr = pmap_kextract(vaddr);
412 if (run_filter(dmat, paddr) != 0) {
420 /* Reserve Necessary Bounce Pages */
421 if (map->pagesneeded != 0) {
425 if (reserve_bounce_pages(dmat, map) != 0) {
427 /* Queue us for resources */
430 map->buflen = buflen;
431 map->callback = callback;
432 map->callback_arg = callback_arg;
434 STAILQ_INSERT_TAIL(&bounce_map_waitinglist, map, links);
437 return (EINPROGRESS);
442 vaddr = (vm_offset_t)buf;
443 sg = &dm_segments[0];
451 paddr = pmap_kextract(vaddr);
452 size = PAGE_SIZE - (paddr & PAGE_MASK);
456 if (map->pagesneeded != 0 && run_filter(dmat, paddr)) {
457 paddr = add_bounce_page(dmat, map, vaddr, size);
460 if (sg->ds_len == 0) {
463 } else if (paddr == nextpaddr) {
466 /* Go to the next segment */
469 if (seg > dmat->nsegments)
475 nextpaddr = paddr + size;
478 } while (buflen > 0);
481 printf("bus_dmamap_load: Too many segs! buf_len = 0x%lx\n",
486 (*callback)(callback_arg, dm_segments, seg, error);
492 * Utility function to load a linear buffer. lastaddrp holds state
493 * between invocations (for multiple-buffer loads). segp contains
494 * the starting segment on entrace, and the ending segment on exit.
495 * first indicates if this is the first invocation of this function.
498 _bus_dmamap_load_buffer(bus_dma_tag_t dmat,
499 bus_dma_segment_t segs[],
500 void *buf, bus_size_t buflen,
503 vm_offset_t *lastaddrp,
508 bus_addr_t curaddr, lastaddr, baddr, bmask;
509 vm_offset_t vaddr = (vm_offset_t)buf;
514 pmap = vmspace_pmap(p->p_vmspace);
518 lastaddr = *lastaddrp;
519 bmask = ~(dmat->boundary - 1);
521 for (seg = *segp; buflen > 0 ; ) {
523 * Get the physical address for this segment.
526 curaddr = pmap_extract(pmap, vaddr);
528 curaddr = pmap_kextract(vaddr);
531 * Compute the segment size, and adjust counts.
533 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK);
538 * Make sure we don't cross any boundaries.
540 if (dmat->boundary > 0) {
541 baddr = (curaddr + dmat->boundary) & bmask;
542 if (sgsize > (baddr - curaddr))
543 sgsize = (baddr - curaddr);
547 * Insert chunk into a segment, coalescing with
548 * previous segment if possible.
551 segs[seg].ds_addr = curaddr;
552 segs[seg].ds_len = sgsize;
555 if (curaddr == lastaddr &&
556 (segs[seg].ds_len + sgsize) <= dmat->maxsegsz &&
557 (dmat->boundary == 0 ||
558 (segs[seg].ds_addr & bmask) == (curaddr & bmask)))
559 segs[seg].ds_len += sgsize;
561 if (++seg >= dmat->nsegments)
563 segs[seg].ds_addr = curaddr;
564 segs[seg].ds_len = sgsize;
568 lastaddr = curaddr + sgsize;
574 *lastaddrp = lastaddr;
579 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
583 * Like _bus_dmamap_load(), but for mbufs.
586 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
588 bus_dmamap_callback2_t *callback, void *callback_arg,
592 bus_dma_segment_t dm_segments[dmat->nsegments];
594 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS];
598 KASSERT(dmat->lowaddr >= ptoa(Maxmem) || map != NULL,
599 ("bus_dmamap_load_mbuf: No support for bounce pages!"));
600 KASSERT(m0->m_flags & M_PKTHDR,
601 ("bus_dmamap_load_mbuf: no packet header"));
605 if (m0->m_pkthdr.len <= dmat->maxsize) {
607 vm_offset_t lastaddr = 0;
610 for (m = m0; m != NULL && error == 0; m = m->m_next) {
611 error = _bus_dmamap_load_buffer(dmat,
614 NULL, flags, &lastaddr, &nsegs, first);
622 /* force "no valid mappings" in callback */
623 (*callback)(callback_arg, dm_segments, 0, 0, error);
625 (*callback)(callback_arg, dm_segments,
626 nsegs+1, m0->m_pkthdr.len, error);
632 * Like _bus_dmamap_load(), but for uios.
635 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
637 bus_dmamap_callback2_t *callback, void *callback_arg,
640 vm_offset_t lastaddr;
642 bus_dma_segment_t dm_segments[dmat->nsegments];
644 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS];
646 int nsegs, error, first, i;
649 struct proc *p = NULL;
651 KASSERT(dmat->lowaddr >= ptoa(Maxmem) || map != NULL,
652 ("bus_dmamap_load_uio: No support for bounce pages!"));
654 resid = uio->uio_resid;
657 if (uio->uio_segflg == UIO_USERSPACE) {
660 ("bus_dmamap_load_uio: USERSPACE but no proc"));
666 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
668 * Now at the first iovec to load. Load each iovec
669 * until we have exhausted the residual count.
672 resid < iov[i].iov_len ? resid : iov[i].iov_len;
673 caddr_t addr = (caddr_t) iov[i].iov_base;
675 error = _bus_dmamap_load_buffer(dmat,
678 p, flags, &lastaddr, &nsegs, first);
685 /* force "no valid mappings" in callback */
686 (*callback)(callback_arg, dm_segments, 0, 0, error);
688 (*callback)(callback_arg, dm_segments,
689 nsegs+1, uio->uio_resid, error);
695 * Release the mapping held by map.
698 _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
700 struct bounce_page *bpage;
702 while ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
703 STAILQ_REMOVE_HEAD(&map->bpages, links);
704 free_bounce_page(dmat, bpage);
709 _bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op)
711 struct bounce_page *bpage;
713 if ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
716 * Handle data bouncing. We might also
717 * want to add support for invalidating
718 * the caches on broken hardware
721 case BUS_DMASYNC_PREWRITE:
722 while (bpage != NULL) {
723 bcopy((void *)bpage->datavaddr,
724 (void *)bpage->vaddr,
726 bpage = STAILQ_NEXT(bpage, links);
730 case BUS_DMASYNC_POSTREAD:
731 while (bpage != NULL) {
732 bcopy((void *)bpage->vaddr,
733 (void *)bpage->datavaddr,
735 bpage = STAILQ_NEXT(bpage, links);
738 case BUS_DMASYNC_PREREAD:
739 case BUS_DMASYNC_POSTWRITE:
747 alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages)
752 if (total_bpages == 0) {
753 STAILQ_INIT(&bounce_page_list);
754 STAILQ_INIT(&bounce_map_waitinglist);
755 STAILQ_INIT(&bounce_map_callbacklist);
758 while (numpages > 0) {
759 struct bounce_page *bpage;
762 bpage = (struct bounce_page *)malloc(sizeof(*bpage), M_DEVBUF,
767 bzero(bpage, sizeof(*bpage));
768 bpage->vaddr = (vm_offset_t)contigmalloc(PAGE_SIZE, M_DEVBUF,
773 if (bpage->vaddr == NULL) {
774 free(bpage, M_DEVBUF);
777 bpage->busaddr = pmap_kextract(bpage->vaddr);
779 STAILQ_INSERT_TAIL(&bounce_page_list, bpage, links);
790 reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map)
794 pages = MIN(free_bpages, map->pagesneeded - map->pagesreserved);
795 free_bpages -= pages;
796 reserved_bpages += pages;
797 map->pagesreserved += pages;
798 pages = map->pagesneeded - map->pagesreserved;
804 add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map, vm_offset_t vaddr,
808 struct bounce_page *bpage;
810 if (map->pagesneeded == 0)
811 panic("add_bounce_page: map doesn't need any pages");
814 if (map->pagesreserved == 0)
815 panic("add_bounce_page: map doesn't need any pages");
816 map->pagesreserved--;
819 bpage = STAILQ_FIRST(&bounce_page_list);
821 panic("add_bounce_page: free page list is empty");
823 STAILQ_REMOVE_HEAD(&bounce_page_list, links);
828 bpage->datavaddr = vaddr;
829 bpage->datacount = size;
830 STAILQ_INSERT_TAIL(&(map->bpages), bpage, links);
831 return (bpage->busaddr);
835 free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage)
838 struct bus_dmamap *map;
840 bpage->datavaddr = 0;
841 bpage->datacount = 0;
844 STAILQ_INSERT_HEAD(&bounce_page_list, bpage, links);
847 if ((map = STAILQ_FIRST(&bounce_map_waitinglist)) != NULL) {
848 if (reserve_bounce_pages(map->dmat, map) == 0) {
849 STAILQ_REMOVE_HEAD(&bounce_map_waitinglist, links);
850 STAILQ_INSERT_TAIL(&bounce_map_callbacklist,
852 busdma_swi_pending = 1;
863 struct bus_dmamap *map;
866 while ((map = STAILQ_FIRST(&bounce_map_callbacklist)) != NULL) {
867 STAILQ_REMOVE_HEAD(&bounce_map_callbacklist, links);
869 bus_dmamap_load(map->dmat, map, map->buf, map->buflen,
870 map->callback, map->callback_arg, /*flags*/0);