[alsa-devel] [PATCH 1/9] ASoC: tlv320aic31xx: Fix typo in DT binding documentation

[Philipp Zabel]

Hi Andrew,

On Wed, 2017-11-08 at 15:24 -0600, Andrew F. Davis wrote:
> The property used to specify a GPIO intended for reset is "reset-gpio",
> this binding uses "gpio-reset", as almost all other bindings use the
> former name this use of the latter is certainly not intended and
> was a typo. 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 at ti.com>
> ---
>  Documentation/devicetree/bindings/sound/tlv320aic31xx.txt | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt b/Documentation/devicetree/bindings/sound/tlv320aic31xx.txt
> index 6fbba562eaa7..4c4e77f97d87 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

I would move this into a "Deprecated properties:" section instead of
just hiding it away.

> +- reset-gpio - GPIO specification for the active low RESET input.

This should be "reset-gpios". For reference, see
Documentation/devicetree/bindings/gpio/gpio.txt.

>  - 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
> @@ -48,6 +48,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 at 18 {
> @@ -56,6 +57,8 @@ tlv320aic31xx: tlv320aic31xx at 18 {
>  
>  	ai31xx-micbias-vg = <MICBIAS_OFF>;
>  
> +	reset-gpio = <&gpio1 17 GPIO_ACTIVE_LOW>;
> +
>  	HPVDD-supply = <&regulator>;
>  	SPRVDD-supply = <&regulator>;
>  	SPLVDD-supply = <&regulator>;

regards
Philipp