Skip to contentSkip to conversation

Convert TI dmtimer binding to yaml

PATCH Superseded Tony Lindgren 3 participants 8 messages Apr 12, 2022 – Apr 13, 2022

Subsystems (3)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover Convert TI dmtimer binding to yaml

Hi all,

Here's v3 changes for TI dmtimer changes.

Regards,

Tony

Changes since v1:

- Improve yaml for various checks based on comments from Krzysztof and Nishanth

- Add checks for am4 timer as pointed out by Krzysztof and Rob

- Split am6 additions into a separate patch as suggested by Krzysztof

Changes since v2:

- Improve yaml for more checks based on comments from Grygorii and Krzysztof

Tony Lindgren (2):
dt-bindings: timer: Update TI timer to yaml
dt-bindings: timer: Add compatible for am6 for TI timer-dm

 .../bindings/pwm/pwm-omap-dmtimer.txt         |   2 +-
 .../bindings/timer/ti,timer-dm.yaml           | 171 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 -----
 3 files changed, 172 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/timer/ti,timer-dm.yaml
 delete mode 100644 Documentation/devicetree/bindings/timer/ti,timer.txt
Signature · 6 lines
2.35.1

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
#1 lore raw

PATCH v3 1/2 dt-bindings: timer: Update TI timer to yaml

Let's update the TI timer binding to use yaml. As this binding is specific to the TI dual-mode timers also known as dm-timers, let's use file name ti,timer-dm.yaml to avoid confusion with other timers.

We also correct the issue with the old binding that was out of date for several properties.

The am43 related timers are undocumented, but compatible with the am3 timers. Let's add the am43 timers too.

The dm814 and dm816 timers are missing, let's add them.

Some timers on some SoCs are dual mapped, like the ABE timers on omap4 and 5. The reg property maxItems must be updated to 2.

The timer clocks can be managed by the parent interconnect target module with no clocks assigned for the timer node. And in some cases the SoC may need to configure additional clocks for the timer in addition to the functional clock.

The clock names are optional and not specific to the comptible property. For example, dra7 timers on l3 interconnect do not need clock-names,while the timers on dra7 l4 interconnect need them with both being compatible with ti,omap5430-timer.

Cc Daniel Lezcano <[email protected]>
Cc Keerthy <[email protected]>
Cc Nishanth Menon <[email protected]>
Cc Vignesh Raghavendra <[email protected]>
---
 .../bindings/pwm/pwm-omap-dmtimer.txt         |   2 +-
 .../bindings/timer/ti,timer-dm.yaml           | 161 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 -----
 3 files changed, 162 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/timer/ti,timer-dm.yaml
 delete mode 100644 Documentation/devicetree/bindings/timer/ti,timer.txt
Documentation/devicetree/bindings/pwm/pwm-omap-dmtimer.txt +1 -1
@@ -2,7 +2,7 @@
 
 Required properties:
 - compatible: Shall contain "ti,omap-dmtimer-pwm".
-- ti,timers: phandle to PWM capable OMAP timer. See timer/ti,timer.txt for info
+- ti,timers: phandle to PWM capable OMAP timer. See timer/ti,timer-dm.yaml for info
   about these timers.
 - #pwm-cells: Should be 3. See pwm.yaml in this directory for a description of
   the cells format.
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +161 -0

161 lines not on this page · raw message

Documentation/devicetree/bindings/timer/ti,timer.txt deleted +0 -44

44 lines not on this page · raw message

Signature · 6 lines
2.35.1

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
#2 lore raw

Re: [PATCH 1/2] dt-bindings: timer: Update TI timer to yaml

Quoted 158 lines · Tony Lindgren

Let's update the TI timer binding to use yaml. As this binding is specific to the TI dual-mode timers also known as dm-timers, let's use file name ti,timer-dm.yaml to avoid confusion with other timers.

We also correct the issue with the old binding that was out of date for several properties.

The am43 related timers are undocumented, but compatible with the am3 timers. Let's add the am43 timers too.

The dm814 and dm816 timers are missing, let's add them.

Some timers on some SoCs are dual mapped, like the ABE timers on omap4 and 5. The reg property maxItems must be updated to 2.

The timer clocks can be managed by the parent interconnect target module with no clocks assigned for the timer node. And in some cases the SoC may need to configure additional clocks for the timer in addition to the functional clock.

The clock names are optional and not specific to the comptible property. For example, dra7 timers on l3 interconnect do not need clock-names,while the timers on dra7 l4 interconnect need them with both being compatible with ti,omap5430-timer.

Cc Daniel Lezcano <[email protected]>
Cc Keerthy <[email protected]>
Cc Nishanth Menon <[email protected]>
Cc Vignesh Raghavendra <[email protected]>
---
 .../bindings/pwm/pwm-omap-dmtimer.txt         |   2 +-
 .../bindings/timer/ti,timer-dm.yaml           | 161 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 -----
 3 files changed, 162 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/timer/ti,timer-dm.yaml
 delete mode 100644 Documentation/devicetree/bindings/timer/ti,timer.txt
