path: root/sound/soc/intel/boards/cht_rt5677.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  cht_rt5677.c - ASoC machine driver for Cherry Trail with RT5677
 *
 *  Copyright (C) 2026 Yauhen Kharuzhy <jekhor@gmail.com>
 *
 *  Based on the mainline cht_bsw_rt5672.c driver and Lenovo's
 *  cht_bl_dpcm_rt5677.c Android driver.
 */

#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/gpio/consumer.h>
#include <linux/i2c.h>
#include <linux/input.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <sound/jack.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/soc-acpi.h>
#include "../../codecs/rt5677.h"
#include "../../codecs/ts3a227e.h"
#include "../atom/sst-atom-controls.h"

#define RT5677_I2C	"i2c-rt5677"
/* x86-android-tablets creates this client with dev_name "ts3a227e". */
#define TS3A227E_I2C	"i2c-ts3a227e"

/* Platform clock 3 provides the codec's 19.2 MHz I2S master clock. */
#define CHT_PLAT_CLK_3_HZ	19200000
#define CHT_CODEC_DAI	"rt5677-aif1"

struct cht_rt5677_private {
	char codec_name[SND_ACPI_I2C_ID_LEN];
	struct clk *mclk;
	struct gpio_desc *gpio_spk_en1;
	struct gpio_desc *gpio_spk_en2;
	struct gpio_desc *gpio_hp_en;
};

static int cht_rt5677_platform_clock_enable(struct snd_soc_card *card,
					    struct snd_soc_dai *codec_dai)
{
	struct cht_rt5677_private *ctx = snd_soc_card_get_drvdata(card);
	int ret;

	ret = clk_prepare_enable(ctx->mclk);
	if (ret) {
		dev_err(card->dev, "enabling MCLK failed: %d\n", ret);
		return ret;
	}

	ret = snd_soc_dai_set_pll(codec_dai, 0, RT5677_PLL1_S_MCLK,
				  CHT_PLAT_CLK_3_HZ, 48000 * 512);
	if (ret) {
		dev_err(card->dev, "setting codec PLL failed: %d\n", ret);
		goto disable_mclk;
	}

	ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_PLL1,
				     48000 * 512, SND_SOC_CLOCK_IN);
	if (ret) {
		dev_err(card->dev, "setting codec sysclk failed: %d\n", ret);
		goto disable_mclk;
	}

	return 0;

disable_mclk:
	clk_disable_unprepare(ctx->mclk);
	return ret;
}

static int cht_rt5677_platform_clock_disable(struct snd_soc_card *card,
					     struct snd_soc_dai *codec_dai)
{
	struct cht_rt5677_private *ctx = snd_soc_card_get_drvdata(card);
	int ret;

	ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_RCCLK,
				     48000 * 512, SND_SOC_CLOCK_IN);
	if (ret)
		dev_warn(card->dev, "setting codec idle sysclk failed: %d\n", ret);

	clk_disable_unprepare(ctx->mclk);

	return ret;
}

static int cht_rt5677_platform_clock_control(struct snd_soc_dapm_widget *w,
					     struct snd_kcontrol *kctl,
					     int event)
{
	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
	struct snd_soc_dai *codec_dai;

	codec_dai = snd_soc_card_get_codec_dai(card, CHT_CODEC_DAI);
	if (!codec_dai) {
		dev_err(card->dev, "codec DAI not found\n");
		return -EIO;
	}

	if (SND_SOC_DAPM_EVENT_ON(event))
		return cht_rt5677_platform_clock_enable(card, codec_dai);

	return cht_rt5677_platform_clock_disable(card, codec_dai);
}

static int cht_rt5677_hp_event(struct snd_soc_dapm_widget *w,
			       struct snd_kcontrol *kctl, int event)
{
	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
	struct cht_rt5677_private *ctx = snd_soc_card_get_drvdata(card);

