Skip to contentSkip to conversation

Add drivers for Intel Keem Bay SoC timer block

PATCH In review [email protected] 4 participants 12 messages Dec 30, 2020 – Jan 20, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v2 cover Add drivers for Intel Keem Bay SoC timer block

From: Vijayakannan Ayyathurai <[email protected]>

Hi,

This patch set adds the driver for Intel Keem Bay SoC timer block, which contains 32-bit general purpose timers, a 64 bit free running counter.

Patch 1 holds the Device Tree binding documentation and Patch 2 holds the Device Driver for clocksource and clockevent.

It was tested on the Keem Bay evaluation module board.

Thanks,
Vijay

Changes since v1:
- Add support for KEEMBAY_TIMER to get selected through Kconfig.platforms.
- Add CLOCK_EVT_FEAT_DYNIRQ as part of clockevent feature.
- Avoid overlapping reg regions across 2 device nodes.
- Simplify 2 device nodes as 1 because both are from same IP block.
- Adapt the driver code according to the new simplified devicetree.

Vijayakannan Ayyathurai (2):
dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer
clocksource: Add Intel Keem Bay Timer Support

 .../bindings/timer/intel,keembay-timer.yaml   |  52 ++++
 arch/arm64/Kconfig.platforms                  |   1 +
 drivers/clocksource/Kconfig                   |  10 +
 drivers/clocksource/Makefile                  |   1 +
 drivers/clocksource/timer-keembay.c           | 225 ++++++++++++++++++
 5 files changed, 289 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/timer/intel,keembay-timer.yaml
 create mode 100644 drivers/clocksource/timer-keembay.c

base-commit: 5c8fe583cce542aa0b84adc939ce85293de36e5e
prerequisite-patch-id: bbb340c3a34059ea6960e8b96f5ad3bf0b4ae7b0
prerequisite-patch-id: b71b548284a57a38ce96d9bb523eadfccabd6e02

Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/2 dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer

From: Vijayakannan Ayyathurai <[email protected]>

Add Device Tree bindings for the Timer IP, which used as clocksource and clockevent device in the Intel Keem Bay SoC.

---
 .../bindings/timer/intel,keembay-timer.yaml   | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/timer/intel,keembay-timer.yaml
Documentation/devicetree/bindings/timer/intel,keembay-timer.yaml new file +52 -0
new file mode 100644
index 000000000000..197493336ac2
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/timer/intel,keembay-timer.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Intel Keem Bay SoC Timers
+
+maintainers:
+  - Wan Ahmad Zainie <[email protected]>
+  - Vijayakannan Ayyathurai <[email protected]>
+
+description:
+  Intel Keem Bay SoC Timers block contains 8 32-bit general purpose timers,
+  a free running 64-bit counter, a random number generator and a watchdog
+  timer. Each gpt can generate an individual interrupt.
+
+properties:
+  compatible:
+    enum:
+      - intel,keembay-timer
+
+  reg:
+    maxItems: 3
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #define KEEM_BAY_A53_TIM
+
+    timer@20330010 {
+        compatible = "intel,keembay-timer";
+        reg = <0x20330010 0xc>,
+              <0x203300e8 0xc>,
+              <0x20331000 0xc>;
+        clocks = <&scmi_clk KEEM_BAY_A53_TIM>;
+        interrupts = <GIC_SPI 3 IRQ_TYPE_LEVEL_HIGH>;

+ };

Signature · 1 line
2.17.1
maintainer
#2 lore raw

Re: [PATCH v2 1/2] dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer

Quoted 5 lines · On Wed, 30 Dec 2020 14:25:26 +0800, [email protected] wrote:

From: Vijayakannan Ayyathurai <[email protected]>

Add Device Tree bindings for the Timer IP, which used as clocksource and clockevent device in the Intel Keem Bay SoC.

