[PATCH RESEND v2] dt-bindings: sound: gtm601: convert to YAML

Convert GTM601 binding to the YAML format.

Signed-off-by: David Heidelberg <david@ixit.cz>

Cc: kernel@puri.sm
---
v2:
 - add #sound-dai-cells
 - put kernel@puri.sm into maintainers

 .../devicetree/bindings/sound/gtm601.txt      | 19 ----------
 .../devicetree/bindings/sound/gtm601.yaml     | 36 +++++++++++++++++++
 2 files changed, 36 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/gtm601.txt
 create mode 100644 Documentation/devicetree/bindings/sound/gtm601.yaml

diff --git a/Documentation/devicetree/bindings/sound/gtm601.txt b/Documentation/devicetree/bindings/sound/gtm601.txt
deleted file mode 100644
index efa32a486c4a..000000000000
--- a/Documentation/devicetree/bindings/sound/gtm601.txt
+++ /dev/null

@@ -1,19 +0,0 @@
-GTM601 UMTS modem audio interface CODEC
-
-This device has no configuration interface. The sample rate and channels are
-based on the compatible string
-	"option,gtm601" = 8kHz mono
-	"broadmobi,bm818" = 48KHz stereo
-
-Required properties:
-
-  - compatible : one of
-	"option,gtm601"
-	"broadmobi,bm818"
-
-
-Example:
-
-codec: gtm601_codec {
-	compatible = "option,gtm601";
-};

diff --git a/Documentation/devicetree/bindings/sound/gtm601.yaml b/Documentation/devicetree/bindings/sound/gtm601.yaml
new file mode 100644
index 000000000000..e81a6aa75522
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/gtm601.yaml

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/gtm601.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GTM601 UMTS modem audio interface CODEC
+
+maintainers:
+  - kernel@puri.sm
+
+description: >
+  This device has no configuration interface. The sample rate and channels are
+  based on the compatible string
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - const: broadmobi,bm818
+          - const: option,gtm601
+      - items:
+          - enum:
+              - broadmobi,bm818  # 48 kHz stereo
+              - option,gtm601  # 8 kHz mono
+
+  '#sound-dai-cells':
+    const: 0
+
+additionalProperties: false
+
+examples:
+  - |
+    gtm601_codec {
+        compatible = "option,gtm601";
+    };

-- 
2.40.1

On 30/07/2023 13:51, David Heidelberg wrote:

Convert GTM601 binding to the YAML format.

Signed-off-by: David Heidelberg <david@ixit.cz>

No need for blank line between tags.

Cc: kernel@puri.sm
---
v2:
 - add #sound-dai-cells
 - put kernel@puri.sm into maintainers

 .../devicetree/bindings/sound/gtm601.txt      | 19 ----------
 .../devicetree/bindings/sound/gtm601.yaml     | 36 +++++++++++++++++++

Filename like compatible, please, so option,gtm601.yaml

Missing $ref to dai-common.yaml

No "items" needed here, just use enum.

This does not make much sense. bm818 is either compatible with gtm601 or
is not. Cannot be both.

No underscores, generic names, so "codec" or "audio-codec".

+        compatible = "option,gtm601";

Add dai cells also to the example to make it complete.

+    };

Best regards,
Krzysztof

Thank you for the review. Version 3 has been sent, and I'm hopeful that I have correctly implemented your feedback.

David

On 30/07/2023 20:54, Krzysztof Kozlowski wrote:

On 30/07/2023 13:51, David Heidelberg wrote:

quoted

Convert GTM601 binding to the YAML format.

Signed-off-by: David Heidelberg <david@ixit.cz>

No need for blank line between tags.

quoted

Cc: kernel@puri.sm
---
v2:
  - add #sound-dai-cells
  - put kernel@puri.sm into maintainers

  .../devicetree/bindings/sound/gtm601.txt      | 19 ----------
  .../devicetree/bindings/sound/gtm601.yaml     | 36 +++++++++++++++++++

Filename like compatible, please, so option,gtm601.yaml

quoted

  2 files changed, 36 insertions(+), 19 deletions(-)
  delete mode 100644 Documentation/devicetree/bindings/sound/gtm601.txt
  create mode 100644 Documentation/devicetree/bindings/sound/gtm601.yaml

diff --git a/Documentation/devicetree/bindings/sound/gtm601.txt b/Documentation/devicetree/bindings/sound/gtm601.txt
deleted file mode 100644
index efa32a486c4a..000000000000
--- a/Documentation/devicetree/bindings/sound/gtm601.txt
+++ /dev/null

@@ -1,19 +0,0 @@
-GTM601 UMTS modem audio interface CODEC
-
-This device has no configuration interface. The sample rate and channels are
-based on the compatible string
-	"option,gtm601" = 8kHz mono
-	"broadmobi,bm818" = 48KHz stereo
-
-Required properties:
-
-  - compatible : one of
-	"option,gtm601"
-	"broadmobi,bm818"
-
-
-Example:
-
-codec: gtm601_codec {
-	compatible = "option,gtm601";
-};

diff --git a/Documentation/devicetree/bindings/sound/gtm601.yaml b/Documentation/devicetree/bindings/sound/gtm601.yaml
new file mode 100644
index 000000000000..e81a6aa75522
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/gtm601.yaml

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/gtm601.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GTM601 UMTS modem audio interface CODEC
+
+maintainers:
+  - kernel@puri.sm
+
+description: >
+  This device has no configuration interface. The sample rate and channels are
+  based on the compatible string
+

Missing $ref to dai-common.yaml

quoted

+properties:
+  compatible:
+    oneOf:
+      - items:
+          - const: broadmobi,bm818
+          - const: option,gtm601
+      - items:

No "items" needed here, just use enum.

quoted

+          - enum:
+              - broadmobi,bm818  # 48 kHz stereo
+              - option,gtm601  # 8 kHz mono

This does not make much sense. bm818 is either compatible with gtm601 or
is not. Cannot be both.

quoted

+
+  '#sound-dai-cells':
+    const: 0
+
+additionalProperties: false
+
+examples:
+  - |
+    gtm601_codec {

No underscores, generic names, so "codec" or "audio-codec".

quoted

+        compatible = "option,gtm601";

Add dai cells also to the example to make it complete.

quoted

+    };

Best regards,
Krzysztof

-- 
David Heidelberg
Certified Linux Magician