Skip to contentSkip to conversation

clocksource/drivers/arm_arch_timer: Add workaround for MediaTek MMIO timer

PATCH In review [email protected] 4 participants 4 messages Apr 17, 2023 – Apr 27, 2023

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

PATCH 1/1 clocksource/drivers/arm_arch_timer: Add workaround for MediaTek MMIO timer

From: Walter Chang <[email protected]>

The MT69XX series SoCs have the incomplete implementation issue in the mmio timer. Specifically, the hardware only implements the TVAL functionality, but not the CVAL functionality. This hardware limitation will cause set_next_event_mem() fail to set the actual expiration time when writing a value to the CVAL. On these platforms, the mmio timer's internal expiration time will still be judged as 0 (the value of TVAL), resulting in the mmio timer not functioning as intended.

The workaround is to use TVAL in addition to CVAL for these affected platforms.

---
 Documentation/arm64/silicon-errata.rst |  4 ++++
 drivers/clocksource/Kconfig            |  9 ++++++++
 drivers/clocksource/arm_arch_timer.c   | 29 ++++++++++++++++++++++++++
 3 files changed, 42 insertions(+)
Documentation/arm64/silicon-errata.rst +4 -0
index ec5f889d7681..ca1893713a4c 100644
@@ -209,3 +209,7 @@ stable kernels.
 +----------------+-----------------+-----------------+-----------------------------+
 | Fujitsu        | A64FX           | E#010001        | FUJITSU_ERRATUM_010001      |
 +----------------+-----------------+-----------------+-----------------------------+
+
++----------------+-----------------+-----------------+-----------------------------+
+| MediaTek       | MT69XX series   | #690001         | MEDIATEK_ERRATUM_690001     |
++----------------+-----------------+-----------------+-----------------------------+
drivers/clocksource/Kconfig +9 -0
index 5fc8f0e7fb38..475356b8dbdc 100644
@@ -368,6 +368,15 @@ config SUN50I_ERRATUM_UNKNOWN1
 	  the Allwinner A64 SoC. The workaround will only be active if the
 	  allwinner,erratum-unknown1 property is found in the timer node.
 
+config MEDIATEK_ERRATUM_690001
+	bool "Workaround for MediaTek MT69XX erratum 690001"
+	depends on ARM_ARCH_TIMER && ARM64
+	help
+	  This option enables a workaround for incomplete implementation
+	  in the MMIO timer on the MediaTek MT69XX SoCs. The workaround
+	  will only be active if mediatek,erratum-690001 property is
+	  found in the timer node.
+
 config ARM_GLOBAL_TIMER
 	bool "Support for the ARM global timer" if COMPILE_TEST
 	select TIMER_OF if OF
drivers/clocksource/arm_arch_timer.c +29 -0
index e09d4427f604..920570d57fc0 100644
@@ -389,6 +389,10 @@ static u64 notrace sun50i_a64_read_cntvct_el0(void)
 }
 #endif
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+static bool arch_timer_mem_sne_use_tval __ro_after_init;
+#endif
+
 #ifdef CONFIG_ARM_ARCH_TIMER_OOL_WORKAROUND
 DEFINE_PER_CPU(const struct arch_timer_erratum_workaround *, timer_unstable_counter_workaround);
 EXPORT_SYMBOL_GPL(timer_unstable_counter_workaround);
@@ -783,6 +787,19 @@ static __always_inline void set_next_event_mem(const int access, unsigned long e
 		cnt = arch_counter_get_cnt_mem(timer, CNTPCT_LO);
 
 	arch_timer_reg_write(access, ARCH_TIMER_REG_CVAL, evt + cnt, clk);
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	if (arch_timer_mem_sne_use_tval) {
+		/* Due to the incomplete implementation of mmio timer on
+		 * specific MediaTek platforms, CVAL has not been implemented.
+		 * Therefore, the workaround is to use TVAL in addition to
+		 * CVAL.
+		 */
+		if (access == ARCH_TIMER_MEM_VIRT_ACCESS)
+			writel_relaxed(evt, timer->base + 0x38);
+		else
+			writel_relaxed(evt, timer->base + 0x28);
+	}
+#endif
 	arch_timer_reg_write(access, ARCH_TIMER_REG_CTRL, ctrl, clk);
 }
 
