i2s.h

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_I2S_H
#define OVE_I2S_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/storage.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ── Enums ───────────────────────────────────────────────────────── */
 
typedef enum {
    OVE_I2S_DIR_TX   = 0x01, 
    OVE_I2S_DIR_RX   = 0x02, 
    OVE_I2S_DIR_TXRX = 0x03, 
} ove_i2s_dir_t;
 
/* ── Callback ────────────────────────────────────────────────────── */
 
typedef void (*ove_i2s_cb_t)(ove_i2s_t i2s, void *user_data);
 
/* ── Configuration ───────────────────────────────────────────────── */
 
struct ove_i2s_cfg {
    unsigned int  instance;         
    uint32_t      sample_rate;      
    uint8_t       bit_depth;        
    uint8_t       channels;         
    ove_i2s_dir_t direction;        
    size_t        dma_buf_samples;  
};
 
#ifdef CONFIG_OVE_I2S
 
/* ── Lifecycle ───────────────────────────────────────────────────── */
 
int  ove_i2s_init(ove_i2s_t *i2s, ove_i2s_storage_t *storage,
          void *tx_dma_buf, void *rx_dma_buf,
          const struct ove_i2s_cfg *cfg);
void ove_i2s_deinit(ove_i2s_t i2s);
 
#ifdef OVE_HEAP_I2S
int  ove_i2s_create(ove_i2s_t *i2s, const struct ove_i2s_cfg *cfg);
void ove_i2s_destroy(ove_i2s_t i2s);
#elif !defined(__ZIG_CIMPORT__)
#define ove_i2s_create(pi2s, cfg) \
    ({ static ove_i2s_storage_t _ove_stor_; \
       static uint8_t _ove_txbuf_[((cfg)->dma_buf_samples) * ((cfg)->bit_depth / 8)] \
           __attribute__((aligned(32))); \
       static uint8_t _ove_rxbuf_[((cfg)->dma_buf_samples) * ((cfg)->bit_depth / 8)] \
           __attribute__((aligned(32))); \
       ove_i2s_init((pi2s), &_ove_stor_, \
            ((cfg)->direction & OVE_I2S_DIR_TX) ? _ove_txbuf_ : (void *)0, \
            ((cfg)->direction & OVE_I2S_DIR_RX) ? _ove_rxbuf_ : (void *)0, \
            (cfg)); })
#define ove_i2s_destroy(i2s) ove_i2s_deinit(i2s)
#endif
 
/* ── Callbacks ───────────────────────────────────────────────────── */
 
int  ove_i2s_set_rx_callback(ove_i2s_t i2s, ove_i2s_cb_t cb,
                 void *user_data);
 
int  ove_i2s_set_tx_callback(ove_i2s_t i2s, ove_i2s_cb_t cb,
                 void *user_data);
 
/* ── Stream control ──────────────────────────────────────────────── */
 
int  ove_i2s_start(ove_i2s_t i2s);
 
int  ove_i2s_stop(ove_i2s_t i2s);
 
int  ove_i2s_pause(ove_i2s_t i2s);
 
int  ove_i2s_resume(ove_i2s_t i2s);
 
/* ── Buffer access ───────────────────────────────────────────────── */
 
void *ove_i2s_rx_buf(ove_i2s_t i2s);
 
void *ove_i2s_tx_buf(ove_i2s_t i2s);
 
size_t ove_i2s_half_buf_size(ove_i2s_t i2s);
 
/* ── ISR helpers (called by backend, not by application) ─────────── */
 
void ove_i2s_rx_half_cplt_isr(ove_i2s_t i2s);
void ove_i2s_rx_cplt_isr(ove_i2s_t i2s);
void ove_i2s_tx_half_cplt_isr(ove_i2s_t i2s);
void ove_i2s_tx_cplt_isr(ove_i2s_t i2s);
 
#else /* !CONFIG_OVE_I2S */
 
static inline int  ove_i2s_create(ove_i2s_t *i, const struct ove_i2s_cfg *c) { (void)i; (void)c; return OVE_ERR_NOT_SUPPORTED; }
static inline void ove_i2s_destroy(ove_i2s_t i) { (void)i; }
static inline int  ove_i2s_set_rx_callback(ove_i2s_t i, ove_i2s_cb_t cb, void *ud) { (void)i; (void)cb; (void)ud; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2s_set_tx_callback(ove_i2s_t i, ove_i2s_cb_t cb, void *ud) { (void)i; (void)cb; (void)ud; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2s_start(ove_i2s_t i) { (void)i; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2s_stop(ove_i2s_t i) { (void)i; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2s_pause(ove_i2s_t i) { (void)i; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2s_resume(ove_i2s_t i) { (void)i; return OVE_ERR_NOT_SUPPORTED; }
static inline void *ove_i2s_rx_buf(ove_i2s_t i) { (void)i; return (void *)0; }
static inline void *ove_i2s_tx_buf(ove_i2s_t i) { (void)i; return (void *)0; }
static inline size_t ove_i2s_half_buf_size(ove_i2s_t i) { (void)i; return 0; }
 
#endif /* CONFIG_OVE_I2S */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_I2S_H */