ra8_ssie.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_ssie_role_peripheral = 0U, 
  k_ra8_ssie_role_controller = 1U, 
} ra8_ssie_role_t;

typedef enum : uint8_t {
  k_ra8_ssie_format_i2s        = 0U, 
  k_ra8_ssie_format_left_just  = 1U, 
  k_ra8_ssie_format_right_just = 2U, 
  k_ra8_ssie_format_monaural   = 3U, 
  k_ra8_ssie_format_tdm_4      = 4U, 
  k_ra8_ssie_format_tdm_6      = 5U, 
  k_ra8_ssie_format_tdm_8      = 6U, 
  k_ra8_ssie_format_tdm = 4U,
} ra8_ssie_format_t;

typedef enum : uint8_t {
  k_ra8_ssie_dwl_8  = 0U, 
  k_ra8_ssie_dwl_16 = 1U, 
  k_ra8_ssie_dwl_18 = 2U, 
  k_ra8_ssie_dwl_20 = 3U, 
  k_ra8_ssie_dwl_22 = 4U, 
  k_ra8_ssie_dwl_24 = 5U, 
  k_ra8_ssie_dwl_32 = 6U, 
} ra8_ssie_data_word_t;

typedef enum : uint8_t {
  k_ra8_ssie_swl_8   = 0U, 
  k_ra8_ssie_swl_16  = 1U, 
  k_ra8_ssie_swl_24  = 2U, 
  k_ra8_ssie_swl_32  = 3U, 
  k_ra8_ssie_swl_48  = 4U, 
  k_ra8_ssie_swl_64  = 5U, 
  k_ra8_ssie_swl_128 = 6U, 
  k_ra8_ssie_swl_256 = 7U, 
} ra8_ssie_system_word_t;

typedef enum : uint8_t {
  k_ra8_ssie_bclk_div_1   = 0x0U, 
  k_ra8_ssie_bclk_div_2   = 0x1U, 
  k_ra8_ssie_bclk_div_4   = 0x2U, 
  k_ra8_ssie_bclk_div_8   = 0x3U, 
  k_ra8_ssie_bclk_div_16  = 0x4U, 
  k_ra8_ssie_bclk_div_32  = 0x5U, 
  k_ra8_ssie_bclk_div_64  = 0x6U, 
  k_ra8_ssie_bclk_div_128 = 0x7U, 
  k_ra8_ssie_bclk_div_6   = 0x8U, 
  k_ra8_ssie_bclk_div_12  = 0x9U, 
  k_ra8_ssie_bclk_div_24  = 0xAU, 
  k_ra8_ssie_bclk_div_48  = 0xBU, 
  k_ra8_ssie_bclk_div_96  = 0xCU, 
} ra8_ssie_bclk_div_t;

typedef enum : uint8_t {
  k_ra8_ssie_dir_rx    = 1U, 
  k_ra8_ssie_dir_tx    = 2U, 
  k_ra8_ssie_dir_tx_rx = 3U, 
} ra8_ssie_dir_t;

typedef enum : uint8_t {
  k_ra8_ssie_evt_none     = 0x00U, 
  k_ra8_ssie_evt_idle     = 0x01U, 
  k_ra8_ssie_evt_tx_empty = 0x02U, 
  k_ra8_ssie_evt_rx_full  = 0x04U, 
  k_ra8_ssie_evt_tx_under = 0x08U, 
  k_ra8_ssie_evt_tx_over  = 0x10U, 
  k_ra8_ssie_evt_rx_under = 0x20U, 
  k_ra8_ssie_evt_rx_over  = 0x40U, 
  k_ra8_ssie_evt_error    = 0x78U, 
} ra8_ssie_event_t;

typedef struct {
  ra8_ssie_role_t        role;          
  ra8_ssie_format_t      format;        
  ra8_ssie_data_word_t   data_word;     
  ra8_ssie_system_word_t system_word;   
  ra8_ssie_bclk_div_t    bclk_div;      
  bool                   use_gpt_clk;   
  bool                   long_frame;    
  bool                   bckp_rising;   
  bool                   lrckp_low;     
  bool                   spdp_high;     
  bool                   byte_swap;     
  bool                   lr_continue;   
  bool                   bck_idle_stop; 
  bool                   enable_aucke;  
  uint8_t                tx_threshold;  
  uint8_t                rx_threshold;  
} ra8_ssie_cfg_t;

typedef struct {
  uint32_t ssisr;    
  uint32_t ssifsr;   
  uint8_t  rx_count; 
  uint8_t  tx_count; 
  bool     rx_full;  
  bool     tx_empty; 
  bool     idle;     
  bool     error;    
  uint8_t  events;   
} ra8_ssie_status_t;

typedef struct {
  uint8_t   tx_dma_channel; 
  uint8_t   rx_dma_channel; 
  uint32_t* tx_buffer;      
  uint32_t* rx_buffer;      
  uint16_t  tx_samples;     
  uint16_t  rx_samples;     
} ra8_ssie_dma_cfg_t;

typedef void (*ra8_ssie_event_fn_t)(void* ctx, uint8_t channel, uint8_t events, uint32_t ssisr);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_init(uint8_t channel, const ra8_ssie_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_ssie_deinit(uint8_t channel);
 
/* =============================================================================
 * Run control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_start(uint8_t channel, ra8_ssie_dir_t dir);

[[nodiscard]] ra8_err_t ra8_ssie_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ssie_start_recovery(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ssie_mute(uint8_t channel, bool enable);

[[nodiscard]] ra8_err_t
ra8_ssie_set_thresholds(uint8_t channel, uint8_t tx_threshold, uint8_t rx_threshold);

[[nodiscard]] ra8_err_t
ra8_ssie_set_fifo_threshold(uint8_t channel, uint8_t tx_threshold, uint8_t rx_threshold);

[[nodiscard]] ra8_err_t
ra8_ssie_attach_dma_pair(uint8_t channel, uint8_t tx_dma_channel, uint8_t rx_dma_channel);

[[nodiscard]] ra8_err_t
ra8_ssie_send_iso(uint8_t channel, const uint32_t* buffer, uint16_t samples);

[[nodiscard]] ra8_err_t
ra8_ssie_recv_iso(uint8_t channel, uint32_t* buffer, uint16_t max_samples, uint16_t* out_got);
 
/* =============================================================================
 * Data path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_write_sample(uint8_t channel, uint32_t sample);

[[nodiscard]] ra8_err_t ra8_ssie_read_sample(uint8_t channel, uint32_t* out);

[[nodiscard]] ra8_err_t ra8_ssie_write_buffer(uint8_t         channel,
                                              const uint32_t* buffer,
                                              uint16_t        samples,
                                              uint16_t*       out_written);

[[nodiscard]] ra8_err_t
ra8_ssie_read_buffer(uint8_t channel, uint32_t* buffer, uint16_t samples, uint16_t* out_read);
 
/* =============================================================================
 * DMA
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_attach_dma(uint8_t channel, const ra8_ssie_dma_cfg_t* dma);

[[nodiscard]] ra8_err_t ra8_ssie_detach_dma(uint8_t channel);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_get_status(uint8_t channel, ra8_ssie_status_t* out);

[[nodiscard]] ra8_err_t ra8_ssie_clear_status(uint8_t channel, uint32_t mask);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_attach_handler(ra8_ssie_event_fn_t fn, void* ctx);

void ra8_ssie_dispatch(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ssie_set_irq_enable(uint8_t channel, uint32_t mask, bool enable);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ssie_enter_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ssie_exit_stop(uint8_t channel);
 
#ifdef __cplusplus
}
#endif