Message ID | 20200612160603.2456-1-dmurphy@ti.com |
---|---|
State | Superseded, archived |
Headers | show |
Series | [v3,1/2] dt-bindings: tas2562: Convert the tas2562 binding to yaml | expand |
Context | Check | Description |
---|---|---|
robh/checkpatch | warning | total: 0 errors, 2 warnings, 65 lines checked |
robh/dt-meta-schema | success |
On Fri, Jun 12, 2020 at 11:06:03AM -0500, Dan Murphy wrote: > - tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shut-down-gpio", > + tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shutdown", > GPIOD_OUT_HIGH); This also changes the name from shut-down to shutdown which will be incompatible (IIRC we do try -gpio as well as -gpios).
Mark On 6/12/20 11:09 AM, Mark Brown wrote: > On Fri, Jun 12, 2020 at 11:06:03AM -0500, Dan Murphy wrote: > >> - tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shut-down-gpio", >> + tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shutdown", >> GPIOD_OUT_HIGH); > This also changes the name from shut-down to shutdown which will be > incompatible (IIRC we do try -gpio as well as -gpios). Yes the non-standardish name was highlighted by Rob[1]. Also I checked the GPIO library and it looks at both -gpio and gpios as property suffixes. Since this is a single GPIO the singular should be used in this case [1] https://lore.kernel.org/patchwork/patch/1251670/ Dan
On Fri, Jun 12, 2020 at 11:18:57AM -0500, Dan Murphy wrote: > On 6/12/20 11:09 AM, Mark Brown wrote: > > On Fri, Jun 12, 2020 at 11:06:03AM -0500, Dan Murphy wrote: > > > - tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shut-down-gpio", > > > + tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shutdown", > > > GPIOD_OUT_HIGH); > > This also changes the name from shut-down to shutdown which will be > > incompatible (IIRC we do try -gpio as well as -gpios). > Yes the non-standardish name was highlighted by Rob[1]. Yes, but we released with it so it's an ABI now and we should still support the old name.
Mark On 6/12/20 11:22 AM, Mark Brown wrote: > On Fri, Jun 12, 2020 at 11:18:57AM -0500, Dan Murphy wrote: >> On 6/12/20 11:09 AM, Mark Brown wrote: >>> On Fri, Jun 12, 2020 at 11:06:03AM -0500, Dan Murphy wrote: >>>> - tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shut-down-gpio", >>>> + tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shutdown", >>>> GPIOD_OUT_HIGH); >>> This also changes the name from shut-down to shutdown which will be >>> incompatible (IIRC we do try -gpio as well as -gpios). >> Yes the non-standardish name was highlighted by Rob[1]. > Yes, but we released with it so it's an ABI now and we should still > support the old name. Well should we then just revert back to the non-standard name and just fix up the code? Or should we support both properties? Dan
On Fri, Jun 12, 2020 at 11:27:04AM -0500, Dan Murphy wrote: > Well should we then just revert back to the non-standard name and just fix > up the code? > Or should we support both properties? Either option is fine for me, supporting both is a little nicer.
Mark On 6/12/20 11:30 AM, Mark Brown wrote: > On Fri, Jun 12, 2020 at 11:27:04AM -0500, Dan Murphy wrote: > >> Well should we then just revert back to the non-standard name and just fix >> up the code? >> Or should we support both properties? > Either option is fine for me, supporting both is a little nicer. Sounds good I will mark the incorrect property as deprecated: true Dan
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..bb51fd88c41a --- /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 address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f + + 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. + + '#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>; + }; + }; +
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