Re: [PATCH 1/2] dt-bindings: rtc: Add TI K3 RTC devicetree bindings documentation

From: Krzysztof Kozlowski
Date: Tue Apr 12 2022 - 08:42:25 EST


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