Commit 9dcb98a2 authored by Hook, Gary's avatar Hook, Gary Committed by Vinod Koul

Documentation: dmaengine: clean up description of dmatest usage

Fix the formatting of the multi-channel test usage example. Call out
the note about parameter ordering and add detail on the settings of
parameters for the new version of dmatest.

Fixes: f80f9988 ("dmaengine: Documentation: Add documentation for multi chan testing")
Signed-off-by: default avatarGary R Hook <gary.hook@amd.com>
Signed-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent 3145d73e
...@@ -44,7 +44,8 @@ Example of usage:: ...@@ -44,7 +44,8 @@ Example of usage::
dmatest.timeout=2000 dmatest.iterations=1 dmatest.channel=dma0chan0 dmatest.run=1 dmatest.timeout=2000 dmatest.iterations=1 dmatest.channel=dma0chan0 dmatest.run=1
Example of multi-channel test usage: Example of multi-channel test usage (new in the 5.0 kernel)::
% modprobe dmatest % modprobe dmatest
% echo 2000 > /sys/module/dmatest/parameters/timeout % echo 2000 > /sys/module/dmatest/parameters/timeout
% echo 1 > /sys/module/dmatest/parameters/iterations % echo 1 > /sys/module/dmatest/parameters/iterations
...@@ -53,15 +54,18 @@ Example of multi-channel test usage: ...@@ -53,15 +54,18 @@ Example of multi-channel test usage:
% echo dma0chan2 > /sys/module/dmatest/parameters/channel % echo dma0chan2 > /sys/module/dmatest/parameters/channel
% echo 1 > /sys/module/dmatest/parameters/run % echo 1 > /sys/module/dmatest/parameters/run
Note: the channel parameter should always be the last parameter set prior to .. note::
running the test (setting run=1), this is because upon setting the channel For all tests, starting in the 5.0 kernel, either single- or multi-channel,
parameter, that specific channel is requested using the dmaengine and a thread the channel parameter(s) must be set after all other parameters. It is at
is created with the existing parameters. This thread is set as pending that time that the existing parameter values are acquired for use by the
and will be executed once run is set to 1. Any parameters set after the thread thread(s). All other parameters are shared. Therefore, if changes are made
is created are not applied. to any of the other parameters, and an additional channel specified, the
(shared) parameters used for all threads will use the new values.
After the channels are specified, each thread is set as pending. All threads
begin execution when the run parameter is set to 1.
.. hint:: .. hint::
available channel list could be extracted by running the following command:: A list of available channels can be found by running the following command::
% ls -1 /sys/class/dma/ % ls -1 /sys/class/dma/
...@@ -204,6 +208,7 @@ Releasing Channels ...@@ -204,6 +208,7 @@ Releasing Channels
Channels can be freed by setting run to 0. Channels can be freed by setting run to 0.
Example:: Example::
% echo dma0chan1 > /sys/module/dmatest/parameters/channel % echo dma0chan1 > /sys/module/dmatest/parameters/channel
dmatest: Added 1 threads using dma0chan1 dmatest: Added 1 threads using dma0chan1
% cat /sys/class/dma/dma0chan1/in_use % cat /sys/class/dma/dma0chan1/in_use
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment