dmaengine: Add note to dmatest documentation about supported channels
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Mon, 26 Mar 2018 11:50:25 +0000 (14:50 +0300)
committerJonathan Corbet <corbet@lwn.net>
Mon, 26 Mar 2018 16:40:18 +0000 (10:40 -0600)
The documentation is not so clear for newbies in a sense of what type of the
channels are supported by it.

Clarify this by adding a note at the preamble of the documentation.

Reported-by: "Zhu, Tony" <tony.zhu@intel.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-By: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/driver-api/dmaengine/dmatest.rst

index 3922c0a3f0c09c7d4d0e8e775796bf4d05a25dfe..9b0dcdb7b7a8dfa7f46a1bd66ea24d7ece04dbe9 100644 (file)
@@ -6,6 +6,11 @@ Andy Shevchenko <andriy.shevchenko@linux.intel.com>
 
 This small document introduces how to test DMA drivers using dmatest module.
 
+.. note::
+  The test suite works only on the channels that have at least one
+  capability of the following: DMA_MEMCPY (memory-to-memory), DMA_MEMSET
+  (const-to-memory or memory-to-memory, when emulated), DMA_XOR, DMA_PQ.
+
 Part 1 - How to build the test module
 =====================================