root/sound/soc/meson/axg-tdmout.c
// SPDX-License-Identifier: (GPL-2.0 OR MIT)
//
// Copyright (c) 2018 BayLibre, SAS.
// Author: Jerome Brunet <jbrunet@baylibre.com>

#include <linux/module.h>
#include <linux/of_platform.h>
#include <linux/regmap.h>
#include <sound/soc.h>
#include <sound/soc-dai.h>

#include "axg-tdm-formatter.h"

#define TDMOUT_CTRL0                    0x00
#define  TDMOUT_CTRL0_BITNUM_MASK       GENMASK(4, 0)
#define  TDMOUT_CTRL0_BITNUM(x)         ((x) << 0)
#define  TDMOUT_CTRL0_SLOTNUM_MASK      GENMASK(9, 5)
#define  TDMOUT_CTRL0_SLOTNUM(x)        ((x) << 5)
#define  TDMOUT_CTRL0_INIT_BITNUM_MASK  GENMASK(19, 15)
#define  TDMOUT_CTRL0_INIT_BITNUM(x)    ((x) << 15)
#define  TDMOUT_CTRL0_ENABLE            BIT(31)
#define  TDMOUT_CTRL0_RST_OUT           BIT(29)
#define  TDMOUT_CTRL0_RST_IN            BIT(28)
#define TDMOUT_CTRL1                    0x04
#define  TDMOUT_CTRL1_TYPE_MASK         GENMASK(6, 4)
#define  TDMOUT_CTRL1_TYPE(x)           ((x) << 4)
#define  SM1_TDMOUT_CTRL1_GAIN_EN       7
#define  TDMOUT_CTRL1_MSB_POS_MASK      GENMASK(12, 8)
#define  TDMOUT_CTRL1_MSB_POS(x)        ((x) << 8)
#define  TDMOUT_CTRL1_SEL_SHIFT         24
#define  TDMOUT_CTRL1_GAIN_EN           26
#define  TDMOUT_CTRL1_WS_INV            BIT(28)
#define TDMOUT_SWAP                     0x08
#define TDMOUT_MASK0                    0x0c
#define TDMOUT_MASK1                    0x10
#define TDMOUT_MASK2                    0x14
#define TDMOUT_MASK3                    0x18
#define TDMOUT_STAT                     0x1c
#define TDMOUT_GAIN0                    0x20
#define TDMOUT_GAIN1                    0x24
#define TDMOUT_MUTE_VAL                 0x28
#define TDMOUT_MUTE0                    0x2c
#define TDMOUT_MUTE1                    0x30
#define TDMOUT_MUTE2                    0x34
#define TDMOUT_MUTE3                    0x38
#define TDMOUT_MASK_VAL                 0x3c

static const struct regmap_config axg_tdmout_regmap_cfg = {
        .reg_bits       = 32,
        .val_bits       = 32,
        .reg_stride     = 4,
        .max_register   = TDMOUT_MASK_VAL,
};

static struct snd_soc_dai *
axg_tdmout_get_be(struct snd_soc_dapm_widget *w)
{
        struct snd_soc_dapm_path *p;
        struct snd_soc_dai *be;

        snd_soc_dapm_widget_for_each_sink_path(w, p) {
                if (!p->connect)
                        continue;

                if (p->sink->id == snd_soc_dapm_dai_in)
                        return (struct snd_soc_dai *)p->sink->priv;

                be = axg_tdmout_get_be(p->sink);
                if (be)
                        return be;
        }

        return NULL;
}

static struct axg_tdm_stream *
axg_tdmout_get_tdm_stream(struct snd_soc_dapm_widget *w)
{
        struct snd_soc_dai *be = axg_tdmout_get_be(w);

        if (!be)
                return NULL;

        return snd_soc_dai_dma_data_get_playback(be);
}

