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 <machine/bus.h>
60 * Load up data starting at offset within a region specified by a
61 * list of virtual address ranges until either length or the region
65 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map,
66 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs,
67 int flags, size_t offset, size_t length)
72 for (; sglist_cnt > 0 && length != 0; sglist_cnt--, list++) {
76 KASSERT((offset < list->ds_len),
77 ("Invalid mid-segment offset"));
78 addr = (char *)(uintptr_t)list->ds_addr + offset;
79 ds_len = list->ds_len - offset;
84 KASSERT((ds_len != 0), ("Segment length is zero"));
85 error = _bus_dmamap_load_buffer(dmat, map, addr, ds_len, pmap,
94 * Load a list of physical addresses.
97 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map,
98 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags)
103 for (; sglist_cnt > 0; sglist_cnt--, list++) {
104 error = _bus_dmamap_load_phys(dmat, map,
105 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL,
114 * Load an unmapped mbuf
117 _bus_dmamap_load_unmapped_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
118 struct mbuf *m, bus_dma_segment_t *segs, int *nsegs, int flags)
120 struct mbuf_ext_pgs *ext_pgs;
121 int error, i, off, len, pglen, pgoff, seglen, segoff;
123 MBUF_EXT_PGS_ASSERT(m);
124 ext_pgs = m->m_ext.ext_pgs;
129 /* Skip over any data removed from the front. */
130 off = mtod(m, vm_offset_t);
132 if (ext_pgs->hdr_len != 0) {
133 if (off >= ext_pgs->hdr_len) {
134 off -= ext_pgs->hdr_len;
136 seglen = ext_pgs->hdr_len - off;
138 seglen = min(seglen, len);
141 error = _bus_dmamap_load_buffer(dmat, map,
142 &ext_pgs->hdr[segoff], seglen, kernel_pmap,
146 pgoff = ext_pgs->first_pg_off;
147 for (i = 0; i < ext_pgs->npgs && error == 0 && len > 0; i++) {
148 pglen = mbuf_ext_pg_len(ext_pgs, i, pgoff);
154 seglen = pglen - off;
155 segoff = pgoff + off;
157 seglen = min(seglen, len);
159 error = _bus_dmamap_load_phys(dmat, map,
160 ext_pgs->pa[i] + segoff, seglen, flags, segs, nsegs);
163 if (len != 0 && error == 0) {
164 KASSERT((off + len) <= ext_pgs->trail_len,
165 ("off + len > trail (%d + %d > %d)", off, len,
166 ext_pgs->trail_len));
167 error = _bus_dmamap_load_buffer(dmat, map,
168 &ext_pgs->trail[off], len, kernel_pmap, flags, segs,
175 * Load an mbuf chain.
178 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
179 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
185 for (m = m0; m != NULL && error == 0; m = m->m_next) {
187 if ((m->m_flags & M_NOMAP) != 0)
188 error = _bus_dmamap_load_unmapped_mbuf_sg(dmat,
189 map, m, segs, nsegs, flags);
191 error = _bus_dmamap_load_buffer(dmat, map,
192 m->m_data, m->m_len, kernel_pmap,
193 flags | BUS_DMA_LOAD_MBUF, segs, nsegs);
196 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
197 __func__, dmat, flags, error, *nsegs);
202 * Load from block io.
205 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
206 int *nsegs, int flags)
209 if ((bio->bio_flags & BIO_VLIST) != 0) {
210 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
211 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
212 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
216 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
217 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
218 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
220 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
221 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
225 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
226 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
227 bus_dma_segment_t *segs, int *segp)
234 for (i = 0; tlen > 0; i++, tlen -= len) {
235 len = min(PAGE_SIZE - ma_offs, tlen);
236 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
237 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
247 * Load a cam control block.
250 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
251 int *nsegs, int flags)
253 struct ccb_hdr *ccb_h;
261 switch (ccb_h->func_code) {
263 struct ccb_scsiio *csio;
266 data_ptr = csio->data_ptr;
267 dxfer_len = csio->dxfer_len;
268 sglist_cnt = csio->sglist_cnt;
271 case XPT_CONT_TARGET_IO: {
272 struct ccb_scsiio *ctio;
275 data_ptr = ctio->data_ptr;
276 dxfer_len = ctio->dxfer_len;
277 sglist_cnt = ctio->sglist_cnt;
281 struct ccb_ataio *ataio;
284 data_ptr = ataio->data_ptr;
285 dxfer_len = ataio->dxfer_len;
290 case XPT_NVME_ADMIN: {
291 struct ccb_nvmeio *nvmeio;
293 nvmeio = &ccb->nvmeio;
294 data_ptr = nvmeio->data_ptr;
295 dxfer_len = nvmeio->dxfer_len;
296 sglist_cnt = nvmeio->sglist_cnt;
300 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
304 switch ((ccb_h->flags & CAM_DATA_MASK)) {
306 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
307 kernel_pmap, flags, NULL, nsegs);
310 error = _bus_dmamap_load_phys(dmat, map,
311 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
315 error = _bus_dmamap_load_vlist(dmat, map,
316 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
317 nsegs, flags, 0, dxfer_len);
319 case CAM_DATA_SG_PADDR:
320 error = _bus_dmamap_load_plist(dmat, map,
321 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
324 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
328 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
338 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
339 int *nsegs, int flags)
348 if (uio->uio_segflg == UIO_USERSPACE) {
349 KASSERT(uio->uio_td != NULL,
350 ("bus_dmamap_load_uio: USERSPACE but no proc"));
351 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
354 resid = uio->uio_resid;
358 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
360 * Now at the first iovec to load. Load each iovec
361 * until we have exhausted the residual count.
364 addr = (caddr_t) iov[i].iov_base;
365 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
367 error = _bus_dmamap_load_buffer(dmat, map, addr,
368 minlen, pmap, flags, NULL, nsegs);
377 * Map the buffer buf into bus space using the dmamap map.
380 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
381 bus_size_t buflen, bus_dmamap_callback_t *callback,
382 void *callback_arg, int flags)
384 bus_dma_segment_t *segs;
389 if ((flags & BUS_DMA_NOWAIT) == 0) {
390 mem = memdesc_vaddr(buf, buflen);
391 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
395 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
396 flags, NULL, &nsegs);
399 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
400 __func__, dmat, flags, error, nsegs);
402 if (error == EINPROGRESS)
405 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
407 (*callback)(callback_arg, segs, 0, error);
409 (*callback)(callback_arg, segs, nsegs, 0);
412 * Return ENOMEM to the caller so that it can pass it up the stack.
413 * This error only happens when NOWAIT is set, so deferral is disabled.
422 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
423 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
425 bus_dma_segment_t *segs;
430 flags |= BUS_DMA_NOWAIT;
432 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
435 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
437 (*callback)(callback_arg, segs, 0, 0, error);
439 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
441 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
442 __func__, dmat, flags, error, nsegs);
447 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
448 bus_dma_segment_t *segs, int *nsegs, int flags)
452 flags |= BUS_DMA_NOWAIT;
454 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
456 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
461 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
462 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
464 bus_dma_segment_t *segs;
467 flags |= BUS_DMA_NOWAIT;
469 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
472 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
474 (*callback)(callback_arg, segs, 0, 0, error);
476 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
478 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
479 __func__, dmat, flags, error, nsegs);
484 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
485 bus_dmamap_callback_t *callback, void *callback_arg,
488 bus_dma_segment_t *segs;
489 struct ccb_hdr *ccb_h;
495 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
496 callback(callback_arg, NULL, 0, 0);
499 if ((flags & BUS_DMA_NOWAIT) == 0) {
500 mem = memdesc_ccb(ccb);
501 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
504 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
507 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
508 __func__, dmat, flags, error, nsegs);
510 if (error == EINPROGRESS)
513 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
515 (*callback)(callback_arg, segs, 0, error);
517 (*callback)(callback_arg, segs, nsegs, error);
519 * Return ENOMEM to the caller so that it can pass it up the stack.
520 * This error only happens when NOWAIT is set, so deferral is disabled.
529 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
530 bus_dmamap_callback_t *callback, void *callback_arg,
533 bus_dma_segment_t *segs;
538 if ((flags & BUS_DMA_NOWAIT) == 0) {
539 mem = memdesc_bio(bio);
540 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
543 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
546 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
547 __func__, dmat, flags, error, nsegs);
549 if (error == EINPROGRESS)
552 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
554 (*callback)(callback_arg, segs, 0, error);
556 (*callback)(callback_arg, segs, nsegs, error);
558 * Return ENOMEM to the caller so that it can pass it up the stack.
559 * This error only happens when NOWAIT is set, so deferral is disabled.
568 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
569 struct memdesc *mem, bus_dmamap_callback_t *callback,
570 void *callback_arg, int flags)
572 bus_dma_segment_t *segs;
576 if ((flags & BUS_DMA_NOWAIT) == 0)
577 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
581 switch (mem->md_type) {
583 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
584 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
587 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
588 mem->md_opaque, flags, NULL, &nsegs);
591 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
592 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
595 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
596 mem->md_opaque, &nsegs, flags);
599 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
603 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
607 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
608 NULL, &nsegs, flags);
611 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
617 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
618 __func__, dmat, flags, error, nsegs);
620 if (error == EINPROGRESS)
623 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
625 (*callback)(callback_arg, segs, 0, error);
627 (*callback)(callback_arg, segs, nsegs, 0);
630 * Return ENOMEM to the caller so that it can pass it up the stack.
631 * This error only happens when NOWAIT is set, so deferral is disabled.