Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1442202

[PATCH v6 46/46] dma-mapping: Document the DMA attributes next to the declaration

From Krzysztof Kozlowski <k.kozlowski@samsung.com>
Newsgroups linux.kernel
Subject [PATCH v6 46/46] dma-mapping: Document the DMA attributes next to the declaration
Date 2016-07-13 10:50 +0200
Message-ID <rUo1J-za-101@gated-at.bofh.it> (permalink)
References (41 earlier) <rUo1I-za-85@gated-at.bofh.it> <rUo1J-za-87@gated-at.bofh.it> <rUo1J-za-89@gated-at.bofh.it> <rUo1I-za-67@gated-at.bofh.it> <rUo1J-za-103@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


Copy documentation abstract about each DMA attribute from
Documentation/DMA-attributes.txt to the place with declaration.

Suggested-by: Christoph Hellwig <hch@infradead.org>
Signed-off-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
---
 include/linux/dma-mapping.h | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/include/linux/dma-mapping.h b/include/linux/dma-mapping.h
index d8fb67783cb7..66533e18276c 100644
--- a/include/linux/dma-mapping.h
+++ b/include/linux/dma-mapping.h
@@ -14,14 +14,47 @@
 /**
  * List of possible attributes associated with a DMA mapping. The semantics
  * of each attribute should be defined in Documentation/DMA-attributes.txt.
+ *
+ * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute
+ * forces all pending DMA writes to complete.
  */
 #define DMA_ATTR_WRITE_BARRIER		(1UL << 0)
+/*
+ * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
+ * may be weakly ordered, that is that reads and writes may pass each other.
+ */
 #define DMA_ATTR_WEAK_ORDERING		(1UL << 1)
+/*
+ * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
+ * buffered to improve performance.
+ */
 #define DMA_ATTR_WRITE_COMBINE		(1UL << 2)
+/*
+ * DMA_ATTR_NON_CONSISTENT: Lets the platform to choose to return either
+ * consistent or non-consistent memory as it sees fit.
+ */
 #define DMA_ATTR_NON_CONSISTENT		(1UL << 3)
+/*
+ * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
+ * virtual mapping for the allocated buffer.
+ */
 #define DMA_ATTR_NO_KERNEL_MAPPING	(1UL << 4)
+/*
+ * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
+ * the CPU cache for the given buffer assuming that it has been already
+ * transferred to 'device' domain.
+ */
 #define DMA_ATTR_SKIP_CPU_SYNC		(1UL << 5)
+/*
+ * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
+ * in physical memory.
+ */
 #define DMA_ATTR_FORCE_CONTIGUOUS	(1UL << 6)
+/*
+ * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
+ * that it's probably not worth the time to try to allocate memory to in a way
+ * that gives better TLB efficiency.
+ */
 #define DMA_ATTR_ALLOC_SINGLE_PAGES	(1UL << 7)
 
 /*
-- 
1.9.1

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[PATCH v6 12/46] drm/exynos: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
  [PATCH v6 17/46] infiniband: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
    [PATCH v6 31/46] microblaze: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 32/46] mips: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
        [PATCH v6 44/46] remoteproc: qcom: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          [PATCH v6 46/46] dma-mapping: Document the DMA attributes next to the  declaration Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          [PATCH v6 45/46] dma-mapping: Remove dma_get_attr Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          Re: [PATCH v6 44/46] remoteproc: qcom: Use unsigned long for  dma_attrs Bjorn Andersson <bjorn.andersson@linaro.org> - 2016-07-13 19:00 +0200
        [PATCH v6 42/46] unicore32: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          [PATCH v6 43/46] xtensa: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
        [PATCH v6 33/46] mn10300: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          [PATCH v6 35/46] openrisc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
            [PATCH v6 38/46] s390: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
              [PATCH v6 41/46] tile: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
              [PATCH v6 39/46] sh: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
                [PATCH v6 40/46] sparc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
            [PATCH v6 37/46] misc: mic: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
            [PATCH v6 36/46] parisc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
          [PATCH v6 34/46] nios2: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
    [PATCH v6 28/46] ia64: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 29/46] m68k: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
        [PATCH v6 30/46] metag: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
    [PATCH v6 26/46] h8300: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 27/46] hexagon: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
    [PATCH v6 22/46] powerpc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 25/46] iommu: intel: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 23/46] video: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
        [PATCH v6 24/46] x86: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
    [PATCH v6 18/46] iommu: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
      [PATCH v6 19/46] [media] dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
        [PATCH v6 20/46] xen: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
          [PATCH v6 21/46] swiotlb: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
    Re: [PATCH v6 17/46] infiniband: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 12:50 +0200
      Re: [PATCH v6 17/46] infiniband: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 13:10 +0200
    [PATCH v6.1] infiniband: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 13:20 +0200
      Re: [PATCH v6.1] infiniband: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 13:20 +0200
    [PATCH v6.2] infiniband: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 14:00 +0200
  [PATCH v6 14/46] drm/msm: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200
    [PATCH v6 16/46] drm/rockship: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
    [PATCH v6 15/46] drm/nouveau: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 11:00 +0200
  [PATCH v6 13/46] drm/mediatek: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-07-13 10:50 +0200

csiph-web