ASoC: clarify that SND_SOC_IMX_SGTL5000 is the old driver

Message ID 20230303093410.357621-1-luca.ceresoli@bootlin.com
State New
Headers
Series ASoC: clarify that SND_SOC_IMX_SGTL5000 is the old driver |

Commit Message

Luca Ceresoli March 3, 2023, 9:34 a.m. UTC
  Both SND_SOC_IMX_SGTL5000 and SND_SOC_FSL_ASOC_CARD implement the
fsl,imx-audio-sgtl5000 compatible string, which is confusing. It took a
little research to find out that the latter is much newer and it is
supposed to be the preferred choice since several years.

Add a clarification note to avoid wasting time for future readers.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>

---

Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Takashi Iwai <tiwai@suse.com>
Cc: Viorel Suman <viorel.suman@nxp.com>
Cc: Shengjiu Wang <shengjiu.wang@nxp.com>
Cc: alsa-devel@alsa-project.org
Cc: linux-kernel@vger.kernel.org
---
 sound/soc/fsl/Kconfig | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Mark Brown March 3, 2023, 12:43 p.m. UTC | #1
On Fri, Mar 03, 2023 at 10:34:10AM +0100, Luca Ceresoli wrote:
> Both SND_SOC_IMX_SGTL5000 and SND_SOC_FSL_ASOC_CARD implement the
> fsl,imx-audio-sgtl5000 compatible string, which is confusing. It took a
> little research to find out that the latter is much newer and it is
> supposed to be the preferred choice since several years.
> 
> Add a clarification note to avoid wasting time for future readers.

Perhaps it's time to just retire the old driver?
  
Mark Brown March 6, 2023, 12:45 p.m. UTC | #2
On Fri, 03 Mar 2023 10:34:10 +0100, Luca Ceresoli wrote:
> Both SND_SOC_IMX_SGTL5000 and SND_SOC_FSL_ASOC_CARD implement the
> fsl,imx-audio-sgtl5000 compatible string, which is confusing. It took a
> little research to find out that the latter is much newer and it is
> supposed to be the preferred choice since several years.
> 
> Add a clarification note to avoid wasting time for future readers.
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoC: clarify that SND_SOC_IMX_SGTL5000 is the old driver
      commit: 03d0f97fdb45c99cf6f808832db8bd5534e22374

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark
  

Patch

diff --git a/sound/soc/fsl/Kconfig b/sound/soc/fsl/Kconfig
index 614eceda6b9e..33b67db8794e 100644
--- a/sound/soc/fsl/Kconfig
+++ b/sound/soc/fsl/Kconfig
@@ -294,6 +294,10 @@  config SND_SOC_IMX_SGTL5000
 	  Say Y if you want to add support for SoC audio on an i.MX board with
 	  a sgtl5000 codec.
 
+	  Note that this is an old driver. Consider enabling
+	  SND_SOC_FSL_ASOC_CARD and SND_SOC_SGTL5000 to use the newer
+	  driver.
+
 config SND_SOC_IMX_SPDIF
 	tristate "SoC Audio support for i.MX boards with S/PDIF"
 	select SND_SOC_IMX_PCM_DMA