root/sound/soc/codecs/wm9705.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * wm9705.c  --  ALSA Soc WM9705 codec support
 *
 * Copyright 2008 Ian Molton <spyro@f2s.com>
 */

#include <linux/init.h>
#include <linux/slab.h>
#include <linux/mfd/wm97xx.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/device.h>
#include <linux/regmap.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/ac97_codec.h>
#include <sound/ac97/codec.h>
#include <sound/ac97/compat.h>
#include <sound/initval.h>
#include <sound/soc.h>

#define WM9705_VENDOR_ID 0x574d4c05
#define WM9705_VENDOR_ID_MASK 0xffffffff

struct wm9705_priv {
        struct snd_ac97 *ac97;
        struct wm97xx_platform_data *mfd_pdata;
};

static const struct reg_default wm9705_reg_defaults[] = {
        { 0x02, 0x8000 },
        { 0x04, 0x8000 },
        { 0x06, 0x8000 },
        { 0x0a, 0x8000 },
        { 0x0c, 0x8008 },
        { 0x0e, 0x8008 },
        { 0x10, 0x8808 },
        { 0x12, 0x8808 },
        { 0x14, 0x8808 },
        { 0x16, 0x8808 },
        { 0x18, 0x8808 },
        { 0x1a, 0x0000 },
        { 0x1c, 0x8000 },
        { 0x20, 0x0000 },
        { 0x22, 0x0000 },
        { 0x26, 0x000f },
        { 0x28, 0x0605 },
        { 0x2a, 0x0000 },
        { 0x2c, 0xbb80 },
        { 0x32, 0xbb80 },
        { 0x34, 0x2000 },
        { 0x5a, 0x0000 },
        { 0x5c, 0x0000 },
        { 0x72, 0x0808 },
        { 0x74, 0x0000 },
        { 0x76, 0x0006 },
        { 0x78, 0x0000 },
        { 0x7a, 0x0000 },
};

static const struct regmap_config wm9705_regmap_config = {
        .reg_bits = 16,
        .reg_stride = 2,
        .val_bits = 16,
        .max_register = 0x7e,
        .cache_type = REGCACHE_MAPLE,

        .volatile_reg = regmap_ac97_default_volatile,

        .reg_defaults = wm9705_reg_defaults,
        .num_reg_defaults = ARRAY_SIZE(wm9705_reg_defaults),
};

