[PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[John Hsu]

The driver makes the crosstalk funciton disabled by default
which can simplify the codec function. The platform may not
need this funciton and reduce the potential risk. Therefore,
We change the property "nuvoton,crosstalk-bypass" to
"nuvoton,crosstalk-enable". The crosstalk measurement is enabled
if the property is set. Otherwise, it is disabled. Besides,
add more condition in the entry point of the crosstalk sequence
to disable the function completely.

Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
---
 .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
 sound/soc/codecs/nau8825.c                         | 23 ++++++++++++----------
 sound/soc/codecs/nau8825.h                         |  2 +-
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt b/Documentation/devicetree/bindings/sound/nau8825.txt
index 2f5e973..d16d968 100644
--- a/Documentation/devicetree/bindings/sound/nau8825.txt
+++ b/Documentation/devicetree/bindings/sound/nau8825.txt
@@ -69,7 +69,7 @@ Optional properties:
   - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
   - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
 
-  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
+  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
 
   - clocks: list of phandle and clock specifier pairs according to common clock bindings for the
       clocks described in clock-names
@@ -98,7 +98,7 @@ Example:
       nuvoton,short-key-debounce = <2>;
       nuvoton,jack-insert-debounce = <7>;
       nuvoton,jack-eject-debounce = <7>;
-      nuvoton,crosstalk-bypass;
+      nuvoton,crosstalk-enable;
 
       clock-names = "mclk";
       clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
index 714ce17..d3c1a02 100644
--- a/sound/soc/codecs/nau8825.c
+++ b/sound/soc/codecs/nau8825.c
@@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct *work)
 
 static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
 {
-	/* If the xtalk_protect is true, that means the process is still
-	 * on going. The driver forces to cancel the cross talk task and
+	/* If the crosstalk is eanbled and the process is on going,
+	 * the driver forces to cancel the crosstalk task and
 	 * restores the configuration to original status.
 	 */
-	if (nau8825->xtalk_protect) {
+	if (nau8825->xtalk_enable && nau8825->xtalk_state !=
+		NAU8825_XTALK_DONE) {
 		cancel_work_sync(&nau8825->xtalk_work);
 		nau8825_xtalk_clean(nau8825);
 	}
@@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 	} else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
 		if (nau8825_is_jack_inserted(regmap)) {
 			event |= nau8825_jack_insert(nau8825);
-			if (!nau8825->xtalk_bypass && !nau8825->high_imped) {
+			if (nau8825->xtalk_enable && !nau8825->high_imped) {
 				/* Apply the cross talk suppression in the
 				 * headset without high impedance.
 				 */
@@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 			nau8825->xtalk_event_mask = event_mask;
 		}
 	} else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
-		schedule_work(&nau8825->xtalk_work);
-		clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
+		if (nau8825->xtalk_enable) {
+			schedule_work(&nau8825->xtalk_work);
+			clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
+		}
 	} else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
 		NAU8825_JACK_INSERTION_DETECTED) {
 		/* One more step to check GPIO status directly. Thus, the
@@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct nau8825 *nau8825)
 			nau8825->jack_insert_debounce);
 	dev_dbg(dev, "jack-eject-debounce:  %d\n",
 			nau8825->jack_eject_debounce);
-	dev_dbg(dev, "crosstalk-bypass:     %d\n",
-			nau8825->xtalk_bypass);
+	dev_dbg(dev, "crosstalk-enable:     %d\n",
+			nau8825->xtalk_enable);
 }
 
 static int nau8825_read_device_properties(struct device *dev,
@@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct device *dev,
 		&nau8825->jack_eject_debounce);
 	if (ret)
 		nau8825->jack_eject_debounce = 0;
-	nau8825->xtalk_bypass = device_property_read_bool(dev,
-		"nuvoton,crosstalk-bypass");
+	nau8825->xtalk_enable = device_property_read_bool(dev,
+		"nuvoton,crosstalk-enable");
 
 	nau8825->mclk = devm_clk_get(dev, "mclk");
 	if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
index 8aee5c86..199d6ea 100644
--- a/sound/soc/codecs/nau8825.h
+++ b/sound/soc/codecs/nau8825.h
@@ -476,7 +476,7 @@ struct nau8825 {
 	int xtalk_event_mask;
 	bool xtalk_protect;
 	int imp_rms[NAU8825_XTALK_IMM];
-	int xtalk_bypass;
+	int xtalk_enable;
 };
 
 int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
-- 
2.6.4

[PATCH 2/2] ASoC: nau8825: improve crosstalk measurement protection

[John Hsu]

The sequence of crosstalk measurement is not robust. The driver
add more protections to make it stronger. The improvements as follows:
(1)Give backup table the default value. The values are the same
with the default of hardware registers. The impact will decline
once restoring the backup table in the wrong way.
(2)Add xtalk_baktab_initialized flag. The flag can keep the
initiation status of backup table. It helps to backup and restore
the backup-table correctly.
(3)Add cancel parameter in the restore function. The volume ramping
should do in crosstalk DONE state only. Otherwise, the delay action
is not allowed because the restore may happen during the jack
eject interruption.
(4)Add xtalk_protect condition check before scheduling work in ISR.
It makes sure the semaphore hold during the crosstalk measurement.
The sequence is still under protection from playback.

Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
---
 sound/soc/codecs/nau8825.c | 45 +++++++++++++++++++++++++++++++--------------
 sound/soc/codecs/nau8825.h |  1 +
 2 files changed, 32 insertions(+), 14 deletions(-)

diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
index d3c1a02..e696f6c 100644
--- a/sound/soc/codecs/nau8825.c
+++ b/sound/soc/codecs/nau8825.c
@@ -194,10 +194,10 @@ static const struct reg_default nau8825_reg_defaults[] = {
 
 /* register backup table when cross talk detection */
 static struct reg_default nau8825_xtalk_baktab[] = {
-	{ NAU8825_REG_ADC_DGAIN_CTRL, 0 },
+	{ NAU8825_REG_ADC_DGAIN_CTRL, 0x00cf },
 	{ NAU8825_REG_HSVOL_CTRL, 0 },
-	{ NAU8825_REG_DACL_CTRL, 0 },
-	{ NAU8825_REG_DACR_CTRL, 0 },
+	{ NAU8825_REG_DACL_CTRL, 0x00cf },
+	{ NAU8825_REG_DACR_CTRL, 0x02cf },
 };
 
 static const unsigned short logtable[256] = {
@@ -454,22 +454,32 @@ static void nau8825_xtalk_backup(struct nau8825 *nau8825)
 {
 	int i;
 
+	if (nau8825->xtalk_baktab_initialized)
+		return;
+
 	/* Backup some register values to backup table */
 	for (i = 0; i < ARRAY_SIZE(nau8825_xtalk_baktab); i++)
 		regmap_read(nau8825->regmap, nau8825_xtalk_baktab[i].reg,
 				&nau8825_xtalk_baktab[i].def);
+
+	nau8825->xtalk_baktab_initialized = true;
 }
 
-static void nau8825_xtalk_restore(struct nau8825 *nau8825)
+static void nau8825_xtalk_restore(struct nau8825 *nau8825, bool cause_cancel)
 {
 	int i, volume;
 
+	if (!nau8825->xtalk_baktab_initialized)
+		return;
+
 	/* Restore register values from backup table; When the driver restores
-	 * the headphone volumem, it needs recover to original level gradually
-	 * with 3dB per step for less pop noise.
+	 * the headphone volume in XTALK_DONE state, it needs recover to
+	 * original level gradually with 3dB per step for less pop noise.
+	 * Otherwise, the restore should do ASAP.
 	 */
 	for (i = 0; i < ARRAY_SIZE(nau8825_xtalk_baktab); i++) {
-		if (nau8825_xtalk_baktab[i].reg == NAU8825_REG_HSVOL_CTRL) {
+		if (!cause_cancel && nau8825_xtalk_baktab[i].reg ==
+			NAU8825_REG_HSVOL_CTRL) {
 			/* Ramping up the volume change to reduce pop noise */
 			volume = nau8825_xtalk_baktab[i].def &
 				NAU8825_HPR_VOL_MASK;
@@ -479,6 +489,8 @@ static void nau8825_xtalk_restore(struct nau8825 *nau8825)
 		regmap_write(nau8825->regmap, nau8825_xtalk_baktab[i].reg,
 				nau8825_xtalk_baktab[i].def);
 	}
+
+	nau8825->xtalk_baktab_initialized = false;
 }
 
 static void nau8825_xtalk_prepare_dac(struct nau8825 *nau8825)
@@ -644,7 +656,7 @@ static void nau8825_xtalk_clean_adc(struct nau8825 *nau8825)
 		NAU8825_POWERUP_ADCL | NAU8825_ADC_VREFSEL_MASK, 0);
 }
 
-static void nau8825_xtalk_clean(struct nau8825 *nau8825)
+static void nau8825_xtalk_clean(struct nau8825 *nau8825, bool cause_cancel)
 {
 	/* Enable internal VCO needed for interruptions */
 	nau8825_configure_sysclk(nau8825, NAU8825_CLK_INTERNAL, 0);
@@ -660,7 +672,7 @@ static void nau8825_xtalk_clean(struct nau8825 *nau8825)
 		NAU8825_I2S_MS_MASK | NAU8825_I2S_LRC_DIV_MASK |
 		NAU8825_I2S_BLK_DIV_MASK, NAU8825_I2S_MS_SLAVE);
 	/* Restore value of specific register for cross talk */
-	nau8825_xtalk_restore(nau8825);
+	nau8825_xtalk_restore(nau8825, cause_cancel);
 }
 
 static void nau8825_xtalk_imm_start(struct nau8825 *nau8825, int vol)
@@ -779,7 +791,7 @@ static void nau8825_xtalk_measure(struct nau8825 *nau8825)
 		dev_dbg(nau8825->dev, "cross talk sidetone: %x\n", sidetone);
 		regmap_write(nau8825->regmap, NAU8825_REG_DAC_DGAIN_CTRL,
 					(sidetone << 8) | sidetone);
-		nau8825_xtalk_clean(nau8825);
+		nau8825_xtalk_clean(nau8825, false);
 		nau8825->xtalk_state = NAU8825_XTALK_DONE;
 		break;
 	default:
@@ -822,7 +834,7 @@ static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
 	if (nau8825->xtalk_enable && nau8825->xtalk_state !=
 		NAU8825_XTALK_DONE) {
 		cancel_work_sync(&nau8825->xtalk_work);
-		nau8825_xtalk_clean(nau8825);
+		nau8825_xtalk_clean(nau8825, true);
 	}
 	/* Reset parameters for cross talk suppression function */
 	nau8825_sema_reset(nau8825);
@@ -1705,8 +1717,11 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 						nau8825->xtalk_protect = false;
 				}
 				/* Startup cross talk detection process */