	return gpiod_set_value_cansleep(ctx->gpio_hp_en,
					 SND_SOC_DAPM_EVENT_ON(event));
}

static int cht_rt5677_spk_event(struct snd_soc_dapm_widget *w,
				struct snd_kcontrol *kctl, int event)
{
	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
	struct cht_rt5677_private *ctx = snd_soc_card_get_drvdata(card);
	bool enable = SND_SOC_DAPM_EVENT_ON(event);
	int rollback_ret;
	int ret;
	int i;

	/* Program the external boost amplifier for mode 3 before enabling it. */
	if (enable) {
		for (i = 0; i < 4; i++) {
			ret = gpiod_set_value_cansleep(ctx->gpio_spk_en1,
						       !(i & 1));
			if (ret)
				goto disable_boost;

			udelay(2);
		}
	}

	ret = gpiod_set_value_cansleep(ctx->gpio_spk_en1, enable);
	if (ret)
		return ret;

	ret = gpiod_set_value_cansleep(ctx->gpio_spk_en2, enable);
	if (ret) {
		rollback_ret = gpiod_set_value_cansleep(ctx->gpio_spk_en1,
							!enable);
		if (rollback_ret)
			dev_warn(card->dev, "rolling back speaker GPIO failed: %d\n",
				 rollback_ret);
		return ret;
	}

	if (enable)
		msleep(50);

	return 0;

disable_boost:
	rollback_ret = gpiod_set_value_cansleep(ctx->gpio_spk_en1, 0);
	if (rollback_ret)
		dev_warn(card->dev, "disabling speaker boost GPIO failed: %d\n",
			 rollback_ret);

	return ret;
}

static const struct snd_soc_dapm_widget cht_rt5677_widgets[] = {
	SND_SOC_DAPM_HP("Headphone", cht_rt5677_hp_event),
	SND_SOC_DAPM_MIC("Headset Mic", NULL),
	SND_SOC_DAPM_MIC("Int Mic", NULL),
	SND_SOC_DAPM_SPK("Speaker", cht_rt5677_spk_event),
	SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
			    cht_rt5677_platform_clock_control,
			    SND_SOC_DAPM_PRE_PMU |
			    SND_SOC_DAPM_POST_PMD),
};

static const struct snd_soc_dapm_route cht_rt5677_map[] = {
	{"IN1P", NULL, "Headset Mic"},
	{"IN1N", NULL, "Headset Mic"},
	{"DMIC L1", NULL, "Int Mic"},
	{"DMIC R1", NULL, "Int Mic"},
	{"Headphone", NULL, "LOUT1"},
	{"Headphone", NULL, "LOUT2"},
	{"Speaker", NULL, "LOUT1"},
	{"Speaker", NULL, "LOUT2"},

	{"AIF1 Playback", NULL, "ssp2 Tx"},
	{"ssp2 Tx", NULL, "codec_out0"},
	{"ssp2 Tx", NULL, "codec_out1"},
	{"codec_in0", NULL, "ssp2 Rx"},
	{"codec_in1", NULL, "ssp2 Rx"},
	{"ssp2 Rx", NULL, "AIF1 Capture"},
	{"Headphone", NULL, "Platform Clock"},
	{"Speaker", NULL, "Platform Clock"},
	{"Headset Mic", NULL, "Platform Clock"},
	{"Int Mic", NULL, "Platform Clock"},
};

static const struct snd_kcontrol_new cht_rt5677_controls[] = {
	SOC_DAPM_PIN_SWITCH("Headphone"),
	SOC_DAPM_PIN_SWITCH("Headset Mic"),
	SOC_DAPM_PIN_SWITCH("Int Mic"),
	SOC_DAPM_PIN_SWITCH("Speaker"),
};

static int cht_rt5677_aif1_hw_params(struct snd_pcm_substream *substream,
				     struct snd_pcm_hw_params *params)
{
	struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
	struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
	int ret;

