[PATCH 0/3] Convert name-prefix doc to json-schema
Following are the changes: - Add json-schema for 'sound-name-prefix' documentation under 'name-perfix.yaml' - Use schema references wherever needed. - Remove txt based doc
Sameer Pujar (3): ASoC: Add json-schema documentation for sound-name-prefix ASoC: Use schema reference for sound-name-prefix ASoC: Remove name-prefix.txt
.../devicetree/bindings/sound/name-prefix.txt | 24 --------------- .../devicetree/bindings/sound/name-prefix.yaml | 35 ++++++++++++++++++++++ .../bindings/sound/nvidia,tegra186-dspk.yaml | 7 +---- .../bindings/sound/nvidia,tegra210-dmic.yaml | 7 +---- .../bindings/sound/nvidia,tegra210-i2s.yaml | 7 +---- .../devicetree/bindings/sound/nxp,tfa989x.yaml | 5 +--- Documentation/devicetree/bindings/sound/rt5659.txt | 2 +- .../bindings/sound/simple-audio-mux.yaml | 5 +--- 8 files changed, 41 insertions(+), 51 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/name-prefix.txt create mode 100644 Documentation/devicetree/bindings/sound/name-prefix.yaml
The 'sound-name-prefix' is used to prepend suitable strings to a component widgets or controls. This is helpful when there are multiple instances of the same component. Add relevant json-schema and is inspired from sound-name-prefix.txt documentation.
Signed-off-by: Sameer Pujar spujar@nvidia.com Cc: Jerome Brunet jbrunet@baylibre.com Cc: Rob Herring robh+dt@kernel.org --- .../devicetree/bindings/sound/name-prefix.yaml | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/name-prefix.yaml
diff --git a/Documentation/devicetree/bindings/sound/name-prefix.yaml b/Documentation/devicetree/bindings/sound/name-prefix.yaml new file mode 100644 index 00000000..b58cc9e --- /dev/null +++ b/Documentation/devicetree/bindings/sound/name-prefix.yaml @@ -0,0 +1,35 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/name-prefix.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Component sound name prefix + +maintainers: + - Jerome Brunet jbrunet@baylibre.com + +properties: + sound-name-prefix: + $ref: /schemas/types.yaml#/definitions/string + description: | + Card implementing the routing property define the connection between + audio components as list of string pair. Component using the same + sink/source names may use this property to prepend the name of their + sinks/sources with the provided string. + +additionalProperties: true + +examples: + - | + analog-amplifier@0 { + compatible = "simple-audio-amplifier"; + sound-name-prefix = "FRONT"; + }; + + analog-amplifier@1 { + compatible = "simple-audio-amplifier"; + sound-name-prefix = "BACK"; + }; + +...
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: bardliao@realtek.com Cc: Alexandre Belloni aleandre.belloni@bootlin.com Cc: Rob Herring robh+dt@kernel.org --- Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml | 7 +------ Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml | 7 +------ Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml | 7 +------ Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml | 5 +---- Documentation/devicetree/bindings/sound/rt5659.txt | 2 +- Documentation/devicetree/bindings/sound/simple-audio-mux.yaml | 5 +---- 6 files changed, 6 insertions(+), 27 deletions(-)
diff --git a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml index 5f6b37c..ae04a11 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml @@ -48,12 +48,7 @@ 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. + $ref: "name-prefix.yaml#/properties/sound-name-prefix"
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..0f9f449 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml @@ -49,12 +49,7 @@ 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. + $ref: "name-prefix.yaml#/properties/sound-name-prefix"
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..a830b58 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml @@ -65,12 +65,7 @@ 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. + $ref: "name-prefix.yaml#/properties/sound-name-prefix"
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..c93b10c 100644 --- a/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml +++ b/Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml @@ -22,10 +22,7 @@ properties: 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. + $ref: "name-prefix.yaml#/properties/sound-name-prefix"
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..5333682 100644 --- a/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml +++ b/Documentation/devicetree/bindings/sound/simple-audio-mux.yaml @@ -22,10 +22,7 @@ properties: 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. + $ref: "name-prefix.yaml#/properties/sound-name-prefix"
required: - compatible
On Wed, Sep 1, 2021 at 11:19 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: bardliao@realtek.com Cc: Alexandre Belloni aleandre.belloni@bootlin.com Cc: Rob Herring robh+dt@kernel.org
Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml | 7 +------ Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml | 7 +------ Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml | 7 +------ Documentation/devicetree/bindings/sound/nxp,tfa989x.yaml | 5 +---- Documentation/devicetree/bindings/sound/rt5659.txt | 2 +- Documentation/devicetree/bindings/sound/simple-audio-mux.yaml | 5 +---- 6 files changed, 6 insertions(+), 27 deletions(-)
diff --git a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml index 5f6b37c..ae04a11 100644 --- a/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml +++ b/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml @@ -48,12 +48,7 @@ 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 aunique string among multiple instances of the same component.The name can be "DSPK1" or "DSPKx", where x depends on the maximumavailable instances on a Tegra SoC.
- $ref: "name-prefix.yaml#/properties/sound-name-prefix"
This is generally not how we reference common properties.
Either you add a $ref to the whole schema document at the top level of this one or add a 'select: true' in name-prefix.yaml.
Rob
Since schema name-prefix.yaml is available and references are updated, remove txt based doc.
Signed-off-by: Sameer Pujar spujar@nvidia.com Cc: Jerome Brunet jbrunet@baylibre.com Cc: Rob Herring robh+dt@kernel.org --- .../devicetree/bindings/sound/name-prefix.txt | 24 ---------------------- 1 file changed, 24 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/name-prefix.txt
diff --git a/Documentation/devicetree/bindings/sound/name-prefix.txt b/Documentation/devicetree/bindings/sound/name-prefix.txt deleted file mode 100644 index 6457759..00000000 --- a/Documentation/devicetree/bindings/sound/name-prefix.txt +++ /dev/null @@ -1,24 +0,0 @@ -Name prefix: - -Card implementing the routing property define the connection between -audio components as list of string pair. Component using the same -sink/source names may use the name prefix property to prepend the -name of their sinks/sources with the provided string. - -Optional name prefix property: -- sound-name-prefix : string using as prefix for the sink/source names of - the component. - -Example: Two instances of the same component. - -amp0: analog-amplifier@0 { - compatible = "simple-audio-amplifier"; - enable-gpios = <&gpio GPIOH_3 0>; - sound-name-prefix = "FRONT"; -}; - -amp1: analog-amplifier@1 { - compatible = "simple-audio-amplifier"; - enable-gpios = <&gpio GPIOH_4 0>; - sound-name-prefix = "BACK"; -};
participants (2)
-
Rob Herring -
Sameer Pujar