| Message ID | 1630686919-19495-3-git-send-email-spujar@nvidia.com |
|---|---|
| State | Accepted |
| Commit | 82d3ec1d89fa2750fdc74e2f29c6c7ff673a2768 |
| Headers | show |
| Series | [v3,1/3] ASoC: Add json-schema documentation for sound-name-prefix | expand |
On Fri, Sep 3, 2021 at 11:36 AM Sameer Pujar <spujar@nvidia.com> wrote: > > Use schema reference for 'sound-name-prefix' property wherever > necessary. > > Signed-off-by: Sameer Pujar <spujar@nvidia.com> > Cc: Jerome Brunet <jbrunet@baylibre.com> > Cc: Stephan Gerhold <stephan@gerhold.net> > Cc: Rob Herring <robh+dt@kernel.org> > Reviewed-by: Jerome Brunet <jbrunet@baylibre.com> > Reviewed-by: Rob Herring <robh@kernel.org> > --- [...] > diff --git a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml > index ffb8fcf..68e5ad2 100644 > --- a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml > +++ b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml > @@ -9,6 +9,9 @@ title: NXP/Goodix TFA989X (TFA1) Audio Amplifiers > maintainers: > - Stephan Gerhold <stephan@gerhold.net> > > +allOf: > + - $ref: name-prefix.yaml# > + > properties: > compatible: > enum: > @@ -21,12 +24,6 @@ properties: > '#sound-dai-cells': > const: 0 > > - sound-name-prefix: You can't remove the property. This is now a warning in linux-next: Documentation/devicetree/bindings/sound/nxp,tfa989x.example.dt.yaml: audio-codec@34: 'sound-name-prefix' does not match any of the regexes: 'pinctrl-[0-9]+' From schema: /builds/robherring/linux-dt/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml Documentation/devicetree/bindings/sound/nxp,tfa989x.example.dt.yaml: audio-codec@36: 'sound-name-prefix' does not match any of the regexes: 'pinctrl-[0-9]+' From schema: /builds/robherring/linux-dt/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml Just 'sound-name-prefix: true' is fine > - $ref: /schemas/types.yaml#/definitions/string > - description: > - Used as prefix for sink/source names of the component. Must be a > - unique string among multiple instances of the same component. > - > vddd-supply: > description: regulator phandle for the VDDD power supply. > > diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt > index c473df5..013f534 100644 > --- a/Documentation/devicetree/bindings/sound/rt5659.txt > +++ b/Documentation/devicetree/bindings/sound/rt5659.txt > @@ -42,7 +42,7 @@ Optional properties: > - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin. > - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin. > > -- sound-name-prefix: Please refer to name-prefix.txt > +- sound-name-prefix: Please refer to name-prefix.yaml > > - ports: A Codec may have a single or multiple I2S interfaces. These > interfaces on Codec side can be described under 'ports' or 'port'. > diff --git a/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml b/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml > index 5986d1f..c597d9d 100644 > --- a/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml > +++ b/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml > @@ -13,6 +13,9 @@ description: | > Simple audio multiplexers are driven using gpios, allowing to select which of > their input line is connected to the output line. > > +allOf: > + - $ref: name-prefix.yaml# > + > properties: > compatible: > const: simple-audio-mux > @@ -21,12 +24,6 @@ properties: > description: | > GPIOs used to select the input line. > > - sound-name-prefix: Here too, but I guess we don't have any example to throw a warning?
On 9/20/2021 6:27 PM, Rob Herring wrote: > External email: Use caution opening links or attachments > > > On Fri, Sep 3, 2021 at 11:36 AM Sameer Pujar <spujar@nvidia.com> wrote: >> Use schema reference for 'sound-name-prefix' property wherever >> necessary. >> >> Signed-off-by: Sameer Pujar <spujar@nvidia.com> >> Cc: Jerome Brunet <jbrunet@baylibre.com> >> Cc: Stephan Gerhold <stephan@gerhold.net> >> Cc: Rob Herring <robh+dt@kernel.org> >> Reviewed-by: Jerome Brunet <jbrunet@baylibre.com> >> Reviewed-by: Rob Herring <robh@kernel.org> >> --- > [...] > >> diff --git a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml >> index ffb8fcf..68e5ad2 100644 >> --- a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml >> +++ b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml >> @@ -9,6 +9,9 @@ title: NXP/Goodix TFA989X (TFA1) Audio Amplifiers >> maintainers: >> - Stephan Gerhold <stephan@gerhold.net> >> >> +allOf: >> + - $ref: name-prefix.yaml# >> + >> properties: >> compatible: >> enum: >> @@ -21,12 +24,6 @@ properties: >> '#sound-dai-cells': >> const: 0 >> >> - sound-name-prefix: > You can't remove the property. This is now a warning in linux-next: > > Documentation/devicetree/bindings/sound/nxp,tfa989x.example.dt.yaml: > audio-codec@34: 'sound-name-prefix' does not match any of the regexes: > 'pinctrl-[0-9]+' > From schema: /builds/robherring/linux-dt/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml > Documentation/devicetree/bindings/sound/nxp,tfa989x.example.dt.yaml: > audio-codec@36: 'sound-name-prefix' does not match any of the regexes: > 'pinctrl-[0-9]+' > From schema: /builds/robherring/linux-dt/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml > > > Just 'sound-name-prefix: true' is fine I will push a fix for this.
diff --git a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml index 5f6b37c..0912d3e 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml @@ -17,6 +17,9 @@ maintainers: - Jon Hunter <jonathanh@nvidia.com> - Sameer Pujar <spujar@nvidia.com> +allOf: + - $ref: name-prefix.yaml# + properties: $nodename: pattern: "^dspk@[0-9a-f]*$" @@ -48,12 +51,6 @@ properties: sound-name-prefix: pattern: "^DSPK[1-9]$" - $ref: /schemas/types.yaml#/definitions/string - description: - Used as prefix for sink/source names of the component. Must be a - unique string among multiple instances of the same component. - The name can be "DSPK1" or "DSPKx", where x depends on the maximum - available instances on a Tegra SoC. ports: $ref: /schemas/graph.yaml#/properties/ports diff --git a/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml b/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml index fd275a5..62db982 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml @@ -16,6 +16,9 @@ maintainers: - Jon Hunter <jonathanh@nvidia.com> - Sameer Pujar <spujar@nvidia.com> +allOf: + - $ref: name-prefix.yaml# + properties: $nodename: pattern: "^dmic@[0-9a-f]*$" @@ -49,12 +52,6 @@ properties: sound-name-prefix: pattern: "^DMIC[1-9]$" - $ref: /schemas/types.yaml#/definitions/string - description: - used as prefix for sink/source names of the component. Must be a - unique string among multiple instances of the same component. - The name can be "DMIC1" or "DMIC2" ... "DMICx", where x depends - on the maximum available instances on a Tegra SoC. ports: $ref: /schemas/graph.yaml#/properties/ports diff --git a/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml b/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml index 6337070..f954be6 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml @@ -16,6 +16,9 @@ maintainers: - Jon Hunter <jonathanh@nvidia.com> - Sameer Pujar <spujar@nvidia.com> +allOf: + - $ref: name-prefix.yaml# + properties: $nodename: pattern: "^i2s@[0-9a-f]*$" @@ -65,12 +68,6 @@ properties: sound-name-prefix: pattern: "^I2S[1-9]$" - $ref: /schemas/types.yaml#/definitions/string - description: - Used as prefix for sink/source names of the component. Must be a - unique string among multiple instances of the same component. - The name can be "I2S1" or "I2S2" ... "I2Sx", where x depends - on the maximum available instances on a Tegra SoC. ports: $ref: /schemas/graph.yaml#/properties/ports diff --git a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml index ffb8fcf..68e5ad2 100644 --- a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml +++ b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml @@ -9,6 +9,9 @@ title: NXP/Goodix TFA989X (TFA1) Audio Amplifiers maintainers: - Stephan Gerhold <stephan@gerhold.net> +allOf: + - $ref: name-prefix.yaml# + properties: compatible: enum: @@ -21,12 +24,6 @@ properties: '#sound-dai-cells': const: 0 - sound-name-prefix: - $ref: /schemas/types.yaml#/definitions/string - description: - Used as prefix for sink/source names of the component. Must be a - unique string among multiple instances of the same component. - vddd-supply: description: regulator phandle for the VDDD power supply. diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt index c473df5..013f534 100644 --- a/Documentation/devicetree/bindings/sound/rt5659.txt +++ b/Documentation/devicetree/bindings/sound/rt5659.txt @@ -42,7 +42,7 @@ Optional properties: - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin. - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin. -- sound-name-prefix: Please refer to name-prefix.txt +- sound-name-prefix: Please refer to name-prefix.yaml - ports: A Codec may have a single or multiple I2S interfaces. These interfaces on Codec side can be described under 'ports' or 'port'. diff --git a/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml b/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml index 5986d1f..c597d9d 100644 --- a/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml +++ b/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml @@ -13,6 +13,9 @@ description: | Simple audio multiplexers are driven using gpios, allowing to select which of their input line is connected to the output line. +allOf: + - $ref: name-prefix.yaml# + properties: compatible: const: simple-audio-mux @@ -21,12 +24,6 @@ properties: description: | GPIOs used to select the input line. - sound-name-prefix: - $ref: /schemas/types.yaml#/definitions/string - description: - Used as prefix for sink/source names of the component. Must be a - unique string among multiple instances of the same component. - required: - compatible - mux-gpios