root/sound/soc/tegra/tegra30_i2s.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * tegra30_i2s.c - Tegra30 I2S driver
 *
 * Author: Stephen Warren <swarren@nvidia.com>
 * Copyright (c) 2010-2012, NVIDIA CORPORATION.  All rights reserved.
 *
 * Based on code copyright/by:
 *
 * Copyright (c) 2009-2010, NVIDIA Corporation.
 * Scott Peterson <speterson@nvidia.com>
 *
 * Copyright (C) 2010 Google, Inc.
 * Iliyan Malchev <malchev@google.com>
 */

#include <linux/clk.h>
#include <linux/device.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/regmap.h>
#include <linux/reset.h>
#include <linux/slab.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/dmaengine_pcm.h>

#include "tegra30_ahub.h"
#include "tegra30_i2s.h"

#define DRV_NAME "tegra30-i2s"

static int tegra30_i2s_runtime_suspend(struct device *dev)
{
        struct tegra30_i2s *i2s = dev_get_drvdata(dev);

        regcache_cache_only(i2s->regmap, true);

        clk_disable_unprepare(i2s->clk_i2s);

        return 0;
}

static int tegra30_i2s_runtime_resume(struct device *dev)
{
        struct tegra30_i2s *i2s = dev_get_drvdata(dev);
        int ret;

        ret = clk_prepare_enable(i2s->clk_i2s);
        if (ret) {
                dev_err(dev, "clk_enable failed: %d\n", ret);
                return ret;
        }

        regcache_cache_only(i2s->regmap, false);
        regcache_mark_dirty(i2s->regmap);

        ret = regcache_sync(i2s->regmap);
        if (ret)
                goto disable_clocks;

        return 0;

disable_clocks:
        clk_disable_unprepare(i2s->clk_i2s);

        return ret;
}

static int tegra30_i2s_set_fmt(struct snd_soc_dai *dai,
                                unsigned int fmt)
{
        struct tegra30_i2s *i2s = snd_soc_dai_get_drvdata(dai);
        unsigned int mask = 0, val = 0;

        switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
        case SND_SOC_DAIFMT_NB_NF:
                break;
        default:
                return -EINVAL;
        }

        mask |= TEGRA30_I2S_CTRL_MASTER_ENABLE;
        switch (fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
        case SND_SOC_DAIFMT_BP_FP:
                val |= TEGRA30_I2S_CTRL_MASTER_ENABLE;
                break;
        case SND_SOC_DAIFMT_BC_FC:
                break;
        default:
                return -EINVAL;
        }

        mask |= TEGRA30_I2S_CTRL_FRAME_FORMAT_MASK |
                TEGRA30_I2S_CTRL_LRCK_MASK;
        switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
        case SND_SOC_DAIFMT_DSP_A:
                val |= TEGRA30_I2S_CTRL_FRAME_FORMAT_FSYNC;
                val |= TEGRA30_I2S_CTRL_LRCK_L_LOW;
                break;
        case SND_SOC_DAIFMT_DSP_B:
                val |= TEGRA30_I2S_CTRL_FRAME_FORMAT_FSYNC;
                val |= TEGRA30_I2S_CTRL_LRCK_R_LOW;
                break;
        case SND_SOC_DAIFMT_I2S:
                val |= TEGRA30_I2S_CTRL_FRAME_FORMAT_LRCK;
                val |= TEGRA30_I2S_CTRL_LRCK_L_LOW;
                break;
        case SND_SOC_DAIFMT_RIGHT_J:
                val |= TEGRA30_I2S_CTRL_FRAME_FORMAT_LRCK;
                val |= TEGRA30_I2S_CTRL_LRCK_L_LOW;
                break;
        case SND_SOC_DAIFMT_LEFT_J:
                val |= TEGRA30_I2S_CTRL_FRAME_FORMAT_LRCK;
                val |= TEGRA30_I2S_CTRL_LRCK_L_LOW;
                break;
        default:
                return -EINVAL;
        }

        pm_runtime_get_sync(dai->dev);
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL, mask, val);
        pm_runtime_put(dai->dev);

        return 0;
}

static int tegra30_i2s_hw_params(struct snd_pcm_substream *substream,
                                 struct snd_pcm_hw_params *params,
                                 struct snd_soc_dai *dai)
{
        struct device *dev = dai->dev;
        struct tegra30_i2s *i2s = snd_soc_dai_get_drvdata(dai);
        unsigned int mask, val, reg;
        int ret, sample_size, srate, i2sclock, bitcnt;
        struct tegra30_ahub_cif_conf cif_conf;

