Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <e9fd112f-0fd2-e833-8687-9a256c307842@linaro.org>
Date:   Wed, 16 Nov 2022 09:20:21 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.4.2
Subject: Re: [PATCH 1/2] dtbindings: clock: Add bindings for Renesas PhiClock
Content-Language: en-US
To:     Alex Helms <alexander.helms.jy@renesas.com>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-clk@vger.kernel.org
Cc:     krzysztof.kozlowski+dt@linaro.org, robh+dt@kernel.org,
        sboyd@kernel.org, mturquette@baylibre.com, geert+renesas@glider.be
References: <20221115192625.9410-1-alexander.helms.jy@renesas.com>
 <20221115192625.9410-2-alexander.helms.jy@renesas.com>
From:   Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
In-Reply-To: <20221115192625.9410-2-alexander.helms.jy@renesas.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 15/11/2022 20:26, Alex Helms wrote:
> Add dt bindings for the Renesas PhiClock clock generator.
> 

Subject: drop second, redundant "bindings"

> Signed-off-by: Alex Helms <alexander.helms.jy@renesas.com>
> ---
>  .../bindings/clock/renesas,phiclock.yaml      | 81 +++++++++++++++++++
>  MAINTAINERS                                   |  5 ++
>  2 files changed, 86 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/renesas,phiclock.yaml
> 
> diff --git a/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml b/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml
> new file mode 100644
> index 000000000..2b36534d3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml

Filename based on compatible.

> @@ -0,0 +1,81 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/clock/renesas,phiclock.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas PhiClock Clock Generator Device Tree Bindings

Drop "Device Tree Bindings"

> +
> +maintainers:
> +  - Alex Helms <alexander.helms.jy@renesas.com>
> +
> +description: |
> +  The Renesas PhiClock is a programmable I2C clock generator that provides
> +  1 reference output and 2 clock outputs.
> +
> +  The driver supports spread spectrum but only if all configurations use the

Driver as in Linux driver? Drop entire paragraph. Bindings are about
hardware, not driver.

> +  same spread spectrum parameters. If your configuration uses spread spectrum,
> +  you must include renesas,ss-amount-percent, renesas,ss-modulation-hz, and
> +  renesas,ss-direction in the device tree.
> +
> +properties:

compatible goes always first. Start your schema from example-schema.yaml.

> +  '#clock-cells':
> +    const: 1
> +
> +  clock-names:
> +    items:
> +      - const: xin-clkin

Just "xin" or entirely drop.

> +
> +  clocks:
> +    const: 1
> +
> +  compatible:
> +    enum:
> +      - renesas,9fgv1006
> +
> +  reg:
> +    maxItems: 1
> +
> +  renesas,ss-amount-percent:
> +    description: Spread spectrum absolute amount as hundredths of a percent, e.g. 150 is 1.50%.

What? If this is percent then it cannot be hundreds of percent. Percent
is percent. Use appropriate units.
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml

> +    minimum: 0
> +    maximum: 500
> +
> +  renesas,ss-modulation-hz:
> +    description: Spread spectrum modulation rate in Hz
> +    minimum: 30000
> +    maximum: 63000
> +
> +  renesas,ss-direction:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description: Spread spectrum direction
> +    enum: [ down, center ]
> +
> +required:
> +  - clock-names
> +  - '#clock-cells'
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    ref25: ref25m {
> +      compatible = "fixed-clock";
> +      #clock-cells = <0>;
> +      clock-frequency = <25000000>;
> +    };

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

> +

Best regards,
Krzysztof