1 /*- 2 * Copyright (c) 2012 EMC Corp. 3 * All rights reserved. 4 * 5 * Copyright (c) 1997, 1998 Justin T. Gibbs. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 33 #include "opt_bus.h" 34 35 #include <sys/param.h> 36 #include <sys/conf.h> 37 #include <sys/systm.h> 38 #include <sys/bio.h> 39 #include <sys/bus.h> 40 #include <sys/callout.h> 41 #include <sys/mbuf.h> 42 #include <sys/memdesc.h> 43 #include <sys/proc.h> 44 #include <sys/uio.h> 45 46 #include <vm/vm.h> 47 #include <vm/vm_page.h> 48 #include <vm/vm_map.h> 49 #include <vm/pmap.h> 50 51 #include <cam/cam.h> 52 #include <cam/cam_ccb.h> 53 54 #include <machine/bus.h> 55 56 /* 57 * Load a list of virtual addresses. 58 */ 59 static int 60 _bus_dmamap_load_vlist(bus_dma_tag_t dmat, bus_dmamap_t map, 61 bus_dma_segment_t *list, int sglist_cnt, struct pmap *pmap, int *nsegs, 62 int flags) 63 { 64 int error; 65 66 error = 0; 67 for (; sglist_cnt > 0; sglist_cnt--, list++) { 68 error = _bus_dmamap_load_buffer(dmat, map, 69 (void *)list->ds_addr, list->ds_len, pmap, flags, NULL, 70 nsegs); 71 if (error) 72 break; 73 } 74 return (error); 75 } 76 77 /* 78 * Load a list of physical addresses. 79 */ 80 static int 81 _bus_dmamap_load_plist(bus_dma_tag_t dmat, bus_dmamap_t map, 82 bus_dma_segment_t *list, int sglist_cnt, int *nsegs, int flags) 83 { 84 int error; 85 86 error = 0; 87 for (; sglist_cnt > 0; sglist_cnt--, list++) { 88 error = _bus_dmamap_load_phys(dmat, map, 89 (vm_paddr_t)list->ds_addr, list->ds_len, flags, NULL, 90 nsegs); 91 if (error) 92 break; 93 } 94 return (error); 95 } 96 97 /* 98 * Load an mbuf chain. 99 */ 100 static int 101 _bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, 102 struct mbuf *m0, bus_dma_segment_t *segs, int *nsegs, int flags) 103 { 104 struct mbuf *m; 105 int error; 106 107 M_ASSERTPKTHDR(m0); 108 109 error = 0; 110 for (m = m0; m != NULL && error == 0; m = m->m_next) { 111 if (m->m_len > 0) { 112 error = _bus_dmamap_load_buffer(dmat, map, m->m_data, 113 m->m_len, kernel_pmap, flags | BUS_DMA_LOAD_MBUF, 114 segs, nsegs); 115 } 116 } 117 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 118 __func__, dmat, flags, error, *nsegs); 119 return (error); 120 } 121 122 /* 123 * Load from block io. 124 */ 125 static int 126 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio, 127 int *nsegs, int flags) 128 { 129 vm_paddr_t paddr; 130 bus_size_t len, tlen; 131 int error, i, ma_offs; 132 133 if ((bio->bio_flags & BIO_UNMAPPED) == 0) { 134 error = _bus_dmamap_load_buffer(dmat, map, bio->bio_data, 135 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs); 136 return (error); 137 } 138 139 error = 0; 140 tlen = bio->bio_bcount; 141 ma_offs = bio->bio_ma_offset; 142 for (i = 0; tlen > 0; i++, tlen -= len) { 143 len = min(PAGE_SIZE - ma_offs, tlen); 144 paddr = VM_PAGE_TO_PHYS(bio->bio_ma[i]) + ma_offs; 145 error = _bus_dmamap_load_phys(dmat, map, paddr, len, 146 flags, NULL, nsegs); 147 if (error != 0) 148 break; 149 ma_offs = 0; 150 } 151 return (error); 152 } 153 154 /* 155 * Load a cam control block. 156 */ 157 static int 158 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 159 int *nsegs, int flags) 160 { 161 struct ccb_ataio *ataio; 162 struct ccb_scsiio *csio; 163 struct ccb_hdr *ccb_h; 164 void *data_ptr; 165 int error; 166 uint32_t dxfer_len; 167 uint16_t sglist_cnt; 168 169 error = 0; 170 ccb_h = &ccb->ccb_h; 171 switch (ccb_h->func_code) { 172 case XPT_SCSI_IO: 173 csio = &ccb->csio; 174 data_ptr = csio->data_ptr; 175 dxfer_len = csio->dxfer_len; 176 sglist_cnt = csio->sglist_cnt; 177 break; 178 case XPT_ATA_IO: 179 ataio = &ccb->ataio; 180 data_ptr = ataio->data_ptr; 181 dxfer_len = ataio->dxfer_len; 182 sglist_cnt = 0; 183 break; 184 default: 185 panic("_bus_dmamap_load_ccb: Unsupported func code %d", 186 ccb_h->func_code); 187 } 188 189 switch ((ccb_h->flags & CAM_DATA_MASK)) { 190 case CAM_DATA_VADDR: 191 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len, 192 kernel_pmap, flags, NULL, nsegs); 193 break; 194 case CAM_DATA_PADDR: 195 error = _bus_dmamap_load_phys(dmat, map, 196 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL, 197 nsegs); 198 break; 199 case CAM_DATA_SG: 200 error = _bus_dmamap_load_vlist(dmat, map, 201 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap, 202 nsegs, flags); 203 break; 204 case CAM_DATA_SG_PADDR: 205 error = _bus_dmamap_load_plist(dmat, map, 206 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags); 207 break; 208 case CAM_DATA_BIO: 209 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr, 210 nsegs, flags); 211 break; 212 default: 213 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented", 214 ccb_h->flags); 215 } 216 return (error); 217 } 218 219 /* 220 * Load a uio. 221 */ 222 static int 223 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 224 int *nsegs, int flags) 225 { 226 bus_size_t resid; 227 bus_size_t minlen; 228 struct iovec *iov; 229 pmap_t pmap; 230 caddr_t addr; 231 int error, i; 232 233 if (uio->uio_segflg == UIO_USERSPACE) { 234 KASSERT(uio->uio_td != NULL, 235 ("bus_dmamap_load_uio: USERSPACE but no proc")); 236 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace); 237 } else 238 pmap = kernel_pmap; 239 resid = uio->uio_resid; 240 iov = uio->uio_iov; 241 error = 0; 242 243 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) { 244 /* 245 * Now at the first iovec to load. Load each iovec 246 * until we have exhausted the residual count. 247 */ 248 249 addr = (caddr_t) iov[i].iov_base; 250 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len; 251 if (minlen > 0) { 252 error = _bus_dmamap_load_buffer(dmat, map, addr, 253 minlen, pmap, flags, NULL, nsegs); 254 resid -= minlen; 255 } 256 } 257 258 return (error); 259 } 260 261 /* 262 * Map the buffer buf into bus space using the dmamap map. 263 */ 264 int 265 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 266 bus_size_t buflen, bus_dmamap_callback_t *callback, 267 void *callback_arg, int flags) 268 { 269 bus_dma_segment_t *segs; 270 struct memdesc mem; 271 int error; 272 int nsegs; 273 274 if ((flags & BUS_DMA_NOWAIT) == 0) { 275 mem = memdesc_vaddr(buf, buflen); 276 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg); 277 } 278 279 nsegs = -1; 280 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap, 281 flags, NULL, &nsegs); 282 nsegs++; 283 284 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 285 __func__, dmat, flags, error, nsegs + 1); 286 287 if (error == EINPROGRESS) 288 return (error); 289 290 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 291 if (error) 292 (*callback)(callback_arg, segs, 0, error); 293 else 294 (*callback)(callback_arg, segs, nsegs, 0); 295 296 /* 297 * Return ENOMEM to the caller so that it can pass it up the stack. 298 * This error only happens when NOWAIT is set, so deferal is disabled. 299 */ 300 if (error == ENOMEM) 301 return (error); 302 303 return (0); 304 } 305 306 int 307 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 308 bus_dmamap_callback2_t *callback, void *callback_arg, int flags) 309 { 310 bus_dma_segment_t *segs; 311 int nsegs, error; 312 313 flags |= BUS_DMA_NOWAIT; 314 nsegs = -1; 315 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags); 316 ++nsegs; 317 318 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 319 if (error) 320 (*callback)(callback_arg, segs, 0, 0, error); 321 else 322 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error); 323 324 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 325 __func__, dmat, flags, error, nsegs); 326 return (error); 327 } 328 329 int 330 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 331 bus_dma_segment_t *segs, int *nsegs, int flags) 332 { 333 int error; 334 335 flags |= BUS_DMA_NOWAIT; 336 *nsegs = -1; 337 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags); 338 ++*nsegs; 339 _bus_dmamap_complete(dmat, map, segs, *nsegs, error); 340 return (error); 341 } 342 343 int 344 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 345 bus_dmamap_callback2_t *callback, void *callback_arg, int flags) 346 { 347 bus_dma_segment_t *segs; 348 int nsegs, error; 349 350 flags |= BUS_DMA_NOWAIT; 351 nsegs = -1; 352 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags); 353 nsegs++; 354 355 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 356 if (error) 357 (*callback)(callback_arg, segs, 0, 0, error); 358 else 359 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error); 360 361 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 362 __func__, dmat, dmat, error, nsegs + 1); 363 return (error); 364 } 365 366 int 367 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 368 bus_dmamap_callback_t *callback, void *callback_arg, 369 int flags) 370 { 371 bus_dma_segment_t *segs; 372 struct ccb_hdr *ccb_h; 373 struct memdesc mem; 374 int error; 375 int nsegs; 376 377 ccb_h = &ccb->ccb_h; 378 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) { 379 callback(callback_arg, NULL, 0, 0); 380 return (0); 381 } 382 if ((flags & BUS_DMA_NOWAIT) == 0) { 383 mem = memdesc_ccb(ccb); 384 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg); 385 } 386 nsegs = -1; 387 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags); 388 nsegs++; 389 if (error == EINPROGRESS) 390 return (error); 391 392 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 393 if (error) 394 (*callback)(callback_arg, segs, 0, error); 395 else 396 (*callback)(callback_arg, segs, nsegs, error); 397 /* 398 * Return ENOMEM to the caller so that it can pass it up the stack. 399 * This error only happens when NOWAIT is set, so deferal is disabled. 400 */ 401 if (error == ENOMEM) 402 return (error); 403 404 return (0); 405 } 406 407 int 408 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map, 409 struct memdesc *mem, bus_dmamap_callback_t *callback, 410 void *callback_arg, int flags) 411 { 412 bus_dma_segment_t *segs; 413 int error; 414 int nsegs; 415 416 if ((flags & BUS_DMA_NOWAIT) == 0) 417 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg); 418 419 nsegs = -1; 420 error = 0; 421 switch (mem->md_type) { 422 case MEMDESC_VADDR: 423 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr, 424 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs); 425 break; 426 case MEMDESC_PADDR: 427 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr, 428 mem->md_opaque, flags, NULL, &nsegs); 429 break; 430 case MEMDESC_VLIST: 431 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list, 432 mem->md_opaque, kernel_pmap, &nsegs, flags); 433 break; 434 case MEMDESC_PLIST: 435 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list, 436 mem->md_opaque, &nsegs, flags); 437 break; 438 case MEMDESC_BIO: 439 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio, 440 &nsegs, flags); 441 break; 442 case MEMDESC_UIO: 443 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio, 444 &nsegs, flags); 445 break; 446 case MEMDESC_MBUF: 447 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf, 448 NULL, &nsegs, flags); 449 break; 450 case MEMDESC_CCB: 451 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs, 452 flags); 453 break; 454 } 455 nsegs++; 456 457 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 458 __func__, dmat, flags, error, nsegs + 1); 459 460 if (error == EINPROGRESS) 461 return (error); 462 463 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 464 if (error) 465 (*callback)(callback_arg, segs, 0, error); 466 else 467 (*callback)(callback_arg, segs, nsegs, 0); 468 469 /* 470 * Return ENOMEM to the caller so that it can pass it up the stack. 471 * This error only happens when NOWAIT is set, so deferal is disabled. 472 */ 473 if (error == ENOMEM) 474 return (error); 475 476 return (0); 477 } 478