diff mbox series

[4/4] dt-bindings: tas2562: Convert the tas2562 binding to yaml

Message ID 20200626154143.20351-4-dmurphy@ti.com
State Changes Requested
Headers show
Series None | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 77 lines checked

Commit Message

Dan Murphy June 26, 2020, 3:41 p.m. UTC
Convert the TAS2562 text file to yaml format.

Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 .../devicetree/bindings/sound/tas2562.txt     | 37 ---------
 .../devicetree/bindings/sound/tas2562.yaml    | 77 +++++++++++++++++++
 2 files changed, 77 insertions(+), 37 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/tas2562.txt
 create mode 100644 Documentation/devicetree/bindings/sound/tas2562.yaml

Comments

Rob Herring July 15, 2020, 8:15 p.m. UTC | #1
On Fri, Jun 26, 2020 at 10:41:43AM -0500, Dan Murphy wrote:
> Convert the TAS2562 text file to yaml format.
> 
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  .../devicetree/bindings/sound/tas2562.txt     | 37 ---------
>  .../devicetree/bindings/sound/tas2562.yaml    | 77 +++++++++++++++++++
>  2 files changed, 77 insertions(+), 37 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/tas2562.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/tas2562.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/tas2562.txt b/Documentation/devicetree/bindings/sound/tas2562.txt
> deleted file mode 100644
> index dc6d7362ded7..000000000000
> --- a/Documentation/devicetree/bindings/sound/tas2562.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -Texas Instruments TAS2562 Smart PA
> -
> -The TAS2562 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:
> - - #address-cells  - Should be <1>.
> - - #size-cells     - Should be <0>.
> - - compatible:	   - Should contain "ti,tas2562", "ti,tas2563".
> - - reg:		   - The i2c address. Should be 0x4c, 0x4d, 0x4e or 0x4f.
> - - ti,imon-slot-no:- TDM TX current sense time slot.
> - - ti,vmon-slot-no:- TDM TX voltage sense time slot. This slot must always be
> -		     greater then ti,imon-slot-no.
> -
> -Optional properties:
> -- interrupt-parent: phandle to the interrupt controller which provides
> -                    the interrupt.
> -- interrupts: (GPIO) interrupt to which the chip is connected.
> -- shut-down-gpio: GPIO used to control the state of the device.
> -
> -Examples:
> -tas2562@4c {
> -        #address-cells = <1>;
> -        #size-cells = <0>;
> -        compatible = "ti,tas2562";
> -        reg = <0x4c>;
> -
> -        interrupt-parent = <&gpio1>;
> -        interrupts = <14>;
> -
> -	shut-down-gpio = <&gpio1 15 0>;
> -        ti,imon-slot-no = <0>;
> -        ti,vmon-slot-no = <1>;
> -};
> -
> diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml
> new file mode 100644
> index 000000000000..1fb467e14d4c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/tas2562.yaml
> @@ -0,0 +1,77 @@
> +# SPDX-License-Identifier: (GPL-2.0+ OR BSD-2-Clause)

Same licensing comment here as tas2770

> +# Copyright (C) 2019 Texas Instruments Incorporated
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/sound/tas2562.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Texas Instruments TAS2562 Smart PA
> +
> +maintainers:
> +  - Dan Murphy <dmurphy@ti.com>
> +
> +description: |
> +  The TAS2562 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,tas2562
> +      - ti,tas2563
> +
> +  reg:
> +    maxItems: 1
> +    description: |
> +       I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
> +
> +  shut-down-gpio:
> +    description: GPIO used to control the state of the device.
> +    deprecated: true

Why do we need this as the driver never worked?

> +
> +  shutdown-gpio:
> +    description: GPIO used to control the state of the device.

-gpios is the preferred form: shutdown-gpios

