Documentation/driver-api/dmaengine/index.rst

File Facts

System

Linux kernel

Corpus path

Documentation/driver-api/dmaengine/index.rst

Extension

.rst

Size

906 bytes

Lines

49

Domain

Support Tooling And Documentation

Bucket

Documentation

Inferred role

Support Tooling And Documentation: documentation

Status

atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

• Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

=======================
DMAEngine documentation
=======================

DMAEngine documentation provides documents for various aspects of DMAEngine
framework.

DMAEngine development documentation
-----------------------------------

This book helps with DMAengine internal APIs and guide for DMAEngine device
driver writers.

.. toctree::
   :maxdepth: 1

   provider

DMAEngine client documentation
------------------------------

This book is a guide to device driver writers on how to use the Slave-DMA
API of the DMAEngine. This is applicable only for slave DMA usage only.

.. toctree::
   :maxdepth: 1

   client

DMA Test documentation
----------------------

This book introduces how to test DMA drivers using dmatest module.

.. toctree::
   :maxdepth: 1

   dmatest

PXA DMA documentation
----------------------

This book adds some notes about PXA DMA

.. toctree::
   :maxdepth: 1

   pxa_dma

Annotation

• Atlas domain: Support Tooling And Documentation / Documentation.
• Implementation status: atlas-only.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.