tdm.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef TDM_H_
#define TDM_H_
 
#include <stdint.h>
#include <stdbool.h>
 
struct tdm_platform_ops;
 
enum tdm_mode {
    TDM_MASTER_TX,
    TDM_MASTER_RX,
    TDM_SLAVE_TX,
    TDM_SLAVE_RX
};
 
struct tdm_init_param {
    enum tdm_mode mode;
    uint8_t data_size;
    uint8_t data_offset;
    bool data_lsb_first;
    uint8_t slots_per_frame;
    bool fs_active_low;
    uint8_t fs_active_length;
    bool fs_lastbit;
    bool rising_edge_sampling;
    const struct tdm_platform_ops *platform_ops;
    void *extra;
};
 
struct tdm_desc {
    const struct tdm_platform_ops *platform_ops;
    void *extra;
};
 
struct tdm_platform_ops {
    int32_t (*tdm_ops_init)(struct tdm_desc **, const struct tdm_init_param *);
    int32_t (*tdm_ops_read)(struct tdm_desc *, void *, uint16_t);
    int32_t (*tdm_ops_write)(struct tdm_desc *, void *, uint16_t);
    int32_t (*tdm_ops_remove)(struct tdm_desc *);
};
 
/* Initialize the TDM communication peripheral. */
int32_t tdm_init(struct tdm_desc **desc,
         const struct tdm_init_param *param);
 
/* Free the resources allocated by tdm_init(). */
int32_t tdm_remove(struct tdm_desc *desc);
 
/* Read data. */
int32_t tdm_read(struct tdm_desc *desc,
         void *data,
         uint16_t bytes_number);
 
/* Write data. */
int32_t tdm_write(struct tdm_desc *desc,
          void *data,
          uint16_t bytes_number);
 
#endif // TDM_H_