dma.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/common/template/vsf_template_hal_driver.h"

Go to the source code of this file.

Data Structures
struct	vsf_dma_channel_hint_t
	DMA channel hint structure for channel allocation. More...
struct	vsf_dma_isr_t
struct	vsf_dma_channel_cfg_t
	dma configuration More...
struct	vsf_dma_channel_status_t
struct	vsf_dma_channel_sg_desc_t
	DMA scatter-gather descriptor structure. More...
struct	vsf_dma_cfg_t
	Configuration structure for DMA. More...
struct	vsf_dma_capability_t
	DMA capability structure that can be reimplemented in specific HAL drivers. More...

Macros
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_ADDR   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_HINT   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_SG_CFG   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_STATUS   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_DMA_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedefs
typedef uintptr_t	vsf_dma_addr_t
	DMA address type, used for source address, destination address and scatter-gather descriptor address.
typedef enum vsf_dma_channel_mode_t	vsf_dma_channel_mode_t
typedef enum vsf_dma_irq_mask_t	vsf_dma_irq_mask_t
typedef struct vsf_dma_channel_hint_t	vsf_dma_channel_hint_t
typedef void	vsf_dma_isr_handler_t(void *target_ptr, vsf_dma_t *dma_ptr, int8_t channel, vsf_dma_irq_mask_t irq_mask)
typedef struct vsf_dma_isr_t	vsf_dma_isr_t
typedef struct vsf_dma_channel_cfg_t	vsf_dma_channel_cfg_t
typedef struct vsf_dma_channel_status_t	vsf_dma_channel_status_t
typedef struct vsf_dma_channel_sg_desc_t	vsf_dma_channel_sg_desc_t
typedef struct vsf_dma_cfg_t	vsf_dma_cfg_t
typedef struct vsf_dma_capability_t	vsf_dma_capability_t

