xt_hal_i2s.h

浏览该文件的文档.

 
#ifndef __XT_HAL_I2S_H__
#define __XT_HAL_I2S_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_HAL_I2S_INVALID_ID           (0xFF)
 
#define XT_HAL_I2S_PROTOCOL_S           (0)
#define XT_HAL_I2S_PROTOCOL_W           (2)
#define XT_HAL_I2S_DATA_BITS_S          (2)
#define XT_HAL_I2S_DATA_BITS_W          (2)
#define XT_HAL_I2S_CHANNELS_S           (4)
#define XT_HAL_I2S_CHANNELS_W           (1)
#define XT_HAL_I2S_MCLK_S               (5)
#define XT_HAL_I2S_MCLK_W               (3)
 
/* I2S 协议格式 */
#define XT_HAL_I2S_PROTOCOL_I2S         ((0) << XT_HAL_I2S_PROTOCOL_S)     
#define XT_HAL_I2S_PROTOCOL_MSB_JUST    ((1) << XT_HAL_I2S_PROTOCOL_S)     
#define XT_HAL_I2S_PROTOCOL_LSB_JUST    ((2) << XT_HAL_I2S_PROTOCOL_S)     
#define XT_HAL_I2S_PROTOCOL_PCM         ((3) << XT_HAL_I2S_PROTOCOL_S)     
 
/* I2S 数据位宽 */
#define XT_HAL_I2S_DATA_BITS_8          ((0) << XT_HAL_I2S_DATA_BITS_S)    
#define XT_HAL_I2S_DATA_BITS_16         ((1) << XT_HAL_I2S_DATA_BITS_S)    
#define XT_HAL_I2S_DATA_BITS_24         ((2) << XT_HAL_I2S_DATA_BITS_S)    
#define XT_HAL_I2S_DATA_BITS_32         ((3) << XT_HAL_I2S_DATA_BITS_S)    
 
/* I2S 通道数 */
#define XT_HAL_I2S_CHANNELS_MONO        ((0) << XT_HAL_I2S_CHANNELS_S)      
#define XT_HAL_I2S_CHANNELS_STEREO      ((1) << XT_HAL_I2S_CHANNELS_S)      
 
/* I2S MCLK 与采样率之间的倍数 */
#define XT_HAL_I2S_MCLK_64FS            ((0) << XT_HAL_I2S_MCLK_S)        
#define XT_HAL_I2S_MCLK_128FS           ((1) << XT_HAL_I2S_MCLK_S)        
#define XT_HAL_I2S_MCLK_256FS           ((2) << XT_HAL_I2S_MCLK_S)        
#define XT_HAL_I2S_MCLK_384FS           ((3) << XT_HAL_I2S_MCLK_S)        
#define XT_HAL_I2S_MCLK_512FS           ((4) << XT_HAL_I2S_MCLK_S)        
 
/* ==================== [Typedefs] ========================================== */
 
/* I2S 事件类型 */
enum xt_hal_i2s_event_id {
    XT_HAL_I2S_EVENT_DONE = 0x00,   
    XT_HAL_I2S_EVENT_BATCH_DONE,    
    XT_HAL_I2S_EVENT_ERROR,         
};
 
typedef void (*xt_hal_i2s_cb_t)(uint8_t i2s_id, uint32_t event_id);

struct xt_hal_i2s_result {
    void *tx_buffer;
    void *rx_buffer;
    size_t size;
};
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_i2sm_setup(
    uint8_t i2s_id, uint32_t mode, uint32_t sample_rate_hz,
    uint8_t mck_pin, uint8_t sck_pin, uint8_t ws_pin,
    uint8_t sd_tx_pin, uint8_t sd_rx_pin);

xt_err_t xt_hal_i2sm_close(uint8_t i2s_id);

xt_err_t xt_hal_i2s_set_cb(uint8_t i2s_id, xt_hal_i2s_cb_t cb);

xt_err_t xt_hal_i2sm_set_rx_buf(uint8_t i2s_id, void *buffer, size_t size);

xt_err_t xt_hal_i2sm_set_tx_buf(uint8_t i2s_id, void *buffer, size_t size);

int32_t xt_hal_i2sm_tx(uint8_t i2s_id, const void *tx_buffer, size_t size);

int32_t xt_hal_i2sm_rx(uint8_t i2s_id, void *rx_buffer, size_t size);

int32_t xt_hal_i2sm_txrx(uint8_t i2s_id,
                         const void *tx_buffer,
                         void *rx_buffer,
                         size_t size);

int32_t xt_hal_i2sm_get_rx_count(uint8_t i2s_id);

int32_t xt_hal_i2sm_get_tx_free(uint8_t i2s_id);

int32_t xt_hal_i2sm_tx_0copy(uint8_t i2s_id, const void *tx_buffer, size_t size);

int32_t xt_hal_i2sm_rx_0copy(uint8_t i2s_id, void *rx_buffer, size_t size);

int32_t xt_hal_i2sm_txrx_0copy(uint8_t i2s_id,
                               const void *tx_buffer,
                               void *rx_buffer,
                               size_t size);

xt_err_t xt_hal_i2sm_tx_continuous(uint8_t i2s_id, const void *tx_buffer, size_t size);

xt_err_t xt_hal_i2sm_rx_continuous(uint8_t i2s_id, void *rx_buffer, size_t size);

xt_err_t xt_hal_i2sm_txrx_continuous(uint8_t i2s_id,
                                     const void *tx_buffer,
                                     void *rx_buffer,
                                     size_t size);

xt_err_t xt_hal_i2sm_stop_continuous(uint8_t i2s_id);

xt_err_t xt_hal_i2sm_get_result(
    uint8_t i2s_id, struct xt_hal_i2s_result *result);

int32_t xt_hal_i2sm_tx_block(uint8_t i2s_id, const void *tx_buffer, size_t size);

int32_t xt_hal_i2sm_rx_block(uint8_t i2s_id, void *rx_buffer, size_t size);

int32_t xt_hal_i2sm_txrx_block(uint8_t i2s_id,
                               const void *tx_buffer,
                               void *rx_buffer,
                               size_t size);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_i2s */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_I2S_H__ */