dma.h

 
#ifndef DMA_H
#define DMA_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*******************************************************************************
*                              Include files
*******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "dma_registers.h"
#include "syna_device.h"
/*******************************************************************************
*                               Macro definitions
*******************************************************************************/
#define DMA_DESCRIPTOR_BIT_COUNT            32
/***************************************************************************/
 
/*******************************************************************************
*                              Type Definitions
*******************************************************************************/

typedef uint8_t dma_peripheral_trigger_t;
typedef void (*dma_event_callback_t)(dma_instance_en instance, uint32_t channel, uint32_t event,
                                    void* user_data);
 

typedef uint32_t* dma_descriptor_handle_t;

 


typedef enum {
    DMA_INSTANCE_INITIALIZED = 0,       
    DMA_INSTANCE_NOT_INITIALIZED = 1    
} dma_state_en;

typedef enum {
    DMA_TRANSFER_MODE_1D = 0,        
    DMA_TRANSFER_MODE_2D = 1,        
} dma_transfer_mode_en;

typedef enum {
    DMA_OP_DISABLE = 0,          
    DMA_OP_CONTINUE = 1,         
    DMA_OP_WRAP = 2,             
    DMA_OP_FILL = 3              
} dma_operation_type_en;

typedef enum {
    DMA_SECURITY_SECURE = 0,     
    DMA_SECURITY_NON_SECURE = 1  
} dma_security_en;

typedef enum {
    DMA_PRIVILEGE_PRIVILEGED = 0,    
    DMA_PRIVILEGE_UNPRIVILEGED = 1   
} dma_privilege_en;

typedef enum {
    DMA_UNIT_SIZE_1BYTE = 0,   
    DMA_UNIT_SIZE_2BYTES = 1,  
    DMA_UNIT_SIZE_4BYTES = 2,  
    DMA_UNIT_SIZE_8BYTES = 3,  
    DMA_UNIT_SIZE_16BYTES = 4  
} dma_unit_size_en;

typedef enum {
    DMA_BURST_SIZE_1 = 0,        
    DMA_BURST_SIZE_2 = 1,        
    DMA_BURST_SIZE_4 = 2,        
    DMA_BURST_SIZE_8 = 3,        
    DMA_BURST_SIZE_16 = 4        
} dma_burst_size_en;

typedef enum {
    DMA_FIFO_DEPTH_1 = 0,               
    DMA_FIFO_DEPTH_2 = 1,               
    DMA_FIFO_DEPTH_4 = 2,               
    DMA_FIFO_DEPTH_8 = 3,               
    DMA_FIFO_DEPTH_16 = 4,              
    DMA_FIFO_DEPTH_32 = 5,              
    DMA_FIFO_DEPTH_64 = 6,              
    DMA_FIFO_DEPTH_128 = 7,             
    DMA_CHANNEL_FIFO_DEPTH_ANY = 0xFF   
} dma_fifo_depth_en;

typedef enum {
    DMA_REG_RELOAD_DISABLED = 0,            
    DMA_REG_RELOAD_SIZE_ONLY = 1,           
    DMA_REG_RELOAD_SRC_ADDR_AND_SIZES = 3,  
    DMA_REG_RELOAD_DEST_ADDR_AND_SIZES = 5, 
    DMA_REG_RELOAD_ALL_ADDR_AND_SIZES = 7   
} dma_reg_reload_type_en;

typedef enum {
    DMA_TRIGGER_SOURCE = 0,      
    DMA_TRIGGER_DEST = 1         
} dma_trigger_target_en;

 
typedef enum {
    DMA_SW_TRIG_SINGLE = 0,         
    DMA_SW_TRIG_LAST_SINGLE = 1,    
    DMA_SW_TRIG_BLOCK = 2,          
    DMA_SW_TRIG_LAST_BLOCK = 3      
} dma_sw_trigger_type_en;