@@ -878,7 +895,16 @@ static void __arch_timer_setup(unsigned type,
 				arch_timer_set_next_event_phys_mem;
 		}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+		if (arch_timer_mem_sne_use_tval) {
+			pr_info("Enabling mediatek,erratum-690001 for mmio timer\n");
+			max_delta = CLOCKSOURCE_MASK(31);
+		} else {
+			max_delta = CLOCKSOURCE_MASK(56);
+		}
+#else
 		max_delta = CLOCKSOURCE_MASK(56);
+#endif
 	}
 
 	clk->set_state_shutdown(clk);
@@ -1591,6 +1617,9 @@ static int __init arch_timer_mem_of_init(struct device_node *np)
 		frame->valid = true;
 	}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	arch_timer_mem_sne_use_tval = of_property_read_bool(np, "mediatek,erratum-690001");
+#endif
 	frame = arch_timer_mem_find_best_frame(timer_mem);
 	if (!frame) {
 		pr_err("Unable to find a suitable frame in timer @ %pa\n",
Signature · 1 line
2.18.0
#1 lore raw

Il 17/04/23 11:06, [email protected] ha scritto:

Quoted 57 lines

From: Walter Chang <[email protected]>

The MT69XX series SoCs have the incomplete implementation issue in the mmio timer. Specifically, the hardware only implements the TVAL functionality, but not the CVAL functionality. This hardware limitation will cause set_next_event_mem() fail to set the actual expiration time when writing a value to the CVAL. On these platforms, the mmio timer's internal expiration time will still be judged as 0 (the value of TVAL), resulting in the mmio timer not functioning as intended.

The workaround is to use TVAL in addition to CVAL for these affected platforms.

---
  Documentation/arm64/silicon-errata.rst |  4 ++++
  drivers/clocksource/Kconfig            |  9 ++++++++
  drivers/clocksource/arm_arch_timer.c   | 29 ++++++++++++++++++++++++++
  3 files changed, 42 insertions(+)
Documentation/arm64/silicon-errata.rst +4 -0
index ec5f889d7681..ca1893713a4c 100644
@@ -209,3 +209,7 @@ stable kernels.
  +----------------+-----------------+-----------------+-----------------------------+
  | Fujitsu        | A64FX           | E#010001        | FUJITSU_ERRATUM_010001      |
  +----------------+-----------------+-----------------+-----------------------------+
+
++----------------+-----------------+-----------------+-----------------------------+
+| MediaTek       | MT69XX series   | #690001         | MEDIATEK_ERRATUM_690001     |
++----------------+-----------------+-----------------+-----------------------------+
drivers/clocksource/Kconfig +9 -0
index 5fc8f0e7fb38..475356b8dbdc 100644
@@ -368,6 +368,15 @@ config SUN50I_ERRATUM_UNKNOWN1
  	  the Allwinner A64 SoC. The workaround will only be active if the
  	  allwinner,erratum-unknown1 property is found in the timer node.
 
+config MEDIATEK_ERRATUM_690001
+	bool "Workaround for MediaTek MT69XX erratum 690001"
+	depends on ARM_ARCH_TIMER && ARM64
+	help
+	  This option enables a workaround for incomplete implementation
+	  in the MMIO timer on the MediaTek MT69XX SoCs. The workaround
+	  will only be active if mediatek,erratum-690001 property is
+	  found in the timer node.
+
  config ARM_GLOBAL_TIMER
  	bool "Support for the ARM global timer" if COMPILE_TEST
  	select TIMER_OF if OF
drivers/clocksource/arm_arch_timer.c +0 -0
index e09d4427f604..920570d57fc0 100644

drivers/clocksource/arm_arch_timer.c static u64 notrace sun50i_a64_read_cntvct_el0(void) · line 393

Quoted 5 lines
drivers/clocksource/arm_arch_timer.c +2 -0
@@ -389,6 +389,10 @@ static u64 notrace sun50i_a64_read_cntvct_el0(void)
  }
  #endif
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+static bool arch_timer_mem_sne_use_tval __ro_after_init;

What about reusing part of the CONFIG_ARM_ARCH_TIMER_OOL_WORKAROUND logic and adding something like CONFIG_ARM_ARCH_TIMER_MEM_WORKAROUND?

That would make you able to reuse the already existing infrastructure to parse the device-tree and possibly more.

Regards,
Angelo

Quoted 52 lines
drivers/clocksource/arm_arch_timer.c +27 -0
+#endif
+
  #ifdef CONFIG_ARM_ARCH_TIMER_OOL_WORKAROUND
  DEFINE_PER_CPU(const struct arch_timer_erratum_workaround *, timer_unstable_counter_workaround);
  EXPORT_SYMBOL_GPL(timer_unstable_counter_workaround);
@@ -783,6 +787,19 @@ static __always_inline void set_next_event_mem(const int access, unsigned long e
  		cnt = arch_counter_get_cnt_mem(timer, CNTPCT_LO);
 
  	arch_timer_reg_write(access, ARCH_TIMER_REG_CVAL, evt + cnt, clk);
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	if (arch_timer_mem_sne_use_tval) {
+		/* Due to the incomplete implementation of mmio timer on
+		 * specific MediaTek platforms, CVAL has not been implemented.
+		 * Therefore, the workaround is to use TVAL in addition to
+		 * CVAL.
+		 */
+		if (access == ARCH_TIMER_MEM_VIRT_ACCESS)
+			writel_relaxed(evt, timer->base + 0x38);
+		else
+			writel_relaxed(evt, timer->base + 0x28);
+	}
+#endif
  	arch_timer_reg_write(access, ARCH_TIMER_REG_CTRL, ctrl, clk);
  }
 
@@ -878,7 +895,16 @@ static void __arch_timer_setup(unsigned type,
  				arch_timer_set_next_event_phys_mem;
  		}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+		if (arch_timer_mem_sne_use_tval) {
+			pr_info("Enabling mediatek,erratum-690001 for mmio timer\n");
+			max_delta = CLOCKSOURCE_MASK(31);
+		} else {
+			max_delta = CLOCKSOURCE_MASK(56);
+		}
+#else
  		max_delta = CLOCKSOURCE_MASK(56);
+#endif
  	}
 
  	clk->set_state_shutdown(clk);
