busdma_machdep.c revision 170979
1/*- 2 * Copyright (c) 2002 Peter Grehan 3 * Copyright (c) 1997, 1998 Justin T. Gibbs. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions, and the following disclaimer, 11 * without modification, immediately at the beginning of the file. 12 * 2. The name of the author may not be used to endorse or promote products 13 * derived from this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 19 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * From i386/busdma_machdep.c,v 1.26 2002/04/19 22:58:09 alfred 28 */ 29 30#include <sys/cdefs.h> 31__FBSDID("$FreeBSD: head/sys/powerpc/powerpc/busdma_machdep.c 170979 2007-06-22 03:57:36Z yongari $"); 32 33/* 34 * MacPPC bus dma support routines 35 */ 36 37#include <sys/param.h> 38#include <sys/systm.h> 39#include <sys/malloc.h> 40#include <sys/bus.h> 41#include <sys/interrupt.h> 42#include <sys/lock.h> 43#include <sys/proc.h> 44#include <sys/mutex.h> 45#include <sys/mbuf.h> 46#include <sys/uio.h> 47 48#include <vm/vm.h> 49#include <vm/vm_page.h> 50#include <vm/vm_map.h> 51 52#include <machine/atomic.h> 53#include <machine/bus.h> 54#include <machine/cpufunc.h> 55 56struct bus_dma_tag { 57 bus_dma_tag_t parent; 58 bus_size_t alignment; 59 bus_size_t boundary; 60 bus_addr_t lowaddr; 61 bus_addr_t highaddr; 62 bus_dma_filter_t *filter; 63 void *filterarg; 64 bus_size_t maxsize; 65 u_int nsegments; 66 bus_size_t maxsegsz; 67 int flags; 68 int ref_count; 69 int map_count; 70 bus_dma_lock_t *lockfunc; 71 void *lockfuncarg; 72}; 73 74struct bus_dmamap { 75 bus_dma_tag_t dmat; 76 void *buf; /* unmapped buffer pointer */ 77 bus_size_t buflen; /* unmapped buffer length */ 78 bus_dmamap_callback_t *callback; 79 void *callback_arg; 80}; 81 82/* 83 * Convenience function for manipulating driver locks from busdma (during 84 * busdma_swi, for example). Drivers that don't provide their own locks 85 * should specify &Giant to dmat->lockfuncarg. Drivers that use their own 86 * non-mutex locking scheme don't have to use this at all. 87 */ 88void 89busdma_lock_mutex(void *arg, bus_dma_lock_op_t op) 90{ 91 struct mtx *dmtx; 92 93 dmtx = (struct mtx *)arg; 94 switch (op) { 95 case BUS_DMA_LOCK: 96 mtx_lock(dmtx); 97 break; 98 case BUS_DMA_UNLOCK: 99 mtx_unlock(dmtx); 100 break; 101 default: 102 panic("Unknown operation 0x%x for busdma_lock_mutex!", op); 103 } 104} 105 106/* 107 * dflt_lock should never get called. It gets put into the dma tag when 108 * lockfunc == NULL, which is only valid if the maps that are associated 109 * with the tag are meant to never be defered. 110 * XXX Should have a way to identify which driver is responsible here. 111 */ 112static void 113dflt_lock(void *arg, bus_dma_lock_op_t op) 114{ 115#ifdef INVARIANTS 116 panic("driver error: busdma dflt_lock called"); 117#else 118 printf("DRIVER_ERROR: busdma dflt_lock called\n"); 119#endif 120} 121 122/* 123 * Allocate a device specific dma_tag. 124 */ 125int 126bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment, 127 bus_size_t boundary, bus_addr_t lowaddr, 128 bus_addr_t highaddr, bus_dma_filter_t *filter, 129 void *filterarg, bus_size_t maxsize, int nsegments, 130 bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc, 131 void *lockfuncarg, bus_dma_tag_t *dmat) 132{ 133 bus_dma_tag_t newtag; 134 int error = 0; 135 136 /* Return a NULL tag on failure */ 137 *dmat = NULL; 138 139 newtag = (bus_dma_tag_t)malloc(sizeof(*newtag), M_DEVBUF, M_NOWAIT); 140 if (newtag == NULL) 141 return (ENOMEM); 142 143 newtag->parent = parent; 144 newtag->alignment = alignment; 145 newtag->boundary = boundary; 146 newtag->lowaddr = trunc_page((vm_offset_t)lowaddr) + (PAGE_SIZE - 1); 147 newtag->highaddr = trunc_page((vm_offset_t)highaddr) + (PAGE_SIZE - 1); 148 newtag->filter = filter; 149 newtag->filterarg = filterarg; 150 newtag->maxsize = maxsize; 151 newtag->nsegments = nsegments; 152 newtag->maxsegsz = maxsegsz; 153 newtag->flags = flags; 154 newtag->ref_count = 1; /* Count ourself */ 155 newtag->map_count = 0; 156 if (lockfunc != NULL) { 157 newtag->lockfunc = lockfunc; 158 newtag->lockfuncarg = lockfuncarg; 159 } else { 160 newtag->lockfunc = dflt_lock; 161 newtag->lockfuncarg = NULL; 162 } 163 164 /* 165 * Take into account any restrictions imposed by our parent tag 166 */ 167 if (parent != NULL) { 168 newtag->lowaddr = min(parent->lowaddr, newtag->lowaddr); 169 newtag->highaddr = max(parent->highaddr, newtag->highaddr); 170 if (newtag->boundary == 0) 171 newtag->boundary = parent->boundary; 172 else if (parent->boundary != 0) 173 newtag->boundary = MIN(parent->boundary, 174 newtag->boundary); 175 if (newtag->filter == NULL) { 176 /* 177 * Short circuit looking at our parent directly 178 * since we have encapsulated all of its information 179 */ 180 newtag->filter = parent->filter; 181 newtag->filterarg = parent->filterarg; 182 newtag->parent = parent->parent; 183 } 184 if (newtag->parent != NULL) 185 atomic_add_int(&parent->ref_count, 1); 186 } 187 188 *dmat = newtag; 189 return (error); 190} 191 192int 193bus_dma_tag_destroy(bus_dma_tag_t dmat) 194{ 195 if (dmat != NULL) { 196 197 if (dmat->map_count != 0) 198 return (EBUSY); 199 200 while (dmat != NULL) { 201 bus_dma_tag_t parent; 202 203 parent = dmat->parent; 204 atomic_subtract_int(&dmat->ref_count, 1); 205 if (dmat->ref_count == 0) { 206 free(dmat, M_DEVBUF); 207 /* 208 * Last reference count, so 209 * release our reference 210 * count on our parent. 211 */ 212 dmat = parent; 213 } else 214 dmat = NULL; 215 } 216 } 217 return (0); 218} 219 220/* 221 * Allocate a handle for mapping from kva/uva/physical 222 * address space into bus device space. 223 */ 224int 225bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp) 226{ 227 *mapp = NULL; 228 dmat->map_count++; 229 230 return (0); 231} 232 233/* 234 * Destroy a handle for mapping from kva/uva/physical 235 * address space into bus device space. 236 */ 237int 238bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map) 239{ 240 if (map != NULL) { 241 panic("dmamap_destroy: NULL?\n"); 242 } 243 dmat->map_count--; 244 return (0); 245} 246 247/* 248 * Allocate a piece of memory that can be efficiently mapped into 249 * bus device space based on the constraints lited in the dma tag. 250 * A dmamap to for use with dmamap_load is also allocated. 251 */ 252int 253bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags, 254 bus_dmamap_t *mapp) 255{ 256 int mflags; 257 258 if (flags & BUS_DMA_NOWAIT) 259 mflags = M_NOWAIT; 260 else 261 mflags = M_WAITOK; 262 if (flags & BUS_DMA_ZERO) 263 mflags |= M_ZERO; 264 265 *mapp = NULL; 266 267 /* 268 * XXX: 269 * (dmat->alignment < dmat->maxsize) is just a quick hack; the exact 270 * alignment guarantees of malloc need to be nailed down, and the 271 * code below should be rewritten to take that into account. 272 * 273 * In the meantime, we'll return an error if malloc gets it wrong. 274 */ 275 if (dmat->maxsize <= PAGE_SIZE && 276 dmat->alignment < dmat->maxsize) { 277 *vaddr = malloc(dmat->maxsize, M_DEVBUF, mflags); 278 } else { 279 /* 280 * XXX Use Contigmalloc until it is merged into this facility 281 * and handles multi-seg allocations. Nobody is doing 282 * multi-seg allocations yet though. 283 */ 284 *vaddr = contigmalloc(dmat->maxsize, M_DEVBUF, mflags, 285 0ul, dmat->lowaddr, dmat->alignment? dmat->alignment : 1ul, 286 dmat->boundary); 287 } 288 289 if (*vaddr == NULL) 290 return (ENOMEM); 291 292 if ((uintptr_t)*vaddr % dmat->alignment) 293 printf("XXX: %s: alignment not respected!\n", __func__); 294 295 return (0); 296} 297 298/* 299 * Free a piece of memory and it's allocated dmamap, that was allocated 300 * via bus_dmamem_alloc. Make the same choice for free/contigfree. 301 */ 302void 303bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map) 304{ 305 if (map != NULL) 306 panic("bus_dmamem_free: Invalid map freed\n"); 307 if (dmat->maxsize <= PAGE_SIZE && 308 dmat->alignment < dmat->maxsize) 309 free(vaddr, M_DEVBUF); 310 else 311 contigfree(vaddr, dmat->maxsize, M_DEVBUF); 312} 313 314/* 315 * Utility function to load a linear buffer. lastaddrp holds state 316 * between invocations (for multiple-buffer loads). segp contains 317 * the starting segment on entrance, and the ending segment on exit. 318 * first indicates if this is the first invocation of this function. 319 */ 320static int 321bus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dma_segment_t segs[], 322 void *buf, bus_size_t buflen, struct thread *td, 323 int flags, vm_offset_t *lastaddrp, int *segp, 324 int first) 325{ 326 bus_size_t sgsize; 327 bus_addr_t curaddr, lastaddr, baddr, bmask; 328 vm_offset_t vaddr = (vm_offset_t)buf; 329 int seg; 330 pmap_t pmap; 331 332 if (td != NULL) 333 pmap = vmspace_pmap(td->td_proc->p_vmspace); 334 else 335 pmap = NULL; 336 337 lastaddr = *lastaddrp; 338 bmask = ~(dmat->boundary - 1); 339 340 for (seg = *segp; buflen > 0 ; ) { 341 /* 342 * Get the physical address for this segment. 343 */ 344 if (pmap) 345 curaddr = pmap_extract(pmap, vaddr); 346 else 347 curaddr = pmap_kextract(vaddr); 348 349 /* 350 * Compute the segment size, and adjust counts. 351 */ 352 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK); 353 if (sgsize > dmat->maxsegsz) 354 sgsize = dmat->maxsegsz; 355 if (buflen < sgsize) 356 sgsize = buflen; 357 358 /* 359 * Make sure we don't cross any boundaries. 360 */ 361 if (dmat->boundary > 0) { 362 baddr = (curaddr + dmat->boundary) & bmask; 363 if (sgsize > (baddr - curaddr)) 364 sgsize = (baddr - curaddr); 365 } 366 367 /* 368 * Insert chunk into a segment, coalescing with 369 * the previous segment if possible. 370 */ 371 if (first) { 372 segs[seg].ds_addr = curaddr; 373 segs[seg].ds_len = sgsize; 374 first = 0; 375 } else { 376 if (curaddr == lastaddr && 377 (segs[seg].ds_len + sgsize) <= dmat->maxsegsz && 378 (dmat->boundary == 0 || 379 (segs[seg].ds_addr & bmask) == (curaddr & bmask))) 380 segs[seg].ds_len += sgsize; 381 else { 382 if (++seg >= dmat->nsegments) 383 break; 384 segs[seg].ds_addr = curaddr; 385 segs[seg].ds_len = sgsize; 386 } 387 } 388 389 lastaddr = curaddr + sgsize; 390 vaddr += sgsize; 391 buflen -= sgsize; 392 } 393 394 *segp = seg; 395 *lastaddrp = lastaddr; 396 397 /* 398 * Did we fit? 399 */ 400 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */ 401} 402 403/* 404 * Map the buffer buf into bus space using the dmamap map. 405 */ 406int 407bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 408 bus_size_t buflen, bus_dmamap_callback_t *callback, 409 void *callback_arg, int flags) 410{ 411#ifdef __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 412 bus_dma_segment_t dm_segments[dmat->nsegments]; 413#else 414 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 415#endif 416 vm_offset_t lastaddr; 417 int error, nsegs; 418 419 if (map != NULL) 420 panic("bus_dmamap_load: Invalid map\n"); 421 422 lastaddr = (vm_offset_t)0; 423 nsegs = 0; 424 error = bus_dmamap_load_buffer(dmat, dm_segments, buf, buflen, 425 NULL, flags, &lastaddr, &nsegs, 1); 426 427 if (error == 0) 428 (*callback)(callback_arg, dm_segments, nsegs + 1, 0); 429 else 430 (*callback)(callback_arg, NULL, 0, error); 431 432 return (0); 433} 434 435/* 436 * Like bus_dmamap_load(), but for mbufs. 437 */ 438int 439bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 440 bus_dmamap_callback2_t *callback, void *callback_arg, 441 int flags) 442{ 443#ifdef __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 444 bus_dma_segment_t dm_segments[dmat->nsegments]; 445#else 446 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 447#endif 448 int nsegs = 0, error = 0; 449 450 M_ASSERTPKTHDR(m0); 451 452 if (m0->m_pkthdr.len <= dmat->maxsize) { 453 int first = 1; 454 vm_offset_t lastaddr = 0; 455 struct mbuf *m; 456 457 for (m = m0; m != NULL && error == 0; m = m->m_next) { 458 if (m->m_len > 0) { 459 error = bus_dmamap_load_buffer(dmat, 460 dm_segments, m->m_data, m->m_len, NULL, 461 flags, &lastaddr, &nsegs, first); 462 first = 0; 463 } 464 } 465 } else { 466 error = EINVAL; 467 } 468 469 if (error) { 470 /* 471 * force "no valid mappings" on error in callback. 472 */ 473 (*callback)(callback_arg, dm_segments, 0, 0, error); 474 } else { 475 (*callback)(callback_arg, dm_segments, nsegs+1, 476 m0->m_pkthdr.len, error); 477 } 478 return (error); 479} 480 481int 482bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 483 bus_dma_segment_t *segs, int *nsegs, int flags) 484{ 485 int error = 0; 486 487 M_ASSERTPKTHDR(m0); 488 489 *nsegs = 0; 490 491 if (m0->m_pkthdr.len <= dmat->maxsize) { 492 int first = 1; 493 vm_offset_t lastaddr = 0; 494 struct mbuf *m; 495 496 for (m = m0; m != NULL && error == 0; m = m->m_next) { 497 if (m->m_len > 0) { 498 error = bus_dmamap_load_buffer(dmat, 499 segs, m->m_data, m->m_len, NULL, 500 flags, &lastaddr, nsegs, first); 501 first = 0; 502 } 503 } 504 ++*nsegs; 505 } else { 506 error = EINVAL; 507 } 508 509 return (error); 510} 511 512/* 513 * Like bus_dmamap_load(), but for uios. 514 */ 515int 516bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 517 bus_dmamap_callback2_t *callback, void *callback_arg, 518 int flags) 519{ 520 vm_offset_t lastaddr; 521#ifdef __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 522 bus_dma_segment_t dm_segments[dmat->nsegments]; 523#else 524 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 525#endif 526 int nsegs, i, error, first; 527 bus_size_t resid; 528 struct iovec *iov; 529 struct thread *td = NULL; 530 531 resid = uio->uio_resid; 532 iov = uio->uio_iov; 533 534 if (uio->uio_segflg == UIO_USERSPACE) { 535 td = uio->uio_td; 536 KASSERT(td != NULL, 537 ("bus_dmamap_load_uio: USERSPACE but no proc")); 538 } 539 540 first = 1; 541 nsegs = error = 0; 542 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) { 543 /* 544 * Now at the first iovec to load. Load each iovec 545 * until we have exhausted the residual count. 546 */ 547 bus_size_t minlen = 548 resid < iov[i].iov_len ? resid : iov[i].iov_len; 549 caddr_t addr = (caddr_t) iov[i].iov_base; 550 551 if (minlen > 0) { 552 error = bus_dmamap_load_buffer(dmat, dm_segments, addr, 553 minlen, td, flags, &lastaddr, &nsegs, first); 554 555 first = 0; 556 557 resid -= minlen; 558 } 559 } 560 561 if (error) { 562 /* 563 * force "no valid mappings" on error in callback. 564 */ 565 (*callback)(callback_arg, dm_segments, 0, 0, error); 566 } else { 567 (*callback)(callback_arg, dm_segments, nsegs+1, 568 uio->uio_resid, error); 569 } 570 571 return (error); 572} 573 574/* 575 * Release the mapping held by map. A no-op on PowerPC. 576 */ 577void 578_bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map) 579{ 580 581 return; 582} 583 584void 585_bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op) 586{ 587 588 return; 589} 590