Merge branch 'topic/doc' into for-linus

This commit is contained in:
Vinod Koul 2018-01-31 13:50:20 +05:30
commit ae40d5c5b4
1 changed files with 17 additions and 21 deletions

View File

@ -111,40 +111,36 @@ The first thing you need to do in your driver is to allocate this
structure. Any of the usual memory allocators will do, but you'll also
need to initialize a few fields in there:
- channels: should be initialized as a list using the
- ``channels``: should be initialized as a list using the
INIT_LIST_HEAD macro for example
- src_addr_widths:
- ``src_addr_widths``:
should contain a bitmask of the supported source transfer width
- dst_addr_widths:
- ``dst_addr_widths``:
should contain a bitmask of the supported destination transfer width
- directions:
- ``directions``:
should contain a bitmask of the supported slave directions
(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.
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
---------------------------