spwm.h

 
#ifndef SPWM_H_
#define SPWM_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "syna_device.h"
#include "spwm_registers.h"
 
/*******************************************************************************
*                               Macro definitions
*******************************************************************************/
#define SPWM_TRIG_IN_COUNT    6      
#define SPWM_TRIG_OUT_COUNT   2      
#define SPWM_SEMA_COUNT       2      

#define DESC_BLOCK_SIZE (SPWM_CONFIG_DESC_MEM_SIZE / SPWM_CONFIG_DESC_INSTANCE_NUM)
 
/***************************************************************************/
 
/*******************************************************************************
*                               Enumerated Types
*******************************************************************************/


typedef enum {
    SPWM_OK = 0,                 
    SPWM_ERROR,                  
    SPWM_ERROR_PARAMETER,        
    SPWM_ERROR_UNSUPPORTED,      
    SPWM_ERROR_BUSY,             
    SPWM_ERROR_TIMEOUT,          
    SPWM_ERROR_NOT_INITIALIZED   
} spwm_status_en;

typedef enum {
    SPWM_MODE_TIMER = 0,  
    SPWM_MODE_RESERVED1,  
    SPWM_MODE_CAPTURE,    
    SPWM_MODE_QUAD,       
    SPWM_MODE_PWM,        
    SPWM_MODE_PWM_DT,     
    SPWM_MODE_PWM_PR,     
    SPWM_MODE_SR          
} spwm_mode_en;

typedef enum {
    SPWM_COUNT_UP = 0,    
    SPWM_COUNT_DOWN,      
    SPWM_COUNT_UPDOWN1,   
    SPWM_COUNT_UPDOWN2    
} spwm_count_mode_en;

typedef enum {
    SPWM_QUAD_MODE_RANGE0 = 0,     
    SPWM_QUAD_MODE_RANGE0_CMP,     
    SPWM_QUAD_MODE_RANGE1_CAPT,    
    SPWM_QUAD_MODE_RANGE1_CMP,     
    SPWM_QUAD_MODE_RANGE1_NUM      
} spwm_quad_mode_en;

typedef enum {
    SPWM_QUAD_ENC_X1 = 0,      
    SPWM_QUAD_ENC_X2,          
    SPWM_QUAD_ENC_X4,          
    SPWM_QUAD_ENC_UP_DOWN,     
    SPWM_QUAD_ENC_NUM          
} spwm_quad_encoding_en;

typedef enum {
    SPWM_PRESCALE_DIV1 = 0,    
    SPWM_PRESCALE_DIV2,        
    SPWM_PRESCALE_DIV4,        
    SPWM_PRESCALE_DIV8,        
    SPWM_PRESCALE_DIV16,       
    SPWM_PRESCALE_DIV32,       
    SPWM_PRESCALE_DIV64,       
    SPWM_PRESCALE_DIV128       
} spwm_prescale_en;

typedef enum {
    SPWM_TRIG_CAPTURE0 = 0,     
    SPWM_TRIG_COUNT,            
    SPWM_TRIG_RELOAD,           
    SPWM_TRIG_STOP,             
    SPWM_TRIG_START,            
    SPWM_TRIG_CAPTURE1          
} spwm_trigger_en;

