725580de75af0ff2d6aad098597b7bdde0966946
[linux-2.6.git] / Documentation / DMA-attributes.txt
1                         DMA attributes
2                         ==============
3
4 This document describes the semantics of the DMA attributes that are
5 defined in linux/dma-attrs.h.
6
7 DMA_ATTR_WRITE_BARRIER
8 ----------------------
9
10 DMA_ATTR_WRITE_BARRIER is a (write) barrier attribute for DMA.  DMA
11 to a memory region with the DMA_ATTR_WRITE_BARRIER attribute forces
12 all pending DMA writes to complete, and thus provides a mechanism to
13 strictly order DMA from a device across all intervening busses and
14 bridges.  This barrier is not specific to a particular type of
15 interconnect, it applies to the system as a whole, and so its
16 implementation must account for the idiosyncracies of the system all
17 the way from the DMA device to memory.
18
19 As an example of a situation where DMA_ATTR_WRITE_BARRIER would be
20 useful, suppose that a device does a DMA write to indicate that data is
21 ready and available in memory.  The DMA of the "completion indication"
22 could race with data DMA.  Mapping the memory used for completion
23 indications with DMA_ATTR_WRITE_BARRIER would prevent the race.
24
25 DMA_ATTR_WEAK_ORDERING
26 ----------------------
27
28 DMA_ATTR_WEAK_ORDERING specifies that reads and writes to the mapping
29 may be weakly ordered, that is that reads and writes may pass each other.
30
31 Since it is optional for platforms to implement DMA_ATTR_WEAK_ORDERING,
32 those that do not will simply ignore the attribute and exhibit default
33 behavior.
34
35 DMA_ATTR_WRITE_COMBINE
36 ----------------------
37
38 DMA_ATTR_WRITE_COMBINE specifies that writes to the mapping may be
39 buffered to improve performance.
40
41 Since it is optional for platforms to implement DMA_ATTR_WRITE_COMBINE,
42 those that do not will simply ignore the attribute and exhibit default
43 behavior.
44
45 DMA_ATTR_NON_CONSISTENT
46 -----------------------
47
48 DMA_ATTR_NON_CONSISTENT lets the platform to choose to return either
49 consistent or non-consistent memory as it sees fit.  By using this API,
50 you are guaranteeing to the platform that you have all the correct and
51 necessary sync points for this memory in the driver.
52
53 DMA_ATTR_NO_KERNEL_MAPPING
54 --------------------------
55
56 DMA_ATTR_NO_KERNEL_MAPPING lets the platform to avoid creating a kernel
57 virtual mapping for the allocated buffer. On some architectures creating
58 such mapping is non-trivial task and consumes very limited resources
59 (like kernel virtual address space or dma consistent address space).
60 Buffers allocated with this attribute can be only passed to user space
61 by calling dma_mmap_attrs(). By using this API, you are guaranteeing
62 that you won't dereference the pointer returned by dma_alloc_attr(). You
63 can threat it as a cookie that must be passed to dma_mmap_attrs() and
64 dma_free_attrs(). Make sure that both of these also get this attribute
65 set on each call.
66
67 Since it is optional for platforms to implement
68 DMA_ATTR_NO_KERNEL_MAPPING, those that do not will simply ignore the
69 attribute and exhibit default behavior.