vsf_template_i2s.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_TEMPLATE_I2S_H__
#define __VSF_TEMPLATE_I2S_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_template_hal_driver.h"
#include "hal/arch/vsf_arch.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
// multi-class support enabled by default for maximum availability.
#ifndef VSF_I2S_CFG_MULTI_CLASS
#   define VSF_I2S_CFG_MULTI_CLASS                  ENABLED
#endif
 
#if defined(VSF_HW_I2S_COUNT) && !defined(VSF_HW_I2S_MASK)
#   define VSF_HW_I2S_MASK                          VSF_HAL_COUNT_TO_MASK(VSF_HW_I2S_COUNT)
#endif
 
#if defined(VSF_HW_I2S_MASK) && !defined(VSF_HW_I2S_COUNT)
#   define VSF_HW_I2S_COUNT                         VSF_HAL_MASK_TO_COUNT(VSF_HW_I2S_MASK)
#endif
 
// application code can redefine it
#ifndef VSF_I2S_CFG_PREFIX
#   if VSF_I2S_CFG_MULTI_CLASS == ENABLED
#       define VSF_I2S_CFG_PREFIX                   vsf
#   elif defined(VSF_HW_I2S_COUNT) && (VSF_HW_I2S_COUNT != 0)
#       define VSF_I2S_CFG_PREFIX                   vsf_hw
#   else
#       define VSF_I2S_CFG_PREFIX                   vsf
#   endif
#endif
 
#ifndef VSF_I2S_CFG_FUNCTION_RENAME
#   define VSF_I2S_CFG_FUNCTION_RENAME              ENABLED
#endif
 
#ifndef VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE
#   define VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE        DISABLED
#endif
 
#ifndef VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK
#   define VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK    DISABLED
#endif
 
#ifndef VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS
#   define VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS      DISABLED
#endif
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
#    define VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG DISABLED
#endif
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
#    define VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
#endif
 
#ifndef VSF_I2S_CFG_INHERT_HAL_CAPABILITY
#   define VSF_I2S_CFG_INHERT_HAL_CAPABILITY       ENABLED
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define VSF_I2S_APIS(__prefix_name)                                                                                                                         \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            i2s, init,          VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)   \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            i2s, tx_init,       VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)   \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                 i2s, tx_fini,       VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            i2s, tx_start,      VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            i2s, rx_init,       VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)   \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                 i2s, rx_fini,       VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            i2s, rx_start,      VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,             i2s, enable,        VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,             i2s, disable,       VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_i2s_status_t,     i2s, status,        VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)                           \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_i2s_capability_t, i2s, capability,    VSF_MCONNECT(__prefix_name, _i2s_t) *i2s_ptr)
 
/*============================ TYPES =========================================*/
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
typedef enum vsf_i2s_mode_t {
    VSF_I2S_MODE_MASTER             = (0x01ul << 0),     // select master mode
    VSF_I2S_MODE_SLAVE              = (0x00ul << 0),     // select slave mode
 
    VSF_I2S_DATA_BITLEN_16          = (0x01ul << 1),
    VSF_I2S_DATA_BITLEN_24          = (0x02ul << 1),
    VSF_I2S_DATA_BITLEN_32          = (0x03ul << 1),
 
    VSF_I2S_FRAME_BITLEN_16         = (0x01ul << 3),
    VSF_I2S_FRAME_BITLEN_24         = (0x02ul << 3),
    VSF_I2S_FRAME_BITLEN_32         = (0x03ul << 3),
 
    VSF_I2S_STANDARD_PHILIPS        = (0x01ul << 5),
    VSF_I2S_STANDARD_MSB            = (0x02ul << 5),
    VSF_I2S_STANDARD_LSB            = (0x03ul << 5),
 
    VSF_I2S_LRCK_POL                = (0x01ul << 7),    // normally used to switch LR channel
    VSF_I2S_BCK_POL                 = (0x01ul << 8),    // bck level while idle
    VSF_I2S_MCLK_OUTPUT             = (0x01ul << 9),
} vsf_i2s_mode_t;
#endif
 
enum {
    VSF_I2S_MODE_COUNT              = 0,
    VSF_I2S_MODE_MASK               = VSF_I2S_MODE_MASTER   |
                                      VSF_I2S_MODE_SLAVE,
 
    VSF_I2S_DATA_BITLEN_COUNT       = 0,
    VSF_I2S_DATA_BITLEN_MASK        = VSF_I2S_DATA_BITLEN_16 |
                                      VSF_I2S_DATA_BITLEN_24 |
                                      VSF_I2S_DATA_BITLEN_32,
 
    VSF_I2S_FRAME_BITLEN_COUNT      = 0,
    VSF_I2S_FRAME_BITLEN_MASK       = VSF_I2S_FRAME_BITLEN_16 |
                                      VSF_I2S_FRAME_BITLEN_24 |
                                      VSF_I2S_FRAME_BITLEN_32,
 
    VSF_I2S_STANDARD_COUNT          = 0,
    VSF_I2S_STANDARD_MASK           = VSF_I2S_STANDARD_PHILIPS  |
                                      VSF_I2S_STANDARD_MSB      |
                                      VSF_I2S_STANDARD_LSB,
 
