1 // SPDX-License-Identifier: GPL-2.0-only
3  *  byt_cr_dpcm_rt5640.c - ASoc Machine driver for Intel Byt CR platform
30 #include <sound/soc-acpi.h>
31 #include <dt-bindings/sound/rt5640.h>
33 #include "../atom/sst-atom-controls.h"
34 #include "../common/soc-intel-quirks.h"
36 #define BYT_RT5640_FALLBACK_CODEC_DEV_NAME	"i2c-rt5640"
77 #define BYT_RT5640_DIFF_MIC		BIT(18) /* default is single-ended */
98 /* in-diff or dmic-pin + jdsrc + ovcd-th + -sf + jd-inv + terminating entry */
112 static int quirk_override = -1;
114 MODULE_PARM_DESC(quirk, "Board-specific quirk override");
149 		dev_info(dev, "quirk realtek,jack-detect-source %ld\n",  in log_quirks()
151 		dev_info(dev, "quirk realtek,over-current-threshold-microamp %ld\n",  in log_quirks()
153 		dev_info(dev, "quirk realtek,over-current-scale-factor %ld\n",  in log_quirks()
187 …dev_err(dev, "Invalid routing, bytcr detected but no SSP0-based quirk, audio cannot work with SSP2…  in log_quirks()
238 		dev_err(codec_dai->component->dev, "can't set pll: %d\n", ret);  in byt_rt5640_prepare_and_enable_pll1()
245 		dev_err(codec_dai->component->dev, "can't set clock %d\n", ret);  in byt_rt5640_prepare_and_enable_pll1()
252 #define BYT_CODEC_DAI1	"rt5640-aif1"
253 #define BYT_CODEC_DAI2	"rt5640-aif2"
257 	struct snd_soc_card *card = dapm->card;  in byt_rt5640_get_codec_dai()
264 		dev_err(card->dev, "Error codec dai not found\n");  in byt_rt5640_get_codec_dai()
272 	struct snd_soc_dapm_context *dapm = w->dapm;  in platform_clock_control()
273 	struct snd_soc_card *card = dapm->card;  in platform_clock_control()
280 		return -EIO;  in platform_clock_control()
283 		ret = clk_prepare_enable(priv->mclk);  in platform_clock_control()
285 			dev_err(card->dev, "could not configure MCLK state\n");  in platform_clock_control()
291 		 * Set codec clock source to internal clock before  in platform_clock_control()
292 		 * turning off the platform clock. Codec needs clock  in platform_clock_control()
299 			clk_disable_unprepare(priv->mclk);  in platform_clock_control()
303 		dev_err(card->dev, "can't set codec sysclk: %d\n", ret);  in platform_clock_control()
320 	 * On devices which use line-out as a second headphones output,  in byt_rt5640_event_lineout()
321 	 * the codec's GPIO1 pin is used to enable an external HP-amp.  in byt_rt5640_event_lineout()
324 	codec_dai = byt_rt5640_get_codec_dai(w->dapm);  in byt_rt5640_event_lineout()
326 		return -EIO;  in byt_rt5640_event_lineout()
331 	snd_soc_component_update_bits(codec_dai->component, RT5640_GPIO_CTRL3,  in byt_rt5640_event_lineout()
344 	SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
350 	{"Headphone", NULL, "Platform Clock"},
351 	{"Headset Mic", NULL, "Platform Clock"},
359 	{"Internal Mic", NULL, "Platform Clock"},
364 	{"Internal Mic", NULL, "Platform Clock"},
369 	{"Internal Mic", NULL, "Platform Clock"},
375 	{"Internal Mic", NULL, "Platform Clock"},
381 	{"Headset Mic 2", NULL, "Platform Clock"},
423 	{"Speaker", NULL, "Platform Clock"},
431 	{"Speaker", NULL, "Platform Clock"},
437 	{"Line Out", NULL, "Platform Clock"},
464 		/* The 2nd headset jack uses lineout with an external HP-amp */
475 	.name = "hp-detect",
482 	.name = "hp2-detect",
493 	{ "hp-detect-gpios", &acpi_gpio0, 1, },
494 	{ "headset-mic-detect-gpios", &acpi_gpio1, 1, },
495 	{ "hp2-detect-gpios", &acpi_gpio2, 1, },
508 	mic_status = gpiod_get_value_cansleep(priv->hsmic_detect);  in byt_rt5640_hp_elitepad_1000g2_jack1_check()
542 	{	/* Acer Iconia One 7 B1-750 */
554 	{	/* Acer Iconia Tab 8 W1-810 */
557 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Iconia W1-810"),
579 	{       /* Acer Aspire SW3-013 */
582 			DMI_MATCH(DMI_PRODUCT_NAME, "Aspire SW3-013"),
595 			DMI_MATCH(DMI_PRODUCT_NAME, "Aspire SW5-012"),
605 		/* Advantech MICA-071 */
608 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "MICA-071"),
610 		/* OVCD Th = 1500uA to reliable detect head-phones vs -set */
717 	{	/* Chuwi Vi8 dual-boot (CWI506) */
733 			DMI_MATCH(DMI_BOARD_NAME, "BYT-PF02"),
749 			DMI_MATCH(DMI_BOARD_NAME, "BYT-PA03C"),
806 			DMI_MATCH(DMI_BIOS_VERSION, "ZY-8-BI-PX4S70VTR400-X423B-005-D"),
814 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
824 	{	/* HP Pavilion x2 10-k0XX, 10-n0XX */
826 			DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
836 	{	/* HP Pavilion x2 10-p0XX */
839 			DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
849 			DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
861 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
872 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
916 	{	/* Lenovo Miix 3-830 */
919 			DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "Lenovo MIIX 3-830"),
963 	{	/* MPMAN Converter 9, similar hw as the I.T.Works TW891 2-in-1 */
986 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Micro-Star International Co., Ltd."),
1038 	{	/* Point of View Mobii TAB-P800W (V2.0) */
1055 	{	/* Point of View Mobii TAB-P800W (V2.1) */
1072 	{	/* Point of View Mobii TAB-P1005W-232 (V2.0) */
1112 	{	/* Toshiba Satellite Click Mini L9W-B */
1115 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "SATELLITE Click Mini L9W-B"),
1124 	{	/* Toshiba Encore WT8-A */
1127 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "TOSHIBA WT8-A"),
1136 	{	/* Toshiba Encore WT10-A */
1139 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "TOSHIBA WT10-A-103"),
1192 	{	/* Catch-all for generic Insyde tablets, must be last */
1218 		props[cnt++] = PROPERTY_ENTRY_U32("realtek,dmic1-data-pin",  in byt_rt5640_add_codec_device_props()
1222 		props[cnt++] = PROPERTY_ENTRY_U32("realtek,dmic2-data-pin",  in byt_rt5640_add_codec_device_props()
1228 				PROPERTY_ENTRY_BOOL("realtek,in1-differential");  in byt_rt5640_add_codec_device_props()
1233 				PROPERTY_ENTRY_BOOL("realtek,in3-differential");  in byt_rt5640_add_codec_device_props()
1240 					    "realtek,jack-detect-source",  in byt_rt5640_add_codec_device_props()
1245 				    "realtek,over-current-threshold-microamp",  in byt_rt5640_add_codec_device_props()
1249 				    "realtek,over-current-scale-factor",  in byt_rt5640_add_codec_device_props()
1254 		props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,jack-detect-not-inverted");  in byt_rt5640_add_codec_device_props()
1273 	{ "rt5640-jd-gpios", &amcr0f28_jd_gpio, 1 },
1280 	struct rt5640_set_jack_data *data = &priv->jack_data;  in byt_rt5640_get_amcr0f28_settings()
1284 	adev = acpi_dev_get_first_match_dev("AMCR0F28", "1", -1);  in byt_rt5640_get_amcr0f28_settings()
1286 		dev_err(card->dev, "error cannot find AMCR0F28 adev\n");  in byt_rt5640_get_amcr0f28_settings()
1287 		return -ENOENT;  in byt_rt5640_get_amcr0f28_settings()
1290 	data->codec_irq_override = acpi_dev_gpio_irq_get(adev, 0);  in byt_rt5640_get_amcr0f28_settings()
1291 	if (data->codec_irq_override < 0) {  in byt_rt5640_get_amcr0f28_settings()
1292 		ret = data->codec_irq_override;  in byt_rt5640_get_amcr0f28_settings()
1293 		dev_err(card->dev, "error %d getting codec IRQ\n", ret);  in byt_rt5640_get_amcr0f28_settings()
1299 		data->jd_gpio = devm_fwnode_gpiod_get(card->dev, acpi_fwnode_handle(adev),  in byt_rt5640_get_amcr0f28_settings()
1300 						      "rt5640-jd", GPIOD_IN, "rt5640-jd");  in byt_rt5640_get_amcr0f28_settings()
1303 		if (IS_ERR(data->jd_gpio)) {  in byt_rt5640_get_amcr0f28_settings()
1304 			ret = PTR_ERR(data->jd_gpio);  in byt_rt5640_get_amcr0f28_settings()
1305 			dev_err(card->dev, "error %d getting jd GPIO\n", ret);  in byt_rt5640_get_amcr0f28_settings()
1316 	struct snd_soc_card *card = runtime->card;  in byt_rt5640_init()
1318 	struct rt5640_set_jack_data *jack_data = &priv->jack_data;  in byt_rt5640_init()
1319 	struct snd_soc_component *component = snd_soc_rtd_to_codec(runtime, 0)->component;  in byt_rt5640_init()
1324 	card->dapm.idle_bias_off = true;  in byt_rt5640_init()
1325 	jack_data->use_platform_clock = true;  in byt_rt5640_init()
1327 	/* Start with RC clk for jack-detect (we disable MCLK below) */  in byt_rt5640_init()
1344 		dev_err(card->dev, "unable to add card controls\n");  in byt_rt5640_init()
1367 	ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);  in byt_rt5640_init()
1372 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1380 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1384 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1388 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1392 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1400 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1404 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1412 		ret = snd_soc_dapm_add_routes(&card->dapm,  in byt_rt5640_init()
1420 	 * The firmware might enable the clock at boot (this information  in byt_rt5640_init()
1421 	 * may or may not be reflected in the enable clock register).  in byt_rt5640_init()
1422 	 * To change the rate we must disable the clock first to cover  in byt_rt5640_init()
1423 	 * these cases. Due to common clock framework restrictions that  in byt_rt5640_init()
1424 	 * do not allow to disable a clock that has not been enabled,  in byt_rt5640_init()
1425 	 * we need to enable the clock first.  in byt_rt5640_init()
1427 	ret = clk_prepare_enable(priv->mclk);  in byt_rt5640_init()
1429 		clk_disable_unprepare(priv->mclk);  in byt_rt5640_init()
1432 		ret = clk_set_rate(priv->mclk, 25000000);  in byt_rt5640_init()
1434 		ret = clk_set_rate(priv->mclk, 19200000);  in byt_rt5640_init()
1436 		dev_err(card->dev, "unable to set MCLK rate\n");  in byt_rt5640_init()
1443 						 &priv->jack, rt5640_pins,  in byt_rt5640_init()
1446 			dev_err(card->dev, "Jack creation failed %d\n", ret);  in byt_rt5640_init()
1449 		snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0,  in byt_rt5640_init()
1458 		snd_soc_component_set_jack(component, &priv->jack, &priv->jack_data);  in byt_rt5640_init()
1464 						 &priv->jack, rt5640_pins,  in byt_rt5640_init()
1471 						 &priv->jack2, rt5640_pins2,  in byt_rt5640_init()
1477 		rt5640_jack_gpio.gpiod_dev = priv->codec_dev;  in byt_rt5640_init()
1479 		ret = snd_soc_jack_add_gpios(&priv->jack, 1, &rt5640_jack_gpio);  in byt_rt5640_init()
1485 		rt5640_jack2_gpio.gpiod_dev = priv->codec_dev;  in byt_rt5640_init()
1487 		ret = snd_soc_jack_add_gpios(&priv->jack2, 1, &rt5640_jack2_gpio);  in byt_rt5640_init()
1489 			snd_soc_jack_free_gpios(&priv->jack, 1, &rt5640_jack_gpio);  in byt_rt5640_init()
1499 	struct snd_soc_card *card = runtime->card;  in byt_rt5640_exit()
1503 		snd_soc_jack_free_gpios(&priv->jack2, 1, &rt5640_jack2_gpio);  in byt_rt5640_exit()
1504 		snd_soc_jack_free_gpios(&priv->jack, 1, &rt5640_jack_gpio);  in byt_rt5640_exit()
1518 	rate->min = rate->max = 48000;  in byt_rt5640_codec_fixup()
1519 	channels->min = channels->max = 2;  in byt_rt5640_codec_fixup()
1523 		/* set SSP0 to 16-bit */  in byt_rt5640_codec_fixup()
1527 		/* set SSP2 to 24-bit */  in byt_rt5640_codec_fixup()
1542 		dev_err(rtd->dev, "can't set format to I2S, err %d\n", ret);  in byt_rt5640_codec_fixup()
1548 		dev_err(rtd->dev, "can't set I2S config, err %d\n", ret);  in byt_rt5640_codec_fixup()
1557 	return snd_pcm_hw_constraint_single(substream->runtime,  in byt_rt5640_aif1_startup()
1573 	DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
1576 	DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
1580 	DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
1583 	/* overwritten with HID */ "i2c-10EC5640:00",
1584 	/* changed w/ quirk */	"rt5640-aif1")));
1587 	DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
1599 		.name = "Deep-Buffer Audio Port",
1600 		.stream_name = "Deep-Buffer Audio",
1609 		.name = "SSP2-Codec",
1625 static char byt_rt5640_long_name[40]; /* = "bytcr-rt5640-*-spk-*-mic" */
1627 static char byt_rt5640_components[64]; /* = "cfg-spk:* cfg-mic:* ..." */
1637 		if (!strcmp(component->name, byt_rt5640_codec_name)) {  in byt_rt5640_suspend()
1638 			dev_dbg(component->dev, "disabling jack detect before suspend\n");  in byt_rt5640_suspend()
1656 		if (!strcmp(component->name, byt_rt5640_codec_name)) {  in byt_rt5640_resume()
1657 			dev_dbg(component->dev, "re-enabling jack detect after resume\n");  in byt_rt5640_resume()
1658 			snd_soc_component_set_jack(component, &priv->jack,  in byt_rt5640_resume()
1659 						   &priv->jack_data);  in byt_rt5640_resume()
1668 #define SOF_CARD_NAME "bytcht rt5640" /* card name will be 'sof-bytcht rt5640' */
1671 #define CARD_NAME "bytcr-rt5640"
1694 	struct device *dev = &pdev->dev;  in snd_byt_rt5640_mc_probe()
1714 		return -ENOMEM;  in snd_byt_rt5640_mc_probe()
1723 		    !strcmp(byt_rt5640_dais[i].codecs->name,  in snd_byt_rt5640_mc_probe()
1724 			    "i2c-10EC5640:00")) {  in snd_byt_rt5640_mc_probe()
1731 	adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);  in snd_byt_rt5640_mc_probe()
1734 			 "i2c-%s", acpi_dev_name(adev));  in snd_byt_rt5640_mc_probe()
1735 		byt_rt5640_dais[dai_index].codecs->name = byt_rt5640_codec_name;  in snd_byt_rt5640_mc_probe()
1737 		dev_err(dev, "Error cannot find '%s' dev\n", mach->id);  in snd_byt_rt5640_mc_probe()
1738 		return -ENOENT;  in snd_byt_rt5640_mc_probe()
1745 		priv->codec_dev = get_device(codec_dev);  in snd_byt_rt5640_mc_probe()
1755 			return -EPROBE_DEFER;  in snd_byt_rt5640_mc_probe()
1758 			dev_err(dev, "Error '%s' is not an i2c_client\n",  in snd_byt_rt5640_mc_probe()
1768 		priv->codec_dev = codec_dev;  in snd_byt_rt5640_mc_probe()
1776 		if (mach->mach_params.acpi_ipc_irq_index == 0)  in snd_byt_rt5640_mc_probe()
1786 		 * with the codec driver/pdata are non-existent  in snd_byt_rt5640_mc_probe()
1791 		/* format specified: 2 64-bit integers */  in snd_byt_rt5640_mc_probe()
1806 		pkg_found = snd_soc_acpi_find_package_from_hid(mach->id,  in snd_byt_rt5640_mc_probe()
1822 			/* no BIOS indications, assume SSP0-AIF2 connection */  in snd_byt_rt5640_mc_probe()
1826 		/* change defaults for Baytrail-CR capture */  in snd_byt_rt5640_mc_probe()
1838 		byt_rt5640_quirk = (unsigned long)dmi_id->driver_data;  in snd_byt_rt5640_mc_probe()
1839 	if (quirk_override != -1) {  in snd_byt_rt5640_mc_probe()
1846 		acpi_dev_add_driver_gpios(ACPI_COMPANION(priv->codec_dev),  in snd_byt_rt5640_mc_probe()
1849 		priv->hsmic_detect = devm_fwnode_gpiod_get(dev, codec_dev->fwnode,  in snd_byt_rt5640_mc_probe()
1850 							   "headset-mic-detect", GPIOD_IN,  in snd_byt_rt5640_mc_probe()
1851 							   "headset-mic-detect");  in snd_byt_rt5640_mc_probe()
1852 		if (IS_ERR(priv->hsmic_detect)) {  in snd_byt_rt5640_mc_probe()
1853 			ret_val = dev_err_probe(dev, PTR_ERR(priv->hsmic_detect),  in snd_byt_rt5640_mc_probe()
1854 						"getting hsmic-detect GPIO\n");  in snd_byt_rt5640_mc_probe()
1868 		byt_rt5640_dais[dai_index].codecs->dai_name = "rt5640-aif2";  in snd_byt_rt5640_mc_probe()
1876 		byt_rt5640_dais[dai_index].cpus->dai_name = "ssp0-port";  in snd_byt_rt5640_mc_probe()
1879 		priv->mclk = devm_clk_get_optional(dev, "pmc_plt_clk_3");  in snd_byt_rt5640_mc_probe()
1880 		if (IS_ERR(priv->mclk)) {  in snd_byt_rt5640_mc_probe()
1881 			ret_val = dev_err_probe(dev, PTR_ERR(priv->mclk),  in snd_byt_rt5640_mc_probe()
1886 		 * Fall back to bit clock usage when clock is not  in snd_byt_rt5640_mc_probe()
1889 		if (!priv->mclk)  in snd_byt_rt5640_mc_probe()
1909 			lineout_string = " cfg-hp2:lineout";  in snd_byt_rt5640_mc_probe()
1911 			lineout_string = " cfg-lineout:2";  in snd_byt_rt5640_mc_probe()
1915 		headset2_string = " cfg-hs2:in1";  in snd_byt_rt5640_mc_probe()
1918 		 "cfg-spk:%s cfg-mic:%s aif:%d%s%s", cfg_spk,  in snd_byt_rt5640_mc_probe()
1924 		 "bytcr-rt5640-%s-spk-%s-mic", spk_type,  in snd_byt_rt5640_mc_probe()
1930 	platform_name = mach->mach_params.platform;  in snd_byt_rt5640_mc_probe()
1950 		dev->driver->pm = &snd_soc_pm_ops;  in snd_byt_rt5640_mc_probe()
1961 	device_remove_software_node(priv->codec_dev);  in snd_byt_rt5640_mc_probe()
1964 		acpi_dev_remove_driver_gpios(ACPI_COMPANION(priv->codec_dev));  in snd_byt_rt5640_mc_probe()
1966 	put_device(priv->codec_dev);  in snd_byt_rt5640_mc_probe()
1976 		acpi_dev_remove_driver_gpios(ACPI_COMPANION(priv->codec_dev));  in snd_byt_rt5640_mc_remove()
1978 	device_remove_software_node(priv->codec_dev);  in snd_byt_rt5640_mc_remove()
1979 	put_device(priv->codec_dev);  in snd_byt_rt5640_mc_remove()