typedef enum {
    SPWM_TRIN_0 = 0,            
    SPWM_TRIN_1,                
    /* Sensor hub / other internal trigger sources */
    SPWM_TRIN_SM_CAP0,          
    SPWM_TRIN_SM_CAP1,          
    SPWM_TRIN_SM_CAP2,          
    SPWM_TRIN_SM_CAP3,          
    SPWM_TRIN_SM_CAP4,          
    SPWM_TRIN_SM_CAP5,          
    SPWM_TRIN_SM_CAP6,          
    SPWM_TRIN_SM_CAP7,          
    SPWM_TRIN_SM_CAP8,          
    SPWM_TRIN_SM_CAP9,          
    SPWM_TRIN_SM_CAP10,         
    SPWM_TRIN_SM_CAP11,         
    /* Loopback from SPWM trigger outputs (TROUT) */
    SPWM_TRIN_TROUT0_0,         
    SPWM_TRIN_TROUT0_1,         
    SPWM_TRIN_TROUT1_0,         
    SPWM_TRIN_TROUT1_1,         
    SPWM_TRIN_TROUT2_0,         
    SPWM_TRIN_TROUT2_1,         
    SPWM_TRIN_TROUT3_0,         
    SPWM_TRIN_TROUT3_1,         
    SPWM_TRIN_TROUT4_0,         
    SPWM_TRIN_TROUT4_1,         
    SPWM_TRIN_TROUT5_0,         
    SPWM_TRIN_TROUT5_1,         
    SPWM_TRIN_TROUT6_0,         
    SPWM_TRIN_TROUT6_1,         
    SPWM_TRIN_TROUT7_0,         
    SPWM_TRIN_TROUT7_1,         
    SPWM_TRIN_TROUT8_0,         
    SPWM_TRIN_TROUT8_1,         
    SPWM_TRIN_TROUT9_0,         
    SPWM_TRIN_TROUT9_1,         
    SPWM_TRIN_TROUT10_0,        
    SPWM_TRIN_TROUT10_1,        
    SPWM_TRIN_TROUT11_0,        
    SPWM_TRIN_TROUT11_1,        
    /* Group command triggers from GRP_TR_CMD */
    SPWM_TRIN_CNT_GRP_0 = (256 - SPWM_CONFIG_GROUP_TRIGGER_NUM), 
    SPWM_TRIN_CNT_GRP_1,        
    SPWM_TRIN_CNT_GRP_2,        
    SPWM_TRIN_CNT_GRP_3,        
    SPWM_TRIN_CNT_GRP_4,        
    SPWM_TRIN_CNT_GRP_5,        
    SPWM_TRIN_CNT_GRP_6,        
    SPWM_TRIN_CNT_GRP_7,        
    SPWM_TRIN_NUM               
} spwm_trigger_src_en;

typedef enum {
    SPWM_TR_RISING_EDGE = 0,   
    SPWM_TR_FALLING_EDGE,      
    SPWM_TR_ANY_EDGE,          
    SPWM_TR_NO_EDGE_DET,       
} spwm_trigger_edge_sel_en;

typedef enum {
    SPWM_TR_OUT_OVERFLOW = 0,  
    SPWM_TR_OUT_UNDERFLOW,     
    SPWM_TR_OUT_TC,            
    SPWM_TR_OUT_CC0_MATCH,     
    SPWM_TR_OUT_CC1_MATCH,     
    SPWM_TR_OUT_LINE_OUT,      
    SPWM_TR_OUT_RESERVED6,     
    SPWM_TR_OUT_DISABLED,      
} spwm_trigger_out_en;

typedef enum {
    SPWM_INTR_TC = 0,           
    SPWM_INTR_CC0_MATCH,        
    SPWM_INTR_CC1_MATCH,        
} spwm_intr_en;

typedef enum {
    SPWM_CTRL_SET = 0,          
    SPWM_CTRL_CLEAR,            
    SPWM_CTRL_INVERT,           
    SPWM_CTRL_NO_CHANGE         
} spwm_pwm_ctrl_mode_en;

typedef enum {
    SPWM_DISABLE_Z = 0,         
    SPWM_DISABLE_RETAIN,        
    SPWM_DISABLE_LOW,           
    SPWM_DISABLE_HIGH           
} spwm_disable_mode_en;

typedef enum {
    SPWM_PWM_OUT_0,    
    SPWM_PWM_OUT_1,    
    SPWM_PWM_OUT_2,    
    SPWM_PWM_OUT_3,    
    SPWM_PWM_OUT_4,    
    SPWM_PWM_OUT_5,    
    SPWM_PWM_OUT_6,    
    SPWM_PWM_OUT_7,    
    SPWM_PWM_OUT_8,    
    SPWM_PWM_OUT_9,    
    SPWM_PWM_OUT_10,   
    SPWM_PWM_OUT_11,   
    SPWM_CAP_IN_0,     
    SPWM_CAP_IN_1,     
    SPWM_CAP_IN_2,     
    SPWM_IO_PIN_MAX,   
} spwm_io_pin_en;

typedef enum {
    SPWM_PWM_CTRL_CC0_MATCH,   
    SPWM_PWM_CTRL_OVERFLOW,    
    SPWM_PWM_CTRL_UNDERFLOW,   
    SPWM_PWM_CTRL_CC1_MATCH,   
    SPWM_PWM_CTRL_NUM,         
} spwm_pwm_ctrl_en;

