]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/arm64/arm64/busdma_bounce.c
sys: Automated cleanup of cdefs and other formatting
[FreeBSD/FreeBSD.git] / sys / arm64 / arm64 / busdma_bounce.c
1 /*-
2  * Copyright (c) 1997, 1998 Justin T. Gibbs.
3  * Copyright (c) 2015-2016 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * Portions of this software were developed by Andrew Turner
7  * under sponsorship of the FreeBSD Foundation.
8  *
9  * Portions of this software were developed by Semihalf
10  * under sponsorship of the FreeBSD Foundation.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
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.
20  *
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
31  * SUCH DAMAGE.
32  */
33
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/domainset.h>
37 #include <sys/malloc.h>
38 #include <sys/bus.h>
39 #include <sys/interrupt.h>
40 #include <sys/kernel.h>
41 #include <sys/ktr.h>
42 #include <sys/lock.h>
43 #include <sys/proc.h>
44 #include <sys/memdesc.h>
45 #include <sys/mutex.h>
46 #include <sys/sysctl.h>
47 #include <sys/uio.h>
48
49 #include <vm/vm.h>
50 #include <vm/vm_extern.h>
51 #include <vm/vm_kern.h>
52 #include <vm/vm_page.h>
53 #include <vm/vm_map.h>
54
55 #include <machine/atomic.h>
56 #include <machine/bus.h>
57 #include <machine/md_var.h>
58 #include <arm64/include/bus_dma_impl.h>
59
60 #define MAX_BPAGES 4096
61
62 enum {
63         BF_COULD_BOUNCE         = 0x01,
64         BF_MIN_ALLOC_COMP       = 0x02,
65         BF_KMEM_ALLOC           = 0x04,
66         BF_COHERENT             = 0x10,
67 };
68
69 struct bounce_page;
70 struct bounce_zone;
71
72 struct bus_dma_tag {
73         struct bus_dma_tag_common common;
74         size_t                  alloc_size;
75         size_t                  alloc_alignment;
76         int                     map_count;
77         int                     bounce_flags;
78         bus_dma_segment_t       *segments;
79         struct bounce_zone      *bounce_zone;
80 };
81
82 static SYSCTL_NODE(_hw, OID_AUTO, busdma, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
83     "Busdma parameters");
84
85 struct sync_list {
86         vm_offset_t     vaddr;          /* kva of client data */
87         bus_addr_t      paddr;          /* physical address */
88         vm_page_t       pages;          /* starting page of client data */
89         bus_size_t      datacount;      /* client data count */
90 };
91
92 struct bus_dmamap {
93         STAILQ_HEAD(, bounce_page) bpages;
94         int                    pagesneeded;
95         int                    pagesreserved;
96         bus_dma_tag_t          dmat;
97         struct memdesc         mem;
98         bus_dmamap_callback_t *callback;
99         void                  *callback_arg;
100         __sbintime_t           queued_time;
101         STAILQ_ENTRY(bus_dmamap) links;
102         u_int                   flags;
103 #define DMAMAP_COHERENT         (1 << 0)
104 #define DMAMAP_FROM_DMAMEM      (1 << 1)
105 #define DMAMAP_MBUF             (1 << 2)
106         int                     sync_count;
107         struct sync_list        slist[];
108 };
109
110 int run_filter(bus_dma_tag_t dmat, bus_addr_t paddr);
111 static bool _bus_dmamap_pagesneeded(bus_dma_tag_t dmat, bus_dmamap_t map,
112     vm_paddr_t buf, bus_size_t buflen, int *pagesneeded);
113 static void _bus_dmamap_count_pages(bus_dma_tag_t dmat, bus_dmamap_t map,
114     pmap_t pmap, void *buf, bus_size_t buflen, int flags);
115 static void _bus_dmamap_count_phys(bus_dma_tag_t dmat, bus_dmamap_t map,
116     vm_paddr_t buf, bus_size_t buflen, int flags);
117
118 static MALLOC_DEFINE(M_BUSDMA, "busdma", "busdma metadata");
119
120 #define dmat_alignment(dmat)    ((dmat)->common.alignment)
121 #define dmat_domain(dmat)       ((dmat)->common.domain)
122 #define dmat_flags(dmat)        ((dmat)->common.flags)
123 #define dmat_lowaddr(dmat)      ((dmat)->common.lowaddr)
124 #define dmat_lockfunc(dmat)     ((dmat)->common.lockfunc)
125 #define dmat_lockfuncarg(dmat)  ((dmat)->common.lockfuncarg)
126
127 #include "../../kern/subr_busdma_bounce.c"
128
129 static int
130 bounce_bus_dma_zone_setup(bus_dma_tag_t dmat)
131 {
132         struct bounce_zone *bz;
133         bus_size_t maxsize;
134         int error;
135
136         /*
137          * Round size up to a full page, and add one more page because
138          * there can always be one more boundary crossing than the
139          * number of pages in a transfer.
140          */
141         maxsize = roundup2(dmat->common.maxsize, PAGE_SIZE) + PAGE_SIZE;
142
143         /* Must bounce */
144         if ((error = alloc_bounce_zone(dmat)) != 0)
145                 return (error);
146         bz = dmat->bounce_zone;
147
148         if (ptoa(bz->total_bpages) < maxsize) {
149                 int pages;
150
151                 pages = atop(maxsize) + 1 - bz->total_bpages;
152
153                 /* Add pages to our bounce pool */
154                 if (alloc_bounce_pages(dmat, pages) < pages)
155                         return (ENOMEM);
156         }
157         /* Performed initial allocation */
158         dmat->bounce_flags |= BF_MIN_ALLOC_COMP;
159
160         return (error);
161 }
162
163 /*
164  * Return true if the DMA should bounce because the start or end does not fall
165  * on a cacheline boundary (which would require a partial cacheline flush).
166  * COHERENT memory doesn't trigger cacheline flushes.  Memory allocated by
167  * bus_dmamem_alloc() is always aligned to cacheline boundaries, and there's a
168  * strict rule that such memory cannot be accessed by the CPU while DMA is in
169  * progress (or by multiple DMA engines at once), so that it's always safe to do
170  * full cacheline flushes even if that affects memory outside the range of a
171  * given DMA operation that doesn't involve the full allocated buffer.  If we're
172  * mapping an mbuf, that follows the same rules as a buffer we allocated.
173  */
174 static bool
175 cacheline_bounce(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t paddr,
176     bus_size_t size)
177 {
178
179 #define DMAMAP_CACHELINE_FLAGS                                          \
180     (DMAMAP_FROM_DMAMEM | DMAMAP_COHERENT | DMAMAP_MBUF)
181         if ((dmat->bounce_flags & BF_COHERENT) != 0)
182                 return (false);
183         if (map != NULL && (map->flags & DMAMAP_CACHELINE_FLAGS) != 0)
184                 return (false);
185         return (((paddr | size) & (dcache_line_size - 1)) != 0);
186 #undef DMAMAP_CACHELINE_FLAGS
187 }
188
189 /*
190  * Return true if the given address does not fall on the alignment boundary.
191  */
192 static bool
193 alignment_bounce(bus_dma_tag_t dmat, bus_addr_t addr)
194 {
195
196         return (!vm_addr_align_ok(addr, dmat->common.alignment));
197 }
198
199 static bool
200 might_bounce(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t paddr,
201     bus_size_t size)
202 {
203
204         /* Memory allocated by bounce_bus_dmamem_alloc won't bounce */
205         if (map && (map->flags & DMAMAP_FROM_DMAMEM) != 0)
206                 return (false);
207
208         if ((dmat->bounce_flags & BF_COULD_BOUNCE) != 0)
209                 return (true);
210
211         if (cacheline_bounce(dmat, map, paddr, size))
212                 return (true);
213
214         if (alignment_bounce(dmat, paddr))
215                 return (true);
216
217         return (false);
218 }
219
220 static bool
221 must_bounce(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t paddr,
222     bus_size_t size)
223 {
224
225         if (cacheline_bounce(dmat, map, paddr, size))
226                 return (true);
227
228         if (alignment_bounce(dmat, paddr))
229                 return (true);
230
231         if ((dmat->bounce_flags & BF_COULD_BOUNCE) != 0 &&
232             bus_dma_run_filter(&dmat->common, paddr))
233                 return (true);
234
235         return (false);
236 }
237
238 /*
239  * Allocate a device specific dma_tag.
240  */
241 static int
242 bounce_bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
243     bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
244     bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
245     int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
246     void *lockfuncarg, bus_dma_tag_t *dmat)
247 {
248         bus_dma_tag_t newtag;
249         int error;
250
251         *dmat = NULL;
252         error = common_bus_dma_tag_create(parent != NULL ? &parent->common :
253             NULL, alignment, boundary, lowaddr, highaddr, filter, filterarg,
254             maxsize, nsegments, maxsegsz, flags, lockfunc, lockfuncarg,
255             sizeof (struct bus_dma_tag), (void **)&newtag);
256         if (error != 0)
257                 return (error);
258
259         newtag->common.impl = &bus_dma_bounce_impl;
260         newtag->map_count = 0;
261         newtag->segments = NULL;
262
263         if ((flags & BUS_DMA_COHERENT) != 0) {
264                 newtag->bounce_flags |= BF_COHERENT;
265         }
266
267         if (parent != NULL) {
268                 if ((newtag->common.filter != NULL ||
269                     (parent->bounce_flags & BF_COULD_BOUNCE) != 0))
270                         newtag->bounce_flags |= BF_COULD_BOUNCE;
271
272                 /* Copy some flags from the parent */
273                 newtag->bounce_flags |= parent->bounce_flags & BF_COHERENT;
274         }
275
276         if ((newtag->bounce_flags & BF_COHERENT) != 0) {
277                 newtag->alloc_alignment = newtag->common.alignment;
278                 newtag->alloc_size = newtag->common.maxsize;
279         } else {
280                 /*
281                  * Ensure the buffer is aligned to a cacheline when allocating
282                  * a non-coherent buffer. This is so we don't have any data
283                  * that another CPU may be accessing around DMA buffer
284                  * causing the cache to become dirty.
285                  */
286                 newtag->alloc_alignment = MAX(newtag->common.alignment,
287                     dcache_line_size);
288                 newtag->alloc_size = roundup2(newtag->common.maxsize,
289                     dcache_line_size);
290         }
291
292         if (newtag->common.lowaddr < ptoa((vm_paddr_t)Maxmem) ||
293             newtag->common.alignment > 1)
294                 newtag->bounce_flags |= BF_COULD_BOUNCE;
295
296         if ((flags & BUS_DMA_ALLOCNOW) != 0)
297                 error = bounce_bus_dma_zone_setup(newtag);
298         else
299                 error = 0;
300
301         if (error != 0)
302                 free(newtag, M_DEVBUF);
303         else
304                 *dmat = newtag;
305         CTR4(KTR_BUSDMA, "%s returned tag %p tag flags 0x%x error %d",
306             __func__, newtag, (newtag != NULL ? newtag->common.flags : 0),
307             error);
308         return (error);
309 }
310
311 static int
312 bounce_bus_dma_tag_destroy(bus_dma_tag_t dmat)
313 {
314 #ifdef KTR
315         bus_dma_tag_t dmat_copy;
316 #endif
317         bus_dma_tag_t parent;
318         int error;
319
320         error = 0;
321 #ifdef KTR
322         dmat_copy = dmat;
323 #endif
324
325
326         if (dmat != NULL) {
327                 if (dmat->map_count != 0) {
328                         error = EBUSY;
329                         goto out;
330                 }
331                 while (dmat != NULL) {
332                         parent = (bus_dma_tag_t)dmat->common.parent;
333                         atomic_subtract_int(&dmat->common.ref_count, 1);
334                         if (dmat->common.ref_count == 0) {
335                                 if (dmat->segments != NULL)
336                                         free(dmat->segments, M_DEVBUF);
337                                 free(dmat, M_DEVBUF);
338                                 /*
339                                  * Last reference count, so
340                                  * release our reference
341                                  * count on our parent.
342                                  */
343                                 dmat = parent;
344                         } else
345                                 dmat = NULL;
346                 }
347         }
348 out:
349         CTR3(KTR_BUSDMA, "%s tag %p error %d", __func__, dmat_copy, error);
350         return (error);
351 }
352
353 /*
354  * Update the domain for the tag.  We may need to reallocate the zone and
355  * bounce pages.
356  */
357 static int
358 bounce_bus_dma_tag_set_domain(bus_dma_tag_t dmat)
359 {
360
361         KASSERT(dmat->map_count == 0,
362             ("bounce_bus_dma_tag_set_domain:  Domain set after use.\n"));
363         if ((dmat->bounce_flags & BF_COULD_BOUNCE) == 0 ||
364             dmat->bounce_zone == NULL)
365                 return (0);
366         dmat->bounce_flags &= ~BF_MIN_ALLOC_COMP;
367         return (bounce_bus_dma_zone_setup(dmat));
368 }
369
370 static bool
371 bounce_bus_dma_id_mapped(bus_dma_tag_t dmat, vm_paddr_t buf, bus_size_t buflen)
372 {
373
374         if (!might_bounce(dmat, NULL, buf, buflen))
375                 return (true);
376         return (!_bus_dmamap_pagesneeded(dmat, NULL, buf, buflen, NULL));
377 }
378
379 static bus_dmamap_t
380 alloc_dmamap(bus_dma_tag_t dmat, int flags)
381 {
382         u_long mapsize;
383         bus_dmamap_t map;
384
385         mapsize = sizeof(*map);
386         mapsize += sizeof(struct sync_list) * dmat->common.nsegments;
387         map = malloc_domainset(mapsize, M_DEVBUF,
388             DOMAINSET_PREF(dmat->common.domain), flags | M_ZERO);
389         if (map == NULL)
390                 return (NULL);
391
392         /* Initialize the new map */
393         STAILQ_INIT(&map->bpages);
394
395         return (map);
396 }
397
398 /*
399  * Allocate a handle for mapping from kva/uva/physical
400  * address space into bus device space.
401  */
402 static int
403 bounce_bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
404 {
405         struct bounce_zone *bz;
406         int error, maxpages, pages;
407
408         error = 0;
409
410         if (dmat->segments == NULL) {
411                 dmat->segments = mallocarray_domainset(dmat->common.nsegments,
412                     sizeof(bus_dma_segment_t), M_DEVBUF,
413                     DOMAINSET_PREF(dmat->common.domain), M_NOWAIT);
414                 if (dmat->segments == NULL) {
415                         CTR3(KTR_BUSDMA, "%s: tag %p error %d",
416                             __func__, dmat, ENOMEM);
417                         return (ENOMEM);
418                 }
419         }
420
421         *mapp = alloc_dmamap(dmat, M_NOWAIT);
422         if (*mapp == NULL) {
423                 CTR3(KTR_BUSDMA, "%s: tag %p error %d",
424                     __func__, dmat, ENOMEM);
425                 return (ENOMEM);
426         }
427
428         /*
429          * Bouncing might be required if the driver asks for an active
430          * exclusion region, a data alignment that is stricter than 1, and/or
431          * an active address boundary.
432          */
433         if (dmat->bounce_zone == NULL) {
434                 if ((error = alloc_bounce_zone(dmat)) != 0) {
435                         free(*mapp, M_DEVBUF);
436                         return (error);
437                 }
438         }
439         bz = dmat->bounce_zone;
440
441         /*
442          * Attempt to add pages to our pool on a per-instance basis up to a sane
443          * limit. Even if the tag isn't subject of bouncing due to alignment
444          * and boundary constraints, it could still auto-bounce due to
445          * cacheline alignment, which requires at most two bounce pages.
446          */
447         if (dmat->common.alignment > 1)
448                 maxpages = MAX_BPAGES;
449         else
450                 maxpages = MIN(MAX_BPAGES, Maxmem -
451                     atop(dmat->common.lowaddr));
452         if ((dmat->bounce_flags & BF_MIN_ALLOC_COMP) == 0 ||
453             (bz->map_count > 0 && bz->total_bpages < maxpages)) {
454                 pages = atop(roundup2(dmat->common.maxsize, PAGE_SIZE)) + 1;
455                 pages = MIN(maxpages - bz->total_bpages, pages);
456                 pages = MAX(pages, 2);
457                 if (alloc_bounce_pages(dmat, pages) < pages)
458                         error = ENOMEM;
459                 if ((dmat->bounce_flags & BF_MIN_ALLOC_COMP) == 0) {
460                         if (error == 0) {
461                                 dmat->bounce_flags |= BF_MIN_ALLOC_COMP;
462                         }
463                 } else
464                         error = 0;
465         }
466         bz->map_count++;
467
468         if (error == 0) {
469                 dmat->map_count++;
470                 if ((dmat->bounce_flags & BF_COHERENT) != 0)
471                         (*mapp)->flags |= DMAMAP_COHERENT;
472         } else {
473                 free(*mapp, M_DEVBUF);
474         }
475         CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
476             __func__, dmat, dmat->common.flags, error);
477         return (error);
478 }
479
480 /*
481  * Destroy a handle for mapping from kva/uva/physical
482  * address space into bus device space.
483  */
484 static int
485 bounce_bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
486 {
487
488         /* Check we are destroying the correct map type */
489         if ((map->flags & DMAMAP_FROM_DMAMEM) != 0)
490                 panic("bounce_bus_dmamap_destroy: Invalid map freed\n");
491
492         if (STAILQ_FIRST(&map->bpages) != NULL || map->sync_count != 0) {
493                 CTR3(KTR_BUSDMA, "%s: tag %p error %d", __func__, dmat, EBUSY);
494                 return (EBUSY);
495         }
496         if (dmat->bounce_zone)
497                 dmat->bounce_zone->map_count--;
498         free(map, M_DEVBUF);
499         dmat->map_count--;
500         CTR2(KTR_BUSDMA, "%s: tag %p error 0", __func__, dmat);
501         return (0);
502 }
503
504 /*
505  * Allocate a piece of memory that can be efficiently mapped into
506  * bus device space based on the constraints lited in the dma tag.
507  * A dmamap to for use with dmamap_load is also allocated.
508  */
509 static int
510 bounce_bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
511     bus_dmamap_t *mapp)
512 {
513         vm_memattr_t attr;
514         int mflags;
515
516         if (flags & BUS_DMA_NOWAIT)
517                 mflags = M_NOWAIT;
518         else
519                 mflags = M_WAITOK;
520
521         if (dmat->segments == NULL) {
522                 dmat->segments = mallocarray_domainset(dmat->common.nsegments,
523                     sizeof(bus_dma_segment_t), M_DEVBUF,
524                     DOMAINSET_PREF(dmat->common.domain), mflags);
525                 if (dmat->segments == NULL) {
526                         CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
527                             __func__, dmat, dmat->common.flags, ENOMEM);
528                         return (ENOMEM);
529                 }
530         }
531         if (flags & BUS_DMA_ZERO)
532                 mflags |= M_ZERO;
533         if (flags & BUS_DMA_NOCACHE)
534                 attr = VM_MEMATTR_UNCACHEABLE;
535         else if ((flags & BUS_DMA_COHERENT) != 0 &&
536             (dmat->bounce_flags & BF_COHERENT) == 0)
537                 /*
538                  * If we have a non-coherent tag, and are trying to allocate
539                  * a coherent block of memory it needs to be uncached.
540                  */
541                 attr = VM_MEMATTR_UNCACHEABLE;
542         else
543                 attr = VM_MEMATTR_DEFAULT;
544
545         /*
546          * Create the map, but don't set the could bounce flag as
547          * this allocation should never bounce;
548          */
549         *mapp = alloc_dmamap(dmat, mflags);
550         if (*mapp == NULL) {
551                 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
552                     __func__, dmat, dmat->common.flags, ENOMEM);
553                 return (ENOMEM);
554         }
555
556         /*
557          * Mark the map as coherent if we used uncacheable memory or the
558          * tag was already marked as coherent.
559          */
560         if (attr == VM_MEMATTR_UNCACHEABLE ||
561             (dmat->bounce_flags & BF_COHERENT) != 0)
562                 (*mapp)->flags |= DMAMAP_COHERENT;
563
564         (*mapp)->flags |= DMAMAP_FROM_DMAMEM;
565
566         /*
567          * Allocate the buffer from the malloc(9) allocator if...
568          *  - It's small enough to fit into a single page.
569          *  - Its alignment requirement is also smaller than the page size.
570          *  - The low address requirement is fulfilled.
571          *  - Default cache attributes are requested (WB).
572          * else allocate non-contiguous pages if...
573          *  - The page count that could get allocated doesn't exceed
574          *    nsegments also when the maximum segment size is less
575          *    than PAGE_SIZE.
576          *  - The alignment constraint isn't larger than a page boundary.
577          *  - There are no boundary-crossing constraints.
578          * else allocate a block of contiguous pages because one or more of the
579          * constraints is something that only the contig allocator can fulfill.
580          *
581          * NOTE: The (dmat->common.alignment <= dmat->maxsize) check
582          * below is just a quick hack. The exact alignment guarantees
583          * of malloc(9) need to be nailed down, and the code below
584          * should be rewritten to take that into account.
585          *
586          * In the meantime warn the user if malloc gets it wrong.
587          */
588         if (dmat->alloc_size <= PAGE_SIZE &&
589             dmat->alloc_alignment <= PAGE_SIZE &&
590             dmat->common.lowaddr >= ptoa((vm_paddr_t)Maxmem) &&
591             attr == VM_MEMATTR_DEFAULT) {
592                 *vaddr = malloc_domainset_aligned(dmat->alloc_size,
593                     dmat->alloc_alignment, M_DEVBUF,
594                     DOMAINSET_PREF(dmat->common.domain), mflags);
595         } else if (dmat->common.nsegments >=
596             howmany(dmat->alloc_size, MIN(dmat->common.maxsegsz, PAGE_SIZE)) &&
597             dmat->alloc_alignment <= PAGE_SIZE &&
598             (dmat->common.boundary % PAGE_SIZE) == 0) {
599                 /* Page-based multi-segment allocations allowed */
600                 *vaddr = kmem_alloc_attr_domainset(
601                     DOMAINSET_PREF(dmat->common.domain), dmat->alloc_size,
602                     mflags, 0ul, dmat->common.lowaddr, attr);
603                 dmat->bounce_flags |= BF_KMEM_ALLOC;
604         } else {
605                 *vaddr = kmem_alloc_contig_domainset(
606                     DOMAINSET_PREF(dmat->common.domain), dmat->alloc_size,
607                     mflags, 0ul, dmat->common.lowaddr,
608                     dmat->alloc_alignment != 0 ? dmat->alloc_alignment : 1ul,
609                     dmat->common.boundary, attr);
610                 dmat->bounce_flags |= BF_KMEM_ALLOC;
611         }
612         if (*vaddr == NULL) {
613                 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
614                     __func__, dmat, dmat->common.flags, ENOMEM);
615                 free(*mapp, M_DEVBUF);
616                 return (ENOMEM);
617         } else if (!vm_addr_align_ok(vtophys(*vaddr), dmat->alloc_alignment)) {
618                 printf("bus_dmamem_alloc failed to align memory properly.\n");
619         }
620         dmat->map_count++;
621         CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d",
622             __func__, dmat, dmat->common.flags, 0);
623         return (0);
624 }
625
626 /*
627  * Free a piece of memory and it's allociated dmamap, that was allocated
628  * via bus_dmamem_alloc.  Make the same choice for free/contigfree.
629  */
630 static void
631 bounce_bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
632 {
633
634         /*
635          * Check the map came from bounce_bus_dmamem_alloc, so the map
636          * should be NULL and the BF_KMEM_ALLOC flag cleared if malloc()
637          * was used and set if kmem_alloc_contig() was used.
638          */
639         if ((map->flags & DMAMAP_FROM_DMAMEM) == 0)
640                 panic("bus_dmamem_free: Invalid map freed\n");
641         if ((dmat->bounce_flags & BF_KMEM_ALLOC) == 0)
642                 free(vaddr, M_DEVBUF);
643         else
644                 kmem_free(vaddr, dmat->alloc_size);
645         free(map, M_DEVBUF);
646         dmat->map_count--;
647         CTR3(KTR_BUSDMA, "%s: tag %p flags 0x%x", __func__, dmat,
648             dmat->bounce_flags);
649 }
650
651 static bool
652 _bus_dmamap_pagesneeded(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t buf,
653     bus_size_t buflen, int *pagesneeded)
654 {
655         bus_addr_t curaddr;
656         bus_size_t sgsize;
657         int count;
658
659         /*
660          * Count the number of bounce pages needed in order to
661          * complete this transfer
662          */
663         count = 0;
664         curaddr = buf;
665         while (buflen != 0) {
666                 sgsize = MIN(buflen, dmat->common.maxsegsz);
667                 if (must_bounce(dmat, map, curaddr, sgsize)) {
668                         sgsize = MIN(sgsize,
669                             PAGE_SIZE - (curaddr & PAGE_MASK));
670                         if (pagesneeded == NULL)
671                                 return (true);
672                         count++;
673                 }
674                 curaddr += sgsize;
675                 buflen -= sgsize;
676         }
677
678         if (pagesneeded != NULL)
679                 *pagesneeded = count;
680         return (count != 0);
681 }
682
683 static void
684 _bus_dmamap_count_phys(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t buf,
685     bus_size_t buflen, int flags)
686 {
687
688         if (map->pagesneeded == 0) {
689                 _bus_dmamap_pagesneeded(dmat, map, buf, buflen,
690                     &map->pagesneeded);
691                 CTR1(KTR_BUSDMA, "pagesneeded= %d\n", map->pagesneeded);
692         }
693 }
694
695 static void
696 _bus_dmamap_count_pages(bus_dma_tag_t dmat, bus_dmamap_t map, pmap_t pmap,
697     void *buf, bus_size_t buflen, int flags)
698 {
699         vm_offset_t vaddr;
700         vm_offset_t vendaddr;
701         bus_addr_t paddr;
702         bus_size_t sg_len;
703
704         if (map->pagesneeded == 0) {
705                 CTR4(KTR_BUSDMA, "lowaddr= %d Maxmem= %d, boundary= %d, "
706                     "alignment= %d", dmat->common.lowaddr,
707                     ptoa((vm_paddr_t)Maxmem),
708                     dmat->common.boundary, dmat->common.alignment);
709                 CTR2(KTR_BUSDMA, "map= %p, pagesneeded= %d", map,
710                     map->pagesneeded);
711                 /*
712                  * Count the number of bounce pages
713                  * needed in order to complete this transfer
714                  */
715                 vaddr = (vm_offset_t)buf;
716                 vendaddr = (vm_offset_t)buf + buflen;
717
718                 while (vaddr < vendaddr) {
719                         sg_len = PAGE_SIZE - ((vm_offset_t)vaddr & PAGE_MASK);
720                         if (pmap == kernel_pmap)
721                                 paddr = pmap_kextract(vaddr);
722                         else
723                                 paddr = pmap_extract(pmap, vaddr);
724                         if (must_bounce(dmat, map, paddr,
725                             min(vendaddr - vaddr, (PAGE_SIZE - ((vm_offset_t)vaddr &
726                             PAGE_MASK)))) != 0) {
727                                 sg_len = roundup2(sg_len,
728                                     dmat->common.alignment);
729                                 map->pagesneeded++;
730                         }
731                         vaddr += sg_len;
732                 }
733                 CTR1(KTR_BUSDMA, "pagesneeded= %d\n", map->pagesneeded);
734         }
735 }
736
737 /*
738  * Add a single contiguous physical range to the segment list.
739  */
740 static bus_size_t
741 _bus_dmamap_addseg(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t curaddr,
742     bus_size_t sgsize, bus_dma_segment_t *segs, int *segp)
743 {
744         int seg;
745
746         /*
747          * Make sure we don't cross any boundaries.
748          */
749         if (!vm_addr_bound_ok(curaddr, sgsize, dmat->common.boundary))
750                 sgsize = roundup2(curaddr, dmat->common.boundary) - curaddr;
751
752         /*
753          * Insert chunk into a segment, coalescing with
754          * previous segment if possible.
755          */
756         seg = *segp;
757         if (seg == -1) {
758                 seg = 0;
759                 segs[seg].ds_addr = curaddr;
760                 segs[seg].ds_len = sgsize;
761         } else {
762                 if (curaddr == segs[seg].ds_addr + segs[seg].ds_len &&
763                     (segs[seg].ds_len + sgsize) <= dmat->common.maxsegsz &&
764                     vm_addr_bound_ok(segs[seg].ds_addr,
765                     segs[seg].ds_len + sgsize, dmat->common.boundary))
766                         segs[seg].ds_len += sgsize;
767                 else {
768                         if (++seg >= dmat->common.nsegments)
769                                 return (0);
770                         segs[seg].ds_addr = curaddr;
771                         segs[seg].ds_len = sgsize;
772                 }
773         }
774         *segp = seg;
775         return (sgsize);
776 }
777
778 /*
779  * Utility function to load a physical buffer.  segp contains
780  * the starting segment on entrace, and the ending segment on exit.
781  */
782 static int
783 bounce_bus_dmamap_load_phys(bus_dma_tag_t dmat, bus_dmamap_t map,
784     vm_paddr_t buf, bus_size_t buflen, int flags, bus_dma_segment_t *segs,
785     int *segp)
786 {
787         struct sync_list *sl;
788         bus_size_t sgsize;
789         bus_addr_t curaddr, sl_end;
790         int error;
791
792         if (segs == NULL)
793                 segs = dmat->segments;
794
795         if (might_bounce(dmat, map, (bus_addr_t)buf, buflen)) {
796                 _bus_dmamap_count_phys(dmat, map, buf, buflen, flags);
797                 if (map->pagesneeded != 0) {
798                         error = _bus_dmamap_reserve_pages(dmat, map, flags);
799                         if (error)
800                                 return (error);
801                 }
802         }
803
804         sl = map->slist + map->sync_count - 1;
805         sl_end = 0;
806
807         while (buflen > 0) {
808                 curaddr = buf;
809                 sgsize = MIN(buflen, dmat->common.maxsegsz);
810                 if (map->pagesneeded != 0 &&
811                     must_bounce(dmat, map, curaddr, sgsize)) {
812                         /*
813                          * The attempt to split a physically continuous buffer
814                          * seems very controversial, it's unclear whether we
815                          * can do this in all cases. Also, memory for bounced
816                          * buffers is allocated as pages, so we cannot
817                          * guarantee multipage alignment.
818                          */
819                         KASSERT(dmat->common.alignment <= PAGE_SIZE,
820                             ("bounced buffer cannot have alignment bigger "
821                             "than PAGE_SIZE: %lu", dmat->common.alignment));
822                         sgsize = MIN(sgsize, PAGE_SIZE - (curaddr & PAGE_MASK));
823                         curaddr = add_bounce_page(dmat, map, 0, curaddr,
824                             sgsize);
825                 } else if ((map->flags & DMAMAP_COHERENT) == 0) {
826                         if (map->sync_count > 0)
827                                 sl_end = sl->paddr + sl->datacount;
828
829                         if (map->sync_count == 0 || curaddr != sl_end) {
830                                 if (++map->sync_count > dmat->common.nsegments)
831                                         break;
832                                 sl++;
833                                 sl->vaddr = 0;
834                                 sl->paddr = curaddr;
835                                 sl->pages = PHYS_TO_VM_PAGE(curaddr);
836                                 KASSERT(sl->pages != NULL,
837                                     ("%s: page at PA:0x%08lx is not in "
838                                     "vm_page_array", __func__, curaddr));
839                                 sl->datacount = sgsize;
840                         } else
841                                 sl->datacount += sgsize;
842                 }
843                 sgsize = _bus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
844                     segp);
845                 if (sgsize == 0)
846                         break;
847                 buf += sgsize;
848                 buflen -= sgsize;
849         }
850
851         /*
852          * Did we fit?
853          */
854         if (buflen != 0) {
855                 bus_dmamap_unload(dmat, map);
856                 return (EFBIG); /* XXX better return value here? */
857         }
858         return (0);
859 }
860
861 /*
862  * Utility function to load a linear buffer.  segp contains
863  * the starting segment on entrace, and the ending segment on exit.
864  */
865 static int
866 bounce_bus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
867     bus_size_t buflen, pmap_t pmap, int flags, bus_dma_segment_t *segs,
868     int *segp)
869 {
870         struct sync_list *sl;
871         bus_size_t sgsize;
872         bus_addr_t curaddr, sl_pend;
873         vm_offset_t kvaddr, vaddr, sl_vend;
874         int error;
875
876         KASSERT((map->flags & DMAMAP_FROM_DMAMEM) != 0 ||
877             dmat->common.alignment <= PAGE_SIZE,
878             ("loading user buffer with alignment bigger than PAGE_SIZE is not "
879             "supported"));
880
881         if (segs == NULL)
882                 segs = dmat->segments;
883
884         if (flags & BUS_DMA_LOAD_MBUF)
885                 map->flags |= DMAMAP_MBUF;
886
887         if (might_bounce(dmat, map, (bus_addr_t)buf, buflen)) {
888                 _bus_dmamap_count_pages(dmat, map, pmap, buf, buflen, flags);
889                 if (map->pagesneeded != 0) {
890                         error = _bus_dmamap_reserve_pages(dmat, map, flags);
891                         if (error)
892                                 return (error);
893                 }
894         }
895
896         /*
897          * XXX Optimally we should parse input buffer for physically
898          * continuous segments first and then pass these segment into
899          * load loop.
900          */
901         sl = map->slist + map->sync_count - 1;
902         vaddr = (vm_offset_t)buf;
903         sl_pend = 0;
904         sl_vend = 0;
905
906         while (buflen > 0) {
907                 /*
908                  * Get the physical address for this segment.
909                  */
910                 if (__predict_true(pmap == kernel_pmap)) {
911                         curaddr = pmap_kextract(vaddr);
912                         kvaddr = vaddr;
913                 } else {
914                         curaddr = pmap_extract(pmap, vaddr);
915                         kvaddr = 0;
916                 }
917
918                 /*
919                  * Compute the segment size, and adjust counts.
920                  */
921                 sgsize = MIN(buflen, dmat->common.maxsegsz);
922                 if ((map->flags & DMAMAP_FROM_DMAMEM) == 0)
923                         sgsize = MIN(sgsize, PAGE_SIZE - (curaddr & PAGE_MASK));
924
925                 if (map->pagesneeded != 0 &&
926                     must_bounce(dmat, map, curaddr, sgsize)) {
927                         /* See comment in bounce_bus_dmamap_load_phys */
928                         KASSERT(dmat->common.alignment <= PAGE_SIZE,
929                             ("bounced buffer cannot have alignment bigger "
930                             "than PAGE_SIZE: %lu", dmat->common.alignment));
931                         curaddr = add_bounce_page(dmat, map, kvaddr, curaddr,
932                             sgsize);
933                 } else if ((map->flags & DMAMAP_COHERENT) == 0) {
934                         if (map->sync_count > 0) {
935                                 sl_pend = sl->paddr + sl->datacount;
936                                 sl_vend = sl->vaddr + sl->datacount;
937                         }
938
939                         if (map->sync_count == 0 ||
940                             (kvaddr != 0 && kvaddr != sl_vend) ||
941                             (curaddr != sl_pend)) {
942                                 if (++map->sync_count > dmat->common.nsegments)
943                                         break;
944                                 sl++;
945                                 sl->vaddr = kvaddr;
946                                 sl->paddr = curaddr;
947                                 if (kvaddr != 0) {
948                                         sl->pages = NULL;
949                                 } else {
950                                         sl->pages = PHYS_TO_VM_PAGE(curaddr);
951                                         KASSERT(sl->pages != NULL,
952                                             ("%s: page at PA:0x%08lx is not "
953                                             "in vm_page_array", __func__,
954                                             curaddr));
955                                 }
956                                 sl->datacount = sgsize;
957                         } else
958                                 sl->datacount += sgsize;
959                 }
960                 sgsize = _bus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
961                     segp);
962                 if (sgsize == 0)
963                         break;
964                 vaddr += sgsize;
965                 buflen -= sgsize;
966         }
967
968         /*
969          * Did we fit?
970          */
971         if (buflen != 0) {
972                 bus_dmamap_unload(dmat, map);
973                 return (EFBIG); /* XXX better return value here? */
974         }
975         return (0);
976 }
977
978 static void
979 bounce_bus_dmamap_waitok(bus_dma_tag_t dmat, bus_dmamap_t map,
980     struct memdesc *mem, bus_dmamap_callback_t *callback, void *callback_arg)
981 {
982
983         map->mem = *mem;
984         map->dmat = dmat;
985         map->callback = callback;
986         map->callback_arg = callback_arg;
987 }
988
989 static bus_dma_segment_t *
990 bounce_bus_dmamap_complete(bus_dma_tag_t dmat, bus_dmamap_t map,
991     bus_dma_segment_t *segs, int nsegs, int error)
992 {
993
994         if (segs == NULL)
995                 segs = dmat->segments;
996         return (segs);
997 }
998
999 /*
1000  * Release the mapping held by map.
1001  */
1002 static void
1003 bounce_bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
1004 {
1005         free_bounce_pages(dmat, map);
1006         map->sync_count = 0;
1007         map->flags &= ~DMAMAP_MBUF;
1008 }
1009
1010 static void
1011 dma_preread_safe(vm_offset_t va, vm_size_t size)
1012 {
1013         /*
1014          * Write back any partial cachelines immediately before and
1015          * after the DMA region.
1016          */
1017         if (va & (dcache_line_size - 1))
1018                 cpu_dcache_wb_range(va, 1);
1019         if ((va + size) & (dcache_line_size - 1))
1020                 cpu_dcache_wb_range(va + size, 1);
1021
1022         cpu_dcache_inv_range(va, size);
1023 }
1024
1025 static void
1026 dma_dcache_sync(struct sync_list *sl, bus_dmasync_op_t op)
1027 {
1028         uint32_t len, offset;
1029         vm_page_t m;
1030         vm_paddr_t pa;
1031         vm_offset_t va, tempva;
1032         bus_size_t size;
1033
1034         offset = sl->paddr & PAGE_MASK;
1035         m = sl->pages;
1036         size = sl->datacount;
1037         pa = sl->paddr;
1038
1039         for ( ; size != 0; size -= len, pa += len, offset = 0, ++m) {
1040                 tempva = 0;
1041                 if (sl->vaddr == 0) {
1042                         len = min(PAGE_SIZE - offset, size);
1043                         tempva = pmap_quick_enter_page(m);
1044                         va = tempva | offset;
1045                         KASSERT(pa == (VM_PAGE_TO_PHYS(m) | offset),
1046                             ("unexpected vm_page_t phys: 0x%16lx != 0x%16lx",
1047                             VM_PAGE_TO_PHYS(m) | offset, pa));
1048                 } else {
1049                         len = sl->datacount;
1050                         va = sl->vaddr;
1051                 }
1052
1053                 switch (op) {
1054                 case BUS_DMASYNC_PREWRITE:
1055                 case BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD:
1056                         cpu_dcache_wb_range(va, len);
1057                         break;
1058                 case BUS_DMASYNC_PREREAD:
1059                         /*
1060                          * An mbuf may start in the middle of a cacheline. There
1061                          * will be no cpu writes to the beginning of that line
1062                          * (which contains the mbuf header) while dma is in
1063                          * progress.  Handle that case by doing a writeback of
1064                          * just the first cacheline before invalidating the
1065                          * overall buffer.  Any mbuf in a chain may have this
1066                          * misalignment.  Buffers which are not mbufs bounce if
1067                          * they are not aligned to a cacheline.
1068                          */
1069                         dma_preread_safe(va, len);
1070                         break;
1071                 case BUS_DMASYNC_POSTREAD:
1072                 case BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE:
1073                         cpu_dcache_inv_range(va, len);
1074                         break;
1075                 default:
1076                         panic("unsupported combination of sync operations: "
1077                               "0x%08x\n", op);
1078                 }
1079
1080                 if (tempva != 0)
1081                         pmap_quick_remove_page(tempva);
1082         }
1083 }
1084
1085 static void
1086 bounce_bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map,
1087     bus_dmasync_op_t op)
1088 {
1089         struct bounce_page *bpage;
1090         struct sync_list *sl, *end;
1091         vm_offset_t datavaddr, tempvaddr;
1092
1093         if (op == BUS_DMASYNC_POSTWRITE)
1094                 return;
1095
1096         if ((op & BUS_DMASYNC_POSTREAD) != 0) {
1097                 /*
1098                  * Wait for any DMA operations to complete before the bcopy.
1099                  */
1100                 dsb(sy);
1101         }
1102
1103         if ((bpage = STAILQ_FIRST(&map->bpages)) != NULL) {
1104                 CTR4(KTR_BUSDMA, "%s: tag %p tag flags 0x%x op 0x%x "
1105                     "performing bounce", __func__, dmat, dmat->common.flags,
1106                     op);
1107
1108                 if ((op & BUS_DMASYNC_PREWRITE) != 0) {
1109                         while (bpage != NULL) {
1110                                 tempvaddr = 0;
1111                                 datavaddr = bpage->datavaddr;
1112                                 if (datavaddr == 0) {
1113                                         tempvaddr = pmap_quick_enter_page(
1114                                             bpage->datapage);
1115                                         datavaddr = tempvaddr | bpage->dataoffs;
1116                                 }
1117
1118                                 bcopy((void *)datavaddr,
1119                                     (void *)bpage->vaddr, bpage->datacount);
1120                                 if (tempvaddr != 0)
1121                                         pmap_quick_remove_page(tempvaddr);
1122                                 if ((map->flags & DMAMAP_COHERENT) == 0)
1123                                         cpu_dcache_wb_range(bpage->vaddr,
1124                                             bpage->datacount);
1125                                 bpage = STAILQ_NEXT(bpage, links);
1126                         }
1127                         dmat->bounce_zone->total_bounced++;
1128                 } else if ((op & BUS_DMASYNC_PREREAD) != 0) {
1129                         while (bpage != NULL) {
1130                                 if ((map->flags & DMAMAP_COHERENT) == 0)
1131                                         cpu_dcache_wbinv_range(bpage->vaddr,
1132                                             bpage->datacount);
1133                                 bpage = STAILQ_NEXT(bpage, links);
1134                         }
1135                 }
1136
1137                 if ((op & BUS_DMASYNC_POSTREAD) != 0) {
1138                         while (bpage != NULL) {
1139                                 if ((map->flags & DMAMAP_COHERENT) == 0)
1140                                         cpu_dcache_inv_range(bpage->vaddr,
1141                                             bpage->datacount);
1142                                 tempvaddr = 0;
1143                                 datavaddr = bpage->datavaddr;
1144                                 if (datavaddr == 0) {
1145                                         tempvaddr = pmap_quick_enter_page(
1146                                             bpage->datapage);
1147                                         datavaddr = tempvaddr | bpage->dataoffs;
1148                                 }
1149
1150                                 bcopy((void *)bpage->vaddr,
1151                                     (void *)datavaddr, bpage->datacount);
1152
1153                                 if (tempvaddr != 0)
1154                                         pmap_quick_remove_page(tempvaddr);
1155                                 bpage = STAILQ_NEXT(bpage, links);
1156                         }
1157                         dmat->bounce_zone->total_bounced++;
1158                 }
1159         }
1160
1161         /*
1162          * Cache maintenance for normal (non-COHERENT non-bounce) buffers.
1163          */
1164         if (map->sync_count != 0) {
1165                 sl = &map->slist[0];
1166                 end = &map->slist[map->sync_count];
1167                 CTR3(KTR_BUSDMA, "%s: tag %p op 0x%x "
1168                     "performing sync", __func__, dmat, op);
1169
1170                 for ( ; sl != end; ++sl)
1171                         dma_dcache_sync(sl, op);
1172         }
1173
1174         if ((op & (BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE)) != 0) {
1175                 /*
1176                  * Wait for the bcopy to complete before any DMA operations.
1177                  */
1178                 dsb(sy);
1179         }
1180 }
1181
1182 struct bus_dma_impl bus_dma_bounce_impl = {
1183         .tag_create = bounce_bus_dma_tag_create,
1184         .tag_destroy = bounce_bus_dma_tag_destroy,
1185         .tag_set_domain = bounce_bus_dma_tag_set_domain,
1186         .id_mapped = bounce_bus_dma_id_mapped,
1187         .map_create = bounce_bus_dmamap_create,
1188         .map_destroy = bounce_bus_dmamap_destroy,
1189         .mem_alloc = bounce_bus_dmamem_alloc,
1190         .mem_free = bounce_bus_dmamem_free,
1191         .load_phys = bounce_bus_dmamap_load_phys,
1192         .load_buffer = bounce_bus_dmamap_load_buffer,
1193         .load_ma = bus_dmamap_load_ma_triv,
1194         .map_waitok = bounce_bus_dmamap_waitok,
1195         .map_complete = bounce_bus_dmamap_complete,
1196         .map_unload = bounce_bus_dmamap_unload,
1197         .map_sync = bounce_bus_dmamap_sync
1198 };