        if (params_channels(params) != 2)
                return -EINVAL;

        mask = TEGRA30_I2S_CTRL_BIT_SIZE_MASK;
        switch (params_format(params)) {
        case SNDRV_PCM_FORMAT_S16_LE:
                val = TEGRA30_I2S_CTRL_BIT_SIZE_16;
                sample_size = 16;
                break;
        default:
                return -EINVAL;
        }

        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL, mask, val);

        srate = params_rate(params);

        /* Final "* 2" required by Tegra hardware */
        i2sclock = srate * params_channels(params) * sample_size * 2;

        bitcnt = (i2sclock / (2 * srate)) - 1;
        if (bitcnt < 0 || bitcnt > TEGRA30_I2S_TIMING_CHANNEL_BIT_COUNT_MASK_US)
                return -EINVAL;

        ret = clk_set_rate(i2s->clk_i2s, i2sclock);
        if (ret) {
                dev_err(dev, "Can't set I2S clock rate: %d\n", ret);
                return ret;
        }

        val = bitcnt << TEGRA30_I2S_TIMING_CHANNEL_BIT_COUNT_SHIFT;

        if (i2sclock % (2 * srate))
                val |= TEGRA30_I2S_TIMING_NON_SYM_ENABLE;

        regmap_write(i2s->regmap, TEGRA30_I2S_TIMING, val);

        cif_conf.threshold = 0;
        cif_conf.audio_channels = 2;
        cif_conf.client_channels = 2;
        cif_conf.audio_bits = TEGRA30_AUDIOCIF_BITS_16;
        cif_conf.client_bits = TEGRA30_AUDIOCIF_BITS_16;
        cif_conf.expand = 0;
        cif_conf.stereo_conv = 0;
        cif_conf.replicate = 0;
        cif_conf.truncate = 0;
        cif_conf.mono_conv = 0;

        if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
                cif_conf.direction = TEGRA30_AUDIOCIF_DIRECTION_RX;
                reg = TEGRA30_I2S_CIF_RX_CTRL;
        } else {
                cif_conf.direction = TEGRA30_AUDIOCIF_DIRECTION_TX;
                reg = TEGRA30_I2S_CIF_TX_CTRL;
        }

        i2s->soc_data->set_audio_cif(i2s->regmap, reg, &cif_conf);

        val = (1 << TEGRA30_I2S_OFFSET_RX_DATA_OFFSET_SHIFT) |
              (1 << TEGRA30_I2S_OFFSET_TX_DATA_OFFSET_SHIFT);
        regmap_write(i2s->regmap, TEGRA30_I2S_OFFSET, val);

        return 0;
}

static void tegra30_i2s_start_playback(struct tegra30_i2s *i2s)
{
        tegra30_ahub_enable_tx_fifo(i2s->playback_fifo_cif);
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL,
                           TEGRA30_I2S_CTRL_XFER_EN_TX,
                           TEGRA30_I2S_CTRL_XFER_EN_TX);
}

static void tegra30_i2s_stop_playback(struct tegra30_i2s *i2s)
{
        tegra30_ahub_disable_tx_fifo(i2s->playback_fifo_cif);
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL,
                           TEGRA30_I2S_CTRL_XFER_EN_TX, 0);
}

static void tegra30_i2s_start_capture(struct tegra30_i2s *i2s)
{
        tegra30_ahub_enable_rx_fifo(i2s->capture_fifo_cif);
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL,
                           TEGRA30_I2S_CTRL_XFER_EN_RX,
                           TEGRA30_I2S_CTRL_XFER_EN_RX);
}

static void tegra30_i2s_stop_capture(struct tegra30_i2s *i2s)
{
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CTRL,
                           TEGRA30_I2S_CTRL_XFER_EN_RX, 0);
        tegra30_ahub_disable_rx_fifo(i2s->capture_fifo_cif);
}

static int tegra30_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
                                struct snd_soc_dai *dai)
{
        struct tegra30_i2s *i2s = snd_soc_dai_get_drvdata(dai);