Documentation/devicetree/bindings/pwm/pwm-omap-dmtimer.txt +1 -1
@@ -2,7 +2,7 @@
 
 Required properties:
 - compatible: Shall contain "ti,omap-dmtimer-pwm".
-- ti,timers: phandle to PWM capable OMAP timer. See timer/ti,timer.txt for info
+- ti,timers: phandle to PWM capable OMAP timer. See timer/ti,timer-dm.yaml for info
   about these timers.
 - #pwm-cells: Should be 3. See pwm.yaml in this directory for a description of
   the cells format.
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +103 -0
new file mode 100644
@@ -0,0 +1,161 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/timer/ti,timer-dm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI dual-mode timer
+
+maintainers:
+  - Tony Lindgren <[email protected]>
+
+description: |
+  The TI dual-mode timer is a general purpose timer with PWM capabilities.
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - ti,am335x-timer
+              - ti,am335x-timer-1ms
+              - ti,dm814-timer
+              - ti,dm816-timer
+              - ti,omap2420-timer
+              - ti,omap3430-timer
+              - ti,omap4430-timer
+              - ti,omap5430-timer
+      - items:
+          - const: ti,am4372-timer
+          - const: ti,am335x-timer
+      - items:
+          - const: ti,am4372-timer-1ms
+          - const: ti,am335x-timer-1ms
+
+  reg:
+    minItems: 1
+    maxItems: 2
+
+  clocks:
+    minItems: 1
+    maxItems: 2
+
+  clock-names:
+    minItems: 1
+    maxItems: 2
+
+  interrupts:
+    description:
+      Interrupt if available. The timer PWM features may be usable
+      in a limited way even without interrupts.
+    maxItems: 1
+
+  ti,timer-alwon:
+    description:
+      Timer is always enabled when the SoC is powered. Note that some SoCs like
+      am335x can suspend to PM coprocessor RTC only mode and in that case the
+      SoC power is cut including timers.
+    type: boolean
+
+  ti,timer-dsp:
+    description:
+      Timer is routable to the DSP in addition to the operating system.
+    type: boolean
+
+  ti,timer-pwm:
+    description:
+      Timer has been wired for PWM capability.
+    type: boolean
+
+  ti,timer-secure:
+    description:
+      Timer access has been limited to secure mode only.
+    type: boolean
+
+  ti,hwmods:
+    description:
+      Name of the HWMOD associated with timer. This is for legacy
+      omap2/3 platforms only.
+    $ref: /schemas/types.yaml#/definitions/string
+    deprecated: true
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - ti,omap3430-timer
+              - ti,omap4430-timer
+              - ti,omap5430-timer
+    then:
+      properties:
+        reg:
+          oneOf:
+            - items:
+                - description: IO address

Documentation/devicetree/bindings/timer/ti,timer-dm.yaml line 113

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+            - items:
+                - description: CPU to L4 ABE IO address
+                - description: L3 to L4 ABE IO address
+        clocks:
+          oneOf:
+            - items:
+                - description: Functional clock
+            - items:
+                - description: Functional clock
+                - description: System clock

I think this can be made simpler, without oneOf:

clocks:
items:
- description: Functional clock
- description: System clock
minItems: 1

and similar for clock-names.

Quoted 8 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +8 -0
+        clock-names:
+          oneOf:
+            - items:
+                - const: fck
+            - items:
+                - const: fck
+                - const: timer_sys_ck
+    else:

Documentation/devicetree/bindings/timer/ti,timer-dm.yaml line 131

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+      properties:
+        reg:
+          items:
+            - description: IO address
+        clocks:
+          items:
+            - description: Functional clock
+        clock-names:
+          items:
+            - const: fck

Hmmm, in your previous version I had impression that first clock is not the same on every flavor. Now it looks the same, so clocks you could simplify even more:
1. Define full list in main properties (not in allOf) with minItems:1
2. Use maxItems:1, for this "else:" case.

This could greatly reduce amount of code you need and keep the actual definition of clocks in main properties (not in allOf; allOf are only to constrain it).

Best regards,
Krzysztof

#3 lore raw

Re: [PATCH 1/2] dt-bindings: timer: Update TI timer to yaml

Quoted 29 lines · Krzysztof Kozlowski
Quoted 15 lines · Tony Lindgren
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +15 -0
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - ti,omap3430-timer
+              - ti,omap4430-timer
+              - ti,omap5430-timer
+    then:
+      properties:
+        reg:
+          oneOf:
+            - items:
+                - description: IO address

Documentation/devicetree/bindings/timer/ti,timer-dm.yaml line 113

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+            - items:
+                - description: CPU to L4 ABE IO address
+                - description: L3 to L4 ABE IO address
+        clocks:
+          oneOf:
+            - items:
+                - description: Functional clock
+            - items:
+                - description: Functional clock
+                - description: System clock

