From a5d332061047301d883f85241fd28cdd45b5ee31 Mon Sep 17 00:00:00 2001 From: Luca Ceresoli Date: Sat, 30 Dec 2017 23:53:06 +0100 Subject: 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: Luca Ceresoli Signed-off-by: Vinod Koul --- Documentation/driver-api/dmaengine/provider.rst | 28 +++++++++++-------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst index 814acb4d2294..a257d9d6bd72 100644 --- a/Documentation/driver-api/dmaengine/provider.rst +++ b/Documentation/driver-api/dmaengine/provider.rst @@ -125,26 +125,22 @@ 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. + 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 --------------------------- -- cgit v1.2.3 From 881053f73ffb465a195815e9f0676e34b6c4450f Mon Sep 17 00:00:00 2001 From: Luca Ceresoli Date: Sat, 30 Dec 2017 23:53:07 +0100 Subject: dmaengine: doc: format struct fields using monospace Monospace is more readable and is also used elsewhere in the docs. Signed-off-by: Luca Ceresoli Signed-off-by: Vinod Koul --- Documentation/driver-api/dmaengine/provider.rst | 12 ++++++------ 1 file 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 -- cgit v1.2.3