i2s.h

// Copyright 2021 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.
#ifndef _i2s_h_
#define _i2s_h_
#include <xs1.h>
#include <stdint.h>
#include <stddef.h>
#include <xcore/port.h>
#include <xcore/clock.h>
#include <xcore/parallel.h>
 
#define I2S_MAX_DATALINES 8
#define I2S_CHANS_PER_FRAME 2
 
typedef enum i2s_mode {
    I2S_MODE_I2S,            
    I2S_MODE_LEFT_JUSTIFIED, 
} i2s_mode_t;
 
typedef enum i2s_slave_bclk_polarity {
    I2S_SLAVE_SAMPLE_ON_BCLK_RISING,   
    I2S_SLAVE_SAMPLE_ON_BCLK_FALLING,  
} i2s_slave_bclk_polarity_t;
 
typedef struct i2s_config {
  unsigned mclk_bclk_ratio;                       
  i2s_mode_t mode;                                
  i2s_slave_bclk_polarity_t slave_bclk_polarity;  
} i2s_config_t;
 
typedef enum i2s_restart {
  I2S_NO_RESTART = 0,      
  I2S_RESTART,             
  I2S_SHUTDOWN             
} i2s_restart_t;
 
typedef void (*i2s_init_t)(void *app_data, i2s_config_t *i2s_config);
 
typedef i2s_restart_t (*i2s_restart_check_t)(void *app_data);
 
typedef void (*i2s_receive_t)(void *app_data, size_t num_in, const int32_t *samples);
 
typedef void (*i2s_send_t)(void *app_data, size_t num_out, int32_t *samples);
 
#define I2S_CALLBACK_ATTR __attribute__((fptrgroup("i2s_callback")))
 
typedef struct {
    I2S_CALLBACK_ATTR i2s_init_t init;
 
    I2S_CALLBACK_ATTR i2s_restart_check_t restart_check;
 
    I2S_CALLBACK_ATTR i2s_receive_t receive;
 
    I2S_CALLBACK_ATTR i2s_send_t send;
 
    void *app_data;
} i2s_callback_group_t;
 // END: addtogroup hil_i2s_core
 
DECLARE_JOB(i2s_master, (const i2s_callback_group_t *, const port_t *, const size_t, const port_t *, const size_t, const port_t, const port_t, const port_t, const xclock_t));
DECLARE_JOB(i2s_master_external_clock, (const i2s_callback_group_t *, const port_t *, const size_t, const port_t *, const size_t, const port_t, const port_t, const xclock_t));
DECLARE_JOB(i2s_slave, (const i2s_callback_group_t *, port_t *, const size_t, port_t *, const size_t, port_t, port_t, xclock_t));
 
void i2s_master(
        const i2s_callback_group_t *const i2s_cbg,
        const port_t p_dout[],
        const size_t num_out,
        const port_t p_din[],
        const size_t num_in,
        const port_t p_bclk,
        const port_t p_lrclk,
        const port_t p_mclk,
        const xclock_t bclk);
 
void i2s_master_external_clock(
        const i2s_callback_group_t *const i2s_cbg,
        const port_t p_dout[],
        const size_t num_out,
        const port_t p_din[],
        const size_t num_in,
        const port_t p_bclk,
        const port_t p_lrclk,
        const xclock_t bclk);
 // END: addtogroup hil_i2s_master
 
void i2s_slave(
        const i2s_callback_group_t *const i2s_cbg,
        port_t p_dout[],
        const size_t num_out,
        port_t p_din[],
        const size_t num_in,
        port_t p_bclk,
        port_t p_lrclk,
        xclock_t bclk);
 // END: addtogroup hil_i2s_slave
 
#endif // _i2s_h_