Skip to contentSkip to conversation

Convert TI dmtimer binding to yaml

PATCH Superseded Tony Lindgren 2 participants 5 messages Apr 13, 2022

Subsystems (3)

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v4 cover Convert TI dmtimer binding to yaml

Hi,

Here's v4 changes for TI dmtimer changes. I kept Krzysztof's ack for the second patch as the rebase on updated first patch was trivial.

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

Changes since v3:

- Simplify constraints for reg, clocks and clock-names as suggested by Krzysztof

- Use version number for patches too as suggested by Rob

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           | 158 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 -----
 3 files changed, 159 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
#1 lore raw

PATCH v4 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 add checks for the deprecated ti,hwmods property as done for other TI device driver bindings earlier.

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 system clock 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 Grygorii Strashko <[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           | 148 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 ------
 3 files changed, 149 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 +148 -0

148 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 · 1 line
2.35.1
#2 lore raw

Re: [PATCH v4 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 add checks for the deprecated ti,hwmods property as done for other TI device driver bindings earlier.

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 system clock 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 Grygorii Strashko <[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           | 148 ++++++++++++++++++
 .../devicetree/bindings/timer/ti,timer.txt    |  44 ------
 3 files changed, 149 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 +99 -0
new file mode 100644
@@ -0,0 +1,148 @@
+# 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:
+    items:
+      - description: IO address
+      - description: L3 to L4 mapping for omap4/5 L4 ABE
+    minItems: 1
+
+  clocks:
+    items:
+      - description: Functional clock
+      - description: System clock for omap4/5 and dra7
+    minItems: 1
+
+  clock-names:
+    items:
+      - const: fck
+      - const: timer_sys_ck
+    minItems: 1
+
+  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:
+      not:
+        properties:
+          compatible:

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

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+            contains:
+              enum:
+                - ti,omap3430-timer
+                - ti,omap4430-timer
+                - ti,omap5430-timer
+    then:
+      properties:
+        reg:
+          items:
+            - description: IO address

You can skip the items because they are the same as in properties before. Just keep maxItems:1.

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

Quoted 4 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +4 -0
+          maxItems: 1
+        clocks:
+          items:
+            - description: Functional clock

The same.

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

Quoted 4 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +4 -0
+          maxItems: 1
+        clock-names:
+          items:
+            - const: fck

The same.

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

Quoted 1 line
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +1 -0
+          maxItems: 1

Rest is good.

Best regards,
Krzysztof

#3 lore raw

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

Quoted 17 lines · Krzysztof Kozlowski
Quoted 5 lines · Tony Lindgren
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +5 -0
+allOf:
+  - if:
+      not:
+        properties:
+          compatible:

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

Quoted 10 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +10 -0
+            contains:
+              enum:
+                - ti,omap3430-timer
+                - ti,omap4430-timer
+                - ti,omap5430-timer
+    then:
+      properties:
+        reg:
+          items:
+            - description: IO address
Quoted 2 lines

You can skip the items because they are the same as in properties before. Just keep maxItems:1.

OK great.

Quoted 12 lines

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

Quoted 4 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +4 -0
+          maxItems: 1
+        clocks:
+          items:
+            - description: Functional clock

The same.

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

Quoted 4 lines
Documentation/devicetree/bindings/timer/ti,timer-dm.yaml new file +4 -0
+          maxItems: 1
+        clock-names:
+          items:
+            - const: fck
Quoted 5 lines

The same.

Quoted 1 line

+ maxItems: 1

Rest is good.

OK

Thanks,

Tony

#4 lore raw

PATCH v4 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 Grygorii Strashko <[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
@@ -88,11 +89,20 @@ properties:
 required:
   - compatible
   - reg
-  - interrupts
 
 additionalProperties: false
 
 allOf:
+  - if:
+      not:
+        properties:
+          compatible:
+            contains:
+              const: ti,am654-timer
+    then:
+      required:
+        - interrupts
+
   - if:
       not:
         properties:
Signature · 1 line
2.35.1