Unverified Commit c50f126b authored by Pierre-Louis Bossart's avatar Pierre-Louis Bossart Committed by Mark Brown
Browse files

ASoC: Intel: boards: harden codec property handling 



In current ACPI-based devices, the DSDT does not include any of the
properties required by the codec driver. This is not an ACPI
limitation proper since the _DSD method could be used, as done for
Camera and SoundWire in newer platforms. For legacy devices, there is
unfortunately no other option than using a work-around: we add
properties to the codec device from the machine driver.

To avoid any issues with the codec driver being unbound, we need to
keep a reference to the codec device until the card is removed.

Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Co-developed-by: default avatarHans de Goede <hdegoede@redhat.com>
Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
Signed-off-by: default avatarPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20210813151116.23931-2-pierre-louis.bossart@linux.intel.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 772d4452

sound/soc/intel/boards/bytcht_es8316.c

+9 −3
Original line number Diff line number Diff line
@@ -37,6 +37,7 @@ struct byt_cht_es8316_private { 
	struct clk *mclk;

	struct snd_soc_jack jack;

	struct gpio_desc *speaker_en_gpio;

	struct device *codec_dev;

	bool speaker_en;

};
@@ -555,7 +556,7 @@ static int snd_byt_cht_es8316_mc_probe(struct platform_device *pdev) 
		gpiod_get_index(codec_dev, "speaker-enable", 0,

				/* see comment in byt_cht_es8316_resume */

				GPIOD_OUT_LOW | GPIOD_FLAGS_BIT_NONEXCLUSIVE);

	put_device(codec_dev);

	priv->codec_dev = codec_dev;



	if (IS_ERR(priv->speaker_en_gpio)) {

		ret = PTR_ERR(priv->speaker_en_gpio);
@@ -567,7 +568,7 @@ static int snd_byt_cht_es8316_mc_probe(struct platform_device *pdev) 
			dev_err(dev, "get speaker GPIO failed: %d\n", ret);

			fallthrough;

		case -EPROBE_DEFER:

			return ret;

			goto err_put_codec;

		}

	}
@@ -605,10 +606,14 @@ static int snd_byt_cht_es8316_mc_probe(struct platform_device *pdev) 
	if (ret) {

		gpiod_put(priv->speaker_en_gpio);

		dev_err(dev, "snd_soc_register_card failed: %d\n", ret);

		return ret;

		goto err_put_codec;

	}

	platform_set_drvdata(pdev, &byt_cht_es8316_card);

	return 0;



err_put_codec:

	put_device(priv->codec_dev);

	return ret;

}



static int snd_byt_cht_es8316_mc_remove(struct platform_device *pdev)
@@ -617,6 +622,7 @@ static int snd_byt_cht_es8316_mc_remove(struct platform_device *pdev) 
	struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);



	gpiod_put(priv->speaker_en_gpio);

	put_device(priv->codec_dev);

	return 0;

}

sound/soc/intel/boards/bytcr_rt5640.c

+31 −16
Original line number Diff line number Diff line
@@ -90,6 +90,7 @@ enum { 
struct byt_rt5640_private {

	struct snd_soc_jack jack;

	struct clk *mclk;

	struct device *codec_dev;

};

static bool is_bytcr;
@@ -969,15 +970,11 @@ static const struct dmi_system_id byt_rt5640_quirk_table[] = { 
 * Note this MUST be called before snd_soc_register_card(), so that the props

 * are in place before the codec component driver's probe function parses them.

 */

static int byt_rt5640_add_codec_device_props(const char *i2c_dev_name)

static int byt_rt5640_add_codec_device_props(struct device *i2c_dev,

					     struct byt_rt5640_private *priv)

{

	struct property_entry props[MAX_NO_PROPS] = {};

	struct device *i2c_dev;

	int ret, cnt = 0;



	i2c_dev = bus_find_device_by_name(&i2c_bus_type, NULL, i2c_dev_name);

	if (!i2c_dev)

		return -EPROBE_DEFER;

	int cnt = 0;



	switch (BYT_RT5640_MAP(byt_rt5640_quirk)) {

	case BYT_RT5640_DMIC1_MAP:
@@ -1017,10 +1014,7 @@ static int byt_rt5640_add_codec_device_props(const char *i2c_dev_name) 
	if (byt_rt5640_quirk & BYT_RT5640_JD_NOT_INV)

		props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,jack-detect-not-inverted");



	ret = device_add_properties(i2c_dev, props);

	put_device(i2c_dev);



	return ret;

	return device_add_properties(i2c_dev, props);

}



static int byt_rt5640_init(struct snd_soc_pcm_runtime *runtime)
@@ -1367,6 +1361,7 @@ static int snd_byt_rt5640_mc_probe(struct platform_device *pdev) 
	struct snd_soc_acpi_mach *mach;

	const char *platform_name;

	struct acpi_device *adev;

	struct device *codec_dev;

	bool sof_parent;

	int ret_val = 0;

	int dai_index = 0;
@@ -1475,10 +1470,16 @@ static int snd_byt_rt5640_mc_probe(struct platform_device *pdev) 
		byt_rt5640_quirk = quirk_override;

	}



	codec_dev = bus_find_device_by_name(&i2c_bus_type, NULL, byt_rt5640_codec_name);

	if (!codec_dev)

		return -EPROBE_DEFER;



	priv->codec_dev = codec_dev;



	/* Must be called before register_card, also see declaration comment. */

	ret_val = byt_rt5640_add_codec_device_props(byt_rt5640_codec_name);

	ret_val = byt_rt5640_add_codec_device_props(codec_dev, priv);

	if (ret_val)

		return ret_val;

		goto err;



	log_quirks(&pdev->dev);
@@ -1509,7 +1510,7 @@ static int snd_byt_rt5640_mc_probe(struct platform_device *pdev) 
			 * for all other errors, including -EPROBE_DEFER

			 */

			if (ret_val != -ENOENT)

				return ret_val;

				goto err;

			byt_rt5640_quirk &= ~BYT_RT5640_MCLK_EN;

		}

	}
