Skip to contentSkip to conversation

ASoC: dt-bindings: audio-graph-card: Expand 'widgets' documentation

PATCH In review Marek Vasut 2 participants 4 messages Jun 6, 2023 – Jun 15, 2023

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

PATCH 1/1 ASoC: dt-bindings: audio-graph-card: Expand 'widgets' documentation

Document the encoding of 'widgets' property to avoid confusion.

---
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Kuninori Morimoto <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: [email protected]
Cc: [email protected]

---
 Documentation/devicetree/bindings/sound/audio-graph.yaml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/sound/audio-graph.yaml +5 -1
index c87eb91de1593..ed31e04ff6a68 100644
@@ -24,7 +24,11 @@ properties:
       connection's sink, the second being the connection's source.
     $ref: /schemas/types.yaml#/definitions/non-unique-string-array
   widgets:
-    description: User specified audio sound widgets.
+    description: |
+      User specified audio sound widgets.
+      Each entry is a pair of strings, the first being the type of
+      widget ("Microphone", "Line", "Headphone", "Speaker"), the
+      second being the machine specific name for the widget.
     $ref: /schemas/types.yaml#/definitions/non-unique-string-array
   convert-rate:
     $ref: /schemas/sound/dai-params.yaml#/$defs/dai-sample-rate
Signature · 1 line
2.39.2
maintainer
#1 lore raw

Documentation/devicetree/bindings/sound/audio-graph.yaml properties: · line 31

Quoted 9 lines · Marek Vasut

Document the encoding of 'widgets' property to avoid confusion.

widgets:

Documentation/devicetree/bindings/sound/audio-graph.yaml +5 -1
-    description: User specified audio sound widgets.
+    description: |
+      User specified audio sound widgets.
+      Each entry is a pair of strings, the first being the type of
+      widget ("Microphone", "Line", "Headphone", "Speaker"), the
+      second being the machine specific name for the widget.

This looks sensible to me, I don't know if there's a way we can get the tooling to validate either the length or (ideally) the widget type strings?

#2 lore raw
Quoted 12 lines · Mark Brown

Documentation/devicetree/bindings/sound/audio-graph.yaml properties: · line 31

Quoted 9 lines · Marek Vasut

Document the encoding of 'widgets' property to avoid confusion.

widgets:

Documentation/devicetree/bindings/sound/audio-graph.yaml +5 -1
-    description: User specified audio sound widgets.
+    description: |
+      User specified audio sound widgets.
+      Each entry is a pair of strings, the first being the type of
+      widget ("Microphone", "Line", "Headphone", "Speaker"), the
+      second being the machine specific name for the widget.
Quoted 3 lines

This looks sensible to me, I don't know if there's a way we can get the tooling to validate either the length or (ideally) the widget type strings?

It seems there is no way to do validation of every two elements for lists with variable number of elements.

maintainer
#3 lore raw
In reply to Marek Vasut
Quoted 3 lines · Marek Vasut

Document the encoding of 'widgets' property to avoid confusion.

Applied to

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

Thanks!

[1/1] ASoC: dt-bindings: audio-graph-card: Expand 'widgets' documentation

      commit: 7077b1864ca8f0d616c497b3ee890d72d1da0a26

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