Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a5d33206 authored by Luca Ceresoli's avatar Luca Ceresoli Committed by Vinod Koul
Browse files

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: default avatarLuca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: default avatarVinod Koul <vinod.koul@intel.com>
parent 4fbd8d19

Documentation/driver-api/dmaengine/provider.rst

+12 −16
Original line number Diff line number Diff line
@@ -125,23 +125,19 @@ 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.

  granularity of the transfer residue reported to dma_set_residue.

  This can be either:



  - Descriptor



    - Your device doesn't support any kind of residue

  - Descriptor:

    your device doesn't support any kind of residue

    reporting. The framework will only know that a particular

    transaction descriptor is done.



      - Segment



        - Your device is able to report which chunks have been transferred



      - Burst

  - Segment:

    your device is able to report which chunks have been transferred



        - Your device is able to report which burst 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.