Driver Operations DMA driver operations More...

#include <zephyr/drivers/dma.h>

Data Fields
dma_api_config	config
	REQ DMA configuration structure.
dma_api_reload	reload
	OPT Reload buffer(s) for a DMA channel.
dma_api_start	start
	REQ Enables DMA channel and starts the transfer, the channel must be configured beforehand.
dma_api_stop	stop
	OPT Stops the DMA transfer and disables the channel.
dma_api_suspend	suspend
	OPT Suspend a DMA channel transfer.
dma_api_resume	resume
	OPT Resume a DMA channel transfer.
dma_api_get_status	get_status
	OPT get current runtime status of DMA transfer
dma_api_get_attribute	get_attribute
	OPT get attribute of a dma controller
dma_api_chan_filter	chan_filter
	OPT DMA channel filter.
dma_api_chan_release	chan_release
	OPT Release channel resources allocated during the request phase.

Detailed Description

Driver Operations DMA driver operations

This is the driver API structure any DMA driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ chan_filter

dma_api_chan_filter dma_driver_api::chan_filter

OPT DMA channel filter.

◆ chan_release

dma_api_chan_release dma_driver_api::chan_release

OPT Release channel resources allocated during the request phase.

See dma_release_channel() for details.

◆ config

dma_api_config dma_driver_api::config

REQ DMA configuration structure.

◆ get_attribute

dma_api_get_attribute dma_driver_api::get_attribute

OPT get attribute of a dma controller

◆ get_status

dma_api_get_status dma_driver_api::get_status

OPT get current runtime status of DMA transfer

◆ reload

dma_api_reload dma_driver_api::reload

OPT Reload buffer(s) for a DMA channel.

◆ resume

dma_api_resume dma_driver_api::resume

OPT Resume a DMA channel transfer.

◆ start

dma_api_start dma_driver_api::start

REQ Enables DMA channel and starts the transfer, the channel must be configured beforehand.

◆ stop

dma_api_stop dma_driver_api::stop

OPT Stops the DMA transfer and disables the channel.

◆ suspend

dma_api_suspend dma_driver_api::suspend

OPT Suspend a DMA channel transfer.

The documentation for this struct was generated from the following file:

zephyr/drivers/dma.h

Data Fields