dmic.h

 
#ifndef DMIC_H
#define DMIC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "syna_device.h"
#include "pdm_registers.h"
#include "clk.h"
#include "timer.h"
#if CONFIG_MODULE_DMA_ENABLED
#include "dma.h"
#endif
 
/*******************************************************************************
*                               Macro definitions
*******************************************************************************/

 
/***************************************************************************/

typedef enum {
    DMIC_EVENT_NONE = 0x00,           
    DMIC_EVENT_OVERFLOW,              
    DMIC_EVENT_FULL,                  
    DMIC_EVENT_UNDERFLOW,             
    DMIC_EVENT_ALMOST_FULL,           
    DMIC_EVENT_MUTE_ENABLED,          
    DMIC_EVENT_INVALID_CONFIG,        
    DMIC_EVENT_READ_COMPLETE,         
    DMIC_EVENT_READ_NOT_READY,        
    DMIC_EVENT_READ_PARTIAL_COMPLETE, 
    DMIC_EVENT_ERROR                  
} dmic_event_en;
 
/*******************************************************************************
 *                              Enumerations
 *******************************************************************************/
typedef enum {
    DMIC_OK                     = 0,   
    DMIC_ERROR                  = 1,   
    DMIC_ERROR_TIMEOUT          = 2,   
    DMIC_ERROR_DATA_STUCK       = 3,   
    DMIC_ERROR_OVERFLOW         = 4,   
    DMIC_ERROR_INVALID_GAIN     = 5,   
    DMIC_ERROR_INVALID_BOOST    = 6,   
    DMIC_ERROR_INVALID_CLK_DIV  = 7,   
    DMIC_ERROR_INVALID_PHASE    = 8,   
    DMIC_ERROR_MUTE_STATE       = 9,   
    DMIC_ERROR_NOT_CLEARED      = 10,  
    DMIC_ERROR_INVALID_CONTEXT  = 11,  
    DMIC_ERROR_INVALID_PARAM    = 12,  
    DMIC_ERROR_DMA_FAILED       = 13,  
    DMIC_ERROR_UNKNOWN          = 14,  
    DMIC_ERROR_NOT_SUPPORTED    = 15,  
    DMIC_ERROR_INVALID_CONFIG   = 16   
} dmic_status_en;

typedef enum {
    DMIC_DECIMATE_BY_64 = 64,  
    DMIC_DECIMATE_BY_32 = 32,  
    DMIC_DECIMATE_BY_16 = 16   
} dmic_decimation_ratio_en;

typedef enum {
    DMIC_PHASE_POS_EDGE_ALIGN_NEG = 0x0,  
    DMIC_PHASE_NEG_EDGE_ALIGN_POS = 0x1,  
} dmic_in_phase_en;

typedef enum {
    DMIC_GAIN_NEG_3DB   = 0x0,  
    DMIC_GAIN_NEG_2_5DB = 0x1,  
    DMIC_GAIN_NEG_2DB   = 0x2,  
    DMIC_GAIN_NEG_1_5DB = 0x3,  
    DMIC_GAIN_NEG_1DB   = 0x4,  
    DMIC_GAIN_NEG_0_5DB = 0x5,  
    DMIC_GAIN_0DB       = 0x6,  
    DMIC_GAIN_POS_0_5DB = 0x7,  
    DMIC_GAIN_POS_1DB   = 0x8,  
    DMIC_GAIN_POS_1_5DB = 0x9,  
    DMIC_GAIN_POS_2DB   = 0xA,  
    DMIC_GAIN_POS_2_5DB = 0xB,  
    DMIC_GAIN_POS_3DB   = 0xC   
} dmic_gain_ctrl_en;

typedef enum {
    DMIC_BOOST_0DB  = 0x0,  
    DMIC_BOOST_6DB  = 0x1,  
    DMIC_BOOST_12DB = 0x2,  
    DMIC_BOOST_18DB = 0x3,  
    DMIC_BOOST_24DB = 0x4   
} dmic_boost_en;

typedef enum {
    DMIC_INT_AFULL = 0x1,  
    DMIC_INT_FULL  = 0x2,  
    DMIC_INT_OVER  = 0x4   
} dmic_int_en;

typedef uint32_t dmic_cutoff_freq_t;

typedef enum {
    DMIC_TRANSFER_MODE_NONE = 0x0, 
    DMIC_TRANSFER_MODE_FIFO = 0x1, 
    DMIC_TRANSFER_MODE_DMA  = 0x2  
} dmic_transfer_mode_en;

typedef enum {
    DMIC_BUFFER_MODE_NONE          = 0x0, 
    DMIC_BUFFER_MODE_PER_CHANNEL   = 0x1, 
    DMIC_BUFFER_MODE_INTERLEAVED   = 0x2  
} dmic_buffer_mode_en;

typedef enum {
    DMIC_SAMPLE_16BIT = 2, 
    DMIC_SAMPLE_24BIT = 3, 
    DMIC_SAMPLE_32BIT = 4  
} dmic_sample_size_en;
 

 
/*******************************************************************************
 *                             Type Definitions
 *******************************************************************************/
typedef struct dmic_io_config_s {
    uint32_t        fs_Hz;              
    uint32_t        pdm_clk_Hz;         
    bool            polarity_reversal;  
    bool            channel_swap;       
    dmic_in_phase_en input_phase;        
} dmic_io_config_t;

typedef struct dmic_channel_config_s {
    dmic_cutoff_freq_t hpf_cutoff_freq; 
    bool               enable;           
    bool               enable_low_power; 
    bool               enable_ll_filter; 
    bool               enable_hpf;       
    bool               enable_iir;       
} dmic_channel_config_t;