-				nau8825->xtalk_state = NAU8825_XTALK_PREPARE;
-				schedule_work(&nau8825->xtalk_work);
+				if (nau8825->xtalk_protect) {
+					nau8825->xtalk_state =
+						NAU8825_XTALK_PREPARE;
+					schedule_work(&nau8825->xtalk_work);
+				}
 			} else {
 				/* The cross talk suppression shouldn't apply
 				 * in the headset with high impedance. Thus,
@@ -1733,7 +1748,8 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 			nau8825->xtalk_event_mask = event_mask;
 		}
 	} else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
-		if (nau8825->xtalk_enable) {
+		/* crosstalk detection enable and process on going */
+		if (nau8825->xtalk_enable && nau8825->xtalk_protect) {
 			schedule_work(&nau8825->xtalk_work);
 			clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
 		}
@@ -2571,6 +2587,7 @@ static int nau8825_i2c_probe(struct i2c_client *i2c,
 	 */
 	nau8825->xtalk_state = NAU8825_XTALK_DONE;
 	nau8825->xtalk_protect = false;
+	nau8825->xtalk_baktab_initialized = false;
 	sema_init(&nau8825->xtalk_sem, 1);
 	INIT_WORK(&nau8825->xtalk_work, nau8825_xtalk_work);
 
diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
index 199d6ea..f7e7321 100644
--- a/sound/soc/codecs/nau8825.h
+++ b/sound/soc/codecs/nau8825.h
@@ -477,6 +477,7 @@ struct nau8825 {
 	bool xtalk_protect;
 	int imp_rms[NAU8825_XTALK_IMM];
 	int xtalk_enable;
+	bool xtalk_baktab_initialized; /* True if initialized. */
 };
 
 int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
-- 
2.6.4

Re: [PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[Wu-Cheng Li (李務誠)]

On Fri, Nov 24, 2017 at 6:08 PM, John Hsu <KCHSU0@nuvoton.com> wrote:
> The driver makes the crosstalk funciton disabled by default
> which can simplify the codec function. The platform may not
> need this funciton and reduce the potential risk. Therefore,
> We change the property "nuvoton,crosstalk-bypass" to
> "nuvoton,crosstalk-enable". The crosstalk measurement is enabled
> if the property is set. Otherwise, it is disabled. Besides,
> add more condition in the entry point of the crosstalk sequence
> to disable the function completely.
>
> Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
> ---
>  .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
>  sound/soc/codecs/nau8825.c                         | 23 ++++++++++++----------
>  sound/soc/codecs/nau8825.h                         |  2 +-
>  3 files changed, 16 insertions(+), 13 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt b/Documentation/devicetree/bindings/sound/nau8825.txt
> index 2f5e973..d16d968 100644
> --- a/Documentation/devicetree/bindings/sound/nau8825.txt
> +++ b/Documentation/devicetree/bindings/sound/nau8825.txt
> @@ -69,7 +69,7 @@ Optional properties:
>    - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
>    - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
>
> -  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
> +  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
>
>    - clocks: list of phandle and clock specifier pairs according to common clock bindings for the
>        clocks described in clock-names
> @@ -98,7 +98,7 @@ Example:
>        nuvoton,short-key-debounce = <2>;
>        nuvoton,jack-insert-debounce = <7>;
>        nuvoton,jack-eject-debounce = <7>;
> -      nuvoton,crosstalk-bypass;
> +      nuvoton,crosstalk-enable;
>
>        clock-names = "mclk";
>        clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
> diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
> index 714ce17..d3c1a02 100644
> --- a/sound/soc/codecs/nau8825.c
> +++ b/sound/soc/codecs/nau8825.c
> @@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct *work)
>
>  static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
>  {
> -       /* If the xtalk_protect is true, that means the process is still
> -        * on going. The driver forces to cancel the cross talk task and
> +       /* If the crosstalk is eanbled and the process is on going,

s/eanbled/enabled/

> +        * the driver forces to cancel the crosstalk task and
>          * restores the configuration to original status.
>          */
> -       if (nau8825->xtalk_protect) {
> +       if (nau8825->xtalk_enable && nau8825->xtalk_state !=
> +               NAU8825_XTALK_DONE) {
>                 cancel_work_sync(&nau8825->xtalk_work);
>                 nau8825_xtalk_clean(nau8825);
>         }
> @@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
>         } else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
>                 if (nau8825_is_jack_inserted(regmap)) {
>                         event |= nau8825_jack_insert(nau8825);
> -                       if (!nau8825->xtalk_bypass && !nau8825->high_imped) {
> +                       if (nau8825->xtalk_enable && !nau8825->high_imped) {
>                                 /* Apply the cross talk suppression in the
>                                  * headset without high impedance.
>                                  */
> @@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
>                         nau8825->xtalk_event_mask = event_mask;
>                 }
>         } else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
> -               schedule_work(&nau8825->xtalk_work);
> -               clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
> +               if (nau8825->xtalk_enable) {
> +                       schedule_work(&nau8825->xtalk_work);
> +                       clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
> +               }

Shouldn't we still set clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ if
crosstalk is disabled?
Otherwise, all active_irq will be disabled later in this function.

>         } else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
>                 NAU8825_JACK_INSERTION_DETECTED) {
>                 /* One more step to check GPIO status directly. Thus, the
> @@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct nau8825 *nau8825)
>                         nau8825->jack_insert_debounce);
>         dev_dbg(dev, "jack-eject-debounce:  %d\n",
>                         nau8825->jack_eject_debounce);
> -       dev_dbg(dev, "crosstalk-bypass:     %d\n",
> -                       nau8825->xtalk_bypass);
> +       dev_dbg(dev, "crosstalk-enable:     %d\n",
> +                       nau8825->xtalk_enable);
>  }
>
>  static int nau8825_read_device_properties(struct device *dev,
> @@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct device *dev,
>                 &nau8825->jack_eject_debounce);
>         if (ret)
>                 nau8825->jack_eject_debounce = 0;
> -       nau8825->xtalk_bypass = device_property_read_bool(dev,
> -               "nuvoton,crosstalk-bypass");
> +       nau8825->xtalk_enable = device_property_read_bool(dev,
> +               "nuvoton,crosstalk-enable");
>
>         nau8825->mclk = devm_clk_get(dev, "mclk");
>         if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
> diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
> index 8aee5c86..199d6ea 100644
> --- a/sound/soc/codecs/nau8825.h
> +++ b/sound/soc/codecs/nau8825.h
> @@ -476,7 +476,7 @@ struct nau8825 {
>         int xtalk_event_mask;
>         bool xtalk_protect;
>         int imp_rms[NAU8825_XTALK_IMM];
> -       int xtalk_bypass;
> +       int xtalk_enable;
>  };
>
>  int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
> --
> 2.6.4
>

Re: [PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[John Hsu]

On 11/27/2017 2:12 PM, Wu-Cheng Li (李務誠) wrote:
> On Fri, Nov 24, 2017 at 6:08 PM, John Hsu <KCHSU0@nuvoton.com> wrote:
>> The driver makes the crosstalk funciton disabled by default
>> which can simplify the codec function. The platform may not
>> need this funciton and reduce the potential risk. Therefore,
>> We change the property "nuvoton,crosstalk-bypass" to
>> "nuvoton,crosstalk-enable". The crosstalk measurement is enabled
>> if the property is set. Otherwise, it is disabled. Besides,
>> add more condition in the entry point of the crosstalk sequence
>> to disable the function completely.
>>
>> Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
>> ---
>>  .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
>>  sound/soc/codecs/nau8825.c                         | 23 ++++++++++++----------
>>  sound/soc/codecs/nau8825.h                         |  2 +-
>>  3 files changed, 16 insertions(+), 13 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt b/Documentation/devicetree/bindings/sound/nau8825.txt
>> index 2f5e973..d16d968 100644
>> --- a/Documentation/devicetree/bindings/sound/nau8825.txt
>> +++ b/Documentation/devicetree/bindings/sound/nau8825.txt
>> @@ -69,7 +69,7 @@ Optional properties:
>>    - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
>>    - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
>>
>> -  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
>> +  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
>>
>>    - clocks: list of phandle and clock specifier pairs according to common clock bindings for the
>>        clocks described in clock-names
>> @@ -98,7 +98,7 @@ Example:
>>        nuvoton,short-key-debounce = <2>;
>>        nuvoton,jack-insert-debounce = <7>;
>>        nuvoton,jack-eject-debounce = <7>;
>> -      nuvoton,crosstalk-bypass;
>> +      nuvoton,crosstalk-enable;
>>
>>        clock-names = "mclk";
>>        clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
>> diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
>> index 714ce17..d3c1a02 100644
>> --- a/sound/soc/codecs/nau8825.c
>> +++ b/sound/soc/codecs/nau8825.c
>> @@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct *work)
>>
>>  static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
>>  {
>> -       /* If the xtalk_protect is true, that means the process is still
>> -        * on going. The driver forces to cancel the cross talk task and
>> +       /* If the crosstalk is eanbled and the process is on going,
>
> s/eanbled/enabled/
>
>> +        * the driver forces to cancel the crosstalk task and
>>          * restores the configuration to original status.
>>          */
>> -       if (nau8825->xtalk_protect) {
>> +       if (nau8825->xtalk_enable && nau8825->xtalk_state !=
>> +               NAU8825_XTALK_DONE) {
>>                 cancel_work_sync(&nau8825->xtalk_work);
>>                 nau8825_xtalk_clean(nau8825);
>>         }
>> @@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
>>         } else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
>>                 if (nau8825_is_jack_inserted(regmap)) {
>>                         event |= nau8825_jack_insert(nau8825);
>> -                       if (!nau8825->xtalk_bypass && !nau8825->high_imped) {
>> +                       if (nau8825->xtalk_enable && !nau8825->high_imped) {
>>                                 /* Apply the cross talk suppression in the
>>                                  * headset without high impedance.
>>                                  */
>> @@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
>>                         nau8825->xtalk_event_mask = event_mask;
>>                 }
>>         } else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
>> -               schedule_work(&nau8825->xtalk_work);
>> -               clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>> +               if (nau8825->xtalk_enable) {
>> +                       schedule_work(&nau8825->xtalk_work);
>> +                       clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>> +               }
>
> Shouldn't we still set clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ if
> crosstalk is disabled?
> Otherwise, all active_irq will be disabled later in this function.
>

Actually, there is assignment about clear_irq before the end of ISR
as follows:
if (!clear_irq) clear_irq = active_irq;
The IRQ will still be cleared. Your comment is correct for the clear
semantic. But the IRQ will never happen if the crosstalk disabled,
because the IRQ is triggered in the crosstalk sequence.

>>         } else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
>>                 NAU8825_JACK_INSERTION_DETECTED) {
>>                 /* One more step to check GPIO status directly. Thus, the
>> @@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct nau8825 *nau8825)
>>                         nau8825->jack_insert_debounce);
>>         dev_dbg(dev, "jack-eject-debounce:  %d\n",
>>                         nau8825->jack_eject_debounce);
>> -       dev_dbg(dev, "crosstalk-bypass:     %d\n",
>> -                       nau8825->xtalk_bypass);
>> +       dev_dbg(dev, "crosstalk-enable:     %d\n",
>> +                       nau8825->xtalk_enable);
>>  }
>>
>>  static int nau8825_read_device_properties(struct device *dev,
>> @@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct device *dev,
>>                 &nau8825->jack_eject_debounce);
>>         if (ret)
>>                 nau8825->jack_eject_debounce = 0;
>> -       nau8825->xtalk_bypass = device_property_read_bool(dev,
>> -               "nuvoton,crosstalk-bypass");
>> +       nau8825->xtalk_enable = device_property_read_bool(dev,
>> +               "nuvoton,crosstalk-enable");
>>
>>         nau8825->mclk = devm_clk_get(dev, "mclk");
>>         if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
>> diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
>> index 8aee5c86..199d6ea 100644
>> --- a/sound/soc/codecs/nau8825.h
>> +++ b/sound/soc/codecs/nau8825.h
>> @@ -476,7 +476,7 @@ struct nau8825 {
>>         int xtalk_event_mask;
>>         bool xtalk_protect;
>>         int imp_rms[NAU8825_XTALK_IMM];
>> -       int xtalk_bypass;
>> +       int xtalk_enable;
>>  };
>>
>>  int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
>> --
>> 2.6.4
>>



===========================================================================================
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.
_______________________________________________
Alsa-devel mailing list
Alsa-devel@alsa-project.org
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

Re: [PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[Wu-Cheng Li (李務誠)]

On Tue, Nov 28, 2017 at 10:40 AM, John Hsu <KCHSU0@nuvoton.com> wrote:
> On 11/27/2017 2:12 PM, Wu-Cheng Li (李務誠) wrote:
>>
>> On Fri, Nov 24, 2017 at 6:08 PM, John Hsu <KCHSU0@nuvoton.com> wrote:
>>>
>>> The driver makes the crosstalk funciton disabled by default
>>> which can simplify the codec function. The platform may not
>>> need this funciton and reduce the potential risk. Therefore,
>>> We change the property "nuvoton,crosstalk-bypass" to
>>> "nuvoton,crosstalk-enable". The crosstalk measurement is enabled
>>> if the property is set. Otherwise, it is disabled. Besides,
>>> add more condition in the entry point of the crosstalk sequence
>>> to disable the function completely.
>>>
>>> Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
>>> ---
>>>  .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
>>>  sound/soc/codecs/nau8825.c                         | 23
>>> ++++++++++++----------
>>>  sound/soc/codecs/nau8825.h                         |  2 +-
>>>  3 files changed, 16 insertions(+), 13 deletions(-)
>>>
>>> diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt
>>> b/Documentation/devicetree/bindings/sound/nau8825.txt
>>> index 2f5e973..d16d968 100644
>>> --- a/Documentation/devicetree/bindings/sound/nau8825.txt
>>> +++ b/Documentation/devicetree/bindings/sound/nau8825.txt
>>> @@ -69,7 +69,7 @@ Optional properties:
>>>    - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce
>>> time to 2^(n+2) ms
>>>    - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce
>>> time to 2^(n+2) ms
>>>
>>> -  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
>>> +  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
>>>
>>>    - clocks: list of phandle and clock specifier pairs according to
>>> common clock bindings for the
>>>        clocks described in clock-names
>>> @@ -98,7 +98,7 @@ Example:
>>>        nuvoton,short-key-debounce = <2>;
>>>        nuvoton,jack-insert-debounce = <7>;
>>>        nuvoton,jack-eject-debounce = <7>;
>>> -      nuvoton,crosstalk-bypass;
>>> +      nuvoton,crosstalk-enable;
>>>
>>>        clock-names = "mclk";
>>>        clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
>>> diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
>>> index 714ce17..d3c1a02 100644
>>> --- a/sound/soc/codecs/nau8825.c
>>> +++ b/sound/soc/codecs/nau8825.c
>>> @@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct
>>> *work)
>>>
>>>  static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
>>>  {
>>> -       /* If the xtalk_protect is true, that means the process is still
>>> -        * on going. The driver forces to cancel the cross talk task and
>>> +       /* If the crosstalk is eanbled and the process is on going,
>>
>>
>> s/eanbled/enabled/
>>
>>> +        * the driver forces to cancel the crosstalk task and
>>>          * restores the configuration to original status.
>>>          */
>>> -       if (nau8825->xtalk_protect) {
>>> +       if (nau8825->xtalk_enable && nau8825->xtalk_state !=
>>> +               NAU8825_XTALK_DONE) {
>>>                 cancel_work_sync(&nau8825->xtalk_work);
>>>                 nau8825_xtalk_clean(nau8825);
>>>         }
>>> @@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void
>>> *data)
>>>         } else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
>>>                 if (nau8825_is_jack_inserted(regmap)) {
>>>                         event |= nau8825_jack_insert(nau8825);
>>> -                       if (!nau8825->xtalk_bypass &&
>>> !nau8825->high_imped) {
>>> +                       if (nau8825->xtalk_enable &&
>>> !nau8825->high_imped) {
>>>                                 /* Apply the cross talk suppression in
>>> the
>>>                                  * headset without high impedance.
>>>                                  */
>>> @@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void
>>> *data)
>>>                         nau8825->xtalk_event_mask = event_mask;
>>>                 }
>>>         } else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
>>> -               schedule_work(&nau8825->xtalk_work);
>>> -               clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>> +               if (nau8825->xtalk_enable) {
>>> +                       schedule_work(&nau8825->xtalk_work);
>>> +                       clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>> +               }
>>
>>
>> Shouldn't we still set clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ if
>> crosstalk is disabled?
>> Otherwise, all active_irq will be disabled later in this function.
>>
>
> Actually, there is assignment about clear_irq before the end of ISR
> as follows:
> if (!clear_irq) clear_irq = active_irq;
Right. But that will disable all other active IRQs. No? I thought you wanted to
only disable the IRQ that was handled.
> The IRQ will still be cleared. Your comment is correct for the clear
> semantic. But the IRQ will never happen if the crosstalk disabled,
> because the IRQ is triggered in the crosstalk sequence.
Theoretically IRQ should not happen if crosstalk is disabled. I think this check
can be used to prevent from a hardware bug.
>
>
>>>         } else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
>>>                 NAU8825_JACK_INSERTION_DETECTED) {
>>>                 /* One more step to check GPIO status directly. Thus, the
>>> @@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct
>>> nau8825 *nau8825)
>>>                         nau8825->jack_insert_debounce);
>>>         dev_dbg(dev, "jack-eject-debounce:  %d\n",
>>>                         nau8825->jack_eject_debounce);
>>> -       dev_dbg(dev, "crosstalk-bypass:     %d\n",
>>> -                       nau8825->xtalk_bypass);
>>> +       dev_dbg(dev, "crosstalk-enable:     %d\n",
>>> +                       nau8825->xtalk_enable);
>>>  }
>>>
>>>  static int nau8825_read_device_properties(struct device *dev,
>>> @@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct
>>> device *dev,
>>>                 &nau8825->jack_eject_debounce);
>>>         if (ret)
>>>                 nau8825->jack_eject_debounce = 0;
>>> -       nau8825->xtalk_bypass = device_property_read_bool(dev,
>>> -               "nuvoton,crosstalk-bypass");
>>> +       nau8825->xtalk_enable = device_property_read_bool(dev,
>>> +               "nuvoton,crosstalk-enable");
>>>
>>>         nau8825->mclk = devm_clk_get(dev, "mclk");
>>>         if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
>>> diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
>>> index 8aee5c86..199d6ea 100644
>>> --- a/sound/soc/codecs/nau8825.h
>>> +++ b/sound/soc/codecs/nau8825.h
>>> @@ -476,7 +476,7 @@ struct nau8825 {
>>>         int xtalk_event_mask;
>>>         bool xtalk_protect;
>>>         int imp_rms[NAU8825_XTALK_IMM];
>>> -       int xtalk_bypass;
>>> +       int xtalk_enable;
>>>  };
>>>
>>>  int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
>>> --
>>> 2.6.4
>>>
>
>
>
> ===========================================================================================
> 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.
_______________________________________________
Alsa-devel mailing list
Alsa-devel@alsa-project.org
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

Re: [PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[John Hsu]

On 11/28/2017 11:21 AM, Wu-Cheng Li (李務誠) wrote:
> On Tue, Nov 28, 2017 at 10:40 AM, John Hsu <KCHSU0@nuvoton.com> wrote:
>> On 11/27/2017 2:12 PM, Wu-Cheng Li (李務誠) wrote:
>>> On Fri, Nov 24, 2017 at 6:08 PM, John Hsu <KCHSU0@nuvoton.com> wrote:
>>>> The driver makes the crosstalk funciton disabled by default
>>>> which can simplify the codec function. The platform may not
>>>> need this funciton and reduce the potential risk. Therefore,
>>>> We change the property "nuvoton,crosstalk-bypass" to
>>>> "nuvoton,crosstalk-enable". The crosstalk measurement is enabled
>>>> if the property is set. Otherwise, it is disabled. Besides,
>>>> add more condition in the entry point of the crosstalk sequence
>>>> to disable the function completely.
>>>>
>>>> Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
>>>> ---
>>>>  .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
>>>>  sound/soc/codecs/nau8825.c                         | 23
>>>> ++++++++++++----------
>>>>  sound/soc/codecs/nau8825.h                         |  2 +-
>>>>  3 files changed, 16 insertions(+), 13 deletions(-)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt
>>>> b/Documentation/devicetree/bindings/sound/nau8825.txt
>>>> index 2f5e973..d16d968 100644
>>>> --- a/Documentation/devicetree/bindings/sound/nau8825.txt
>>>> +++ b/Documentation/devicetree/bindings/sound/nau8825.txt
>>>> @@ -69,7 +69,7 @@ Optional properties:
>>>>    - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce
>>>> time to 2^(n+2) ms
>>>>    - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce
>>>> time to 2^(n+2) ms
>>>>
>>>> -  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
>>>> +  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
>>>>
>>>>    - clocks: list of phandle and clock specifier pairs according to
>>>> common clock bindings for the
>>>>        clocks described in clock-names
>>>> @@ -98,7 +98,7 @@ Example:
>>>>        nuvoton,short-key-debounce = <2>;
>>>>        nuvoton,jack-insert-debounce = <7>;
>>>>        nuvoton,jack-eject-debounce = <7>;
>>>> -      nuvoton,crosstalk-bypass;
>>>> +      nuvoton,crosstalk-enable;
>>>>
>>>>        clock-names = "mclk";
>>>>        clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
>>>> diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
>>>> index 714ce17..d3c1a02 100644
>>>> --- a/sound/soc/codecs/nau8825.c
>>>> +++ b/sound/soc/codecs/nau8825.c
>>>> @@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct
>>>> *work)
>>>>
>>>>  static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
>>>>  {
>>>> -       /* If the xtalk_protect is true, that means the process is still
>>>> -        * on going. The driver forces to cancel the cross talk task and
>>>> +       /* If the crosstalk is eanbled and the process is on going,
>>>
>>> s/eanbled/enabled/
>>>
>>>> +        * the driver forces to cancel the crosstalk task and
>>>>          * restores the configuration to original status.
>>>>          */
>>>> -       if (nau8825->xtalk_protect) {
>>>> +       if (nau8825->xtalk_enable && nau8825->xtalk_state !=
>>>> +               NAU8825_XTALK_DONE) {
>>>>                 cancel_work_sync(&nau8825->xtalk_work);
>>>>                 nau8825_xtalk_clean(nau8825);
>>>>         }
>>>> @@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void
>>>> *data)
>>>>         } else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
>>>>                 if (nau8825_is_jack_inserted(regmap)) {
>>>>                         event |= nau8825_jack_insert(nau8825);
>>>> -                       if (!nau8825->xtalk_bypass &&
>>>> !nau8825->high_imped) {
>>>> +                       if (nau8825->xtalk_enable &&
>>>> !nau8825->high_imped) {
>>>>                                 /* Apply the cross talk suppression in
>>>> the
>>>>                                  * headset without high impedance.
>>>>                                  */
>>>> @@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void
>>>> *data)
>>>>                         nau8825->xtalk_event_mask = event_mask;
>>>>                 }
>>>>         } else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
>>>> -               schedule_work(&nau8825->xtalk_work);
>>>> -               clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>>> +               if (nau8825->xtalk_enable) {
>>>> +                       schedule_work(&nau8825->xtalk_work);
>>>> +                       clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>>> +               }
>>>
>>> Shouldn't we still set clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ if
>>> crosstalk is disabled?
>>> Otherwise, all active_irq will be disabled later in this function.
>>>
>> Actually, there is assignment about clear_irq before the end of ISR
>> as follows:
>> if (!clear_irq) clear_irq = active_irq;
> Right. But that will disable all other active IRQs. No? I thought you wanted to
> only disable the IRQ that was handled.

