aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/dmaengine
diff options
context:
space:
mode:
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>2018-03-26 07:50:26 -0400
committerJonathan Corbet <corbet@lwn.net>2018-03-26 12:40:36 -0400
commitbc1287b9e5150c5ff85ef4695ccdbe00a8a4d6bf (patch)
tree6e3a9940fcee1e4f9cad4ac4865429213ba580eb /Documentation/driver-api/dmaengine
parenta6cd7714c0bd53f72d3ed61acbb86b07bcf6c693 (diff)
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>
Diffstat (limited to 'Documentation/driver-api/dmaengine')
-rw-r--r--Documentation/driver-api/dmaengine/dmatest.rst26
1 files changed, 12 insertions, 14 deletions
diff --git a/Documentation/driver-api/dmaengine/dmatest.rst b/Documentation/driver-api/dmaengine/dmatest.rst
index 9b0dcdb7b7a8..9b45ff0d85cb 100644
--- a/Documentation/driver-api/dmaengine/dmatest.rst
+++ b/Documentation/driver-api/dmaengine/dmatest.rst
@@ -15,6 +15,7 @@ Part 1 - How to build the test module
15===================================== 15=====================================
16 16
17The menuconfig contains an option that could be found by following path: 17The menuconfig contains an option that could be found by following path:
18
18 Device Drivers -> DMA Engine support -> DMA Test client 19 Device Drivers -> DMA Engine support -> DMA Test client
19 20
20In the configuration file the option called CONFIG_DMATEST. The dmatest could 21In 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.
23Part 2 - When dmatest is built as a module 24Part 2 - When dmatest is built as a module
24========================================== 25==========================================
25 26
26Example of usage: :: 27Example of usage::
27 28
28 % modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1 29 % modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
29 30
30...or: :: 31...or::
31 32
32 % modprobe dmatest 33 % modprobe dmatest
33 % echo dma0chan0 > /sys/module/dmatest/parameters/channel 34 % echo dma0chan0 > /sys/module/dmatest/parameters/channel
@@ -35,14 +36,12 @@ Example of usage: ::
35 % echo 1 > /sys/module/dmatest/parameters/iterations 36 % echo 1 > /sys/module/dmatest/parameters/iterations
36 % echo 1 > /sys/module/dmatest/parameters/run 37 % echo 1 > /sys/module/dmatest/parameters/run
37 38
38...or on the kernel command line: :: 39...or on the kernel command line::
39 40
40 dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1 41 dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1
41 42
42..hint:: available channel list could be extracted by running the following 43.. hint::
43 command: 44 available channel list could be extracted by running the following command::
44
45::
46 45
47 % ls -1 /sys/class/dma/ 46 % ls -1 /sys/class/dma/
48 47
@@ -64,12 +63,12 @@ before returning. For example, the following scripts wait for 42 tests
64to complete before exiting. Note that if 'iterations' is set to 'infinite' then 63to complete before exiting. Note that if 'iterations' is set to 'infinite' then
65waiting is disabled. 64waiting is disabled.
66 65
67Example: :: 66Example::
68 67
69 % modprobe dmatest run=1 iterations=42 wait=1 68 % modprobe dmatest run=1 iterations=42 wait=1
70 % modprobe -r dmatest 69 % modprobe -r dmatest
71 70
72...or: :: 71...or::
73 72
74 % modprobe dmatest run=1 iterations=42 73 % modprobe dmatest run=1 iterations=42
75 % cat /sys/module/dmatest/parameters/wait 74 % cat /sys/module/dmatest/parameters/wait
@@ -81,7 +80,7 @@ Part 3 - When built-in in the kernel
81The module parameters that is supplied to the kernel command line will be used 80The module parameters that is supplied to the kernel command line will be used
82for the first performed test. After user gets a control, the test could be 81for the first performed test. After user gets a control, the test could be
83re-run with the same or different parameters. For the details see the above 82re-run with the same or different parameters. For the details see the above
84section "Part 2 - When dmatest is built as a module..." 83section `Part 2 - When dmatest is built as a module`_.
85 84
86In both cases the module parameters are used as the actual values for the test 85In both cases the module parameters are used as the actual values for the test
87case. You always could check them at run-time by running :: 86case. 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 ::
91Part 4 - Gathering the test results 90Part 4 - Gathering the test results
92=================================== 91===================================
93 92
94Test results are printed to the kernel log buffer with the format: :: 93Test results are printed to the kernel log buffer with the format::
95 94
96 "dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)" 95 "dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
97 96
98Example of output: :: 97Example of output::
99
100 98
101 % dmesg | tail -n 1 99 % dmesg | tail -n 1
102 dmatest: result dma0chan0-copy0: #1: No errors with src_off=0x7bf dst_off=0x8ad len=0x3fea (0) 100 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,
106or status. A test thread also emits a summary line at completion listing the 104or status. A test thread also emits a summary line at completion listing the
107number of tests executed, number that failed, and a result code. 105number of tests executed, number that failed, and a result code.
108 106
109Example: :: 107Example::
110 108
111 % dmesg | tail -n 1 109 % dmesg | tail -n 1
112 dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0) 110 dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0)