I think this can be made simpler, without oneOf:

Quoted 8 lines

clocks:
items:
- description: Functional clock
- description: System clock
minItems: 1

and similar for clock-names.

OK simpler sure sounds good to me considering the file path starts with "Documentation" :)

Quoted 25 lines
Quoted 8 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +8 -0
+        clock-names:
+          oneOf:
+            - items:
+                - const: fck
+            - items:
+                - const: fck
+                - const: timer_sys_ck
+    else:

Documentation/devicetree/bindings/timer/ti,timer-dm.yaml line 131

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+      properties:
+        reg:
+          items:
+            - description: IO address
+        clocks:
+          items:
+            - description: Functional clock
+        clock-names:
+          items:
+            - const: fck

Hmmm, in your previous version I had impression that first clock is not the same on every flavor. Now it looks the same, so clocks you could simplify even more:
1. Define full list in main properties (not in allOf) with minItems:1
2. Use maxItems:1, for this "else:" case.

Quoted 3 lines

This could greatly reduce amount of code you need and keep the actual definition of clocks in main properties (not in allOf; allOf are only to constrain it).

OK thanks I'll check. I think we can assume the first clock is "fck" if it is configured at all.

Regards,

Tony

#4 lore raw

Re: [PATCH 1/2] dt-bindings: timer: Update TI timer to yaml

Quoted 7 lines · Tony Lindgren
Quoted 6 lines · Krzysztof Kozlowski

Hmmm, in your previous version I had impression that first clock is not the same on every flavor. Now it looks the same, so clocks you could simplify even more:
1. Define full list in main properties (not in allOf) with minItems:1
2. Use maxItems:1, for this "else:" case.

Quoted 6 lines
Quoted 3 lines

This could greatly reduce amount of code you need and keep the actual definition of clocks in main properties (not in allOf; allOf are only to constrain it).

OK thanks I'll check. I think we can assume the first clock is "fck" if it is configured at all.

Yup, this works nicely :) Will send out v4 set.

Thanks,

Tony

#5 lore raw

PATCH v3 2/2 dt-bindings: timer: Add compatible for am6 for TI timer-dm

In reply to Tony Lindgren

Let's add compatible for ti,am654-timer for TI am64, am65 and j72 SoCs. As the timer hardware is the same between am64, am65 and j72 we use the compatible name for the earliest SoC with this timer.

The timer interrupts are not routable for the operating system for some timers on am6. Let's make sure the interrupts are configured for the timers on all other SoCs.

Cc Daniel Lezcano <[email protected]>
Cc Keerthy <[email protected]>
Cc Nishanth Menon <[email protected]>
Cc Vignesh Raghavendra <[email protected]>
---
 .../devicetree/bindings/timer/ti,timer-dm.yaml       | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml +11 -1
@@ -19,6 +19,7 @@ properties:
           - enum:
               - ti,am335x-timer
               - ti,am335x-timer-1ms
+              - ti,am654-timer
               - ti,dm814-timer
               - ti,dm816-timer
               - ti,omap2420-timer
@@ -82,11 +83,20 @@ properties:
 required:
   - compatible
   - reg
-  - interrupts
 
 additionalProperties: false
 
 allOf:
+  - if:
+      not:
+        properties:
+          compatible:
+            contains:
+              const: ti,am654-timer
+    then:
+      required:
+        - interrupts
+
   - if:
       properties:
         compatible:
Signature · 6 lines
2.35.1

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
maintainer
#6 lore raw
In reply to Tony Lindgren
Quoted 3 lines · Tony Lindgren

Hi all,

Here's v3 changes for TI dmtimer changes.

You missed 'v3' on the patches.

Quoted 25 lines

Regards,

Tony

Changes since v1:

- Improve yaml for various checks based on comments from Krzysztof and Nishanth

- Add checks for am4 timer as pointed out by Krzysztof and Rob

- Split am6 additions into a separate patch as suggested by Krzysztof

Changes since v2:

- Improve yaml for more checks based on comments from Grygorii and Krzysztof

Tony Lindgren (2):
dt-bindings: timer: Update TI timer to yaml
dt-bindings: timer: Add compatible for am6 for TI timer-dm

Quoted 10 lines
 .../bindings/pwm/pwm-omap-dmtimer.txt         |   2 +-
 .../bindings/timer/ti,timer-dm.yaml           | 171 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 -----
 3 files changed, 172 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/timer/ti,timer-dm.yaml
 delete mode 100644 Documentation/devicetree/bindings/timer/ti,timer.txt
Signature · 1 line
2.35.1

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

#7 lore raw
Quoted 6 lines · Rob Herring
Quoted 3 lines · Tony Lindgren

Hi all,

Here's v3 changes for TI dmtimer changes.

You missed 'v3' on the patches.

Sounds like I need to start using git format-patch with -v option :)

Regards,

Tony