diff options
| author | Vinod Koul <vinod.koul@intel.com> | 2018-01-31 13:50:20 +0530 |
|---|---|---|
| committer | Vinod Koul <vinod.koul@intel.com> | 2018-01-31 13:50:20 +0530 |
| commit | ae40d5c5b4977a54c2f0c166dcf205f8701d8af3 (patch) | |
| tree | f0d5efec9d151b3b92686429d9be446e0d17b3fe | |
| parent | 40303764f7aaaaf2ccfb01f4fac5a631fffc1a3c (diff) | |
| parent | 881053f73ffb465a195815e9f0676e34b6c4450f (diff) | |
Merge branch 'topic/doc' into for-linus
| -rw-r--r-- | Documentation/driver-api/dmaengine/provider.rst | 38 |
1 files changed, 17 insertions, 21 deletions
diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst index 814acb4d2294..dfc4486b5743 100644 --- a/Documentation/driver-api/dmaengine/provider.rst +++ b/Documentation/driver-api/dmaengine/provider.rst @@ -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 --------------------------- |