dmaengine: Clarify cyclic transfer residue documentation
authorPaul Kocialkowski <paul.kocialkowski@bootlin.com>
Thu, 31 Mar 2022 13:41:14 +0000 (15:41 +0200)
committerVinod Koul <vkoul@kernel.org>
Mon, 11 Apr 2022 13:45:52 +0000 (19:15 +0530)
commit1f854536a8336c61c89ab040bbc874c75325d37c
treea9739dd8adb01bee9409eeda0e887c0128cddb3d
parentec834f1cc7cf471b090bb0a6ee077a7bb90a3549
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>
Documentation/driver-api/dmaengine/provider.rst