i2s.h

 
#ifndef I2S_DRIVER_H_
#define I2S_DRIVER_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "syna_device.h"
#include "i2s_registers.h"
#include "cache.h"
#include "logger.h" /* To Remove Once SEC1 Vaidation is completed */
#include "clk.h"
 
/*******************************************************************************
*                               Macro definitions
*******************************************************************************/
#define I2S_DMA_CHANNEL_INVALID   (0xFFFFFFFFU)
 
#ifndef I2S_TX_POOL_MAX_BLOCKS
#define I2S_TX_POOL_MAX_BLOCKS 4U
#endif
 
#ifndef I2S_TX_POOL_BLOCK_BYTES
#define I2S_TX_POOL_BLOCK_BYTES 8000U
#endif
 
/***************************************************************************/
 
/*******************************************************************************
*                               Enumerated Types
*******************************************************************************/

typedef enum {
    I2S_OK = 0,                     
    I2S_ERROR,                      
    I2S_ERROR_INVALID_PARAM,        
    I2S_ERROR_NOT_READY,            
    I2S_ERROR_BUSY,                 
    I2S_ERROR_TIMEOUT,              
    I2S_ERROR_NO_MEMORY,            
    I2S_ERROR_INVALID_STATE,        
    I2S_ERROR_UNDERRUN,             
    I2S_ERROR_OVERRUN,              
    I2S_ERROR_NOT_SUPPORTED,        
    I2S_ERROR_HW_FAULT              
} i2s_status_en;

typedef enum {
    I2S_FMT_STANDARD_I2S            = 0,  
    I2S_FMT_LEFT_JUSTIFIED          = 1,  
    I2S_FMT_RIGHT_JUSTIFIED         = 2,  
    I2S_FMT_TDM                     = 3   
} i2s_data_format_en;

typedef enum {
    I2S_FMT_CAP_STANDARD_I2S        = (1 << 0), 
    I2S_FMT_CAP_LEFT_JUSTIFIED      = (1 << 1), 
    I2S_FMT_CAP_RIGHT_JUSTIFIED     = (1 << 2), 
    I2S_FMT_CAP_TDM                 = (1 << 3)  
} i2s_data_format_caps_en;

typedef enum {
    I2S_MODE_MASTER                 = 0,  
    I2S_MODE_SLAVE                  = 1   
} i2s_clock_mode_en;

typedef enum {
    I2S_DIR_TX                      = 0,  
    I2S_DIR_RX                      = 1,  
} i2s_direction_en;

typedef enum {
    I2S_STATE_NOT_READY             = 0,  
    I2S_STATE_READY                 = 1,  
    I2S_STATE_RUNNING               = 2,  
    I2S_STATE_STOPPING              = 3,  
    I2S_STATE_ERROR                 = 4   
} i2s_state_en;

typedef enum {
    I2S_TRIGGER_START               = 0,  
    I2S_TRIGGER_STOP                = 1,  
    I2S_TRIGGER_PREPARE             = 2,  
    I2S_TRIGGER_PAUSE               = 3,  
    I2S_TRIGGER_RESUME              = 4   
} i2s_trigger_cmd_en;

typedef enum {
    I2S_EVENT_TX_COMPLETE           = (1 << 0),  
    I2S_EVENT_RX_COMPLETE           = (1 << 1),  
    I2S_EVENT_TX_UNDERRUN           = (1 << 2),  
    I2S_EVENT_RX_OVERRUN            = (1 << 3),  
    I2S_EVENT_FRAME_ERROR           = (1 << 4),  
    I2S_EVENT_ERROR                 = (1 << 5)   
} i2s_event_en;

typedef enum {
    I2S_WORD_SIZE_8BIT              = 8,   
    I2S_WORD_SIZE_16BIT             = 16,  
    I2S_WORD_SIZE_24BIT             = 24,  
    I2S_WORD_SIZE_32BIT             = 32   
} i2s_word_size_en;

typedef enum {
    I2S_WORD_SIZE_CAP_8BIT          = (1 << 0),  
    I2S_WORD_SIZE_CAP_16BIT         = (1 << 1),  
    I2S_WORD_SIZE_CAP_24BIT         = (1 << 2),  
    I2S_WORD_SIZE_CAP_32BIT         = (1 << 3)   
} i2s_word_size_caps_en;

typedef enum {
    I2S_SAMPLE_RATE_8000 = 8000U,
    I2S_SAMPLE_RATE_11025 = 11025U,
    I2S_SAMPLE_RATE_12000 = 12000U,
    I2S_SAMPLE_RATE_16000 = 16000U,
    I2S_SAMPLE_RATE_22050 = 22050U,
    I2S_SAMPLE_RATE_24000 = 24000U,
    I2S_SAMPLE_RATE_32000 = 32000U,
    I2S_SAMPLE_RATE_44100 = 44100U,
    I2S_SAMPLE_RATE_48000 = 48000U,
    I2S_SAMPLE_RATE_64000 = 64000U,
    I2S_SAMPLE_RATE_88200 = 88200U,
    I2S_SAMPLE_RATE_96000 = 96000U,
    I2S_SAMPLE_RATE_176400 = 176400U,
    I2S_SAMPLE_RATE_192000 = 192000U,
    I2S_SAMPLE_RATE_384000 = 384000U
} i2s_sample_rate_en;

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


