Re: [PATCH v3 1/2] ASoC: dt-bindings: Added schema for "nuvoton,nau8325"

From: Rob Herring
Date: Mon Mar 04 2024 - 08:38:11 EST


On Mon, Mar 04, 2024 at 06:15:22PM +0800, Seven Lee wrote:
> Added a DT schema for describing nau8325 audio amplifiers.

Present tense: Add a ...

Please say more about this device. Features, link to datasheet, etc.

>
> Signed-off-by: Seven Lee <wtli@xxxxxxxxxxx>
> ---
> .../bindings/sound/nuvoton,nau8325.yaml | 74 +++++++++++++++++++
> 1 file changed, 74 insertions(+)
> create mode 100755 Documentation/devicetree/bindings/sound/nuvoton,nau8325.yaml

Schemas aren't executable. checkpatch.pl will tell you this.

>
> diff --git a/Documentation/devicetree/bindings/sound/nuvoton,nau8325.yaml b/Documentation/devicetree/bindings/sound/nuvoton,nau8325.yaml
> new file mode 100755
> index 000000000000..297d29462812
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/nuvoton,nau8325.yaml
> @@ -0,0 +1,74 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/nuvoton,nau8325.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NAU8325 audio Amplifier
> +
> +maintainers:
> + - Seven Lee <WTLI@xxxxxxxxxxx>
> +
> +allOf:
> + - $ref: dai-common.yaml#
> +
> +properties:
> + compatible:
> + const: nuvoton,nau8325
> +
> + reg:
> + maxItems: 1
> +
> + nuvoton,vref-impedance:
> + description:
> + VREF impedance selection.
> + enum: ["Open", "25kOhm", "125kOhm", "2.5kOhm"]

Use standard units (-ohms), not strings. For "open", just omit the
property.

> +
> +
> + nuvoton,dac-vref:
> + description: DAC Reference Voltage Setting.
> + enum: ["External VDDA", "1.5V", "1.6V", "1.7V"]

Use standard units.

> +
> +
> + nuvoton,alc-enable:
> + description:
> + Enable digital automatic level control (ALC) function.
> + type: boolean
> +
> + nuvoton,clock-detection-disable:
> + description:
> + When clock detection is enabled, it will detect whether MCLK
> + and FS are within the range. MCLK range is from 2.048MHz to 24.576MHz.
> + FS range is from 8kHz to 96kHz. And also needs to detect the ratio
> + MCLK_SRC/LRCK of 256, 400 or 500, and needs to detect the BCLK
> + to make sure data is present. There needs to be at least 8 BCLK
> + cycles per Frame Sync.
> + type: boolean
> +
> + nuvoton,clock-det-data:
> + description:
> + Request clock detection to require 2048 non-zero samples before enabling
> + the audio paths. If set then non-zero samples is required, otherwise it
> + doesn't matter.
> + type: boolean
> +
> +required:
> + - compatible
> + - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + codec@21 {
> + compatible = "nuvoton,nau8325";
> + reg = <0x21>;
> + nuvoton,vref-impedance = "125kOhm";
> + nuvoton,dac-vref = "1.6V";
> + nuvoton,alc-enable;
> + nuvoton,clock-det-data;
> + };
> + };
> --
> 2.25.1
>