Skip to contentSkip to conversation

ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

PATCH Superseded Frank Li 2 participants 2 messages Feb 11 – Feb 12

Subsystems (4)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Frank Li

author maintainer
#0 lore raw

PATCH 1/1 ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

Convert eukrea-tlv320.txt to yaml format.

---
 .../bindings/sound/eukrea,asoc-tlv320.yaml    | 53 +++++++++++++++++++
 .../bindings/sound/eukrea-tlv320.txt          | 26 ---------
 2 files changed, 53 insertions(+), 26 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml new file +53 -0
new file mode 100644
index 0000000000000..483507fa77937
@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/eukrea,asoc-tlv320.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Audio complex for Eukrea boards with tlv320aic23 codec.
+
+maintainers:
+  - Frank Li <[email protected]>
+
+properties:
+  compatible:
+    const: eukrea,asoc-tlv320
+
+  eukrea,model:
+    $ref: /schemas/types.yaml#/definitions/string
+    description:
+      The user-visible name of this sound complex.
+
+  ssi-controller:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      The phandle of the SSI controller.
+
+  fsl,mux-int-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The internal port of the i.MX audio muxer (AUDMUX).
+
+  fsl,mux-ext-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      The external port of the i.MX audio muxer.
+      Note: The AUDMUX port numbering should start at 1, which is consistent with
+      hardware manual.
+
+required:
+  - compatible
+  - eukrea,model
+  - ssi-controller
+
+additionalProperties: false
+
+examples:
+  - |
+    sound {
+        compatible = "eukrea,asoc-tlv320";
+        eukrea,model = "imx51-eukrea-tlv320aic23";
+        ssi-controller = <&ssi2>;
+        fsl,mux-int-port = <2>;
+        fsl,mux-ext-port = <3>;
+    };
Documentation/devicetree/bindings/sound/eukrea-tlv320.txt deleted +0 -26
deleted file mode 100644
index 6dfa88c4dc1e8..0000000000000
@@ -1,26 +0,0 @@
-Audio complex for Eukrea boards with tlv320aic23 codec.
-
-Required properties:
-
-  - compatible		: "eukrea,asoc-tlv320"
-
-  - eukrea,model	: The user-visible name of this sound complex.
-
-  - ssi-controller	: The phandle of the SSI controller.
-
-  - fsl,mux-int-port	: The internal port of the i.MX audio muxer (AUDMUX).
-
-  - fsl,mux-ext-port	: The external port of the i.MX audio muxer.
-
-Note: The AUDMUX port numbering should start at 1, which is consistent with
-hardware manual.
-
-Example:
-
-	sound {
-		compatible = "eukrea,asoc-tlv320";
-		eukrea,model = "imx51-eukrea-tlv320aic23";
-		ssi-controller = <&ssi2>;
-		fsl,mux-int-port = <2>;
-		fsl,mux-ext-port = <3>;
-	};
Signature · 1 line
2.43.0
#1 lore raw
Quoted 36 lines · Frank Li

Convert eukrea-tlv320.txt to yaml format.

---
 .../bindings/sound/eukrea,asoc-tlv320.yaml    | 53 +++++++++++++++++++
 .../bindings/sound/eukrea-tlv320.txt          | 26 ---------
 2 files changed, 53 insertions(+), 26 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml new file +19 -0
new file mode 100644
index 0000000000000..483507fa77937
@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/eukrea,asoc-tlv320.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Audio complex for Eukrea boards with tlv320aic23 codec.
+
+maintainers:
+  - Frank Li <[email protected]>
+
+properties:
+  compatible:
+    const: eukrea,asoc-tlv320
+
+  eukrea,model:
+    $ref: /schemas/types.yaml#/definitions/string
+    description:
+      The user-visible name of this sound complex.

Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml line 29

Quoted 10 lines
Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml new file +10 -0
+
+  ssi-controller:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      The phandle of the SSI controller.
+
+  fsl,mux-int-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The internal port of the i.MX audio muxer (AUDMUX).

Same comment about port numbering applies also for mux-int-port. So better add it here too.

Quoted 4 lines
Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml new file +4 -0
+
+  fsl,mux-ext-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |

Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml line 43

Quoted 10 lines
Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml new file +10 -0
+      The external port of the i.MX audio muxer.
+      Note: The AUDMUX port numbering should start at 1, which is consistent with
+      hardware manual.
+
+required:
+  - compatible
+  - eukrea,model
+  - ssi-controller
+
+additionalProperties: false

The driver sound/soc/fsl/eukrea-tlv320.c allows an optional property named codec-handle
so I'm not sure additionalProperties: false is correct here.