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 mbuf chain.
117 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map,
118 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags)
124 for (m = m0; m != NULL && error == 0; m = m->m_next) {
126 error = _bus_dmamap_load_buffer(dmat, map, m->m_data,
127 m->m_len, kernel_pmap, flags | BUS_DMA_LOAD_MBUF,
131 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
132 __func__, dmat, flags, error, *nsegs);
137 * Load from block io.
140 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
141 int *nsegs, int flags)
144 if ((bio->bio_flags & BIO_VLIST) != 0) {
145 bus_dma_segment_t *segs = (bus_dma_segment_t *)bio->bio_data;
146 return (_bus_dmamap_load_vlist(dmat, map, segs, bio->bio_ma_n,
147 kernel_pmap, nsegs, flags, bio->bio_ma_offset,
151 if ((bio->bio_flags & BIO_UNMAPPED) != 0)
152 return (_bus_dmamap_load_ma(dmat, map, bio->bio_ma,
153 bio->bio_bcount, bio->bio_ma_offset, flags, NULL, nsegs));
155 return (_bus_dmamap_load_buffer(dmat, map, bio->bio_data,
156 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs));
160 bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map,
161 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
162 bus_dma_segment_t *segs, int *segp)
169 for (i = 0; tlen > 0; i++, tlen -= len) {
170 len = min(PAGE_SIZE - ma_offs, tlen);
171 paddr = VM_PAGE_TO_PHYS(ma[i]) + ma_offs;
172 error = _bus_dmamap_load_phys(dmat, map, paddr, len,
182 * Load a cam control block.
185 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
186 int *nsegs, int flags)
188 struct ccb_hdr *ccb_h;
196 switch (ccb_h->func_code) {
198 struct ccb_scsiio *csio;
201 data_ptr = csio->data_ptr;
202 dxfer_len = csio->dxfer_len;
203 sglist_cnt = csio->sglist_cnt;
206 case XPT_CONT_TARGET_IO: {
207 struct ccb_scsiio *ctio;
210 data_ptr = ctio->data_ptr;
211 dxfer_len = ctio->dxfer_len;
212 sglist_cnt = ctio->sglist_cnt;
216 struct ccb_ataio *ataio;
219 data_ptr = ataio->data_ptr;
220 dxfer_len = ataio->dxfer_len;
225 case XPT_NVME_ADMIN: {
226 struct ccb_nvmeio *nvmeio;
228 nvmeio = &ccb->nvmeio;
229 data_ptr = nvmeio->data_ptr;
230 dxfer_len = nvmeio->dxfer_len;
231 sglist_cnt = nvmeio->sglist_cnt;
235 panic("_bus_dmamap_load_ccb: Unsupported func code %d",
239 switch ((ccb_h->flags & CAM_DATA_MASK)) {
241 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len,
242 kernel_pmap, flags, NULL, nsegs);
245 error = _bus_dmamap_load_phys(dmat, map,
246 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL,
250 error = _bus_dmamap_load_vlist(dmat, map,
251 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap,
252 nsegs, flags, 0, dxfer_len);
254 case CAM_DATA_SG_PADDR:
255 error = _bus_dmamap_load_plist(dmat, map,
256 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags);
259 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr,
263 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented",
273 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
274 int *nsegs, int flags)
283 if (uio->uio_segflg == UIO_USERSPACE) {
284 KASSERT(uio->uio_td != NULL,
285 ("bus_dmamap_load_uio: USERSPACE but no proc"));
286 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace);
289 resid = uio->uio_resid;
293 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) {
295 * Now at the first iovec to load. Load each iovec
296 * until we have exhausted the residual count.
299 addr = (caddr_t) iov[i].iov_base;
300 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len;
302 error = _bus_dmamap_load_buffer(dmat, map, addr,
303 minlen, pmap, flags, NULL, nsegs);
312 * Map the buffer buf into bus space using the dmamap map.
315 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
316 bus_size_t buflen, bus_dmamap_callback_t *callback,
317 void *callback_arg, int flags)
319 bus_dma_segment_t *segs;
324 if ((flags & BUS_DMA_NOWAIT) == 0) {
325 mem = memdesc_vaddr(buf, buflen);
326 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
330 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap,
331 flags, NULL, &nsegs);
334 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
335 __func__, dmat, flags, error, nsegs);
337 if (error == EINPROGRESS)
340 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
342 (*callback)(callback_arg, segs, 0, error);
344 (*callback)(callback_arg, segs, nsegs, 0);
347 * Return ENOMEM to the caller so that it can pass it up the stack.
348 * This error only happens when NOWAIT is set, so deferral is disabled.
357 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
358 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
360 bus_dma_segment_t *segs;
365 flags |= BUS_DMA_NOWAIT;
367 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags);
370 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
372 (*callback)(callback_arg, segs, 0, 0, error);
374 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error);
376 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
377 __func__, dmat, flags, error, nsegs);
382 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0,
383 bus_dma_segment_t *segs, int *nsegs, int flags)
387 flags |= BUS_DMA_NOWAIT;
389 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags);
391 _bus_dmamap_complete(dmat, map, segs, *nsegs, error);
396 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio,
397 bus_dmamap_callback2_t *callback, void *callback_arg, int flags)
399 bus_dma_segment_t *segs;
402 flags |= BUS_DMA_NOWAIT;
404 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags);
407 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
409 (*callback)(callback_arg, segs, 0, 0, error);
411 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error);
413 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
414 __func__, dmat, flags, error, nsegs);
419 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
420 bus_dmamap_callback_t *callback, void *callback_arg,
423 bus_dma_segment_t *segs;
424 struct ccb_hdr *ccb_h;
430 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) {
431 callback(callback_arg, NULL, 0, 0);
434 if ((flags & BUS_DMA_NOWAIT) == 0) {
435 mem = memdesc_ccb(ccb);
436 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
439 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags);
442 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
443 __func__, dmat, flags, error, nsegs);
445 if (error == EINPROGRESS)
448 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
450 (*callback)(callback_arg, segs, 0, error);
452 (*callback)(callback_arg, segs, nsegs, error);
454 * Return ENOMEM to the caller so that it can pass it up the stack.
455 * This error only happens when NOWAIT is set, so deferral is disabled.
464 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio,
465 bus_dmamap_callback_t *callback, void *callback_arg,
468 bus_dma_segment_t *segs;
473 if ((flags & BUS_DMA_NOWAIT) == 0) {
474 mem = memdesc_bio(bio);
475 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg);
478 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags);
481 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
482 __func__, dmat, flags, error, nsegs);
484 if (error == EINPROGRESS)
487 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
489 (*callback)(callback_arg, segs, 0, error);
491 (*callback)(callback_arg, segs, nsegs, error);
493 * Return ENOMEM to the caller so that it can pass it up the stack.
494 * This error only happens when NOWAIT is set, so deferral is disabled.
503 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map,
504 struct memdesc *mem, bus_dmamap_callback_t *callback,
505 void *callback_arg, int flags)
507 bus_dma_segment_t *segs;
511 if ((flags & BUS_DMA_NOWAIT) == 0)
512 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg);
516 switch (mem->md_type) {
518 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr,
519 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs);
522 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr,
523 mem->md_opaque, flags, NULL, &nsegs);
526 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list,
527 mem->md_opaque, kernel_pmap, &nsegs, flags, 0, SIZE_T_MAX);
530 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list,
531 mem->md_opaque, &nsegs, flags);
534 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio,
538 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio,
542 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf,
543 NULL, &nsegs, flags);
546 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs,
552 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d",
553 __func__, dmat, flags, error, nsegs);
555 if (error == EINPROGRESS)
558 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error);
560 (*callback)(callback_arg, segs, 0, error);
562 (*callback)(callback_arg, segs, nsegs, 0);
565 * Return ENOMEM to the caller so that it can pass it up the stack.
566 * This error only happens when NOWAIT is set, so deferral is disabled.