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;
411 if ((flags & BUS_DMA_NOWAIT) == 0) {
412 mem = memdesc_vaddr(buf, buflen);
413 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
417 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
418 flags, NULL, &nsegs);
421 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
422 __func__, dmat, flags, error, nsegs);
424 if (error == EINPROGRESS)
427 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
429 (*callback)(callback_arg, segs, 0, error);
431 (*callback)(callback_arg, segs, nsegs, 0);
434 * Return ENOMEM to the caller so that it can pass it up the stack.
435 * This error only happens when NOWAIT is set, so deferral is disabled.
444 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
445 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
447 bus_dma_segment_t *segs;
452 flags |= BUS_DMA_NOWAIT;
454 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
457 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
459 (*callback)(callback_arg, segs, 0, 0, error);
461 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
463 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
464 __func__, dmat, flags, error, nsegs);
469 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
470 bus_dma_segment_t *segs, int *nsegs, int flags)
474 flags |= BUS_DMA_NOWAIT;
476 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
478 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
483 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
484 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
486 bus_dma_segment_t *segs;
489 flags |= BUS_DMA_NOWAIT;
491 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
494 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
496 (*callback)(callback_arg, segs, 0, 0, error);
498 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
500 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
501 __func__, dmat, flags, error, nsegs);
506 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
507 bus_dmamap_callback_t *callback, void *callback_arg,
510 bus_dma_segment_t *segs;
511 struct ccb_hdr *ccb_h;
517 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
518 callback(callback_arg, NULL, 0, 0);
521 if ((flags & BUS_DMA_NOWAIT) == 0) {
522 mem = memdesc_ccb(ccb);
523 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
526 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
529 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
530 __func__, dmat, flags, error, nsegs);
532 if (error == EINPROGRESS)
535 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
537 (*callback)(callback_arg, segs, 0, error);
539 (*callback)(callback_arg, segs, nsegs, error);
541 * Return ENOMEM to the caller so that it can pass it up the stack.
542 * This error only happens when NOWAIT is set, so deferral is disabled.
551 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
552 bus_dmamap_callback_t *callback, void *callback_arg,
555 bus_dma_segment_t *segs;
560 if ((flags & BUS_DMA_NOWAIT) == 0) {
561 mem = memdesc_bio(bio);
562 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
565 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
568 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
569 __func__, dmat, flags, error, nsegs);
571 if (error == EINPROGRESS)
574 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
576 (*callback)(callback_arg, segs, 0, error);
578 (*callback)(callback_arg, segs, nsegs, error);
580 * Return ENOMEM to the caller so that it can pass it up the stack.
581 * This error only happens when NOWAIT is set, so deferral is disabled.
590 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
591 struct memdesc *mem, bus_dmamap_callback_t *callback,
592 void *callback_arg, int flags)
594 bus_dma_segment_t *segs;
598 if ((flags & BUS_DMA_NOWAIT) == 0)
599 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
603 switch (mem->md_type) {
605 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
606 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
609 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
610 mem->md_opaque, flags, NULL, &nsegs);
613 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
614 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
617 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
618 mem->md_opaque, &nsegs, flags);
621 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
625 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
629 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
630 NULL, &nsegs, flags);
633 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
639 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
640 __func__, dmat, flags, error, nsegs);
642 if (error == EINPROGRESS)
645 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
647 (*callback)(callback_arg, segs, 0, error);
649 (*callback)(callback_arg, segs, nsegs, 0);
652 * Return ENOMEM to the caller so that it can pass it up the stack.
653 * This error only happens when NOWAIT is set, so deferral is disabled.
662 bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map,
663 struct crypto_buffer *cb, bus_dmamap_callback_t *callback,
664 void *callback_arg, int flags)
666 bus_dma_segment_t *segs;
670 flags |= BUS_DMA_NOWAIT;
673 switch (cb->cb_type) {
674 case CRYPTO_BUF_CONTIG:
675 error = _bus_dmamap_load_buffer(dmat, map, cb->cb_buf,
676 cb->cb_buf_len, kernel_pmap, flags, NULL, &nsegs);
678 case CRYPTO_BUF_MBUF:
679 error = _bus_dmamap_load_mbuf_sg(dmat, map, cb->cb_mbuf,
680 NULL, &nsegs, flags);
682 case CRYPTO_BUF_SINGLE_MBUF:
683 error = _bus_dmamap_load_single_mbuf(dmat, map, cb->cb_mbuf,
684 NULL, &nsegs, flags);
687 error = _bus_dmamap_load_uio(dmat, map, cb->cb_uio, &nsegs,
690 case CRYPTO_BUF_VMPAGE:
691 error = _bus_dmamap_load_ma(dmat, map, cb->cb_vm_page,
692 cb->cb_vm_page_len, cb->cb_vm_page_offset, flags, NULL,
700 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
701 __func__, dmat, flags, error, nsegs);
703 if (error == EINPROGRESS)
706 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
708 (*callback)(callback_arg, segs, 0, error);
710 (*callback)(callback_arg, segs, nsegs, 0);
713 * Return ENOMEM to the caller so that it can pass it up the stack.
714 * This error only happens when NOWAIT is set, so deferral is disabled.
723 bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, struct cryptop *crp,
724 bus_dmamap_callback_t *callback, void *callback_arg, int flags)
726 return (bus_dmamap_load_crp_buffer(dmat, map, &crp->crp_buf, callback,
727 callback_arg, flags));
731 bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent)
740 t->lowaddr = t->highaddr = BUS_SPACE_MAXADDR;
741 t->maxsize = t->maxsegsize = BUS_SPACE_MAXSIZE;
742 t->nsegments = BUS_SPACE_UNRESTRICTED;
744 t->lockfuncarg = NULL;
749 bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat)
752 if (t == NULL || dmat == NULL)
755 return (bus_dma_tag_create(t->parent, t->alignment, t->boundary,
756 t->lowaddr, t->highaddr, NULL, NULL, t->maxsize,
757 t->nsegments, t->maxsegsize, t->flags, t->lockfunc, t->lockfuncarg,
762 bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, u_int count)
764 bus_dma_param_t *pkv;
769 case BD_PARAM_PARENT:
770 t->parent = pkv->ptr;
772 case BD_PARAM_ALIGNMENT:
773 t->alignment = pkv->num;
775 case BD_PARAM_BOUNDARY:
776 t->boundary = pkv->num;
778 case BD_PARAM_LOWADDR:
779 t->lowaddr = pkv->pa;
781 case BD_PARAM_HIGHADDR:
782 t->highaddr = pkv->pa;
784 case BD_PARAM_MAXSIZE:
785 t->maxsize = pkv->num;
787 case BD_PARAM_NSEGMENTS:
788 t->nsegments = pkv->num;
790 case BD_PARAM_MAXSEGSIZE:
791 t->maxsegsize = pkv->num;
796 case BD_PARAM_LOCKFUNC:
797 t->lockfunc = pkv->ptr;
799 case BD_PARAM_LOCKFUNCARG:
800 t->lockfuncarg = pkv->ptr;
805 case BD_PARAM_INVALID:
807 KASSERT(0, ("Invalid key %d\n", pkv->key));
815 bool bus_dma_iommu_set_buswide(device_t dev);
816 int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
817 vm_paddr_t start, vm_size_t length, int flags);
820 bus_dma_iommu_set_buswide(device_t dev)
826 bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
827 vm_paddr_t start, vm_size_t length, int flags)