Re: [PATCH] docs: dmaengine: clarify ordering rules around cookie completion

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] docs: typo 'architcure' and grammatical errors in dmaengine provider documentation
--

commit 5e1e4fe7c0e4434abe23aff6f6d55d9b232ea575
Author: Vinod Koul <vkoul@kernel.org>

docs: dmaengine: clarify ordering rules around cookie completion

This commit adds documentation to clarify the ordering rules for DMA cookie
completion, ensuring buffers are flushed before drivers invoke the completion.

> diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
> index f4ed98f701c91..073ba6c0f29dc 100644
> --- a/Documentation/driver-api/dmaengine/provider.rst
> +++ b/Documentation/driver-api/dmaengine/provider.rst
> @@ -555,6 +555,11 @@ dma_cookie_t
>  - Not really relevant any more since the introduction of ``virt-dma``
>    that abstracts it away.
>  
> +- dmaengine drivers need to ensure buffers are flushed before invoking
> +  vchan_cookie_complete() or dma_cookie_complete(). This would imply a call
> +  to unmapping buffers or any such architcure calls to ensure caller seeing
> +  buffers are flushed is done before invoking these calls.

[Severity: Low]
This isn't a bug, but there is a typo here ('architcure' instead of
'architecture'), and the phrasing "to ensure caller seeing buffers are
flushed is done before invoking these calls" is grammatically awkward.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261009093745.539924-1-vkoul@kernel.org?part=1