        switch (cmd) {
        case SNDRV_PCM_TRIGGER_START:
        case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
        case SNDRV_PCM_TRIGGER_RESUME:
                if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
                        tegra30_i2s_start_playback(i2s);
                else
                        tegra30_i2s_start_capture(i2s);
                break;
        case SNDRV_PCM_TRIGGER_STOP:
        case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
        case SNDRV_PCM_TRIGGER_SUSPEND:
                if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
                        tegra30_i2s_stop_playback(i2s);
                else
                        tegra30_i2s_stop_capture(i2s);
                break;
        default:
                return -EINVAL;
        }

        return 0;
}

static int tegra30_i2s_set_tdm(struct snd_soc_dai *dai,
                               unsigned int tx_mask, unsigned int rx_mask,
                               int slots, int slot_width)
{
        struct tegra30_i2s *i2s = snd_soc_dai_get_drvdata(dai);
        unsigned int mask, val;

        dev_dbg(dai->dev, "%s: txmask=0x%08x rxmask=0x%08x slots=%d width=%d\n",
                 __func__, tx_mask, rx_mask, slots, slot_width);

        mask = TEGRA30_I2S_SLOT_CTRL_TOTAL_SLOTS_MASK |
               TEGRA30_I2S_SLOT_CTRL_RX_SLOT_ENABLES_MASK |
               TEGRA30_I2S_SLOT_CTRL_TX_SLOT_ENABLES_MASK;

        val = (tx_mask << TEGRA30_I2S_SLOT_CTRL_TX_SLOT_ENABLES_SHIFT) |
              (rx_mask << TEGRA30_I2S_SLOT_CTRL_RX_SLOT_ENABLES_SHIFT) |
              ((slots - 1) << TEGRA30_I2S_SLOT_CTRL_TOTAL_SLOTS_SHIFT);

        pm_runtime_get_sync(dai->dev);
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_SLOT_CTRL, mask, val);
        /* set the fsync width to minimum of 1 clock width */
        regmap_update_bits(i2s->regmap, TEGRA30_I2S_CH_CTRL,
                           TEGRA30_I2S_CH_CTRL_FSYNC_WIDTH_MASK, 0x0);
        pm_runtime_put(dai->dev);

        return 0;
}

static int tegra30_i2s_probe(struct snd_soc_dai *dai)
{
        struct tegra30_i2s *i2s = snd_soc_dai_get_drvdata(dai);

        snd_soc_dai_init_dma_data(dai,  &i2s->playback_dma_data,
                                        &i2s->capture_dma_data);

        return 0;
}

static const struct snd_soc_dai_ops tegra30_i2s_dai_ops = {
        .probe          = tegra30_i2s_probe,
        .set_fmt        = tegra30_i2s_set_fmt,
        .hw_params      = tegra30_i2s_hw_params,
        .trigger        = tegra30_i2s_trigger,
        .set_tdm_slot   = tegra30_i2s_set_tdm,
};

static const struct snd_soc_dai_driver tegra30_i2s_dai_template = {
        .playback = {
                .stream_name = "Playback",
                .channels_min = 2,
                .channels_max = 2,
                .rates = SNDRV_PCM_RATE_8000_96000,
                .formats = SNDRV_PCM_FMTBIT_S16_LE,
        },
        .capture = {
                .stream_name = "Capture",
                .channels_min = 2,
                .channels_max = 2,
                .rates = SNDRV_PCM_RATE_8000_96000,
                .formats = SNDRV_PCM_FMTBIT_S16_LE,
        },
        .ops = &tegra30_i2s_dai_ops,
        .symmetric_rate = 1,
};

static const struct snd_soc_component_driver tegra30_i2s_component = {
        .name                   = DRV_NAME,
        .legacy_dai_naming      = 1,
};

static bool tegra30_i2s_wr_rd_reg(struct device *dev, unsigned int reg)
{
        switch (reg) {
        case TEGRA30_I2S_CTRL:
        case TEGRA30_I2S_TIMING:
        case TEGRA30_I2S_OFFSET:
        case TEGRA30_I2S_CH_CTRL:
        case TEGRA30_I2S_SLOT_CTRL:
        case TEGRA30_I2S_CIF_RX_CTRL:
        case TEGRA30_I2S_CIF_TX_CTRL:
        case TEGRA30_I2S_FLOWCTL:
        case TEGRA30_I2S_TX_STEP:
        case TEGRA30_I2S_FLOW_STATUS:
        case TEGRA30_I2S_FLOW_TOTAL:
        case TEGRA30_I2S_FLOW_OVER:
        case TEGRA30_I2S_FLOW_UNDER:
        case TEGRA30_I2S_LCOEF_1_4_0:
        case TEGRA30_I2S_LCOEF_1_4_1:
        case TEGRA30_I2S_LCOEF_1_4_2:
        case TEGRA30_I2S_LCOEF_1_4_3:
        case TEGRA30_I2S_LCOEF_1_4_4:
        case TEGRA30_I2S_LCOEF_1_4_5:
        case TEGRA30_I2S_LCOEF_2_4_0:
        case TEGRA30_I2S_LCOEF_2_4_1:
        case TEGRA30_I2S_LCOEF_2_4_2:
                return true;
        default:
                return false;
        }
}

