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>
This commit is contained in:
parent
4fbd8d194f
commit
a5d3320610
|
@ -125,26 +125,22 @@ need to initialize a few fields in there:
|
||||||
(i.e. excluding mem2mem transfers)
|
(i.e. excluding mem2mem transfers)
|
||||||
|
|
||||||
- residue_granularity:
|
- 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.
|
- Descriptor:
|
||||||
This can be either:
|
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
|
- Burst:
|
||||||
reporting. The framework will only know that a particular
|
your device is able to report which burst have been transferred
|
||||||
transaction descriptor is done.
|
|
||||||
|
|
||||||
- Segment
|
- dev: should hold the pointer to the ``struct device`` associated
|
||||||
|
to your current driver instance.
|
||||||
- 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.
|
|
||||||
|
|
||||||
Supported transaction types
|
Supported transaction types
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
Loading…
Reference in a new issue