arnavsharma990 opened a new pull request, #20201:
URL: https://github.com/apache/nuttx/pull/20201
## Summary
Document the common DMA driver framework, which was previously
represented only by a minimal documentation stub.
The documentation covers:
- DMA framework architecture and terminology
- DMA controller and client interfaces
- DMA channels and transfer lifecycle
- DMA callbacks and transfer control
- DMA link support
- Requirements for implementing a DMA controller
- Configuration options
- Existing in-tree DMA users and implementation examples
The documentation is based on the current implementation in
`include/nuttx/dma/dma.h` and existing users such as
`drivers/audio/audio_dma.c` and `drivers/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
- Verified referenced DMA APIs, structures, fields, and file paths
against the current source tree.
- Verified the documentation against existing DMA users.
- Ran RST/Sphinx validation successfully with no warnings.
- Ran `git diff --check`.
- Full NuttX documentation build was not available because the
local environment does not have `sphinx_rtd_theme` installed.
## Related Issue
Closes #20200
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