static bool tegra30_i2s_volatile_reg(struct device *dev, unsigned int reg)
{
        switch (reg) {
        case TEGRA30_I2S_FLOW_STATUS:
        case TEGRA30_I2S_FLOW_TOTAL:
        case TEGRA30_I2S_FLOW_OVER:
        case TEGRA30_I2S_FLOW_UNDER:
                return true;
        default:
                return false;
        }
}

static const struct regmap_config tegra30_i2s_regmap_config = {
        .reg_bits = 32,
        .reg_stride = 4,
        .val_bits = 32,
        .max_register = TEGRA30_I2S_LCOEF_2_4_2,
        .writeable_reg = tegra30_i2s_wr_rd_reg,
        .readable_reg = tegra30_i2s_wr_rd_reg,
        .volatile_reg = tegra30_i2s_volatile_reg,
        .cache_type = REGCACHE_FLAT,
};

static const struct tegra30_i2s_soc_data tegra30_i2s_config = {
        .set_audio_cif = tegra30_ahub_set_cif,
};

static const struct tegra30_i2s_soc_data tegra124_i2s_config = {
        .set_audio_cif = tegra124_ahub_set_cif,
};

static const struct of_device_id tegra30_i2s_of_match[] = {
        { .compatible = "nvidia,tegra124-i2s", .data = &tegra124_i2s_config },
        { .compatible = "nvidia,tegra30-i2s", .data = &tegra30_i2s_config },
        {},
};

static int tegra30_i2s_platform_probe(struct platform_device *pdev)
{
        struct tegra30_i2s *i2s;
        const struct tegra30_i2s_soc_data *soc_data;
        u32 cif_ids[2];
        void __iomem *regs;
        int ret;

        i2s = devm_kzalloc(&pdev->dev, sizeof(struct tegra30_i2s), GFP_KERNEL);
        if (!i2s) {
                ret = -ENOMEM;
                goto err;
        }
        dev_set_drvdata(&pdev->dev, i2s);

        soc_data = of_device_get_match_data(&pdev->dev);
        if (!soc_data) {
                dev_err(&pdev->dev, "Error: No device match found\n");
                ret = -ENODEV;
                goto err;
        }
        i2s->soc_data = soc_data;

        i2s->dai = tegra30_i2s_dai_template;
        i2s->dai.name = dev_name(&pdev->dev);

        ret = of_property_read_u32_array(pdev->dev.of_node,
                                         "nvidia,ahub-cif-ids", cif_ids,
                                         ARRAY_SIZE(cif_ids));
        if (ret < 0)
                goto err;

        i2s->playback_i2s_cif = cif_ids[0];
        i2s->capture_i2s_cif = cif_ids[1];

        i2s->clk_i2s = devm_clk_get(&pdev->dev, NULL);
        if (IS_ERR(i2s->clk_i2s)) {
                dev_err(&pdev->dev, "Can't retrieve i2s clock\n");
                ret = PTR_ERR(i2s->clk_i2s);
                goto err;
        }

        regs = devm_platform_ioremap_resource(pdev, 0);
        if (IS_ERR(regs)) {
                ret = PTR_ERR(regs);
                goto err;
        }

        i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
                                            &tegra30_i2s_regmap_config);
        if (IS_ERR(i2s->regmap)) {
                dev_err(&pdev->dev, "regmap init failed\n");
                ret = PTR_ERR(i2s->regmap);
                goto err;
        }
        regcache_cache_only(i2s->regmap, true);

        pm_runtime_enable(&pdev->dev);

        i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
        i2s->playback_dma_data.maxburst = 4;
        ret = tegra30_ahub_allocate_tx_fifo(&i2s->playback_fifo_cif,
                                            i2s->playback_dma_chan,
                                            sizeof(i2s->playback_dma_chan),
                                            &i2s->playback_dma_data.addr);
        if (ret) {
                dev_err(&pdev->dev, "Could not alloc TX FIFO: %d\n", ret);
                goto err_pm_disable;
        }
        ret = tegra30_ahub_set_rx_cif_source(i2s->playback_i2s_cif,
                                             i2s->playback_fifo_cif);
        if (ret) {
                dev_err(&pdev->dev, "Could not route TX FIFO: %d\n", ret);
                goto err_free_tx_fifo;
        }

        i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
        i2s->capture_dma_data.maxburst = 4;
        ret = tegra30_ahub_allocate_rx_fifo(&i2s->capture_fifo_cif,
                                            i2s->capture_dma_chan,
                                            sizeof(i2s->capture_dma_chan),
                                            &i2s->capture_dma_data.addr);
        if (ret) {
                dev_err(&pdev->dev, "Could not alloc RX FIFO: %d\n", ret);
                goto err_unroute_tx_fifo;
        }
        ret = tegra30_ahub_set_rx_cif_source(i2s->capture_fifo_cif,
                                             i2s->capture_i2s_cif);
        if (ret) {
                dev_err(&pdev->dev, "Could not route TX FIFO: %d\n", ret);
                goto err_free_rx_fifo;
        }

        ret = snd_soc_register_component(&pdev->dev, &tegra30_i2s_component,
                                   &i2s->dai, 1);
        if (ret) {
                dev_err(&pdev->dev, "Could not register DAI: %d\n", ret);
                ret = -ENOMEM;
                goto err_unroute_rx_fifo;
        }

        ret = tegra_pcm_platform_register_with_chan_names(&pdev->dev,
                                &i2s->dma_config, i2s->playback_dma_chan,
                                i2s->capture_dma_chan);
        if (ret) {
                dev_err(&pdev->dev, "Could not register PCM: %d\n", ret);
                goto err_unregister_component;
        }

        return 0;