Yes, I do want to clear the IRQ that handed in this time. Whenever
the interruption happens, the ISR will read the IRQ status bitmaps,
and only one IRQ raised in each time. After it is cleared, the codec
just can monitor the next event and makes the active IRQs.

>> The IRQ will still be cleared. Your comment is correct for the clear
>> semantic. But the IRQ will never happen if the crosstalk disabled,
>> because the IRQ is triggered in the crosstalk sequence.
> Theoretically IRQ should not happen if crosstalk is disabled. I think this check
> can be used to prevent from a hardware bug.
>>
>>>>         } else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
>>>>                 NAU8825_JACK_INSERTION_DETECTED) {
>>>>                 /* One more step to check GPIO status directly. Thus, the
>>>> @@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct
>>>> nau8825 *nau8825)
>>>>                         nau8825->jack_insert_debounce);
>>>>         dev_dbg(dev, "jack-eject-debounce:  %d\n",
>>>>                         nau8825->jack_eject_debounce);
>>>> -       dev_dbg(dev, "crosstalk-bypass:     %d\n",
>>>> -                       nau8825->xtalk_bypass);
>>>> +       dev_dbg(dev, "crosstalk-enable:     %d\n",
>>>> +                       nau8825->xtalk_enable);
>>>>  }
>>>>
>>>>  static int nau8825_read_device_properties(struct device *dev,
>>>> @@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct
>>>> device *dev,
>>>>                 &nau8825->jack_eject_debounce);
>>>>         if (ret)
>>>>                 nau8825->jack_eject_debounce = 0;
>>>> -       nau8825->xtalk_bypass = device_property_read_bool(dev,
>>>> -               "nuvoton,crosstalk-bypass");
>>>> +       nau8825->xtalk_enable = device_property_read_bool(dev,
>>>> +               "nuvoton,crosstalk-enable");
>>>>
>>>>         nau8825->mclk = devm_clk_get(dev, "mclk");
>>>>         if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
>>>> diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
>>>> index 8aee5c86..199d6ea 100644
>>>> --- a/sound/soc/codecs/nau8825.h
>>>> +++ b/sound/soc/codecs/nau8825.h
>>>> @@ -476,7 +476,7 @@ struct nau8825 {
>>>>         int xtalk_event_mask;
>>>>         bool xtalk_protect;
>>>>         int imp_rms[NAU8825_XTALK_IMM];
>>>> -       int xtalk_bypass;
>>>> +       int xtalk_enable;
>>>>  };
>>>>
>>>>  int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
>>>> --
>>>> 2.6.4
>>>>
>>
>>
>> ===========================================================================================
>> 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.



===========================================================================================
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.
_______________________________________________
Alsa-devel mailing list
Alsa-devel@alsa-project.org
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

Re: [PATCH 1/2] ASoC: nau8825: disable crosstalk by default

[John Hsu]

On 11/28/2017 12:07 PM, John Hsu wrote:
> On 11/28/2017 11:21 AM, Wu-Cheng Li (李務誠) wrote:
>> On Tue, Nov 28, 2017 at 10:40 AM, John Hsu <KCHSU0@nuvoton.com> wrote:
>>> On 11/27/2017 2:12 PM, Wu-Cheng Li (李務誠) wrote:
>>>> On Fri, Nov 24, 2017 at 6:08 PM, John Hsu <KCHSU0@nuvoton.com> wrote:
>>>>> The driver makes the crosstalk funciton disabled by default
>>>>> which can simplify the codec function. The platform may not
>>>>> need this funciton and reduce the potential risk. Therefore,
>>>>> We change the property "nuvoton,crosstalk-bypass" to
>>>>> "nuvoton,crosstalk-enable". The crosstalk measurement is enabled
>>>>> if the property is set. Otherwise, it is disabled. Besides,
>>>>> add more condition in the entry point of the crosstalk sequence
>>>>> to disable the function completely.
>>>>>
>>>>> Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
>>>>> ---
>>>>>  .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
>>>>>  sound/soc/codecs/nau8825.c                         | 23
>>>>> ++++++++++++----------
>>>>>  sound/soc/codecs/nau8825.h                         |  2 +-
>>>>>  3 files changed, 16 insertions(+), 13 deletions(-)
>>>>>
>>>>> diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt
>>>>> b/Documentation/devicetree/bindings/sound/nau8825.txt
>>>>> index 2f5e973..d16d968 100644
>>>>> --- a/Documentation/devicetree/bindings/sound/nau8825.txt
>>>>> +++ b/Documentation/devicetree/bindings/sound/nau8825.txt
>>>>> @@ -69,7 +69,7 @@ Optional properties:
>>>>>    - nuvoton,jack-insert-debounce: number from 0 to 7 that sets
>>>>> debounce
>>>>> time to 2^(n+2) ms
>>>>>    - nuvoton,jack-eject-debounce: number from 0 to 7 that sets
>>>>> debounce
>>>>> time to 2^(n+2) ms
>>>>>
>>>>> -  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
>>>>> +  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
>>>>>
>>>>>    - clocks: list of phandle and clock specifier pairs according to
>>>>> common clock bindings for the
>>>>>        clocks described in clock-names
>>>>> @@ -98,7 +98,7 @@ Example:
>>>>>        nuvoton,short-key-debounce = <2>;
>>>>>        nuvoton,jack-insert-debounce = <7>;
>>>>>        nuvoton,jack-eject-debounce = <7>;
>>>>> -      nuvoton,crosstalk-bypass;
>>>>> +      nuvoton,crosstalk-enable;
>>>>>
>>>>>        clock-names = "mclk";
>>>>>        clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
>>>>> diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
>>>>> index 714ce17..d3c1a02 100644
>>>>> --- a/sound/soc/codecs/nau8825.c
>>>>> +++ b/sound/soc/codecs/nau8825.c
>>>>> @@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct
>>>>> work_struct
>>>>> *work)
>>>>>
>>>>>  static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
>>>>>  {
>>>>> -       /* If the xtalk_protect is true, that means the process is
>>>>> still
>>>>> -        * on going. The driver forces to cancel the cross talk
>>>>> task and
>>>>> +       /* If the crosstalk is eanbled and the process is on going,
>>>>
>>>> s/eanbled/enabled/
>>>>
>>>>> +        * the driver forces to cancel the crosstalk task and
>>>>>          * restores the configuration to original status.
>>>>>          */
>>>>> -       if (nau8825->xtalk_protect) {
>>>>> +       if (nau8825->xtalk_enable && nau8825->xtalk_state !=
>>>>> +               NAU8825_XTALK_DONE) {
>>>>>                 cancel_work_sync(&nau8825->xtalk_work);
>>>>>                 nau8825_xtalk_clean(nau8825);
>>>>>         }
>>>>> @@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq,
>>>>> void
>>>>> *data)
>>>>>         } else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
>>>>>                 if (nau8825_is_jack_inserted(regmap)) {
>>>>>                         event |= nau8825_jack_insert(nau8825);
>>>>> -                       if (!nau8825->xtalk_bypass &&
>>>>> !nau8825->high_imped) {
>>>>> +                       if (nau8825->xtalk_enable &&
>>>>> !nau8825->high_imped) {
>>>>>                                 /* Apply the cross talk suppression in
>>>>> the
>>>>>                                  * headset without high impedance.
>>>>>                                  */
>>>>> @@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int
>>>>> irq, void
>>>>> *data)
>>>>>                         nau8825->xtalk_event_mask = event_mask;
>>>>>                 }
>>>>>         } else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
>>>>> -               schedule_work(&nau8825->xtalk_work);
>>>>> -               clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>>>> +               if (nau8825->xtalk_enable) {
>>>>> +                       schedule_work(&nau8825->xtalk_work);
>>>>> +                       clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
>>>>> +               }
>>>>
>>>> Shouldn't we still set clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ if
>>>> crosstalk is disabled?
>>>> Otherwise, all active_irq will be disabled later in this function.
>>>>
>>> Actually, there is assignment about clear_irq before the end of ISR
>>> as follows:
>>> if (!clear_irq) clear_irq = active_irq;
>> Right. But that will disable all other active IRQs. No? I thought you
>> wanted to
>> only disable the IRQ that was handled.
>
> Yes, I do want to clear the IRQ that handed in this time. Whenever
> the interruption happens, the ISR will read the IRQ status bitmaps,
> and only one IRQ raised in each time. After it is cleared, the codec
> just can monitor the next event and makes the active IRQs.
>