@@ -1553,7 +1554,7 @@ static int snd_byt_rt5640_mc_probe(struct platform_device *pdev) 
	ret_val = snd_soc_fixup_dai_links_platform_name(&byt_rt5640_card,

							platform_name);

	if (ret_val)

		return ret_val;

		goto err;



	sof_parent = snd_soc_acpi_sof_parent(&pdev->dev);
@@ -1575,10 +1576,23 @@ static int snd_byt_rt5640_mc_probe(struct platform_device *pdev) 
	if (ret_val) {

		dev_err(&pdev->dev, "devm_snd_soc_register_card failed %d\n",

			ret_val);

		return ret_val;

		goto err;

	}

	platform_set_drvdata(pdev, &byt_rt5640_card);

	return ret_val;



err:

	put_device(priv->codec_dev);

	return ret_val;

}



static int snd_byt_rt5640_mc_remove(struct platform_device *pdev)

{

	struct snd_soc_card *card = platform_get_drvdata(pdev);

	struct byt_rt5640_private *priv = snd_soc_card_get_drvdata(card);



	put_device(priv->codec_dev);

	return 0;

}



static struct platform_driver snd_byt_rt5640_mc_driver = {
@@ -1586,6 +1600,7 @@ static struct platform_driver snd_byt_rt5640_mc_driver = { 
		.name = "bytcr_rt5640",

	},

	.probe = snd_byt_rt5640_mc_probe,

	.remove = snd_byt_rt5640_mc_remove,

};



module_platform_driver(snd_byt_rt5640_mc_driver);

sound/soc/intel/boards/bytcr_rt5651.c

+24 −13
Original line number Diff line number Diff line
@@ -85,6 +85,7 @@ struct byt_rt5651_private { 
	struct gpio_desc *ext_amp_gpio;

	struct gpio_desc *hp_detect;

	struct snd_soc_jack jack;

	struct device *codec_dev;

};



static const struct acpi_gpio_mapping *byt_rt5651_gpios;
@@ -993,12 +994,12 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
		byt_rt5651_quirk = quirk_override;

	}



	priv->codec_dev = codec_dev;



	/* Must be called before register_card, also see declaration comment. */

	ret_val = byt_rt5651_add_codec_device_props(codec_dev);

	if (ret_val) {

		put_device(codec_dev);

		return ret_val;

	}

	if (ret_val)

		goto err;



	/* Cherry Trail devices use an external amplifier enable gpio */

	if (soc_intel_is_cht() && !byt_rt5651_gpios)
@@ -1022,8 +1023,7 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
					ret_val);

				fallthrough;

			case -EPROBE_DEFER:

				put_device(codec_dev);

				return ret_val;

				goto err;

			}

		}

		priv->hp_detect = devm_fwnode_gpiod_get(&pdev->dev,
@@ -1042,14 +1042,11 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
					ret_val);

				fallthrough;

			case -EPROBE_DEFER:

				put_device(codec_dev);

				return ret_val;

				goto err;

			}

		}

	}



	put_device(codec_dev);



	log_quirks(&pdev->dev);



	if ((byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2) ||
@@ -1073,7 +1070,7 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
			 * for all other errors, including -EPROBE_DEFER

			 */

			if (ret_val != -ENOENT)

				return ret_val;

				goto err;

			byt_rt5651_quirk &= ~BYT_RT5651_MCLK_EN;

		}

	}
@@ -1102,7 +1099,7 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
	ret_val = snd_soc_fixup_dai_links_platform_name(&byt_rt5651_card,

							platform_name);

	if (ret_val)

		return ret_val;

		goto err;



	sof_parent = snd_soc_acpi_sof_parent(&pdev->dev);
@@ -1124,10 +1121,23 @@ static int snd_byt_rt5651_mc_probe(struct platform_device *pdev) 
	if (ret_val) {

		dev_err(&pdev->dev, "devm_snd_soc_register_card failed %d\n",

			ret_val);

		return ret_val;

		goto err;

	}

	platform_set_drvdata(pdev, &byt_rt5651_card);

	return ret_val;



err:

	put_device(priv->codec_dev);

	return ret_val;

}



static int snd_byt_rt5651_mc_remove(struct platform_device *pdev)

{

	struct snd_soc_card *card = platform_get_drvdata(pdev);

	struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);



	put_device(priv->codec_dev);

	return 0;

}



static struct platform_driver snd_byt_rt5651_mc_driver = {
@@ -1135,6 +1145,7 @@ static struct platform_driver snd_byt_rt5651_mc_driver = { 
		.name = "bytcr_rt5651",

	},

	.probe = snd_byt_rt5651_mc_probe,

	.remove = snd_byt_rt5651_mc_remove,

};



module_platform_driver(snd_byt_rt5651_mc_driver);