2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2012 EMC Corp.
7 * Copyright (c) 1997, 1998 Justin T. Gibbs.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
34 #include "opt_iommu.h"
36 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/callout.h>
42 #include <sys/limits.h>
45 #include <sys/memdesc.h>
46 #include <sys/mutex.h>
51 #include <vm/vm_page.h>
52 #include <vm/vm_map.h>
55 #include <opencrypto/cryptodev.h>
57 #include <machine/bus.h>
60 * Convenience function for manipulating driver locks from busdma (during
61 * busdma_swi, for example).
64 busdma_lock_mutex(void *arg, bus_dma_lock_op_t op)
68 dmtx = (struct mtx *)arg;
77 panic("Unknown operation 0x%x for busdma_lock_mutex!", op);
82 * dflt_lock should never get called. It gets put into the dma tag when
83 * lockfunc == NULL, which is only valid if the maps that are associated
84 * with the tag are meant to never be deferred.
86 * XXX Should have a way to identify which driver is responsible here.
89 _busdma_dflt_lock(void *arg, bus_dma_lock_op_t op)
92 panic("driver error: _bus_dma_dflt_lock called");
97 * Load up data starting at offset within a region specified by a
98 * list of virtual address ranges until either length or the region
102 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map,
103 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs,
104 int flags, size_t offset, size_t length)
109 for (; sglist_cnt > 0 && length != 0; sglist_cnt--, list++) {
113 KASSERT((offset < list->ds_len),
114 ("Invalid mid-segment offset"));
115 addr = (char *)(uintptr_t)list->ds_addr + offset;
116 ds_len = list->ds_len - offset;
121 KASSERT((ds_len != 0), ("Segment length is zero"));
122 error = _bus_dmamap_load_buffer(dmat, map, addr, ds_len, pmap,
131 * Load a list of physical addresses.
134 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map,
135 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags)
140 for (; sglist_cnt > 0; sglist_cnt--, list++) {
141 error = _bus_dmamap_load_phys(dmat, map,
142 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL,
151 * Load an unmapped mbuf
154 _bus_dmamap_load_mbuf_epg(bus_dma_tag_t dmat, bus_dmamap_t map,
155 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
157 int error, i, off, len, pglen, pgoff, seglen, segoff;
164 /* Skip over any data removed from the front. */
165 off = mtod(m, vm_offset_t);
167 if (m->m_epg_hdrlen != 0) {
168 if (off >= m->m_epg_hdrlen) {
169 off -= m->m_epg_hdrlen;
171 seglen = m->m_epg_hdrlen - off;
173 seglen = min(seglen, len);
176 error = _bus_dmamap_load_buffer(dmat, map,
177 &m->m_epg_hdr[segoff], seglen, kernel_pmap,
181 pgoff = m->m_epg_1st_off;
182 for (i = 0; i < m->m_epg_npgs && error == 0 && len > 0; i++) {
183 pglen = m_epg_pagelen(m, i, pgoff);
189 seglen = pglen - off;
190 segoff = pgoff + off;
192 seglen = min(seglen, len);
194 error = _bus_dmamap_load_phys(dmat, map,
195 m->m_epg_pa[i] + segoff, seglen, flags, segs, nsegs);
198 if (len != 0 && error == 0) {
199 KASSERT((off + len) <= m->m_epg_trllen,
200 ("off + len > trail (%d + %d > %d)", off, len,
202 error = _bus_dmamap_load_buffer(dmat, map,
203 &m->m_epg_trail[off], len, kernel_pmap, flags, segs,
210 * Load a single mbuf.
213 _bus_dmamap_load_single_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
214 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
219 if ((m->m_flags & M_EXTPG) != 0)
220 error = _bus_dmamap_load_mbuf_epg(dmat, map, m, segs, nsegs,
223 error = _bus_dmamap_load_buffer(dmat, map, m->m_data, m->m_len,
224 kernel_pmap, flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
225 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
226 __func__, dmat, flags, error, *nsegs);
231 * Load an mbuf chain.
234 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
235 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
241 for (m = m0; m != NULL && error == 0; m = m->m_next) {
243 if ((m->m_flags & M_EXTPG) != 0)
244 error = _bus_dmamap_load_mbuf_epg(dmat,
245 map, m, segs, nsegs, flags);
247 error = _bus_dmamap_load_buffer(dmat, map,
248 m->m_data, m->m_len, kernel_pmap,
249 flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
252 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
253 __func__, dmat, flags, error, *nsegs);
258 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
259 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
260 bus_dma_segment_t *segs, int *segp)
267 for (i = 0; tlen > 0; i++, tlen -= len) {
268 len = min(PAGE_SIZE - ma_offs, tlen);
269 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
270 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
283 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
284 int *nsegs, int flags)
293 if (uio->uio_segflg == UIO_USERSPACE) {
294 KASSERT(uio->uio_td != NULL,
295 ("bus_dmamap_load_uio: USERSPACE but no proc"));
296 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
299 resid = uio->uio_resid;
303 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
305 * Now at the first iovec to load. Load each iovec
306 * until we have exhausted the residual count.
309 addr = (caddr_t) iov[i].iov_base;
310 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
312 error = _bus_dmamap_load_buffer(dmat, map, addr,
313 minlen, pmap, flags, NULL, nsegs);
322 * Map the buffer buf into bus space using the dmamap map.
325 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
326 bus_size_t buflen, bus_dmamap_callback_t *callback,
327 void *callback_arg, int flags)
329 bus_dma_segment_t *segs;
335 mem = memdesc_vaddr(buf, buflen);
336 _bus_dmamap_load_kmsan(dmat, map, &mem);
339 if ((flags & BUS_DMA_NOWAIT) == 0) {
340 mem = memdesc_vaddr(buf, buflen);
341 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
345 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
346 flags, NULL, &nsegs);
349 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
350 __func__, dmat, flags, error, nsegs);
352 if (error == EINPROGRESS)
355 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
357 (*callback)(callback_arg, segs, 0, error);
359 (*callback)(callback_arg, segs, nsegs, 0);
362 * Return ENOMEM to the caller so that it can pass it up the stack.
363 * This error only happens when NOWAIT is set, so deferral is disabled.
372 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
373 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
375 bus_dma_segment_t *segs;
381 struct memdesc mem = memdesc_mbuf(m0);
382 _bus_dmamap_load_kmsan(dmat, map, &mem);
385 flags |= BUS_DMA_NOWAIT;
387 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
390 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
392 (*callback)(callback_arg, segs, 0, 0, error);
394 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
396 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
397 __func__, dmat, flags, error, nsegs);
402 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
403 bus_dma_segment_t *segs, int *nsegs, int flags)
408 struct memdesc mem = memdesc_mbuf(m0);
409 _bus_dmamap_load_kmsan(dmat, map, &mem);
412 flags |= BUS_DMA_NOWAIT;
414 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
416 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
421 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
422 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
424 bus_dma_segment_t *segs;
428 struct memdesc mem = memdesc_uio(uio);
429 _bus_dmamap_load_kmsan(dmat, map, &mem);
432 flags |= BUS_DMA_NOWAIT;
434 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
437 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
439 (*callback)(callback_arg, segs, 0, 0, error);
441 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
443 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
444 __func__, dmat, flags, error, nsegs);
449 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
450 bus_dmamap_callback_t *callback, void *callback_arg,
455 mem = memdesc_bio(bio);
456 return (bus_dmamap_load_mem(dmat, map, &mem, callback, callback_arg,
461 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
462 struct memdesc *mem, bus_dmamap_callback_t *callback,
463 void *callback_arg, int flags)
465 bus_dma_segment_t *segs;
470 _bus_dmamap_load_kmsan(dmat, map, mem);
473 if ((flags & BUS_DMA_NOWAIT) == 0)
474 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
478 switch (mem->md_type) {
480 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
481 mem->md_len, kernel_pmap, flags, NULL, &nsegs);
484 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
485 mem->md_len, flags, NULL, &nsegs);
488 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
489 mem->md_nseg, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
492 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
493 mem->md_nseg, &nsegs, flags);
496 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
500 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
501 NULL, &nsegs, flags);
503 case MEMDESC_VMPAGES:
504 error = _bus_dmamap_load_ma(dmat, map, mem->u.md_ma,
505 mem->md_len, mem->md_offset, flags, NULL, &nsegs);
510 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
511 __func__, dmat, flags, error, nsegs);
513 if (error == EINPROGRESS)
516 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
518 (*callback)(callback_arg, segs, 0, error);
520 (*callback)(callback_arg, segs, nsegs, 0);
523 * Return ENOMEM to the caller so that it can pass it up the stack.
524 * This error only happens when NOWAIT is set, so deferral is disabled.
533 bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map,
534 struct crypto_buffer *cb, bus_dmamap_callback_t *callback,
535 void *callback_arg, int flags)
537 bus_dma_segment_t *segs;
541 flags |= BUS_DMA_NOWAIT;
544 switch (cb->cb_type) {
545 case CRYPTO_BUF_CONTIG:
546 error = _bus_dmamap_load_buffer(dmat, map, cb->cb_buf,
547 cb->cb_buf_len, kernel_pmap, flags, NULL, &nsegs);
549 case CRYPTO_BUF_MBUF:
550 error = _bus_dmamap_load_mbuf_sg(dmat, map, cb->cb_mbuf,
551 NULL, &nsegs, flags);
553 case CRYPTO_BUF_SINGLE_MBUF:
554 error = _bus_dmamap_load_single_mbuf(dmat, map, cb->cb_mbuf,
555 NULL, &nsegs, flags);
558 error = _bus_dmamap_load_uio(dmat, map, cb->cb_uio, &nsegs,
561 case CRYPTO_BUF_VMPAGE:
562 error = _bus_dmamap_load_ma(dmat, map, cb->cb_vm_page,
563 cb->cb_vm_page_len, cb->cb_vm_page_offset, flags, NULL,
571 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
572 __func__, dmat, flags, error, nsegs);
574 if (error == EINPROGRESS)
577 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
579 (*callback)(callback_arg, segs, 0, error);
581 (*callback)(callback_arg, segs, nsegs, 0);
584 * Return ENOMEM to the caller so that it can pass it up the stack.
585 * This error only happens when NOWAIT is set, so deferral is disabled.
594 bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, struct cryptop *crp,
595 bus_dmamap_callback_t *callback, void *callback_arg, int flags)
597 return (bus_dmamap_load_crp_buffer(dmat, map, &crp->crp_buf, callback,
598 callback_arg, flags));
602 bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent)
611 t->lowaddr = t->highaddr = BUS_SPACE_MAXADDR;
612 t->maxsize = t->maxsegsize = BUS_SPACE_MAXSIZE;
613 t->nsegments = BUS_SPACE_UNRESTRICTED;
615 t->lockfuncarg = NULL;
620 bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat)
623 if (t == NULL || dmat == NULL)
626 return (bus_dma_tag_create(t->parent, t->alignment, t->boundary,
627 t->lowaddr, t->highaddr, NULL, NULL, t->maxsize,
628 t->nsegments, t->maxsegsize, t->flags, t->lockfunc, t->lockfuncarg,
633 bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, u_int count)
635 bus_dma_param_t *pkv;
640 case BD_PARAM_PARENT:
641 t->parent = pkv->ptr;
643 case BD_PARAM_ALIGNMENT:
644 t->alignment = pkv->num;
646 case BD_PARAM_BOUNDARY:
647 t->boundary = pkv->num;
649 case BD_PARAM_LOWADDR:
650 t->lowaddr = pkv->pa;
652 case BD_PARAM_HIGHADDR:
653 t->highaddr = pkv->pa;
655 case BD_PARAM_MAXSIZE:
656 t->maxsize = pkv->num;
658 case BD_PARAM_NSEGMENTS:
659 t->nsegments = pkv->num;
661 case BD_PARAM_MAXSEGSIZE:
662 t->maxsegsize = pkv->num;
667 case BD_PARAM_LOCKFUNC:
668 t->lockfunc = pkv->ptr;
670 case BD_PARAM_LOCKFUNCARG:
671 t->lockfuncarg = pkv->ptr;
676 case BD_PARAM_INVALID:
678 KASSERT(0, ("Invalid key %d\n", pkv->key));
686 bool bus_dma_iommu_set_buswide(device_t dev);
687 int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
688 vm_paddr_t start, vm_size_t length, int flags);
691 bus_dma_iommu_set_buswide(device_t dev)
697 bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
698 vm_paddr_t start, vm_size_t length, int flags)