static void axg_tdmout_enable(struct regmap *map)
{
        /* Apply both reset */
        regmap_update_bits(map, TDMOUT_CTRL0,
                           TDMOUT_CTRL0_RST_OUT | TDMOUT_CTRL0_RST_IN, 0);

        /* Clear out reset before in reset */
        regmap_update_bits(map, TDMOUT_CTRL0,
                           TDMOUT_CTRL0_RST_OUT, TDMOUT_CTRL0_RST_OUT);
        regmap_update_bits(map, TDMOUT_CTRL0,
                           TDMOUT_CTRL0_RST_IN,  TDMOUT_CTRL0_RST_IN);

        /* Actually enable tdmout */
        regmap_update_bits(map, TDMOUT_CTRL0,
                           TDMOUT_CTRL0_ENABLE, TDMOUT_CTRL0_ENABLE);
}

static void axg_tdmout_disable(struct regmap *map)
{
        regmap_update_bits(map, TDMOUT_CTRL0, TDMOUT_CTRL0_ENABLE, 0);
}

static int axg_tdmout_prepare(struct regmap *map,
                              const struct axg_tdm_formatter_hw *quirks,
                              struct axg_tdm_stream *ts)
{
        unsigned int val, skew = quirks->skew_offset;

        /* Set the stream skew */
        switch (ts->iface->fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
        case SND_SOC_DAIFMT_I2S:
        case SND_SOC_DAIFMT_DSP_A:
                break;

        case SND_SOC_DAIFMT_LEFT_J:
        case SND_SOC_DAIFMT_DSP_B:
                skew += 1;
                break;

        default:
                pr_err("Unsupported format: %u\n",
                       ts->iface->fmt & SND_SOC_DAIFMT_FORMAT_MASK);
                return -EINVAL;
        }

        val = TDMOUT_CTRL0_INIT_BITNUM(skew);

        /* Set the slot width */
        val |= TDMOUT_CTRL0_BITNUM(ts->iface->slot_width - 1);

        /* Set the slot number */
        val |= TDMOUT_CTRL0_SLOTNUM(ts->iface->slots - 1);

        regmap_update_bits(map, TDMOUT_CTRL0,
                           TDMOUT_CTRL0_INIT_BITNUM_MASK |
                           TDMOUT_CTRL0_BITNUM_MASK |
                           TDMOUT_CTRL0_SLOTNUM_MASK, val);

        /* Set the sample width */
        val = TDMOUT_CTRL1_MSB_POS(ts->width - 1);

        /* FIFO data are arranged in chunks of 64bits */
        switch (ts->physical_width) {
        case 8:
                /* 8 samples of 8 bits */
                val |= TDMOUT_CTRL1_TYPE(0);
                break;
        case 16:
                /* 4 samples of 16 bits - right justified */
                val |= TDMOUT_CTRL1_TYPE(2);
                break;
        case 32:
                /* 2 samples of 32 bits - right justified */
                val |= TDMOUT_CTRL1_TYPE(4);
                break;
        default:
                pr_err("Unsupported physical width: %u\n",
                       ts->physical_width);
                return -EINVAL;
        }

        /* If the sample clock is inverted, invert it back for the formatter */
        if (axg_tdm_lrclk_invert(ts->iface->fmt))
                val |= TDMOUT_CTRL1_WS_INV;

        regmap_update_bits(map, TDMOUT_CTRL1,
                           (TDMOUT_CTRL1_TYPE_MASK | TDMOUT_CTRL1_MSB_POS_MASK |
                            TDMOUT_CTRL1_WS_INV), val);

        /* Set static swap mask configuration */
        regmap_write(map, TDMOUT_SWAP, 0x76543210);

        return axg_tdm_formatter_set_channel_masks(map, ts, TDMOUT_MASK0);
}

