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$");
37 #include <sys/param.h>
39 #include <sys/systm.h>
42 #include <sys/callout.h>
45 #include <sys/memdesc.h>
50 #include <vm/vm_page.h>
51 #include <vm/vm_map.h>
55 #include <cam/cam_ccb.h>
57 #include <opencrypto/cryptodev.h>
59 #include <machine/bus.h>
62 * Load up data starting at offset within a region specified by a
63 * list of virtual address ranges until either length or the region
67 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map,
68 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs,
69 int flags, size_t offset, size_t length)
74 for (; sglist_cnt > 0 && length != 0; sglist_cnt--, list++) {
78 KASSERT((offset < list->ds_len),
79 ("Invalid mid-segment offset"));
80 addr = (char *)(uintptr_t)list->ds_addr + offset;
81 ds_len = list->ds_len - offset;
86 KASSERT((ds_len != 0), ("Segment length is zero"));
87 error = _bus_dmamap_load_buffer(dmat, map, addr, ds_len, pmap,
96 * Load a list of physical addresses.
99 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map,
100 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags)
105 for (; sglist_cnt > 0; sglist_cnt--, list++) {
106 error = _bus_dmamap_load_phys(dmat, map,
107 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL,
116 * Load an unmapped mbuf
119 _bus_dmamap_load_unmapped_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
120 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
122 struct mbuf_ext_pgs *ext_pgs;
123 int error, i, off, len, pglen, pgoff, seglen, segoff;
125 MBUF_EXT_PGS_ASSERT(m);
126 ext_pgs = &m->m_ext_pgs;
131 /* Skip over any data removed from the front. */
132 off = mtod(m, vm_offset_t);
134 if (ext_pgs->hdr_len != 0) {
135 if (off >= ext_pgs->hdr_len) {
136 off -= ext_pgs->hdr_len;
138 seglen = ext_pgs->hdr_len - off;
140 seglen = min(seglen, len);
143 error = _bus_dmamap_load_buffer(dmat, map,
144 &ext_pgs->m_epg_hdr[segoff], seglen, kernel_pmap,
148 pgoff = ext_pgs->first_pg_off;
149 for (i = 0; i < ext_pgs->npgs && error == 0 && len > 0; i++) {
150 pglen = mbuf_ext_pg_len(ext_pgs, i, pgoff);
156 seglen = pglen - off;
157 segoff = pgoff + off;
159 seglen = min(seglen, len);
161 error = _bus_dmamap_load_phys(dmat, map,
162 ext_pgs->m_epg_pa[i] + segoff, seglen, flags, segs, nsegs);
165 if (len != 0 && error == 0) {
166 KASSERT((off + len) <= ext_pgs->trail_len,
167 ("off + len > trail (%d + %d > %d)", off, len,
168 ext_pgs->trail_len));
169 error = _bus_dmamap_load_buffer(dmat, map,
170 &ext_pgs->m_epg_trail[off], len, kernel_pmap, flags, segs,
177 * Load an mbuf chain.
180 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
181 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
187 for (m = m0; m != NULL && error == 0; m = m->m_next) {
189 if ((m->m_flags & M_NOMAP) != 0)
190 error = _bus_dmamap_load_unmapped_mbuf_sg(dmat,
191 map, m, segs, nsegs, flags);
193 error = _bus_dmamap_load_buffer(dmat, map,
194 m->m_data, m->m_len, kernel_pmap,
195 flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
198 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
199 __func__, dmat, flags, error, *nsegs);
204 * Load from block io.
207 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
208 int *nsegs, int flags)
211 if ((bio->bio_flags & BIO_VLIST) != 0) {
212 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
213 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
214 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
218 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
219 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
220 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
222 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
223 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
227 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
228 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
229 bus_dma_segment_t *segs, int *segp)
236 for (i = 0; tlen > 0; i++, tlen -= len) {
237 len = min(PAGE_SIZE - ma_offs, tlen);
238 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
239 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
249 * Load a cam control block.
252 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
253 int *nsegs, int flags)
255 struct ccb_hdr *ccb_h;
263 switch (ccb_h->func_code) {
265 struct ccb_scsiio *csio;
268 data_ptr = csio->data_ptr;
269 dxfer_len = csio->dxfer_len;
270 sglist_cnt = csio->sglist_cnt;
273 case XPT_CONT_TARGET_IO: {
274 struct ccb_scsiio *ctio;
277 data_ptr = ctio->data_ptr;
278 dxfer_len = ctio->dxfer_len;
279 sglist_cnt = ctio->sglist_cnt;
283 struct ccb_ataio *ataio;
286 data_ptr = ataio->data_ptr;
287 dxfer_len = ataio->dxfer_len;
292 case XPT_NVME_ADMIN: {
293 struct ccb_nvmeio *nvmeio;
295 nvmeio = &ccb->nvmeio;
296 data_ptr = nvmeio->data_ptr;
297 dxfer_len = nvmeio->dxfer_len;
298 sglist_cnt = nvmeio->sglist_cnt;
302 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
306 switch ((ccb_h->flags & CAM_DATA_MASK)) {
308 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
309 kernel_pmap, flags, NULL, nsegs);
312 error = _bus_dmamap_load_phys(dmat, map,
313 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
317 error = _bus_dmamap_load_vlist(dmat, map,
318 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
319 nsegs, flags, 0, dxfer_len);
321 case CAM_DATA_SG_PADDR:
322 error = _bus_dmamap_load_plist(dmat, map,
323 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
326 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
330 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
340 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
341 int *nsegs, int flags)
350 if (uio->uio_segflg == UIO_USERSPACE) {
351 KASSERT(uio->uio_td != NULL,
352 ("bus_dmamap_load_uio: USERSPACE but no proc"));
353 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
356 resid = uio->uio_resid;
360 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
362 * Now at the first iovec to load. Load each iovec
363 * until we have exhausted the residual count.
366 addr = (caddr_t) iov[i].iov_base;
367 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
369 error = _bus_dmamap_load_buffer(dmat, map, addr,
370 minlen, pmap, flags, NULL, nsegs);
379 * Map the buffer buf into bus space using the dmamap map.
382 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
383 bus_size_t buflen, bus_dmamap_callback_t *callback,
384 void *callback_arg, int flags)
386 bus_dma_segment_t *segs;
391 if ((flags & BUS_DMA_NOWAIT) == 0) {
392 mem = memdesc_vaddr(buf, buflen);
393 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
397 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
398 flags, NULL, &nsegs);
401 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
402 __func__, dmat, flags, error, nsegs);
404 if (error == EINPROGRESS)
407 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
409 (*callback)(callback_arg, segs, 0, error);
411 (*callback)(callback_arg, segs, nsegs, 0);
414 * Return ENOMEM to the caller so that it can pass it up the stack.
415 * This error only happens when NOWAIT is set, so deferral is disabled.
424 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
425 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
427 bus_dma_segment_t *segs;
432 flags |= BUS_DMA_NOWAIT;
434 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &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, m0->m_pkthdr.len, 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_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
450 bus_dma_segment_t *segs, int *nsegs, int flags)
454 flags |= BUS_DMA_NOWAIT;
456 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
458 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
463 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
464 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
466 bus_dma_segment_t *segs;
469 flags |= BUS_DMA_NOWAIT;
471 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
474 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
476 (*callback)(callback_arg, segs, 0, 0, error);
478 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
480 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
481 __func__, dmat, flags, error, nsegs);
486 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
487 bus_dmamap_callback_t *callback, void *callback_arg,
490 bus_dma_segment_t *segs;
491 struct ccb_hdr *ccb_h;
497 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
498 callback(callback_arg, NULL, 0, 0);
501 if ((flags & BUS_DMA_NOWAIT) == 0) {
502 mem = memdesc_ccb(ccb);
503 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
506 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
509 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
510 __func__, dmat, flags, error, nsegs);
512 if (error == EINPROGRESS)
515 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
517 (*callback)(callback_arg, segs, 0, error);
519 (*callback)(callback_arg, segs, nsegs, error);
521 * Return ENOMEM to the caller so that it can pass it up the stack.
522 * This error only happens when NOWAIT is set, so deferral is disabled.
531 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
532 bus_dmamap_callback_t *callback, void *callback_arg,
535 bus_dma_segment_t *segs;
540 if ((flags & BUS_DMA_NOWAIT) == 0) {
541 mem = memdesc_bio(bio);
542 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
545 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
548 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
549 __func__, dmat, flags, error, nsegs);
551 if (error == EINPROGRESS)
554 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
556 (*callback)(callback_arg, segs, 0, error);
558 (*callback)(callback_arg, segs, nsegs, error);
560 * Return ENOMEM to the caller so that it can pass it up the stack.
561 * This error only happens when NOWAIT is set, so deferral is disabled.
570 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
571 struct memdesc *mem, bus_dmamap_callback_t *callback,
572 void *callback_arg, int flags)
574 bus_dma_segment_t *segs;
578 if ((flags & BUS_DMA_NOWAIT) == 0)
579 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
583 switch (mem->md_type) {
585 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
586 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
589 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
590 mem->md_opaque, flags, NULL, &nsegs);
593 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
594 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
597 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
598 mem->md_opaque, &nsegs, flags);
601 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
605 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
609 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
610 NULL, &nsegs, flags);
613 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
619 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
620 __func__, dmat, flags, error, nsegs);
622 if (error == EINPROGRESS)
625 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
627 (*callback)(callback_arg, segs, 0, error);
629 (*callback)(callback_arg, segs, nsegs, 0);
632 * Return ENOMEM to the caller so that it can pass it up the stack.
633 * This error only happens when NOWAIT is set, so deferral is disabled.
642 bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, struct cryptop *crp,
643 bus_dmamap_callback_t *callback, void *callback_arg, int flags)
645 bus_dma_segment_t *segs;
649 flags |= BUS_DMA_NOWAIT;
652 switch (crp->crp_buf_type) {
653 case CRYPTO_BUF_CONTIG:
654 error = _bus_dmamap_load_buffer(dmat, map, crp->crp_buf,
655 crp->crp_ilen, kernel_pmap, flags, NULL, &nsegs);
657 case CRYPTO_BUF_MBUF:
658 error = _bus_dmamap_load_mbuf_sg(dmat, map, crp->crp_mbuf,
659 NULL, &nsegs, flags);
662 error = _bus_dmamap_load_uio(dmat, map, crp->crp_uio, &nsegs,
668 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
669 __func__, dmat, flags, error, nsegs);
671 if (error == EINPROGRESS)
674 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
676 (*callback)(callback_arg, segs, 0, error);
678 (*callback)(callback_arg, segs, nsegs, 0);
681 * Return ENOMEM to the caller so that it can pass it up the stack.
682 * This error only happens when NOWAIT is set, so deferral is disabled.