cfn_hal_i2s.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_I2S_H
#define CAFFEINE_HAL_HAL_I2S_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"
 
/* Defines ----------------------------------------------------------*/
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_I2S_EVENT_NONE        = 0,
    CFN_HAL_I2S_EVENT_TX_COMPLETE = CFN_HAL_BIT(0), 
    CFN_HAL_I2S_EVENT_RX_READY    = CFN_HAL_BIT(1), 
} cfn_hal_i2s_event_t;
 
typedef enum
{
    CFN_HAL_I2S_ERROR_NONE    = 0,
    CFN_HAL_I2S_ERROR_OVERRUN = CFN_HAL_BIT(0), 
    CFN_HAL_I2S_ERROR_SYNC    = CFN_HAL_BIT(1), 
    CFN_HAL_I2S_ERROR_GENERAL = CFN_HAL_BIT(2), 
} cfn_hal_i2s_error_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_I2S_CONFIG_MODE_MASTER_TX,
    CFN_HAL_I2S_CONFIG_MODE_MASTER_RX,
    CFN_HAL_I2S_CONFIG_MODE_SLAVE_TX,
    CFN_HAL_I2S_CONFIG_MODE_SLAVE_RX,
 
    CFN_HAL_I2S_CONFIG_MODE_MAX
} cfn_hal_i2s_config_mode_t;
 
typedef enum
{
    CFN_HAL_I2S_CONFIG_STANDARD_PHILIPS,
    CFN_HAL_I2S_CONFIG_STANDARD_MSB,
    CFN_HAL_I2S_CONFIG_STANDARD_LSB,
    CFN_HAL_I2S_CONFIG_STANDARD_PCM_SHORT,
    CFN_HAL_I2S_CONFIG_STANDARD_PCM_LONG,
 
    CFN_HAL_I2S_CONFIG_STANDARD_MAX
} cfn_hal_i2s_config_standard_t;
 
typedef enum
{
    CFN_HAL_I2S_CONFIG_DATAFORMAT_16B,
    CFN_HAL_I2S_CONFIG_DATAFORMAT_16B_EXTENDED,
    CFN_HAL_I2S_CONFIG_DATAFORMAT_24B,
    CFN_HAL_I2S_CONFIG_DATAFORMAT_32B,
 
    CFN_HAL_I2S_CONFIG_DATAFORMAT_MAX
} cfn_hal_i2s_config_dataformat_t;
 
typedef struct
{
    uint32_t                        sample_rate; 
    cfn_hal_i2s_config_mode_t       mode;        
    cfn_hal_i2s_config_standard_t   standard;    
    cfn_hal_i2s_config_dataformat_t data_format; 
    void                           *custom;      
} cfn_hal_i2s_config_t;
 
typedef struct
{
    void                      *instance; 
    cfn_hal_gpio_pin_handle_t *ck;       
    cfn_hal_gpio_pin_handle_t *ws;       
    cfn_hal_gpio_pin_handle_t *sd;       
    cfn_hal_gpio_pin_handle_t *ext_sd;   
    cfn_hal_gpio_pin_handle_t *mck;      
    void                      *user_arg; 
} cfn_hal_i2s_phy_t;
 
typedef struct cfn_hal_i2s_s     cfn_hal_i2s_t;
typedef struct cfn_hal_i2s_api_s cfn_hal_i2s_api_t;
 
typedef void (*cfn_hal_i2s_callback_t)(cfn_hal_i2s_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg);
 
struct cfn_hal_i2s_api_s
{
    cfn_hal_api_base_t base;
 