static const struct snd_kcontrol_new axg_tdmout_controls[] = {
        SOC_DOUBLE("Lane 0 Volume", TDMOUT_GAIN0,  0,  8, 255, 0),
        SOC_DOUBLE("Lane 1 Volume", TDMOUT_GAIN0, 16, 24, 255, 0),
        SOC_DOUBLE("Lane 2 Volume", TDMOUT_GAIN1,  0,  8, 255, 0),
        SOC_DOUBLE("Lane 3 Volume", TDMOUT_GAIN1, 16, 24, 255, 0),
        SOC_SINGLE("Gain Enable Switch", TDMOUT_CTRL1,
                   TDMOUT_CTRL1_GAIN_EN, 1, 0),
};

static const char * const axg_tdmout_sel_texts[] = {
        "IN 0", "IN 1", "IN 2",
};

static SOC_ENUM_SINGLE_DECL(axg_tdmout_sel_enum, TDMOUT_CTRL1,
                            TDMOUT_CTRL1_SEL_SHIFT, axg_tdmout_sel_texts);

static const struct snd_kcontrol_new axg_tdmout_in_mux =
        SOC_DAPM_ENUM("Input Source", axg_tdmout_sel_enum);

static const struct snd_soc_dapm_widget axg_tdmout_dapm_widgets[] = {
        SND_SOC_DAPM_AIF_IN("IN 0", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 1", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 2", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_MUX("SRC SEL", SND_SOC_NOPM, 0, 0, &axg_tdmout_in_mux),
        SND_SOC_DAPM_PGA_E("ENC", SND_SOC_NOPM, 0, 0, NULL, 0,
                           axg_tdm_formatter_event,
                           (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD)),
        SND_SOC_DAPM_AIF_OUT("OUT", NULL, 0, SND_SOC_NOPM, 0, 0),
};

static const struct snd_soc_dapm_route axg_tdmout_dapm_routes[] = {
        { "SRC SEL", "IN 0", "IN 0" },
        { "SRC SEL", "IN 1", "IN 1" },
        { "SRC SEL", "IN 2", "IN 2" },
        { "ENC", NULL, "SRC SEL" },
        { "OUT", NULL, "ENC" },
};

static const struct snd_soc_component_driver axg_tdmout_component_drv = {
        .controls               = axg_tdmout_controls,
        .num_controls           = ARRAY_SIZE(axg_tdmout_controls),
        .dapm_widgets           = axg_tdmout_dapm_widgets,
        .num_dapm_widgets       = ARRAY_SIZE(axg_tdmout_dapm_widgets),
        .dapm_routes            = axg_tdmout_dapm_routes,
        .num_dapm_routes        = ARRAY_SIZE(axg_tdmout_dapm_routes),
};

static const struct axg_tdm_formatter_ops axg_tdmout_ops = {
        .get_stream     = axg_tdmout_get_tdm_stream,
        .prepare        = axg_tdmout_prepare,
        .enable         = axg_tdmout_enable,
        .disable        = axg_tdmout_disable,
};

static const struct axg_tdm_formatter_driver axg_tdmout_drv = {
        .component_drv  = &axg_tdmout_component_drv,
        .regmap_cfg     = &axg_tdmout_regmap_cfg,
        .ops            = &axg_tdmout_ops,
        .quirks         = &(const struct axg_tdm_formatter_hw) {
                .skew_offset = 1,
        },
};

static const struct axg_tdm_formatter_driver g12a_tdmout_drv = {
        .component_drv  = &axg_tdmout_component_drv,
        .regmap_cfg     = &axg_tdmout_regmap_cfg,
        .ops            = &axg_tdmout_ops,
        .quirks         = &(const struct axg_tdm_formatter_hw) {
                .skew_offset = 2,
        },
};

static const struct snd_kcontrol_new sm1_tdmout_controls[] = {
        SOC_DOUBLE("Lane 0 Volume", TDMOUT_GAIN0,  0,  8, 255, 0),
        SOC_DOUBLE("Lane 1 Volume", TDMOUT_GAIN0, 16, 24, 255, 0),
        SOC_DOUBLE("Lane 2 Volume", TDMOUT_GAIN1,  0,  8, 255, 0),
        SOC_DOUBLE("Lane 3 Volume", TDMOUT_GAIN1, 16, 24, 255, 0),
        SOC_SINGLE("Gain Enable Switch", TDMOUT_CTRL1,
                   SM1_TDMOUT_CTRL1_GAIN_EN, 1, 0),
};

static const char * const sm1_tdmout_sel_texts[] = {
        "IN 0", "IN 1", "IN 2", "IN 3", "IN 4",
};

static SOC_ENUM_SINGLE_DECL(sm1_tdmout_sel_enum, TDMOUT_CTRL1,
                            TDMOUT_CTRL1_SEL_SHIFT, sm1_tdmout_sel_texts);

static const struct snd_kcontrol_new sm1_tdmout_in_mux =
        SOC_DAPM_ENUM("Input Source", sm1_tdmout_sel_enum);

static const struct snd_soc_dapm_widget sm1_tdmout_dapm_widgets[] = {
        SND_SOC_DAPM_AIF_IN("IN 0", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 1", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 2", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 3", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_AIF_IN("IN 4", NULL, 0, SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_MUX("SRC SEL", SND_SOC_NOPM, 0, 0, &sm1_tdmout_in_mux),
        SND_SOC_DAPM_PGA_E("ENC", SND_SOC_NOPM, 0, 0, NULL, 0,
                           axg_tdm_formatter_event,
                           (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD)),
        SND_SOC_DAPM_AIF_OUT("OUT", NULL, 0, SND_SOC_NOPM, 0, 0),
};

static const struct snd_soc_dapm_route sm1_tdmout_dapm_routes[] = {
        { "SRC SEL", "IN 0", "IN 0" },
        { "SRC SEL", "IN 1", "IN 1" },
        { "SRC SEL", "IN 2", "IN 2" },
        { "SRC SEL", "IN 3", "IN 3" },
        { "SRC SEL", "IN 4", "IN 4" },
        { "ENC", NULL, "SRC SEL" },
        { "OUT", NULL, "ENC" },
};

static const struct snd_soc_component_driver sm1_tdmout_component_drv = {
        .controls               = sm1_tdmout_controls,
        .num_controls           = ARRAY_SIZE(sm1_tdmout_controls),
        .dapm_widgets           = sm1_tdmout_dapm_widgets,
        .num_dapm_widgets       = ARRAY_SIZE(sm1_tdmout_dapm_widgets),
        .dapm_routes            = sm1_tdmout_dapm_routes,
        .num_dapm_routes        = ARRAY_SIZE(sm1_tdmout_dapm_routes),
};

static const struct axg_tdm_formatter_driver sm1_tdmout_drv = {
        .component_drv  = &sm1_tdmout_component_drv,
        .regmap_cfg     = &axg_tdmout_regmap_cfg,
        .ops            = &axg_tdmout_ops,
        .quirks         = &(const struct axg_tdm_formatter_hw) {
                .skew_offset = 2,
        },
};

static const struct of_device_id axg_tdmout_of_match[] = {
        {
                .compatible = "amlogic,axg-tdmout",
                .data = &axg_tdmout_drv,
        }, {
                .compatible = "amlogic,g12a-tdmout",
                .data = &g12a_tdmout_drv,
        }, {
                .compatible = "amlogic,sm1-tdmout",
                .data = &sm1_tdmout_drv,
        }, {}
};
MODULE_DEVICE_TABLE(of, axg_tdmout_of_match);

static struct platform_driver axg_tdmout_pdrv = {
        .probe = axg_tdm_formatter_probe,
        .driver = {
                .name = "axg-tdmout",
                .of_match_table = axg_tdmout_of_match,
        },
};
module_platform_driver(axg_tdmout_pdrv);

MODULE_DESCRIPTION("Amlogic AXG TDM output formatter driver");
MODULE_AUTHOR("Jerome Brunet <jbrunet@baylibre.com>");
MODULE_LICENSE("GPL v2");