mirror-linux/Documentation/driver-api/dmaengine
Paul Kocialkowski 1f854536a8 dmaengine: Clarify cyclic transfer residue documentation
The current documentation for the residue reported in a cyclic transfer
case mentions that the reported residue should be relative to the current
period only. However the definition of DMA_RESIDUE_GRANULARITY_SEGMENT
specifies that the residue should be updated after each period for
a cyclic transfer, which is in direct contradiction.

Moreover the pcm_dmaengine common code uses the residue relative to
the whole cyclic buffer size, not one period.

Correct the residue-related documentation to reflect this.

Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
Link: https://lore.kernel.org/r/20220331134114.703782-1-paul.kocialkowski@bootlin.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
2022-04-11 19:15:52 +05:30
..
client.rst dmaengine: doc: client: Update for dmaengine_get_dma_device() usage 2020-12-11 21:20:08 +05:30
dmatest.rst Documentation: dmaengine: Correctly describe dmatest with channel unset 2021-11-22 12:31:00 +05:30
index.rst docs: prevent warnings due to autosectionlabel 2020-03-20 17:01:29 -06:00
provider.rst dmaengine: Clarify cyclic transfer residue documentation 2022-04-11 19:15:52 +05:30
pxa_dma.rst dmaengine: doc: ReSTize pxa_dma doc 2017-11-05 10:03:34 -07:00