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 an mbuf chain.
179 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
180 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
186 for (m = m0; m != NULL && error == 0; m = m->m_next) {
188 if ((m->m_flags & M_EXTPG) != 0)
189 error = _bus_dmamap_load_mbuf_epg(dmat,
190 map, m, segs, nsegs, flags);
192 error = _bus_dmamap_load_buffer(dmat, map,
193 m->m_data, m->m_len, kernel_pmap,
194 flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
197 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
198 __func__, dmat, flags, error, *nsegs);
203 * Load from block io.
206 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
207 int *nsegs, int flags)
210 if ((bio->bio_flags & BIO_VLIST) != 0) {
211 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
212 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
213 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
217 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
218 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
219 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
221 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
222 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
226 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
227 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
228 bus_dma_segment_t *segs, int *segp)
235 for (i = 0; tlen > 0; i++, tlen -= len) {
236 len = min(PAGE_SIZE - ma_offs, tlen);
237 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
238 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
248 * Load a cam control block.
251 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
252 int *nsegs, int flags)
254 struct ccb_hdr *ccb_h;
262 switch (ccb_h->func_code) {
264 struct ccb_scsiio *csio;
267 data_ptr = csio->data_ptr;
268 dxfer_len = csio->dxfer_len;
269 sglist_cnt = csio->sglist_cnt;
272 case XPT_CONT_TARGET_IO: {
273 struct ccb_scsiio *ctio;
276 data_ptr = ctio->data_ptr;
277 dxfer_len = ctio->dxfer_len;
278 sglist_cnt = ctio->sglist_cnt;
282 struct ccb_ataio *ataio;
285 data_ptr = ataio->data_ptr;
286 dxfer_len = ataio->dxfer_len;
291 case XPT_NVME_ADMIN: {
292 struct ccb_nvmeio *nvmeio;
294 nvmeio = &ccb->nvmeio;
295 data_ptr = nvmeio->data_ptr;
296 dxfer_len = nvmeio->dxfer_len;
297 sglist_cnt = nvmeio->sglist_cnt;
301 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
305 switch ((ccb_h->flags & CAM_DATA_MASK)) {
307 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
308 kernel_pmap, flags, NULL, nsegs);
311 error = _bus_dmamap_load_phys(dmat, map,
312 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
316 error = _bus_dmamap_load_vlist(dmat, map,
317 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
318 nsegs, flags, 0, dxfer_len);
320 case CAM_DATA_SG_PADDR:
321 error = _bus_dmamap_load_plist(dmat, map,
322 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
325 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
329 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
339 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
340 int *nsegs, int flags)
349 if (uio->uio_segflg == UIO_USERSPACE) {
350 KASSERT(uio->uio_td != NULL,
351 ("bus_dmamap_load_uio: USERSPACE but no proc"));
352 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
355 resid = uio->uio_resid;
359 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
361 * Now at the first iovec to load. Load each iovec
362 * until we have exhausted the residual count.
365 addr = (caddr_t) iov[i].iov_base;
366 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
368 error = _bus_dmamap_load_buffer(dmat, map, addr,
369 minlen, pmap, flags, NULL, nsegs);
378 * Map the buffer buf into bus space using the dmamap map.
381 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
382 bus_size_t buflen, bus_dmamap_callback_t *callback,
383 void *callback_arg, int flags)
385 bus_dma_segment_t *segs;
390 if ((flags & BUS_DMA_NOWAIT) == 0) {
391 mem = memdesc_vaddr(buf, buflen);
392 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
396 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
397 flags, NULL, &nsegs);
400 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
401 __func__, dmat, flags, error, nsegs);
403 if (error == EINPROGRESS)
406 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
408 (*callback)(callback_arg, segs, 0, error);
410 (*callback)(callback_arg, segs, nsegs, 0);
413 * Return ENOMEM to the caller so that it can pass it up the stack.
414 * This error only happens when NOWAIT is set, so deferral is disabled.
423 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
424 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
426 bus_dma_segment_t *segs;
431 flags |= BUS_DMA_NOWAIT;
433 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
436 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
438 (*callback)(callback_arg, segs, 0, 0, error);
440 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
442 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
443 __func__, dmat, flags, error, nsegs);
448 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
449 bus_dma_segment_t *segs, int *nsegs, int flags)
453 flags |= BUS_DMA_NOWAIT;
455 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
457 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
462 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
463 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
465 bus_dma_segment_t *segs;
468 flags |= BUS_DMA_NOWAIT;
470 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
473 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
475 (*callback)(callback_arg, segs, 0, 0, error);
477 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
479 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
480 __func__, dmat, flags, error, nsegs);
485 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
486 bus_dmamap_callback_t *callback, void *callback_arg,
489 bus_dma_segment_t *segs;
490 struct ccb_hdr *ccb_h;
496 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
497 callback(callback_arg, NULL, 0, 0);
500 if ((flags & BUS_DMA_NOWAIT) == 0) {
501 mem = memdesc_ccb(ccb);
502 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
505 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
508 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
509 __func__, dmat, flags, error, nsegs);
511 if (error == EINPROGRESS)
514 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
516 (*callback)(callback_arg, segs, 0, error);
518 (*callback)(callback_arg, segs, nsegs, error);
520 * Return ENOMEM to the caller so that it can pass it up the stack.
521 * This error only happens when NOWAIT is set, so deferral is disabled.
530 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
531 bus_dmamap_callback_t *callback, void *callback_arg,
534 bus_dma_segment_t *segs;
539 if ((flags & BUS_DMA_NOWAIT) == 0) {
540 mem = memdesc_bio(bio);
541 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
544 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
547 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
548 __func__, dmat, flags, error, nsegs);
550 if (error == EINPROGRESS)
553 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
555 (*callback)(callback_arg, segs, 0, error);
557 (*callback)(callback_arg, segs, nsegs, error);
559 * Return ENOMEM to the caller so that it can pass it up the stack.
560 * This error only happens when NOWAIT is set, so deferral is disabled.
569 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
570 struct memdesc *mem, bus_dmamap_callback_t *callback,
571 void *callback_arg, int flags)
573 bus_dma_segment_t *segs;
577 if ((flags & BUS_DMA_NOWAIT) == 0)
578 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
582 switch (mem->md_type) {
584 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
585 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
588 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
589 mem->md_opaque, flags, NULL, &nsegs);
592 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
593 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
596 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
597 mem->md_opaque, &nsegs, flags);
600 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
604 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
608 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
609 NULL, &nsegs, flags);
612 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
618 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
619 __func__, dmat, flags, error, nsegs);
621 if (error == EINPROGRESS)
624 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
626 (*callback)(callback_arg, segs, 0, error);
628 (*callback)(callback_arg, segs, nsegs, 0);
631 * Return ENOMEM to the caller so that it can pass it up the stack.
632 * This error only happens when NOWAIT is set, so deferral is disabled.
641 bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map,
642 struct crypto_buffer *cb, bus_dmamap_callback_t *callback,
643 void *callback_arg, int flags)
645 bus_dma_segment_t *segs;
649 flags |= BUS_DMA_NOWAIT;
652 switch (cb->cb_type) {
653 case CRYPTO_BUF_CONTIG:
654 error = _bus_dmamap_load_buffer(dmat, map, cb->cb_buf,
655 cb->cb_buf_len, kernel_pmap, flags, NULL, &nsegs);
657 case CRYPTO_BUF_MBUF:
658 error = _bus_dmamap_load_mbuf_sg(dmat, map, cb->cb_mbuf,
659 NULL, &nsegs, flags);
662 error = _bus_dmamap_load_uio(dmat, map, cb->cb_uio, &nsegs,
665 case CRYPTO_BUF_VMPAGE:
666 error = _bus_dmamap_load_ma(dmat, map, cb->cb_vm_page,
667 cb->cb_vm_page_len, cb->cb_vm_page_offset, flags, NULL,
675 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
676 __func__, dmat, flags, error, nsegs);
678 if (error == EINPROGRESS)
681 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
683 (*callback)(callback_arg, segs, 0, error);
685 (*callback)(callback_arg, segs, nsegs, 0);
688 * Return ENOMEM to the caller so that it can pass it up the stack.
689 * This error only happens when NOWAIT is set, so deferral is disabled.
698 bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, struct cryptop *crp,
699 bus_dmamap_callback_t *callback, void *callback_arg, int flags)
701 return (bus_dmamap_load_crp_buffer(dmat, map, &crp->crp_buf, callback,
702 callback_arg, flags));
706 bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent)
715 t->lowaddr = t->highaddr = BUS_SPACE_MAXADDR;
716 t->maxsize = t->maxsegsize = BUS_SPACE_MAXSIZE;
717 t->nsegments = BUS_SPACE_UNRESTRICTED;
719 t->lockfuncarg = NULL;
724 bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat)
727 if (t == NULL || dmat == NULL)
730 return (bus_dma_tag_create(t->parent, t->alignment, t->boundary,
731 t->lowaddr, t->highaddr, NULL, NULL, t->maxsize,
732 t->nsegments, t->maxsegsize, t->flags, t->lockfunc, t->lockfuncarg,
737 bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, u_int count)
739 bus_dma_param_t *pkv;
744 case BD_PARAM_PARENT:
745 t->parent = pkv->ptr;
747 case BD_PARAM_ALIGNMENT:
748 t->alignment = pkv->num;
750 case BD_PARAM_BOUNDARY:
751 t->boundary = pkv->num;
753 case BD_PARAM_LOWADDR:
754 t->lowaddr = pkv->pa;
756 case BD_PARAM_HIGHADDR:
757 t->highaddr = pkv->pa;
759 case BD_PARAM_MAXSIZE:
760 t->maxsize = pkv->num;
762 case BD_PARAM_NSEGMENTS:
763 t->nsegments = pkv->num;
765 case BD_PARAM_MAXSEGSIZE:
766 t->maxsegsize = pkv->num;
771 case BD_PARAM_LOCKFUNC:
772 t->lockfunc = pkv->ptr;
774 case BD_PARAM_LOCKFUNCARG:
775 t->lockfuncarg = pkv->ptr;
780 case BD_PARAM_INVALID:
782 KASSERT(0, ("Invalid key %d\n", pkv->key));
790 bool bus_dma_iommu_set_buswide(device_t dev);
791 int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
792 vm_paddr_t start, vm_size_t length, int flags);
795 bus_dma_iommu_set_buswide(device_t dev)
801 bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map,
802 vm_paddr_t start, vm_size_t length, int flags)