ASoC: dt-bindings: audio-graph-card: Expand 'widgets' documentation
authorMarek Vasut <marex@denx.de>
Tue, 6 Jun 2023 17:59:51 +0000 (19:59 +0200)
committerMark Brown <broonie@kernel.org>
Fri, 9 Jun 2023 09:44:42 +0000 (10:44 +0100)
Document the encoding of 'widgets' property to avoid confusion.

Signed-off-by: Marek Vasut <marex@denx.de>
Link: https://lore.kernel.org/r/20230606175951.215740-1-marex@denx.de
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/audio-graph.yaml

index c87eb91de159324b032f4c00078b2172021d9d80..ed31e04ff6a681d279946f64f749a61a54599698 100644 (file)
@@ -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