[PATCH v2 0/8] Remove use of "gpio-reset" from DT

[PATCH v2 0/8] Remove use of "gpio-reset" from DT

[Andrew F. Davis]

Hello all,

I was working on fixing up the tlv320aic31xx driver when I noticed
its gpio reset was not working, it was due to this driver looking
for "gpio-reset" instead of the usual "reset-gpio". A quick check
shows this mistake is rare and only copied by one other audio CODECs:

$ git grep "reset-gpio" | wc -l
630
$ git grep "gpio-reset" | wc -l
6

Luckliy the two effected drivers only use this reset line when power
has been cut to the device, so not only were these optional
properties but they had no real functional effect anyway. Lets
just fix this before is spreads to drivers were it matters.

I've also added fixes tags to each patch so it can be individually
back-ported to where this bug was introduced if one wanted to. I'm
hoping this can sit on next for a while to get the most testing,
just in case I'm wrong about this not breaking anything.

Thanks,
Andrew

Changes from v1:
 - Move old property to "Deprecated properties" section in binding
 - Keep backwards compatibility for now in driver with warning
 - Re-order patches to keep series bisectable
 - Use "reset-gpios" over "reset-gpio"
 - Drop taken patch
 - Rebased on v4.15-rc1

Andrew F. Davis (8):
  ASoC: tlv320aic31xx: Fix typo in DT binding documentation
  ASoC: tlv320aic3x: Fix typo in DT binding documentation
  ASoC: tlv320aic31xx: Fix the reset GPIO OF name
  ASoC: tlv320aic3x: Fix the reset GPIO OF name
  ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin
  ARM: dts: imx6: RDU2: Fix the audio CODEC's reset pin
  ARM: dts: imx: Fix the audio CODEC's reset pin
  ARM: dts: omap3-n900: Fix the audio CODEC's reset pin

 Documentation/devicetree/bindings/sound/tlv320aic31xx.txt |  9 ++++++++-
 Documentation/devicetree/bindings/sound/tlv320aic3x.txt   | 10 +++++++++-
 arch/arm/boot/dts/am335x-pepper.dts                       |  2 +-
 arch/arm/boot/dts/imx6qdl-gw5903.dtsi                     |  2 +-
 arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi                   |  4 ++--
 arch/arm/boot/dts/omap3-n900.dts                          |  4 ++--
 sound/soc/codecs/tlv320aic31xx.c                          | 11 +++++++++--
 sound/soc/codecs/tlv320aic3x.c                            | 15 +++++++++++----
 8 files changed, 43 insertions(+), 14 deletions(-)

-- 
2.15.0

[PATCH v2 1/8] ASoC: tlv320aic31xx: Fix typo in DT binding documentation

[Andrew F. Davis]

The property used to specify a GPIO intended for reset is "reset-gpios",
this binding uses "gpio-reset", as almost all other bindings use the
former name this use of the latter was certainly not intended. It is not
compatible with newer methods used to fetch GPIO pins and to prevent the
spread of this error to other bindings lets fix this here.

We also standardize the pin as active-low, different device trees have
marked the GPIO different ways, luckily the driver currently uses the
low-level GPIO set function which does not respect the active-low flag,
but future changes may change this. This is an active-low reset, mark
it as such.

Lastly, add an example of use for this property.

Fixes: e00447fafbf7 ("ASoC: tlv320aic31xx: Add basic codec driver implementation")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 Documentation/devicetree/bindings/sound/tlv320aic31xx.txt | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt b/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt
index 6fbba562eaa7..5b3c33bb99e5 100644
--- a/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt
+++ b/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt
@@ -22,7 +22,7 @@ Required properties:
 
 Optional properties:
 
-- gpio-reset - gpio pin number used for codec reset
+- reset-gpios - GPIO specification for the active low RESET input.
 - ai31xx-micbias-vg - MicBias Voltage setting
         1 or MICBIAS_2_0V - MICBIAS output is powered to 2.0V
         2 or MICBIAS_2_5V - MICBIAS output is powered to 2.5V
