no_os_tdm.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_TDM_H_
#define _NO_OS_TDM_H_
 
#include <stdint.h>
#include <stdbool.h>

struct no_os_tdm_platform_ops;
 
enum no_os_tdm_mode {
    NO_OS_TDM_MASTER_TX,
    NO_OS_TDM_MASTER_RX,
    NO_OS_TDM_SLAVE_TX,
    NO_OS_TDM_SLAVE_RX
};

struct no_os_tdm_init_param {
    enum no_os_tdm_mode mode;
    uint8_t data_size;
    uint8_t data_offset;
    bool data_lsb_first;
    uint8_t slots_per_frame;
    uint32_t active_slots;
    bool fs_active_low;
    uint8_t fs_active_length;
    bool fs_lastbit;
    bool rising_edge_sampling;
    /* IRQ ID */
    uint32_t irq_id;
    void (*rx_complete_callback)(void *rx_arg);
    void (*rx_half_complete_callback)(void *rx_arg);
    const struct no_os_tdm_platform_ops *platform_ops;
    void *extra;
};

struct no_os_tdm_desc {
    /* IRQ ID */
    uint32_t irq_id;
    const struct no_os_tdm_platform_ops *platform_ops;
    struct lf256fifo *rx_fifo;
    void *extra;
};

struct no_os_tdm_platform_ops {
    int32_t (*tdm_ops_init)(struct no_os_tdm_desc **,
                const struct no_os_tdm_init_param *);
    int32_t (*tdm_ops_read)(struct no_os_tdm_desc *, void *, uint16_t);
    int32_t (*tdm_ops_write)(struct no_os_tdm_desc *, void *, uint16_t);
    int32_t (*tdm_ops_pause)(struct no_os_tdm_desc *);
    int32_t (*tdm_ops_resume)(struct no_os_tdm_desc *);
    int32_t (*tdm_ops_stop)(struct no_os_tdm_desc *);
    int32_t (*tdm_ops_remove)(struct no_os_tdm_desc *);
};
 
/* Initialize the TDM communication peripheral. */
int32_t  no_os_tdm_init(struct no_os_tdm_desc **desc,
            const struct no_os_tdm_init_param *param);
 
/* Free the resources allocated by  no_os_tdm_init(). */
int32_t  no_os_tdm_remove(struct no_os_tdm_desc *desc);
 
/* Read data. */
int32_t  no_os_tdm_read(struct no_os_tdm_desc *desc,
            void *data,
            uint16_t bytes_number);
 
/* Write data. */
int32_t  no_os_tdm_write(struct no_os_tdm_desc *desc,
             void *data,
             uint16_t bytes_number);
 
/* Pause TDM DMA Transfer */
int32_t  no_os_tdm_pause(struct no_os_tdm_desc *desc);
 
/* Resume TDM DMA Transfer */
int32_t  no_os_tdm_resume(struct no_os_tdm_desc *desc);
 
/* Stop TDM DMA Transfer */
int32_t  no_os_tdm_stop(struct no_os_tdm_desc *desc);
 
#endif // _NO_OS_TDM_H_