typedef enum {
    SPWM_LINE_SRC_L,       
    SPWM_LINE_SRC_H,       
    SPWM_LINE_SRC_PWM,     
    SPWM_LINE_SRC_INV,     
    SPWM_LINE_SRC_Z,       
    SPWM_LINE_SRC_NUM,     
} spwm_line_src_en;

typedef enum
{
    SPWM_DSC_OK,                 
    SPWM_DSC_ERROR_RANGE,        
    SPWM_DSC_ERROR_NOSPACE,      
    SPWM_DSC_ERROR_BUSY,         
    SPWM_DSC_ERROR_NULL,         
    SPWM_DSC_ERROR_INVALID       
} spwm_dsc_status_en;

typedef enum
{
    SPWM_DSC_SYN_WAIT_ALL,       
    SPWM_DSC_SYN_WAIT_ANY,       
    SPWM_DSC_SYN_SET,            
    SPWM_DSC_SYN_CLEAR           
} spwm_dsc_syn_op_en;

typedef enum {
    SPWM_DSC_REG_CTRL = 0,          
    SPWM_DSC_REG_CC0,               
    SPWM_DSC_REG_CC1,               
    SPWM_DSC_REG_PERIOD,            
    SPWM_DSC_REG_CC0_BUFF,          
    SPWM_DSC_REG_CC1_BUFF,          
    SPWM_DSC_REG_PERIOD_BUFF,       
    SPWM_DSC_REG_LINE_SEL,          
    SPWM_DSC_REG_LINE_SEL_BUFF,     
    SPWM_DSC_REG_TR_CMD,            
    SPWM_DSC_REG_INTR_STA,          
} spwm_dsc_reg_id_en;

 
/*******************************************************************************
*                            Type Definitions
*******************************************************************************/


typedef void (*spwm_isr_cb_t)(spwm_instance_en id, uint32_t irq_mask, void *user_ctx);

typedef void (*spwm_desc_isr_cb_t)(spwm_instance_en id, uint8_t desc_id, void *param);

typedef struct spwm_dsc_chain spwm_dsc_chain_t;

typedef struct {
    spwm_trigger_src_en       src;    
    spwm_trigger_edge_sel_en  edge;   
    bool                      invert; 
} spwm_trigger_in_cfg_t;

typedef struct {
    bool auto_reload_cc0;     
    bool auto_reload_cc1;     
} spwm_timer_cfg_t;

typedef struct {
    bool                   auto_reload_cc0;     
    bool                   auto_reload_cc1;     
    bool                   auto_reload_period;  
    spwm_trigger_in_cfg_t  trig_a;              
    spwm_trigger_in_cfg_t  trig_b;              
    spwm_trigger_in_cfg_t  trig_idx;            
    spwm_quad_mode_en      quad_mode;           
    spwm_quad_encoding_en  encoding;            
} spwm_quad_cfg_t;

typedef struct {
    bool                   auto_reload_cc0;      
    bool                   auto_reload_cc1;      
    bool                   auto_reload_period;   
    bool                   auto_reload_line_sel; 
    bool                   cc0_match_up_en;      
    bool                   cc1_match_up_en;      
    bool                   cc0_match_down_en;    
    bool                   cc1_match_down_en;    
    bool                   pwm_imm_kill;         
    bool                   pwm_stop_on_kill;     
    bool                   pwm_sync_kill;        
    spwm_disable_mode_en   disable_mode;         
    spwm_pwm_ctrl_mode_en  cc0_match_mode;       
    spwm_pwm_ctrl_mode_en  overflow_mode;        
    spwm_pwm_ctrl_mode_en  underflow_mode;       
    spwm_pwm_ctrl_mode_en  cc1_match_mode;       
    uint32_t               line_sel;             
    uint32_t               line_sel_buff;        
} spwm_pwm_cfg_t;

typedef struct {
    spwm_pwm_cfg_t        pwm;            
    uint16_t              deadtime;       
    uint16_t              compl_deadtime; 
} spwm_pwmdt_cfg_t;

typedef struct {
    spwm_pwm_cfg_t pwm;     
    uint16_t lfsr_seed;     
    uint16_t lfsr_tap;      
} spwm_pwmpr_cfg_t;

