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 idiosyncrasies 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 treat 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.
  70
  71 DMA_ATTR_SKIP_CPU_SYNC
  72 ----------------------
  73
  74 By default dma_map_{single,page,sg} functions family transfer a given
  75 buffer from CPU domain to device domain. Some advanced use cases might
  76 require sharing a buffer between more than one device. This requires
  77 having a mapping created separately for each device and is usually
  78 performed by calling dma_map_{single,page,sg} function more than once
  79 for the given buffer with device pointer to each device taking part in
  80 the buffer sharing. The first call transfers a buffer from 'CPU' domain
  81 to 'device' domain, what synchronizes CPU caches for the given region
  82 (usually it means that the cache has been flushed or invalidated
  83 depending on the dma direction). However, next calls to
  84 dma_map_{single,page,sg}() for other devices will perform exactly the
  85 same synchronization operation on the CPU cache. CPU cache synchronization
  86 might be a time consuming operation, especially if the buffers are
  87 large, so it is highly recommended to avoid it if possible.
  88 DMA_ATTR_SKIP_CPU_SYNC allows platform code to skip synchronization of
  89 the CPU cache for the given buffer assuming that it has been already
  90 transferred to 'device' domain. This attribute can be also used for
  91 dma_unmap_{single,page,sg} functions family to force buffer to stay in
  92 device domain after releasing a mapping for it. Use this attribute with
  93 care!
  94
  95 DMA_ATTR_FORCE_CONTIGUOUS
  96 -------------------------
  97
  98 By default DMA-mapping subsystem is allowed to assemble the buffer
  99 allocated by dma_alloc_attrs() function from individual pages if it can
 100 be mapped as contiguous chunk into device dma address space. By
 101 specifying this attribute the allocated buffer is forced to be contiguous
 102 also in physical memory.
 103
 104 DMA_ATTR_STRONGLY_ORDERED
 105 -------------------------
 106
 107 DMA_ATTR_STRONGLY_ORDERED allocates memory with a very restrictive type
 108 of mapping (no unaligned accesses, no re-ordering, no write merging, no
 109 buffering, no pre-fetching). This has severe performance penalties and
 110 should not be used for general purpose DMA allocations. It should only
 111 be used if one of the restrictions on strongly ordered memory is required.
 112
 113 DMA_ATTR_NO_DELAYED_UNMAP
 114 -------------------------
 115
 116 DMA_ATTR_NO_DELAYED_UNMAP is used only by the msm specific lazy mapping
 117 feature. By default, the lazy mapping and unmapping holds an additional
 118 reference so that when the buffer is freed, the mapping is not destroyed
 119 and can be re-used. By specifying this attribute, an additional reference
 120 will NOT be held by the lazy mapping code and it will be released as soon
 121 as the buffer is freed.
 122
 123 DMA_ATTR_EXEC_MAPPING
 124 ---------------------
 125
 126 By default, the DMA mappings are non-executable. Some use cases might require
 127 an executable mapping. This attribute can be used to indicate to the DMA
 128 subsystem to create an executable mappings for the buffer.
 129
 130 DMA_ATTR_FORCE_COHERENT
 131 -----------------------
 132
 133 When passed to a DMA map call the DMA_ATTR_FORCE_COHERENT DMA
 134 attribute can be used to force a buffer to be mapped as IO coherent.
 135
 136 When the DMA_ATTR_FORCE_COHERENT attribute is set during a map call ensure
 137 that it is also set during for the matching unmap call to ensure that the
 138 correct cache maintenance is carried out.
 139
 140 This DMA attribute is only currently supported for arm64 stage 1 IOMMU
 141 mappings.
 142
 143 DMA_ATTR_FORCE_NON_COHERENT
 144 ---------------------------
 145 When passed to a DMA map call the DMA_ATTR_FORCE_NON_COHERENT DMA
 146 attribute can be used to force a buffer to not be mapped as IO
 147 coherent.
 148 The DMA_ATTR_FORCE_NON_COHERENT DMA attribute overrides the buffer IO
 149 coherency configuration set by making the device IO coherent.
 150
 151 When the DMA_ATTR_FORCE_NON_COHERENT attribute is set during a map call
 152 ensure that it is also set during for the matching unmap call to ensure
 153 that the correct cache maintenance is carried out.
 154
 155 This DMA attribute is only currently supported for arm64 stage 1 IOMMU
 156 mappings.