| Message ID | 20220915113955.22521-2-astrid.rost@axis.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | ASoC: ts3a227e control debounce times | expand |
On 15/09/2022 12:39, Astrid Rost wrote: > Convert from ts3a227e.txt to yaml. > > Signed-off-by: Astrid Rost <astrid.rost@axis.com> Thank you for your patch. There is something to discuss/improve. > --- > .../devicetree/bindings/sound/ts3a227e.txt | 30 -------- > .../devicetree/bindings/sound/ts3a227e.yaml | 69 +++++++++++++++++++ > 2 files changed, 69 insertions(+), 30 deletions(-) > --- /dev/null > +++ b/Documentation/devicetree/bindings/sound/ts3a227e.yaml > @@ -0,0 +1,69 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: "http://devicetree.org/schemas/sound/ts3a227e.yaml#" Filename based on compatible, so ti,ts3a227e.yaml > +$schema: "http://devicetree.org/meta-schemas/core.yaml#" Drop quotes from both lines above. > + > +title: Texas Instruments TS3A227E > + Autonomous Audio Accessory Detection and Configuration Switch > + > +maintainers: > + - Dylan Reid <dgreid@chromium.org> > + > +description: | > + The TS3A227E detect headsets of 3-ring and 4-ring standards and > + switches automatically to route the microphone correctly. It also > + handles key press detection in accordance with the Android audio > + headset specification v1.0. > + > +properties: > + compatible: > + enum: > + - ti,ts3a227e > + > + reg: > + description: I2C address of the device. Skip description, it's obvious. > + const: 0x3b > + > + interrupts: > + maxItems: 1 > + description: | > + Interrupt number for /INT pin from the ts3a227e. Skip description > + > + ti,micbias: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: Intended MICBIAS voltage (datasheet section 9.6.7). > + enum: > + - 0 # 2.1 V > + - 1 # 2.2 V > + - 2 # 2.3 V > + - 3 # 2.4 V > + - 4 # 2.5 V > + - 5 # 2.6 V > + - 6 # 2.7 V > + - 7 # 2.8 V > + default: 2 Old bindings said default is 1. It this was intended, please mention in commit msg deviations from pure conversion. > + > +required: > + - compatible > + - reg > + - interrupts > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/gpio/gpio.h> This header is not used. > + #include <dt-bindings/interrupt-controller/irq.h> > + i2c0 { Node name just "i2c" > + #address-cells = <1>; > + #size-cells = <0>; > + codec: ts3a227e@3b { Node names should be generic. https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation audio-controller? audio-switch? > + compatible = "ti,ts3a227e"; > + reg = <0x3b>; > + interrupt-parent = <&gpio1>; > + interrupts = <3 IRQ_TYPE_LEVEL_LOW>; > + }; > + }; > + > +... Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/sound/ts3a227e.txt b/Documentation/devicetree/bindings/sound/ts3a227e.txt deleted file mode 100644 index 21ab45bc7e8f..000000000000 --- a/Documentation/devicetree/bindings/sound/ts3a227e.txt +++ /dev/null @@ -1,30 +0,0 @@ -Texas Instruments TS3A227E -Autonomous Audio Accessory Detection and Configuration Switch - -The TS3A227E detect headsets of 3-ring and 4-ring standards and -switches automatically to route the microphone correctly. It also -handles key press detection in accordance with the Android audio -headset specification v1.0. - -Required properties: - - - compatible: Should contain "ti,ts3a227e". - - reg: The i2c address. Should contain <0x3b>. - - interrupts: Interrupt number for /INT pin from the 227e - -Optional properies: - - ti,micbias: Intended MICBIAS voltage (datasheet section 9.6.7). - Select 0/1/2/3/4/5/6/7 to specify MICBIAS voltage - 2.1V/2.2V/2.3V/2.4V/2.5V/2.6V/2.7V/2.8V - Default value is "1" (2.2V). - -Examples: - - i2c { - ts3a227e@3b { - compatible = "ti,ts3a227e"; - reg = <0x3b>; - interrupt-parent = <&gpio>; - interrupts = <3 IRQ_TYPE_LEVEL_LOW>; - }; - }; diff --git a/Documentation/devicetree/bindings/sound/ts3a227e.yaml b/Documentation/devicetree/bindings/sound/ts3a227e.yaml new file mode 100644 index 000000000000..3512b1f1e32b --- /dev/null +++ b/Documentation/devicetree/bindings/sound/ts3a227e.yaml @@ -0,0 +1,69 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: "http://devicetree.org/schemas/sound/ts3a227e.yaml#" +$schema: "http://devicetree.org/meta-schemas/core.yaml#" + +title: Texas Instruments TS3A227E + Autonomous Audio Accessory Detection and Configuration Switch + +maintainers: + - Dylan Reid <dgreid@chromium.org> + +description: | + The TS3A227E detect headsets of 3-ring and 4-ring standards and + switches automatically to route the microphone correctly. It also + handles key press detection in accordance with the Android audio + headset specification v1.0. + +properties: + compatible: + enum: + - ti,ts3a227e + + reg: + description: I2C address of the device. + const: 0x3b + + interrupts: + maxItems: 1 + description: | + Interrupt number for /INT pin from the ts3a227e. + + ti,micbias: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Intended MICBIAS voltage (datasheet section 9.6.7). + enum: + - 0 # 2.1 V + - 1 # 2.2 V + - 2 # 2.3 V + - 3 # 2.4 V + - 4 # 2.5 V + - 5 # 2.6 V + - 6 # 2.7 V + - 7 # 2.8 V + default: 2 + +required: + - compatible + - reg + - interrupts + +additionalProperties: false + +examples: + - | + #include <dt-bindings/gpio/gpio.h> + #include <dt-bindings/interrupt-controller/irq.h> + i2c0 { + #address-cells = <1>; + #size-cells = <0>; + codec: ts3a227e@3b { + compatible = "ti,ts3a227e"; + reg = <0x3b>; + interrupt-parent = <&gpio1>; + interrupts = <3 IRQ_TYPE_LEVEL_LOW>; + }; + }; + +...
Convert from ts3a227e.txt to yaml. Signed-off-by: Astrid Rost <astrid.rost@axis.com> --- .../devicetree/bindings/sound/ts3a227e.txt | 30 -------- .../devicetree/bindings/sound/ts3a227e.yaml | 69 +++++++++++++++++++ 2 files changed, 69 insertions(+), 30 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/ts3a227e.txt create mode 100644 Documentation/devicetree/bindings/sound/ts3a227e.yaml