zephyr/doc/hardware
Tom Burdick 344d24bcb7 docs: Better document the DMA API and expectations
The DMA API has several expectations for drivers and callers that were
underdocumented or undocumented. Better clarify the driver expectations
and caller expectations.

The DMA API from the caller side is not a portable API and really cannot
be as each DMA has unique properties and expectations of memory,
peripheral interaction, and features. The API in effect provides a union
of all useful DMA functionality drivers have needed in the tree. It can
still be a good abstraction, with care, for peripheral devices for
vendors where the DMA IP might be very similar but have slight
variances.

From the driver implementation side expectations around synchronization,
state transitions, and memory management for transfer descriptors is now
described in documentation rather than solely from me in github review
comments.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2023-11-10 10:40:10 +01:00
..
arch dt: Make zephyr,memory-attr a capabilities bitmask 2023-09-15 12:46:54 +02:00
barriers doc: Add barriers API docs 2023-05-31 06:15:32 -04:00
cache
emulator
peripherals docs: Better document the DMA API and expectations 2023-11-10 10:40:10 +01:00
pinctrl doc: pinctrl: fix link to ELC2021 slide deck 2023-06-07 04:40:47 -04:00
porting doc: hardware:porting:arch fix typo 2023-10-18 18:38:36 +03:00
index.rst doc: Add barriers API docs 2023-05-31 06:15:32 -04:00