typedef enum {
    DMA_TRIG_SW_REQ = 0,        
    DMA_TRIG_RESERVED = 1,      
    DMA_TRIG_HW_REQ = 2,        
    DMA_TRIG_INTERNAL_REQ = 3   
} dma_trigger_type_en;

typedef enum {
    DMA_STATUS_DONE = (1U << 0),     
    DMA_STATUS_ERROR = (1U << 1),    
    DMA_STATUS_DISABLED = (1U << 2), 
    DMA_STATUS_STOPPED = (1U << 3),  
    DMA_STATUS_PAUSED = (1U << 4),   
    DMA_STATUS_BUSY = (1U << 5),     
    DMA_STATUS_WAITING = (1U << 6)   
} dma_status_flags_en;

typedef enum {
    DMA_INT_DONE = (1U << 0),        
    DMA_INT_ERROR = (1U << 1),       
    DMA_INT_DISABLED = (1U << 2),    
    DMA_INT_STOPPED = (1U << 3)      
} dma_interrupt_flags_en;

typedef enum {
 
    DMA_OK = 0,                             
    DMA_ERROR_INVALID_INSTANCE = 1,         
    DMA_ERROR_INVALID_CHANNEL = 2,          
    DMA_ERROR_INVALID_CONFIG = 3,           
    DMA_ERROR_CHANNEL_BUSY = 4,             
    DMA_ERROR_NO_CHANNELS = 5,              
    DMA_ERROR_HARDWARE_ERROR = 6,           
    DMA_ERROR_INVALID_ADDRESS = 7,          
    DMA_ERROR_INVALID_SIZE = 8,             
    DMA_ERROR_BURST_MISMATCH = 9,           
    DMA_ERROR_ALIGNMENT = 10,               
    DMA_ERROR_TEMPLATE_NOT_SUPPORTED = 11,  
    DMA_ERROR_2D_NOT_SUPPORTED = 12,        
    DMA_ERROR_TRIGGER_CONFLICT = 13,        
    DMA_ERROR_INVALID_PARAMETER = 14,       
    DMA_ERROR_ALREADY_INITIALIZED = 15,     
    DMA_ERROR_NOT_INITIALIZED = 16,         
    DMA_ERROR_SEMAPHORE_ALLOC = 17,         
    DMA_ERROR_MEMORY_ALLOC = 18,            
    DMA_ERROR_TRANSFER_FAIL = 19            
} dma_status_en;

typedef enum {
    DMA_OPTION_NONE = 0,             
    DMA_OPTION_HIGH_PRIORITY = 1,    
    DMA_OPTION_SECURE = 4,           
    DMA_OPTION_PRIVILEGED = 8        
} dma_transfer_options_en;

typedef enum {
    DMA_TRANSFER_TYPE_MEM2MEM = 0,   
    DMA_TRANSFER_TYPE_PERIPH2MEM,    
    DMA_TRANSFER_TYPE_MEM2PERIPH,    
    DMA_TRANSFER_TYPE_STATIC         
} dma_transfer_type_en;
 

typedef enum {
 
    DMA_TRIG_MODE_COMMAND = 0,     
    DMA_TRIG_MODE_RESERVED = 1,    
    DMA_TRIG_MODE_FLOW = 2,        
    DMA_TRIG_MODE_INTERNAL = 3     
} dma_trigger_mode_en;
 

typedef enum {
    DMA_DONE_TYPE_NONE = 0,             
    DMA_DONE_TYPE_DEFAULT = 1,          
    DMA_DONE_TYPE_AUTO_RESTART = 3      
} dma_donetype_en;
 



typedef struct {
 
    bool enable_auto_restart;     
    bool infinite_restart;        
    uint16_t restart_count;       
} dma_auto_restart_config_t;

 
typedef struct {
 
    dma_trigger_type_en trig_type;       
    dma_sw_trigger_type_en sw_trig_type; 
    dma_trigger_mode_en mode;            
    uint8_t block_size;                  
 
} dma_sw_trigger_config_t;

