share/man/man9/bus_dma.9

   1 .\" Copyright (c) 2002, 2003 Hiten M. Pandya.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions, and the following disclaimer,
   9 .\"    without modification, immediately at the beginning of the file.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR, CONTRIBUTORS OR THE
  17 .\" VOICES IN HITEN PANDYA'S HEAD BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  18 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  19 .\" TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20 .\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  21 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  22 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
  26 .\" All rights reserved.
  27 .\"
  28 .\" This code is derived from software contributed to The NetBSD Foundation
  29 .\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  30 .\" NASA Ames Research Center.
  31 .\"
  32 .\" Redistribution and use in source and binary forms, with or without
  33 .\" modification, are permitted provided that the following conditions
  34 .\" are met:
  35 .\" 1. Redistributions of source code must retain the above copyright
  36 .\"    notice, this list of conditions and the following disclaimer.
  37 .\" 2. Redistributions in binary form must reproduce the above copyright
  38 .\"    notice, this list of conditions and the following disclaimer in the
  39 .\"    documentation and/or other materials provided with the distribution.
  40 .\" 3. All advertising materials mentioning features or use of this software
  41 .\"    must display the following acknowledgment:
  42 .\"     This product includes software developed by the NetBSD
  43 .\"     Foundation, Inc. and its contributors.
  44 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  45 .\"    contributors may be used to endorse or promote products derived
  46 .\"    from this software without specific prior written permission.
  47 .\"
  48 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  49 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  50 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  51 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  52 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  53 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  54 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  55 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  56 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  57 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  58 .\" POSSIBILITY OF SUCH DAMAGE.
  59 .\"
  60 .\" $FreeBSD$
  61 .\" $NetBSD: bus_dma.9,v 1.25 2002/10/14 13:43:16 wiz Exp $
  62 .\"
  63 .Dd May 28, 2003
  64 .Dt BUS_DMA 9
  65 .Os
  66 .Sh NAME
  67 .Nm bus_dma ,
  68 .Nm bus_dma_tag_create ,
  69 .Nm bus_dma_tag_destroy ,
  70 .Nm bus_dmamap_create ,
  71 .Nm bus_dmamap_destroy ,
  72 .Nm bus_dmamap_load ,
  73 .Nm bus_dmamap_load_mbuf ,
  74 .Nm bus_dmamap_load_uio ,
  75 .Nm bus_dmamap_unload ,
  76 .Nm bus_dmamap_sync ,
  77 .Nm bus_dmamem_alloc ,
  78 .Nm bus_dmamem_free
  79 .Nd Bus and Machine Independent DMA Mapping Interface
  80 .Sh SYNOPSIS
  81 .In machine/bus.h
  82 .Ft int
  83 .Fn bus_dma_tag_create "bus_dma_tag_t parent" "bus_size_t alignment" \
  84 "bus_size_t boundary" "bus_addr_t lowaddr" "bus_addr_t highaddr" \
  85 "bus_dma_filter_t *filtfunc" "void *filtfuncarg" "bus_size_t maxsize" \
  86 "int nsegments" "bus_size_t maxsegsz" "int flags" "bus_dma_lock_t *lockfunc" \
  87 "void *lockfuncarg" "bus_dma_tag_t *dmat"
  88 .Ft int
  89 .Fn bus_dma_tag_destroy "bus_dma_tag_t dmat"
  90 .Ft int
  91 .Fn bus_dmamap_create "bus_dma_tag_t dmat" "int flags" "bus_dmamap_t *mapp"
  92 .Ft int
  93 .Fn bus_dmamap_destroy "bus_dma_tag_t dmat" "bus_dmamap_t map"
  94 .Ft int
  95 .Fn bus_dmamap_load "bus_dma_tag_t dmat" "bus_dmamap_t map" "void *buf" \
  96 "bus_size_t buflen" "bus_dmamap_callback_t *callback" "void *callback_arg" \
  97 "int flags"
  98 .Ft int
  99 .Fn bus_dmamap_load_mbuf "bus_dma_tag_t dmat" "bus_dmamap_t map" \
 100 "struct mbuf *mbuf" "bus_dmamap_callback2_t *callback" "void *callback_arg" \
 101 "int flags"
 102 .Ft int
 103 .Fn bus_dmamap_load_uio "bus_dma_tag_t dmat" "bus_dmamap_t map" \
 104 "struct uio *uio" "bus_dmamap_callback2_t *callback" "void *callback_arg" \
 105 "int flags"
 106 .Ft void
 107 .Fn bus_dmamap_unload "bus_dma_tag_t dmat" "bus_dmamap_t map"
 108 .Ft void
 109 .Fn bus_dmamap_sync "bus_dma_tag_t dmat" "bus_dmamap_t map" \
 110 "op"
 111 .Ft int
 112 .Fn bus_dmamem_alloc "bus_dma_tag_t dmat" "void **vaddr" \
 113 "int flags" "bus_dmamap_t *mapp"
 114 .Ft void
 115 .Fn bus_dmamem_free "bus_dma_tag_t dmat" "void *vaddr" \
 116 "bus_dmamap_t map"
 117 .Sh DESCRIPTION
 118 Direct Memory Access (DMA) is a method of transferring data
 119 without involving the CPU, thus providing higher performance.
 120 A DMA transaction can be achieved between device to memory,
 121 device to device, or memory to memory.
 122 .Pp
 123 The
 124 .Nm
 125 API is a bus, device, and machine-independent (MI) interface to
 126 DMA mechanisms.
 127 It provides the client with flexibility and simplicity by
 128 abstracting machine dependent issues like setting up
 129 DMA mappings, handling cache issues, bus specific features
 130 and limitations.
 131 .Sh STRUCTURES AND TYPES
 132 .Bl -tag -width compact
 133 .It Vt bus_dma_tag_t
 134 A machine-dependent (MD) opaque type that describes the
 135 characteristics of DMA transactions.
 136 DMA tags are organized into a hierarchy, with each child
 137 tag inheriting the restrictions of its parent.
 138 This allows all devices along the path of DMA transactions
 139 to contribute to the constraints of those transactions.
 140 .It Vt bus_dma_filter_t
 141 Client specified address filter having the format:
 142 .Bl -tag -width compact
 143 .It Ft int
 144 .Fn "client_filter" "void *filtarg" "bus_addr_t testaddr"
 145 .El
 146 .sp
 147 Address filters can be specified during tag creation to allow
 148 for devices who's DMA address restrictions cannot be specified
 149 by a single window.
 150 The
 151 .Fa filtarg
 152 is client specified during tag creation to be passed to all
 153 invocations of the callback.
 154 The
 155 .Fa testaddr
 156 argument contains a potential starting address of a DMA mapping.
 157 The filter function operates on the set of addresses from
 158 .Fa testaddr
 159 to
 160 .Ql trunc_page(testaddr) + PAGE_SIZE - 1 ,
 161 inclusive.
 162 The filter function should return zero for any mapping in this range
 163 that can be accommodated by the device and non-zero otherwise.
 164 .It Vt bus_dma_segment_t
 165 A machine-dependent type that describes individual
 166 DMA segments.
 167 .Bd -literal
 168         bus_addr_t      ds_addr;
 169         bus_size_t      ds_len;
 170 .Ed
 171 .sp
 172 The
 173 .Fa ds_addr
 174 field contains the device visible address of the DMA segment, and
 175 .Fa ds_len
 176 contains the length of the DMA segment.
 177 Although the DMA segments returned by a mapping call will adhere to
 178 all restrictions necessary for a successful DMA operation, some conversion
 179 (e.g.\& a conversion from host byte order to the device's byte order) is
 180 almost always required when presenting segment information to the device.
 181 .It Vt bus_dmamap_t
 182 A machine-dependent opaque type describing an individual mapping.
 183 Multiple DMA maps can be associated with one DMA tag.
 184 .It Vt bus_dmamap_callback_t
 185 Client specified callback for receiving mapping information resulting from
 186 the load of a
 187 .Vt bus_dmamap_t
 188 via
 189 .Fn bus_dmamap_load .
 190 Callbacks are of the format:
 191 .Bl -tag -width compact
 192 .It Ft void
 193 .Fn "client_callback" "void *callback_arg" "bus_dma_segment_t *segs" \
 194 "int nseg" "int error"
 195 .El
 196 .sp
 197 The
 198 .Fa callback_arg
 199 is the callback argument passed to dmamap load functions.
 200 The
 201 .Fa segs
 202 and
 203 .Fa nseg
 204 parameters describe an array of
 205 .Vt bus_dma_segment_t
 206 structures that represent the mapping.
 207 This array is only valid within the scope of the callback function.
 208 The success or failure of the mapping is indicated by the
 209 .Fa error
 210 parameter.
 211 More information on the use of callbacks can be found in the
 212 description of the individual dmamap load functions.
 213 .It Vt bus_dmamap_callback2_t
 214 Client specified callback for receiving mapping information resulting from
 215 the load of a
 216 .Vt bus_dmamap_t
 217 via
 218 .Fn bus_dmamap_load_uio
 219 or
 220 .Fn bus_dmamap_load_mbuf .
 221 .sp
 222 Callback2s are of the format:
 223 .Bl -tag -width compact
 224 .It Ft void
 225 .Fn "client_callback2" "void *callback_arg" "bus_dma_segment_t *segs" \
 226 "int nseg" "bus_size_t mapsize" "int error"
 227 .El
 228 .sp
 229 Callback2's behavior is the same as
 230 .Vt bus_dmamap_callback_t
 231 with the addition that the length of the data mapped is provided via
 232 .Fa mapsize .
 233 .It Vt bus_dmasync_op_t
 234 Memory synchronization operation specifier.
 235 Bus DMA requires explicit synchronization of memory with it's device
 236 visible mapping in order to guarantee memory coherency.
 237 The
 238 .Vt bus_dmasync_op_t
 239 allows the type of DMA operation that will be or has been performed
 240 to be communicated to the system so that the correct coherency measures
 241 are taken.
 242 All operations specified below are performed from the CPU's
 243 point of view (for a complete description, see the
 244 .Fn bus_dmamap_sync
 245 description below):
 246 .Bl -tag -width BUS_DMASYNC_POSTWRITE
 247 .It Dv BUS_DMASYNC_PREREAD
 248 Perform any synchronization required after an update of memory by the CPU
 249 but prior to DMA read operations.
 250 .It Dv BUS_DMASYNC_PREWRITE
 251 Perform any synchronization required after an update of memory by the CPU
 252 but prior to DMA write operations.
 253 .It Dv BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE
 254 Perform any synchronization required prior to a combination of DMA read
 255 and write operations.
 256 .It Dv BUS_DMASYNC_POSTREAD
 257 Perform any synchronization required after DMA read operations, but prior
 258 to CPU access of the memory.
 259 .It Dv BUS_DMASYNC_POSTWRITE
 260 Perform any synchronization required after DMA write operations, but prior
 261 to CPU access of the memory.
 262 .It Dv BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE
 263 Perform any synchronization required after a combination of DMA read
 264 and write operations.
 265 .El
 266 .It Vt bus_dma_lock_t
 267 Client specified lock/mutex manipulation method.
 268 This will be called from
 269 within busdma whenever a client lock needs to be manipulated.
 270 In its current form, the function will be called immediately before
 271 the callback for a dma load operation that has been deferred with
 272 .Dv BUS_DMA_LOCK
 273 and immediately after with
 274 .Dv BUS_DMA_UNLOCK .
 275 If the load operation does not need to be deferred, then it
 276 will not be called since the function loading the map should
 277 be holding the appropriate locks.
 278 This method is of the format:
 279 .Bl -tag -width compact
 280 .It Ft void
 281 .Fn "lockfunc" "void *lockfunc_arg" "bus_dma_lock_op_t op"
 282 .El
 283 .sp
 284 Two
 285 .Vt lockfunc
 286 implementations are provided for convenience.
 287 .Fn busdma_lock_mutex
 288 performs standard mutex operations on the sleep mutex provided via the
 289 .Fa lockfuncarg .
 290 passed into
 291 .Fn bus_dma_tag_create .
 292 .Fn dflt_lock
 293 will generate a system panic if it is called.
 294 It is substituted into the tag when
 295 .Fa lockfunc
 296 is passed as NULL to
 297 .Fn bus_dma_tag_create .
 298 .It Vt bus_dma_lock_op_t
 299 Operations to be performed by the client-specified
 300 .Fn lockfunc .
 301 .Bl -tag -width BUS_DMA_UNLOCK
 302 .It Dv BUS_DMA_LOCK
 303 Acquires and/or locks the client locking primitive.
 304 .It Dv BUS_DMA_UNLOCK
 305 Releases and/or unlocks the client locking primitive.
 306 .El
 307 .El
 308 .sp
 309 .Sh FUNCTIONS
 310 .Bl -tag -width compact
 311 .It Fn bus_dma_tag_create "parent" "alignment" "boundary" "lowaddr" \
 312 "highaddr" "*filtfunc" "*filtfuncarg" "maxsize" "nsegments" "maxsegsz" \
 313 "flags" "lockfunc" "lockfuncarg" "*dmat"
 314 Allocates a device specific DMA tag, and initializes it according to
 315 the arguments provided:
 316 .Bl -tag -width *filtfuncarg -compact
 317 .It Fa parent
 318 Indicates restrictions between the parent bridge, CPU memory, and the
 319 device.
 320 May be NULL, if no DMA restrictions are to be inherited.
 321 .It Fa alignment
 322 Alignment constraint, in bytes, of any mappings created using this tag.
 323 The alignment must be a power of 2.
 324 Hardware that can DMA starting at any address would specify
 325 .Em 1
 326 for byte alignment.
 327 Hardware requiring DMA transfers to start on a multiple of 4K
 328 would specify
 329 .Em 4096.
 330 .It Fa boundary
 331 Boundary constraint, in bytes, of the target DMA memory region.
 332 The boundary indicates the set of addresses, all multiples of the
 333 boundary argument, that cannot be crossed by a single
 334 .Vt bus_dma_segment_t .
 335 The boundary must be a power of 2 and must be no smaller that the
 336 maximum segment size.
 337 .Ql 0
 338 indicates that there are no boundary restrictions.
 339 .It Fa lowaddr
 340 .It Fa highaddr
 341 Bounds of the window of bus address space that
 342 .Em cannot
 343 be directly accessed by the device.
 344 The window contains all address greater than lowaddr and
 345 less than or equal to highaddr.
 346 For example, a device incapable of DMA above 4GB, would specify
 347 a highaddr of
 348 .Dv BUS_SPACE_MAXADDR
 349 and a lowaddr of
 350 .Dv BUS_SPACE_MAXADDR_32BIT .
 351 Similarly a device that can only dma to addresses bellow 16MB would
 352 specify a highaddr of
 353 .Dv BUS_SPACE_MAXADDR
 354 and a lowaddr of
 355 .Dv BUS_SPACE_MAXADDR_24BIT .
 356 Some implementations requires that some region of device visible
 357 address space, overlapping available host memory, be outside the
 358 window.
 359 This area of
 360 .Ql safe memory
 361 is used to bounce requests that would otherwise conflict with
 362 the exclusion window.
 363 .It Fa filtfunc
 364 Optional filter function (may be NULL) to be called for any attempt to
 365 map memory into the window described by
 366 .Fa lowaddr
 367 and
 368 .Fa highaddr.
 369 A filter function is only required when the single window described
 370 by
 371 .Fa lowaddr
 372 and
 373 .Fa highaddr
 374 cannot adequately describe the constraints of the device.
 375 The filter function will be called for every machine page
 376 that overlaps the exclusion window.
 377 .It Fa filtfuncarg
 378 Argument passed to all calls to the filter function for this tag.
 379 May be NULL.
 380 .It Fa maxsize
 381 Maximum size, in bytes, of the sum of all segment lengths in a given
 382 DMA mapping associated with this tag.
 383 .It Fa nsegments
 384 Number of discontinuities (scatter/gather segments) allowed
 385 in a DMA mapped region.
 386 If there is no restriction,
 387 .Dv BUS_SPACE_UNRESTRICTED
 388 may be specified.
 389 .It Fa maxsegsz
 390 Maximum size, in bytes, of a segment in any DMA mapped region associated
 391 with
 392 .Fa dmat .
 393 .It Fa flags
 394 Are as follows:
 395 .Bl -tag -width "BUS_DMA_ALLOCNOW" -compact
 396 .It Dv BUS_DMA_ALLOCNOW
 397 Allocate the resources necessary to guarantee that all map load
 398 operations associated with this tag will not block.
 399 If sufficient resources are not available,
 400 .Er ENOMEM
 401 is returned.
 402 .El
 403 .It Fa lockfunc
 404 Optional lock manipulation function (may be NULL) to be called when busdma
 405 needs to manipulate a lock on behalf of the client.
 406 If NULL is specified,
 407 .Fn dflt_lock
 408 is used.
 409 .It Fa lockfuncarg
 410 Optional argument to be passed to the function specified by
 411 .Fa lockfunc .
 412 .It Fa dmat
 413 Pointer to a bus_dma_tag_t where the resulting DMA tag will
 414 be stored.
 415 .El
 416 .Pp
 417 Returns
 418 .Er ENOMEM
 419 if sufficient memory is not available for tag creation
 420 or allocating mapping resources.
 421 .It Fn bus_dma_tag_destroy "dmat"
 422 Deallocate the DMA tag
 423 .Fa dmat
 424 that was created by
 425 .Fn bus_dma_tag_create .
 426 .Pp
 427 Returns
 428 .Er EBUSY
 429 if any DMA maps remain associated with
 430 .Fa dmat
 431 or
 432 .Ql 0
 433 on success.
 434 .It Fn bus_dmamap_create "dmat" "flags" "*mapp"
 435 Allocates and initializes a DMA map.
 436 Arguments are as follows:
 437 .Bl -tag -width nsegments -compact
 438 .It Fa dmat
 439 DMA tag.
 440 .It Fa flags
 441 The value of this argument is currently undefined and should be
 442 specified as
 443 .Ql 0 .
 444 .It Fa mapp
 445 Pointer to a
 446 .Vt bus_dmamap_t
 447 where the resulting DMA map will be stored.
 448 .El
 449 .Pp
 450 Returns
 451 .Er ENOMEM
 452 if sufficient memory is not available for creating the
 453 map or allocating mapping resources.
 454 .It Fn bus_dmamap_destroy "dmat" "map"
 455 Frees all resources associated with a given DMA map.
 456 Arguments are as follows:
 457 .Bl -tag -width dmat -compact
 458 .It Fa dmat
 459 DMA tag used to allocate
 460 .Fa map .
 461 .It Fa map
 462 The DMA map to destroy.
 463 .El
 464 .Pp
 465 Returns
 466 .Er EBUSY
 467 if a mapping is still active for
 468 .Fa map .
 469 .It Fn bus_dmamap_load "dmat" "map" "buf" "buflen" "*callback" \
 470 "callback_arg" "flags"
 471 Creates a mapping in device visible address space of
 472 .Fa buflen
 473 bytes of
 474 .Fa buf ,
 475 associated with the DMA map
 476 .Fa map.
 477 Arguments are as follows:
 478 .Bl -tag -width buflen -compact
 479 .It Fa dmat
 480 DMA tag used to allocate
 481 .Fa map.
 482 .It Fa map
 483 A DMA map without a currently active mapping.
 484 .It Fa buf
 485 A kernel virtual address pointer to a contiguous (in KVA) buffer, to be
 486 mapped into device visible address space.
 487 .It Fa buflen
 488 The size of the buffer.
 489 .It Fa callback Fa callback_arg
 490 The callback function, and its argument.
 491 .It Fa flags
 492 The value of this argument is currently undefined, and should be
 493 specified as
 494 .Ql 0 .
 495 .El
 496 .Pp
 497 Return values to the caller are as follows:
 498 .Bl -tag -width EINPROGRESS -compact
 499 .It 0
 500 The callback has been called and completed.
 501 The status of the mapping has been delivered to the callback.
 502 .It Er EINPROGRESS
 503 The mapping has been deferred for lack of resources.
 504 The callback will be called as soon as resources are available.
 505 Callbacks are serviced in FIFO order.
 506 DMA maps created from DMA tags that are allocated with
 507 the
 508 .Dv BUS_DMA_ALLOCNOW
 509 flag will never return this status for a load operation.
 510 .It Er EINVAL
 511 The load request was invalid.
 512 The callback has not, and will not be called.
 513 This error value may indicate that
 514 .Fa dmat ,
 515 .Fa map ,
 516 .Fa buf ,
 517 or
 518 .Fa callback
 519 were invalid, or
 520 .Fa buslen
 521 was larger than the
 522 .Fa maxsize
 523 argument used to create the dma tag
 524 .Fa dmat .
 525 .El
 526 .Pp
 527 When the callback is called, it is presented with an error value
 528 indicating the disposition of the mapping.
 529 Error may be one of the following:
 530 .Bl -tag -width EINPROGRESS -compact
 531 .It 0
 532 The mapping was successful and the
 533 .Fa dm_segs
 534 callback argument contains an array of
 535 .Vt bus_dma_segment_t
 536 elements describing the mapping.
 537 This array is only valid during the scope of the callback function.
 538 .It Er EFBIG
 539 A mapping could not be achieved within the segment constraints provided
 540 in the tag even though the requested allocation size was less than maxsize.
 541 .El
 542 .It Fn bus_dmamap_load_mbuf "dmat" "map" "mbuf" "callback2" "callback_arg" \
 543 "flags"
 544 This is a variation of
 545 .Fn bus_dmamap_load
 546 which maps mbuf chains
 547 for DMA transfers.
 548 A
 549 .Vt bus_size_t
 550 argument is also passed to the callback routine, which
 551 contains the mbuf chain's packet header length.
 552 .Pp
 553 Mbuf chains are assumed to be in kernel virtual address space.
 554 .Pp
 555 Returns
 556 .Er EINVAL
 557 if the size of the mbuf chain exceeds the maximum limit of the
 558 DMA tag.
 559 .It Fn bus_dmamap_load_uio "dmat" "map" "uio" "callback2" "callback_arg" "flags"
 560 This is a variation of
 561 .Fn bus_dmamap_load
 562 which maps buffers pointed to by
 563 .Fa uio
 564 for DMA transfers.
 565 A
 566 .Vt bus_size_t
 567 argument is also passed to the callback routine, which contains the size of
 568 .Fa uio ,
 569 i.e.
 570 .Fa uio->uio_resid .
 571 .Pp
 572 If
 573 .Fa uio->uio_segflg
 574 is
 575 .Dv UIO_USERSPACE ,
 576 then it is assumed that the buffer,
 577 .Fa uio
 578 is in
 579 .Fa "uio->uio_td->td_proc" Ns 's
 580 address space.
 581 User space memory must be in-core and wired prior to attempting a map
 582 load operation.
 583 Pages may be locked using
 584 .Xr vslock 9 .
 585 .It Fn bus_dmamap_unload "dmat" "map"
 586 Unloads a DMA map.
 587 Arguments are as follows:
 588 .Bl -tag -width dmam -compact
 589 .It Fa dmat
 590 DMA tag used to allocate
 591 .Fa map .
 592 .It Fa map
 593 The DMA map that is to be unloaded.
 594 .El
 595 .Pp
 596 .Fn bus_dmamap_unload
 597 will not perform any implicit synchronization of DMA buffers.
 598 This must be done explicitly by a call to
 599 .Fn bus_dmamap_sync
 600 prior to unloading the map.
 601 .It Fn bus_dmamap_sync "dmat" "map" "op"
 602 Performs synchronization of a device visible mapping with the CPU visible
 603 memory referenced by that mapping.
 604 Arguments are as follows:
 605 .Bl -tag -width dmat -compact
 606 .It Fa dmat
 607 DMA tag used to allocate
 608 .Fa map .
 609 .It Fa map
 610 The DMA mapping to be synchronized.
 611 .It Fa op
 612 Type of synchronization operation to perform.
 613 See the definition of
 614 .Vt bus_dmasync_op_t
 615 for a description of the acceptable values for
 616 .Fa op .
 617 .El
 618 .Pp
 619 .Fn bus_dmamap_sync
 620 is the method used to ensure that CPU and device DMA access to shared
 621 memory is coherent.
 622 For example, the CPU might be used to setup the contents of a buffer
 623 that is to be DMA'ed into a device.
 624 To ensure that the data are visible via the device's mapping of that
 625 memory, the buffer must be loaded and a dma sync operation of
 626 .Dv BUS_DMASYNC_PREREAD
 627 must be performed.
 628 Additional sync operations must be performed after every CPU write
 629 to this memory if additional DMA reads are to be performed.
 630 Conversely, for the DMA write case, the buffer must be loaded,
 631 and a dma sync operation of
 632 .Dv BUS_DMASYNC_PREWRITE
 633 must be performed.
 634 The CPU will only be able to see the results of this DMA write
 635 once the DMA has completed and a
 636 .Dv BUS_DMASYNC_POSTWRITE
 637 operation has been performed.
 638 .Pp
 639 If DMA read and write operations are not preceded and followed by the
 640 appropriate synchronization operations, behavior is undefined.
 641 .It Fn bus_dmamem_alloc "dmat" "**vaddr" "flags" "mapp"
 642 Allocates memory that is mapped into KVA at the address returned
 643 in
 644 .Fa vaddr
 645 that is permanently loaded into the newly created
 646 .Vt bus_dmamap_t
 647 returned via
 648 .Fa mapp .
 649 Arguments are as follows:
 650 .Bl -tag -width alignment -compact
 651 .It Fa dmat
 652 DMA tag describing the constraints of the DMA mapping.
 653 .It Fa vaddr
 654 Pointer to a pointer that will hold the returned KVA mapping of
 655 the allocated region.
 656 .It Fa flags
 657 Flags are defined as follows:
 658 .Bl -tag -width BUS_DMA_NOWAIT -compact
 659 .It Dv BUS_DMA_WAITOK
 660 The routine can safely wait (sleep) for resources.
 661 .It Dv BUS_DMA_NOWAIT
 662 The routine is not allowed to wait for resources.
 663 If resources are not available,
 664 .Dv ENOMEM
 665 is returned.
 666 .It Dv BUS_DMA_COHERENT
 667 Attempt to map this memory such that cache sync operations are
 668 as cheap as possible.
 669 This flag is typically set on memory that will be accessed by both
 670 a CPU and a DMA engine, frequently.
 671 Use of this flag does not remove the requirement of using
 672 bus_dmamap_sync, but it may reduce the cost of performing
 673 these operations.
 674 .It Dv BUS_DMA_ZERO
 675 Causes the allocated memory to be set to all zeros.
 676 .El
 677 .It Fa mapp
 678 Pointer to storage for the returned DMA map.
 679 .El
 680 .Pp
 681 The size of memory to be allocated is
 682 .Fa maxsize
 683 as specified in
 684 .Fa dmat .
 685 .Pp
 686 The current implementation of
 687 .Fn bus_dmamem_alloc
 688 will allocate all requests as a single segment.
 689 .Pp
 690 Although no explicit loading is required to access the memory
 691 referenced by the returned map, the synchronization requirements
 692 as described in the
 693 .Fn bus_dmamap_sync
 694 section still apply.
 695 .Pp
 696 Returns
 697 .Er ENOMEM
 698 if sufficient memory is not available for completing
 699 the operation.
 700 .It Fn bus_dmamem_free "dmat" "*vaddr" "map"
 701 Frees memory previously allocated by
 702 .Fn bus_dmamem_alloc .
 703 Any mappings
 704 will be invalidated.
 705 Arguments are as follows:
 706 .Bl -tag -width vaddr -compact
 707 .It Fa dmat
 708 DMA tag.
 709 .It Fa vaddr
 710 Kernel virtual address of the memory.
 711 .It Fa map
 712 DMA map to be invalidated.
 713 .El
 714 .El
 715 .Sh RETURN VALUES
 716 Behavior is undefined if invalid arguments are passed to
 717 any of the above functions.
 718 If sufficient resources cannot be allocated for a given
 719 transaction,
 720 .Er ENOMEM
 721 is returned.
 722 All
 723 routines that are not of type,
 724 .Vt void ,
 725 will return 0 on success or an error
 726 code, as discussed above.
 727 .Pp
 728 All
 729 .Vt void
 730 routines will succeed if provided with valid arguments.
 731 .Sh SEE ALSO
 732 .Xr devclass 9 ,
 733 .Xr device 9 ,
 734 .Xr driver 9 ,
 735 .Xr rman 9 ,
 736 .Xr vslock 9
 737 .Pp
 738 .Rs
 739 .%A "Jason R. Thorpe"
 740 .%T "A Machine-Independent DMA Framework for NetBSD"
 741 .%J "Proceedings of the Summer 1998 USENIX Technical Conference"
 742 .%Q "USENIX Association"
 743 .%D "June 1998"
 744 .Re
 745 .Sh HISTORY
 746 The
 747 .Nm
 748 interface first appeared in
 749 .Nx 1.3 .
 750 .Pp
 751 The
 752 .Nm
 753 API was adopted from
 754 .Nx
 755 for use in the CAM SCSI subsystem.
 756 The alterations to the original API were aimed to remove the need for
 757 a
 758 .Vt bus_dma_segment_t
 759 array stored in each
 760 .Vt bus_dmamap_t
 761 while allowing callers to queue up on scarce resources.
 762 .Sh AUTHORS
 763 The
 764 .Nm
 765 interface was designed and implemented by
 766 .An Jason R. Thorpe
 767 of the Numerical Aerospace Simulation Facility, NASA Ames Research Center.
 768 Additional input on the
 769 .Nm
 770 design was provided by
 771 .An -nosplit
 772 .An Chris Demetriou ,
 773 .An Charles Hannum ,
 774 .An Ross Harvey ,
 775 .An Matthew Jacob ,
 776 .An Jonathan Stone ,
 777 and
 778 .An Matt Thomas .
 779 .Pp
 780 The
 781 .Nm
 782 interface in
 783 .Fx
 784 benefits from the contributions of
 785 .An Justin T. Gibbs ,
 786 .An Peter Wemm ,
 787 .An Doug Rabson ,
 788 .An Matthew N. Dodd ,
 789 .An Sam Leffler ,
 790 .An Maxime Henrion ,
 791 .An Jake Burkholder ,
 792 .An Takahashi Yoshihiro ,
 793 .An Scott Long
 794 and many others.
 795 .Pp
 796 This manual page was written by
 797 .An Hiten M. Pandya
 798 and
 799 .An Justin T. Gibbs .