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
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/malloc.h>
34 #include <vm/vm_page.h>
36 #include <machine/bus.h>
37 #include <machine/md_var.h>
39 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
40 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
41 #define MAX_BPAGES 128
49 bus_dma_filter_t *filter;
60 vm_offset_t vaddr; /* kva of bounce buffer */
61 bus_addr_t busaddr; /* Physical address */
62 vm_offset_t datavaddr; /* kva of client data */
63 bus_size_t datacount; /* client data count */
64 STAILQ_ENTRY(bounce_page) links;
67 int busdma_swi_pending;
69 static STAILQ_HEAD(bp_list, bounce_page) bounce_page_list;
70 static int free_bpages;
71 static int reserved_bpages;
72 static int active_bpages;
73 static int total_bpages;
74 static bus_addr_t bounce_lowaddr = BUS_SPACE_MAXADDR;
77 struct bp_list bpages;
81 void *buf; /* unmapped buffer pointer */
82 bus_size_t buflen; /* unmapped buffer length */
83 bus_dmamap_callback_t *callback;
85 STAILQ_ENTRY(bus_dmamap) links;
88 static STAILQ_HEAD(, bus_dmamap) bounce_map_waitinglist;
89 static STAILQ_HEAD(, bus_dmamap) bounce_map_callbacklist;
90 static struct bus_dmamap nobounce_dmamap;
92 static int alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages);
93 static int reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map);
94 static vm_offset_t add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map,
95 vm_offset_t vaddr, bus_size_t size);
96 static void free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage);
97 static __inline int run_filter(bus_dma_tag_t dmat, bus_addr_t paddr);
100 run_filter(bus_dma_tag_t dmat, bus_addr_t paddr)
106 if (paddr > dmat->lowaddr
107 && paddr <= dmat->highaddr
108 && (dmat->filter == NULL
109 || (*dmat->filter)(dmat->filterarg, paddr) != 0))
113 } while (retval == 0 && dmat != NULL);
117 #define BUS_DMA_MIN_ALLOC_COMP BUS_DMA_BUS4
119 * Allocate a device specific dma_tag.
122 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
123 bus_size_t boundary, bus_addr_t lowaddr,
124 bus_addr_t highaddr, bus_dma_filter_t *filter,
125 void *filterarg, bus_size_t maxsize, int nsegments,
126 bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat)
128 bus_dma_tag_t newtag;
131 /* Return a NULL tag on failure */
134 newtag = (bus_dma_tag_t)malloc(sizeof(*newtag), M_DEVBUF, M_NOWAIT);
138 newtag->parent = parent;
139 newtag->alignment = alignment;
140 newtag->boundary = boundary;
141 newtag->lowaddr = trunc_page((vm_offset_t)lowaddr) + (PAGE_SIZE - 1);
142 newtag->highaddr = trunc_page((vm_offset_t)highaddr) + (PAGE_SIZE - 1);
143 newtag->filter = filter;
144 newtag->filterarg = filterarg;
145 newtag->maxsize = maxsize;
146 newtag->nsegments = nsegments;
147 newtag->maxsegsz = maxsegsz;
148 newtag->flags = flags;
149 newtag->ref_count = 1; /* Count ourself */
150 newtag->map_count = 0;
152 /* Take into account any restrictions imposed by our parent tag */
153 if (parent != NULL) {
154 newtag->lowaddr = MIN(parent->lowaddr, newtag->lowaddr);
155 newtag->highaddr = MAX(parent->highaddr, newtag->highaddr);
157 * XXX Not really correct??? Probably need to honor boundary
158 * all the way up the inheritence chain.
160 newtag->boundary = MAX(parent->boundary, newtag->boundary);
161 if (newtag->filter == NULL) {
163 * Short circuit looking at our parent directly
164 * since we have encapsulated all of its information
166 newtag->filter = parent->filter;
167 newtag->filterarg = parent->filterarg;
168 newtag->parent = parent->parent;
170 if (newtag->parent != NULL) {
175 if (newtag->lowaddr < ptoa(Maxmem) && (flags & BUS_DMA_ALLOCNOW) != 0) {
178 if (lowaddr > bounce_lowaddr) {
180 * Go through the pool and kill any pages
181 * that don't reside below lowaddr.
183 panic("bus_dma_tag_create: page reallocation "
186 if (ptoa(total_bpages) < maxsize) {
189 pages = atop(maxsize) - total_bpages;
191 /* Add pages to our bounce pool */
192 if (alloc_bounce_pages(newtag, pages) < pages)
195 /* Performed initial allocation */
196 newtag->flags |= BUS_DMA_MIN_ALLOC_COMP;
200 free(newtag, M_DEVBUF);
208 bus_dma_tag_destroy(bus_dma_tag_t dmat)
212 if (dmat->map_count != 0)
215 while (dmat != NULL) {
216 bus_dma_tag_t parent;
218 parent = dmat->parent;
220 if (dmat->ref_count == 0) {
221 free(dmat, M_DEVBUF);
223 * Last reference count, so
224 * release our reference
225 * count on our parent.
236 * Allocate a handle for mapping from kva/uva/physical
237 * address space into bus device space.
240 bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
246 if (dmat->lowaddr < ptoa(Maxmem)) {
250 *mapp = (bus_dmamap_t)malloc(sizeof(**mapp), M_DEVBUF,
255 /* Initialize the new map */
256 bzero(*mapp, sizeof(**mapp));
257 STAILQ_INIT(&((*mapp)->bpages));
260 * Attempt to add pages to our pool on a per-instance
261 * basis up to a sane limit.
263 maxpages = MIN(MAX_BPAGES, Maxmem - atop(dmat->lowaddr));
264 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0
265 || (dmat->map_count > 0
266 && total_bpages < maxpages)) {
269 if (dmat->lowaddr > bounce_lowaddr) {
271 * Go through the pool and kill any pages
272 * that don't reside below lowaddr.
274 panic("bus_dmamap_create: page reallocation "
277 pages = atop(dmat->maxsize);
278 pages = MIN(maxpages - total_bpages, pages);
279 error = alloc_bounce_pages(dmat, pages);
281 if ((dmat->flags & BUS_DMA_MIN_ALLOC_COMP) == 0) {
283 dmat->flags |= BUS_DMA_MIN_ALLOC_COMP;
297 * Destroy a handle for mapping from kva/uva/physical
298 * address space into bus device space.
301 bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
304 if (STAILQ_FIRST(&map->bpages) != NULL)
314 * Allocate a piece of memory that can be efficiently mapped into
315 * bus device space based on the constraints lited in the dma tag.
316 * A dmamap to for use with dmamap_load is also allocated.
319 bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
322 /* If we succeed, no mapping/bouncing will be required */
325 if ((dmat->maxsize <= PAGE_SIZE) && dmat->lowaddr >= ptoa(Maxmem)) {
326 *vaddr = malloc(dmat->maxsize, M_DEVBUF,
327 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK);
330 * XXX Use Contigmalloc until it is merged into this facility
331 * and handles multi-seg allocations. Nobody is doing
332 * multi-seg allocations yet though.
334 *vaddr = contigmalloc(dmat->maxsize, M_DEVBUF,
335 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK,
336 0ul, dmat->lowaddr, dmat->alignment? dmat->alignment : 1ul,
345 * Free a piece of memory and it's allociated dmamap, that was allocated
346 * via bus_dmamem_alloc.
349 bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
352 * dmamem does not need to be bounced, so the map should be
356 panic("bus_dmamem_free: Invalid map freed\n");
357 /* XXX There is no "contigfree" and "free" doesn't work */
358 if ((dmat->maxsize <= PAGE_SIZE) && dmat->lowaddr >= ptoa(Maxmem))
359 free(vaddr, M_DEVBUF);
362 #define BUS_DMAMAP_NSEGS ((BUS_SPACE_MAXSIZE / PAGE_SIZE) + 1)
365 * Map the buffer buf into bus space using the dmamap map.
368 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
369 bus_size_t buflen, bus_dmamap_callback_t *callback,
370 void *callback_arg, int flags)
375 bus_dma_segment_t dm_segments[dmat->nsegments];
377 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS];
379 bus_dma_segment_t *sg;
382 vm_offset_t nextpaddr;
385 map = &nobounce_dmamap;
389 * If we are being called during a callback, pagesneeded will
390 * be non-zero, so we can avoid doing the work twice.
392 if (dmat->lowaddr < ptoa(Maxmem) && map->pagesneeded == 0) {
393 vm_offset_t vendaddr;
396 * Count the number of bounce pages
397 * needed in order to complete this transfer
399 vaddr = trunc_page((vm_offset_t)buf);
400 vendaddr = (vm_offset_t)buf + buflen;
402 while (vaddr < vendaddr) {
403 paddr = pmap_kextract(vaddr);
404 if (run_filter(dmat, paddr) != 0) {
412 /* Reserve Necessary Bounce Pages */
413 if (map->pagesneeded != 0) {
417 if (reserve_bounce_pages(dmat, map) != 0) {
419 /* Queue us for resources */
422 map->buflen = buflen;
423 map->callback = callback;
424 map->callback_arg = callback_arg;
426 STAILQ_INSERT_TAIL(&bounce_map_waitinglist, map, links);
429 return (EINPROGRESS);
434 vaddr = (vm_offset_t)buf;
435 sg = &dm_segments[0];
443 paddr = pmap_kextract(vaddr);
444 size = PAGE_SIZE - (paddr & PAGE_MASK);
448 if (map->pagesneeded != 0 && run_filter(dmat, paddr)) {
449 paddr = add_bounce_page(dmat, map, vaddr, size);
452 if (sg->ds_len == 0) {
455 } else if (paddr == nextpaddr) {
458 /* Go to the next segment */
461 if (seg > dmat->nsegments)
467 nextpaddr = paddr + size;
470 } while (buflen > 0);
473 printf("bus_dmamap_load: Too many segs! buf_len = 0x%lx\n",
478 (*callback)(callback_arg, dm_segments, seg, error);
484 * Release the mapping held by map.
487 _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
489 struct bounce_page *bpage;
491 while ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
492 STAILQ_REMOVE_HEAD(&map->bpages, links);
493 free_bounce_page(dmat, bpage);
498 _bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op)
500 struct bounce_page *bpage;
502 if ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
505 * Handle data bouncing. We might also
506 * want to add support for invalidating
507 * the caches on broken hardware
510 case BUS_DMASYNC_PREWRITE:
511 while (bpage != NULL) {
512 bcopy((void *)bpage->datavaddr,
513 (void *)bpage->vaddr,
515 bpage = STAILQ_NEXT(bpage, links);
519 case BUS_DMASYNC_POSTREAD:
520 while (bpage != NULL) {
521 bcopy((void *)bpage->vaddr,
522 (void *)bpage->datavaddr,
524 bpage = STAILQ_NEXT(bpage, links);
527 case BUS_DMASYNC_PREREAD:
528 case BUS_DMASYNC_POSTWRITE:
536 alloc_bounce_pages(bus_dma_tag_t dmat, u_int numpages)
541 if (total_bpages == 0) {
542 STAILQ_INIT(&bounce_page_list);
543 STAILQ_INIT(&bounce_map_waitinglist);
544 STAILQ_INIT(&bounce_map_callbacklist);
547 while (numpages > 0) {
548 struct bounce_page *bpage;
551 bpage = (struct bounce_page *)malloc(sizeof(*bpage), M_DEVBUF,
556 bzero(bpage, sizeof(*bpage));
557 bpage->vaddr = (vm_offset_t)contigmalloc(PAGE_SIZE, M_DEVBUF,
562 if (bpage->vaddr == NULL) {
563 free(bpage, M_DEVBUF);
566 bpage->busaddr = pmap_kextract(bpage->vaddr);
568 STAILQ_INSERT_TAIL(&bounce_page_list, bpage, links);
579 reserve_bounce_pages(bus_dma_tag_t dmat, bus_dmamap_t map)
583 pages = MIN(free_bpages, map->pagesneeded - map->pagesreserved);
584 free_bpages -= pages;
585 reserved_bpages += pages;
586 map->pagesreserved += pages;
587 pages = map->pagesneeded - map->pagesreserved;
593 add_bounce_page(bus_dma_tag_t dmat, bus_dmamap_t map, vm_offset_t vaddr,
597 struct bounce_page *bpage;
599 if (map->pagesneeded == 0)
600 panic("add_bounce_page: map doesn't need any pages");
603 if (map->pagesreserved == 0)
604 panic("add_bounce_page: map doesn't need any pages");
605 map->pagesreserved--;
608 bpage = STAILQ_FIRST(&bounce_page_list);
610 panic("add_bounce_page: free page list is empty");
612 STAILQ_REMOVE_HEAD(&bounce_page_list, links);
617 bpage->datavaddr = vaddr;
618 bpage->datacount = size;
619 STAILQ_INSERT_TAIL(&(map->bpages), bpage, links);
620 return (bpage->busaddr);
624 free_bounce_page(bus_dma_tag_t dmat, struct bounce_page *bpage)
627 struct bus_dmamap *map;
629 bpage->datavaddr = 0;
630 bpage->datacount = 0;
633 STAILQ_INSERT_HEAD(&bounce_page_list, bpage, links);
636 if ((map = STAILQ_FIRST(&bounce_map_waitinglist)) != NULL) {
637 if (reserve_bounce_pages(map->dmat, map) == 0) {
638 STAILQ_REMOVE_HEAD(&bounce_map_waitinglist, links);
639 STAILQ_INSERT_TAIL(&bounce_map_callbacklist,
641 busdma_swi_pending = 1;
652 struct bus_dmamap *map;
655 while ((map = STAILQ_FIRST(&bounce_map_callbacklist)) != NULL) {
656 STAILQ_REMOVE_HEAD(&bounce_map_callbacklist, links);
658 bus_dmamap_load(map->dmat, map, map->buf, map->buflen,
659 map->callback, map->callback_arg, /*flags*/0);