DMA (SF32LB specifics)

DMA (SF32LB specifics) More...

Data Structures
struct	sf32lb_dma_dt_spec
	SF32LB DMA DT spec. More...

Macros
#define	SF32LB_DMA_DT_SPEC_GET(node_id)
	Initialize a sf32lb_dma_dt_spec structure from a DT node.
#define	SF32LB_DMA_DT_SPEC_GET_BY_NAME(node_id, name)
	Initialize a sf32lb_dma_dt_spec structure from a DT node.
#define	SF32LB_DMA_DT_SPEC_GET_BY_NAME_OR(node_id, name, default_value)
	Initialize a sf32lb_dma_dt_spec structure from a DT node, with a fallback to default values.
#define	SF32LB_DMA_DT_INST_SPEC_GET(index)   SF32LB_DMA_DT_SPEC_GET(DT_DRV_INST(index))
	Initialize a sf32lb_dma_dt_spec structure from a DT instance.
#define	SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME(index, name)    SF32LB_DMA_DT_SPEC_GET_BY_NAME(DT_DRV_INST(index), name)
	Initialize a sf32lb_dma_dt_spec structure from a DT instance.
#define	SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME_OR(index, name, default_value)    SF32LB_DMA_DT_SPEC_GET_BY_NAME_OR(DT_DRV_INST(index), name, default_value)
	Initialize a sf32lb_dma_dt_spec structure from a DT instance.

Functions
static bool	sf32lb_dma_is_ready_dt (const struct sf32lb_dma_dt_spec *spec)
	Check if the DMA controller is ready.
static void	sf32lb_dma_config_init_dt (const struct sf32lb_dma_dt_spec *spec, struct dma_config *config)
	Initialize a DMA configuration structure from a DT spec.
static int	sf32lb_dma_config_dt (const struct sf32lb_dma_dt_spec *spec, struct dma_config *config)
	Configure a DMA channel from a DT spec.
static int	sf32lb_dma_start_dt (const struct sf32lb_dma_dt_spec *spec)
	Start a DMA transfer from a DT spec.
static int	sf32lb_dma_stop_dt (const struct sf32lb_dma_dt_spec *spec)
	Stop a DMA transfer from a DT spec.
static int	sf32lb_dma_reload_dt (const struct sf32lb_dma_dt_spec *spec, uintptr_t src, uintptr_t dst, size_t size)
	Reload a DMA transfer from a DT spec.
static int	sf32lb_dma_get_status_dt (const struct sf32lb_dma_dt_spec *spec, struct dma_status *status)
	Get the status of a DMA transfer from a DT spec.

Detailed Description

DMA (SF32LB specifics)

Macro Definition Documentation

SF32LB_DMA_DT_INST_SPEC_GET

#define SF32LB_DMA_DT_INST_SPEC_GET

(

index

)

SF32LB_DMA_DT_SPEC_GET(DT_DRV_INST(index))

#include <zephyr/drivers/dma/sf32lb.h>

Initialize a sf32lb_dma_dt_spec structure from a DT instance.

Parameters

index

DT instance index

SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME

#define SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME	(		index,
			name
	)		SF32LB_DMA_DT_SPEC_GET_BY_NAME(DT_DRV_INST(index), name)

#include <zephyr/drivers/dma/sf32lb.h>

Initialize a sf32lb_dma_dt_spec structure from a DT instance.

Parameters

index	DT instance index
name	DMA name

SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME_OR

#define SF32LB_DMA_DT_INST_SPEC_GET_BY_NAME_OR	(		index,
			name,
			default_value
	)		SF32LB_DMA_DT_SPEC_GET_BY_NAME_OR(DT_DRV_INST(index), name, default_value)

#include <zephyr/drivers/dma/sf32lb.h>

Initialize a sf32lb_dma_dt_spec structure from a DT instance.

Parameters

index	DT instance index
name	DMA name
default_value	Default value for missing cells

SF32LB_DMA_DT_SPEC_GET

#define SF32LB_DMA_DT_SPEC_GET

(

node_id

)

#include <zephyr/drivers/dma/sf32lb.h>

Value:

        {                                                                                          \
                .dev = DEVICE_DT_GET(DT_DMAS_CTLR(node_id)),                                       \
                .channel = DT_DMAS_CELL_BY_IDX(node_id, 0, channel),                               \
                .request = DT_DMAS_CELL_BY_IDX(node_id, 0, request),                               \
                .config = DT_DMAS_CELL_BY_IDX(node_id, 0, config),                                 \
        }