typedef struct {
    bool enable;                     
    uint8_t trigger_port;            
    bool trigger_level;              
    bool trigger_edge;               
} dma_hw_trigger_config_t;

typedef struct {
    bool enable_template;               
    uint8_t src_template_size;          
    uint8_t dest_template_size;         
    uint32_t src_template;              
    uint32_t dest_template;             
} dma_template_config_t;

typedef struct {
    dma_operation_type_en x_type;           
 
    uint32_t src_addr;                      
    uint32_t dest_addr;                     
 
    uint32_t transfer_size;                 
    dma_unit_size_en unit_size;             
 
    dma_burst_size_en src_burst_size;       
    dma_burst_size_en dest_burst_size;      
 
    int32_t src_x_increment;                
    int32_t dest_x_increment;               
 
    uint32_t fill_value;                    
 
    dma_template_config_t template_config;  
 
    uint32_t link_addr;                     
} dma_1d_config_t;

typedef struct {
    dma_operation_type_en x_type;       
    dma_operation_type_en y_type;       
 
    /* Address configuration */
    uint32_t src_addr;                  
    uint32_t dest_addr;                 
 
    /* Size configuration */
    uint32_t src_x_size;                
    uint32_t dest_x_size;               
    uint32_t src_y_size;                
    uint32_t dest_y_size;               
 
    dma_unit_size_en unit_size;         
    dma_burst_size_en src_burst_size;   
    dma_burst_size_en dest_burst_size;  
 
    int32_t src_x_increment;            
    int32_t dest_x_increment;           
    int32_t src_y_stride;               
    int32_t dest_y_stride;              
 
    uint32_t fill_value;                
 
    uint32_t link_addr;                 
} dma_2d_config_t;

typedef struct {
    dma_transfer_mode_en mode;              
 
    union {
        dma_1d_config_t config_1d;          
        dma_2d_config_t config_2d;          
    };
 
    uint8_t priority;                       
    dma_security_en src_security;           
    dma_security_en dest_security;          
    dma_privilege_en src_privilege;         
    dma_privilege_en dest_privilege;        
 
    /* Trigger configuration */
    dma_hw_trigger_config_t src_trigger;    
    dma_hw_trigger_config_t dest_trigger;   
 
    /* Auto-configuration */
    dma_auto_restart_config_t auto_restart; 
    dma_reg_reload_type_en reg_reload_type; 
 
    /* Callback configuration */
    dma_event_callback_t callback;          
    void *user_data;                        
} dma_channel_config_t;

typedef struct {
    bool is_free;                           
 
    bool support_2d;                        
    bool template_supported;                
    uint32_t wrap_supported;                
    uint32_t cmd_link_supported;            
    dma_fifo_depth_en required_fifo_depth;  
 
    /* Constraints / policy */
    dma_security_en security;               
    dma_privilege_en privilege;             
 
    uint8_t trig_in_sel;                    
 
    uint32_t base_address;                  
} dma_channel_attr_t;

 
 
/*******************************************************************************
*                              Command Linking Support
*******************************************************************************/

 
/*******************************************************************************
*                              Template Configurations
*******************************************************************************/

extern const dma_channel_config_t DMA_CONFIG_MEMORY_COPY;
extern const dma_channel_config_t DMA_CONFIG_MEMORY_TO_PERIPHERAL;
extern const dma_channel_config_t DMA_CONFIG_PERIPHERAL_TO_MEMORY;
extern const dma_channel_config_t DMA_CONFIG_2D_IMAGE_COPY;

 
/*******************************************************************************
*                              Function Declarations
*******************************************************************************/
 
/*******************************************************************************
* Function Name: dma_init
****************************************************************************/
dma_status_en dma_init(dma_instance_en instance);
 
/*******************************************************************************
* Function Name: dma_deinit
****************************************************************************/
dma_status_en dma_deinit(dma_instance_en instance);
 
/*******************************************************************************
* Function Name: dma_request_channel
****************************************************************************/
dma_status_en dma_channel_request(dma_instance_en instance, uint32_t *channel,
                                 dma_channel_attr_t *attr);
 
