Skip to contentSkip to conversation

ASoC: tlv320adcx140: Avoid accessing invalid gpio_reset

PATCH In review Camel Guo 5 participants 11 messages Sep 8, 2020 – Sep 9, 2020

Subsystems (3)
lore
Share & tools
lore

Camel Guo

author
#0 lore raw

PATCH 1/2 ASoC: tlv320adcx140: Avoid accessing invalid gpio_reset

From: Camel Guo <[email protected]>

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

---
 sound/soc/codecs/tlv320adcx140.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
sound/soc/codecs/tlv320adcx140.c +3 -1
index 7ae6ec374be3..597dd1062943 100644
@@ -984,8 +984,10 @@ static int adcx140_i2c_probe(struct i2c_client *i2c,
 
 	adcx140->gpio_reset = devm_gpiod_get_optional(adcx140->dev,
 						      "reset", GPIOD_OUT_LOW);
-	if (IS_ERR(adcx140->gpio_reset))
+	if (IS_ERR(adcx140->gpio_reset) || adcx140->gpio_reset == NULL) {
 		dev_info(&i2c->dev, "Reset GPIO not defined\n");
+		adcx140->gpio_reset = NULL;
+	}
 
 	adcx140->supply_areg = devm_regulator_get_optional(adcx140->dev,
 							   "areg");
Signature · 1 line
2.20.1
author
#1 lore raw

PATCH 2/2 ASoC: tlv320adcx140: Wake up codec before accessing register

From: Camel Guo <[email protected]>

According to its datasheet, after reset this codec goes into sleep mode. In this mode, any register accessing should be avoided except for exiting sleep mode. Hence this commit moves SLEEP_CFG access before any register accessing.

---
 sound/soc/codecs/tlv320adcx140.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
sound/soc/codecs/tlv320adcx140.c +12 -12
index 597dd1062943..6d456aa269ad 100644
@@ -842,6 +842,18 @@ static int adcx140_codec_probe(struct snd_soc_component *component)
 	if (ret)
 		goto out;
 
+	if (adcx140->supply_areg == NULL)
+		sleep_cfg_val |= ADCX140_AREG_INTERNAL;
+
+	ret = regmap_write(adcx140->regmap, ADCX140_SLEEP_CFG, sleep_cfg_val);
+	if (ret) {
+		dev_err(adcx140->dev, "setting sleep config failed %d\n", ret);
+		goto out;
+	}
+
+	/* 8.4.3: Wait >= 1ms after entering active mode. */
+	usleep_range(1000, 100000);
+
 	pdm_count = device_property_count_u32(adcx140->dev,
 					      "ti,pdm-edge-select");
 	if (pdm_count <= ADCX140_NUM_PDM_EDGES && pdm_count > 0) {
@@ -889,18 +901,6 @@ static int adcx140_codec_probe(struct snd_soc_component *component)
 	if (ret)
 		goto out;
 
-	if (adcx140->supply_areg == NULL)
-		sleep_cfg_val |= ADCX140_AREG_INTERNAL;
-
-	ret = regmap_write(adcx140->regmap, ADCX140_SLEEP_CFG, sleep_cfg_val);
-	if (ret) {
-		dev_err(adcx140->dev, "setting sleep config failed %d\n", ret);
-		goto out;
-	}
-
-	/* 8.4.3: Wait >= 1ms after entering active mode. */
-	usleep_range(1000, 100000);
-
 	ret = regmap_update_bits(adcx140->regmap, ADCX140_BIAS_CFG,
 				ADCX140_MIC_BIAS_VAL_MSK |
 				ADCX140_MIC_BIAS_VREF_MSK, bias_cfg);
Signature · 1 line
2.20.1
#2 lore raw

Re: [PATCH 2/2] ASoC: tlv320adcx140: Wake up codec before accessing register

Camel

Quoted 6 lines · Camel Guo

From: Camel Guo <[email protected]>

According to its datasheet, after reset this codec goes into sleep mode. In this mode, any register accessing should be avoided except for exiting sleep mode. Hence this commit moves SLEEP_CFG access before any register accessing.

This is interesting because our HW team suggested putting the device into sleep mode when doing register writes/reads because they were finding abnormalities in the register settings when the device is active.

I have a local patch that changes this as well that the HW team requested.

Mark

Let me run this by the HW team first before applying this patch.

Dan

Acked-by
#3 lore raw

Re: [PATCH 2/2] ASoC: tlv320adcx140: Wake up codec before accessing register

Camel

Quoted 5 lines · Dan Murphy

Camel

Quoted 2 lines · Camel Guo

From: Camel Guo <[email protected]>

Quoted 8 lines
Quoted 4 lines

According to its datasheet, after reset this codec goes into sleep mode. In this mode, any register accessing should be avoided except for exiting sleep mode. Hence this commit moves SLEEP_CFG access before any register accessing.

This is interesting because our HW team suggested putting the device into sleep mode when doing register writes/reads because they were finding abnormalities in the register settings when the device is active.

I have a local patch that changes this as well that the HW team requested.

OK I have clarification on this now.  Their original request was incorrect they indicate the BIAS, ADC and PLLs be powered down during writes and reads.

Quoted 4 lines

Mark

Let me run this by the HW team first before applying this patch.

Mark

Quoted 3 lines

Dan

#4 lore raw
In reply to Camel Guo

Camel

Quoted 17 lines · Camel Guo

From: Camel Guo <[email protected]>

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

---
  sound/soc/codecs/tlv320adcx140.c | 4 +++-
  1 file changed, 3 insertions(+), 1 deletion(-)
sound/soc/codecs/tlv320adcx140.c +0 -0
index 7ae6ec374be3..597dd1062943 100644

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 987

Quoted 5 lines
sound/soc/codecs/tlv320adcx140.c +1 -1
@@ -984,8 +984,10 @@ static int adcx140_i2c_probe(struct i2c_client *i2c,
 
  	adcx140->gpio_reset = devm_gpiod_get_optional(adcx140->dev,
  						      "reset", GPIOD_OUT_LOW);
-	if (IS_ERR(adcx140->gpio_reset))
+	if (IS_ERR(adcx140->gpio_reset) || adcx140->gpio_reset == NULL) {

This looks a bit off and seems like the NULL check was added just to print the message.

I would suggest removing the "or" check and just set the gpio_reset to NULL in an error case.

This avoids noise in the log especially if the gpio_reset is intentionally not populated in the DT

Dan

#5 lore raw
In reply to Camel Guo
Quoted 17 lines · Camel Guo

From: Camel Guo <[email protected]>

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

---
 sound/soc/codecs/tlv320adcx140.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
sound/soc/codecs/tlv320adcx140.c +0 -0
index 7ae6ec374be3..597dd1062943 100644

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 989

Quoted 7 lines
sound/soc/codecs/tlv320adcx140.c +2 -1
@@ -984,8 +984,10 @@ static int adcx140_i2c_probe(struct i2c_client *i2c,
 
 	adcx140->gpio_reset = devm_gpiod_get_optional(adcx140->dev,
 						      "reset", GPIOD_OUT_LOW);
-	if (IS_ERR(adcx140->gpio_reset))
+	if (IS_ERR(adcx140->gpio_reset) || adcx140->gpio_reset == NULL) {
 		dev_info(&i2c->dev, "Reset GPIO not defined\n");
+		adcx140->gpio_reset = NULL;

the correct fix is to:

	dev_err(&i2c->dev, "Reset GPIO not defined\n");
	return PTR_ERR(adcx140->gpio_reset);

If the reset GPIO is specified and you get error when requesting it as optional, there is a reason for that.
For example deferred probing.

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 993

Quoted 5 lines
sound/soc/codecs/tlv320adcx140.c +1 -0
+	}
 
 	adcx140->supply_areg = devm_regulator_get_optional(adcx140->dev,
 							   "areg");

- Péter

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

#6 lore raw

Hi,

Quoted 29 lines · Peter Ujfalusi
Quoted 17 lines · Camel Guo

From: Camel Guo <[email protected]>

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

---
 sound/soc/codecs/tlv320adcx140.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
sound/soc/codecs/tlv320adcx140.c +0 -0
index 7ae6ec374be3..597dd1062943 100644

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 989

Quoted 7 lines
sound/soc/codecs/tlv320adcx140.c +2 -1
@@ -984,8 +984,10 @@ static int adcx140_i2c_probe(struct i2c_client *i2c,
 
 	adcx140->gpio_reset = devm_gpiod_get_optional(adcx140->dev,
 						      "reset", GPIOD_OUT_LOW);
-	if (IS_ERR(adcx140->gpio_reset))
+	if (IS_ERR(adcx140->gpio_reset) || adcx140->gpio_reset == NULL) {
 		dev_info(&i2c->dev, "Reset GPIO not defined\n");
+		adcx140->gpio_reset = NULL;

the correct fix is to:

Quoted 1 line
	dev_err(&i2c->dev, "Reset GPIO not defined\n");

no need to print, I think gpio core will do that.

Quoted 8 lines
	return PTR_ERR(adcx140->gpio_reset);

If the reset GPIO is specified and you get error when requesting it as optional, there is a reason for that.
For example deferred probing.

Quoted 2 lines
sound/soc/codecs/tlv320adcx140.c +1 -0
+	}
 
Quoted 9 lines

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 993

Quoted 3 lines
sound/soc/codecs/tlv320adcx140.c +0 -0
 	adcx140->supply_areg = devm_regulator_get_optional(adcx140->dev,
 							   "areg");

- Péter

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

- Péter

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

#7 lore raw

Hi Peter,

Thanks for your comment. I will make a new one like what you said.

Quoted 34 lines · Peter Ujfalusi

Hi,

Quoted 21 lines · Peter Ujfalusi
Quoted 18 lines · Camel Guo

From: Camel Guo <[email protected]>

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

---
  sound/soc/codecs/tlv320adcx140.c | 4 +++-

  1 file changed, 3 insertions(+), 1 deletion(-)
sound/soc/codecs/tlv320adcx140.c +0 -0
index 7ae6ec374be3..597dd1062943 100644
@@ -984,8 +984,10 @@ static int adcx140_i2c_probe(struct i2c_client *i2c,
 
Quoted 9 lines

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 989

Quoted 6 lines
sound/soc/codecs/tlv320adcx140.c +2 -1
        adcx140->gpio_reset = devm_gpiod_get_optional(adcx140->dev,
                                                      "reset", GPIOD_OUT_LOW);
-    if (IS_ERR(adcx140->gpio_reset))
+    if (IS_ERR(adcx140->gpio_reset) || adcx140->gpio_reset == NULL) {
                dev_info(&i2c->dev, "Reset GPIO not defined\n");
+            adcx140->gpio_reset = NULL;

the correct fix is to:
        dev_err(&i2c->dev, "Reset GPIO not defined\n");

Quoted 7 lines

no need to print, I think gpio core will do that.

Quoted 5 lines

        return PTR_ERR(adcx140->gpio_reset);

If the reset GPIO is specified and you get error when requesting it as optional, there is a reason for that.
For example deferred probing.

I agree! Please ignore this patch and I will make a new one like this.

Quoted 18 lines
Quoted 12 lines

sound/soc/codecs/tlv320adcx140.c static int adcx140_i2c_probe(struct i2c_client *i2c, · line 993

Quoted 6 lines
sound/soc/codecs/tlv320adcx140.c +1 -0
+    }
 
        adcx140->supply_areg = devm_regulator_get_optional(adcx140->dev,
                                                           "areg");

- Péter

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

- Péter

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

maintainer
#8 lore raw
In reply to Camel Guo
Quoted 4 lines · Camel Guo

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

Applied to

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

Thanks!

[1/1] ASoC: tlv320adcx140: Wake up codec before accessing register

      commit: 1a5ce48fd667128e369fdc7fb87e21539aed21b5

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

#9 lore raw

Mark

Quoted 9 lines · Mark Brown
Quoted 4 lines · Camel Guo

When gpio_reset is not well defined in devicetree, the adcx140->gpio_reset is an error code instead of NULL. In this case, adcx140->gpio_reset should not be used by adcx140_reset. This commit sets it NULL to avoid accessing an invalid variable.

Applied to

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

I think it is "ASoC: tlv320adcx140: Wake up codec before register setting" that is applied to for next not this one.

Quoted 24 lines

Thanks!

[1/1] ASoC: tlv320adcx140: Wake up codec before accessing register
      commit: 1a5ce48fd667128e369fdc7fb87e21539aed21b5

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

maintainer
#10 lore raw
Quoted 8 lines · Camel Guo
Quoted 3 lines · Mark Brown

Applied to

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

I think it is "ASoC: tlv320adcx140: Wake up codec before register setting" that is applied to for next not this one.

As the mail says:

Quoted 2 lines
Quoted 2 lines

[1/1] ASoC: tlv320adcx140: Wake up codec before accessing register
      commit: 1a5ce48fd667128e369fdc7fb87e21539aed21b5

You didn't send a cover letter.