@@ -1591,6 +1617,9 @@ static int __init arch_timer_mem_of_init(struct device_node *np)
  		frame->valid = true;
  	}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	arch_timer_mem_sne_use_tval = of_property_read_bool(np, "mediatek,erratum-690001");
+#endif
  	frame = arch_timer_mem_find_best_frame(timer_mem);
  	if (!frame) {
  		pr_err("Unable to find a suitable frame in timer @ %pa\n",
maintainer
#2 lore raw
Quoted 57 lines · AngeloGioacchino Del Regno

Il 17/04/23 11:06, [email protected] ha scritto:

Quoted 55 lines

From: Walter Chang <[email protected]>

The MT69XX series SoCs have the incomplete implementation issue in the mmio timer. Specifically, the hardware only implements the TVAL functionality, but not the CVAL functionality. This hardware limitation will cause set_next_event_mem() fail to set the actual expiration time when writing a value to the CVAL. On these platforms, the mmio timer's internal expiration time will still be judged as 0 (the value of TVAL), resulting in the mmio timer not functioning as intended.

The workaround is to use TVAL in addition to CVAL for these affected platforms.

---
  Documentation/arm64/silicon-errata.rst |  4 ++++
  drivers/clocksource/Kconfig            |  9 ++++++++
  drivers/clocksource/arm_arch_timer.c   | 29 ++++++++++++++++++++++++++
  3 files changed, 42 insertions(+)
Documentation/arm64/silicon-errata.rst +4 -0
index ec5f889d7681..ca1893713a4c 100644
@@ -209,3 +209,7 @@ stable kernels.
  +----------------+-----------------+-----------------+-----------------------------+
  | Fujitsu        | A64FX           | E#010001        | FUJITSU_ERRATUM_010001      |
  +----------------+-----------------+-----------------+-----------------------------+
+
++----------------+-----------------+-----------------+-----------------------------+
+| MediaTek       | MT69XX series   | #690001         | MEDIATEK_ERRATUM_690001     |
++----------------+-----------------+-----------------+-----------------------------+
drivers/clocksource/Kconfig +8 -0
index 5fc8f0e7fb38..475356b8dbdc 100644
@@ -368,6 +368,15 @@ config SUN50I_ERRATUM_UNKNOWN1
  	  the Allwinner A64 SoC. The workaround will only be active if the
  	  allwinner,erratum-unknown1 property is found in the timer node.
  +config MEDIATEK_ERRATUM_690001
+	bool "Workaround for MediaTek MT69XX erratum 690001"
+	depends on ARM_ARCH_TIMER && ARM64
+	help
+	  This option enables a workaround for incomplete implementation
+	  in the MMIO timer on the MediaTek MT69XX SoCs. The workaround
+	  will only be active if mediatek,erratum-690001 property is
+	  found in the timer node.
+
  config ARM_GLOBAL_TIMER
  	bool "Support for the ARM global timer" if COMPILE_TEST
  	select TIMER_OF if OF
drivers/clocksource/arm_arch_timer.c +0 -0
index e09d4427f604..920570d57fc0 100644
Quoted 8 lines

drivers/clocksource/arm_arch_timer.c static u64 notrace sun50i_a64_read_cntvct_el0(void) · line 392

Quoted 5 lines
drivers/clocksource/arm_arch_timer.c +1 -0
@@ -389,6 +389,10 @@ static u64 notrace sun50i_a64_read_cntvct_el0(void)
  }
  #endif
  +#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+static bool arch_timer_mem_sne_use_tval __ro_after_init;

What about reusing part of the CONFIG_ARM_ARCH_TIMER_OOL_WORKAROUND logic and adding something like CONFIG_ARM_ARCH_TIMER_MEM_WORKAROUND?

I don't think there is *any* need for the out-of-line stuff on any of the memory-mapped accesses, if only because they are not inlined the first place, and that there is no performance requirements around this timer (it should hardly ever be used as the sched clock, for example).

Despite being part of the same driver, the sysreg and MMIO timers are vastly different and keeping them together has only been a nuisance. Someone should throw an axe at this stuff.

	M.
Signature · 1 line
Without deviation from the norm, progress is not possible.
Reviewed-by on v1 1/1
#3 lore raw
In reply to [email protected]
Quoted 15 lines · On Mon, 2023-04-17 at 17:06 +0800, [email protected] wrote:

From: Walter Chang <[email protected]>

The MT69XX series SoCs have the incomplete implementation issue in the
mmio timer. Specifically, the hardware only implements the TVAL functionality, but not the CVAL functionality. This hardware limitation
will cause set_next_event_mem() fail to set the actual expiration time
when writing a value to the CVAL. On these platforms, the mmio timer's
internal expiration time will still be judged as 0 (the value of TVAL),
resulting in the mmio timer not functioning as intended.

Quoted 4 lines

The workaround is to use TVAL in addition to CVAL for these affected platforms.

Quoted 124 lines
---
 Documentation/arm64/silicon-errata.rst |  4 ++++
 drivers/clocksource/Kconfig            |  9 ++++++++
 drivers/clocksource/arm_arch_timer.c   | 29
++++++++++++++++++++++++++
 3 files changed, 42 insertions(+)
Documentation/arm64/silicon-errata.rst +0 -1
index ec5f889d7681..ca1893713a4c 100644
@@ -209,3 +209,7 @@ stable kernels.
 +----------------+-----------------+-----------------+------------
-----------------+
 | Fujitsu        | A64FX           | E#010001        |

FUJITSU_ERRATUM_010001 |
+----------------+-----------------+-----------------+------------
-----------------+
+
++----------------+-----------------+-----------------+------------
-----------------+
+| MediaTek | MT69XX series | #690001 |
MEDIATEK_ERRATUM_690001 |
++----------------+-----------------+-----------------+------------
-----------------+

drivers/clocksource/Kconfig +0 -0
index 5fc8f0e7fb38..475356b8dbdc 100644
@@ -368,6 +368,15 @@ config SUN50I_ERRATUM_UNKNOWN1
 	  the Allwinner A64 SoC. The workaround will only be active if

the
allwinner,erratum-unknown1 property is found in the timer
node.

drivers/clocksource/Kconfig +5 -0
+config MEDIATEK_ERRATUM_690001
+	bool "Workaround for MediaTek MT69XX erratum 690001"
+	depends on ARM_ARCH_TIMER && ARM64
+	help
+	  This option enables a workaround for incomplete

implementation

drivers/clocksource/Kconfig +4 -0
+	  in the MMIO timer on the MediaTek MT69XX SoCs. The workaround
+	  will only be active if mediatek,erratum-690001 property is
+	  found in the timer node.
+
 config ARM_GLOBAL_TIMER
 	bool "Support for the ARM global timer" if COMPILE_TEST
 	select TIMER_OF if OF
drivers/clocksource/arm_arch_timer.c +4 -0
index e09d4427f604..920570d57fc0 100644
@@ -389,6 +389,10 @@ static u64 notrace
 sun50i_a64_read_cntvct_el0(void)
 }
 #endif
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+static bool arch_timer_mem_sne_use_tval __ro_after_init;
+#endif
+
 #ifdef CONFIG_ARM_ARCH_TIMER_OOL_WORKAROUND
 DEFINE_PER_CPU(const struct arch_timer_erratum_workaround *,

timer_unstable_counter_workaround);
EXPORT_SYMBOL_GPL(timer_unstable_counter_workaround);

