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: <dee496ce-5e74-4a53-c783-6420b2391387@linaro.org>
Date:   Tue, 12 Apr 2022 14:06:40 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.7.0
Subject: Re: [PATCH 1/2] dt-bindings: rtc: Add TI K3 RTC devicetree bindings
 documentation
Content-Language: en-US
To:     Nishanth Menon <nm@ti.com>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Alessandro Zummo <a.zummo@towertech.it>
Cc:     linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-rtc@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        Vignesh Raghavendra <vigneshr@ti.com>
References: <20220412073138.25027-1-nm@ti.com>
 <20220412073138.25027-2-nm@ti.com>
From:   Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
In-Reply-To: <20220412073138.25027-2-nm@ti.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 12/04/2022 09:31, Nishanth Menon wrote:
> This adds the documentation for the devicetree bindings of the Texas
> Instruments RTC modules on K3 family of SoCs such as AM62x SoCs or
> newer.
> 

Thank you for your patch. There is something to discuss/improve.

(...)

> +properties:
> +  compatible:
> +    items:

No need for items. Just enum under the compatible.

> +      - enum:
> +          - ti,am62-rtc
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: VBUS Interface clock
> +      - description: 32k Clock source (external or internal).
> +
> +  clock-names:
> +    items:
> +      - const: "vbus"
> +      - const: "osc32k"

No quotes.

> +
> +  power-domains:
> +    maxItems: 1
> +
> +  assigned-clocks:
> +    description: |
> +      override default osc32k parent clock reference to the osc32k clock entry
> +    maxItems: 1
> +
> +  assigned-clock-parents:
> +    description: |
> +      override default osc32k parent clock phandle of the new parent clock of osc32k
> +    maxItems: 1

Usually assigned-clockXXX are not needed in the bindings. Is here
something different? They are put only to indicate something special.

> +
> +  wakeup-source: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    rtc@2b1f0000 {
> +        compatible = "ti,am62-rtc";
> +        reg = <0x2b1f0000 0x100>;
> +        interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
> +        power-domains = <&bar 0>;
> +        clocks = <&foo 0>, <&foo 1>;
> +        clock-names = "vbus", "osc32k";
> +        wakeup-source;
> +    };
> +
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    rtc@2b1f0000 {
> +        compatible = "ti,am62-rtc";
> +        reg = <0x2b1f0000 0x100>;
> +        interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
> +        power-domains = <&bar 0>;
> +        clocks = <&foo 0>, <&foo 1>;
> +        clock-names = "vbus", "osc32k";
> +        wakeup-source;
> +        assigned-clocks = <&foo 1>;
> +        assigned-clock-parents = <&foo 2>;
> +

Unneeded blank line.

> +    };


Best regards,
Krzysztof