    /* I2S Specific Extensions */
    cfn_hal_error_code_t (*transmit_dma)(cfn_hal_i2s_t *driver, const uint16_t *data, size_t size);
    cfn_hal_error_code_t (*receive_dma)(cfn_hal_i2s_t *driver, uint16_t *data, size_t size);
    cfn_hal_error_code_t (*pause)(cfn_hal_i2s_t *driver);
    cfn_hal_error_code_t (*resume)(cfn_hal_i2s_t *driver);
    cfn_hal_error_code_t (*stop)(cfn_hal_i2s_t *driver);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_i2s_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(i2s, cfn_hal_i2s_config_t, cfn_hal_i2s_api_t, cfn_hal_i2s_phy_t, cfn_hal_i2s_callback_t);
 
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_i2s_populate(cfn_hal_i2s_t              *driver,
                                         uint32_t                    peripheral_id,
                                         struct cfn_hal_clock_s     *clock,
                                         void                       *dependency,
                                         const cfn_hal_i2s_api_t    *api,
                                         const cfn_hal_i2s_phy_t    *phy,
                                         const cfn_hal_i2s_config_t *config,
                                         cfn_hal_i2s_callback_t      callback,
                                         void                       *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_I2S, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_config_validate(const cfn_hal_i2s_t        *driver,
                                                                const cfn_hal_i2s_config_t *config)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    if ((config->mode >= CFN_HAL_I2S_CONFIG_MODE_MAX) || (config->standard >= CFN_HAL_I2S_CONFIG_STANDARD_MAX) ||
        (config->data_format >= CFN_HAL_I2S_CONFIG_DATAFORMAT_MAX))
    {
        return CFN_HAL_ERROR_BAD_CONFIG;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_init(cfn_hal_i2s_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    driver->base.vmt           = (const struct cfn_hal_api_base_s *) driver->api;
    cfn_hal_error_code_t error = cfn_hal_i2s_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_deinit(cfn_hal_i2s_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_config_set(cfn_hal_i2s_t *driver, const cfn_hal_i2s_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_i2s_config_validate(driver, config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    {
        driver->config = config;
    }
    return cfn_hal_base_config_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_config_get(cfn_hal_i2s_t *driver, cfn_hal_i2s_config_t *config)
{
    if (!driver || !config || !driver->config)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    *config = *(driver->config);
    return CFN_HAL_ERROR_OK;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_callback_register(cfn_hal_i2s_t               *driver,
                                                                  const cfn_hal_i2s_callback_t callback,
                                                                  void                        *user_arg)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    {
        driver->cb          = callback;
        driver->cb_user_arg = user_arg;
    }
    return cfn_hal_base_callback_register(
        &driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_power_state_set(cfn_hal_i2s_t *driver, cfn_hal_power_state_t state)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_power_state_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_event_enable(cfn_hal_i2s_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_event_disable(cfn_hal_i2s_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_event_get(cfn_hal_i2s_t *driver, uint32_t *event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_error_enable(cfn_hal_i2s_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_error_disable(cfn_hal_i2s_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_error_get(cfn_hal_i2s_t *driver, uint32_t *error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_I2S, error_mask);
}
 
/* I2S Specific Functions ------------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_transmit_dma(cfn_hal_i2s_t *driver, const uint16_t *data, size_t size)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_I2S, transmit_dma, driver, error, data, size);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_receive_dma(cfn_hal_i2s_t *driver, uint16_t *data, size_t size)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_I2S, receive_dma, driver, error, data, size);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_pause(cfn_hal_i2s_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_I2S, pause, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_resume(cfn_hal_i2s_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_I2S, resume, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_i2s_stop(cfn_hal_i2s_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_I2S, stop, driver, error);
    return error;
}
 
cfn_hal_error_code_t cfn_hal_i2s_construct(cfn_hal_i2s_t              *driver,
                                           const cfn_hal_i2s_config_t *config,
                                           const cfn_hal_i2s_phy_t    *phy,
                                           struct cfn_hal_clock_s     *clock,
                                           void                       *dependency,
                                           cfn_hal_i2s_callback_t      callback,
                                           void                       *user_arg);
cfn_hal_error_code_t cfn_hal_i2s_destruct(cfn_hal_i2s_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_I2S_H