Skip to contentSkip to conversation

ASoC: nau8315: add codec driver

PATCH In review David Lin 4 participants 12 messages Nov 2, 2020 – Nov 10, 2020

Subsystems (3)
lore
Share & tools
lore

David Lin

author
#0 lore raw

PATCH 1/1 ASoC: nau8315: add codec driver

Add codec driver for Nuvoton NAU8315.

---
 .../devicetree/bindings/sound/nau8315.txt     |  18 ++
 sound/soc/codecs/Kconfig                      |   5 +
 sound/soc/codecs/Makefile                     |   2 +
 sound/soc/codecs/nau8315.c                    | 166 ++++++++++++++++++
 4 files changed, 191 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/nau8315.txt
 create mode 100644 sound/soc/codecs/nau8315.c
Documentation/devicetree/bindings/sound/nau8315.txt new file +18 -0
new file mode 100644
index 000000000000..6eaec46f384c
@@ -0,0 +1,18 @@
+Nuvoton NAU8315 Mono Class-D Amplifier
+
+Required properties:
+- compatible   : "nuvoton,nau8315"
+
+Optional properties:
+- enable-gpios : GPIO specifier for the chip's device enable input(EN) pin.
+        If this option is not specified then driver does not manage
+        the pin state (e.g. chip is always on).
+
+Example:
+
+#include <dt-bindings/gpio/gpio.h>
+
+nau8315 {
+	compatible = "nuvoton,nau8315";
+	enable-gpios = <&gpio1 5 GPIO_ACTIVE_HIGH>;
+};
sound/soc/codecs/Kconfig +5 -0
index 5791b7056af6..2b6eceb3573c 100644
@@ -130,6 +130,7 @@ config SND_SOC_ALL_CODECS
 	imply SND_SOC_MT6358
 	imply SND_SOC_MT6359
 	imply SND_SOC_MT6660
+	imply SND_SOC_NAU8315
 	imply SND_SOC_NAU8540
 	imply SND_SOC_NAU8810
 	imply SND_SOC_NAU8822
@@ -1760,6 +1761,10 @@ config SND_SOC_MT6660
 	  Select N if you don't have MT6660 on board.
 	  Select M to build this as module.
 
+config SND_SOC_NAU8315
+	tristate "Nuvoton Technology Corporation NAU8315 CODEC"
+	depends on GPIOLIB
+
 config SND_SOC_NAU8540
        tristate "Nuvoton Technology Corporation NAU85L40 CODEC"
        depends on I2C
sound/soc/codecs/Makefile +2 -0
index 11ce98c25d6c..144d9256d4d5 100644
@@ -129,6 +129,7 @@ snd-soc-mt6351-objs := mt6351.o
 snd-soc-mt6358-objs := mt6358.o
 snd-soc-mt6359-objs := mt6359.o
 snd-soc-mt6660-objs := mt6660.o
+snd-soc-nau8315-objs := nau8315.o
 snd-soc-nau8540-objs := nau8540.o
 snd-soc-nau8810-objs := nau8810.o
 snd-soc-nau8822-objs := nau8822.o
@@ -438,6 +439,7 @@ obj-$(CONFIG_SND_SOC_MT6351)	+= snd-soc-mt6351.o
 obj-$(CONFIG_SND_SOC_MT6358)	+= snd-soc-mt6358.o
 obj-$(CONFIG_SND_SOC_MT6359)	+= snd-soc-mt6359.o
 obj-$(CONFIG_SND_SOC_MT6660)	+= snd-soc-mt6660.o
+obj-$(CONFIG_SND_SOC_NAU8315)   += snd-soc-nau8315.o
 obj-$(CONFIG_SND_SOC_NAU8540)   += snd-soc-nau8540.o
 obj-$(CONFIG_SND_SOC_NAU8810)   += snd-soc-nau8810.o
 obj-$(CONFIG_SND_SOC_NAU8822)   += snd-soc-nau8822.o
sound/soc/codecs/nau8315.c new file +166 -0

166 lines not on this page · raw message