Quoted 8 lines
---
 .../bindings/timer/intel,keembay-timer.yaml   | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/timer/intel,keembay-timer.yaml

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Error: Documentation/devicetree/bindings/timer/intel,keembay-timer.example.dts:32.3-33.1 syntax error FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:344: Documentation/devicetree/bindings/timer/intel,keembay-timer.example.dt.yaml] Error 1
make: *** [Makefile:1370: dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1421313

This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit.

#3 lore raw

RE: [PATCH v2 1/2] dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer

Hi Rob,

Quoted 35 lines

From: Rob Herring <[email protected]>

Quoted 8 lines

From: Vijayakannan Ayyathurai <[email protected]>

Add Device Tree bindings for the Timer IP, which used as clocksource and clockevent device in the Intel Keem Bay SoC.

Signed-off-by Vijayakannan Ayyathurai

<[email protected]>

Quoted 4 lines
---
 .../bindings/timer/intel,keembay-timer.yaml   | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644

Documentation/devicetree/bindings/timer/intel,keembay-timer.yaml

Quoted 1 line

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Error: Documentation/devicetree/bindings/timer/intel,keembay- timer.example.dts:32.3-33.1 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:344:
Documentation/devicetree/bindings/timer/intel,keembay- timer.example.dt.yaml] Error 1
make: *** [Makefile:1370: dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1421313

This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.

Quoted 7 lines

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit.

Thanks for the review. Let me check again and re-submit in the next version.

Thanks,
Vijay

#4 lore raw

PATCH v2 2/2 clocksource: Add Intel Keem Bay Timer Support

In reply to [email protected]

From: Vijayakannan Ayyathurai <[email protected]>

Add generic clocksource and clockevent driver for the timer IP used in Intel Keem Bay SoC.

One free running Counter used as a clocksource device and one Timer used as a clockevent device. Both are enabled through TIM_GEN_CONFIG register. This register is in the DT resource index 2.

Timer and Counter base register is in the DT resource index 0 and 1 respectively. This register map/unmap handled by TIMER OF api.

---
 arch/arm64/Kconfig.platforms        |   1 +
 drivers/clocksource/Kconfig         |  10 ++
 drivers/clocksource/Makefile        |   1 +
 drivers/clocksource/timer-keembay.c | 225 ++++++++++++++++++++++++++++
 4 files changed, 237 insertions(+)
 create mode 100644 drivers/clocksource/timer-keembay.c
arch/arm64/Kconfig.platforms +1 -0
index 6eecdef538bd..12c0c39a27ff 100644
@@ -146,6 +146,7 @@ config ARCH_HISI
 
 config ARCH_KEEMBAY
 	bool "Keem Bay SoC"
+	select KEEMBAY_TIMER
 	help
 	  This enables support for Intel Movidius SoC code-named Keem Bay.
 
drivers/clocksource/Kconfig +10 -0
index 14c7c4712478..cebe774fe104 100644
@@ -728,4 +728,14 @@ config MICROCHIP_PIT64B
 	  modes and high resolution. It is used as a clocksource
 	  and a clockevent.
 
+config KEEMBAY_TIMER
+	bool "Intel Keembay timer driver"
+	depends on ARCH_KEEMBAY || (ARM64 && COMPILE_TEST)
+	select TIMER_OF
+	help
+	  This option enables the support for the Intel Keembay general
+	  purpose timer and free running counter driver. Each timer can
+	  generate an individual interrupt and the 64 bit counter can also
+	  be used as one of the clock source.
+
 endmenu
drivers/clocksource/Makefile +1 -0
index 3c75cbbf8533..584628a56c76 100644
@@ -93,3 +93,4 @@ obj-$(CONFIG_CSKY_MP_TIMER)		+= timer-mp-csky.o
 obj-$(CONFIG_GX6605S_TIMER)		+= timer-gx6605s.o
 obj-$(CONFIG_HYPERV_TIMER)		+= hyperv_timer.o
 obj-$(CONFIG_MICROCHIP_PIT64B)		+= timer-microchip-pit64b.o
+obj-$(CONFIG_KEEMBAY_TIMER)		+= timer-keembay.o
drivers/clocksource/timer-keembay.c new file +225 -0

225 lines not on this page · raw message

Signature · 1 line
2.17.1
#5 lore raw

Re: [PATCH v2 2/2] clocksource: Add Intel Keem Bay Timer Support

Quoted 1 line · On 30/12/2020 07:25, [email protected] wrote:

From: Vijayakannan Ayyathurai <[email protected]>

[ ... ]

Quoted 8 lines
drivers/clocksource/timer-keembay.c new file +8 -0
+static struct timer_of keembay_ce_to = {
+	.flags	= TIMER_OF_IRQ | TIMER_OF_BASE | TIMER_OF_CLOCK,
+	.clkevt = {
+		.name			= "keembay_sys_clkevt",
+		.features		= CLOCK_EVT_FEAT_PERIODIC |
+					  CLOCK_EVT_FEAT_ONESHOT  |
+					  CLOCK_EVT_FEAT_DYNIRQ,
+		.rating			= TIM_RATING,

drivers/clocksource/timer-keembay.c line 141

Quoted 10 lines
drivers/clocksource/timer-keembay.c new file +10 -0
+		.set_next_event		= keembay_timer_set_next_event,
+		.set_state_periodic	= keembay_timer_periodic,
+		.set_state_shutdown	= keembay_timer_shutdown,
+	},
+	.of_base = {
+		.index = 0,
+	},
+	.of_irq = {
+		.handler = keembay_timer_isr,
+		.flags = IRQF_TIMER | IRQF_IRQPOLL,

Is the IRQPOLL flag really needed here ?

Quoted 66 lines
drivers/clocksource/timer-keembay.c new file +66 -0
+	},
+};
+
+static int __init keembay_clockevent_init(struct device_node *np,
+					  struct keembay_init_data *data)
+{
+	u32 val;
+	int ret;
+
+	data->mask = TIM_CONFIG_PRESCALER_ENABLE;
+	data->cfg = &keembay_ce_to;
+	ret = keembay_timer_setup(np, data);
+	if (ret)
+		return ret;
+
+	val = readl(data->base + TIM_RELOAD_VAL_OFFSET);
+
+	keembay_ce_to.clkevt.cpumask = cpumask_of(0);
+	keembay_ce_to.of_clk.rate = keembay_ce_to.of_clk.rate / (val + 1);
+
+	keembay_timer_disable(timer_of_base(&keembay_ce_to));
+
+	clockevents_config_and_register(&keembay_ce_to.clkevt,
+					timer_of_rate(&keembay_ce_to), 1, U32_MAX);
+	return 0;
+}
+
+static struct timer_of keembay_cs_to = {
+	.flags	= TIMER_OF_BASE | TIMER_OF_CLOCK,
+	.of_base = {
+		.index = 1,
+	},
+};
+
+static u64 notrace keembay_clocksource_read(struct clocksource *cs)
+{
+	return lo_hi_readq(timer_of_base(&keembay_cs_to));
+}
+
+static struct clocksource keembay_counter = {
+	.name			= "keembay_sys_counter",
+	.rating			= TIM_RATING,
+	.read			= keembay_clocksource_read,
+	.mask			= CLOCKSOURCE_MASK(TIM_CLKSRC_BITS),
+	.flags			= CLOCK_SOURCE_IS_CONTINUOUS |
+				  CLOCK_SOURCE_SUSPEND_NONSTOP,
+};
+
+static int __init keembay_clocksource_init(struct device_node *np,
+					   struct keembay_init_data *data)
+{
+	int ret;
+
+	data->mask = TIM_CONFIG_ENABLE;
+	data->cfg = &keembay_cs_to;
+	ret = keembay_timer_setup(np, data);
+	if (ret)
+		return ret;
+
+	return clocksource_register_hz(&keembay_counter, timer_of_rate(&keembay_cs_to));
+}
+
+static int __init keembay_timer_init(struct device_node *np)
+{
+	struct keembay_init_data data;
+	int ret;

drivers/clocksource/timer-keembay.c line 217

Quoted 10 lines
drivers/clocksource/timer-keembay.c new file +10 -0
+
+	data.base = of_iomap(np, 2);
+	if (!data.base)
+		return -ENXIO;
+
+	ret = keembay_clocksource_init(np, &data);
+	if (ret)
+		goto exit;
+
+	ret = keembay_clockevent_init(np, &data);

Is this missing ?

	if (ret)
		goto exit;

	return 0;
Quoted 9 lines
drivers/clocksource/timer-keembay.c new file +8 -0
+
+exit:
+	keembay_timer_cleanup(np, &data);
+
+	return ret;
+}
+
+TIMER_OF_DECLARE(keembay_timer, "intel,keembay-timer", keembay_timer_init);
Signature · 5 lines
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog
#6 lore raw

RE: [PATCH v2 2/2] clocksource: Add Intel Keem Bay Timer Support

Hi Daniel,

Quoted 15 lines

From: Daniel Lezcano <[email protected]>

Quoted 1 line

From: Vijayakannan Ayyathurai <[email protected]>

[ ... ]

drivers/clocksource/timer-keembay.c

Quoted 9 lines
drivers/clocksource/timer-keembay.c new file +9 -0
+static struct timer_of keembay_ce_to = {
+	.flags	= TIMER_OF_IRQ | TIMER_OF_BASE | TIMER_OF_CLOCK,
+	.clkevt = {
+		.name			= "keembay_sys_clkevt",
+		.features		= CLOCK_EVT_FEAT_PERIODIC |
+					  CLOCK_EVT_FEAT_ONESHOT  |
+					  CLOCK_EVT_FEAT_DYNIRQ,
+		.rating			= TIM_RATING,
+		.set_next_event		=

keembay_timer_set_next_event,

Quoted 12 lines

drivers/clocksource/timer-keembay.c line 141

Quoted 9 lines
drivers/clocksource/timer-keembay.c new file +9 -0
+		.set_state_periodic	= keembay_timer_periodic,
+		.set_state_shutdown	= keembay_timer_shutdown,
+	},
+	.of_base = {
+		.index = 0,
+	},
+	.of_irq = {
+		.handler = keembay_timer_isr,
+		.flags = IRQF_TIMER | IRQF_IRQPOLL,

Is the IRQPOLL flag really needed here ?

Not really needed. I will remove this redundant Flag in my next version.

Quoted 8 lines
Quoted 8 lines
drivers/clocksource/timer-keembay.c new file +8 -0
+static int __init keembay_timer_init(struct device_node *np)
+{
+	struct keembay_init_data data;
+	int ret;
+
+	data.base = of_iomap(np, 2);
+	if (!data.base)
+		return -ENXIO;
Quoted 9 lines

drivers/clocksource/timer-keembay.c line 217

Quoted 6 lines
drivers/clocksource/timer-keembay.c new file +6 -0
+
+	ret = keembay_clocksource_init(np, &data);
+	if (ret)
+		goto exit;
+
+	ret = keembay_clockevent_init(np, &data);

Is this missing ?

Yes. Either case it goes to the exit path. So I thought of avoiding this error handling code.

Quoted 5 lines
	if (ret)
		goto exit;

	return 0;
Quoted 11 lines

drivers/clocksource/timer-keembay.c

Quoted 8 lines
drivers/clocksource/timer-keembay.c new file +8 -0
+
+exit:
+	keembay_timer_cleanup(np, &data);
+
+	return ret;
+}
+
+TIMER_OF_DECLARE(keembay_timer, "intel,keembay-timer",

keembay_timer_init);

Quoted 1 line

Thanks,
Vijay

#7 lore raw

Re: [PATCH v2 2/2] clocksource: Add Intel Keem Bay Timer Support

On Tue, Jan 19, 2021 at 02:56:36AM +0000, Ayyathurai, Vijayakannan wrote:

...

Quoted 13 lines
Quoted 12 lines

drivers/clocksource/timer-keembay.c line 217

Quoted 9 lines
drivers/clocksource/timer-keembay.c new file +9 -0
+	data.base = of_iomap(np, 2);
+	if (!data.base)
+		return -ENXIO;
+
+	ret = keembay_clocksource_init(np, &data);
+	if (ret)
+		goto exit;
+
+	ret = keembay_clockevent_init(np, &data);

Is this missing ?

Quoted 1 line

Yes. Either case it goes to the exit path. So I thought of avoiding this error handling code.

The point is that in success you probably won't call keembay_timer_cleanup().

Quoted 10 lines
Quoted 10 lines
	if (ret)
		goto exit;

	return 0;
Quoted 5 lines
drivers/clocksource/timer-keembay.c new file +5 -0
+exit:
+	keembay_timer_cleanup(np, &data);
+
+	return ret;
+}
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw

RE: [PATCH v2 2/2] clocksource: Add Intel Keem Bay Timer Support

Hi Andy,

Quoted 15 lines

From: [email protected]

Quoted 13 lines
Quoted 12 lines

drivers/clocksource/timer-keembay.c line 217

Quoted 9 lines
drivers/clocksource/timer-keembay.c new file +9 -0
+	data.base = of_iomap(np, 2);
+	if (!data.base)
+		return -ENXIO;
+
+	ret = keembay_clocksource_init(np, &data);
+	if (ret)
+		goto exit;
+
+	ret = keembay_clockevent_init(np, &data);

Is this missing ?

Quoted 5 lines
Quoted 1 line

Yes. Either case it goes to the exit path. So I thought of avoiding this error

handling code.

The point is that in success you probably won't call keembay_timer_cleanup().

Yes. You are right, if I use this error handling code.

Quoted 11 lines
Quoted 10 lines
Quoted 10 lines
	if (ret)
		goto exit;

	return 0;

drivers/clocksource/timer-keembay.c line 223

Quoted 5 lines
drivers/clocksource/timer-keembay.c new file +5 -0
+exit:
+	keembay_timer_cleanup(np, &data);
+
+	return ret;
+}

Thanks,
Vijay

#9 lore raw
In reply to [email protected]

Hi,

Quoted 9 lines

From: Vijayakannan Ayyathurai <[email protected]>

Changes since v1:
- Add support for KEEMBAY_TIMER to get selected through Kconfig.platforms.
- Add CLOCK_EVT_FEAT_DYNIRQ as part of clockevent feature.
- Avoid overlapping reg regions across 2 device nodes.
- Simplify 2 device nodes as 1 because both are from same IP block.
- Adapt the driver code according to the new simplified devicetree.

Quoted 3 lines

Vijayakannan Ayyathurai (2):
dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer
clocksource: Add Intel Keem Bay Timer Support

Kindly help us to review this updated patch(v2) set.

Thanks,
Vijay

#10 lore raw
Quoted 11 lines · Vijayakannan

Hi,

Quoted 9 lines

From: Vijayakannan Ayyathurai <[email protected]>

Changes since v1:
- Add support for KEEMBAY_TIMER to get selected through Kconfig.platforms.
- Add CLOCK_EVT_FEAT_DYNIRQ as part of clockevent feature.
- Avoid overlapping reg regions across 2 device nodes.
- Simplify 2 device nodes as 1 because both are from same IP block.
- Adapt the driver code according to the new simplified devicetree.

Quoted 5 lines
Quoted 3 lines

Vijayakannan Ayyathurai (2):
dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer
clocksource: Add Intel Keem Bay Timer Support

Kindly help us to review this updated patch(v2) set.

Review in progress ... :)

Signature · 5 lines
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog
#11 lore raw

Hi Daniel,

Quoted 11 lines

From: Daniel Lezcano <[email protected]>

Quoted 4 lines
Quoted 4 lines

From: Vijayakannan Ayyathurai <[email protected]>

Changes since v1:
- Add support for KEEMBAY_TIMER to get selected through

Kconfig.platforms.

Quoted 5 lines
Quoted 5 lines

- Add CLOCK_EVT_FEAT_DYNIRQ as part of clockevent feature.
- Avoid overlapping reg regions across 2 device nodes.
- Simplify 2 device nodes as 1 because both are from same IP block.
- Adapt the driver code according to the new simplified devicetree.

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines

Vijayakannan Ayyathurai (2):
dt-bindings: timer: Add bindings for Intel Keem Bay SoC timer
clocksource: Add Intel Keem Bay Timer Support

Kindly help us to review this updated patch(v2) set.

Review in progress ... :)

Thank you for the Review.

Thanks,
Vijay