hal_sio.h

浏览该文件的文档.

 
#ifndef HAL_SIO_H
#define HAL_SIO_H
 
#include <stdint.h>
#include <stdbool.h>
#include "common_def.h"
#include "errcode.h"
#include "sio_porting.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
typedef enum hal_sio_driver_mode {
    SLAVE,                                      
    MASTER                                      
} hal_sio_driver_mode_t;
 
typedef enum hal_sio_mode {
    I2S_MODE = 0,                                   
    PCM_MODE,                                       
    NONE_SIO_MODE
} hal_sio_mode_t;
 
typedef enum hal_sio_interrupt {
    RX_INTR = 0,                                
    TX_INTR,                                    
    RX_RIGHT_FIFO_OVER,                         
    RX_LEFT_FIFO_OVER,                          
    TX_RIGHT_FIFO_UNDER,                        
    TX_LEFT_FIFO_UNDER                          
} hal_sio_interrupt_t;
 
typedef enum hal_sio_iming_mode {
    PCM_STD_MODE = 0,                           
    PCM_UD_MODE,                                
    NONE_TIMING_MODE
} hal_sio_timing_mode_t;
 
typedef enum {
    STD_MODE = 0,                               
    MULTICHANNEL_MODE                           
} hal_sio_transfer_mode_t;
 
typedef enum hal_sio_clk_edge {
    FALLING_EDGE = 0,                           
    RISING_EDGE,                                
    NONE_EDGE
} hal_sio_clk_edge_t;
 
typedef enum hal_sio_voice_channel {
    SIO_LEFT = 0,                               
    SIO_RIGHT,                                  
    NONE_MODE
} hal_sio_voice_channel_t;
 
typedef enum hal_sio_data_width {
    RESERVED,                                   
    SIXTEEN_BIT,                                
    EIGHTEEN_BIT,                               
    TWENTY_BIT,                                 
    TWENTY_FOUR_BIT,                            
    THIRTY_TWO_BIT                              
} hal_sio_data_width_t;
 
typedef enum hal_sio_channel_number {
    TWO_CH,                                     
    FOUR_CH,                                    
    EIGHT_CH,                                   
    SIXTEEN_CH                                  
} hal_sio_channel_number_t;
 
typedef struct hal_sio_tx_data {
    uint32_t *left_buff;                        
    uint32_t *right_buff;                       
    uint32_t length;                            
} hal_sio_tx_data_t;
 
typedef struct hal_sio_received_data {
    uint32_t left_buff[CONFIG_DATA_LEN_MAX];    
    uint32_t right_buff[CONFIG_DATA_LEN_MAX];   
    uint32_t length;                            
} hal_sio_rx_data_t;
 
typedef struct hal_sio_config {
    hal_sio_driver_mode_t drive_mode;           
    hal_sio_transfer_mode_t transfer_mode;      
    hal_sio_data_width_t data_width;            
    hal_sio_channel_number_t channels_num;      
    hal_sio_timing_mode_t timing;               
    hal_sio_clk_edge_t clk_edge;                
    uint8_t div_number;                         
    uint8_t number_of_channels;                 
} hal_sio_config_t;
 
#if defined(CONFIG_I2S_SUPPORT_DMA)
 
typedef struct hal_i2s_dma_attr {
    bool tx_dma_enable;                     
    uint8_t tx_int_threshold;               
    bool rx_dma_enable;                     
    uint8_t rx_int_threshold;               
} hal_i2s_dma_attr_t;
 
typedef void (*hal_sio_dma_cfg_t)(sio_bus_t bus, const uintptr_t attr);
#endif
 
typedef void (*hal_sio_callback_t)(uint32_t *left_buff, uint32_t *right_buff, uint32_t length);
 
typedef errcode_t (*hal_sio_init_t)(sio_bus_t bus);
 
typedef void (*hal_sio_deinit_t)(sio_bus_t bus);
 
typedef void (*hal_sio_set_config_t)(sio_bus_t bus, const hal_sio_config_t *config);
 
typedef errcode_t (*hal_sio_get_config_t)(sio_bus_t bus, hal_sio_config_t *config);
 
typedef void (*hal_sio_rx_enable_t)(sio_bus_t bus, bool en);
 
typedef void (*hal_sio_write_t)(sio_bus_t bus, hal_sio_tx_data_t *data, hal_sio_mode_t mode);
 
typedef void (*hal_sio_get_data_t)(sio_bus_t bus, hal_sio_rx_data_t *data);
 
typedef void (*hal_sio_register_t)(sio_bus_t bus, hal_sio_callback_t callback);
 
typedef void (*hal_sio_unregister_t)(sio_bus_t bus);
 
typedef void (*hal_sio_loop_t)(sio_bus_t bus, bool en);
 
typedef void (*hal_sio_loop_trans_t)(sio_bus_t bus, hal_sio_tx_data_t *data, hal_sio_mode_t mode);
 
typedef struct hal_sio_funcs {
    hal_sio_init_t              init;                       
    hal_sio_deinit_t            deinit;                     
    hal_sio_set_config_t        set_config;                 
    hal_sio_get_config_t        get_config;                 
    hal_sio_rx_enable_t         rx_enable;                       
    hal_sio_write_t             write;                      
    hal_sio_get_data_t          get_data;                   
    hal_sio_register_t          registerfunc;               
    hal_sio_unregister_t        unregisterfunc;             
    hal_sio_loop_t              loop;                       
    hal_sio_loop_trans_t        loop_trans;                 
#if defined(CONFIG_I2S_SUPPORT_DMA)
    hal_sio_dma_cfg_t           dma_cfg;                    
#endif
} hal_sio_funcs_t;
 
errcode_t hal_sio_regs_init(sio_bus_t bus);
 
void hal_sio_regs_deinit(sio_bus_t bus);
 
errcode_t hal_sio_register_funcs(sio_bus_t bus, hal_sio_funcs_t *funcs);
 
errcode_t hal_sio_unregister_funcs(sio_bus_t bus);
 
hal_sio_funcs_t *hal_sio_get_funcs(sio_bus_t bus);
 
#if defined(CONFIG_I2S_SUPPORT_DMA)
void hal_sio_set_crg_clock_enable(sio_bus_t bus, bool enable);
 
void hal_sio_set_tx_enable(sio_bus_t bus, uint32_t val);
 
void hal_sio_set_rx_enable(sio_bus_t bus, uint32_t val);
#endif
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif