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


Groups > linux.kernel > #1434360

[PATCH v5 44/44] dma-mapping: Document the DMA attributes next to the declaration

From Krzysztof Kozlowski <k.kozlowski@samsung.com>
Newsgroups linux.kernel
Subject [PATCH v5 44/44] dma-mapping: Document the DMA attributes next to the declaration
Date 2016-06-30 10:40 +0200
Message-ID <rPFFU-7jk-31@gated-at.bofh.it> (permalink)
References <rPFwd-7ga-3@gated-at.bofh.it> <rPFwd-7ga-5@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 v5 00/44] dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 12/44] drm/mediatek: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 25/44] h8300: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 02/44] alpha: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 03/44] arc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 05/44] arm64: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
  [PATCH v5 01/44] dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
    [PATCH v5 13/44] drm/msm: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
    [PATCH v5 41/44] unicore32: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:30 +0200
    [PATCH v5 19/44] xen: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
      Re: [PATCH v5 19/44] xen: dma-mapping: Use unsigned long for  dma_attrs Konrad Rzeszutek Wilk <konrad.wilk@oracle.com> - 2016-06-30 15:30 +0200
    [PATCH v5 29/44] metag: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 27/44] ia64: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 36/44] misc: mic: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 30/44] microblaze: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 28/44] m68k: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 35/44] parisc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 43/44] dma-mapping: Remove dma_get_attr Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 21/44] powerpc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 31/44] mips: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 40/44] tile: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 44/44] dma-mapping: Document the DMA attributes next to the  declaration Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 20/44] swiotlb: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
      Re: [PATCH v5 20/44] swiotlb: dma-mapping: Use unsigned long for  dma_attrs Konrad Rzeszutek Wilk <konrad.wilk@oracle.com> - 2016-06-30 15:20 +0200
    [PATCH v5 32/44] mn10300: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 33/44] nios2: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 37/44] s390: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 24/44] iommu: intel: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 26/44] hexagon: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
      Re: [PATCH v5 26/44] hexagon: dma-mapping: Use unsigned long for  dma_attrs Richard Kuo <rkuo@codeaurora.org> - 2016-07-01 02:20 +0200
    [PATCH v5 39/44] sparc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 34/44] openrisc: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:40 +0200
    [PATCH v5 17/44] iommu: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 18/44] [media] dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
      Re: [PATCH v5 18/44] [media] dma-mapping: Use unsigned long for  dma_attrs Marek Szyprowski <m.szyprowski@samsung.com> - 2016-06-30 11:50 +0200
    [PATCH v5 07/44] blackfin: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 22/44] video: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 08/44] c6x: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 14/44] drm/nouveau: dma-mapping: Use unsigned long for  dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 09/44] cris: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 23/44] x86: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 06/44] avr32: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200
    [PATCH v5 04/44] ARM: dma-mapping: Use unsigned long for dma_attrs Krzysztof Kozlowski <k.kozlowski@samsung.com> - 2016-06-30 10:50 +0200

csiph-web