Initialize a sf32lb_dma_dt_spec structure from a DT node.

Parameters

node_id

DT node identifier

SF32LB_DMA_DT_SPEC_GET_BY_NAME

#define SF32LB_DMA_DT_SPEC_GET_BY_NAME	(		node_id,
			name
	)

#include <zephyr/drivers/dma/sf32lb.h>

Value:

        {                                                                                          \
                .dev = DEVICE_DT_GET(DT_DMAS_CTLR_BY_NAME(node_id, name)),                         \
                .channel = DT_DMAS_CELL_BY_NAME(node_id, name, channel),                           \
                .request = DT_DMAS_CELL_BY_NAME(node_id, name, request),                           \
                .config = DT_DMAS_CELL_BY_NAME(node_id, name, config),                             \
        }

Initialize a sf32lb_dma_dt_spec structure from a DT node.

Parameters

node_id

DT node identifier

SF32LB_DMA_DT_SPEC_GET_BY_NAME_OR

#define SF32LB_DMA_DT_SPEC_GET_BY_NAME_OR	(		node_id,
			name,
			default_value
	)

#include <zephyr/drivers/dma/sf32lb.h>

Value:

        COND_CODE_1(DT_DMAS_HAS_NAME(node_id, name),                                               \
                (SF32LB_DMA_DT_SPEC_GET_BY_NAME(node_id, name)), (default_value))

Initialize a sf32lb_dma_dt_spec structure from a DT node, with a fallback to default values.

Parameters

node_id	DT node identifier
name	lowercase-and-underscores name of a dmas element as defined by the node's dma-names property
default_value	a fallback value to expand to

Function Documentation

sf32lb_dma_config_dt()

static int sf32lb_dma_config_dt ( const struct sf32lb_dma_dt_spec *  spec, struct dma_config *  config  )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Configure a DMA channel from a DT spec.

Parameters

spec	SF32LB DMA DT spec
config	DMA configuration

Return values

0	If successful.
-ENOTSUP	If the configuration is not supported.
-errno	Other negative errno code failure (see dma_config()).

sf32lb_dma_config_init_dt()

static void sf32lb_dma_config_init_dt ( const struct sf32lb_dma_dt_spec *  spec, struct dma_config *  config  )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Initialize a DMA configuration structure from a DT spec.

This function sets the following fields in the dma_config structure:

• dma_slot
• channel_priority

Parameters

	spec	SF32LB DMA DT spec
[out]	config	DMA configuration

sf32lb_dma_get_status_dt()

static int sf32lb_dma_get_status_dt ( const struct sf32lb_dma_dt_spec *  spec, struct dma_status *  status  )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Get the status of a DMA transfer from a DT spec.

Parameters

	spec	SF32LB DMA DT spec
[out]	status	Status output

Return values

0	If successful.
-errno	Negative errno code failure (see dma_get_status()).

sf32lb_dma_is_ready_dt()

static bool sf32lb_dma_is_ready_dt ( const struct sf32lb_dma_dt_spec *  spec )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Check if the DMA controller is ready.

Parameters

spec	SF32LB DMA DT spec

Returns

true If the DMA controller is ready.

false If the DMA controller is not ready.

sf32lb_dma_reload_dt()

static int sf32lb_dma_reload_dt ( const struct sf32lb_dma_dt_spec *  spec, uintptr_t  src, uintptr_t  dst, size_t  size  )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Reload a DMA transfer from a DT spec.

Parameters

spec	SF32LB DMA DT spec
src	Source address
dst	Destination address
size	Transfer size

Return values

0	If successful.
-errno	Negative errno code failure (see dma_reload()).

sf32lb_dma_start_dt()

static int sf32lb_dma_start_dt ( const struct sf32lb_dma_dt_spec *  spec )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Start a DMA transfer from a DT spec.

Parameters

spec	SF32LB DMA DT spec

Return values

0	If successful.
-errno	Negative errno code failure (see dma_start()).

sf32lb_dma_stop_dt()

static int sf32lb_dma_stop_dt ( const struct sf32lb_dma_dt_spec *  spec )

inlinestatic

#include <zephyr/drivers/dma/sf32lb.h>

Stop a DMA transfer from a DT spec.

Parameters

spec	SF32LB DMA DT spec

Return values

0	If successful.
-errno	Negative errno code failure (see dma_stop()).