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 *)(uintptr_t)list->ds_addr, list->ds_len, pmap, 70 flags, NULL, 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 error = 0; 108 for (m = m0; m != NULL && error == 0; m = m->m_next) { 109 if (m->m_len > 0) { 110 error = _bus_dmamap_load_buffer(dmat, map, m->m_data, 111 m->m_len, kernel_pmap, flags | BUS_DMA_LOAD_MBUF, 112 segs, nsegs); 113 } 114 } 115 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 116 __func__, dmat, flags, error, *nsegs); 117 return (error); 118 } 119 120 /* 121 * Load from block io. 122 */ 123 static int 124 _bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio, 125 int *nsegs, int flags) 126 { 127 vm_paddr_t paddr; 128 bus_size_t len, tlen; 129 int error, i, ma_offs; 130 131 if ((bio->bio_flags & BIO_UNMAPPED) == 0) { 132 error = _bus_dmamap_load_buffer(dmat, map, bio->bio_data, 133 bio->bio_bcount, kernel_pmap, flags, NULL, nsegs); 134 return (error); 135 } 136 137 error = 0; 138 tlen = bio->bio_bcount; 139 ma_offs = bio->bio_ma_offset; 140 for (i = 0; tlen > 0; i++, tlen -= len) { 141 len = min(PAGE_SIZE - ma_offs, tlen); 142 paddr = VM_PAGE_TO_PHYS(bio->bio_ma[i]) + ma_offs; 143 error = _bus_dmamap_load_phys(dmat, map, paddr, len, 144 flags, NULL, nsegs); 145 if (error != 0) 146 break; 147 ma_offs = 0; 148 } 149 return (error); 150 } 151 152 /* 153 * Load a cam control block. 154 */ 155 static int 156 _bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 157 int *nsegs, int flags) 158 { 159 struct ccb_hdr *ccb_h; 160 void *data_ptr; 161 int error; 162 uint32_t dxfer_len; 163 uint16_t sglist_cnt; 164 165 error = 0; 166 ccb_h = &ccb->ccb_h; 167 switch (ccb_h->func_code) { 168 case XPT_SCSI_IO: { 169 struct ccb_scsiio *csio; 170 171 csio = &ccb->csio; 172 data_ptr = csio->data_ptr; 173 dxfer_len = csio->dxfer_len; 174 sglist_cnt = csio->sglist_cnt; 175 break; 176 } 177 case XPT_CONT_TARGET_IO: { 178 struct ccb_scsiio *ctio; 179 180 ctio = &ccb->ctio; 181 data_ptr = ctio->data_ptr; 182 dxfer_len = ctio->dxfer_len; 183 sglist_cnt = ctio->sglist_cnt; 184 break; 185 } 186 case XPT_ATA_IO: { 187 struct ccb_ataio *ataio; 188 189 ataio = &ccb->ataio; 190 data_ptr = ataio->data_ptr; 191 dxfer_len = ataio->dxfer_len; 192 sglist_cnt = 0; 193 break; 194 } 195 default: 196 panic("_bus_dmamap_load_ccb: Unsupported func code %d", 197 ccb_h->func_code); 198 } 199 200 switch ((ccb_h->flags & CAM_DATA_MASK)) { 201 case CAM_DATA_VADDR: 202 error = _bus_dmamap_load_buffer(dmat, map, data_ptr, dxfer_len, 203 kernel_pmap, flags, NULL, nsegs); 204 break; 205 case CAM_DATA_PADDR: 206 error = _bus_dmamap_load_phys(dmat, map, 207 (vm_paddr_t)(uintptr_t)data_ptr, dxfer_len, flags, NULL, 208 nsegs); 209 break; 210 case CAM_DATA_SG: 211 error = _bus_dmamap_load_vlist(dmat, map, 212 (bus_dma_segment_t *)data_ptr, sglist_cnt, kernel_pmap, 213 nsegs, flags); 214 break; 215 case CAM_DATA_SG_PADDR: 216 error = _bus_dmamap_load_plist(dmat, map, 217 (bus_dma_segment_t *)data_ptr, sglist_cnt, nsegs, flags); 218 break; 219 case CAM_DATA_BIO: 220 error = _bus_dmamap_load_bio(dmat, map, (struct bio *)data_ptr, 221 nsegs, flags); 222 break; 223 default: 224 panic("_bus_dmamap_load_ccb: flags 0x%X unimplemented", 225 ccb_h->flags); 226 } 227 return (error); 228 } 229 230 /* 231 * Load a uio. 232 */ 233 static int 234 _bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 235 int *nsegs, int flags) 236 { 237 bus_size_t resid; 238 bus_size_t minlen; 239 struct iovec *iov; 240 pmap_t pmap; 241 caddr_t addr; 242 int error, i; 243 244 if (uio->uio_segflg == UIO_USERSPACE) { 245 KASSERT(uio->uio_td != NULL, 246 ("bus_dmamap_load_uio: USERSPACE but no proc")); 247 pmap = vmspace_pmap(uio->uio_td->td_proc->p_vmspace); 248 } else 249 pmap = kernel_pmap; 250 resid = uio->uio_resid; 251 iov = uio->uio_iov; 252 error = 0; 253 254 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) { 255 /* 256 * Now at the first iovec to load. Load each iovec 257 * until we have exhausted the residual count. 258 */ 259 260 addr = (caddr_t) iov[i].iov_base; 261 minlen = resid < iov[i].iov_len ? resid : iov[i].iov_len; 262 if (minlen > 0) { 263 error = _bus_dmamap_load_buffer(dmat, map, addr, 264 minlen, pmap, flags, NULL, nsegs); 265 resid -= minlen; 266 } 267 } 268 269 return (error); 270 } 271 272 /* 273 * Map the buffer buf into bus space using the dmamap map. 274 */ 275 int 276 bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 277 bus_size_t buflen, bus_dmamap_callback_t *callback, 278 void *callback_arg, int flags) 279 { 280 bus_dma_segment_t *segs; 281 struct memdesc mem; 282 int error; 283 int nsegs; 284 285 if ((flags & BUS_DMA_NOWAIT) == 0) { 286 mem = memdesc_vaddr(buf, buflen); 287 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg); 288 } 289 290 nsegs = -1; 291 error = _bus_dmamap_load_buffer(dmat, map, buf, buflen, kernel_pmap, 292 flags, NULL, &nsegs); 293 nsegs++; 294 295 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 296 __func__, dmat, flags, error, nsegs); 297 298 if (error == EINPROGRESS) 299 return (error); 300 301 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 302 if (error) 303 (*callback)(callback_arg, segs, 0, error); 304 else 305 (*callback)(callback_arg, segs, nsegs, 0); 306 307 /* 308 * Return ENOMEM to the caller so that it can pass it up the stack. 309 * This error only happens when NOWAIT is set, so deferral is disabled. 310 */ 311 if (error == ENOMEM) 312 return (error); 313 314 return (0); 315 } 316 317 int 318 bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 319 bus_dmamap_callback2_t *callback, void *callback_arg, int flags) 320 { 321 bus_dma_segment_t *segs; 322 int nsegs, error; 323 324 M_ASSERTPKTHDR(m0); 325 326 flags |= BUS_DMA_NOWAIT; 327 nsegs = -1; 328 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, NULL, &nsegs, flags); 329 ++nsegs; 330 331 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 332 if (error) 333 (*callback)(callback_arg, segs, 0, 0, error); 334 else 335 (*callback)(callback_arg, segs, nsegs, m0->m_pkthdr.len, error); 336 337 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 338 __func__, dmat, flags, error, nsegs); 339 return (error); 340 } 341 342 int 343 bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 344 bus_dma_segment_t *segs, int *nsegs, int flags) 345 { 346 int error; 347 348 flags |= BUS_DMA_NOWAIT; 349 *nsegs = -1; 350 error = _bus_dmamap_load_mbuf_sg(dmat, map, m0, segs, nsegs, flags); 351 ++*nsegs; 352 _bus_dmamap_complete(dmat, map, segs, *nsegs, error); 353 return (error); 354 } 355 356 int 357 bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 358 bus_dmamap_callback2_t *callback, void *callback_arg, int flags) 359 { 360 bus_dma_segment_t *segs; 361 int nsegs, error; 362 363 flags |= BUS_DMA_NOWAIT; 364 nsegs = -1; 365 error = _bus_dmamap_load_uio(dmat, map, uio, &nsegs, flags); 366 nsegs++; 367 368 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 369 if (error) 370 (*callback)(callback_arg, segs, 0, 0, error); 371 else 372 (*callback)(callback_arg, segs, nsegs, uio->uio_resid, error); 373 374 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 375 __func__, dmat, flags, error, nsegs); 376 return (error); 377 } 378 379 int 380 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 381 bus_dmamap_callback_t *callback, void *callback_arg, 382 int flags) 383 { 384 bus_dma_segment_t *segs; 385 struct ccb_hdr *ccb_h; 386 struct memdesc mem; 387 int error; 388 int nsegs; 389 390 ccb_h = &ccb->ccb_h; 391 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_NONE) { 392 callback(callback_arg, NULL, 0, 0); 393 return (0); 394 } 395 if ((flags & BUS_DMA_NOWAIT) == 0) { 396 mem = memdesc_ccb(ccb); 397 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg); 398 } 399 nsegs = -1; 400 error = _bus_dmamap_load_ccb(dmat, map, ccb, &nsegs, flags); 401 nsegs++; 402 403 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 404 __func__, dmat, flags, error, nsegs); 405 406 if (error == EINPROGRESS) 407 return (error); 408 409 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 410 if (error) 411 (*callback)(callback_arg, segs, 0, error); 412 else 413 (*callback)(callback_arg, segs, nsegs, error); 414 /* 415 * Return ENOMEM to the caller so that it can pass it up the stack. 416 * This error only happens when NOWAIT is set, so deferral is disabled. 417 */ 418 if (error == ENOMEM) 419 return (error); 420 421 return (0); 422 } 423 424 int 425 bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio, 426 bus_dmamap_callback_t *callback, void *callback_arg, 427 int flags) 428 { 429 bus_dma_segment_t *segs; 430 struct memdesc mem; 431 int error; 432 int nsegs; 433 434 if ((flags & BUS_DMA_NOWAIT) == 0) { 435 mem = memdesc_bio(bio); 436 _bus_dmamap_waitok(dmat, map, &mem, callback, callback_arg); 437 } 438 nsegs = -1; 439 error = _bus_dmamap_load_bio(dmat, map, bio, &nsegs, flags); 440 nsegs++; 441 442 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 443 __func__, dmat, flags, error, nsegs); 444 445 if (error == EINPROGRESS) 446 return (error); 447 448 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 449 if (error) 450 (*callback)(callback_arg, segs, 0, error); 451 else 452 (*callback)(callback_arg, segs, nsegs, error); 453 /* 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. 456 */ 457 if (error == ENOMEM) 458 return (error); 459 460 return (0); 461 } 462 463 int 464 bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map, 465 struct memdesc *mem, bus_dmamap_callback_t *callback, 466 void *callback_arg, int flags) 467 { 468 bus_dma_segment_t *segs; 469 int error; 470 int nsegs; 471 472 if ((flags & BUS_DMA_NOWAIT) == 0) 473 _bus_dmamap_waitok(dmat, map, mem, callback, callback_arg); 474 475 nsegs = -1; 476 error = 0; 477 switch (mem->md_type) { 478 case MEMDESC_VADDR: 479 error = _bus_dmamap_load_buffer(dmat, map, mem->u.md_vaddr, 480 mem->md_opaque, kernel_pmap, flags, NULL, &nsegs); 481 break; 482 case MEMDESC_PADDR: 483 error = _bus_dmamap_load_phys(dmat, map, mem->u.md_paddr, 484 mem->md_opaque, flags, NULL, &nsegs); 485 break; 486 case MEMDESC_VLIST: 487 error = _bus_dmamap_load_vlist(dmat, map, mem->u.md_list, 488 mem->md_opaque, kernel_pmap, &nsegs, flags); 489 break; 490 case MEMDESC_PLIST: 491 error = _bus_dmamap_load_plist(dmat, map, mem->u.md_list, 492 mem->md_opaque, &nsegs, flags); 493 break; 494 case MEMDESC_BIO: 495 error = _bus_dmamap_load_bio(dmat, map, mem->u.md_bio, 496 &nsegs, flags); 497 break; 498 case MEMDESC_UIO: 499 error = _bus_dmamap_load_uio(dmat, map, mem->u.md_uio, 500 &nsegs, flags); 501 break; 502 case MEMDESC_MBUF: 503 error = _bus_dmamap_load_mbuf_sg(dmat, map, mem->u.md_mbuf, 504 NULL, &nsegs, flags); 505 break; 506 case MEMDESC_CCB: 507 error = _bus_dmamap_load_ccb(dmat, map, mem->u.md_ccb, &nsegs, 508 flags); 509 break; 510 } 511 nsegs++; 512 513 CTR5(KTR_BUSDMA, "%s: tag %p tag flags 0x%x error %d nsegs %d", 514 __func__, dmat, flags, error, nsegs); 515 516 if (error == EINPROGRESS) 517 return (error); 518 519 segs = _bus_dmamap_complete(dmat, map, NULL, nsegs, error); 520 if (error) 521 (*callback)(callback_arg, segs, 0, error); 522 else 523 (*callback)(callback_arg, segs, nsegs, 0); 524 525 /* 526 * Return ENOMEM to the caller so that it can pass it up the stack. 527 * This error only happens when NOWAIT is set, so deferral is disabled. 528 */ 529 if (error == ENOMEM) 530 return (error); 531 532 return (0); 533 } 534