static const struct snd_kcontrol_new wm9705_snd_ac97_controls[] = {
        SOC_DOUBLE("Master Playback Volume", AC97_MASTER, 8, 0, 31, 1),
        SOC_SINGLE("Master Playback Switch", AC97_MASTER, 15, 1, 1),
        SOC_DOUBLE("Headphone Playback Volume", AC97_HEADPHONE, 8, 0, 31, 1),
        SOC_SINGLE("Headphone Playback Switch", AC97_HEADPHONE, 15, 1, 1),
        SOC_DOUBLE("PCM Playback Volume", AC97_PCM, 8, 0, 31, 1),
        SOC_SINGLE("PCM Playback Switch", AC97_PCM, 15, 1, 1),
        SOC_SINGLE("Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1),
        SOC_SINGLE("Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1),
        SOC_SINGLE("PCBeep Playback Volume", AC97_PC_BEEP, 1, 15, 1),
        SOC_SINGLE("Phone Playback Volume", AC97_PHONE, 0, 31, 1),
        SOC_DOUBLE("Line Playback Volume", AC97_LINE, 8, 0, 31, 1),
        SOC_DOUBLE("CD Playback Volume", AC97_CD, 8, 0, 31, 1),
        SOC_SINGLE("Mic Playback Volume", AC97_MIC, 0, 31, 1),
        SOC_SINGLE("Mic 20dB Boost Switch", AC97_MIC, 6, 1, 0),
        SOC_DOUBLE("Capture Volume", AC97_REC_GAIN, 8, 0, 15, 0),
        SOC_SINGLE("Capture Switch", AC97_REC_GAIN, 15, 1, 1),
};

static const char *wm9705_mic[] = {"Mic 1", "Mic 2"};
static const char *wm9705_rec_sel[] = {"Mic", "CD", "NC", "NC",
        "Line", "Stereo Mix", "Mono Mix", "Phone"};

static SOC_ENUM_SINGLE_DECL(wm9705_enum_mic,
                            AC97_GENERAL_PURPOSE, 8, wm9705_mic);
static SOC_ENUM_SINGLE_DECL(wm9705_enum_rec_l,
                            AC97_REC_SEL, 8, wm9705_rec_sel);
static SOC_ENUM_SINGLE_DECL(wm9705_enum_rec_r,
                            AC97_REC_SEL, 0, wm9705_rec_sel);

/* Headphone Mixer */
static const struct snd_kcontrol_new wm9705_hp_mixer_controls[] = {
        SOC_DAPM_SINGLE("PCBeep Playback Switch", AC97_PC_BEEP, 15, 1, 1),
        SOC_DAPM_SINGLE("CD Playback Switch", AC97_CD, 15, 1, 1),
        SOC_DAPM_SINGLE("Mic Playback Switch", AC97_MIC, 15, 1, 1),
        SOC_DAPM_SINGLE("Phone Playback Switch", AC97_PHONE, 15, 1, 1),
        SOC_DAPM_SINGLE("Line Playback Switch", AC97_LINE, 15, 1, 1),
};

/* Mic source */
static const struct snd_kcontrol_new wm9705_mic_src_controls =
        SOC_DAPM_ENUM("Route", wm9705_enum_mic);

/* Capture source */
static const struct snd_kcontrol_new wm9705_capture_selectl_controls =
        SOC_DAPM_ENUM("Route", wm9705_enum_rec_l);
static const struct snd_kcontrol_new wm9705_capture_selectr_controls =
        SOC_DAPM_ENUM("Route", wm9705_enum_rec_r);

/* DAPM widgets */
static const struct snd_soc_dapm_widget wm9705_dapm_widgets[] = {
        SND_SOC_DAPM_MUX("Mic Source", SND_SOC_NOPM, 0, 0,
                &wm9705_mic_src_controls),
        SND_SOC_DAPM_MUX("Left Capture Source", SND_SOC_NOPM, 0, 0,
                &wm9705_capture_selectl_controls),
        SND_SOC_DAPM_MUX("Right Capture Source", SND_SOC_NOPM, 0, 0,
                &wm9705_capture_selectr_controls),
        SND_SOC_DAPM_DAC("Left DAC", "Left HiFi Playback",
                SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_DAC("Right DAC", "Right HiFi Playback",
                SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_MIXER_NAMED_CTL("HP Mixer", SND_SOC_NOPM, 0, 0,
                &wm9705_hp_mixer_controls[0],
                ARRAY_SIZE(wm9705_hp_mixer_controls)),
        SND_SOC_DAPM_MIXER("Mono Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_ADC("Left ADC", "Left HiFi Capture", SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_ADC("Right ADC", "Right HiFi Capture", SND_SOC_NOPM, 0, 0),
        SND_SOC_DAPM_PGA("Headphone PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Speaker PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Line PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Line out PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Mono PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Phone PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Mic PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("PCBEEP PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("CD PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_PGA("ADC PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
        SND_SOC_DAPM_OUTPUT("HPOUTL"),
        SND_SOC_DAPM_OUTPUT("HPOUTR"),
        SND_SOC_DAPM_OUTPUT("LOUT"),
        SND_SOC_DAPM_OUTPUT("ROUT"),
        SND_SOC_DAPM_OUTPUT("MONOOUT"),
        SND_SOC_DAPM_INPUT("PHONE"),
        SND_SOC_DAPM_INPUT("LINEINL"),
        SND_SOC_DAPM_INPUT("LINEINR"),
        SND_SOC_DAPM_INPUT("CDINL"),
        SND_SOC_DAPM_INPUT("CDINR"),
        SND_SOC_DAPM_INPUT("PCBEEP"),
        SND_SOC_DAPM_INPUT("MIC1"),
        SND_SOC_DAPM_INPUT("MIC2"),
};

/* Audio map
 * WM9705 has no switches to disable the route from the inputs to the HP mixer
 * so in order to prevent active inputs from forcing the audio outputs to be
 * constantly enabled, we use the mutes on those inputs to simulate such
 * controls.
 */
static const struct snd_soc_dapm_route wm9705_audio_map[] = {
        /* HP mixer */
        {"HP Mixer", "PCBeep Playback Switch", "PCBEEP PGA"},
        {"HP Mixer", "CD Playback Switch", "CD PGA"},
        {"HP Mixer", "Mic Playback Switch", "Mic PGA"},
        {"HP Mixer", "Phone Playback Switch", "Phone PGA"},
        {"HP Mixer", "Line Playback Switch", "Line PGA"},
        {"HP Mixer", NULL, "Left DAC"},
        {"HP Mixer", NULL, "Right DAC"},

        /* mono mixer */
        {"Mono Mixer", NULL, "HP Mixer"},

        /* outputs */
        {"Headphone PGA", NULL, "HP Mixer"},
        {"HPOUTL", NULL, "Headphone PGA"},
        {"HPOUTR", NULL, "Headphone PGA"},
        {"Line out PGA", NULL, "HP Mixer"},
        {"LOUT", NULL, "Line out PGA"},
        {"ROUT", NULL, "Line out PGA"},
        {"Mono PGA", NULL, "Mono Mixer"},
        {"MONOOUT", NULL, "Mono PGA"},

        /* inputs */
        {"CD PGA", NULL, "CDINL"},
        {"CD PGA", NULL, "CDINR"},
        {"Line PGA", NULL, "LINEINL"},
        {"Line PGA", NULL, "LINEINR"},
        {"Phone PGA", NULL, "PHONE"},
        {"Mic Source", "Mic 1", "MIC1"},
        {"Mic Source", "Mic 2", "MIC2"},
        {"Mic PGA", NULL, "Mic Source"},
        {"PCBEEP PGA", NULL, "PCBEEP"},

        /* Left capture selector */
        {"Left Capture Source", "Mic", "Mic Source"},
        {"Left Capture Source", "CD", "CDINL"},
        {"Left Capture Source", "Line", "LINEINL"},
        {"Left Capture Source", "Stereo Mix", "HP Mixer"},
        {"Left Capture Source", "Mono Mix", "HP Mixer"},
        {"Left Capture Source", "Phone", "PHONE"},

        /* Right capture source */
        {"Right Capture Source", "Mic", "Mic Source"},
        {"Right Capture Source", "CD", "CDINR"},
        {"Right Capture Source", "Line", "LINEINR"},
        {"Right Capture Source", "Stereo Mix", "HP Mixer"},
        {"Right Capture Source", "Mono Mix", "HP Mixer"},
        {"Right Capture Source", "Phone", "PHONE"},

        {"ADC PGA", NULL, "Left Capture Source"},
        {"ADC PGA", NULL, "Right Capture Source"},

        /* ADC's */
        {"Left ADC",  NULL, "ADC PGA"},
        {"Right ADC", NULL, "ADC PGA"},
};

static int ac97_prepare(struct snd_pcm_substream *substream,
                        struct snd_soc_dai *dai)
{
        struct snd_soc_component *component = dai->component;
        int reg;

        snd_soc_component_update_bits(component, AC97_EXTENDED_STATUS, 0x1, 0x1);

        if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
                reg = AC97_PCM_FRONT_DAC_RATE;
        else
                reg = AC97_PCM_LR_ADC_RATE;

        return snd_soc_component_write(component, reg, substream->runtime->rate);
}

#define WM9705_AC97_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 | \
                        SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 | \
                        SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
                        SNDRV_PCM_RATE_48000)

static const struct snd_soc_dai_ops wm9705_dai_ops = {
        .prepare        = ac97_prepare,
};

static struct snd_soc_dai_driver wm9705_dai[] = {
        {
                .name = "wm9705-hifi",
                .playback = {
                        .stream_name = "HiFi Playback",
                        .channels_min = 1,
                        .channels_max = 2,
                        .rates = WM9705_AC97_RATES,
                        .formats = SND_SOC_STD_AC97_FMTS,
                },
                .capture = {
                        .stream_name = "HiFi Capture",
                        .channels_min = 1,
                        .channels_max = 2,
                        .rates = WM9705_AC97_RATES,
                        .formats = SND_SOC_STD_AC97_FMTS,
                },
                .ops = &wm9705_dai_ops,
        },
        {
                .name = "wm9705-aux",
                .playback = {
                        .stream_name = "Aux Playback",
                        .channels_min = 1,
                        .channels_max = 1,
                        .rates = WM9705_AC97_RATES,
                        .formats = SNDRV_PCM_FMTBIT_S16_LE,
                },
        }
};

#ifdef CONFIG_PM
static int wm9705_soc_suspend(struct snd_soc_component *component)
{
        regcache_cache_bypass(component->regmap, true);
        snd_soc_component_write(component, AC97_POWERDOWN, 0xffff);
        regcache_cache_bypass(component->regmap, false);

        return 0;
}

static int wm9705_soc_resume(struct snd_soc_component *component)
{
        struct wm9705_priv *wm9705 = snd_soc_component_get_drvdata(component);
        int ret;

        ret = snd_ac97_reset(wm9705->ac97, true, WM9705_VENDOR_ID,
                WM9705_VENDOR_ID_MASK);
        if (ret < 0)
                return ret;

        snd_soc_component_cache_sync(component);

        return 0;
}
#else
#define wm9705_soc_suspend NULL
#define wm9705_soc_resume NULL
#endif

static int wm9705_soc_probe(struct snd_soc_component *component)
{
        struct wm9705_priv *wm9705 = snd_soc_component_get_drvdata(component);
        struct regmap *regmap;

        if (wm9705->mfd_pdata) {
                wm9705->ac97 = wm9705->mfd_pdata->ac97;
                regmap = wm9705->mfd_pdata->regmap;
        } else if (IS_ENABLED(CONFIG_SND_SOC_AC97_BUS)) {
                wm9705->ac97 = snd_soc_new_ac97_component(component, WM9705_VENDOR_ID,
                                                      WM9705_VENDOR_ID_MASK);
                if (IS_ERR(wm9705->ac97)) {
                        dev_err(component->dev, "Failed to register AC97 codec\n");
                        return PTR_ERR(wm9705->ac97);
                }

                regmap = regmap_init_ac97(wm9705->ac97, &wm9705_regmap_config);
                if (IS_ERR(regmap)) {
                        snd_soc_free_ac97_component(wm9705->ac97);
                        return PTR_ERR(regmap);
                }
        } else {
                return -ENXIO;
        }

        snd_soc_component_set_drvdata(component, wm9705->ac97);
        snd_soc_component_init_regmap(component, regmap);

        return 0;
}

static void wm9705_soc_remove(struct snd_soc_component *component)
{
        struct wm9705_priv *wm9705 = snd_soc_component_get_drvdata(component);

        if (IS_ENABLED(CONFIG_SND_SOC_AC97_BUS) && !wm9705->mfd_pdata) {
                snd_soc_component_exit_regmap(component);
                snd_soc_free_ac97_component(wm9705->ac97);
        }
}

static const struct snd_soc_component_driver soc_component_dev_wm9705 = {
        .probe                  = wm9705_soc_probe,
        .remove                 = wm9705_soc_remove,
        .suspend                = wm9705_soc_suspend,
        .resume                 = wm9705_soc_resume,
        .controls               = wm9705_snd_ac97_controls,
        .num_controls           = ARRAY_SIZE(wm9705_snd_ac97_controls),
        .dapm_widgets           = wm9705_dapm_widgets,
        .num_dapm_widgets       = ARRAY_SIZE(wm9705_dapm_widgets),
        .dapm_routes            = wm9705_audio_map,
        .num_dapm_routes        = ARRAY_SIZE(wm9705_audio_map),
        .idle_bias_on           = 1,
        .use_pmdown_time        = 1,
        .endianness             = 1,
};

static int wm9705_probe(struct platform_device *pdev)
{
        struct wm9705_priv *wm9705;

        wm9705 = devm_kzalloc(&pdev->dev, sizeof(*wm9705), GFP_KERNEL);
        if (wm9705 == NULL)
                return -ENOMEM;

        wm9705->mfd_pdata = dev_get_platdata(&pdev->dev);
        platform_set_drvdata(pdev, wm9705);

        return devm_snd_soc_register_component(&pdev->dev,
                        &soc_component_dev_wm9705, wm9705_dai, ARRAY_SIZE(wm9705_dai));
}

static struct platform_driver wm9705_codec_driver = {
        .driver = {
                        .name = "wm9705-codec",
        },

        .probe = wm9705_probe,
};

module_platform_driver(wm9705_codec_driver);

MODULE_DESCRIPTION("ASoC WM9705 driver");
MODULE_AUTHOR("Ian Molton");
MODULE_LICENSE("GPL v2");