> +
> +  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.  This slot must always be greater then
> +      ti,imon-slot-no.
> +
> +  '#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,tas2562";
> +       reg = <0x4c>;
> +       #sound-dai-cells = <1>;
> +       interrupt-parent = <&gpio1>;
> +       interrupts = <14>;
> +       shutdown-gpio = <&gpio1 15 0>;
> +       ti,imon-slot-no = <0>;
> +       ti,vmon-slot-no = <2>;
> +     };
> +   };
> +
> +...
> -- 
> 2.26.2
>
Dan Murphy July 20, 2020, 6:22 p.m. UTC | #2
Rob

On 7/15/20 3:15 PM, Rob Herring wrote:
> On Fri, Jun 26, 2020 at 10:41:43AM -0500, Dan Murphy wrote:
>> Convert the TAS2562 text file to yaml format.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   .../devicetree/bindings/sound/tas2562.txt     | 37 ---------
>>   .../devicetree/bindings/sound/tas2562.yaml    | 77 +++++++++++++++++++
>>   2 files changed, 77 insertions(+), 37 deletions(-)
>>   delete mode 100644 Documentation/devicetree/bindings/sound/tas2562.txt
>>   create mode 100644 Documentation/devicetree/bindings/sound/tas2562.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/sound/tas2562.txt b/Documentation/devicetree/bindings/sound/tas2562.txt
>> deleted file mode 100644
>> index dc6d7362ded7..000000000000
>> --- a/Documentation/devicetree/bindings/sound/tas2562.txt
>> +++ /dev/null
>> @@ -1,37 +0,0 @@
>> -Texas Instruments TAS2562 Smart PA
>> -
>> -The TAS2562 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:
>> - - #address-cells  - Should be <1>.
>> - - #size-cells     - Should be <0>.
>> - - compatible:	   - Should contain "ti,tas2562", "ti,tas2563".
>> - - reg:		   - The i2c address. Should be 0x4c, 0x4d, 0x4e or 0x4f.
>> - - ti,imon-slot-no:- TDM TX current sense time slot.
>> - - ti,vmon-slot-no:- TDM TX voltage sense time slot. This slot must always be
>> -		     greater then ti,imon-slot-no.
>> -
>> -Optional properties:
>> -- interrupt-parent: phandle to the interrupt controller which provides
>> -                    the interrupt.
>> -- interrupts: (GPIO) interrupt to which the chip is connected.
>> -- shut-down-gpio: GPIO used to control the state of the device.
>> -
>> -Examples:
>> -tas2562@4c {
>> -        #address-cells = <1>;
>> -        #size-cells = <0>;
>> -        compatible = "ti,tas2562";
>> -        reg = <0x4c>;
>> -
>> -        interrupt-parent = <&gpio1>;
>> -        interrupts = <14>;
>> -
>> -	shut-down-gpio = <&gpio1 15 0>;
>> -        ti,imon-slot-no = <0>;
>> -        ti,vmon-slot-no = <1>;
>> -};
>> -
>> diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml
>> new file mode 100644
>> index 000000000000..1fb467e14d4c
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/sound/tas2562.yaml
>> @@ -0,0 +1,77 @@
>> +# SPDX-License-Identifier: (GPL-2.0+ OR BSD-2-Clause)
> Same licensing comment here as tas2770

OK I will fix it like I did with the other TAS2770 patches


>> +# Copyright (C) 2019 Texas Instruments Incorporated
>> +%YAML 1.2
>> +---
>> +$id: "http://devicetree.org/schemas/sound/tas2562.yaml#"
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: Texas Instruments TAS2562 Smart PA
>> +
>> +maintainers:
>> +  - Dan Murphy <dmurphy@ti.com>
>> +
>> +description: |
>> +  The TAS2562 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,tas2562
>> +      - ti,tas2563
>> +
>> +  reg:
>> +    maxItems: 1
>> +    description: |
>> +       I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
>> +
>> +  shut-down-gpio:
>> +    description: GPIO used to control the state of the device.
>> +    deprecated: true
> Why do we need this as the driver never worked?