	ret = snd_soc_dai_set_pll(codec_dai, 0, RT5677_PLL1_S_MCLK,
				  CHT_PLAT_CLK_3_HZ, params_rate(params) * 512);
	if (ret) {
		dev_err(rtd->dev, "setting codec PLL failed: %d\n", ret);
		return ret;
	}

	ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_PLL1,
				     params_rate(params) * 512,
				     SND_SOC_CLOCK_IN);
	if (ret) {
		dev_err(rtd->dev, "setting codec sysclk failed: %d\n", ret);
		return ret;
	}

	ret = snd_soc_dai_set_fmt(codec_dai,
				  SND_SOC_DAIFMT_DSP_B |
				  SND_SOC_DAIFMT_IB_NF |
				  SND_SOC_DAIFMT_CBC_CFC);
	if (ret) {
		dev_err(codec_dai->dev, "setting TDM format failed: %d\n", ret);
		return ret;
	}

	/* Four 25-bit DSP_B slots carry 24-bit samples; the codec uses slots 0 and 1. */
	ret = snd_soc_dai_set_tdm_slot(codec_dai, 0x3, 0x3, 4, 25);
	if (ret) {
		dev_err(rtd->dev, "setting codec TDM slots failed: %d\n", ret);
		return ret;
	}

	return 0;
}

static int cht_rt5677_codec_init(struct snd_soc_pcm_runtime *runtime)
{
	struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(runtime, 0);
	struct snd_soc_component *component = codec_dai->component;
	struct cht_rt5677_private *ctx = snd_soc_card_get_drvdata(runtime->card);
	int ret;

	/*
	 * The codec derives its asynchronous sample-rate conversion clocks from
	 * I2S1 while the SSP link runs from the Cherry Trail platform clock.
	 */
	ret = rt5677_sel_asrc_clk_src(component, RT5677_DA_STEREO_FILTER |
					       RT5677_AD_STEREO1_FILTER |
					       RT5677_I2S1_SOURCE,
					RT5677_CLK_SEL_I2S1_ASRC);
	if (ret) {
		dev_err(runtime->dev, "setting stereo ASRC clock failed: %d\n", ret);
		return ret;
	}

	/* Mono ADC L uses the codec system clock rather than the I2S1 clock. */
	ret = rt5677_sel_asrc_clk_src(component, RT5677_AD_MONO_L_FILTER, RT5677_CLK_SEL_SYS2);
	if (ret) {
		dev_err(runtime->dev, "setting mono ASRC clock failed: %d\n", ret);
		return ret;
	}

	/* Firmware may leave MCLK enabled without updating the CCF count. */
	ret = clk_prepare_enable(ctx->mclk);
	if (ret) {
		dev_err(runtime->dev, "preparing MCLK failed: %d\n", ret);
		return ret;
	}
	clk_disable_unprepare(ctx->mclk);

	ret = clk_set_rate(ctx->mclk, CHT_PLAT_CLK_3_HZ);
	if (ret) {
		dev_err(runtime->dev, "setting MCLK rate failed: %d\n", ret);
		return ret;
	}

	return 0;
}

static int cht_rt5677_codec_fixup(struct snd_soc_pcm_runtime *rtd,
				  struct snd_pcm_hw_params *params)
{
	struct snd_interval *rate = hw_param_interval(params,
			SNDRV_PCM_HW_PARAM_RATE);
	struct snd_interval *channels = hw_param_interval(params,
						SNDRV_PCM_HW_PARAM_CHANNELS);

	/* The DSP will convert the FE rate to 48k, stereo, 24bits */
	rate->min = 48000;
	rate->max = 48000;
	channels->min = 2;
	channels->max = 2;

	/*
	 * Configure SSP2 for the 24-bit format expected by the codec. The
	 * ssp2-port front end still advertises S16_LE and converts the stream.
	 */
	snd_mask_none(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT));
	params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);

	return 0;
}

