| Message ID | 20200602193524.30309-2-dmurphy@ti.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/2] dt-bindings: ASoc: Fix tdm-slot documentation spelling error | expand |
On Tue, Jun 02, 2020 at 02:35:24PM -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 | 34 ---------- > .../devicetree/bindings/sound/tas2562.yaml | 65 +++++++++++++++++++ > 2 files changed, 65 insertions(+), 34 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 94796b547184..000000000000 > --- a/Documentation/devicetree/bindings/sound/tas2562.txt > +++ /dev/null > @@ -1,34 +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. > - > -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 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 = <&gpio1 15 0>; > - ti,imon-slot-no = <0>; > -}; > - > diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml > new file mode 100644 > index 000000000000..11e0269d03b3 > --- /dev/null > +++ b/Documentation/devicetree/bindings/sound/tas2562.yaml > @@ -0,0 +1,65 @@ > +# 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 addresss of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f > + > + shut-down: Hopefully, this is an error. It should be 'shut-down-gpios'. Looking at the driver, it is also broken. It's passing 'shut-down-gpio' which means the GPIO core is looking for 'shut-down-gpio-gpio' or 'shut-down-gpio-gpios'. Also the standardish naming here is 'shutdown-gpios'. Given this probably never worked, we should use that. > + 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. > + > + '#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>; > + > + shut-down = <&gpio1 15 0>; > + ti,imon-slot-no = <0>; > + }; > + }; > + > -- > 2.26.2 >
diff --git a/Documentation/devicetree/bindings/sound/tas2562.txt b/Documentation/devicetree/bindings/sound/tas2562.txt deleted file mode 100644 index 94796b547184..000000000000 --- a/Documentation/devicetree/bindings/sound/tas2562.txt +++ /dev/null @@ -1,34 +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. - -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 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 = <&gpio1 15 0>; - ti,imon-slot-no = <0>; -}; - diff --git a/Documentation/devicetree/bindings/sound/tas2562.yaml b/Documentation/devicetree/bindings/sound/tas2562.yaml new file mode 100644 index 000000000000..11e0269d03b3 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/tas2562.yaml @@ -0,0 +1,65 @@ +# 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 addresss of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f + + shut-down: + 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. + + '#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>; + + shut-down = <&gpio1 15 0>; + ti,imon-slot-no = <0>; + }; + }; +
Convert the TAS2562 text file to yaml format. Signed-off-by: Dan Murphy <dmurphy@ti.com> --- .../devicetree/bindings/sound/tas2562.txt | 34 ---------- .../devicetree/bindings/sound/tas2562.yaml | 65 +++++++++++++++++++ 2 files changed, 65 insertions(+), 34 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/tas2562.txt create mode 100644 Documentation/devicetree/bindings/sound/tas2562.yaml