Skip to contentSkip to conversation

dt-bindings: sound: gtm601: convert to YAML

PATCH In review David Heidelberg 4 participants 4 messages Jul 30, 2023 – Jul 31, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 dt-bindings: sound: gtm601: convert to YAML

Convert GTM601 binding to the YAML format.

---
v4:
- added missing required property
v3:
- incorporated feedback from Krzysztof
v2:
- add #sound-dai-cells
- put [email protected] into maintainers

 .../devicetree/bindings/sound/gtm601.txt      | 19 ---------
 .../bindings/sound/option,gtm601.yaml         | 40 +++++++++++++++++++
 2 files changed, 40 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/gtm601.txt
 create mode 100644 Documentation/devicetree/bindings/sound/option,gtm601.yaml
Documentation/devicetree/bindings/sound/gtm601.txt deleted +0 -19
deleted file mode 100644
index efa32a486c4a..000000000000
@@ -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";
-};
Documentation/devicetree/bindings/sound/option,gtm601.yaml new file +40 -0
new file mode 100644
index 000000000000..69c2ccc79dc5
@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/option,gtm601.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GTM601 UMTS modem audio interface CODEC
+
+maintainers:
+  - [email protected]
+
+description: >
+  This device has no configuration interface. The sample rate and channels are
+  based on the compatible string
+
+properties:
+  compatible:
+    oneOf:
+      - items:  # 48 kHz stereo
+          - const: broadmobi,bm818
+          - const: option,gtm601
+      - const: option,gtm601  # 8 kHz mono
+
+  '#sound-dai-cells':
+    const: 0
+
+required:
+  - compatible
+
+allOf:
+  - $ref: dai-common.yaml#
+
+additionalProperties: false
+
+examples:
+  - |
+    codec {
+        compatible = "option,gtm601";
+        #sound-dai-cells = <0>;
+    };
Signature · 1 line
2.40.1
#2 lore raw
In reply to David Heidelberg

Hi,

Quoted 61 lines · David Heidelberg

Convert GTM601 binding to the YAML format.

---
v4:
- added missing required property
v3:
- incorporated feedback from Krzysztof
v2:
- add #sound-dai-cells
- put [email protected] into maintainers

 .../devicetree/bindings/sound/gtm601.txt      | 19 ---------
 .../bindings/sound/option,gtm601.yaml         | 40 +++++++++++++++++++
 2 files changed, 40 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/gtm601.txt
 create mode 100644 Documentation/devicetree/bindings/sound/option,gtm601.yaml
Documentation/devicetree/bindings/sound/gtm601.txt deleted +0 -19
deleted file mode 100644
index efa32a486c4a..000000000000
@@ -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";
-};
Documentation/devicetree/bindings/sound/option,gtm601.yaml new file +12 -0
new file mode 100644
index 000000000000..69c2ccc79dc5
@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/option,gtm601.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GTM601 UMTS modem audio interface CODEC
+
+maintainers:
+  - [email protected]
+
+description: >

Documentation/devicetree/bindings/sound/option,gtm601.yaml line 22

Quoted 10 lines
Documentation/devicetree/bindings/sound/option,gtm601.yaml new file +10 -0
+  This device has no configuration interface. The sample rate and channels are
+  based on the compatible string
+
+properties:
+  compatible:
+    oneOf:
+      - items:  # 48 kHz stereo
+          - const: broadmobi,bm818
+          - const: option,gtm601
+      - const: option,gtm601  # 8 kHz mono

This looks good to me. I just wonder if it makes sense to use a description instead of comments to make the sampling rate/channel requirements a bit more obvious:

- description: Broadmobi BM818 (48kHz stereo) items:
- const: broadmobi,bm818
- const: option,gtm601
- description: Option GTM601 audio code (8kHz mono)
const: option,gtm601

Cheers,
-- Guido

Quoted 21 lines
Documentation/devicetree/bindings/sound/option,gtm601.yaml new file +18 -0
+
+  '#sound-dai-cells':
+    const: 0
+
+required:
+  - compatible
+
+allOf:
+  - $ref: dai-common.yaml#
+
+additionalProperties: false
+
+examples:
+  - |
+    codec {
+        compatible = "option,gtm601";
+        #sound-dai-cells = <0>;
+    };
Signature · 1 line
2.40.1
maintainer
#3 lore raw
In reply to David Heidelberg
Quoted 3 lines · David Heidelberg

Convert GTM601 binding to the YAML format.

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] dt-bindings: sound: gtm601: convert to YAML

      commit: cd8ee8aba1f3b5dd4118dc8cea05b73734983288

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark