dmaengine: Make dmatest.rst indeed reST compatible
Make dmatest.rst indeed reST compatible. Achieve this by fixing several formatting issues. Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
a6cd7714c0
commit
bc1287b9e5
|
@ -15,6 +15,7 @@ Part 1 - How to build the test module
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
The menuconfig contains an option that could be found by following path:
|
The menuconfig contains an option that could be found by following path:
|
||||||
|
|
||||||
Device Drivers -> DMA Engine support -> DMA Test client
|
Device Drivers -> DMA Engine support -> DMA Test client
|
||||||
|
|
||||||
In the configuration file the option called CONFIG_DMATEST. The dmatest could
|
In the configuration file the option called CONFIG_DMATEST. The dmatest could
|
||||||
|
@ -23,11 +24,11 @@ be built as module or inside kernel. Let's consider those cases.
|
||||||
Part 2 - When dmatest is built as a module
|
Part 2 - When dmatest is built as a module
|
||||||
==========================================
|
==========================================
|
||||||
|
|
||||||
Example of usage: ::
|
Example of usage::
|
||||||
|
|
||||||
% modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
|
% modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
|
||||||
|
|
||||||
...or: ::
|
...or::
|
||||||
|
|
||||||
% modprobe dmatest
|
% modprobe dmatest
|
||||||
% echo dma0chan0 > /sys/module/dmatest/parameters/channel
|
% echo dma0chan0 > /sys/module/dmatest/parameters/channel
|
||||||
|
@ -35,14 +36,12 @@ Example of usage: ::
|
||||||
% echo 1 > /sys/module/dmatest/parameters/iterations
|
% echo 1 > /sys/module/dmatest/parameters/iterations
|
||||||
% echo 1 > /sys/module/dmatest/parameters/run
|
% echo 1 > /sys/module/dmatest/parameters/run
|
||||||
|
|
||||||
...or on the kernel command line: ::
|
...or on the kernel command line::
|
||||||
|
|
||||||
dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1
|
dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1
|
||||||
|
|
||||||
..hint:: available channel list could be extracted by running the following
|
.. hint::
|
||||||
command:
|
available channel list could be extracted by running the following command::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
% ls -1 /sys/class/dma/
|
% ls -1 /sys/class/dma/
|
||||||
|
|
||||||
|
@ -64,12 +63,12 @@ before returning. For example, the following scripts wait for 42 tests
|
||||||
to complete before exiting. Note that if 'iterations' is set to 'infinite' then
|
to complete before exiting. Note that if 'iterations' is set to 'infinite' then
|
||||||
waiting is disabled.
|
waiting is disabled.
|
||||||
|
|
||||||
Example: ::
|
Example::
|
||||||
|
|
||||||
% modprobe dmatest run=1 iterations=42 wait=1
|
% modprobe dmatest run=1 iterations=42 wait=1
|
||||||
% modprobe -r dmatest
|
% modprobe -r dmatest
|
||||||
|
|
||||||
...or: ::
|
...or::
|
||||||
|
|
||||||
% modprobe dmatest run=1 iterations=42
|
% modprobe dmatest run=1 iterations=42
|
||||||
% cat /sys/module/dmatest/parameters/wait
|
% cat /sys/module/dmatest/parameters/wait
|
||||||
|
@ -81,7 +80,7 @@ Part 3 - When built-in in the kernel
|
||||||
The module parameters that is supplied to the kernel command line will be used
|
The module parameters that is supplied to the kernel command line will be used
|
||||||
for the first performed test. After user gets a control, the test could be
|
for the first performed test. After user gets a control, the test could be
|
||||||
re-run with the same or different parameters. For the details see the above
|
re-run with the same or different parameters. For the details see the above
|
||||||
section "Part 2 - When dmatest is built as a module..."
|
section `Part 2 - When dmatest is built as a module`_.
|
||||||
|
|
||||||
In both cases the module parameters are used as the actual values for the test
|
In both cases the module parameters are used as the actual values for the test
|
||||||
case. You always could check them at run-time by running ::
|
case. You always could check them at run-time by running ::
|
||||||
|
@ -91,12 +90,11 @@ case. You always could check them at run-time by running ::
|
||||||
Part 4 - Gathering the test results
|
Part 4 - Gathering the test results
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
Test results are printed to the kernel log buffer with the format: ::
|
Test results are printed to the kernel log buffer with the format::
|
||||||
|
|
||||||
"dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
|
"dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
|
||||||
|
|
||||||
Example of output: ::
|
Example of output::
|
||||||
|
|
||||||
|
|
||||||
% dmesg | tail -n 1
|
% dmesg | tail -n 1
|
||||||
dmatest: result dma0chan0-copy0: #1: No errors with src_off=0x7bf dst_off=0x8ad len=0x3fea (0)
|
dmatest: result dma0chan0-copy0: #1: No errors with src_off=0x7bf dst_off=0x8ad len=0x3fea (0)
|
||||||
|
@ -106,7 +104,7 @@ the parens represents additional information, e.g. error code, error counter,
|
||||||
or status. A test thread also emits a summary line at completion listing the
|
or status. A test thread also emits a summary line at completion listing the
|
||||||
number of tests executed, number that failed, and a result code.
|
number of tests executed, number that failed, and a result code.
|
||||||
|
|
||||||
Example: ::
|
Example::
|
||||||
|
|
||||||
% dmesg | tail -n 1
|
% dmesg | tail -n 1
|
||||||
dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0)
|
dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0)
|
||||||
|
|
Loading…
Reference in a new issue