typedef struct {
    uint8_t auto_reload_cc0;   
    uint8_t auto_reload_cc1;   
} spwm_sr_cfg_t;

typedef struct {
    uint32_t               cc0;                
    uint32_t               cc0_buff;           
    uint32_t               cc1;                
    uint32_t               cc1_buff;           
    int                    clkdiv_sel;         
    uint32_t               period;             
    uint32_t               counter;            
    uint32_t               period_buff;        
    spwm_count_mode_en     count_mode;         
    spwm_trigger_in_cfg_t  trig_in[SPWM_TRIG_IN_COUNT];
    spwm_trigger_out_en    trig_out[SPWM_TRIG_OUT_COUNT];
    spwm_trigger_out_en    sema[SPWM_SEMA_COUNT];
    spwm_mode_en           mode;               
    bool                   one_shot;           
    spwm_prescale_en       prescale;           
    union {
        spwm_timer_cfg_t   timer;              
        spwm_pwm_cfg_t     pwm;                
        spwm_pwmdt_cfg_t   pwmdt;              
        spwm_quad_cfg_t    quad;               
        spwm_pwmpr_cfg_t   pwmpr;              
        spwm_sr_cfg_t      sr;                 
    } cfg;                                     
} spwm_config_t;

typedef struct
{
    bool running;       
    bool done;          
    bool error;         
    bool irq_enabled;   
    bool irq_pending;   
} spwm_dsc_chain_status_t;

 
/*******************************************************************************
*                          Function Prototypes
*******************************************************************************/

 
/*******************************************************************************
* Function Name: spwm_init
****************************************************************************/
spwm_status_en spwm_init(spwm_instance_en id);
 
/*******************************************************************************
* Function Name: spwm_deinit
****************************************************************************/
spwm_status_en spwm_deinit(spwm_instance_en id);
 
/*******************************************************************************
* Function Name: spwm_enable
****************************************************************************/
spwm_status_en spwm_enable(spwm_instance_en id, uint8_t group_id);
 
/*******************************************************************************
* Function Name: spwm_disable
****************************************************************************/
spwm_status_en spwm_disable(spwm_instance_en id, uint8_t group_id);
 
/*******************************************************************************
* Function Name: spwm_clkdiv_config
****************************************************************************/
spwm_status_en spwm_clkdiv_config(spwm_instance_en id, uint8_t clkdiv_id,
                                  uint32_t int_div, uint32_t fra_div);
 
/*******************************************************************************
* Function Name: spwm_clkdiv_enable
****************************************************************************/
spwm_status_en spwm_clkdiv_enable(spwm_instance_en id, uint8_t clkdiv_id,
                                  bool enable, uint8_t phase_align_sel);
 
/*******************************************************************************
* Function Name: spwm_otrigclk_config
****************************************************************************/
spwm_status_en spwm_otrigclk_config(spwm_instance_en id, uint8_t clkdiv_id);
 
/*******************************************************************************
* Function Name: spwm_configure
****************************************************************************/
spwm_status_en spwm_configure(spwm_instance_en id, uint8_t group_id,
                              const spwm_config_t *config);
 
/*******************************************************************************
* Function Name: spwm_trigger
****************************************************************************/
spwm_status_en spwm_trigger(spwm_instance_en id, uint8_t group_id, spwm_trigger_en trig);
 
/*******************************************************************************
* Function Name: spwm_group_trigger
****************************************************************************/
spwm_status_en spwm_group_trigger(spwm_instance_en id, uint8_t group_trigger_id);
 
