zephyr/doc/hardware/peripherals
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
..
audio
can drivers: can: unify spelling of CAN Flexible Data-rate abbreviation 2023-11-01 11:17:17 +00:00
display
edac
1-Wire_bus_topology.drawio.svg
adc.rst
auxdisplay.rst doc: peripherals: fix bad link to Display API 2023-06-07 04:40:47 -04:00
bbram.rst bbram: Add documentation 2023-05-05 10:57:01 -05:00
bc12.rst docs: bc12: Update for charging mode operation 2023-05-08 09:57:56 +02:00
charger.rst docs: charger: Corrects text in the Properties section 2023-11-09 17:26:03 -05:00
clock_control.rst
coredump.rst
counter.rst
dac.rst
dma.rst docs: Better document the DMA API and expectations 2023-11-10 10:40:10 +01:00
eeprom.rst
entropy.rst
espi.rst
flash.rst
fuel_gauge.rst fuel_gauge: Repl property struct w/ union 2023-09-27 12:07:59 +02:00
gnss.rst doc: gnss: Add GNSS documentation 2023-10-30 11:43:19 -04:00
gpio.rst
hwinfo.rst
i2c_eeprom_target.rst
i2c.rst doc: i2c: fixed non-working link to I2C spec 2023-06-07 04:40:47 -04:00
i3c.rst
index.rst doc: gnss: Add GNSS documentation 2023-10-30 11:43:19 -04:00
ipm.rst
kscan.rst
led.rst
mbox.rst
mdio.rst
mipi_dsi.rst
pcie.rst doc/pcie: Add basic entry for PCIe doxygen documentation 2023-06-17 07:58:41 -04:00
peci.rst
ps2.rst
pwm.rst
regulators.rst
reset.rst
retained_mem.rst doc: retained_mem: Add note on mutex configuration 2023-10-10 16:27:10 +03:00
rtc.rst
sdhc.rst doc: disk: Mention eMMC support in disk subsystem 2023-08-18 10:14:01 +02:00
sensor.rst emul: Introduce emulator backend API and generic sensor test 2023-07-28 17:48:31 +02:00
smbus.rst doc: smbus: Correct SMBus documentation 2023-06-01 18:04:58 -04:00
spi.rst
tcpc.rst
tgpio.rst doc: hardware: peripherals: Added tgpio.rst 2023-09-29 16:28:09 +02:00
uart.rst serial: allow callback setting to be exclusive 2023-07-18 11:13:02 +00:00
usbc_vbus.rst
video.rst
w1.rst
watchdog.rst