Re: [PATCH V1 1/3] dt-bindings: sound: add binding for CIX IPBLOQ HDA controller

[Krzysztof Kozlowski <krzk@kernel.org>]

On Thu, Oct 30, 2025 at 07:09:26PM +0800, joakim.zhang@cixtech.com wrote:
> From: Joakim Zhang <joakim.zhang@cixtech.com>
> 
> This patch adds binding for CIX IPBLOQ HDA controller.

Please do not use "This commit/patch/change", but imperative mood. See
longer explanation here:
https://elixir.bootlin.com/linux/v6.16/source/Documentation/process/submitting-patches.rst#L94

Please use standard email subjects, so with the PATCH keyword in the
title. 'git format-patch -vX' helps here to create proper versioned patches.
Another useful tool is b4. Skipping the PATCH keyword makes filtering of
emails more difficult thus making the review process less convenient.

A nit, subject: drop second/last, redundant "binding for". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.17-rc3/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

> 
> Signed-off-by: Joakim Zhang <joakim.zhang@cixtech.com>
> ---
>  .../bindings/sound/cix,ipbloq-hda.yaml        | 69 +++++++++++++++++++
>  1 file changed, 69 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/cix,ipbloq-hda.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/cix,ipbloq-hda.yaml b/Documentation/devicetree/bindings/sound/cix,ipbloq-hda.yaml
> new file mode 100644
> index 000000000000..a4285d1e0319
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/cix,ipbloq-hda.yaml

Filename must match the compatible. See writing bindings doc.

> @@ -0,0 +1,69 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/cix,ipbloq-hda.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: CIX IPBLOQ HDA controller
> +
> +description: |

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

> +  CIX IPBLOQ High Definition Audio (HDA) Controller driver.

driver as in Linux driver? No, please describe here briefly hardware.

> +
> +maintainers:
> +  - Joakim Zhang <joakim.zhang@cixtech.com>
> +
> +properties:
> +  compatible:
> +    const: cix,sky1-ipbloq-hda
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    description: The interrupt from the HDA controller

Drop description, obvious. Cannot be anything else.

> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 2

You should list the items instead with description.

> +
> +  clock-names:
> +    maxItems: 2

No, you need to list the items. There is no syntax like that.

> +
> +  resets:
> +    maxItems: 1
> +
> +  reset-names:
> +    maxItems: 1

No, you need to list the items.

> +
> +  cix,model:
> +    $ref: /schemas/types.yaml#/definitions/string

Use standard properties, see other bindings. Maybe ones from
generic/simple audio card fit.


> +    description: |

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

> +      The user-visible name of this sound complex. If this property is
> +      not specified then boards can use default name provided in hda driver.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +  - resets
> +  - reset-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include<dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    audss_ipb_hda: ipb-hda@70c0000 {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
If you cannot find a name matching your device, please check in kernel
sources for similar cases or you can grow the spec (via pull request to
DT spec repo).

e.g. sound or sound-card. Maybe hda, if it is known enough.

Also drop unused label.

Best regards,
Krzysztof