aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVinod Koul <vinod.koul@intel.com>2016-12-13 22:36:14 -0500
committerVinod Koul <vinod.koul@intel.com>2016-12-13 22:36:14 -0500
commit7fc3b3f946341a035f05e13756f7b2c441492c55 (patch)
tree64d3576471e0b652fe1e8279dc5211295d42e2bf
parent2ef7ff03a9b050f393344a4537efb176de0c7eb2 (diff)
parent397dadf5508fc2cb335b042421cb645d5a6439e0 (diff)
Merge branch 'topic/doc' into for-linus
-rw-r--r--Documentation/dmaengine/client.txt16
-rw-r--r--Documentation/dmaengine/dmatest.txt10
-rw-r--r--Documentation/dmaengine/provider.txt2
-rw-r--r--Documentation/dmaengine/pxa_dma.txt2
4 files changed, 15 insertions, 15 deletions
diff --git a/Documentation/dmaengine/client.txt b/Documentation/dmaengine/client.txt
index 9e33189745f0..c72b4563de10 100644
--- a/Documentation/dmaengine/client.txt
+++ b/Documentation/dmaengine/client.txt
@@ -37,8 +37,8 @@ The slave DMA usage consists of following steps:
372. Set slave and controller specific parameters 372. Set slave and controller specific parameters
38 38
39 Next step is always to pass some specific information to the DMA 39 Next step is always to pass some specific information to the DMA
40 driver. Most of the generic information which a slave DMA can use 40 driver. Most of the generic information which a slave DMA can use
41 is in struct dma_slave_config. This allows the clients to specify 41 is in struct dma_slave_config. This allows the clients to specify
42 DMA direction, DMA addresses, bus widths, DMA burst lengths etc 42 DMA direction, DMA addresses, bus widths, DMA burst lengths etc
43 for the peripheral. 43 for the peripheral.
44 44
@@ -52,7 +52,7 @@ The slave DMA usage consists of following steps:
52 struct dma_slave_config *config) 52 struct dma_slave_config *config)
53 53
54 Please see the dma_slave_config structure definition in dmaengine.h 54 Please see the dma_slave_config structure definition in dmaengine.h
55 for a detailed explanation of the struct members. Please note 55 for a detailed explanation of the struct members. Please note
56 that the 'direction' member will be going away as it duplicates the 56 that the 'direction' member will be going away as it duplicates the
57 direction given in the prepare call. 57 direction given in the prepare call.
58 58
@@ -101,7 +101,7 @@ The slave DMA usage consists of following steps:
101 desc = dmaengine_prep_slave_sg(chan, sgl, nr_sg, direction, flags); 101 desc = dmaengine_prep_slave_sg(chan, sgl, nr_sg, direction, flags);
102 102
103 Once a descriptor has been obtained, the callback information can be 103 Once a descriptor has been obtained, the callback information can be
104 added and the descriptor must then be submitted. Some DMA engine 104 added and the descriptor must then be submitted. Some DMA engine
105 drivers may hold a spinlock between a successful preparation and 105 drivers may hold a spinlock between a successful preparation and
106 submission so it is important that these two operations are closely 106 submission so it is important that these two operations are closely
107 paired. 107 paired.
@@ -138,7 +138,7 @@ The slave DMA usage consists of following steps:
138 activity via other DMA engine calls not covered in this document. 138 activity via other DMA engine calls not covered in this document.
139 139
140 dmaengine_submit() will not start the DMA operation, it merely adds 140 dmaengine_submit() will not start the DMA operation, it merely adds
141 it to the pending queue. For this, see step 5, dma_async_issue_pending. 141 it to the pending queue. For this, see step 5, dma_async_issue_pending.
142 142
1435. Issue pending DMA requests and wait for callback notification 1435. Issue pending DMA requests and wait for callback notification
144 144
@@ -184,13 +184,13 @@ Further APIs:
184 184
1853. int dmaengine_resume(struct dma_chan *chan) 1853. int dmaengine_resume(struct dma_chan *chan)
186 186
187 Resume a previously paused DMA channel. It is invalid to resume a 187 Resume a previously paused DMA channel. It is invalid to resume a
188 channel which is not currently paused. 188 channel which is not currently paused.
189 189
1904. enum dma_status dma_async_is_tx_complete(struct dma_chan *chan, 1904. enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
191 dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used) 191 dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
192 192
193 This can be used to check the status of the channel. Please see 193 This can be used to check the status of the channel. Please see
194 the documentation in include/linux/dmaengine.h for a more complete 194 the documentation in include/linux/dmaengine.h for a more complete
195 description of this API. 195 description of this API.
196 196
@@ -200,7 +200,7 @@ Further APIs:
200 200
201 Note: 201 Note:
202 Not all DMA engine drivers can return reliable information for 202 Not all DMA engine drivers can return reliable information for
203 a running DMA channel. It is recommended that DMA engine users 203 a running DMA channel. It is recommended that DMA engine users
204 pause or stop (via dmaengine_terminate_all()) the channel before 204 pause or stop (via dmaengine_terminate_all()) the channel before
205 using this API. 205 using this API.
206 206
diff --git a/Documentation/dmaengine/dmatest.txt b/Documentation/dmaengine/dmatest.txt
index dd77a81bdb80..fb683c72dea8 100644
--- a/Documentation/dmaengine/dmatest.txt
+++ b/Documentation/dmaengine/dmatest.txt
@@ -34,7 +34,7 @@ command:
34 % ls -1 /sys/class/dma/ 34 % ls -1 /sys/class/dma/
35 35
36Once started a message like "dmatest: Started 1 threads using dma0chan0" is 36Once started a message like "dmatest: Started 1 threads using dma0chan0" is
37emitted. After that only test failure messages are reported until the test 37emitted. After that only test failure messages are reported until the test
38stops. 38stops.
39 39
40Note that running a new test will not stop any in progress test. 40Note that running a new test will not stop any in progress test.
@@ -43,11 +43,11 @@ The following command returns the state of the test.
43 % cat /sys/module/dmatest/parameters/run 43 % cat /sys/module/dmatest/parameters/run
44 44
45To wait for test completion userpace can poll 'run' until it is false, or use 45To wait for test completion userpace can poll 'run' until it is false, or use
46the wait parameter. Specifying 'wait=1' when loading the module causes module 46the wait parameter. Specifying 'wait=1' when loading the module causes module
47initialization to pause until a test run has completed, while reading 47initialization to pause until a test run has completed, while reading
48/sys/module/dmatest/parameters/wait waits for any running test to complete 48/sys/module/dmatest/parameters/wait waits for any running test to complete
49before returning. For example, the following scripts wait for 42 tests 49before returning. For example, the following scripts wait for 42 tests
50to complete before exiting. Note that if 'iterations' is set to 'infinite' then 50to complete before exiting. Note that if 'iterations' is set to 'infinite' then
51waiting is disabled. 51waiting is disabled.
52 52
53Example: 53Example:
@@ -81,7 +81,7 @@ Example of output:
81 81
82The message format is unified across the different types of errors. A number in 82The message format is unified across the different types of errors. A number in
83the parens represents additional information, e.g. error code, error counter, 83the parens represents additional information, e.g. error code, error counter,
84or status. A test thread also emits a summary line at completion listing the 84or status. A test thread also emits a summary line at completion listing the
85number of tests executed, number that failed, and a result code. 85number of tests executed, number that failed, and a result code.
86 86
87Example: 87Example:
diff --git a/Documentation/dmaengine/provider.txt b/Documentation/dmaengine/provider.txt
index c4fd47540b31..e33bc1c8ed2c 100644
--- a/Documentation/dmaengine/provider.txt
+++ b/Documentation/dmaengine/provider.txt
@@ -384,7 +384,7 @@ where to put them)
384 - The descriptor should be prepared for reuse by invoking 384 - The descriptor should be prepared for reuse by invoking
385 dmaengine_desc_set_reuse() which will set DMA_CTRL_REUSE. 385 dmaengine_desc_set_reuse() which will set DMA_CTRL_REUSE.
386 - dmaengine_desc_set_reuse() will succeed only when channel support 386 - dmaengine_desc_set_reuse() will succeed only when channel support
387 reusable descriptor as exhibited by capablities 387 reusable descriptor as exhibited by capabilities
388 - As a consequence, if a device driver wants to skip the dma_map_sg() and 388 - As a consequence, if a device driver wants to skip the dma_map_sg() and
389 dma_unmap_sg() in between 2 transfers, because the DMA'd data wasn't used, 389 dma_unmap_sg() in between 2 transfers, because the DMA'd data wasn't used,
390 it can resubmit the transfer right after its completion. 390 it can resubmit the transfer right after its completion.
diff --git a/Documentation/dmaengine/pxa_dma.txt b/Documentation/dmaengine/pxa_dma.txt
index 413ef9cfaa4d..0736d44b5438 100644
--- a/Documentation/dmaengine/pxa_dma.txt
+++ b/Documentation/dmaengine/pxa_dma.txt
@@ -29,7 +29,7 @@ Constraints
29 29
30 d) Bandwidth guarantee 30 d) Bandwidth guarantee
31 The PXA architecture has 4 levels of DMAs priorities : high, normal, low. 31 The PXA architecture has 4 levels of DMAs priorities : high, normal, low.
32 The high prorities get twice as much bandwidth as the normal, which get twice 32 The high priorities get twice as much bandwidth as the normal, which get twice
33 as much as the low priorities. 33 as much as the low priorities.
34 A driver should be able to request a priority, especially the real-time 34 A driver should be able to request a priority, especially the real-time
35 ones such as pxa_camera with (big) throughputs. 35 ones such as pxa_camera with (big) throughputs.