Not sure what you are asking.

Driver has been fixed for this specific binding in sound for-next.

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git/commit/sound/soc/codecs/tas2562.c?h=for-next&id=bc07b54459cbb3a572a78b5c200ff79ef11b8158

>
>> +
>> +  shutdown-gpio:
>> +    description: GPIO used to control the state of the device.
> -gpios is the preferred form: shutdown-gpios

So the plural form of gpio is preferred even if the gpio is singular?  I 
would think gpio would be plural if this was an array of gpios.

I am waiting for the yaml to be accepted before adding this shutdown 
property to the driver.

Dan
Rob Herring July 23, 2020, 8:16 p.m. UTC | #3
On Mon, Jul 20, 2020 at 12:22 PM Dan Murphy <dmurphy@ti.com> wrote:
>
> Rob
>
> On 7/15/20 3:15 PM, Rob Herring wrote:
> > On Fri, Jun 26, 2020 at 10:41:43AM -0500, Dan Murphy wrote:
> >> Convert the TAS2562 text file to yaml format.
> >>
> >> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> >> ---
> >>   .../devicetree/bindings/sound/tas2562.txt     | 37 ---------
> >>   .../devicetree/bindings/sound/tas2562.yaml    | 77 +++++++++++++++++++
> >>   2 files changed, 77 insertions(+), 37 deletions(-)
> >>   delete mode 100644 Documentation/devicetree/bindings/sound/tas2562.txt
> >>   create mode 100644 Documentation/devicetree/bindings/sound/tas2562.yaml
> >>
> >> diff --git a/Documentation/devicetree/bindings/sound/tas2562.txt b/Documentation/devicetree/bindings/sound/tas2562.txt
> >> deleted file mode 100644
> >> index dc6d7362ded7..000000000000
> >> --- a/Documentation/devicetree/bindings/sound/tas2562.txt
> >> +++ /dev/null
> >> @@ -1,37 +0,0 @@
> >> -Texas Instruments TAS2562 Smart PA
> >> -
> >> -The TAS2562 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:
> >> - - #address-cells  - Should be <1>.
> >> - - #size-cells     - Should be <0>.
> >> - - compatible:         - Should contain "ti,tas2562", "ti,tas2563".
> >> - - reg:                - The i2c address. Should be 0x4c, 0x4d, 0x4e or 0x4f.
> >> - - ti,imon-slot-no:- TDM TX current sense time slot.
> >> - - ti,vmon-slot-no:- TDM TX voltage sense time slot. This slot must always be
> >> -                 greater then ti,imon-slot-no.
> >> -
> >> -Optional properties:
> >> -- interrupt-parent: phandle to the interrupt controller which provides
> >> -                    the interrupt.
> >> -- interrupts: (GPIO) interrupt to which the chip is connected.
> >> -- shut-down-gpio: GPIO used to control the state of the device.
> >> -
> >> -Examples:
> >> -tas2562@4c {
> >> -        #address-cells = <1>;
> >> -        #size-cells = <0>;
> >> -        compatible = "ti,tas2562";
> >> -        reg = <0x4c>;
> >> -
> >> -        interrupt-parent = <&gpio1>;
> >> -        interrupts = <14>;
> >> -
> >> -    shut-down-gpio = <&gpio1 15 0>;
> >> -        ti,imon-slot-no = <0>;
> >> -        ti,vmon-slot-no = <1>;
> >> -};
> >> -
> >> diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml
> >> new file mode 100644
> >> index 000000000000..1fb467e14d4c
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/sound/tas2562.yaml
> >> @@ -0,0 +1,77 @@
> >> +# SPDX-License-Identifier: (GPL-2.0+ OR BSD-2-Clause)
> > Same licensing comment here as tas2770
>
> OK I will fix it like I did with the other TAS2770 patches
>
>
> >> +# Copyright (C) 2019 Texas Instruments Incorporated
> >> +%YAML 1.2
> >> +---
> >> +$id: "http://devicetree.org/schemas/sound/tas2562.yaml#"
> >> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> >> +
> >> +title: Texas Instruments TAS2562 Smart PA
> >> +
> >> +maintainers:
> >> +  - Dan Murphy <dmurphy@ti.com>
> >> +
> >> +description: |
> >> +  The TAS2562 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,tas2562
> >> +      - ti,tas2563
> >> +
> >> +  reg:
> >> +    maxItems: 1
> >> +    description: |
> >> +       I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
> >> +
> >> +  shut-down-gpio:
> >> +    description: GPIO used to control the state of the device.
> >> +    deprecated: true
> > Why do we need this as the driver never worked?
>
> Not sure what you are asking.
>
> Driver has been fixed for this specific binding in sound for-next.
>
> https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git/commit/sound/soc/codecs/tas2562.c?h=for-next&id=bc07b54459cbb3a572a78b5c200ff79ef11b8158