typedef struct dmic_fifo_config_s {
    bool               enable;                 
    uint16_t           threshold;              
    bool               int_almost_full_enable; 
    bool               int_full_enable;        
    bool               int_overflow_enable;    
} dmic_fifo_config_t;

typedef struct dmic_dma_config_s {
    /* Linux-style runtime layout */
    void               *buffer;       
    uint32_t           buffer_bytes;  
    uint32_t           period_bytes;  
    uint32_t           frame_bytes;   
} dmic_dma_config_t;

typedef struct dmic_data_path_config_s {
    uint8_t              channel;        
    dmic_transfer_mode_en transfer_mode; 
    union {
        dmic_dma_config_t  dma;           
        dmic_fifo_config_t fifo;          
    } cfg;
} dmic_data_path_config_t;

typedef struct dmic_buffer_context_s {
    uint8_t  channel;        
    uint8_t *buffer;         
    uint32_t buffer_size;    
    uint32_t offset_bytes;   
    uint32_t available_bytes;
} dmic_buffer_context_t;

typedef struct dmic_capability_s {
    uint8_t          num_channels;   
    uint32_t         transfer_modes; 
    uint32_t         buffer_modes;   
    bool             has_fifo;       
    bool             has_dma;        
    bool             has_hwvad;      
    bool             has_gain;       
    bool             has_boost;      
    bool             has_iir;        
    uint32_t         clk_id;         
    uint32_t         max_clk_hz;     
} dmic_capability_t;
 

typedef void (*dmic_event_cb_t)(
    dmic_instance_en instance,
    uint8_t channel,
    dmic_event_en event,
    uint32_t offset,
    uint32_t size,
    void *user_data);

 
/*******************************************************************************
 *                             Function Prototypes
 *******************************************************************************/
 
/*******************************************************************************
*                           Function Name: dmic_init
****************************************************************************/
INIT_CODE dmic_status_en dmic_init(dmic_instance_en instance);
 
/*******************************************************************************
*                     Function Name: dmic_get_capability
****************************************************************************/
dmic_status_en dmic_get_capability(dmic_instance_en instance, dmic_capability_t *capability);
 
/*******************************************************************************
*                    Function Name: dmic_config_channel
****************************************************************************/
dmic_status_en dmic_config_channel(dmic_instance_en instance, uint8_t channel,
    const dmic_channel_config_t* cfg);
 
/*******************************************************************************
*                        Function Name: dmic_configure_io
****************************************************************************/
dmic_status_en dmic_configure_io(dmic_instance_en instance, 
    const dmic_io_config_t* dmic_config);
 
/*******************************************************************************
*                     Function Name: dmic_enable_interrupts
****************************************************************************/
dmic_status_en dmic_enable_interrupts(dmic_instance_en instance, uint32_t mask /* bitmask of dmic_int_en */);
 
/*******************************************************************************
*                             Function Name: dmic_reset
****************************************************************************/
dmic_status_en dmic_reset(dmic_instance_en instance);
 
/*******************************************************************************
*                           Function Name: dmic_enable
****************************************************************************/
dmic_status_en dmic_enable(dmic_instance_en instance);
 
/*******************************************************************************
*                           Function Name: dmic_disable
****************************************************************************/
dmic_status_en dmic_disable(dmic_instance_en instance);
 
/*******************************************************************************
*                         Function Name: dmic_isr
****************************************************************************/
dmic_status_en dmic_isr(dmic_instance_en instance);
 
/*******************************************************************************
*                         Function Name: dmic_start
****************************************************************************/
dmic_status_en dmic_start(dmic_instance_en instance);
 
/*******************************************************************************
*                        Function Name: dmic_stop
****************************************************************************/
dmic_status_en dmic_stop(dmic_instance_en instance);
 
/*******************************************************************************
*                           Function Name: dmic_read
****************************************************************************/
dmic_status_en dmic_read(dmic_instance_en instance, dmic_buffer_context_t *buf,
                        int32_t timeout);
 
/*******************************************************************************
*                      Function Name: dmic_read_nonblocking
****************************************************************************/
dmic_status_en dmic_read_nonblocking(dmic_instance_en instance,
                                    dmic_buffer_context_t *buf);
 
/*******************************************************************************
*                     Function Name: dmic_set_channel_volume
****************************************************************************/
dmic_status_en dmic_set_channel_volume(dmic_instance_en instance, 
    uint8_t channel, float volume_db);
 
/*******************************************************************************
*                  Function Name: dmic_set_channel_gain
****************************************************************************/
dmic_status_en dmic_set_channel_gain(dmic_instance_en instance, 
    dmic_channel_en channel, dmic_gain_ctrl_en gain_ctrl);
 
/*******************************************************************************
*                     Function Name: dmic_set_channel_boost
****************************************************************************/
dmic_status_en dmic_set_channel_boost(dmic_instance_en instance, 
    dmic_channel_en channel, dmic_boost_en boost_level);
 
/*******************************************************************************
*                   Function Name: dmic_register_callback
****************************************************************************/
dmic_status_en dmic_register_callback(dmic_instance_en instance, 
    dmic_event_cb_t event_cb, void* user_data);
 
 
/*******************************************************************************
*                    Function Name: dmic_config_data_path
****************************************************************************/
dmic_status_en dmic_config_data_path(dmic_instance_en instance,
    const dmic_data_path_config_t *cfg);

 
#ifdef __cplusplus
}
#endif
 
#endif     /* DMIC_H */