Re: [PATCH v3 03/21] ASoC: dt-bindings: Add binding for Apple Silicon Mac audio

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] ASoC: dt-bindings: apple,macaudio: additionalProperties blocks tdm-slot $ref
--

commit 212ef47e302889aa8e011388085ecf8d026993bf
Author: Martin Povišer <povik+lin@cutebit.org>

ASoC: dt-bindings: Add binding for Apple Silicon Mac audio

This commit adds a devicetree binding for the primary audio subsystem on
Apple Silicon Macs, integrating the MCA I2S peripheral and codecs for
driving the headphone jack and speaker arrays.

> diff --git a/Documentation/devicetree/bindings/sound/apple,macaudio.yaml b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> new file mode 100644
> index 0000000000000..af8e9686ba7bb
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> @@ -0,0 +1,212 @@

[ ... ]

> +patternProperties:
> +  "^dai-link(@[0-9a-f]+)?$":
> +    description: |
> +      Node for each sound peripheral such as the speaker array, headphones jack,
> +      or microphone.
> +    type: object
> +    $ref: tdm-slot.yaml#
> +    additionalProperties: false

[Severity: Low]
Does setting additionalProperties: false alongside $ref: tdm-slot.yaml# in
the ^dai-link(@[0-9a-f]+)?$ schema block all properties defined in
tdm-slot.yaml?

In dtschema, additionalProperties: false only permits property names
matched by the immediate schema object's properties and patternProperties
keywords, ignoring properties defined in a sibling $ref unless they are
also listed locally:

Documentation/devicetree/bindings/writing-schema.rst:
  * additionalProperties: false
      Most common case, where no additional schema is referenced or if this
      binding allows subset of properties from other referenced schemas.

  * unevaluatedProperties: false
      Used when this binding references other schema whose all properties
      should be allowed.

Because none of the properties from tdm-slot.yaml (such as
dai-tdm-slot-num, dai-tdm-slot-width, dai-tdm-idle-mode, or the mask
properties) are listed in the local properties or patternProperties of
^dai-link(@[0-9a-f]+)?$, any dai-link subnode using standard tdm-slot.yaml
properties will fail dtbs_check validation.

Should this use unevaluatedProperties: false instead, or should the
node-level $ref: tdm-slot.yaml# be dropped if only the locally defined
^dai-tdm-idle-mode-[0-9]$ and ^dai-tdm-slot-tx-idle-mask-[0-9]$
patternProperties are intended?

[ ... ]

> +    patternProperties:
> +      "^dai-tdm-idle-mode-[0-9]$":
> +        $ref: tdm-slot.yaml#/properties/dai-tdm-idle-mode
> +
> +      "^dai-tdm-slot-tx-idle-mask-[0-9]$":
> +        $ref: /schemas/types.yaml#/definitions/uint32
> +        description: Idle slot mask. A bit being set to 1 indicates
> +          that the corresponding TDM slot is inactive/idle.
> +
> +    required:
> +      - reg
> +      - codec
> +      - cpu

[ ... ]

>
> -- 
> 2.51.2
>

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261018-macaudio-v3-0-abdff7741dea@gmail.com?part=3