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