Re: [PATCH 02/18] ASoC: dt-bindings: mediatek,mt8365-mt6357: Add audio sound card document

Krzysztof Kozlowski
2024-02-27T09:06:50Z

On 26/02/2024 15:01, Alexandre Mergnat wrote:
> Add soundcard bindings for the MT8365 SoC with the MT6357 audio codec.
>
> Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com>
> ---
> .../bindings/sound/mediatek,mt8365-mt6357.yaml | 127 +++++++++++++++++++++
> 1 file changed, 127 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/sound/mediatek,mt8365-mt6357.yaml b/Documentation/devicetree/bindings/sound/mediatek,mt8365-mt6357.yaml
> new file mode 100644
> index 000000000000..f469611ec6b6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/mediatek,mt8365-mt6357.yaml
> @@ -0,0 +1,127 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/mediatek,mt8365-mt6357.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Mediatek MT8365 sound card with MT6357 sound codec.

Drop full stop. This is title.

> +
> +maintainers:
> + - Alexandre Mergnat <amergnat@baylibre.com>
> +
> +description:
> + This binding describes the MT8365 sound card.

Say something useful. There is no need to say that binding is a binding
describing something. Or just drop it if this is obvious.

> +
> +properties:
> + compatible:
> + const: mediatek,mt8365-mt6357
> +
> + mediatek,hp-pull-down:
> + description:
> + Earphone driver positive output stage short to the
> + audio reference ground.
> + Default value is false.

That's obvious, isn't it? Drop.

> + type: boolean
> +
> + mediatek,micbias0-microvolt:
> + description: |
> + Selects MIC Bias 0 output voltage.
> + [1.7v, 1.8v, 1.9v, 2.0v, 2.1v, 2.5v, 2.6v, 2.7v]
> + enum: [0, 1, 2, 3, 4, 5, 6, 7]

0 is 0V, not 1.7! That's total mess. You use here microvolts. Look at
property name.

> +
> + mediatek,micbias1-microvolt:
> + description: |
> + Selects MIC Bias 1 output voltage.
> + [1.7v, 1.8v, 1.9v, 2.0v, 2.1v, 2.5v, 2.6v, 2.7v]
> + enum: [0, 1, 2, 3, 4, 5, 6, 7]
> +
> + mediatek,platform:
> + $ref: /schemas/types.yaml#/definitions/phandle
> + description: The phandle of MT8365 ASoC platform.
> +
> + pinctrl-names:
> + minItems: 1
> + items:
> + - const: aud_default

Drop redundant parts. aud looks like block name.

> + - const: aud_dmic
> + - const: aud_miso_off
> + - const: aud_miso_on
> + - const: aud_mosi_off
> + - const: aud_mosi_on
> +
> + vaud28-supply:
> + description:
> + 2.8 volt supply for the audio codec
> +
> +patternProperties:
> + "^dai-link-[0-9]+$":
> + type: object
> + description:
> + Container for dai-link level properties and CODEC sub-nodes.
> +
> + properties:
> + codec:
> + type: object
> + description: Holds subnode which indicates codec dai.
> +
> + properties:
> + sound-dai:
> + maxItems: 1
> + description: phandle of the codec DAI
> +
> + additionalProperties: false
> +
> + link-name:
> + description:
> + This property corresponds to the name of the BE dai-link to which
> + we are going to update parameters in this node.
> + items:
> + const: 2ND I2S BE
> +
> + sound-dai:
> + maxItems: 1
> + description: phandle of the CPU DAI
> +
> + additionalProperties: false
> +
> + required:
> + - link-name
> + - sound-dai
> +
> +additionalProperties: false

This goes after required: block. See example schema.

> +
> +required:
> + - compatible
> + - mediatek,platform
> + - pinctrl-names
> + - vaud28-supply
> +

Best regards,
Krzysztof