static struct snd_soc_jack_pin cht_rt5677_jack_pins[] = {
	{
		.pin = "Headphone",
		.mask = SND_JACK_HEADPHONE,
	},
	{
		.pin = "Headset Mic",
		.mask = SND_JACK_MICROPHONE,
	},
};

static int cht_rt5677_headset_init(struct snd_soc_component *component)
{
	struct snd_soc_card *card = component->card;
	struct snd_soc_jack *jack;
	int jack_type;
	int ret;

	jack = devm_kzalloc(card->dev, sizeof(*jack), GFP_KERNEL);
	if (!jack)
		return -ENOMEM;

	/*
	 * TI supports four headset buttons:
	 * KEY_MEDIA
	 * KEY_VOICECOMMAND
	 * KEY_VOLUMEUP
	 * KEY_VOLUMEDOWN
	 */
	jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE |
		    SND_JACK_BTN_0 | SND_JACK_BTN_1 |
		    SND_JACK_BTN_2 | SND_JACK_BTN_3;

	ret = snd_soc_card_jack_new_pins(card, "Headset Jack", jack_type,
					 jack, cht_rt5677_jack_pins,
					 ARRAY_SIZE(cht_rt5677_jack_pins));
	if (ret) {
		dev_err(card->dev, "creating headset jack failed: %d\n", ret);
		return ret;
	}

	return ts3a227e_enable_jack_detect(component, jack);
}

static int cht_rt5677_aif1_startup(struct snd_pcm_substream *substream)
{
	return snd_pcm_hw_constraint_single(substream->runtime,
			SNDRV_PCM_HW_PARAM_RATE, 48000);
}

static const struct snd_soc_ops cht_rt5677_aif1_ops = {
	.startup = cht_rt5677_aif1_startup,
};

static const struct snd_soc_ops cht_rt5677_be_ssp2_ops = {
	.hw_params = cht_rt5677_aif1_hw_params,
};

static const struct snd_soc_aux_dev cht_rt5677_headset_dev = {
	.dlc = COMP_AUX(TS3A227E_I2C),
	.init = cht_rt5677_headset_init,
};

