[v1,1/3] dmaengine: Add note to dmatest documentation about supported channels

[v1,1/3] dmaengine: Add note to dmatest documentation about supported channels

[Vinod Koul]

On Mon, Mar 26, 2018 at 08:45:16AM -0600, Jonathan Corbet wrote:
> On Mon, 26 Mar 2018 14:50:25 +0300
> Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:
> 
> > 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.
> 
> Applied to the docs tree, thanks.

Lgtm, you can add my ack if not pushed out

Acked-By: Vinod Koul <vinod.koul@intel.com>

[v1,1/3] dmaengine: Add note to dmatest documentation about supported channels

[Jonathan Corbet]

On Mon, 26 Mar 2018 14:50:25 +0300
Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:

> 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.

Applied to the docs tree, thanks.

jon
---
To unsubscribe from this list: send the line "unsubscribe dmaengine" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[v1,1/3] dmaengine: Add note to dmatest documentation about supported channels

[Andy Shevchenko]

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>
---
 Documentation/driver-api/dmaengine/dmatest.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/driver-api/dmaengine/dmatest.rst b/Documentation/driver-api/dmaengine/dmatest.rst
index 3922c0a3f0c0..9b0dcdb7b7a8 100644
--- a/Documentation/driver-api/dmaengine/dmatest.rst
+++ b/Documentation/driver-api/dmaengine/dmatest.rst
@@ -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
 =====================================