I'll set the clear_irq even through the crosstalk is disabled.

>>> The IRQ will still be cleared. Your comment is correct for the clear
>>> semantic. But the IRQ will never happen if the crosstalk disabled,
>>> because the IRQ is triggered in the crosstalk sequence.
>> Theoretically IRQ should not happen if crosstalk is disabled. I think
>> this check
>> can be used to prevent from a hardware bug.
>>>
>>>>>         } else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
>>>>>                 NAU8825_JACK_INSERTION_DETECTED) {
>>>>>                 /* One more step to check GPIO status directly.
>>>>> Thus, the
>>>>> @@ -2440,8 +2443,8 @@ static void
>>>>> nau8825_print_device_properties(struct
>>>>> nau8825 *nau8825)
>>>>>                         nau8825->jack_insert_debounce);
>>>>>         dev_dbg(dev, "jack-eject-debounce:  %d\n",
>>>>>                         nau8825->jack_eject_debounce);
>>>>> -       dev_dbg(dev, "crosstalk-bypass:     %d\n",
>>>>> -                       nau8825->xtalk_bypass);
>>>>> +       dev_dbg(dev, "crosstalk-enable:     %d\n",
>>>>> +                       nau8825->xtalk_enable);
>>>>>  }
>>>>>
>>>>>  static int nau8825_read_device_properties(struct device *dev,
>>>>> @@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct
>>>>> device *dev,
>>>>>                 &nau8825->jack_eject_debounce);
>>>>>         if (ret)
>>>>>                 nau8825->jack_eject_debounce = 0;
>>>>> -       nau8825->xtalk_bypass = device_property_read_bool(dev,
>>>>> -               "nuvoton,crosstalk-bypass");
>>>>> +       nau8825->xtalk_enable = device_property_read_bool(dev,
>>>>> +               "nuvoton,crosstalk-enable");
>>>>>
>>>>>         nau8825->mclk = devm_clk_get(dev, "mclk");
>>>>>         if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
>>>>> diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
>>>>> index 8aee5c86..199d6ea 100644
>>>>> --- a/sound/soc/codecs/nau8825.h
>>>>> +++ b/sound/soc/codecs/nau8825.h
>>>>> @@ -476,7 +476,7 @@ struct nau8825 {
>>>>>         int xtalk_event_mask;
>>>>>         bool xtalk_protect;
>>>>>         int imp_rms[NAU8825_XTALK_IMM];
>>>>> -       int xtalk_bypass;
>>>>> +       int xtalk_enable;
>>>>>  };
>>>>>
>>>>>  int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
>>>>> --
>>>>> 2.6.4
>>>>>
>>>
>>>
>>> ===========================================================================================
>>>
>>> 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.
>
>
>
> ===========================================================================================
>
> 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.
> _______________________________________________
> Alsa-devel mailing list
> Alsa-devel@alsa-project.org
> http://mailman.alsa-project.org/mailman/listinfo/alsa-devel



===========================================================================================
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.
_______________________________________________
Alsa-devel mailing list
Alsa-devel@alsa-project.org
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

Applied "ASoC: nau8825: disable crosstalk by default" to the asoc tree

[Mark Brown]

The patch

   ASoC: nau8825: disable crosstalk by default

has been applied to the asoc tree at

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

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

>From 226d7449135ffc62866c06d73b28cac90b3f31e4 Mon Sep 17 00:00:00 2001
From: John Hsu <KCHSU0@nuvoton.com>
Date: Fri, 24 Nov 2017 18:08:26 +0800
Subject: [PATCH] ASoC: nau8825: disable crosstalk by default

The driver makes the crosstalk funciton disabled by default
which can simplify the codec function. The platform may not
need this funciton and reduce the potential risk. Therefore,
We change the property "nuvoton,crosstalk-bypass" to
"nuvoton,crosstalk-enable". The crosstalk measurement is enabled
if the property is set. Otherwise, it is disabled. Besides,
add more condition in the entry point of the crosstalk sequence
to disable the function completely.

Signed-off-by: John Hsu <KCHSU0@nuvoton.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
---
 .../devicetree/bindings/sound/nau8825.txt          |  4 ++--
 sound/soc/codecs/nau8825.c                         | 23 ++++++++++++----------
 sound/soc/codecs/nau8825.h                         |  2 +-
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/nau8825.txt b/Documentation/devicetree/bindings/sound/nau8825.txt
index 2f5e973285a6..d16d96839bcb 100644
--- a/Documentation/devicetree/bindings/sound/nau8825.txt
+++ b/Documentation/devicetree/bindings/sound/nau8825.txt
@@ -69,7 +69,7 @@ Optional properties:
   - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
   - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms
 
-  - nuvoton,crosstalk-bypass: make crosstalk function bypass if set.
+  - nuvoton,crosstalk-enable: make crosstalk function enable if set.
 
   - clocks: list of phandle and clock specifier pairs according to common clock bindings for the
       clocks described in clock-names
@@ -98,7 +98,7 @@ Example:
       nuvoton,short-key-debounce = <2>;
       nuvoton,jack-insert-debounce = <7>;
       nuvoton,jack-eject-debounce = <7>;
-      nuvoton,crosstalk-bypass;
+      nuvoton,crosstalk-enable;
 
       clock-names = "mclk";
       clocks = <&tegra_car TEGRA210_CLK_CLK_OUT_2>;
diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
index 714ce17da717..d3c1a02f1e15 100644
--- a/sound/soc/codecs/nau8825.c
+++ b/sound/soc/codecs/nau8825.c
@@ -815,11 +815,12 @@ static void nau8825_xtalk_work(struct work_struct *work)
 
 static void nau8825_xtalk_cancel(struct nau8825 *nau8825)
 {
-	/* If the xtalk_protect is true, that means the process is still
-	 * on going. The driver forces to cancel the cross talk task and
+	/* If the crosstalk is eanbled and the process is on going,
+	 * the driver forces to cancel the crosstalk task and
 	 * restores the configuration to original status.
 	 */
-	if (nau8825->xtalk_protect) {
+	if (nau8825->xtalk_enable && nau8825->xtalk_state !=
+		NAU8825_XTALK_DONE) {
 		cancel_work_sync(&nau8825->xtalk_work);
 		nau8825_xtalk_clean(nau8825);
 	}
@@ -1686,7 +1687,7 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 	} else if (active_irq & NAU8825_HEADSET_COMPLETION_IRQ) {
 		if (nau8825_is_jack_inserted(regmap)) {
 			event |= nau8825_jack_insert(nau8825);
-			if (!nau8825->xtalk_bypass && !nau8825->high_imped) {
+			if (nau8825->xtalk_enable && !nau8825->high_imped) {
 				/* Apply the cross talk suppression in the
 				 * headset without high impedance.
 				 */
@@ -1732,8 +1733,10 @@ static irqreturn_t nau8825_interrupt(int irq, void *data)
 			nau8825->xtalk_event_mask = event_mask;
 		}
 	} else if (active_irq & NAU8825_IMPEDANCE_MEAS_IRQ) {
-		schedule_work(&nau8825->xtalk_work);
-		clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
+		if (nau8825->xtalk_enable) {
+			schedule_work(&nau8825->xtalk_work);
+			clear_irq = NAU8825_IMPEDANCE_MEAS_IRQ;
+		}
 	} else if ((active_irq & NAU8825_JACK_INSERTION_IRQ_MASK) ==
 		NAU8825_JACK_INSERTION_DETECTED) {
 		/* One more step to check GPIO status directly. Thus, the
@@ -2440,8 +2443,8 @@ static void nau8825_print_device_properties(struct nau8825 *nau8825)
 			nau8825->jack_insert_debounce);
 	dev_dbg(dev, "jack-eject-debounce:  %d\n",
 			nau8825->jack_eject_debounce);
-	dev_dbg(dev, "crosstalk-bypass:     %d\n",
-			nau8825->xtalk_bypass);
+	dev_dbg(dev, "crosstalk-enable:     %d\n",
+			nau8825->xtalk_enable);
 }
 
 static int nau8825_read_device_properties(struct device *dev,
@@ -2506,8 +2509,8 @@ static int nau8825_read_device_properties(struct device *dev,
 		&nau8825->jack_eject_debounce);
 	if (ret)
 		nau8825->jack_eject_debounce = 0;
-	nau8825->xtalk_bypass = device_property_read_bool(dev,
-		"nuvoton,crosstalk-bypass");
+	nau8825->xtalk_enable = device_property_read_bool(dev,
+		"nuvoton,crosstalk-enable");
 
 	nau8825->mclk = devm_clk_get(dev, "mclk");
 	if (PTR_ERR(nau8825->mclk) == -EPROBE_DEFER) {
diff --git a/sound/soc/codecs/nau8825.h b/sound/soc/codecs/nau8825.h
index 8aee5c8647ae..199d6ea4dcdc 100644
--- a/sound/soc/codecs/nau8825.h
+++ b/sound/soc/codecs/nau8825.h
@@ -476,7 +476,7 @@ struct nau8825 {
 	int xtalk_event_mask;
 	bool xtalk_protect;
 	int imp_rms[NAU8825_XTALK_IMM];
-	int xtalk_bypass;
+	int xtalk_enable;
 };
 
 int nau8825_enable_jack_detect(struct snd_soc_codec *codec,
-- 
2.15.0