i2s.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Piotr Mienkowski
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_I2S_H_
#define ZEPHYR_INCLUDE_DRIVERS_I2S_H_

 
#include <zephyr/types.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * The following #defines are used to configure the I2S controller.
 */

typedef uint8_t i2s_fmt_t;

#define I2S_FMT_DATA_FORMAT_SHIFT           0
#define I2S_FMT_DATA_FORMAT_MASK            (0x7 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_FORMAT_I2S             (0 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_FORMAT_PCM_SHORT       (1 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_FORMAT_PCM_LONG        (2 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_FORMAT_LEFT_JUSTIFIED  (3 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_FORMAT_RIGHT_JUSTIFIED (4 << I2S_FMT_DATA_FORMAT_SHIFT)

#define I2S_FMT_DATA_ORDER_MSB              (0 << 3)
#define I2S_FMT_DATA_ORDER_LSB              BIT(3)
#define I2S_FMT_DATA_ORDER_INV              I2S_FMT_DATA_ORDER_LSB

#define I2S_FMT_CLK_FORMAT_SHIFT           4
#define I2S_FMT_CLK_FORMAT_MASK            (0x3 << I2S_FMT_CLK_FORMAT_SHIFT)

#define I2S_FMT_BIT_CLK_INV                 BIT(4)
#define I2S_FMT_FRAME_CLK_INV               BIT(5)

#define I2S_FMT_CLK_NF_NB               (0 << I2S_FMT_CLK_FORMAT_SHIFT)
#define I2S_FMT_CLK_NF_IB               (1 << I2S_FMT_CLK_FORMAT_SHIFT)
#define I2S_FMT_CLK_IF_NB               (2 << I2S_FMT_CLK_FORMAT_SHIFT)
#define I2S_FMT_CLK_IF_IB               (3 << I2S_FMT_CLK_FORMAT_SHIFT)

typedef uint8_t i2s_opt_t;

#define I2S_OPT_BIT_CLK_CONT                (0 << 0)
#define I2S_OPT_BIT_CLK_GATED               BIT(0)
#define I2S_OPT_BIT_CLK_CONTROLLER          (0 << 1)
#define I2S_OPT_BIT_CLK_TARGET              BIT(1)
#define I2S_OPT_FRAME_CLK_CONTROLLER        (0 << 2)
#define I2S_OPT_FRAME_CLK_TARGET            BIT(2)

#define I2S_OPT_BIT_CLK_MASTER              I2S_OPT_BIT_CLK_CONTROLLER __DEPRECATED_MACRO
#define I2S_OPT_BIT_CLK_SLAVE               I2S_OPT_BIT_CLK_TARGET __DEPRECATED_MACRO
#define I2S_OPT_FRAME_CLK_MASTER            I2S_OPT_FRAME_CLK_CONTROLLER __DEPRECATED_MACRO
#define I2S_OPT_FRAME_CLK_SLAVE             I2S_OPT_FRAME_CLK_TARGET __DEPRECATED_MACRO

#define I2S_OPT_LOOPBACK                    BIT(7)

#define I2S_OPT_PINGPONG                    BIT(6)

enum i2s_dir {
        I2S_DIR_RX,
        I2S_DIR_TX,
        I2S_DIR_BOTH,
};

enum i2s_state {
        I2S_STATE_NOT_READY,
        I2S_STATE_READY,
        I2S_STATE_RUNNING,
        I2S_STATE_STOPPING,
        I2S_STATE_ERROR,
};

enum i2s_trigger_cmd {
        I2S_TRIGGER_START,
        I2S_TRIGGER_STOP,
        I2S_TRIGGER_DRAIN,
        I2S_TRIGGER_DROP,
        I2S_TRIGGER_PREPARE,
};

struct i2s_config {
        uint8_t word_size;
        uint8_t channels;
        i2s_fmt_t format;
        i2s_opt_t options;
        uint32_t frame_clk_freq;
        struct k_mem_slab *mem_slab;
        size_t block_size;
        int32_t timeout;
};

__subsystem struct i2s_driver_api {
        int (*configure)(const struct device *dev, enum i2s_dir dir,
                         const struct i2s_config *cfg);
        const struct i2s_config *(*config_get)(const struct device *dev,
                                  enum i2s_dir dir);
        int (*read)(const struct device *dev, void **mem_block, size_t *size);
        int (*write)(const struct device *dev, void *mem_block, size_t size);
        int (*trigger)(const struct device *dev, enum i2s_dir dir,
                       enum i2s_trigger_cmd cmd);
};

__syscall int i2s_configure(const struct device *dev, enum i2s_dir dir,
                            const struct i2s_config *cfg);
 
static inline int z_impl_i2s_configure(const struct device *dev,
                                       enum i2s_dir dir,
                                       const struct i2s_config *cfg)
{
        const struct i2s_driver_api *api =
                (const struct i2s_driver_api *)dev->api;
 
        return api->configure(dev, dir, cfg);
}

static inline const struct i2s_config *i2s_config_get(const struct device *dev,
                                                      enum i2s_dir dir)
{
        const struct i2s_driver_api *api =
                (const struct i2s_driver_api *)dev->api;
 
        return api->config_get(dev, dir);
}

static inline int i2s_read(const struct device *dev, void **mem_block,
                                 size_t *size)
{
        const struct i2s_driver_api *api =
                (const struct i2s_driver_api *)dev->api;
 
        return api->read(dev, mem_block, size);
}

__syscall int i2s_buf_read(const struct device *dev, void *buf, size_t *size);

static inline int i2s_write(const struct device *dev, void *mem_block,
                            size_t size)
{
        const struct i2s_driver_api *api =
                (const struct i2s_driver_api *)dev->api;
 
        return api->write(dev, mem_block, size);
}

__syscall int i2s_buf_write(const struct device *dev, void *buf, size_t size);

__syscall int i2s_trigger(const struct device *dev, enum i2s_dir dir,
                          enum i2s_trigger_cmd cmd);
 
static inline int z_impl_i2s_trigger(const struct device *dev,
                                     enum i2s_dir dir,
                                     enum i2s_trigger_cmd cmd)
{
        const struct i2s_driver_api *api =
                (const struct i2s_driver_api *)dev->api;
 
        return api->trigger(dev, dir, cmd);
}

 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/i2s.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_I2S_H_ */