devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
To: linux-sound@vger.kernel.org
Cc: lgirdwood@gmail.com, broonie@kernel.org, robh@kernel.org,
	krzk+dt@kernel.org, conor+dt@kernel.org, drake@endlessm.com,
	katsuhiro@katsuster.net, matteomartelli3@gmail.com,
	zhoubinbin@loongson.cn, KCHSU0@nuvoton.com,
	patches@opensource.cirrus.com, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, shuah@kernel.org,
	jihed.chaibi.dev@gmail.com
Subject: [PATCH 1/3] ASoC: dt-bindings: everest,es8316: Document routing strings
Date: Sat,  9 Aug 2025 17:18:51 +0200	[thread overview]
Message-ID: <20250809151853.47562-2-jihed.chaibi.dev@gmail.com> (raw)
In-Reply-To: <20250809151853.47562-1-jihed.chaibi.dev@gmail.com>

The es8316 driver defines several DAPM widget names that are used for
audio routing in the device tree. However, these strings are not
documented in the binding file.

This forces developers to read the C source to discover the valid
names, which can be inefficient and error-prone.

Add a list of the input and output widget names to the binding's
description to make it self-contained and improve the user
experience for board bring-up.

Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
 .../devicetree/bindings/sound/everest,es8316.yaml  | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/devicetree/bindings/sound/everest,es8316.yaml b/Documentation/devicetree/bindings/sound/everest,es8316.yaml
index e4b2eb5fa..cd073dd0c 100644
--- a/Documentation/devicetree/bindings/sound/everest,es8316.yaml
+++ b/Documentation/devicetree/bindings/sound/everest,es8316.yaml
@@ -12,6 +12,20 @@ maintainers:
   - Matteo Martelli <matteomartelli3@gmail.com>
   - Binbin Zhou <zhoubinbin@loongson.cn>
 
+description: |
+  Everest ES8311, ES8316 and ES8323 audio CODECs
+
+  Valid routing names defined in the driver for this codec include:
+
+    Outputs:
+      * HPOL: Left Headphone Output
+      * HPOR: Right Headphone Output
+
+    Inputs:
+      * DMIC: Digital Microphone Input
+      * MIC1: Analog Microphone Input 1
+      * MIC2: Analog Microphone Input 2
+
 allOf:
   - $ref: dai-common.yaml#
 
-- 
2.39.5


  reply	other threads:[~2025-08-09 15:20 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-09 15:18 [PATCH 0/3] ASoC: dt-bindings: Document routing strings for various codecs Jihed Chaibi
2025-08-09 15:18 ` Jihed Chaibi [this message]
2025-08-12  7:40   ` [PATCH 1/3] ASoC: dt-bindings: everest,es8316: Document routing strings Krzysztof Kozlowski
2025-08-12 11:05     ` Mark Brown
2025-09-02  7:57       ` Krzysztof Kozlowski
2025-08-09 15:18 ` [PATCH 2/3] ASoC: dt-bindings: nau8825: " Jihed Chaibi
2025-08-12  7:42   ` Krzysztof Kozlowski
2025-08-09 15:18 ` [PATCH 3/3] ASoC: dt-bindings: wlf,wm8960: Document routing strings (pin names) Jihed Chaibi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250809151853.47562-2-jihed.chaibi.dev@gmail.com \
    --to=jihed.chaibi.dev@gmail.com \
    --cc=KCHSU0@nuvoton.com \
    --cc=broonie@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=drake@endlessm.com \
    --cc=katsuhiro@katsuster.net \
    --cc=krzk+dt@kernel.org \
    --cc=lgirdwood@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-sound@vger.kernel.org \
    --cc=matteomartelli3@gmail.com \
    --cc=patches@opensource.cirrus.com \
    --cc=robh@kernel.org \
    --cc=shuah@kernel.org \
    --cc=zhoubinbin@loongson.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).