Re: [PATCH 1/2] dt-bindings: tas2770: Convert tas2770 binding to yaml

From: Rob Herring
Date: Wed Jul 15 2020 - 14:12:52 EST


On Fri, Jun 12, 2020 at 12:13:41PM -0500, Dan Murphy wrote:
> Convert the tas2770 binding to yaml format.
> Add in the reset-gpio to the binding as it is in the code but not
> documented in the binding.
>
> Signed-off-by: Dan Murphy <dmurphy@xxxxxx>
> ---
> .../devicetree/bindings/sound/tas2770.txt | 37 ---------
> .../devicetree/bindings/sound/tas2770.yaml | 76 +++++++++++++++++++
> 2 files changed, 76 insertions(+), 37 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/sound/tas2770.txt
> create mode 100644 Documentation/devicetree/bindings/sound/tas2770.yaml
>
> diff --git a/Documentation/devicetree/bindings/sound/tas2770.txt b/Documentation/devicetree/bindings/sound/tas2770.txt
> deleted file mode 100644
> index ede6bb3d9637..000000000000
> --- a/Documentation/devicetree/bindings/sound/tas2770.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -Texas Instruments TAS2770 Smart PA
> -
> -The TAS2770 is a mono, digital input Class-D audio amplifier optimized for
> -efficiently driving high peak power into small loudspeakers.
> -Integrated speaker voltage and current sense provides for
> -real time monitoring of loudspeaker behavior.
> -
> -Required properties:
> -
> - - compatible: - Should contain "ti,tas2770".
> - - reg: - The i2c address. Should contain <0x4c>, <0x4d>,<0x4e>, or <0x4f>.
> - - #address-cells - Should be <1>.
> - - #size-cells - Should be <0>.
> - - ti,asi-format: - Sets TDM RX capture edge. 0->Rising; 1->Falling.
> - - ti,imon-slot-no:- TDM TX current sense time slot.
> - - ti,vmon-slot-no:- TDM TX voltage sense time slot.
> -
> -Optional properties:
> -
> -- interrupt-parent: the phandle to the interrupt controller which provides
> - the interrupt.
> -- interrupts: interrupt specification for data-ready.
> -
> -Examples:
> -
> - tas2770@4c {
> - compatible = "ti,tas2770";
> - reg = <0x4c>;
> - #address-cells = <1>;
> - #size-cells = <0>;
> - interrupt-parent = <&msm_gpio>;
> - interrupts = <97 0>;
> - ti,asi-format = <0>;
> - ti,imon-slot-no = <0>;
> - ti,vmon-slot-no = <2>;
> - };
> -
> diff --git a/Documentation/devicetree/bindings/sound/tas2770.yaml b/Documentation/devicetree/bindings/sound/tas2770.yaml
> new file mode 100644
> index 000000000000..8c667fd37a57
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/tas2770.yaml
> @@ -0,0 +1,76 @@
> +# SPDX-License-Identifier: (GPL-2.0+ OR BSD-2-Clause)

Do you have rights to relicense? The old binding defaults to
GPL-2.0-only. If so, great.

Either way, GPL-2.0-only not GPL-2.0+.

Otherwise,

Reviewed-by: Rob Herring <robh@xxxxxxxxxx>

> +# Copyright (C) 2019-20 Texas Instruments Incorporated
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/sound/tas2770.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: Texas Instruments TAS2770 Smart PA
> +
> +maintainers:
> + - Shi Fu <shifu0704@xxxxxxxxxxxxxxx>
> +
> +description: |
> + The TAS2770 is a mono, digital input Class-D audio amplifier optimized for
> + efficiently driving high peak power into small loudspeakers.
> + Integrated speaker voltage and current sense provides for
> + real time monitoring of loudspeaker behavior.
> +
> +properties:
> + compatible:
> + enum:
> + - ti,tas2770
> +
> + reg:
> + maxItems: 1
> + description: |
> + I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
> +
> + reset-gpio:
> + description: GPIO used to reset the device.
> +
> + interrupts:
> + maxItems: 1
> +
> + ti,imon-slot-no:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: TDM TX current sense time slot.
> +
> + ti,vmon-slot-no:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: TDM TX voltage sense time slot.
> +
> + ti,asi-format:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Sets TDM RX capture edge.
> + enum:
> + - 0 # Rising edge
> + - 1 # Falling edge
> +
> + '#sound-dai-cells':
> + const: 1
> +
> +required:
> + - compatible
> + - reg
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + i2c0 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + codec: codec@4c {
> + compatible = "ti,tas2770";
> + reg = <0x4c>;
> + #sound-dai-cells = <1>;
> + interrupt-parent = <&gpio1>;
> + interrupts = <14>;
> + reset-gpio = <&gpio1 15 0>;
> + ti,imon-slot-no = <0>;
> + ti,vmon-slot-no = <2>;
> + };
> + };
> +
> --
> 2.26.2
>