Why fix the driver and then have to maintain compatibility? Just
update everything to use 'shutdown-gpios' and move on.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/tas2562.txt b/Documentation/devicetree/bindings/sound/tas2562.txt
deleted file mode 100644
index dc6d7362ded7..000000000000
--- a/Documentation/devicetree/bindings/sound/tas2562.txt
+++ /dev/null
@@ -1,37 +0,0 @@ 
-Texas Instruments TAS2562 Smart PA
-
-The TAS2562 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:
- - #address-cells  - Should be <1>.
- - #size-cells     - Should be <0>.
- - compatible:	   - Should contain "ti,tas2562", "ti,tas2563".
- - reg:		   - The i2c address. Should be 0x4c, 0x4d, 0x4e or 0x4f.
- - ti,imon-slot-no:- TDM TX current sense time slot.
- - ti,vmon-slot-no:- TDM TX voltage sense time slot. This slot must always be
-		     greater then ti,imon-slot-no.
-
-Optional properties:
-- interrupt-parent: phandle to the interrupt controller which provides
-                    the interrupt.
-- interrupts: (GPIO) interrupt to which the chip is connected.
-- shut-down-gpio: GPIO used to control the state of the device.
-
-Examples:
-tas2562@4c {
-        #address-cells = <1>;
-        #size-cells = <0>;
-        compatible = "ti,tas2562";
-        reg = <0x4c>;
-
-        interrupt-parent = <&gpio1>;
-        interrupts = <14>;
-
-	shut-down-gpio = <&gpio1 15 0>;
-        ti,imon-slot-no = <0>;
-        ti,vmon-slot-no = <1>;
-};
-
diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml
new file mode 100644
index 000000000000..1fb467e14d4c
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/tas2562.yaml
@@ -0,0 +1,77 @@ 
+# SPDX-License-Identifier: (GPL-2.0+ OR BSD-2-Clause)
+# Copyright (C) 2019 Texas Instruments Incorporated
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/sound/tas2562.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Texas Instruments TAS2562 Smart PA
+
+maintainers:
+  - Dan Murphy <dmurphy@ti.com>
+
+description: |
+  The TAS2562 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,tas2562
+      - ti,tas2563
+
+  reg:
+    maxItems: 1
+    description: |
+       I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
+
+  shut-down-gpio:
+    description: GPIO used to control the state of the device.
+    deprecated: true
+
+  shutdown-gpio:
+    description: GPIO used to control the state of 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.  This slot must always be greater then
+      ti,imon-slot-no.
+
+  '#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,tas2562";
+       reg = <0x4c>;
+       #sound-dai-cells = <1>;
+       interrupt-parent = <&gpio1>;
+       interrupts = <14>;
+       shutdown-gpio = <&gpio1 15 0>;
+       ti,imon-slot-no = <0>;
+       ti,vmon-slot-no = <2>;
+     };
+   };
+
+...