typedef struct {
    bool                bit_clk_gated;    
    bool                bit_clk_inv;      
    bool                frame_clk_inv;    
} i2s_clock_mode_t;
 

typedef struct {
    i2s_data_format_en  data_format;    
    i2s_clock_mode_en   clock_mode;     
    i2s_word_size_en    word_size;      
    uint8_t             channels;       
    uint32_t            sample_rate;    
    i2s_clock_mode_t    clock_config;   
    bool                mclk_present;   
    bool                mclk_required;  
    uint16_t            mclk_ratio;     
    size_t              block_size;     
    uint8_t             num_blocks;     
    bool                enable_dma;     
} i2s_config_t;

typedef struct {
    uint32_t                formats;          
    bool                    master_mode;      
    bool                    slave_mode;       
    uint8_t                 max_channels;     
    uint32_t                min_sample_rate;  
    uint32_t                max_sample_rate;  
    i2s_word_size_caps_en   word_sizes;       
} i2s_capabilities_t;

typedef struct
{
    i2s_status_en (*init)(void *backend);
    i2s_status_en (*submit)(void *backend, int channel, uint32_t addr, uint32_t size);
    i2s_status_en (*wait_complete)(void *backend, int channel, int timeout_ms);
    i2s_status_en (*clear)(void *backend, int channel);
    int (*get_channel)(void *backend, bool is_tx);
    int (*intr_status)(void *backend, int channel);
} i2s_mem_if_ops_t;

 
/*******************************************************************************
*                               Callback Types
*******************************************************************************/


typedef void (*i2s_event_cb_t)(i2s_instance_en instance, i2s_direction_en direction,\
                                i2s_event_en event,  void *user_data);

typedef void (*i2s_buffer_cb_t)(i2s_instance_en instance, i2s_direction_en direction,\
                                    void *buffer, size_t size, void *user_data);
 
/*******************************************************************************
 *                             Function Prototypes
 *******************************************************************************/

/*******************************************************************************
*                          Function Name: i2s_init
****************************************************************************/
INIT_CODE i2s_status_en i2s_init(i2s_instance_en instance);
 
/*******************************************************************************
*                          Function Name: i2s_get_fifo_depth
****************************************************************************/
i2s_status_en i2s_get_fifo_depth(i2s_instance_en instance, i2s_direction_en direction,\
                                            uint32_t *depth);
 
 
/*******************************************************************************
*                          Function Name: i2s_set_fifo_depth
****************************************************************************/
i2s_status_en i2s_set_fifo_depth(i2s_instance_en instance, i2s_direction_en direction,\
                                            uint32_t depth_words);
 
/*******************************************************************************
*                          Function Name: i2s_deinit
****************************************************************************/
i2s_status_en i2s_deinit(i2s_instance_en instance);
 
/*******************************************************************************
*                          Function Name: i2s_intr_enable
****************************************************************************/
i2s_status_en i2s_intr_enable(i2s_instance_en id, int enable);
 
/*******************************************************************************
*                          Function Name: i2s_get_config
****************************************************************************/
i2s_status_en i2s_get_config(i2s_instance_en instance, i2s_direction_en direction,
                             i2s_config_t *config);
 
/*******************************************************************************
*                          Function Name: i2s_get_capabilities
****************************************************************************/
i2s_status_en i2s_get_capabilities(i2s_instance_en instance, i2s_capabilities_t *caps);
 
/*******************************************************************************
*                          Function Name: i2s_trigger
****************************************************************************/
i2s_status_en i2s_trigger(i2s_instance_en instance, i2s_direction_en direction,
                            i2s_trigger_cmd_en cmd);
 
/*******************************************************************************
*                          Function Name: i2s_register_callback
****************************************************************************/
i2s_status_en i2s_register_callback(i2s_instance_en instance, i2s_event_cb_t callback,
                                    void *user_data);
 
/*******************************************************************************
*                          Function Name: i2s_register_buffer_callback
****************************************************************************/
i2s_status_en i2s_register_buffer_callback(i2s_instance_en instance, i2s_buffer_cb_t callback,
                                           void *user_data);
 
/*******************************************************************************
*                          Function Name: i2s_config
****************************************************************************/
i2s_status_en i2s_configure(i2s_instance_en id, i2s_direction_en direction,
                            const i2s_config_t *cfg);
 
/*******************************************************************************
*                          Function Name: i2s_write_async
****************************************************************************/
i2s_status_en i2s_write_async(i2s_instance_en instance, const void *buffer, size_t size);
 
/*******************************************************************************
*                          Function Name: i2s_read_async
****************************************************************************/
i2s_status_en i2s_read_async(i2s_instance_en instance, void *buffer, size_t size);
 
/*******************************************************************************
*                          Function Name: i2s_get_state
****************************************************************************/
i2s_state_en i2s_get_state(i2s_instance_en instance, i2s_direction_en direction);
 
/*******************************************************************************
*                          Function Name: i2s_flush
****************************************************************************/
i2s_status_en i2s_flush(i2s_instance_en instance, i2s_direction_en direction);
 
#if CONFIG_MODULE_DMA_ENABLED
/*******************************************************************************
*                          Function Name: i2s_set_dma_instance
****************************************************************************/
i2s_status_en i2s_set_dma_instance(i2s_instance_en id, dma_instance_en dma_instance);
 
#endif

 
#ifdef __cplusplus
}
#endif
 
#endif /* I2S_H_ */