    VSF_I2S_MODE_ALL_BITS_MASK      = VSF_I2S_MODE_MASK         |
                                      VSF_I2S_DATA_BITLEN_MASK  |
                                      VSF_I2S_FRAME_BITLEN_MASK |
                                      VSF_I2S_STANDARD_MASK     |
                                      VSF_I2S_LRCK_POL          |
                                      VSF_I2S_BCK_POL           |
                                      VSF_I2S_MCLK_OUTPUT,
};
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
typedef enum vsf_i2s_irq_mask_t {
    VSF_I2S_IRQ_MASK_TX_TGL_BUFFER  = (0x1ul <<  0),
    VSF_I2S_IRQ_MASK_RX_TGL_BUFFER  = (0x1ul <<  1),
} vsf_i2s_irq_mask_t;
#endif
 
enum {
    VSF_I2S_IRQ_ALL_BITS_MASK       = VSF_I2S_IRQ_MASK_TX_TGL_BUFFER |
                                      VSF_I2S_IRQ_MASK_RX_TGL_BUFFER,
};
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
typedef struct vsf_i2s_status_t {
    union {
        inherit(vsf_peripheral_status_t)
        uint32_t value;
    };
} vsf_i2s_status_t;
#endif
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
typedef struct vsf_i2s_capability_t {
#if VSF_I2S_CFG_INHERT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
    struct {
        // sample rate converter
        bool is_src_supported;
        // double buffer
        bool is_dbuffer_supported;
    } i2s_capability;
} vsf_i2s_capability_t;
#endif
 
#if VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
typedef struct vsf_i2s_t vsf_i2s_t;
 
typedef void vsf_i2s_isr_handler_t(void *target_ptr,
                                   vsf_i2s_t *i2s_ptr,
                                   vsf_i2s_irq_mask_t irq_mask);
 
typedef struct vsf_i2s_isr_t {
    vsf_i2s_isr_handler_t *handler_fn;      
    void                  *target_ptr;      
    vsf_arch_prio_t        prio;            
} vsf_i2s_isr_t;
 
typedef struct vsf_i2s_cfg_t {
    vsf_i2s_mode_t mode;                    
    uint32_t data_sample_rate;              
    uint32_t hw_sample_rate;                
    uint8_t *buffer;                        
    uint16_t buffer_size;                   
    uint8_t channel_num;                    
    vsf_i2s_isr_t isr;                      
} vsf_i2s_cfg_t;
#endif
 
typedef struct vsf_i2s_op_t {
#undef __VSF_HAL_TEMPLATE_API
#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
 
    VSF_I2S_APIS(vsf)
} vsf_i2s_op_t;
 
#if VSF_I2S_CFG_MULTI_CLASS == ENABLED
struct vsf_i2s_t  {
    const vsf_i2s_op_t * op;
};
#endif
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_i2s_init(vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *i2s_cfg);
 
extern vsf_err_t vsf_i2s_tx_init(vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *i2s_cfg);
 
extern void vsf_i2s_tx_fini(vsf_i2s_t *i2s_ptr);
 
extern vsf_err_t vsf_i2s_tx_start(vsf_i2s_t *i2s_ptr);
 
extern vsf_err_t vsf_i2s_rx_init(vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *i2s_cfg);
 
extern void vsf_i2s_rx_fini(vsf_i2s_t *i2s_ptr);
 
extern vsf_err_t vsf_i2s_rx_start(vsf_i2s_t *i2s_ptr);
 
extern void vsf_i2s_fini(vsf_i2s_t *i2s_ptr);
 
extern fsm_rt_t vsf_i2s_enable(vsf_i2s_t *i2s_ptr);
 
extern fsm_rt_t vsf_i2s_disable(vsf_i2s_t *i2s_ptr);
 
extern vsf_i2s_status_t vsf_i2s_status(vsf_i2s_t *i2s_ptr);
 
extern vsf_i2s_capability_t vsf_i2s_capability(vsf_i2s_t *i2s_ptr);
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#if VSF_I2S_CFG_FUNCTION_RENAME == ENABLED
#   define __vsf_i2s_t                      VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_t)
#   define vsf_i2s_init(__i2s, ...)         VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_init)         ((__vsf_i2s_t *)(__i2s), ##__VA_ARGS__)
#   define vsf_i2s_enable(__i2s)            VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_enable)       ((__vsf_i2s_t *)(__i2s))
#   define vsf_i2s_disable(__i2s)           VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_disable)      ((__vsf_i2s_t *)(__i2s))
#   define vsf_i2s_status(__i2s)            VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_status)       ((__vsf_i2s_t *)(__i2s))
#   define vsf_i2s_capability(__i2s)        VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_capability)   ((__vsf_i2s_t *)(__i2s))
 
#   define vsf_i2s_tx_init(__i2s, ...)      VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_tx_init)      ((__vsf_i2s_t *)(__i2s), ##__VA_ARGS__)
#   define vsf_i2s_tx_fini(__i2s, ...)      VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_tx_fini)      ((__vsf_i2s_t *)(__i2s), ##__VA_ARGS__)
#   define vsf_i2s_tx_start(__i2s)          VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_tx_start)     ((__vsf_i2s_t *)(__i2s))
 
#   define vsf_i2s_rx_init(__i2s, ...)      VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_rx_init)      ((__vsf_i2s_t *)(__i2s), ##__VA_ARGS__)
#   define vsf_i2s_rx_fini(__i2s, ...)      VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_rx_fini)      ((__vsf_i2s_t *)(__i2s), ##__VA_ARGS__)
#   define vsf_i2s_rx_start(__i2s)          VSF_MCONNECT(VSF_I2S_CFG_PREFIX, _i2s_rx_start)     ((__vsf_i2s_t *)(__i2s))
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /*__VSF_TEMPLATE_I2S_H__*/