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 0/3] ASoC: dt-bindings: Document routing strings for various codecs
Date: Sat,  9 Aug 2025 17:18:50 +0200	[thread overview]
Message-ID: <20250809151853.47562-1-jihed.chaibi.dev@gmail.com> (raw)

This patch series addresses a challenge for developers configuring ASoC
audio cards in the device tree. Discovering the valid routing strings for
a codec often requires reading the C driver source, which is inefficient,
error-prone, and creates a high barrier to entry.

To improve this, this series adds the lists of these strings (which
correspond to the driver's DAPM widget names) to the descriptions of
three popular audio codec bindings. This makes the documentation more
self-contained and improves the user experience for anyone doing board
bring-up.

While this series adds the documentation as plain text, a potential
future enhancement could be defining these strings as a formal enum
in the binding. This would allow for automated checking and further
improve robustness.

Jihed Chaibi (3):
  ASoC: dt-bindings: everest,es8316: Document routing strings
  ASoC: dt-bindings: nau8825: Document routing strings
  ASoC: dt-bindings: wlf,wm8960: Document routing strings (pin names)

 .../bindings/sound/everest,es8316.yaml        | 14 ++++++++++++
 .../bindings/sound/nuvoton,nau8825.yaml       | 12 ++++++++++
 .../devicetree/bindings/sound/wlf,wm8960.yaml | 22 +++++++++++++++++++
 3 files changed, 48 insertions(+)

-- 
2.39.5


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

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-09 15:18 Jihed Chaibi [this message]
2025-08-09 15:18 ` [PATCH 1/3] ASoC: dt-bindings: everest,es8316: Document routing strings Jihed Chaibi
2025-08-12  7:40   ` 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-1-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).