diff options
| author | Luca Ceresoli <luca@lucaceresoli.net> | 2017-12-30 17:53:07 -0500 |
|---|---|---|
| committer | Vinod Koul <vinod.koul@intel.com> | 2018-01-08 05:33:47 -0500 |
| commit | 881053f73ffb465a195815e9f0676e34b6c4450f (patch) | |
| tree | 38df8b18690b60a45a63c449673cfd0d129798ec /Documentation/driver-api | |
| parent | a5d332061047301d883f85241fd28cdd45b5ee31 (diff) | |
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.rst | 12 |
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 | |||
| 111 | structure. Any of the usual memory allocators will do, but you'll also | 111 | structure. Any of the usual memory allocators will do, but you'll also |
| 112 | need to initialize a few fields in there: | 112 | need to initialize a few fields in there: |
| 113 | 113 | ||
| 114 | - channels: should be initialized as a list using the | 114 | - ``channels``: should be initialized as a list using the |
| 115 | INIT_LIST_HEAD macro for example | 115 | INIT_LIST_HEAD macro for example |
| 116 | 116 | ||
| 117 | - src_addr_widths: | 117 | - ``src_addr_widths``: |
| 118 | should contain a bitmask of the supported source transfer width | 118 | should contain a bitmask of the supported source transfer width |
| 119 | 119 | ||
| 120 | - dst_addr_widths: | 120 | - ``dst_addr_widths``: |
| 121 | should contain a bitmask of the supported destination transfer width | 121 | should contain a bitmask of the supported destination transfer width |
| 122 | 122 | ||
| 123 | - directions: | 123 | - ``directions``: |
| 124 | should contain a bitmask of the supported slave directions | 124 | should contain a bitmask of the supported slave directions |
| 125 | (i.e. excluding mem2mem transfers) | 125 | (i.e. excluding mem2mem transfers) |
| 126 | 126 | ||
| 127 | - residue_granularity: | 127 | - ``residue_granularity``: |
| 128 | granularity of the transfer residue reported to dma_set_residue. | 128 | granularity of the transfer residue reported to dma_set_residue. |
| 129 | This can be either: | 129 | This can be either: |
| 130 | 130 | ||
| @@ -139,7 +139,7 @@ need to initialize a few fields in there: | |||
| 139 | - Burst: | 139 | - Burst: |
| 140 | your device is able to report which burst have been transferred | 140 | your device is able to report which burst have been transferred |
| 141 | 141 | ||
| 142 | - dev: should hold the pointer to the ``struct device`` associated | 142 | - ``dev``: should hold the pointer to the ``struct device`` associated |
| 143 | to your current driver instance. | 143 | to your current driver instance. |
| 144 | 144 | ||
| 145 | Supported transaction types | 145 | Supported transaction types |
