Skip to contentSkip to conversation

dt-bindings: sound: add toshiba,apb-dummy-codec binding

PATCH In review Pablo D. Bergamasco 3 participants 5 messages Jun 16 – Jun 18

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

PATCH 1/1 dt-bindings: sound: add toshiba,apb-dummy-codec binding

Add device tree binding documentation for the Toshiba APBridge dummy ALSA SoC codec used in the Greybus audio framework.

Fixes the following checkpatch warning:
WARNING: DT compatible string appears un-documented

---
 .../sound/toshiba,apb-dummy-codec.yaml        | 33 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/toshiba,apb-dummy-codec.yaml
Documentation/devicetree/bindings/sound/toshiba,apb-dummy-codec.yaml new file +33 -0
new file mode 100644
index 000000000000..e0542feeb980
@@ -0,0 +1,33 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/toshiba,apb-dummy-codec.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Toshiba APBridge Dummy ALSA SoC Codec
+
+maintainers:
+  - Vaibhav Agarwal <[email protected]>
+
+description:
+  The APBridge dummy codec is part of the Greybus audio framework,
+  used in Project Ara modular phone hardware. It provides a dummy
+  ALSA SoC codec driver for the APBridge audio interface, enabling
+  audio streaming between Greybus modules and the host processor
+  via the APBridge protocol.
+
+properties:
+  compatible:
+    const: toshiba,apb-dummy-codec
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    codec {
+        compatible = "toshiba,apb-dummy-codec";
+    };
+...
MAINTAINERS +1 -0
index b2040011a386..b6b4b488c0f7 100644
@@ -11077,6 +11077,7 @@ GREYBUS AUDIO PROTOCOLS DRIVERS
 M:	Vaibhav Agarwal <[email protected]>
 M:	Mark Greer <[email protected]>
 S:	Maintained
+F:	Documentation/devicetree/bindings/sound/toshiba,apb-dummy-codec.yaml
 F:	drivers/staging/greybus/audio_apbridgea.c
 F:	drivers/staging/greybus/audio_apbridgea.h
 F:	drivers/staging/greybus/audio_codec.c
Signature · 1 line
2.54.0
maintainer
#1 lore raw
Quoted 2 lines · Pablo D. Bergamasco

Add device tree binding documentation for the Toshiba APBridge dummy ALSA SoC codec used in the Greybus audio framework.

Please submit patches using subject lines reflecting the style for the subsystem, this makes it easier for people to identify relevant patches. Look at what existing commits in the area you're changing are doing and make sure your subject lines visually resemble what they're doing. There's no need to resubmit to fix this alone.

#2 lore raw
In reply to Pablo D. Bergamasco
Quoted 5 lines · Pablo D. Bergamasco

Add device tree binding documentation for the Toshiba APBridge dummy ALSA SoC codec used in the Greybus audio framework.

Fixes the following checkpatch warning:
WARNING: DT compatible string appears un-documented

Nope. We don't take bindings for staging. Isn't this documented in staging docs already?

Best regards,
Krzysztof

#3 lore raw
Quoted 2 lines · Krzysztof Kozlowski

Nope. We don't take bindings for staging. Isn't this documented in staging docs already?

I checked drivers/staging/greybus/Documentation/ and found only firmware and sysfs documentation. There is no existing DT binding documentation for the "toshiba,apb-dummy-codec" compatible string.

Should I add the binding documentation within the staging directory itself, or is there a preferred approach for staging drivers?

Best regards,
Pablo D. Bergamasco

#4 lore raw
Quoted 10 lines · Pablo D. Bergamasco
Quoted 2 lines · Krzysztof Kozlowski

Nope. We don't take bindings for staging. Isn't this documented in staging docs already?

I checked drivers/staging/greybus/Documentation/ and found only firmware and sysfs documentation. There is no existing DT binding documentation for the "toshiba,apb-dummy-codec" compatible string.

Should I add the binding documentation within the staging directory itself, or is there a preferred approach for staging drivers?

We don't take bindings for staging drivers outside. I do not know if it makes sense to have any bindings inside staging itself. Honestly it does not matter to me.

You should not be fixing checkpatch warnings blindly.

Best regards,
Krzysztof