@@ -30,6 +30,10 @@ Optional properties:
 	If this node is not mentioned or if the value is unknown, then
 	micbias	is set to 2.0V.
 
+Deprecated properties:
+
+- gpio-reset - gpio pin number used for codec reset
+
 CODEC output pins:
   * HPL
   * HPR
@@ -48,6 +52,7 @@ CODEC input pins:
 The pins can be used in referring sound node's audio-routing property.
 
 Example:
+#include <dt-bindings/gpio/gpio.h>
 #include <dt-bindings/sound/tlv320aic31xx-micbias.h>
 
 tlv320aic31xx: tlv320aic31xx@18 {
@@ -56,6 +61,8 @@ tlv320aic31xx: tlv320aic31xx@18 {
 
 	ai31xx-micbias-vg = <MICBIAS_OFF>;
 
+	reset-gpios = <&gpio1 17 GPIO_ACTIVE_LOW>;
+
 	HPVDD-supply = <&regulator>;
 	SPRVDD-supply = <&regulator>;
 	SPLVDD-supply = <&regulator>;
-- 
2.15.0

[PATCH v2 2/8] ASoC: tlv320aic3x: Fix typo in DT binding documentation

[Andrew F. Davis]

The property used to specify a GPIO intended for reset is "reset-gpios",
this binding uses "gpio-reset", as almost all other bindings use the
former name this use of the latter was certainly not intended. It is not
compatible with newer methods used to fetch GPIO pins and to prevent the
spread of this error to other bindings lets fix this here.

We also standardize the pin as active-low, different device trees have
marked the GPIO different ways, luckily the driver currently uses the
low-level GPIO set function which does not respect the active-low flag,
but future changes may change this. This is an active-low reset, mark
it as such.

Lastly, add an example of use for this property.

Fixes: c24fdc886fde ("ASoC: tlv320aic3x: Add device tree bindings")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 Documentation/devicetree/bindings/sound/tlv320aic3x.txt | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/sound/tlv320aic3x.txt b/Documentation/devicetree/bindings/sound/tlv320aic3x.txt
index ba5b45c483f5..9796c4639262 100644
--- a/Documentation/devicetree/bindings/sound/tlv320aic3x.txt
+++ b/Documentation/devicetree/bindings/sound/tlv320aic3x.txt
@@ -17,7 +17,7 @@ Required properties:
 
 Optional properties:
 
-- gpio-reset - gpio pin number used for codec reset
+- reset-gpios - GPIO specification for the active low RESET input.
 - ai3x-gpio-func - <array of 2 int> - AIC3X_GPIO1 & AIC3X_GPIO2 Functionality
 				    - Not supported on tlv320aic3104
 - ai3x-micbias-vg - MicBias Voltage required.
@@ -34,6 +34,10 @@ Optional properties:
 - AVDD-supply, IOVDD-supply, DRVDD-supply, DVDD-supply : power supplies for the
   device as covered in Documentation/devicetree/bindings/regulator/regulator.txt
 
+Deprecated properties:
+
+- gpio-reset - gpio pin number used for codec reset
+
 CODEC output pins:
   * LLOUT
   * RLOUT
@@ -61,10 +65,14 @@ The pins can be used in referring sound node's audio-routing property.
 
 Example:
 
+#include <dt-bindings/gpio/gpio.h>
+
 tlv320aic3x: tlv320aic3x@1b {
 	compatible = "ti,tlv320aic3x";
 	reg = <0x1b>;
 
+	reset-gpios = <&gpio1 17 GPIO_ACTIVE_LOW>;
+
 	AVDD-supply = <&regulator>;
 	IOVDD-supply = <&regulator>;
 	DRVDD-supply = <&regulator>;
-- 
2.15.0

[PATCH v2 3/8] ASoC: tlv320aic31xx: Fix the reset GPIO OF name

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: e00447fafbf7 ("ASoC: tlv320aic31xx: Add basic codec driver implementation")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 sound/soc/codecs/tlv320aic31xx.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/sound/soc/codecs/tlv320aic31xx.c b/sound/soc/codecs/tlv320aic31xx.c
index e2862372c26e..4837f25b0760 100644
--- a/sound/soc/codecs/tlv320aic31xx.c
+++ b/sound/soc/codecs/tlv320aic31xx.c
@@ -1279,9 +1279,16 @@ static void aic31xx_pdata_from_of(struct aic31xx_priv *aic31xx)
 		aic31xx->pdata.micbias_vg = MICBIAS_2_0V;
 	}
 
-	ret = of_get_named_gpio(np, "gpio-reset", 0);
-	if (ret > 0)
+	ret = of_get_named_gpio(np, "reset-gpios", 0);
+	if (ret > 0) {
 		aic31xx->pdata.gpio_reset = ret;
+	} else {
+		ret = of_get_named_gpio(np, "gpio-reset", 0);
+		if (ret > 0) {
+			dev_warn(aic31xx->dev, "Using deprecated property \"gpio-reset\", please update your DT");
+			aic31xx->pdata.gpio_reset = ret;
+		}
+	}
 }
 #else /* CONFIG_OF */
 static void aic31xx_pdata_from_of(struct aic31xx_priv *aic31xx)
-- 
2.15.0

[PATCH v2 4/8] ASoC: tlv320aic3x: Fix the reset GPIO OF name

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: c24fdc886fde ("ASoC: tlv320aic3x: Add device tree bindings")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 sound/soc/codecs/tlv320aic3x.c | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/sound/soc/codecs/tlv320aic3x.c b/sound/soc/codecs/tlv320aic3x.c
index 06f92571eba4..b751cad545da 100644
--- a/sound/soc/codecs/tlv320aic3x.c
+++ b/sound/soc/codecs/tlv320aic3x.c
@@ -1804,11 +1804,18 @@ static int aic3x_i2c_probe(struct i2c_client *i2c,
 		if (!ai3x_setup)
 			return -ENOMEM;
 
-		ret = of_get_named_gpio(np, "gpio-reset", 0);
-		if (ret >= 0)
+		ret = of_get_named_gpio(np, "reset-gpios", 0);
+		if (ret >= 0) {
 			aic3x->gpio_reset = ret;
-		else
-			aic3x->gpio_reset = -1;
+		} else {
+			ret = of_get_named_gpio(np, "gpio-reset", 0);
+			if (ret > 0) {
+				dev_warn(&i2c->dev, "Using deprecated property \"gpio-reset\", please update your DT");
+				aic3x->gpio_reset = ret;
+			} else {
+				aic3x->gpio_reset = -1;
+			}
+		}
 
 		if (of_property_read_u32_array(np, "ai3x-gpio-func",
 					ai3x_setup->gpio_func, 2) >= 0) {
-- 
2.15.0

[PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: 4341881d0562 ("ARM: dts: Add devicetree for Gumstix Pepper board")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 arch/arm/boot/dts/am335x-pepper.dts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm/boot/dts/am335x-pepper.dts b/arch/arm/boot/dts/am335x-pepper.dts
index 03c7d77023c6..9fb7426070ce 100644
--- a/arch/arm/boot/dts/am335x-pepper.dts
+++ b/arch/arm/boot/dts/am335x-pepper.dts
@@ -139,7 +139,7 @@
 &audio_codec {
 	status = "okay";
 
-	gpio-reset = <&gpio1 16 GPIO_ACTIVE_LOW>;
+	reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
 	AVDD-supply = <&ldo3_reg>;
 	IOVDD-supply = <&ldo3_reg>;
 	DRVDD-supply = <&ldo3_reg>;
-- 
2.15.0

[PATCH v2 6/8] ARM: dts: imx6: RDU2: Fix the audio CODEC's reset pin

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: d763762e3b58 ("ARM: dts: imx6: add ZII RDU2 boards")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi b/arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi
index 7812fbac963c..1b465e5a06cf 100644
--- a/arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi
+++ b/arch/arm/boot/dts/imx6qdl-zii-rdu2.dtsi
@@ -337,7 +337,7 @@
 		AVDD-supply = <&reg_3p3v>;
 		IOVDD-supply = <&reg_3p3v>;
 		DVDD-supply = <&vgen4_reg>;
-		gpio-reset = <&gpio1 2 GPIO_ACTIVE_HIGH>;
+		reset-gpios = <&gpio1 2 GPIO_ACTIVE_LOW>;
 	};
 
 	accel@1c {
@@ -525,7 +525,7 @@
 		AVDD-supply = <&reg_3p3v>;
 		IOVDD-supply = <&reg_3p3v>;
 		DVDD-supply = <&vgen4_reg>;
-		gpio-reset = <&gpio1 0 GPIO_ACTIVE_HIGH>;
+		reset-gpios = <&gpio1 0 GPIO_ACTIVE_LOW>;
 	};
 
 	touchscreen@20 {
-- 
2.15.0

[PATCH v2 7/8] ARM: dts: imx: Fix the audio CODEC's reset pin

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: 50bffb78e2ee ("ARM: dts: imx: add Gateworks Ventana GW5903 support")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 arch/arm/boot/dts/imx6qdl-gw5903.dtsi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm/boot/dts/imx6qdl-gw5903.dtsi b/arch/arm/boot/dts/imx6qdl-gw5903.dtsi
index 444425153fc7..16299103a941 100644
--- a/arch/arm/boot/dts/imx6qdl-gw5903.dtsi
+++ b/arch/arm/boot/dts/imx6qdl-gw5903.dtsi
@@ -310,7 +310,7 @@
 	tlv320aic3105: codec@18 {
 		compatible = "ti,tlv320aic3x";
 		reg = <0x18>;
-		gpio-reset = <&gpio5 17 GPIO_ACTIVE_LOW>;
+		reset-gpios = <&gpio5 17 GPIO_ACTIVE_LOW>;
 		clocks = <&clks IMX6QDL_CLK_CKO>;
 		ai3x-micbias-vg = <2>; /* MICBIAS_2_5V */
 		/* Regulators */
-- 
2.15.0

[PATCH v2 8/8] ARM: dts: omap3-n900: Fix the audio CODEC's reset pin

[Andrew F. Davis]

The correct DT property for specifying a GPIO used for reset
is "reset-gpios", fix this here.

Fixes: 14e3e295b2b9 ("ARM: dts: omap3-n900: Add TLV320AIC3X support")

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 arch/arm/boot/dts/omap3-n900.dts | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/arm/boot/dts/omap3-n900.dts b/arch/arm/boot/dts/omap3-n900.dts
index 669c51c00c00..5362139d5312 100644
--- a/arch/arm/boot/dts/omap3-n900.dts
+++ b/arch/arm/boot/dts/omap3-n900.dts
@@ -558,7 +558,7 @@
 	tlv320aic3x: tlv320aic3x@18 {
 		compatible = "ti,tlv320aic3x";
 		reg = <0x18>;
-		gpio-reset = <&gpio2 28 GPIO_ACTIVE_HIGH>; /* 60 */
+		reset-gpios = <&gpio2 28 GPIO_ACTIVE_LOW>; /* 60 */
 		ai3x-gpio-func = <
 			0 /* AIC3X_GPIO1_FUNC_DISABLED */
 			5 /* AIC3X_GPIO2_FUNC_DIGITAL_MIC_INPUT */
@@ -575,7 +575,7 @@
 	tlv320aic3x_aux: tlv320aic3x@19 {
 		compatible = "ti,tlv320aic3x";
 		reg = <0x19>;
-		gpio-reset = <&gpio2 28 GPIO_ACTIVE_HIGH>; /* 60 */
+		reset-gpios = <&gpio2 28 GPIO_ACTIVE_LOW>; /* 60 */
 
 		AVDD-supply = <&vmmc2>;
 		DRVDD-supply = <&vmmc2>;
-- 
2.15.0

Re: [PATCH v2 1/8] ASoC: tlv320aic31xx: Fix typo in DT binding documentation

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 589 bytes --]

On Wed, Nov 29, 2017 at 11:13:52AM -0600, Andrew F. Davis wrote:
> The property used to specify a GPIO intended for reset is "reset-gpios",
> this binding uses "gpio-reset", as almost all other bindings use the
> former name this use of the latter was certainly not intended. It is not
> compatible with newer methods used to fetch GPIO pins and to prevent the
> spread of this error to other bindings lets fix this here.

When you say you're fixing a typo I'm looking for a fix for something
like two letters being transposed.  This isn't that, it's a completely
different property name.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Tony Lindgren]

* Andrew F. Davis <afd@ti.com> [171129 17:16]:
> The correct DT property for specifying a GPIO used for reset
> is "reset-gpios", fix this here.
> 
> Fixes: 4341881d0562 ("ARM: dts: Add devicetree for Gumstix Pepper board")

So it seems this and patch 8/8 are safe for me to pick separately?

Regards,

Tony

> Signed-off-by: Andrew F. Davis <afd@ti.com>
> ---
>  arch/arm/boot/dts/am335x-pepper.dts | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/arm/boot/dts/am335x-pepper.dts b/arch/arm/boot/dts/am335x-pepper.dts
> index 03c7d77023c6..9fb7426070ce 100644
> --- a/arch/arm/boot/dts/am335x-pepper.dts
> +++ b/arch/arm/boot/dts/am335x-pepper.dts
> @@ -139,7 +139,7 @@
>  &audio_codec {
>  	status = "okay";
>  
> -	gpio-reset = <&gpio1 16 GPIO_ACTIVE_LOW>;
> +	reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
>  	AVDD-supply = <&ldo3_reg>;
>  	IOVDD-supply = <&ldo3_reg>;
>  	DRVDD-supply = <&ldo3_reg>;
> -- 
> 2.15.0
> 

Re: [PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 324 bytes --]

On Thu, Nov 30, 2017 at 08:18:26AM -0800, Tony Lindgren wrote:

> So it seems this and patch 8/8 are safe for me to pick separately?

It might make sense to pull in the relevant branches from ASoC first
however IIRC the reset GPIO code currently does nothing useful anyway so
it won't have any impact on bisection.  Andrew?

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Andrew F. Davis]

On 11/30/2017 10:33 AM, Mark Brown wrote:
> On Thu, Nov 30, 2017 at 08:18:26AM -0800, Tony Lindgren wrote:
> 
>> So it seems this and patch 8/8 are safe for me to pick separately?
> 
> It might make sense to pull in the relevant branches from ASoC first
> however IIRC the reset GPIO code currently does nothing useful anyway so
> it won't have any impact on bisection.  Andrew?
> 

Yeah, that's right, for safety it would be nice to take these after the
ASoC code, but it shouldn't matter in practice as the reset wasn't used
right anyway.

Re: [PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 498 bytes --]

On Thu, Nov 30, 2017 at 10:37:22AM -0600, Andrew F. Davis wrote:
> On 11/30/2017 10:33 AM, Mark Brown wrote:

> > It might make sense to pull in the relevant branches from ASoC first
> > however IIRC the reset GPIO code currently does nothing useful anyway so
> > it won't have any impact on bisection.  Andrew?

> Yeah, that's right, for safety it would be nice to take these after the
> ASoC code, but it shouldn't matter in practice as the reset wasn't used
> right anyway.

I'd just go for it.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v2 5/8] ARM: dts: am335x-pepper: Fix the audio CODEC's reset pin

[Tony Lindgren]

* Mark Brown <broonie@kernel.org> [171130 16:56]:
> On Thu, Nov 30, 2017 at 10:37:22AM -0600, Andrew F. Davis wrote:
> > On 11/30/2017 10:33 AM, Mark Brown wrote:
> 
> > > It might make sense to pull in the relevant branches from ASoC first
> > > however IIRC the reset GPIO code currently does nothing useful anyway so
> > > it won't have any impact on bisection.  Andrew?
> 
> > Yeah, that's right, for safety it would be nice to take these after the
> > ASoC code, but it shouldn't matter in practice as the reset wasn't used
> > right anyway.
> 
> I'd just go for it.

OK will apply the two omap dts changes for v4.16.

Thanks,

Tony