diff options
author | Paul Kocialkowski <paul.kocialkowski@bootlin.com> | 2022-03-31 16:41:14 +0300 |
---|---|---|
committer | Vinod Koul <vkoul@kernel.org> | 2022-04-11 16:45:52 +0300 |
commit | 1f854536a8336c61c89ab040bbc874c75325d37c (patch) | |
tree | a9739dd8adb01bee9409eeda0e887c0128cddb3d /drivers/dma/idxd | |
parent | ec834f1cc7cf471b090bb0a6ee077a7bb90a3549 (diff) | |
download | linux-1f854536a8336c61c89ab040bbc874c75325d37c.tar.xz |
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>
Diffstat (limited to 'drivers/dma/idxd')
0 files changed, 0 insertions, 0 deletions