Enumerations
enum	vsf_dma_channel_mode_t {   VSF_DMA_MEMORY_TO_MEMORY = (1 << 14) | (0 << 4) ,   VSF_DMA_MEMORY_TO_PERIPHERAL = (0 << 14) | (1 << 4) ,   VSF_DMA_PERIPHERAL_TO_MEMORY = (0 << 14) | (0 << 4) ,   VSF_DMA_SRC_ADDR_INCREMENT = (1 << 6) ,   VSF_DMA_SRC_ADDR_NO_CHANGE = (0 << 6) ,   VSF_DMA_SRC_WIDTH_BYTE_1 = (0 << 8) ,   VSF_DMA_SRC_WIDTH_BYTES_2 = (1 << 8) ,   VSF_DMA_SRC_WIDTH_BYTES_4 = (2 << 8) ,   VSF_DMA_DST_ADDR_INCREMENT = (1 << 7) ,   VSF_DMA_DST_ADDR_NO_CHANGE = (0 << 7) ,   VSF_DMA_DST_WIDTH_BYTE_1 = (0 << 10) ,   VSF_DMA_DST_WIDTH_BYTES_2 = (1 << 10) ,   VSF_DMA_DST_WIDTH_BYTES_4 = (2 << 10) ,   VSF_DMA_PRIORITY_LOW = (0x00 << 12) ,   VSF_DMA_PRIORITY_MEDIUM = (0x01 << 12) ,   VSF_DMA_PRIORITY_HIGH = (0x02 << 12) ,   VSF_DMA_PRIORITY_VERY_HIGH = (0x03 << 12) ,   VSF_DMA_EVENT = (1 << 17) ,   VSF_DMA_SYNC_RISING = (1 << 24) | (1 << 25) ,   VSF_DMA_SYNC_FALLING = (1 << 24) | (2 << 25) ,   VSF_DMA_SYNC_RISING_AND_FALLING = (1 << 24) | (3 << 25) ,   VSF_DMA_PERIPHERAL_TO_PERIPHERAL = (1 << 16) ,   VSF_DMA_SRC_ADDR_DECREMENT = (1 << 17) ,   VSF_DMA_DST_ADDR_DECREMENT = (1 << 18) ,   VSF_DMA_SRC_WIDTH_BYTES_8 = (0 << 19) ,   VSF_DMA_SRC_WIDTH_BYTES_16 = (1 << 19) ,   VSF_DMA_SRC_WIDTH_BYTES_32 = (2 << 19) ,   VSF_DMA_DST_WIDTH_BYTES_8 = (0 << 21) ,   VSF_DMA_DST_WIDTH_BYTES_16 = (1 << 21) ,   VSF_DMA_DST_WIDTH_BYTES_32 = (2 << 21) ,   VSF_DMA_SRC_BURST_LENGTH_1 = (0 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_2 = (1 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_4 = (2 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_8 = (3 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_16 = (4 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_32 = (5 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_64 = (6 << 23) ,   VSF_DMA_SRC_BURST_LENGTH_128 = (7 << 23) ,   VSF_DMA_DST_BURST_LENGTH_1 = (0 << 26) ,   VSF_DMA_DST_BURST_LENGTH_2 = (1 << 26) ,   VSF_DMA_DST_BURST_LENGTH_4 = (2 << 26) ,   VSF_DMA_DST_BURST_LENGTH_8 = (3 << 26) ,   VSF_DMA_DST_BURST_LENGTH_16 = (4 << 26) ,   VSF_DMA_DST_BURST_LENGTH_32 = (5 << 26) ,   VSF_DMA_DST_BURST_LENGTH_64 = (6 << 26) ,   VSF_DMA_DST_BURST_LENGTH_128 = (7 << 26) ,   VSF_HW_DMA_CTRL_CONFIG_MASK }
enum	vsf_dma_irq_mask_t {   VSF_DMA_IRQ_MASK_CPL = (1 << 1) ,   VSF_DMA_IRQ_MASK_HALF_CPL = (1 << 2) ,   VSF_DMA_IRQ_MASK_ERROR = (1 << 3) }

Macro Definition Documentation

VSF_DMA_CFG_REIMPLEMENT_TYPE_ADDR

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_ADDR   ENABLED

Note

When vsf_peripheral_status_t is inherited, vsf_template_hal_driver.h needs to be included

VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_HINT

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_HINT   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_SG_CFG

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_SG_CFG   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_STATUS

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CHANNEL_STATUS   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_DMA_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_DMA_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_dma_addr_t

typedef uintptr_t vsf_dma_addr_t

DMA address type, used for source address, destination address and scatter-gather descriptor address.

Note

The default type is uintptr_t.

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_channel_mode_t

typedef enum vsf_dma_channel_mode_t vsf_dma_channel_mode_t

vsf_dma_irq_mask_t

typedef enum vsf_dma_irq_mask_t vsf_dma_irq_mask_t

vsf_dma_channel_hint_t

typedef struct vsf_dma_channel_hint_t vsf_dma_channel_hint_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_isr_handler_t

typedef void vsf_dma_isr_handler_t(void *target_ptr, vsf_dma_t *dma_ptr, int8_t channel, vsf_dma_irq_mask_t irq_mask)

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_isr_t

typedef struct vsf_dma_isr_t vsf_dma_isr_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_channel_cfg_t

typedef struct vsf_dma_channel_cfg_t vsf_dma_channel_cfg_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_channel_status_t

typedef struct vsf_dma_channel_status_t vsf_dma_channel_status_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_channel_sg_desc_t

typedef struct vsf_dma_channel_sg_desc_t vsf_dma_channel_sg_desc_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_cfg_t

typedef struct vsf_dma_cfg_t vsf_dma_cfg_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_capability_t

typedef struct vsf_dma_capability_t vsf_dma_capability_t

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

Enumeration Type Documentation

vsf_dma_channel_mode_t

enum vsf_dma_channel_mode_t

Enumerator
VSF_DMA_MEMORY_TO_MEMORY
VSF_DMA_MEMORY_TO_PERIPHERAL
VSF_DMA_PERIPHERAL_TO_MEMORY
VSF_DMA_SRC_ADDR_INCREMENT
VSF_DMA_SRC_ADDR_NO_CHANGE
VSF_DMA_SRC_WIDTH_BYTE_1
VSF_DMA_SRC_WIDTH_BYTES_2
VSF_DMA_SRC_WIDTH_BYTES_4
VSF_DMA_DST_ADDR_INCREMENT
VSF_DMA_DST_ADDR_NO_CHANGE
VSF_DMA_DST_WIDTH_BYTE_1
VSF_DMA_DST_WIDTH_BYTES_2
VSF_DMA_DST_WIDTH_BYTES_4
VSF_DMA_PRIORITY_LOW
VSF_DMA_PRIORITY_MEDIUM
VSF_DMA_PRIORITY_HIGH
VSF_DMA_PRIORITY_VERY_HIGH
VSF_DMA_EVENT
VSF_DMA_SYNC_RISING
VSF_DMA_SYNC_FALLING
VSF_DMA_SYNC_RISING_AND_FALLING
VSF_DMA_PERIPHERAL_TO_PERIPHERAL
VSF_DMA_SRC_ADDR_DECREMENT
VSF_DMA_DST_ADDR_DECREMENT
VSF_DMA_SRC_WIDTH_BYTES_8
VSF_DMA_SRC_WIDTH_BYTES_16
VSF_DMA_SRC_WIDTH_BYTES_32
VSF_DMA_DST_WIDTH_BYTES_8
VSF_DMA_DST_WIDTH_BYTES_16
VSF_DMA_DST_WIDTH_BYTES_32
VSF_DMA_SRC_BURST_LENGTH_1
VSF_DMA_SRC_BURST_LENGTH_2
VSF_DMA_SRC_BURST_LENGTH_4
VSF_DMA_SRC_BURST_LENGTH_8
VSF_DMA_SRC_BURST_LENGTH_16
VSF_DMA_SRC_BURST_LENGTH_32
VSF_DMA_SRC_BURST_LENGTH_64
VSF_DMA_SRC_BURST_LENGTH_128
VSF_DMA_DST_BURST_LENGTH_1
VSF_DMA_DST_BURST_LENGTH_2
VSF_DMA_DST_BURST_LENGTH_4
VSF_DMA_DST_BURST_LENGTH_8
VSF_DMA_DST_BURST_LENGTH_16
VSF_DMA_DST_BURST_LENGTH_32
VSF_DMA_DST_BURST_LENGTH_64
VSF_DMA_DST_BURST_LENGTH_128
VSF_HW_DMA_CTRL_CONFIG_MASK

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.

vsf_dma_irq_mask_t

enum vsf_dma_irq_mask_t

Enumerator
VSF_DMA_IRQ_MASK_CPL
VSF_DMA_IRQ_MASK_HALF_CPL
VSF_DMA_IRQ_MASK_ERROR

Examples

/github/workspace/source/hal/driver/common/template/vsf_template_dma.h.