/*******************************************************************************
* Function Name: spwm_get_counter
****************************************************************************/
spwm_status_en spwm_get_counter(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_cc0
****************************************************************************/
spwm_status_en spwm_get_cc0(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_cc1
****************************************************************************/
spwm_status_en spwm_get_cc1(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_period
****************************************************************************/
spwm_status_en spwm_get_period(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_line_sel
****************************************************************************/
spwm_status_en spwm_get_line_sel(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_cc0_buff
****************************************************************************/
spwm_status_en spwm_get_cc0_buff(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_cc1_buff
****************************************************************************/
spwm_status_en spwm_get_cc1_buff(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_period_buff
****************************************************************************/
spwm_status_en spwm_get_period_buff(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_get_line_sel_buff
****************************************************************************/
spwm_status_en spwm_get_line_sel_buff(spwm_instance_en id, uint8_t group_id, uint32_t *val);
 
/*******************************************************************************
* Function Name: spwm_set_clkdiv
****************************************************************************/
spwm_status_en spwm_set_clkdiv(spwm_instance_en id, uint8_t group_id, uint8_t clkdiv_id);
 
/*******************************************************************************
* Function Name: spwm_set_mode
****************************************************************************/
spwm_status_en spwm_set_mode(spwm_instance_en id, uint8_t group_id,
                             spwm_mode_en mode);
 
/*******************************************************************************
* Function Name: spwm_set_count_mode
****************************************************************************/
spwm_status_en spwm_set_count_mode(spwm_instance_en id, uint8_t group_id,
                                   spwm_count_mode_en count_mode);
 
/*******************************************************************************
* Function Name: spwm_set_counter
****************************************************************************/
spwm_status_en spwm_set_counter(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_one_shot
****************************************************************************/
spwm_status_en spwm_set_one_shot(spwm_instance_en id, uint8_t group_id, bool one_shot);
 
/*******************************************************************************
* Function Name: spwm_set_prescale
****************************************************************************/
spwm_status_en spwm_set_prescale(spwm_instance_en id, uint8_t group_id,
                                 spwm_prescale_en prescale);
 
/*******************************************************************************
* Function Name: spwm_set_deadtime
****************************************************************************/
spwm_status_en spwm_set_deadtime(spwm_instance_en id, uint8_t group_id,
                                uint32_t deadtime, uint32_t compl_deadtime);
 
/*******************************************************************************
* Function Name: spwm_set_cc0
****************************************************************************/
spwm_status_en spwm_set_cc0(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_cc1
****************************************************************************/
spwm_status_en spwm_set_cc1(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_period
****************************************************************************/
spwm_status_en spwm_set_period(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_line_sel
****************************************************************************/
spwm_status_en spwm_set_line_sel(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_cc0_buff
****************************************************************************/
spwm_status_en spwm_set_cc0_buff(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_cc1_buff
****************************************************************************/
spwm_status_en spwm_set_cc1_buff(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_period_buff
****************************************************************************/
spwm_status_en spwm_set_period_buff(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_line_sel_buff
****************************************************************************/
spwm_status_en spwm_set_line_sel_buff(spwm_instance_en id, uint8_t group_id, uint32_t val);
 
/*******************************************************************************
* Function Name: spwm_set_trig_in_all
****************************************************************************/
spwm_status_en spwm_set_trig_in_all(spwm_instance_en id,
                                    uint8_t group_id,
                                    const spwm_trigger_in_cfg_t *cfg);
 
/*******************************************************************************
* Function Name: spwm_set_trig_in
****************************************************************************/
spwm_status_en spwm_set_trig_in(spwm_instance_en id, uint8_t group_id,
                                  spwm_trigger_en trigger, const spwm_trigger_in_cfg_t *config);
 
/*******************************************************************************
* Function Name: spwm_set_trig_out
****************************************************************************/
spwm_status_en spwm_set_trig_out(spwm_instance_en id, uint8_t group_id,
                                    int out_id, spwm_trigger_out_en out);
 
/*******************************************************************************
* Function Name: spwm_set_sema
****************************************************************************/
spwm_status_en spwm_set_sema(spwm_instance_en id, uint8_t group_id,
                             uint8_t sema_id, uint8_t val);
 
/*******************************************************************************
* Function Name: spwm_set_sema_sel
****************************************************************************/
spwm_status_en spwm_set_sema_sel(spwm_instance_en id, uint8_t group_id,
                                   int sema_id, spwm_trigger_out_en out);
 
/*******************************************************************************
* Function Name: spwm_make_line_sel
****************************************************************************/
uint32_t spwm_make_line_sel(spwm_line_src_en out, spwm_line_src_en compl);
 
/*******************************************************************************
* Function Name: spwm_get_interrupt_status
****************************************************************************/
spwm_status_en spwm_get_interrupt_status(spwm_instance_en id, uint8_t group_id,
                                         uint32_t *irq_status);
 
/*******************************************************************************
* Function Name: spwm_enable_interrupt
****************************************************************************/
spwm_status_en spwm_enable_interrupt(spwm_instance_en id, uint8_t group_id,
                                        spwm_intr_en intr);
 
/*******************************************************************************
* Function Name: spwm_disable_interrupt
****************************************************************************/
spwm_status_en spwm_disable_interrupt(spwm_instance_en id, uint8_t group_id,
                                        spwm_intr_en intr);
 
/*******************************************************************************
* Function Name: spwm_disable_all_interrupts
****************************************************************************/
spwm_status_en spwm_disable_all_interrupts(spwm_instance_en id, uint8_t group_id);
 
/*******************************************************************************
* Function Name: spwm_clear_all_interrupts
****************************************************************************/
spwm_status_en spwm_clear_all_interrupts(spwm_instance_en id, uint8_t group_id);
 
/*******************************************************************************
* Function Name: spwm_output_select
****************************************************************************/
spwm_status_en spwm_output_select(spwm_instance_en id, uint8_t group_id,
                                    spwm_io_pin_en pin, bool compl);
 
/*******************************************************************************
* Function Name: spwm_clear_interrupt
****************************************************************************/
spwm_status_en spwm_clear_interrupt(spwm_instance_en id, uint8_t group_id,
                                        uint32_t mask);
 
/*******************************************************************************
* Function Name: spwm_clear_desc_interrupt
****************************************************************************/
spwm_status_en spwm_clear_desc_interrupt(spwm_instance_en id, uint8_t desc_id);
 
/*******************************************************************************
* Function Name: spwm_enable_desc_interrupt
****************************************************************************/
spwm_status_en spwm_enable_desc_interrupt(spwm_instance_en id, uint8_t desc_id);
 
/*******************************************************************************
* Function Name: spwm_disable_desc_interrupt
****************************************************************************/
spwm_status_en spwm_disable_desc_interrupt(spwm_instance_en id, uint8_t desc_id);
 
/*******************************************************************************
* Function Name: spwm_register_callback
****************************************************************************/
spwm_status_en spwm_register_callback(spwm_instance_en id, spwm_isr_cb_t cb, void *user_ctx);
 
/*******************************************************************************
* Function Name: spwm_register_desc_callback
****************************************************************************/
spwm_status_en spwm_register_desc_callback(spwm_instance_en id, spwm_desc_isr_cb_t cb,
                                           void *param);
 
/*******************************************************************************
* Function Name: spwm_dsc_mem_alloc
****************************************************************************/
spwm_dsc_status_en spwm_dsc_mem_alloc(size_t size_bytes, uint16_t *handle);
 
/*******************************************************************************
* Function Name: spwm_dsc_mem_free
****************************************************************************/
void spwm_dsc_mem_free(uint16_t handle);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_create
****************************************************************************/
spwm_dsc_chain_t *spwm_dsc_chain_create(void);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_destroy
****************************************************************************/
void spwm_dsc_chain_destroy(spwm_dsc_chain_t *chain);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_init_for_handle
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_init_for_handle(spwm_instance_en id, spwm_dsc_chain_t *chain,
                                                  uint16_t handle);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_init
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_init(spwm_instance_en id, spwm_dsc_chain_t *chain,
                                       uint32_t start_offset_bytes, uint32_t block_size_bytes);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_add_cfg
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_add_cfg(spwm_dsc_chain_t *chain, uint8_t group_id,
                                        spwm_dsc_reg_id_en reg_id, const uint32_t *values,
                                        uint32_t num_values, bool last);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_add_syn
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_add_syn(spwm_dsc_chain_t *chain, spwm_dsc_syn_op_en opcode,
                                          uint8_t group, uint32_t counter_mask, bool last);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_add_nxt
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_add_nxt(spwm_dsc_chain_t *chain, uint32_t target_offset_bytes);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_start
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_start(spwm_instance_en id, const spwm_dsc_chain_t *chain,
                                        uint8_t desc_id, bool enable_interrupt);
 
/*******************************************************************************
* Function Name: spwm_dsc_chain_get_status
****************************************************************************/
spwm_dsc_status_en spwm_dsc_chain_get_status(spwm_instance_en id, const spwm_dsc_chain_t *chain,
                                           uint8_t instance, spwm_dsc_chain_status_t *status);

 
#ifdef __cplusplus
}
#endif
 
#endif /* SPWM_H_ */