summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api
diff options
context:
space:
mode:
authorLuca Ceresoli <luca@lucaceresoli.net>2017-12-30 23:53:07 +0100
committerVinod Koul <vinod.koul@intel.com>2018-01-08 16:03:47 +0530
commit881053f73ffb465a195815e9f0676e34b6c4450f (patch)
tree38df8b18690b60a45a63c449673cfd0d129798ec /Documentation/driver-api
parenta5d332061047301d883f85241fd28cdd45b5ee31 (diff)
downloadlinux-881053f73ffb465a195815e9f0676e34b6c4450f.tar.bz2
dmaengine: doc: format struct fields using monospace
Monospace is more readable and is also used elsewhere in the docs. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Diffstat (limited to 'Documentation/driver-api')
-rw-r--r--Documentation/driver-api/dmaengine/provider.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
index a257d9d6bd72..dfc4486b5743 100644
--- a/Documentation/driver-api/dmaengine/provider.rst
+++ b/Documentation/driver-api/dmaengine/provider.rst
@@ -111,20 +111,20 @@ 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:
@@ -139,7 +139,7 @@ need to initialize a few fields in there:
- Burst:
your device is able to report which burst have been transferred
-- dev: should hold the pointer to the ``struct device`` associated
+- ``dev``: should hold the pointer to the ``struct device`` associated
to your current driver instance.
Supported transaction types