/*******************************************************************************
* Function Name: dma_request_specific_channel
****************************************************************************/
dma_status_en dma_request_specific_channel(dma_instance_en instance,
                                            uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_free_channel
****************************************************************************/
dma_status_en dma_free_channel(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_prepare_transfer
****************************************************************************/
dma_status_en dma_prepare_transfer(dma_instance_en instance,  uint32_t channel,
                                    dma_channel_config_t* config);
 
/*******************************************************************************
* Function Name: dma_start_transfer
****************************************************************************/
dma_status_en dma_start_transfer(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_sw_trig_config
****************************************************************************/
dma_status_en dma_sw_trig_config(dma_instance_en instance, uint32_t channel,
                                const dma_sw_trigger_config_t* config);
 
/*******************************************************************************
* Function Name: dma_sw_trig
****************************************************************************/
dma_status_en dma_sw_trig(dma_instance_en instance,  uint32_t channel,
                            dma_trigger_target_en trigger_target);
 
/*******************************************************************************
* Function Name: dma_get_status
****************************************************************************/
dma_status_en dma_get_status(dma_instance_en instance,  uint32_t channel,
                            uint32_t* status);
 
/*******************************************************************************
* Function Name: dma_clear_status
****************************************************************************/
dma_status_en dma_clear_status(dma_instance_en instance,  uint32_t channel,
                                uint32_t mask);
 
/*******************************************************************************
* Function Name: dma_enable_ints
****************************************************************************/
dma_status_en dma_enable_ints(dma_instance_en instance,  uint32_t channel,
                                uint32_t mask);
 
/*******************************************************************************
* Function Name: dma_disable_ints
****************************************************************************/
dma_status_en dma_disable_ints(dma_instance_en instance,  uint32_t channel,
                                uint32_t mask);
 
/*******************************************************************************
* Function Name: dma_get_error
****************************************************************************/
dma_status_en dma_get_error(dma_instance_en instance,  uint32_t channel,
                            uint32_t* error);
 
/*******************************************************************************
* Function Name: dma_pause_transfer
****************************************************************************/
dma_status_en dma_pause_transfer(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_resume_transfer
****************************************************************************/
dma_status_en dma_resume_transfer(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_stop_transfer
****************************************************************************/
dma_status_en dma_stop_transfer(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_abort_transfer
****************************************************************************/
dma_status_en dma_abort_transfer(dma_instance_en instance,  uint32_t channel);
 
/*******************************************************************************
* Function Name: dma_get_remaining_bytes
****************************************************************************/
dma_status_en dma_get_remaining_bytes(dma_instance_en instance,  uint32_t channel,
                                        uint32_t* remaining);
 
/*******************************************************************************
* Function Name: dma_channel_is_active
****************************************************************************/
dma_status_en dma_channel_is_active(dma_instance_en instance,  uint32_t channel, bool *active);
 
/*******************************************************************************
* Function Name: dma_create_descriptor
****************************************************************************/
dma_status_en dma_create_descriptor(dma_instance_en instance, uint32_t channel,
                                    const dma_channel_config_t *config,
                                    dma_descriptor_handle_t *descriptor_out);
 
/*******************************************************************************
* Function Name: dma_link_descriptors
****************************************************************************/
dma_status_en dma_link_descriptors(dma_descriptor_handle_t first_desc,
                                    dma_descriptor_handle_t second_desc);
 
/*******************************************************************************
* Function Name: dma_start_descriptor_chain
****************************************************************************/
dma_status_en dma_start_descriptor_chain(dma_instance_en instance,
                                        uint32_t channel,
                                        dma_descriptor_handle_t* first_desc);
 
/*******************************************************************************
* Function Name: dma_free_descriptor
****************************************************************************/
dma_status_en dma_free_descriptor(dma_descriptor_handle_t descriptor);


 
#ifdef __cplusplus
}
#endif
 
#endif /* DMA_H */