Unverified Commit 214db271 authored by Mark Brown's avatar Mark Brown
Browse files

Merge series "Convert name-prefix doc to json-schema" from Sameer Pujar <spujar@nvidia.com>: 

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

Changelog
=========

v2 -> v3
--------
 * Removed examples in patch 1/3 as suggested by Rob
 * Added reviewed tag from Jerome for the series
 * Added reviewed tag from Rob for patch 2/3

v1 -> v2
--------
 * Provide top reference to name-prefix.yaml as suggested by Rob
   for patch 2/3
 * Dropped couple of unreachable email ids from Cc list in commit
   message of patch 2/3
 * No changes in remaining patches

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     | 21 +++++++++++++++++++
 .../bindings/sound/nvidia,tegra186-dspk.yaml       |  9 +++-----
 .../bindings/sound/nvidia,tegra210-dmic.yaml       |  9 +++-----
 .../bindings/sound/nvidia,tegra210-i2s.yaml        |  9 +++-----
 .../devicetree/bindings/sound/nxp,tfa989x.yaml     |  9 +++-----
 Documentation/devicetree/bindings/sound/rt5659.txt |  2 +-
 .../bindings/sound/simple-audio-mux.yaml           |  9 +++-----
 8 files changed, 37 insertions(+), 55 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/name-prefix.txt
 create mode 100644 Documentation/devicetree/bindings/sound/name-prefix.yaml

--
2.7.4
parents 0beeb330 955cc348

Documentation/devicetree/bindings/sound/name-prefix.txt

deleted100644 → 0
+0 −24
Original line number Diff line number Diff line 
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";

};

Documentation/devicetree/bindings/sound/name-prefix.yaml

0 → 100644
+21 −0
Original line number Diff line number Diff line 
# 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

Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml

+3 −6
Original line number Diff line number Diff line
@@ -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

Documentation/devicetree/bindings/sound/nvidia,tegra210-dmic.yaml

+3 −6
Original line number Diff line number Diff line
@@ -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

Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml

+3 −6
Original line number Diff line number Diff line
@@ -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