busdma_machdep.c revision 117126
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 117126 2003-07-01 15:52:06Z scottl $"); 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 171 /* 172 * XXX Not really correct??? Probably need to honor boundary 173 * all the way up the inheritence chain. 174 */ 175 newtag->boundary = max(parent->boundary, newtag->boundary); 176 if (newtag->filter == NULL) { 177 /* 178 * Short circuit looking at our parent directly 179 * since we have encapsulated all of its information 180 */ 181 newtag->filter = parent->filter; 182 newtag->filterarg = parent->filterarg; 183 newtag->parent = parent->parent; 184 } 185 if (newtag->parent != NULL) 186 atomic_add_int(&parent->ref_count, 1); 187 } 188 189 *dmat = newtag; 190 return (error); 191} 192 193int 194bus_dma_tag_destroy(bus_dma_tag_t dmat) 195{ 196 if (dmat != NULL) { 197 198 if (dmat->map_count != 0) 199 return (EBUSY); 200 201 while (dmat != NULL) { 202 bus_dma_tag_t parent; 203 204 parent = dmat->parent; 205 atomic_subtract_int(&dmat->ref_count, 1); 206 if (dmat->ref_count == 0) { 207 free(dmat, M_DEVBUF); 208 /* 209 * Last reference count, so 210 * release our reference 211 * count on our parent. 212 */ 213 dmat = parent; 214 } else 215 dmat = NULL; 216 } 217 } 218 return (0); 219} 220 221/* 222 * Allocate a handle for mapping from kva/uva/physical 223 * address space into bus device space. 224 */ 225int 226bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp) 227{ 228 *mapp = NULL; 229 dmat->map_count++; 230 231 return (0); 232} 233 234/* 235 * Destroy a handle for mapping from kva/uva/physical 236 * address space into bus device space. 237 */ 238int 239bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map) 240{ 241 if (map != NULL) { 242 panic("dmamap_destroy: NULL?\n"); 243 } 244 dmat->map_count--; 245 return (0); 246} 247 248/* 249 * Allocate a piece of memory that can be efficiently mapped into 250 * bus device space based on the constraints lited in the dma tag. 251 * A dmamap to for use with dmamap_load is also allocated. 252 */ 253int 254bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags, 255 bus_dmamap_t *mapp) 256{ 257 *mapp = NULL; 258 259 if (dmat->maxsize <= PAGE_SIZE) { 260 *vaddr = malloc(dmat->maxsize, M_DEVBUF, 261 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK); 262 } else { 263 /* 264 * XXX Use Contigmalloc until it is merged into this facility 265 * and handles multi-seg allocations. Nobody is doing 266 * multi-seg allocations yet though. 267 */ 268 mtx_lock(&Giant); 269 *vaddr = contigmalloc(dmat->maxsize, M_DEVBUF, 270 (flags & BUS_DMA_NOWAIT) ? M_NOWAIT : M_WAITOK, 271 0ul, dmat->lowaddr, dmat->alignment? dmat->alignment : 1ul, 272 dmat->boundary); 273 mtx_unlock(&Giant); 274 } 275 276 if (*vaddr == NULL) 277 return (ENOMEM); 278 279 return (0); 280} 281 282/* 283 * Free a piece of memory and it's allocated dmamap, that was allocated 284 * via bus_dmamem_alloc. Make the same choice for free/contigfree. 285 */ 286void 287bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map) 288{ 289 if (map != NULL) 290 panic("bus_dmamem_free: Invalid map freed\n"); 291 if (dmat->maxsize <= PAGE_SIZE) 292 free(vaddr, M_DEVBUF); 293 else { 294 mtx_lock(&Giant); 295 contigfree(vaddr, dmat->maxsize, M_DEVBUF); 296 mtx_unlock(&Giant); 297 } 298} 299 300/* 301 * Map the buffer buf into bus space using the dmamap map. 302 */ 303int 304bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 305 bus_size_t buflen, bus_dmamap_callback_t *callback, 306 void *callback_arg, int flags) 307{ 308 vm_offset_t vaddr; 309 vm_offset_t paddr; 310#ifdef __GNUC__ 311 bus_dma_segment_t dm_segments[dmat->nsegments]; 312#else 313 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 314#endif 315 bus_dma_segment_t *sg; 316 int seg; 317 int error = 0; 318 vm_offset_t nextpaddr; 319 320 if (map != NULL) 321 panic("bus_dmamap_load: Invalid map\n"); 322 323 vaddr = (vm_offset_t)buf; 324 sg = &dm_segments[0]; 325 seg = 1; 326 sg->ds_len = 0; 327 nextpaddr = 0; 328 329 do { 330 bus_size_t size; 331 332 paddr = pmap_kextract(vaddr); 333 size = PAGE_SIZE - (paddr & PAGE_MASK); 334 if (size > buflen) 335 size = buflen; 336 337 if (sg->ds_len == 0) { 338 sg->ds_addr = paddr; 339 sg->ds_len = size; 340 } else if (paddr == nextpaddr) { 341 sg->ds_len += size; 342 } else { 343 /* Go to the next segment */ 344 sg++; 345 seg++; 346 if (seg > dmat->nsegments) 347 break; 348 sg->ds_addr = paddr; 349 sg->ds_len = size; 350 } 351 vaddr += size; 352 nextpaddr = paddr + size; 353 buflen -= size; 354 355 } while (buflen > 0); 356 357 if (buflen != 0) { 358 printf("bus_dmamap_load: Too many segs! buf_len = 0x%lx\n", 359 (u_long)buflen); 360 error = EFBIG; 361 } 362 363 (*callback)(callback_arg, dm_segments, seg, error); 364 365 return (0); 366} 367 368/* 369 * Utility function to load a linear buffer. lastaddrp holds state 370 * between invocations (for multiple-buffer loads). segp contains 371 * the starting segment on entrance, and the ending segment on exit. 372 * first indicates if this is the first invocation of this function. 373 */ 374static int 375bus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dma_segment_t segs[], 376 void *buf, bus_size_t buflen, struct thread *td, 377 int flags, vm_offset_t *lastaddrp, int *segp, 378 int first) 379{ 380 bus_size_t sgsize; 381 bus_addr_t curaddr, lastaddr, baddr, bmask; 382 vm_offset_t vaddr = (vm_offset_t)buf; 383 int seg; 384 pmap_t pmap; 385 386 if (td != NULL) 387 pmap = vmspace_pmap(td->td_proc->p_vmspace); 388 else 389 pmap = NULL; 390 391 lastaddr = *lastaddrp; 392 bmask = ~(dmat->boundary - 1); 393 394 for (seg = *segp; buflen > 0 ; ) { 395 /* 396 * Get the physical address for this segment. 397 */ 398 if (pmap) 399 curaddr = pmap_extract(pmap, vaddr); 400 else 401 curaddr = pmap_kextract(vaddr); 402 403 /* 404 * Compute the segment size, and adjust counts. 405 */ 406 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK); 407 if (buflen < sgsize) 408 sgsize = buflen; 409 410 /* 411 * Make sure we don't cross any boundaries. 412 */ 413 if (dmat->boundary > 0) { 414 baddr = (curaddr + dmat->boundary) & bmask; 415 if (sgsize > (baddr - curaddr)) 416 sgsize = (baddr - curaddr); 417 } 418 419 /* 420 * Insert chunk into a segment, coalescing with 421 * the previous segment if possible. 422 */ 423 if (first) { 424 segs[seg].ds_addr = curaddr; 425 segs[seg].ds_len = sgsize; 426 first = 0; 427 } else { 428 if (curaddr == lastaddr && 429 (segs[seg].ds_len + sgsize) <= dmat->maxsegsz && 430 (dmat->boundary == 0 || 431 (segs[seg].ds_addr & bmask) == (curaddr & bmask))) 432 segs[seg].ds_len += sgsize; 433 else { 434 if (++seg >= dmat->nsegments) 435 break; 436 segs[seg].ds_addr = curaddr; 437 segs[seg].ds_len = sgsize; 438 } 439 } 440 441 lastaddr = curaddr + sgsize; 442 vaddr += sgsize; 443 buflen -= sgsize; 444 } 445 446 *segp = seg; 447 *lastaddrp = lastaddr; 448 449 /* 450 * Did we fit? 451 */ 452 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */ 453} 454 455/* 456 * Like bus_dmamap_load(), but for mbufs. 457 */ 458int 459bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, struct mbuf *m0, 460 bus_dmamap_callback2_t *callback, void *callback_arg, 461 int flags) 462{ 463#ifdef __GNUC__ 464 bus_dma_segment_t dm_segments[dmat->nsegments]; 465#else 466 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 467#endif 468 int nsegs = 0, error = 0; 469 470 M_ASSERTPKTHDR(m0); 471 472 if (m0->m_pkthdr.len <= dmat->maxsize) { 473 int first = 1; 474 vm_offset_t lastaddr = 0; 475 struct mbuf *m; 476 477 for (m = m0; m != NULL && error == 0; m = m->m_next) { 478 if (m->m_len > 0) { 479 error = bus_dmamap_load_buffer(dmat, 480 dm_segments, m->m_data, m->m_len, NULL, 481 flags, &lastaddr, &nsegs, first); 482 first = 0; 483 } 484 } 485 } else { 486 error = EINVAL; 487 } 488 489 if (error) { 490 /* 491 * force "no valid mappings" on error in callback. 492 */ 493 (*callback)(callback_arg, dm_segments, 0, 0, error); 494 } else { 495 (*callback)(callback_arg, dm_segments, nsegs+1, 496 m0->m_pkthdr.len, error); 497 } 498 return (error); 499} 500 501/* 502 * Like bus_dmamap_load(), but for uios. 503 */ 504int 505bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, struct uio *uio, 506 bus_dmamap_callback2_t *callback, void *callback_arg, 507 int flags) 508{ 509 vm_offset_t lastaddr; 510#ifdef __GNUC__ 511 bus_dma_segment_t dm_segments[dmat->nsegments]; 512#else 513 bus_dma_segment_t dm_segments[BUS_DMAMAP_NSEGS]; 514#endif 515 int nsegs, i, error, first; 516 bus_size_t resid; 517 struct iovec *iov; 518 struct thread *td = NULL; 519 520 resid = uio->uio_resid; 521 iov = uio->uio_iov; 522 523 if (uio->uio_segflg == UIO_USERSPACE) { 524 td = uio->uio_td; 525 KASSERT(td != NULL, 526 ("bus_dmamap_load_uio: USERSPACE but no proc")); 527 } 528 529 first = 1; 530 nsegs = error = 0; 531 for (i = 0; i < uio->uio_iovcnt && resid != 0 && !error; i++) { 532 /* 533 * Now at the first iovec to load. Load each iovec 534 * until we have exhausted the residual count. 535 */ 536 bus_size_t minlen = 537 resid < iov[i].iov_len ? resid : iov[i].iov_len; 538 caddr_t addr = (caddr_t) iov[i].iov_base; 539 540 if (minlen > 0) { 541 error = bus_dmamap_load_buffer(dmat, dm_segments, addr, 542 minlen, td, flags, &lastaddr, &nsegs, first); 543 544 first = 0; 545 546 resid -= minlen; 547 } 548 } 549 550 if (error) { 551 /* 552 * force "no valid mappings" on error in callback. 553 */ 554 (*callback)(callback_arg, dm_segments, 0, 0, error); 555 } else { 556 (*callback)(callback_arg, dm_segments, nsegs+1, 557 uio->uio_resid, error); 558 } 559 560 return (error); 561} 562 563/* 564 * Release the mapping held by map. A no-op on PowerPC. 565 */ 566void 567bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map) 568{ 569 570 return; 571} 572 573void 574bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op) 575{ 576 577 return; 578} 579