summaryrefslogtreecommitdiff
path: root/Documentation/driver-api
diff options
context:
space:
mode:
authorLuca Ceresoli <luca@lucaceresoli.net>2017-12-30 23:53:06 +0100
committerVinod Koul <vinod.koul@intel.com>2018-01-08 16:03:47 +0530
commita5d332061047301d883f85241fd28cdd45b5ee31 (patch)
tree357802b399fddacbcae3ba66163641a7df0cdcc4 /Documentation/driver-api
parent4fbd8d194f06c8a3fd2af1ce560ddb31f7ec8323 (diff)
dmaengine: doc: fix bullet list formatting
The bullet list documenting the 'struct dma_device' fields has several nesting errors, making it render improperly. It also has incoherent formatting: some fields have a description in the same bullet, some in a sub-bullet. Fix both to have a correct and coherent formatting. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Diffstat (limited to 'Documentation/driver-api')
-rw-r--r--Documentation/driver-api/dmaengine/provider.rst28
1 files changed, 12 insertions, 16 deletions
diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
index 814acb4d2294..a257d9d6bd72 100644
--- a/Documentation/driver-api/dmaengine/provider.rst
+++ b/Documentation/driver-api/dmaengine/provider.rst
@@ -125,26 +125,22 @@ need to initialize a few fields in there:
(i.e. excluding mem2mem transfers)
- residue_granularity:
+ granularity of the transfer residue reported to dma_set_residue.
+ This can be either:
- - Granularity of the transfer residue reported to dma_set_residue.
- This can be either:
+ - Descriptor:
+ your device doesn't support any kind of residue
+ reporting. The framework will only know that a particular
+ transaction descriptor is done.
- - Descriptor
+ - Segment:
+ your device is able to report which chunks have been transferred
- - Your device doesn't support any kind of residue
- reporting. The framework will only know that a particular
- transaction descriptor is done.
+ - Burst:
+ your device is able to report which burst have been transferred
- - Segment
-
- - Your device is able to report which chunks have been transferred
-
- - Burst
-
- - Your device is able to report which burst have been transferred
-
- - dev: should hold the pointer to the ``struct device`` associated
- to your current driver instance.
+- dev: should hold the pointer to the ``struct device`` associated
+ to your current driver instance.
Supported transaction types
---------------------------