rtos_i2s.h

// Copyright 2020-2021 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
#ifndef RTOS_I2S_H_
#define RTOS_I2S_H_
 
#include <xcore/clock.h>
#include <xcore/port.h>
#include "i2s.h"
 
#include "rtos_osal.h"
#include "rtos_driver_rpc.h"
 
#define RTOS_I2S_APP_SEND_FILTER_CALLBACK_ATTR __attribute__((fptrgroup("rtos_i2s_send_filter_cb_fptr_grp")))
 
#define RTOS_I2S_APP_RECEIVE_FILTER_CALLBACK_ATTR __attribute__((fptrgroup("rtos_i2s_receive_filter_cb_fptr_grp")))
 
typedef struct rtos_i2s_struct rtos_i2s_t;
 
typedef size_t (*rtos_i2s_send_filter_cb_t)(rtos_i2s_t *ctx, void *app_data, int32_t *i2s_frame, size_t i2s_frame_size, int32_t *send_buf, size_t samples_available);
 
typedef size_t (*rtos_i2s_receive_filter_cb_t)(rtos_i2s_t *ctx, void *app_data, int32_t *i2s_frame, size_t i2s_frame_size, int32_t *receive_buf, size_t sample_spaces_free);
 
struct rtos_i2s_struct{
    rtos_driver_rpc_t *rpc_config;
 
    __attribute__((fptrgroup("rtos_i2s_rx_fptr_grp")))
    size_t (*rx)(rtos_i2s_t *, int32_t *, size_t, unsigned);
 
    __attribute__((fptrgroup("rtos_i2s_tx_fptr_grp")))
    size_t (*tx)(rtos_i2s_t *, int32_t *, size_t, unsigned);
 
    unsigned mclk_bclk_ratio;
    i2s_mode_t mode;
    port_t p_dout[I2S_MAX_DATALINES];
    size_t num_out;
    port_t p_din[I2S_MAX_DATALINES];
    size_t num_in;
    port_t p_bclk;
    port_t p_lrclk;
    port_t p_mclk;
    xclock_t bclk;
 
    void *send_filter_app_data;
    RTOS_I2S_APP_SEND_FILTER_CALLBACK_ATTR rtos_i2s_send_filter_cb_t send_filter_cb;
 
    void *receive_filter_app_data;
    RTOS_I2S_APP_RECEIVE_FILTER_CALLBACK_ATTR rtos_i2s_receive_filter_cb_t receive_filter_cb;
 
    rtos_osal_mutex_t mutex;
    streaming_channel_t c_i2s_isr;
 
    rtos_osal_thread_t hil_thread;
    rtos_osal_semaphore_t send_sem;
    rtos_osal_semaphore_t recv_sem;
    int send_blocked;
    int recv_blocked;
    struct {
        int32_t *buf;
        size_t buf_size;
        size_t write_index;
        size_t read_index;
        volatile size_t total_written;
        volatile size_t total_read;
        volatile size_t required_free_count;
    } send_buffer;
    struct {
        int32_t *buf;
        size_t buf_size;
        size_t write_index;
        size_t read_index;
        volatile size_t total_written;
        volatile size_t total_read;
        volatile size_t required_available_count;
    } recv_buffer;
    uint8_t isr_cmd;
};
 
#include "rtos_i2s_rpc.h"
 
inline int rtos_i2s_mclk_bclk_ratio(
        const unsigned audio_clock_frequency,
        const unsigned sample_rate)
{
    return audio_clock_frequency / (sample_rate * (8 * sizeof(int32_t)) * I2S_CHANS_PER_FRAME);
}
 
inline void rtos_i2s_send_filter_cb_set(
        rtos_i2s_t *ctx,
        rtos_i2s_send_filter_cb_t send_filter_cb,
        void *send_filter_app_data)
{
    ctx->send_filter_app_data = send_filter_app_data;
    ctx->send_filter_cb = send_filter_cb;
}
 
inline void rtos_i2s_receive_filter_cb_set(
        rtos_i2s_t *ctx,
        rtos_i2s_receive_filter_cb_t receive_filter_cb,
        void *receive_filter_app_data)
{
    ctx->receive_filter_app_data = receive_filter_app_data;
    ctx->receive_filter_cb = receive_filter_cb;
}
 
void rtos_i2s_start(
        rtos_i2s_t *i2s_ctx,
        unsigned mclk_bclk_ratio,
        i2s_mode_t mode,
        size_t recv_buffer_size,
        size_t send_buffer_size,
        unsigned interrupt_core_id);
 
inline size_t rtos_i2s_rx(
        rtos_i2s_t *ctx,
        int32_t *i2s_sample_buf,
        size_t frame_count,
        unsigned timeout)
{
    return ctx->rx(ctx, i2s_sample_buf, frame_count, timeout);
}
 
inline size_t rtos_i2s_tx(
        rtos_i2s_t *ctx,
        int32_t *i2s_sample_buf,
        size_t frame_count,
        unsigned timeout)
{
    return ctx->tx(ctx, i2s_sample_buf, frame_count, timeout);
}
 
void rtos_i2s_master_init(
        rtos_i2s_t *i2s_ctx,
        uint32_t io_core_mask,
        port_t p_dout[],
        size_t num_out,
        port_t p_din[],
        size_t num_in,
        port_t p_bclk,
        port_t p_lrclk,
        port_t p_mclk,
        xclock_t bclk);
 
void rtos_i2s_master_ext_clock_init(
        rtos_i2s_t *i2s_ctx,
        uint32_t io_core_mask,
        port_t p_dout[],
        size_t num_out,
        port_t p_din[],
        size_t num_in,
        port_t p_bclk,
        port_t p_lrclk,
        xclock_t bclk);
 
void rtos_i2s_slave_init(
        rtos_i2s_t *i2s_ctx,
        uint32_t io_core_mask,
        port_t p_dout[],
        size_t num_out,
        port_t p_din[],
        size_t num_in,
        port_t p_bclk,
        port_t p_lrclk,
        xclock_t bclk);
 
#endif /* RTOS_I2S_H_ */