Signature · 1 line
2.25.1
#1 lore raw
Quoted 14 lines
sound/soc/codecs/nau8315.c new file +13 -0
+struct nau8315_priv {
+	struct gpio_desc *enable;
+	int enpin_switch;
+};
+
+static int nau8315_daiops_trigger(struct snd_pcm_substream *substream,
+		int cmd, struct snd_soc_dai *dai)
+{
+	struct snd_soc_component *component = dai->component;
+	struct nau8315_priv *nau8315 =
+		snd_soc_component_get_drvdata(component);
+
+	if (!nau8315->enable)

sound/soc/codecs/nau8315.c line 47

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+		return 0;
+
+	switch (cmd) {
+	case SNDRV_PCM_TRIGGER_START:
+	case SNDRV_PCM_TRIGGER_RESUME:
+	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
+		if (nau8315->enpin_switch) {
+			gpiod_set_value(nau8315->enable, 1);
+			dev_dbg(component->dev, "set enable to 1");
+		}

I know the code is modeled after max98357a.c but I keep wondering if this enpin_switch state is actually useful for anything.

Is there actually a case where the trigger happens before the DAPM_POST_PMU event handled below [1]?

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+		break;
+	case SNDRV_PCM_TRIGGER_STOP:
+	case SNDRV_PCM_TRIGGER_SUSPEND:
+	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
+		gpiod_set_value(nau8315->enable, 0);
+		dev_dbg(component->dev, "set enable to 0");
+		break;
+	}
+
+	return 0;

sound/soc/codecs/nau8315.c line 67

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+}
+
+static int nau8315_enpin_event(struct snd_soc_dapm_widget *w,
+		struct snd_kcontrol *kcontrol, int event)
+{
+	struct snd_soc_component *component =
+		snd_soc_dapm_to_component(w->dapm);
+	struct nau8315_priv *nau8315 =
+		snd_soc_component_get_drvdata(component);
+

[1]

sound/soc/codecs/nau8315.c line 71

Quoted 4 lines
sound/soc/codecs/nau8315.c new file +4 -0
+	if (event & SND_SOC_DAPM_POST_PMU)
+		nau8315->enpin_switch = 1;
+	else if (event & SND_SOC_DAPM_POST_PMD)
+		nau8315->enpin_switch = 0;

And even if this variable was useful, for symmetry should it be PRE_PMU/POST_PMD?

Quoted 13 lines
sound/soc/codecs/nau8315.c new file +13 -0
+
+	return 0;
+}
+
+static const struct snd_soc_dapm_widget nau8315_dapm_widgets[] = {
+	SND_SOC_DAPM_OUTPUT("Speaker"),
+	SND_SOC_DAPM_OUT_DRV_E("EN_Pin", SND_SOC_NOPM, 0, 0, NULL, 0,
+			nau8315_enpin_event,
+			SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
+};
+
+static const struct snd_soc_dapm_route nau8315_dapm_routes[] = {
+	{"EN_Pin", NULL, "HiFi Playback"},

sound/soc/codecs/nau8315.c line 94

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+	{"Speaker", NULL, "EN_Pin"},
+};
+
+static const struct snd_soc_component_driver nau8315_component_driver = {
+	.dapm_widgets		= nau8315_dapm_widgets,
+	.num_dapm_widgets	= ARRAY_SIZE(nau8315_dapm_widgets),
+	.dapm_routes		= nau8315_dapm_routes,
+	.num_dapm_routes	= ARRAY_SIZE(nau8315_dapm_routes),
+	.idle_bias_on		= 1,
+	.use_pmdown_time	= 1,

is this necessary? This has the side effect of powering-down immediately instead of after a delay.

Quoted 3 lines
sound/soc/codecs/nau8315.c new file +3 -0
+	.endianness		= 1,
+	.non_legacy_dai_naming	= 1,
+};
author
#2 lore raw
Quoted 28 lines · Pierre-Louis Bossart
Quoted 14 lines
sound/soc/codecs/nau8315.c new file +13 -0
+struct nau8315_priv {
+    struct gpio_desc *enable;
+    int enpin_switch;
+};
+
+static int nau8315_daiops_trigger(struct snd_pcm_substream *substream,
+        int cmd, struct snd_soc_dai *dai)
+{
+    struct snd_soc_component *component = dai->component;
+    struct nau8315_priv *nau8315 =
+        snd_soc_component_get_drvdata(component);
+
+    if (!nau8315->enable)

sound/soc/codecs/nau8315.c line 47

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+        return 0;
+
+    switch (cmd) {
+    case SNDRV_PCM_TRIGGER_START:
+    case SNDRV_PCM_TRIGGER_RESUME:
+    case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
+        if (nau8315->enpin_switch) {
+            gpiod_set_value(nau8315->enable, 1);
+            dev_dbg(component->dev, "set enable to 1");
+        }

I know the code is modeled after max98357a.c but I keep wondering if this enpin_switch state is actually useful for anything.

Quoted 3 lines

Is there actually a case where the trigger happens before the DAPM_POST_PMU event handled below [1]?

Yes. Currently, I set event on DAPM just with SND_SOC_DAPM_POST_PMU or SND_SOC_DAPM_POST_PMD, so these two specified events will be caught.

If I set SND_SOC_DAPM_PRE_PMU event, it can be caught, too.

Quoted 23 lines
Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+        break;
+    case SNDRV_PCM_TRIGGER_STOP:
+    case SNDRV_PCM_TRIGGER_SUSPEND:
+    case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
+        gpiod_set_value(nau8315->enable, 0);
+        dev_dbg(component->dev, "set enable to 0");
+        break;
+    }
+
+    return 0;

sound/soc/codecs/nau8315.c line 67

Quoted 10 lines
sound/soc/codecs/nau8315.c new file +10 -0
+}
+
+static int nau8315_enpin_event(struct snd_soc_dapm_widget *w,
+        struct snd_kcontrol *kcontrol, int event)
+{
+    struct snd_soc_component *component =
+        snd_soc_dapm_to_component(w->dapm);
+    struct nau8315_priv *nau8315 =
+        snd_soc_component_get_drvdata(component);
+

[1]

Quoted 8 lines

sound/soc/codecs/nau8315.c line 71

Quoted 4 lines
sound/soc/codecs/nau8315.c new file +4 -0
+    if (event & SND_SOC_DAPM_POST_PMU)
+        nau8315->enpin_switch = 1;
+    else if (event & SND_SOC_DAPM_POST_PMD)
+        nau8315->enpin_switch = 0;

And even if this variable was useful, for symmetry should it be PRE_PMU/POST_PMD?

Yes, I agree with your opinion.

From the above description, I suppose you might want to point whether the dapm widget of EN_PIN is redundant, right? That's a reason the physical hardware pin is set to high/low in trigger function point of snd_soc_dai_ops, it always occurred after dapm event.
If yes, from my current platform of verification, even if the dapm widget of EN_PIN is removed, the result of sound output is same yet. Maybe the first version, I should submit a simpler version.

Quoted 19 lines
Quoted 19 lines
sound/soc/codecs/nau8315.c new file +17 -0
+
+    return 0;
+}
+
+static const struct snd_soc_dapm_widget nau8315_dapm_widgets[] = {
+    SND_SOC_DAPM_OUTPUT("Speaker"),
+    SND_SOC_DAPM_OUT_DRV_E("EN_Pin", SND_SOC_NOPM, 0, 0, NULL, 0,
+            nau8315_enpin_event,
+            SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
+};
+
+static const struct snd_soc_dapm_route nau8315_dapm_routes[] = {
+    {"EN_Pin", NULL, "HiFi Playback"},
+    {"Speaker", NULL, "EN_Pin"},
+};
+
+static const struct snd_soc_component_driver

nau8315_component_driver = {
+ .dapm_widgets = nau8315_dapm_widgets,

Quoted 8 lines

sound/soc/codecs/nau8315.c line 94

Quoted 5 lines
sound/soc/codecs/nau8315.c new file +5 -0
+    .num_dapm_widgets    = ARRAY_SIZE(nau8315_dapm_widgets),
+    .dapm_routes        = nau8315_dapm_routes,
+    .num_dapm_routes    = ARRAY_SIZE(nau8315_dapm_routes),
+    .idle_bias_on        = 1,
+    .use_pmdown_time    = 1,

is this necessary? This has the side effect of powering-down immediately instead of after a delay.

Yes, I follow most of drivers to use this flag.

Quoted 4 lines

sound/soc/codecs/nau8315.c line 97

Quoted 4 lines
sound/soc/codecs/nau8315.c new file +3 -0
+    .endianness        = 1,
+    .non_legacy_dai_naming    = 1,
+};

________________________________
________________________________
The privileged confidential information contained in this email is intended for use only by the addressees as indicated by the original sender of this email. If you are not the addressee indicated in this email or are not responsible for delivery of the email to such a person, please kindly reply to the sender indicating this fact and delete all copies of it from your computer and network server immediately. Your cooperation is highly appreciated. It is advised that any unauthorized use of confidential information of Nuvoton is strictly prohibited; and any information in this email irrelevant to the official business of Nuvoton shall be deemed as neither given nor endorsed by Nuvoton.

#3 lore raw
Quoted 22 lines
Quoted 12 lines

sound/soc/codecs/nau8315.c line 67

Quoted 9 lines
sound/soc/codecs/nau8315.c new file +8 -0
+static int nau8315_enpin_event(struct snd_soc_dapm_widget *w,
+        struct snd_kcontrol *kcontrol, int event)
+{
+    struct snd_soc_component *component =
+        snd_soc_dapm_to_component(w->dapm);
+    struct nau8315_priv *nau8315 =
+        snd_soc_component_get_drvdata(component);
+

[1]

Quoted 8 lines
Quoted 4 lines

+    if (event & SND_SOC_DAPM_POST_PMU)
+        nau8315->enpin_switch = 1;
+    else if (event & SND_SOC_DAPM_POST_PMD)
+        nau8315->enpin_switch = 0;

And even if this variable was useful, for symmetry should it be PRE_PMU/POST_PMD?

Yes, I agree with your opinion.

Quoted 7 lines

From the above description, I suppose you might want to point whether
the dapm widget of EN_PIN is redundant, right? That's a reason the physical hardware pin is set to high/low in trigger function point of snd_soc_dai_ops, it always occurred after dapm event.
If yes, from my current platform of verification, even if the dapm widget of EN_PIN is removed, the result of sound output is same yet. Maybe the first version, I should submit a simpler version.

The model from the Max98357a seems to come from 128f825aeab79 (' ASoC: max98357a: move control of SD_MODE to DAPM')

It doesn't seem like this additional EN_PIN is useful at the codec level but may help with machine integration.

I still don't get the POST_PMU/POST_PMD. This was changed in 04a646ff5acaa by Tzung-Bi Shih @ Google, wondering if there is an explanation?

Not pushing back, just trying to get what makes sense for amplifiers.

#4 lore raw
Quoted 5 lines · Pierre-Louis Bossart

The model from the Max98357a seems to come from 128f825aeab79 ('
ASoC: max98357a: move control of SD_MODE to DAPM')

It doesn't seem like this additional EN_PIN is useful at the codec level but may help with machine integration.

We have a platform that max98357a shares the I2S with another codec. The software control here is for separating them. See the commit message of 128f825aeab79 ("ASoC: max98357a: move control of SD_MODE to DAPM") for more details.

Quoted 3 lines

I still don't get the POST_PMU/POST_PMD. This was changed in 04a646ff5acaa by Tzung-Bi Shih @ Google, wondering if there is an explanation?

There was a report for max98357a pop noise on rk3399-gru-kevin due to commit 128f825aeab79. Commit 04a646ff5acaa ("ASoC: max98357a: move control of SD_MODE back to DAI ops") fixes it. See
https://patchwork.kernel.org/project/alsa-devel/patch/[email protected]/#23502085.

There is no reason for the asymmetric POST_PMU/POST_PMD here. You should find that the sdmode_switch doesn't take effect immediately in the DAPM event. I guess I was trying something (e.g. turning on/off when the stream is opening) but failed. And I probably forgot to recover the DAPM events back to symmetric (to avoid confusing people).

If nau8315 doesn't share I2S with other components for now, it could be better to not introduce the software mute control.

maintainer
#5 lore raw
Quoted 2 lines · Tzung-Bi Shih

If nau8315 doesn't share I2S with other components for now, it could be better to not introduce the software mute control.

The mute callback is there because there's some controllers that don't start up cleanly and end up outputing glitches (for example due to not being able to flush their FIFOs) - keeping the CODEC muted until after the I2S is running covers those glitches.

#6 lore raw
Quoted 9 lines · Mark Brown
Quoted 2 lines · Tzung-Bi Shih

If nau8315 doesn't share I2S with other components for now, it could be better to not introduce the software mute control.

The mute callback is there because there's some controllers that don't start up cleanly and end up outputing glitches (for example due to not being able to flush their FIFOs) - keeping the CODEC muted until after the I2S is running covers those glitches.

Thanks for explaining those dependencies. The code looks good to me:

author
#7 lore raw
Quoted 8 lines · Pierre-Louis Bossart
Quoted 5 lines · Mark Brown
Quoted 2 lines · Tzung-Bi Shih

If nau8315 doesn't share I2S with other components for now, it could be better to not introduce the software mute control.

Quoted 9 lines
Quoted 4 lines

The mute callback is there because there's some controllers that don't start up cleanly and end up outputing glitches (for example due to not being able to flush their FIFOs) - keeping the CODEC muted until after the I2S is running covers those glitches.

Thanks for explaining those dependencies. The code looks good to me:

Thanks for your comments. However, I also agree the opinion from
Tzung-Bi Shih @ Google.
May I confirm whether I should keep this patch, and remove dapm widget
of EN_PIN next patch?
________________________________
________________________________
The privileged confidential information contained in this email is intended for use only by the addressees as indicated by the original sender of this email. If you are not the addressee indicated in this email or are not responsible for delivery of the email to such a person, please kindly reply to the sender indicating this fact and delete all copies of it from your computer and network server immediately. Your cooperation is highly appreciated. It is advised that any unauthorized use of confidential information of Nuvoton is strictly prohibited; and any information in this email irrelevant to the official business of Nuvoton shall be deemed as neither given nor endorsed by Nuvoton.

maintainer
#8 lore raw
Quoted 4 lines · On Fri, Nov 06, 2020 at 11:31:36AM +0800, CTLIN0 wrote:

Thanks for your comments. However, I also agree the opinion from Tzung-Bi Shih @ Google.
May I confirm whether I should keep this patch, and remove dapm widget of EN_PIN next patch?

Please send incremental patches on top of this one with any changes.

#9 lore raw
Quoted 8 lines · Mark Brown
Quoted 4 lines · On Fri, Nov 06, 2020 at 11:31:36AM +0800, CTLIN0 wrote:

Thanks for your comments. However, I also agree the opinion from Tzung-Bi Shih @ Google.
May I confirm whether I should keep this patch, and remove dapm widget of EN_PIN next patch?

Please send incremental patches on top of this one with any changes.

EN_PIN is not strictly required but as discussed it provides additional flexibility for machine drivers, so probably better to keep it?

author
#10 lore raw

PATCH 2/2 ASoC: nau8315: revise the power event of EN_PIN dapm widget for symmetry

In reply to David Lin

This patch is to revise the power event of EN_PIN dapm widget for symmetry.

---
 sound/soc/codecs/nau8315.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
sound/soc/codecs/nau8315.c +2 -2
index e6bc5c0a5036..2b66e3f7a8b7 100644
@@ -65,7 +65,7 @@ static int nau8315_enpin_event(struct snd_soc_dapm_widget *w,
 	struct nau8315_priv *nau8315 =
 		snd_soc_component_get_drvdata(component);
 
-	if (event & SND_SOC_DAPM_POST_PMU)
+	if (event & SND_SOC_DAPM_PRE_PMU)
 		nau8315->enpin_switch = 1;
 	else if (event & SND_SOC_DAPM_POST_PMD)
 		nau8315->enpin_switch = 0;
@@ -77,7 +77,7 @@ static const struct snd_soc_dapm_widget nau8315_dapm_widgets[] = {
 	SND_SOC_DAPM_OUTPUT("Speaker"),
 	SND_SOC_DAPM_OUT_DRV_E("EN_Pin", SND_SOC_NOPM, 0, 0, NULL, 0,
 			nau8315_enpin_event,
-			SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
+			SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
 };
 
 static const struct snd_soc_dapm_route nau8315_dapm_routes[] = {
Signature · 1 line
2.25.1
maintainer
#11 lore raw
In reply to David Lin
Quoted 1 line · David Lin

Add codec driver for Nuvoton NAU8315.

Applied to

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

Thanks!

[1/2] ASoC: nau8315: add codec driver

      commit: 4d1a9952dda649284413e6ff12b81db3a2bc4115
[2/2] ASoC: nau8315: revise the power event of EN_PIN dapm widget for symmetry
      commit: 9352d45a6e4588b8c7ddded871e08d89e0e6b79f

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