docs: document common DMA driver framework - #20201
Merged
Merged
Conversation
Document the common DMA driver framework and its usage. Describe the DMA controller and client interfaces, channel and transfer lifecycle, DMA links, controller implementation requirements, and existing in-tree users. Add references to the audio DMA and 16550 UART implementations to provide concrete usage examples. Signed-off-by: Arnav Sharma <2006arnavsharma@gmail.com>
github-actions
Bot
added
Area: Documentation
xiaoxiang781216
approved these changes
Sep 20, 2026
acassis
approved these changes
Sep 20, 2026
Contributor
|
@arnavsharma990 you missed the "Assisted-by:" after your signature |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the common DMA driver framework, which was previously
represented only by a minimal documentation stub.
The documentation covers:
The documentation is based on the current implementation in
include/nuttx/dma/dma.hand existing users such asdrivers/audio/audio_dma.canddrivers/serial/uart_16550.c.The documentation also explicitly identifies parts of the common
interface for which there is currently no in-tree implementation
or caller.
Validation
against the current source tree.
git diff --check.local environment does not have
sphinx_rtd_themeinstalled.Related Issue
Closes #20200