err_unregister_component:
        snd_soc_unregister_component(&pdev->dev);
err_unroute_rx_fifo:
        tegra30_ahub_unset_rx_cif_source(i2s->capture_fifo_cif);
err_free_rx_fifo:
        tegra30_ahub_free_rx_fifo(i2s->capture_fifo_cif);
err_unroute_tx_fifo:
        tegra30_ahub_unset_rx_cif_source(i2s->playback_i2s_cif);
err_free_tx_fifo:
        tegra30_ahub_free_tx_fifo(i2s->playback_fifo_cif);
err_pm_disable:
        pm_runtime_disable(&pdev->dev);
err:
        return ret;
}

static void tegra30_i2s_platform_remove(struct platform_device *pdev)
{
        struct tegra30_i2s *i2s = dev_get_drvdata(&pdev->dev);

        tegra_pcm_platform_unregister(&pdev->dev);
        snd_soc_unregister_component(&pdev->dev);

        tegra30_ahub_unset_rx_cif_source(i2s->capture_fifo_cif);
        tegra30_ahub_free_rx_fifo(i2s->capture_fifo_cif);

        tegra30_ahub_unset_rx_cif_source(i2s->playback_i2s_cif);
        tegra30_ahub_free_tx_fifo(i2s->playback_fifo_cif);

        pm_runtime_disable(&pdev->dev);
}

static const struct dev_pm_ops tegra30_i2s_pm_ops = {
        RUNTIME_PM_OPS(tegra30_i2s_runtime_suspend,
                       tegra30_i2s_runtime_resume, NULL)
        SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, pm_runtime_force_resume)
};

static struct platform_driver tegra30_i2s_driver = {
        .driver = {
                .name = DRV_NAME,
                .of_match_table = tegra30_i2s_of_match,
                .pm = pm_ptr(&tegra30_i2s_pm_ops),
        },
        .probe = tegra30_i2s_platform_probe,
        .remove = tegra30_i2s_platform_remove,
};
module_platform_driver(tegra30_i2s_driver);

MODULE_AUTHOR("Stephen Warren <swarren@nvidia.com>");
MODULE_DESCRIPTION("Tegra30 I2S ASoC driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:" DRV_NAME);
MODULE_DEVICE_TABLE(of, tegra30_i2s_of_match);