linux-kernel - Re: [PATCH 1/3] ASoC: dt-bindings: everest,es8316: Document routing strings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <d5d0133f-1b42-4ad0-a3e0-2a2bdeb67484@kernel.org>
Date: Tue, 12 Aug 2025 09:40:20 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Jihed Chaibi <jihed.chaibi.dev@...il.com>, linux-sound@...r.kernel.org
Cc: lgirdwood@...il.com, broonie@...nel.org, robh@...nel.org,
 krzk+dt@...nel.org, conor+dt@...nel.org, drake@...lessm.com,
 katsuhiro@...suster.net, matteomartelli3@...il.com, zhoubinbin@...ngson.cn,
 KCHSU0@...oton.com, patches@...nsource.cirrus.com,
 devicetree@...r.kernel.org, linux-kernel@...r.kernel.org, shuah@...nel.org
Subject: Re: [PATCH 1/3] ASoC: dt-bindings: everest,es8316: Document routing
 strings

On 09/08/2025 17:18, Jihed Chaibi wrote:
> 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.

Reading free form text is as inefficient and error-prone as reading the
driver.

> 
> 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@...il.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@...il.com>
>    - Binbin Zhou <zhoubinbin@...ngson.cn>
>  
> +description: |
> +  Everest ES8311, ES8316 and ES8323 audio CODECs
> +
> +  Valid routing names defined in the driver for this codec include:

Anyway, don't describe drivers but hardware.

Best regards,
Krzysztof