diff mbox series

[V2,1/2] dt-bindings: rtc: Add TI K3 RTC description

Message ID 20220511002600.27964-2-nm@ti.com (mailing list archive)
State New, archived
Headers show
Series rtc: Introduce rtc-ti-k3 | expand

Commit Message

Nishanth Menon May 11, 2022, 12:25 a.m. UTC
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.

Signed-off-by: Nishanth Menon <nm@ti.com>
---
Changes since V1:
Krzysztof's comments addressed:
* $subject updated
* assigned-clocks* dropped
* Dropped the un-necessary quotes
* Dropped the extra example, which serves no purpose now.
* compatible is just an enum now.

V1: https://lore.kernel.org/all/20220412073138.25027-2-nm@ti.com/

 .../devicetree/bindings/rtc/ti,k3-rtc.yaml    | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml

Comments

Krzysztof Kozlowski May 11, 2022, 4:28 p.m. UTC | #1
On 11/05/2022 02:25, 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.
> 
> Signed-off-by: Nishanth Menon <nm@ti.com>
> ---
> Changes since V1:
> Krzysztof's comments addressed:
> * $subject updated
> * assigned-clocks* dropped
> * Dropped the un-necessary quotes
> * Dropped the extra example, which serves no purpose now.
> * compatible is just an enum now.
> 
> V1: https://lore.kernel.org/all/20220412073138.25027-2-nm@ti.com/
> 
>  .../devicetree/bindings/rtc/ti,k3-rtc.yaml    | 61 +++++++++++++++++++
>  1 file changed, 61 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml b/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml
> new file mode 100644
> index 000000000000..444e18df6231
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml
> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/ti,k3-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments K3 Real Time Clock
> +
> +maintainers:
> +  - Nishanth Menon <nm@ti.com>
> +
> +description: |
> +  This RTC appears in the AM62x family of SoCs.
> +
> +properties:
> +  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
> +
> +  power-domains:
> +    maxItems: 1
> +
> +  wakeup-source: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +
> +additionalProperties: false

I didn't brought it earlier (I assumed you used existing RTC examples
for your schema): why this is not including generic rtc.yaml schema?
Isn't this a RTC?


Best regards,
Krzysztof
Nishanth Menon May 11, 2022, 7:38 p.m. UTC | #2
On 18:28-20220511, Krzysztof Kozlowski wrote:
> On 11/05/2022 02:25, Nishanth Menon wrote:
[...]

> 
> I didn't brought it earlier (I assumed you used existing RTC examples
> for your schema): why this is not including generic rtc.yaml schema?
> Isn't this a RTC?

Oversight, and I suppose I picked a bad example to emulate :(

I assume you mean adding:
allOf:
  - $ref: "rtc.yaml#"

Like this:
https://gist.github.com/nmenon/0c326c92fbadecd042209c0078f0af99 ?
Krzysztof Kozlowski May 12, 2022, 10:12 a.m. UTC | #3
On 11/05/2022 21:38, Nishanth Menon wrote:
> On 18:28-20220511, Krzysztof Kozlowski wrote:
>> On 11/05/2022 02:25, Nishanth Menon wrote:
> [...]
> 
>>
>> I didn't brought it earlier (I assumed you used existing RTC examples
>> for your schema): why this is not including generic rtc.yaml schema?
>> Isn't this a RTC?
> 
> Oversight, and I suppose I picked a bad example to emulate :(
> 
> I assume you mean adding:
> allOf:
>   - $ref: "rtc.yaml#"
> 
> Like this:
> https://gist.github.com/nmenon/0c326c92fbadecd042209c0078f0af99 ?

Yes plus you need to use unevaluatedProperties:false and remove
wakeup-source (it's coming from rtc.yaml).

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml b/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml
new file mode 100644
index 000000000000..444e18df6231
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/ti,k3-rtc.yaml
@@ -0,0 +1,61 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/ti,k3-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments K3 Real Time Clock
+
+maintainers:
+  - Nishanth Menon <nm@ti.com>
+
+description: |
+  This RTC appears in the AM62x family of SoCs.
+
+properties:
+  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
+
+  power-domains:
+    maxItems: 1
+
+  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;
+    };