ASoC: dt-bindings: samsung,tm2: convert to dtschema
authorKrzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Sat, 29 Jan 2022 12:24:30 +0000 (13:24 +0100)
committerMark Brown <broonie@kernel.org>
Thu, 10 Feb 2022 13:21:02 +0000 (13:21 +0000)
Convert the audio complex on Samsung TM2 boards with Samsung Exynos SoC
to DT schema format.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220129122430.45694-5-krzysztof.kozlowski@canonical.com
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt [deleted file]
Documentation/devicetree/bindings/sound/samsung,tm2.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
deleted file mode 100644 (file)
index f5ccc12..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-Samsung Exynos5433 TM2(E) audio complex with WM5110 codec
-
-Required properties:
-
- - compatible           : "samsung,tm2-audio"
- - model                : the user-visible name of this sound complex
- - audio-codec          : the first entry should be phandle of the wm5110 audio
-                          codec node, as described in ../mfd/arizona.txt;
-                          the second entry should be phandle of the HDMI
-                          transmitter node
- - i2s-controller       : the list of phandle and argument tuples pointing to
-                          I2S controllers, the first entry should be I2S0 and
-                          the second one I2S1
- - audio-amplifier      : the phandle of the MAX98504 amplifier
- - samsung,audio-routing : a list of the connections between audio components;
-                          each entry is a pair of strings, the first being the
-                          connection's sink, the second being the connection's
-                          source; valid names for sources and sinks are the
-                          WM5110's and MAX98504's pins and the jacks on the
-                          board: HP, SPK, Main Mic, Sub Mic, Third Mic,
-                          Headset Mic
- - mic-bias-gpios       : GPIO pin that enables the Main Mic bias regulator
-
-
-Example:
-
-sound {
-       compatible = "samsung,tm2-audio";
-       audio-codec = <&wm5110>, <&hdmi>;
-       i2s-controller = <&i2s0 0>, <&i2s1 0>;
-       audio-amplifier = <&max98504>;
-       mic-bias-gpios = <&gpr3 2 0>;
-       model = "wm5110";
-       samsung,audio-routing =
-               "HP", "HPOUT1L",
-               "HP", "HPOUT1R",
-               "SPK", "SPKOUT",
-               "SPKOUT", "HPOUT2L",
-               "SPKOUT", "HPOUT2R",
-               "Main Mic", "MICBIAS2",
-               "IN1R", "Main Mic";
-};
diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2.yaml b/Documentation/devicetree/bindings/sound/samsung,tm2.yaml
new file mode 100644 (file)
index 0000000..74712d6
--- /dev/null
@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/samsung,tm2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Samsung Exynos5433 TM2(E) audio complex with WM5110 codec
+
+maintainers:
+  - Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
+  - Sylwester Nawrocki <s.nawrocki@samsung.com>
+
+properties:
+  compatible:
+    const: samsung,tm2-audio
+
+  audio-amplifier:
+    description: Phandle to the MAX98504 amplifier.
+    $ref: /schemas/types.yaml#/definitions/phandle
+
+  audio-codec:
+    description: Phandles to the codecs.
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    items:
+      - description: Phandle to the WM5110 audio codec.
+      - description: Phandle to the HDMI transmitter node.
+
+  samsung,audio-routing:
+    description: |
+      List of the connections between audio components; each entry is
+      a pair of strings, the first being the connection's sink, the second
+      being the connection's source; valid names for sources and sinks are the
+      WM5110's and MAX98504's pins and the jacks on the board: HP, SPK, Main
+      Mic, Sub Mic, Third Mic, Headset Mic.
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+
+  i2s-controller:
+    description: Phandles to the I2S controllers.
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    items:
+      - description: Phandle to I2S0.
+      - description: Phandle to I2S1.
+
+  mic-bias-gpios:
+    description: GPIO pin that enables the Main Mic bias regulator.
+
+  model:
+    description: The user-visible name of this sound complex.
+    $ref: /schemas/types.yaml#/definitions/string
+
+required:
+  - compatible
+  - audio-amplifier
+  - audio-codec
+  - samsung,audio-routing
+  - i2s-controller
+  - mic-bias-gpios
+  - model
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    sound {
+        compatible = "samsung,tm2-audio";
+        audio-codec = <&wm5110>, <&hdmi>;
+        i2s-controller = <&i2s0 0>, <&i2s1 0>;
+        audio-amplifier = <&max98504>;
+        mic-bias-gpios = <&gpr3 2 GPIO_ACTIVE_HIGH>;
+        model = "wm5110";
+        samsung,audio-routing = "HP", "HPOUT1L",
+                                "HP", "HPOUT1R",
+                                "SPK", "SPKOUT",
+                                "SPKOUT", "HPOUT2L",
+                                "SPKOUT", "HPOUT2R",
+                                "RCV", "HPOUT3L",
+                                "RCV", "HPOUT3R";
+    };