drivers/clocksource/arm_arch_timer.c +0 -0
@@ -783,6 +787,19 @@ static __always_inline void

set_next_event_mem(const int access, unsigned long e

drivers/clocksource/arm_arch_timer.c +0 -0
 		cnt = arch_counter_get_cnt_mem(timer, CNTPCT_LO);
 
 	arch_timer_reg_write(access, ARCH_TIMER_REG_CVAL, evt + cnt,

clk);

drivers/clocksource/arm_arch_timer.c +3 -0
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	if (arch_timer_mem_sne_use_tval) {
+		/* Due to the incomplete implementation of mmio timer

on

drivers/clocksource/arm_arch_timer.c +1 -0
+		 * specific MediaTek platforms, CVAL has not been

implemented.

drivers/clocksource/arm_arch_timer.c +1 -0
+		 * Therefore, the workaround is to use TVAL in addition

to

drivers/clocksource/arm_arch_timer.c +17 -0
+		 * CVAL.
+		 */
+		if (access == ARCH_TIMER_MEM_VIRT_ACCESS)
+			writel_relaxed(evt, timer->base + 0x38);
+		else
+			writel_relaxed(evt, timer->base + 0x28);
+	}
+#endif
 	arch_timer_reg_write(access, ARCH_TIMER_REG_CTRL, ctrl, clk);
 }
@@ -878,7 +895,16 @@ static void __arch_timer_setup(unsigned type,
 				arch_timer_set_next_event_phys_mem;
 		}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+		if (arch_timer_mem_sne_use_tval) {
+			pr_info("Enabling mediatek,erratum-690001 for
 mmio timer\n");
+			max_delta = CLOCKSOURCE_MASK(31);
+		} else {
+			max_delta = CLOCKSOURCE_MASK(56);
+		}
+#else
 		max_delta = CLOCKSOURCE_MASK(56);
+#endif
 	}
 
drivers/clocksource/arm_arch_timer.c +3 -0
 	clk->set_state_shutdown(clk);
@@ -1591,6 +1617,9 @@ static int __init arch_timer_mem_of_init(struct
 device_node *np)
 		frame->valid = true;
 	}
 
+#ifdef CONFIG_MEDIATEK_ERRATUM_690001
+	arch_timer_mem_sne_use_tval = of_property_read_bool(np,
 "mediatek,erratum-690001");
+#endif
 	frame = arch_timer_mem_find_best_frame(timer_mem);
drivers/clocksource/arm_arch_timer.c +0 -0
 	if (!frame) {
 		pr_err("Unable to find a suitable frame in timer @

%pa\n",