iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

dmaengine: doc: fix bullet list formatting

Browse Source 
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>
This commit is contained in:
Luca Ceresoli 2017-12-30 23:53:06 +01:00 committed by Vinod Koul
parent 4fbd8d194f
commit a5d3320610
1 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/driver-api/dmaengine/provider.rst
View File

@ -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
---------------------------