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

[Krzysztof Kozlowski]

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@xxxxxxxxx>
> ---
>  .../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@xxxxxxxxx>
>    - Binbin Zhou <zhoubinbin@xxxxxxxxxxx>
>  
> +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