2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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>
33 __FBSDID("$FreeBSD$");
36 #include "opt_iommu.h"
38 #include <sys/param.h>
40 #include <sys/systm.h>
43 #include <sys/callout.h>
46 #include <sys/memdesc.h>
51 #include <vm/vm_page.h>
52 #include <vm/vm_map.h>
56 #include <cam/cam_ccb.h>
58 #include <opencrypto/cryptodev.h>
60 #include <machine/bus.h>
63 * Load up data starting at offset within a region specified by a
64 * list of virtual address ranges until either length or the region
68 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map,
69 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs,
70 int flags, size_t offset, size_t length)
75 for (; sglist_cnt > 0 && length != 0; sglist_cnt--, list++) {
79 KASSERT((offset < list->ds_len),
80 ("Invalid mid-segment offset"));
81 addr = (char *)(uintptr_t)list->ds_addr + offset;
82 ds_len = list->ds_len - offset;
87 KASSERT((ds_len != 0), ("Segment length is zero"));
88 error = _bus_dmamap_load_buffer(dmat, map, addr, ds_len, pmap,
97 * Load a list of physical addresses.
100 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map,
101 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags)
106 for (; sglist_cnt > 0; sglist_cnt--, list++) {
107 error = _bus_dmamap_load_phys(dmat, map,
108 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL,
117 * Load an unmapped mbuf
120 _bus_dmamap_load_mbuf_epg(bus_dma_tag_t dmat, bus_dmamap_t map,
121 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
123 int error, i, off, len, pglen, pgoff, seglen, segoff;
130 /* Skip over any data removed from the front. */
131 off = mtod(m, vm_offset_t);
133 if (m->m_epg_hdrlen != 0) {
134 if (off >= m->m_epg_hdrlen) {
135 off -= m->m_epg_hdrlen;
137 seglen = m->m_epg_hdrlen - off;
139 seglen = min(seglen, len);
142 error = _bus_dmamap_load_buffer(dmat, map,
143 &m->m_epg_hdr[segoff], seglen, kernel_pmap,
147 pgoff = m->m_epg_1st_off;
148 for (i = 0; i < m->m_epg_npgs && error == 0 && len > 0; i++) {
149 pglen = m_epg_pagelen(m, i, pgoff);
155 seglen = pglen - off;
156 segoff = pgoff + off;
158 seglen = min(seglen, len);
160 error = _bus_dmamap_load_phys(dmat, map,
161 m->m_epg_pa[i] + segoff, seglen, flags, segs, nsegs);
164 if (len != 0 && error == 0) {
165 KASSERT((off + len) <= m->m_epg_trllen,
166 ("off + len > trail (%d + %d > %d)", off, len,
168 error = _bus_dmamap_load_buffer(dmat, map,
169 &m->m_epg_trail[off], len, kernel_pmap, flags, segs,
176 * Load a single mbuf.
179 _bus_dmamap_load_single_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
180 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
185 if ((m->m_flags & M_EXTPG) != 0)
186 error = _bus_dmamap_load_mbuf_epg(dmat, map, m, segs, nsegs,
189 error = _bus_dmamap_load_buffer(dmat, map, m->m_data, m->m_len,
190 kernel_pmap, flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
191 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
192 __func__, dmat, flags, error, *nsegs);
197 * Load an mbuf chain.
200 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
201 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
207 for (m = m0; m != NULL && error == 0; m = m->m_next) {
209 if ((m->m_flags & M_EXTPG) != 0)
210 error = _bus_dmamap_load_mbuf_epg(dmat,
211 map, m, segs, nsegs, flags);
213 error = _bus_dmamap_load_buffer(dmat, map,
214 m->m_data, m->m_len, kernel_pmap,
215 flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
218 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
219 __func__, dmat, flags, error, *nsegs);
224 * Load from block io.
227 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
228 int *nsegs, int flags)
231 if ((bio->bio_flags & BIO_VLIST) != 0) {
232 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
233 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
234 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
238 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
239 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
240 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
242 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
243 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
247 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
248 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
249 bus_dma_segment_t *segs, int *segp)
256 for (i = 0; tlen > 0; i++, tlen -= len) {
257 len = min(PAGE_SIZE - ma_offs, tlen);
258 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
259 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
269 * Load a cam control block.
272 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
273 int *nsegs, int flags)
275 struct ccb_hdr *ccb_h;
283 switch (ccb_h->func_code) {
285 struct ccb_scsiio *csio;
288 data_ptr = csio->data_ptr;
289 dxfer_len = csio->dxfer_len;
290 sglist_cnt = csio->sglist_cnt;
293 case XPT_CONT_TARGET_IO: {
294 struct ccb_scsiio *ctio;
297 data_ptr = ctio->data_ptr;
298 dxfer_len = ctio->dxfer_len;
299 sglist_cnt = ctio->sglist_cnt;
303 struct ccb_ataio *ataio;
306 data_ptr = ataio->data_ptr;
307 dxfer_len = ataio->dxfer_len;
312 case XPT_NVME_ADMIN: {
313 struct ccb_nvmeio *nvmeio;
315 nvmeio = &ccb->nvmeio;
316 data_ptr = nvmeio->data_ptr;
317 dxfer_len = nvmeio->dxfer_len;
318 sglist_cnt = nvmeio->sglist_cnt;
322 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
326 switch ((ccb_h->flags & CAM_DATA_MASK)) {
328 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
329 kernel_pmap, flags, NULL, nsegs);
332 error = _bus_dmamap_load_phys(dmat, map,
333 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
337 error = _bus_dmamap_load_vlist(dmat, map,
338 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
339 nsegs, flags, 0, dxfer_len);
341 case CAM_DATA_SG_PADDR:
342 error = _bus_dmamap_load_plist(dmat, map,
343 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
346 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
350 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
360 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
361 int *nsegs, int flags)
370 if (uio->uio_segflg == UIO_USERSPACE) {
371 KASSERT(uio->uio_td != NULL,
372 ("bus_dmamap_load_uio: USERSPACE but no proc"));
373 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
376 resid = uio->uio_resid;
380 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
382 * Now at the first iovec to load. Load each iovec
383 * until we have exhausted the residual count.
386 addr = (caddr_t) iov[i].iov_base;
387 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
389 error = _bus_dmamap_load_buffer(dmat, map, addr,
390 minlen, pmap, flags, NULL, nsegs);
399 * Map the buffer buf into bus space using the dmamap map.
402 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
403 bus_size_t buflen, bus_dmamap_callback_t *callback,
404 void *callback_arg, int flags)
406 bus_dma_segment_t *segs;
412 mem = memdesc_vaddr(buf, buflen);
413 _bus_dmamap_load_kmsan(dmat, map, &mem);
416 if ((flags & BUS_DMA_NOWAIT) == 0) {
417 mem = memdesc_vaddr(buf, buflen);
418 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
422 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
423 flags, NULL, &nsegs);
426 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
427 __func__, dmat, flags, error, nsegs);
429 if (error == EINPROGRESS)
432 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
434 (*callback)(callback_arg, segs, 0, error);
436 (*callback)(callback_arg, segs, nsegs, 0);
439 * Return ENOMEM to the caller so that it can pass it up the stack.
440 * This error only happens when NOWAIT is set, so deferral is disabled.
449 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
450 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
452 bus_dma_segment_t *segs;
458 struct memdesc mem = memdesc_mbuf(m0);
459 _bus_dmamap_load_kmsan(dmat, map, &mem);
462 flags |= BUS_DMA_NOWAIT;
464 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
467 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
469 (*callback)(callback_arg, segs, 0, 0, error);
471 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
473 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
474 __func__, dmat, flags, error, nsegs);
479 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
480 bus_dma_segment_t *segs, int *nsegs, int flags)
485 struct memdesc mem = memdesc_mbuf(m0);
486 _bus_dmamap_load_kmsan(dmat, map, &mem);
489 flags |= BUS_DMA_NOWAIT;
491 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
493 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
498 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
499 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
501 bus_dma_segment_t *segs;
505 struct memdesc mem = memdesc_uio(uio);
506 _bus_dmamap_load_kmsan(dmat, map, &mem);
509 flags |= BUS_DMA_NOWAIT;
511 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
514 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
516 (*callback)(callback_arg, segs, 0, 0, error);
518 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
520 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
521 __func__, dmat, flags, error, nsegs);
526 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
527 bus_dmamap_callback_t *callback, void *callback_arg,
530 bus_dma_segment_t *segs;
531 struct ccb_hdr *ccb_h;
537 mem = memdesc_ccb(ccb);
538 _bus_dmamap_load_kmsan(dmat, map, &mem);
542 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
543 callback(callback_arg, NULL, 0, 0);
546 if ((flags & BUS_DMA_NOWAIT) == 0) {
547 mem = memdesc_ccb(ccb);
548 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
551 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
554 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
555 __func__, dmat, flags, error, nsegs);
557 if (error == EINPROGRESS)
560 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
562 (*callback)(callback_arg, segs, 0, error);
564 (*callback)(callback_arg, segs, nsegs, error);
566 * Return ENOMEM to the caller so that it can pass it up the stack.
567 * This error only happens when NOWAIT is set, so deferral is disabled.
576 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
577 bus_dmamap_callback_t *callback, void *callback_arg,
580 bus_dma_segment_t *segs;
586 mem = memdesc_bio(bio);
587 _bus_dmamap_load_kmsan(dmat, map, &mem);
590 if ((flags & BUS_DMA_NOWAIT) == 0) {
591 mem = memdesc_bio(bio);
592 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
595 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
598 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
599 __func__, dmat, flags, error, nsegs);
601 if (error == EINPROGRESS)
604 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
606 (*callback)(callback_arg, segs, 0, error);
608 (*callback)(callback_arg, segs, nsegs, error);
610 * Return ENOMEM to the caller so that it can pass it up the stack.
611 * This error only happens when NOWAIT is set, so deferral is disabled.
620 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
621 struct memdesc *mem, bus_dmamap_callback_t *callback,
622 void *callback_arg, int flags)
624 bus_dma_segment_t *segs;
629 _bus_dmamap_load_kmsan(dmat, map, mem);
632 if ((flags & BUS_DMA_NOWAIT) == 0)
633 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
637 switch (mem->md_type) {
639 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
640 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
643 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
644 mem->md_opaque, flags, NULL, &nsegs);
647 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
648 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
651 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
652 mem->md_opaque, &nsegs, flags);
655 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
659 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
663 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
664 NULL, &nsegs, flags);
667 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
673 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
674 __func__, dmat, flags, error, nsegs);
676 if (error == EINPROGRESS)
679 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
681 (*callback)(callback_arg, segs, 0, error);
683 (*callback)(callback_arg, segs, nsegs, 0);
686 * Return ENOMEM to the caller so that it can pass it up the stack.
687 * This error only happens when NOWAIT is set, so deferral is disabled.
696 bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map,
697 struct crypto_buffer *cb, bus_dmamap_callback_t *callback,
698 void *callback_arg, int flags)
700 bus_dma_segment_t *segs;
704 flags |= BUS_DMA_NOWAIT;
707 switch (cb->cb_type) {
708 case CRYPTO_BUF_CONTIG:
709 error = _bus_dmamap_load_buffer(dmat, map, cb->cb_buf,
710 cb->cb_buf_len, kernel_pmap, flags, NULL, &nsegs);
712 case CRYPTO_BUF_MBUF:
713 error = _bus_dmamap_load_mbuf_sg(dmat, map, cb->cb_mbuf,
714 NULL, &nsegs, flags);
716 case CRYPTO_BUF_SINGLE_MBUF:
717 error = _bus_dmamap_load_single_mbuf(dmat, map, cb->cb_mbuf,
718 NULL, &nsegs, flags);
721 error = _bus_dmamap_load_uio(dmat, map, cb->cb_uio, &nsegs,
724 case CRYPTO_BUF_VMPAGE:
725 error = _bus_dmamap_load_ma(dmat, map, cb->cb_vm_page,
726 cb->cb_vm_page_len, cb->cb_vm_page_offset, flags, NULL,
734 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
735 __func__, dmat, flags, error, nsegs);
737 if (error == EINPROGRESS)
740 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
742 (*callback)(callback_arg, segs, 0, error);
744 (*callback)(callback_arg, segs, nsegs, 0);
747 * Return ENOMEM to the caller so that it can pass it up the stack.
748 * This error only happens when NOWAIT is set, so deferral is disabled.
757 bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, struct cryptop *crp,
758 bus_dmamap_callback_t *callback, void *callback_arg, int flags)
760 return (bus_dmamap_load_crp_buffer(dmat, map, &crp->crp_buf, callback,
761 callback_arg, flags));
765 bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent)
774 t->lowaddr = t->highaddr = BUS_SPACE_MAXADDR;
775 t->maxsize = t->maxsegsize = BUS_SPACE_MAXSIZE;
776 t->nsegments = BUS_SPACE_UNRESTRICTED;
778 t->lockfuncarg = NULL;
783 bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat)
786 if (t == NULL || dmat == NULL)
789 return (bus_dma_tag_create(t->parent, t->alignment, t->boundary,
790 t->lowaddr, t->highaddr, NULL, NULL, t->maxsize,
791 t->nsegments, t->maxsegsize, t->flags, t->lockfunc, t->lockfuncarg,
796 bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, u_int count)
798 bus_dma_param_t *pkv;
803 case BD_PARAM_PARENT:
804 t->parent = pkv->ptr;
806 case BD_PARAM_ALIGNMENT:
807 t->alignment = pkv->num;
809 case BD_PARAM_BOUNDARY:
810 t->boundary = pkv->num;
812 case BD_PARAM_LOWADDR:
813 t->lowaddr = pkv->pa;
815 case BD_PARAM_HIGHADDR:
816 t->highaddr = pkv->pa;
818 case BD_PARAM_MAXSIZE:
819 t->maxsize = pkv->num;
821 case BD_PARAM_NSEGMENTS:
822 t->nsegments = pkv->num;
824 case BD_PARAM_MAXSEGSIZE:
825 t->maxsegsize = pkv->num;
830 case BD_PARAM_LOCKFUNC:
831 t->lockfunc = pkv->ptr;
833 case BD_PARAM_LOCKFUNCARG:
834 t->lockfuncarg = pkv->ptr;
839 case BD_PARAM_INVALID:
841 KASSERT(0, ("Invalid key %d\n", pkv->key));
849 bool bus_dma_iommu_set_buswide(device_t dev);
850 int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
851 vm_paddr_t start, vm_size_t length, int flags);
854 bus_dma_iommu_set_buswide(device_t dev)
860 bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
861 vm_paddr_t start, vm_size_t length, int flags)