LKML Archive on
help / color / mirror / Atom feed
From: Daniel Thompson <>
To: Vinod Koul <>, Jonathan Corbet <>
Cc: Daniel Thompson <>,
	Andy Shevchenko <>,,,,
Subject: [PATCH 1/2] Documentation: dmaengine: Add a description of what dmatest does
Date: Thu, 18 Nov 2021 10:09:51 +0000	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

Currently it can difficult to determine what dmatest does without
reading the source code. Let's add a description.

The description is taken mostly from the patch header of
commit 4a776f0aa922 ("dmatest: Simple DMA memcpy test client").
It has been edited and updated slightly. Nevertheless the new text was
largely written by Haarvard Skinnemoen and was copied from another
patch, already committed to the kernel, which has Haarvard's SoB:
attached to it.

Signed-off-by: Daniel Thompson <>
Reviewed-by: Andy Shevchenko <>
 Documentation/driver-api/dmaengine/dmatest.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/driver-api/dmaengine/dmatest.rst b/Documentation/driver-api/dmaengine/dmatest.rst
index ee268d445d38..529cc2cbbb1b 100644
--- a/Documentation/driver-api/dmaengine/dmatest.rst
+++ b/Documentation/driver-api/dmaengine/dmatest.rst
@@ -6,6 +6,16 @@ Andy Shevchenko <>
 This small document introduces how to test DMA drivers using dmatest module.
+The dmatest module tests DMA memcpy, memset, XOR and RAID6 P+Q operations using
+various lengths and various offsets into the source and destination buffers. It
+will initialize both buffers with a repeatable pattern and verify that the DMA
+engine copies the requested region and nothing more. It will also verify that
+the bytes aren't swapped around, and that the source buffer isn't modified.
+The dmatest module can be configured to test a specific channel. It can also
+test multiple channels at the same time, and it can start multiple threads
+competing for the same channel.
 .. 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

  reply	other threads:[~2021-11-18 10:11 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-18 10:09 [PATCH 0/2] Documentation: dmaengine: Tweak dmatest docs Daniel Thompson
2021-11-18 10:09 ` Daniel Thompson [this message]
2021-11-18 10:09 ` [PATCH 2/2] Documentation: dmaengine: Correctly describe dmatest with channel unset Daniel Thompson
2021-11-22  7:01 ` [PATCH 0/2] Documentation: dmaengine: Tweak dmatest docs Vinod Koul
  -- strict thread matches above, loose matches on Subject: below --
2021-08-18 15:13 Daniel Thompson
2021-08-18 15:13 ` [PATCH 1/2] Documentation: dmaengine: Add a description of what dmatest does Daniel Thompson
2021-08-18 15:27   ` Andy Shevchenko
2021-08-19  9:13     ` Daniel Thompson
2021-08-26 12:52       ` Vinod Koul

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \ \ \
    --subject='Re: [PATCH 1/2] Documentation: dmaengine: Add a description of what dmatest does' \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).