| Message ID | 20240826-cs4271-yaml-v1-1-dad3f0b041ef@maquefel.me (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | ASoC: dt-bindings: cirrus,cs4271: Convert to dtschema | expand |
On Mon, 26 Aug 2024 12:53:08 +0300, Nikita Shubin wrote: > Convert the Cirrus Logic CS4271 audio CODEC bindings to DT schema. > > Cc: Alexander Sverdlin <alexander.sverdlin@gmail.com> > Signed-off-by: Nikita Shubin <nikita.shubin@maquefel.me> > Link: https://lore.kernel.org/all/20240715-ep93xx-v11-0-4e924efda795@maquefel.me > --- > This is complementary patch to ep93xx DT conversion series. > > Based on "ASoC: dt-bindings: cirrus,cs4270: Convert to dtschema" patch. > --- > .../devicetree/bindings/sound/cirrus,cs4271.yaml | 91 ++++++++++++++++++++++ > Documentation/devicetree/bindings/sound/cs4271.txt | 57 -------------- > 2 files changed, 91 insertions(+), 57 deletions(-) > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: ./Documentation/devicetree/bindings/sound/cirrus,cs4271.yaml:91:4: [error] no new line character at the end of file (new-line-at-end-of-file) dtschema/dtc warnings/errors: doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240826-cs4271-yaml-v1-1-dad3f0b041ef@maquefel.me The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
On 26/08/2024 11:53, Nikita Shubin via B4 Relay wrote: > From: Nikita Shubin <nikita.shubin@maquefel.me> > > Convert the Cirrus Logic CS4271 audio CODEC bindings to DT schema. > > Cc: Alexander Sverdlin <alexander.sverdlin@gmail.com> > Signed-off-by: Nikita Shubin <nikita.shubin@maquefel.me> > Link: https://lore.kernel.org/all/20240715-ep93xx-v11-0-4e924efda795@maquefel.me I think Link goes above your SoB. Your Sob must be the last tag from you. > --- > This is complementary patch to ep93xx DT conversion series. ... > + > +title: Cirrus Logic CS4271 audio CODEC > + > +maintainers: > + - Alexander Sverdlin <alexander.sverdlin@gmail.com> > + - Nikita Shubin <nikita.shubin@maquefel.me> > + > +description: > + The CS4271 is a stereo audio codec. This driver supports both the I2C > + and the SPI bus. Drop references to driver. You can say that device supports configuration over I2C and SPI. > + > +allOf: > + - $ref: dai-common.yaml# > + - $ref: /schemas/spi/spi-peripheral-props.yaml# > + > +properties: > + compatible: > + const: cirrus,cs4271 > + > + reg: > + maxItems: 1 > + > + spi-cpha: true > + > + spi-cpol: true > + > + '#sound-dai-cells': > + const: 0 None of these three were present in original binding. > + > + reset-gpio: If it bases on cs4270, look there - there is no "gpio", but "gpios". Mention changes in commit msg. > + description: > + This pin will be deasserted before communication to the codec starts. > + maxItems: 1 > + > + va-supply: > + description: Analog power supply. > + > + vd-supply: > + description: Digital power supply. > + > + vl-supply: > + description: Serial Control Port power supply. > + > + port: > + $ref: audio-graph-port.yaml# > + unevaluatedProperties: false This wasn't present in original binding and nothing in commit msg explained changes from pure conversion. Explain them in commit msg. > + > + cirrus,amuteb-eq-bmutec: > + description: > + When given, the Codec's AMUTEB=BMUTEC flag is enabled. > + type: boolean > + > + cirrus,enable-soft-reset: > + description: | > + The CS4271 requires its LRCLK and MCLK to be stable before its RESET > + line is de-asserted. That also means that clocks cannot be changed > + without putting the chip back into hardware reset, which also requires > + a complete re-initialization of all registers. > + > + One (undocumented) workaround is to assert and de-assert the PDN bit > + in the MODE2 register. This workaround can be enabled with this DT > + property. > + > + Note that this is not needed in case the clocks are stable > + throughout the entire runtime of the codec. > + type: boolean > + > +required: > + - compatible > + - reg > + > +unevaluatedProperties: false > + > +examples: > + - | > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + cs4271: codec@0 { Drop unused label. > + compatible = "cirrus,cs4271"; > + reg = <0>; > + reset-gpio = <&gpio0 1 0>; Use defines for flags. Also, make the example complete. You miss many properties. > + }; > + }; > + > +... > \ No newline at end of file This needs to be always fixed before posting. Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs4271.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs4271.yaml new file mode 100644 index 000000000000..dd104483ab81 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/cirrus,cs4271.yaml @@ -0,0 +1,91 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/cirrus,cs4271.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Cirrus Logic CS4271 audio CODEC + +maintainers: + - Alexander Sverdlin <alexander.sverdlin@gmail.com> + - Nikita Shubin <nikita.shubin@maquefel.me> + +description: + The CS4271 is a stereo audio codec. This driver supports both the I2C + and the SPI bus. + +allOf: + - $ref: dai-common.yaml# + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + const: cirrus,cs4271 + + reg: + maxItems: 1 + + spi-cpha: true + + spi-cpol: true + + '#sound-dai-cells': + const: 0 + + reset-gpio: + description: + This pin will be deasserted before communication to the codec starts. + maxItems: 1 + + va-supply: + description: Analog power supply. + + vd-supply: + description: Digital power supply. + + vl-supply: + description: Serial Control Port power supply. + + port: + $ref: audio-graph-port.yaml# + unevaluatedProperties: false + + cirrus,amuteb-eq-bmutec: + description: + When given, the Codec's AMUTEB=BMUTEC flag is enabled. + type: boolean + + cirrus,enable-soft-reset: + description: | + The CS4271 requires its LRCLK and MCLK to be stable before its RESET + line is de-asserted. That also means that clocks cannot be changed + without putting the chip back into hardware reset, which also requires + a complete re-initialization of all registers. + + One (undocumented) workaround is to assert and de-assert the PDN bit + in the MODE2 register. This workaround can be enabled with this DT + property. + + Note that this is not needed in case the clocks are stable + throughout the entire runtime of the codec. + type: boolean + +required: + - compatible + - reg + +unevaluatedProperties: false + +examples: + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + cs4271: codec@0 { + compatible = "cirrus,cs4271"; + reg = <0>; + reset-gpio = <&gpio0 1 0>; + }; + }; + +... \ No newline at end of file diff --git a/Documentation/devicetree/bindings/sound/cs4271.txt b/Documentation/devicetree/bindings/sound/cs4271.txt deleted file mode 100644 index 6e699ceabacd..000000000000 --- a/Documentation/devicetree/bindings/sound/cs4271.txt +++ /dev/null @@ -1,57 +0,0 @@ -Cirrus Logic CS4271 DT bindings - -This driver supports both the I2C and the SPI bus. - -Required properties: - - - compatible: "cirrus,cs4271" - -For required properties on SPI, please consult -Documentation/devicetree/bindings/spi/spi-bus.txt - -Required properties on I2C: - - - reg: the i2c address - - -Optional properties: - - - reset-gpio: a GPIO spec to define which pin is connected to the chip's - !RESET pin - - cirrus,amuteb-eq-bmutec: When given, the Codec's AMUTEB=BMUTEC flag - is enabled. - - cirrus,enable-soft-reset: - The CS4271 requires its LRCLK and MCLK to be stable before its RESET - line is de-asserted. That also means that clocks cannot be changed - without putting the chip back into hardware reset, which also requires - a complete re-initialization of all registers. - - One (undocumented) workaround is to assert and de-assert the PDN bit - in the MODE2 register. This workaround can be enabled with this DT - property. - - Note that this is not needed in case the clocks are stable - throughout the entire runtime of the codec. - - - vd-supply: Digital power - - vl-supply: Logic power - - va-supply: Analog Power - -Examples: - - codec_i2c: cs4271@10 { - compatible = "cirrus,cs4271"; - reg = <0x10>; - reset-gpio = <&gpio 23 0>; - vd-supply = <&vdd_3v3_reg>; - vl-supply = <&vdd_3v3_reg>; - va-supply = <&vdd_3v3_reg>; - }; - - codec_spi: cs4271@0 { - compatible = "cirrus,cs4271"; - reg = <0x0>; - reset-gpio = <&gpio 23 0>; - spi-max-frequency = <6000000>; - }; -