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>
44 #include <sys/memdesc.h>
49 #include <vm/vm_page.h>
50 #include <vm/vm_map.h>
54 #include <cam/cam_ccb.h>
56 #include <machine/bus.h>
59 * Load up data starting at offset within a region specified by a
60 * list of virtual address ranges until either length or the region
64 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map,
65 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs,
66 int flags, size_t offset, size_t length)
71 for (; sglist_cnt > 0 && length != 0; sglist_cnt--, list++) {
75 KASSERT((offset < list->ds_len),
76 ("Invalid mid-segment offset"));
77 addr = (char *)(uintptr_t)list->ds_addr + offset;
78 ds_len = list->ds_len - offset;
83 KASSERT((ds_len != 0), ("Segment length is zero"));
84 error = _bus_dmamap_load_buffer(dmat, map, addr, ds_len, pmap,
93 * Load a list of physical addresses.
96 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map,
97 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags)
102 for (; sglist_cnt > 0; sglist_cnt--, list++) {
103 error = _bus_dmamap_load_phys(dmat, map,
104 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL,
113 * Load an mbuf chain.
116 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
117 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
123 for (m = m0; m != NULL && error == 0; m = m->m_next) {
125 error = _bus_dmamap_load_buffer(dmat, map, m->m_data,
126 m->m_len, kernel_pmap, flags | BUS_DMA_LOAD_MBUF,
130 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
131 __func__, dmat, flags, error, *nsegs);
136 * Load from block io.
139 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
140 int *nsegs, int flags)
143 if ((bio->bio_flags & BIO_VLIST) != 0) {
144 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
145 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
146 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
150 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
151 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
152 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
154 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
155 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
159 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
160 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
161 bus_dma_segment_t *segs, int *segp)
168 for (i = 0; tlen > 0; i++, tlen -= len) {
169 len = min(PAGE_SIZE - ma_offs, tlen);
170 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
171 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
181 * Load a cam control block.
184 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
185 int *nsegs, int flags)
187 struct ccb_hdr *ccb_h;
195 switch (ccb_h->func_code) {
197 struct ccb_scsiio *csio;
200 data_ptr = csio->data_ptr;
201 dxfer_len = csio->dxfer_len;
202 sglist_cnt = csio->sglist_cnt;
205 case XPT_CONT_TARGET_IO: {
206 struct ccb_scsiio *ctio;
209 data_ptr = ctio->data_ptr;
210 dxfer_len = ctio->dxfer_len;
211 sglist_cnt = ctio->sglist_cnt;
215 struct ccb_ataio *ataio;
218 data_ptr = ataio->data_ptr;
219 dxfer_len = ataio->dxfer_len;
224 case XPT_NVME_ADMIN: {
225 struct ccb_nvmeio *nvmeio;
227 nvmeio = &ccb->nvmeio;
228 data_ptr = nvmeio->data_ptr;
229 dxfer_len = nvmeio->dxfer_len;
230 sglist_cnt = nvmeio->sglist_cnt;
234 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
238 switch ((ccb_h->flags & CAM_DATA_MASK)) {
240 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
241 kernel_pmap, flags, NULL, nsegs);
244 error = _bus_dmamap_load_phys(dmat, map,
245 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
249 error = _bus_dmamap_load_vlist(dmat, map,
250 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
251 nsegs, flags, 0, dxfer_len);
253 case CAM_DATA_SG_PADDR:
254 error = _bus_dmamap_load_plist(dmat, map,
255 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
258 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
262 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
272 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
273 int *nsegs, int flags)
282 if (uio->uio_segflg == UIO_USERSPACE) {
283 KASSERT(uio->uio_td != NULL,
284 ("bus_dmamap_load_uio: USERSPACE but no proc"));
285 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
288 resid = uio->uio_resid;
292 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
294 * Now at the first iovec to load. Load each iovec
295 * until we have exhausted the residual count.
298 addr = (caddr_t) iov[i].iov_base;
299 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
301 error = _bus_dmamap_load_buffer(dmat, map, addr,
302 minlen, pmap, flags, NULL, nsegs);
311 * Map the buffer buf into bus space using the dmamap map.
314 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
315 bus_size_t buflen, bus_dmamap_callback_t *callback,
316 void *callback_arg, int flags)
318 bus_dma_segment_t *segs;
323 if ((flags & BUS_DMA_NOWAIT) == 0) {
324 mem = memdesc_vaddr(buf, buflen);
325 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
329 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
330 flags, NULL, &nsegs);
333 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
334 __func__, dmat, flags, error, nsegs);
336 if (error == EINPROGRESS)
339 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
341 (*callback)(callback_arg, segs, 0, error);
343 (*callback)(callback_arg, segs, nsegs, 0);
346 * Return ENOMEM to the caller so that it can pass it up the stack.
347 * This error only happens when NOWAIT is set, so deferral is disabled.
356 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
357 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
359 bus_dma_segment_t *segs;
364 flags |= BUS_DMA_NOWAIT;
366 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
369 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
371 (*callback)(callback_arg, segs, 0, 0, error);
373 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
375 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
376 __func__, dmat, flags, error, nsegs);
381 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
382 bus_dma_segment_t *segs, int *nsegs, int flags)
386 flags |= BUS_DMA_NOWAIT;
388 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
390 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
395 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
396 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
398 bus_dma_segment_t *segs;
401 flags |= BUS_DMA_NOWAIT;
403 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
406 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
408 (*callback)(callback_arg, segs, 0, 0, error);
410 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
412 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
413 __func__, dmat, flags, error, nsegs);
418 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
419 bus_dmamap_callback_t *callback, void *callback_arg,
422 bus_dma_segment_t *segs;
423 struct ccb_hdr *ccb_h;
429 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
430 callback(callback_arg, NULL, 0, 0);
433 if ((flags & BUS_DMA_NOWAIT) == 0) {
434 mem = memdesc_ccb(ccb);
435 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
438 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
441 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
442 __func__, dmat, flags, error, nsegs);
444 if (error == EINPROGRESS)
447 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
449 (*callback)(callback_arg, segs, 0, error);
451 (*callback)(callback_arg, segs, nsegs, error);
453 * Return ENOMEM to the caller so that it can pass it up the stack.
454 * This error only happens when NOWAIT is set, so deferral is disabled.
463 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
464 bus_dmamap_callback_t *callback, void *callback_arg,
467 bus_dma_segment_t *segs;
472 if ((flags & BUS_DMA_NOWAIT) == 0) {
473 mem = memdesc_bio(bio);
474 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
477 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
480 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
481 __func__, dmat, flags, error, nsegs);
483 if (error == EINPROGRESS)
486 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
488 (*callback)(callback_arg, segs, 0, error);
490 (*callback)(callback_arg, segs, nsegs, error);
492 * Return ENOMEM to the caller so that it can pass it up the stack.
493 * This error only happens when NOWAIT is set, so deferral is disabled.
502 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
503 struct memdesc *mem, bus_dmamap_callback_t *callback,
504 void *callback_arg, int flags)
506 bus_dma_segment_t *segs;
510 if ((flags & BUS_DMA_NOWAIT) == 0)
511 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
515 switch (mem->md_type) {
517 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
518 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
521 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
522 mem->md_opaque, flags, NULL, &nsegs);
525 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
526 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
529 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
530 mem->md_opaque, &nsegs, flags);
533 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
537 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
541 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
542 NULL, &nsegs, flags);
545 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
551 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
552 __func__, dmat, flags, error, nsegs);
554 if (error == EINPROGRESS)
557 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
559 (*callback)(callback_arg, segs, 0, error);
561 (*callback)(callback_arg, segs, nsegs, 0);
564 * Return ENOMEM to the caller so that it can pass it up the stack.
565 * This error only happens when NOWAIT is set, so deferral is disabled.