Re: [PATCH v2 1/2] ASoC: dt-bindings: Add PDM controller for the StarFive JH8100 SoC

From: Krzysztof Kozlowski
Date: Tue Apr 23 2024 - 05:49:45 EST


On 23/04/2024 10:34, Xingyu Wu wrote:
> Add bindings about the PDM controller for the StarFive JH8100 SoC.
>
> Signed-off-by: Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>

If there is going to be resend/new version, three nits. Anyway:

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxx>

..

> +
> +title: StarFive JH8100 PDM controller
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> + The Pulse Density Modulation (PDM) controller is a digital PDM out
> + microphone interface controller and decoder that supports both up to 4
> + channels, and an Inter-IC Sound (I2S) transmitter that outputs standard
> + stereo audio data to another device. The I2S transmitter can be
> + configured to operate either a master or a slave (default mode). The PDM
> + controller includes two PDM blocks, each PDM block can drive one
> + bitstream sampling clock and two bitstream coming data (mono/stereo)
> + with sampling clock rising and falling edge.
> +
> +maintainers:
> + - Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>
> + - Walker Chen <walker.chen@xxxxxxxxxxxxxxxx>
> +
> +allOf:
> + - $ref: dai-common.yaml#
> +
> +properties:
> + compatible:
> + const: starfive,jh8100-pdm
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + items:
> + - description: DMIC output clock
> + - description: Main ICG clock
> +
> + clock-names:
> + items:
> + - const: dmic
> + - const: icg
> +
> + resets:
> + maxItems: 1
> +
> + "#sound-dai-cells":
> + const: 0
> +
> + starfive,syscon:
> + $ref: /schemas/types.yaml#/definitions/phandle-array
> + items:
> + - items:
> + - description: phandle to System Register Controller sys_syscon_ne node.
> + - description: PDM source enabled control offset of SYS_SYSCON_NE register.
> + - description: PDM source enabled control mask
> + description:
> + The phandle to System Register Controller syscon node and the PDM source
> + from I2S enabled control offset and mask of SYS_SYSCON_NE register.

This description duplicates items. Drop redundant parts (there is really
never a need to say phandle is a phandle because it cannot be anything
else). Instead say what is it used for.


> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - resets
> + - '#sound-dai-cells'

Use consistent quotes, either ' or "



Best regards,
Krzysztof