SND_SOC_DAILINK_DEF(dummy,	DAILINK_COMP_ARRAY(COMP_DUMMY()));
SND_SOC_DAILINK_DEF(media,	DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
SND_SOC_DAILINK_DEF(deepbuffer,	DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
SND_SOC_DAILINK_DEF(ssp2_port,	DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
SND_SOC_DAILINK_DEF(ssp2_codec,	DAILINK_COMP_ARRAY(COMP_CODEC(RT5677_I2C, CHT_CODEC_DAI)));
SND_SOC_DAILINK_DEF(platform,	DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));

static const struct snd_soc_dai_link cht_rt5677_dailink[] = {
	/* Front End DAI links */
	[MERR_DPCM_AUDIO] = {
		.name = "Audio Port",
		.stream_name = "Audio",
		.nonatomic = true,
		.dynamic = 1,
		.ops = &cht_rt5677_aif1_ops,
		SND_SOC_DAILINK_REG(media, dummy, platform),
	},
	[MERR_DPCM_DEEP_BUFFER] = {
		.name = "Deep-Buffer Audio Port",
		.stream_name = "Deep-Buffer Audio",
		.nonatomic = true,
		.dynamic = 1,
		.playback_only = 1,
		.ops = &cht_rt5677_aif1_ops,
		SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
	},

	/* Back End DAI links */
	{
		/* SSP2 - Codec */
		.name = "SSP2-Codec",
		.id = 0,
		.no_pcm = 1,
		.nonatomic = true,
		.init = cht_rt5677_codec_init,
		.be_hw_params_fixup = cht_rt5677_codec_fixup,
		.ops = &cht_rt5677_be_ssp2_ops,
		SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
	},
};

static const struct snd_soc_card cht_rt5677_card = {
	.owner = THIS_MODULE,
	.num_links = ARRAY_SIZE(cht_rt5677_dailink),
	.num_aux_devs = 1,
	.dapm_widgets = cht_rt5677_widgets,
	.num_dapm_widgets = ARRAY_SIZE(cht_rt5677_widgets),
	.dapm_routes = cht_rt5677_map,
	.num_dapm_routes = ARRAY_SIZE(cht_rt5677_map),
	.controls = cht_rt5677_controls,
	.num_controls = ARRAY_SIZE(cht_rt5677_controls),
};

static const struct acpi_gpio_params speaker_enable_gpio = { 2, 0, false };
static const struct acpi_gpio_mapping cht_rt5677_acpi_gpios[] = {
	{ "speaker-enable-gpios", &speaker_enable_gpio, 1 },
	{ }
};

#define SOF_CARD_NAME "cht rt5677"
#define SOF_DRIVER_NAME "SOF"

#define CARD_NAME "cht-rt5677"
#define DRIVER_NAME NULL

static void cht_rt5677_gpiod_put(void *data)
{
	gpiod_put(data);
}

static void cht_rt5677_remove_driver_gpios(void *data)
{
	acpi_dev_remove_driver_gpios(data);
}

static int cht_rt5677_get_gpio(struct device *dev, struct device *codec_dev,
			       const char *con_id, struct gpio_desc **gpio)
{
	int ret;

	*gpio = gpiod_get(codec_dev, con_id, GPIOD_OUT_LOW);
	if (IS_ERR(*gpio)) {
		ret = PTR_ERR(*gpio);
		return dev_err_probe(dev, ret, "getting %s GPIO failed\n", con_id);
	}

	ret = devm_add_action_or_reset(dev, cht_rt5677_gpiod_put, *gpio);
	if (ret)
		return dev_err_probe(dev, ret, "registering %s GPIO cleanup failed\n",
				     con_id);

	return 0;
}

static int cht_rt5677_clone_dai_links(struct device *dev, struct snd_soc_card *card)
{
	struct snd_soc_dai_link_component *components;
	struct snd_soc_dai_link *links;
	size_t size;
	int i;

	links = devm_kmemdup(dev, cht_rt5677_dailink,
			     sizeof(cht_rt5677_dailink), GFP_KERNEL);
	if (!links)
		return -ENOMEM;

	for (i = 0; i < ARRAY_SIZE(cht_rt5677_dailink); i++) {
		if (links[i].num_cpus) {
			size = sizeof(*components) * links[i].num_cpus;
			components = devm_kmemdup(dev, links[i].cpus, size, GFP_KERNEL);
			if (!components)
				return -ENOMEM;
			links[i].cpus = components;
		}

		if (links[i].num_codecs) {
			size = sizeof(*components) * links[i].num_codecs;
			components = devm_kmemdup(dev, links[i].codecs, size, GFP_KERNEL);
			if (!components)
				return -ENOMEM;
			links[i].codecs = components;
		}

		if (links[i].num_platforms) {
			size = sizeof(*components) * links[i].num_platforms;
			components = devm_kmemdup(dev, links[i].platforms, size, GFP_KERNEL);
			if (!components)
				return -ENOMEM;
			links[i].platforms = components;
		}
	}

	card->dai_link = links;
	return 0;
}

static int snd_cht_rt5677_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct cht_rt5677_private *ctx;
	struct snd_soc_acpi_mach *mach = dev_get_platdata(dev);
	struct snd_soc_aux_dev *aux_dev;
	struct snd_soc_dai_link *dai_links;
	struct snd_soc_card *card;
	struct acpi_device *adev;
	struct device *codec_dev;
	bool sof_parent;
	int ret;
	int i;

	ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
	if (!ctx)
		return -ENOMEM;

	card = devm_kmemdup(dev, &cht_rt5677_card, sizeof(*card), GFP_KERNEL);
	if (!card)
		return -ENOMEM;

	ret = cht_rt5677_clone_dai_links(dev, card);
	if (ret)
		return ret;
	dai_links = card->dai_link;

	aux_dev = devm_kmemdup(dev, &cht_rt5677_headset_dev,
			       sizeof(cht_rt5677_headset_dev), GFP_KERNEL);
	if (!aux_dev)
		return -ENOMEM;

	card->aux_dev = aux_dev;

	strscpy(ctx->codec_name, RT5677_I2C, sizeof(ctx->codec_name));

	/* Use the ACPI-enumerated codec name when firmware describes the codec. */
	adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
	if (adev) {
		snprintf(ctx->codec_name, sizeof(ctx->codec_name),
			 "i2c-%s", acpi_dev_name(adev));

		acpi_dev_put(adev);
		for (i = 0; i < card->num_links; i++) {
			if (dai_links[i].codecs->name &&
			    !strcmp(dai_links[i].codecs->name,
				    RT5677_I2C)) {
				dai_links[i].codecs->name = ctx->codec_name;
				break;
			}
		}
	}

	codec_dev = bus_find_device_by_name(&i2c_bus_type, NULL,
					    ctx->codec_name);
	if (!codec_dev)
		return dev_err_probe(dev, -EPROBE_DEFER,
				     "waiting for codec %s\n", ctx->codec_name);

	adev = ACPI_COMPANION(codec_dev);
	if (adev) {
		/*
		 * Firmware describes the external speaker enable in _CRS. The
		 * x86-android-tablets quirk supplies software-node properties for
		 * the RT5677 GPIO2 and GPIO4 speaker/headphone enables.
		 */
		ret = acpi_dev_add_driver_gpios(adev, cht_rt5677_acpi_gpios);
		if (ret) {
			dev_err_probe(dev, ret, "adding codec GPIO mappings failed\n");
			goto out_put_codec;
		}

		ret = devm_add_action_or_reset(dev, cht_rt5677_remove_driver_gpios, adev);
		if (ret) {
			dev_err_probe(dev, ret, "registering GPIO mapping cleanup failed\n");
			goto out_put_codec;
		}
	}

	ret = cht_rt5677_get_gpio(dev, codec_dev, "speaker-enable", &ctx->gpio_spk_en1);
	if (ret)
		goto out_put_codec;

	ret = cht_rt5677_get_gpio(dev, codec_dev, "speaker-enable2", &ctx->gpio_spk_en2);
	if (ret)
		goto out_put_codec;

	ret = cht_rt5677_get_gpio(dev, codec_dev, "headphone-enable", &ctx->gpio_hp_en);
	if (ret)
		goto out_put_codec;

	put_device(codec_dev);

	card->dev = dev;

	ctx->mclk = devm_clk_get(dev, "pmc_plt_clk_3");
	if (IS_ERR(ctx->mclk))
		return dev_err_probe(dev, PTR_ERR(ctx->mclk), "getting MCLK failed\n");

	snd_soc_card_set_drvdata(card, ctx);

	sof_parent = snd_soc_acpi_sof_parent(dev);

	if (sof_parent) {
		card->name = SOF_CARD_NAME;
		card->driver_name = SOF_DRIVER_NAME;
	} else {
		card->name = CARD_NAME;
		card->driver_name = DRIVER_NAME;
	}

	ret = devm_snd_soc_register_card(dev, card);
	if (ret)
		return dev_err_probe(dev, ret, "registering sound card failed\n");

	return 0;

out_put_codec:
	put_device(codec_dev);
	return ret;
}

static struct platform_driver snd_cht_rt5677_driver = {
	.driver = {
		.name = "cht-rt5677",
		.pm = &snd_soc_pm_ops,
	},
	.probe = snd_cht_rt5677_probe,
};

module_platform_driver(snd_cht_rt5677_driver);

MODULE_DESCRIPTION("Cherry Trail RT5677 machine driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:cht-rt5677");