sys/ztimer: add LPTIMER auto init #17654

kfessel · 2022-02-14T15:06:06Z

Contribution description

adds LPTIMER to ztimer auto init

Testing procedure

CONFIG_ZTIMER_LPTIMER_DEV
CONFIG_ZTIMER_LPTIMER_FREQ
CONFIG_ZTIMER_LPTIMER_WIDTH
CONFIG_ZTIMER_LPTIMER_BLOCK_PM_MODE

have to be defined
and
ztimer_periph_lptimer
be used
msec and sec prefer lptimer over rtt

I the details a diff can be found adding a second timer for stm32 (may not work on all devices) and using that in the ztimer_xsec example since this PR is about adding the lowpower-timer (lptimer) support to ztimer this was removed from it.

diff --git a/boards/common/stm32/include/cfg_timer_tim2.h b/boards/common/stm32/include/cfg_timer_tim2.h
index d7f6008c6f..c9c7126b30 100644
--- a/boards/common/stm32/include/cfg_timer_tim2.h
+++ b/boards/common/stm32/include/cfg_timer_tim2.h
@@ -47,10 +47,18 @@ static const timer_conf_t timer_config[] = {
 #endif
         .bus      = APB1,
         .irqn     = TIM2_IRQn
-    }
+    },
+    {
+        .dev      = TIM5,
+        .max      = 0xffffffff,
+        .rcc_mask = RCC_APB1ENR_TIM5EN,
+        .bus      = APB1,
+        .irqn     = TIM5_IRQn
+    },
 };
 
 #define TIMER_0_ISR         isr_tim2
+#define TIMER_1_ISR         isr_tim5
 
 #define TIMER_NUMOF         ARRAY_SIZE(timer_config)
 /** @} */
diff --git a/dist/tools/doccheck/exclude_patterns b/dist/tools/doccheck/exclude_patterns
index 362c11d1c3..8c1457d007 100644
--- a/dist/tools/doccheck/exclude_patterns
+++ b/dist/tools/doccheck/exclude_patterns
@@ -13119,3 +13119,4 @@ boards/esp32\-ttgo\-t\-beam/doc\.txt:[0-9]+: warning: unable to resolve referenc
 boards/esp32\-wemos\-lolin\-d32\-pro/doc\.txt:[0-9]+: warning: explicit link request to 'esp32_wemos_lolin_d32_pro_optional_hardware' could not be resolved
 drivers/include/xbee\.h:[0-9]+: warning: found documented return type for xbee_setup that does not return anything
 boards/nrf52840dongle/doc\.txt:[0-9]+: warning: unable to resolve reference to 'nrf52840dongle_flash' for \\ref command
+boards/common/stm32/include/cfg_timer_tim2\.h:[0-9]+: warning: Member TIMER_1_ISR \(macro definition\) of file cfg_timer_tim2\.h is not documented\.
diff --git a/tests/ztimer_xsec/Makefile b/tests/ztimer_xsec/Makefile
index 8709ee2154..f34aa56d08 100644
--- a/tests/ztimer_xsec/Makefile
+++ b/tests/ztimer_xsec/Makefile
@@ -4,6 +4,9 @@ USEMODULE += ztimer
 USEMODULE += ztimer_usec
 USEMODULE += ztimer_msec
 USEMODULE += ztimer_sec
+USEMODULE += ztimer_periph_lptimer
+
+CFLAGS += "-DCONFIG_ZTIMER_LPTIMER_DEV=TIMER_DEV(1)" "-DCONFIG_ZTIMER_LPTIMER_FREQ=1000LU" "-DCONFIG_ZTIMER_LPTIMER_WIDTH=32" "-DCONFIG_ZTIMER_LPTIMER_BLOCK_PM_MODE=ZTIMER_CLOCK_NO_REQUIRED_PM_MODE"
 
 # microbit qemu lacks rtt
 TEST_ON_CI_BLACKLIST += microbit
diff --git a/tests/ztimer_xsec/main.c b/tests/ztimer_xsec/main.c
index 993edfa344..4dc0d69d7b 100644
--- a/tests/ztimer_xsec/main.c
+++ b/tests/ztimer_xsec/main.c
@@ -56,7 +56,7 @@ int main(void)
 {
     puts("starting ztimers");
     /* start a timer on each high level ztimer*/
-    ztimer_set(ZTIMER_SEC, &sec_tim, 1);
+    ztimer_set(ZTIMER_SEC, &sec_tim, 3);
     ztimer_set(ZTIMER_MSEC, &msec_tim, 200);
     ztimer_set(ZTIMER_USEC, &usec_tim, 100 * US_PER_MS);

Issues/PRs references

includes #16342
fixes #17611
this may help with using rtt64 by PR #18120

maribu · 2022-02-15T09:19:07Z

Maybe @jue89 could review this, as he has the hardware and also is interested in a use case for this.

benpicco · 2022-07-18T21:42:07Z

So say I have

--- a/boards/same54-xpro/include/periph_conf.h
+++ b/boards/same54-xpro/include/periph_conf.h
@@ -92,6 +92,15 @@ static const tc32_conf_t timer_config[] = {
         .gclk_id        = TC2_GCLK_ID,
         .gclk_src       = SAM0_GCLK_TIMER,
         .flags          = TC_CTRLA_MODE_COUNT32,
+    },
+    {   /* Timer 2, low power */
+        .dev            = TC4,
+        .irq            = TC4_IRQn,
+        .mclk           = &MCLK->APBCMASK.reg,
+        .mclk_mask      = MCLK_APBCMASK_TC4 | MCLK_APBCMASK_TC5,
+        .gclk_id        = TC4_GCLK_ID,
+        .gclk_src       = SAM0_GCLK_32KHZ,
+        .flags          = TC_CTRLA_MODE_COUNT32,
     }
 };
 
@@ -103,6 +112,10 @@ static const tc32_conf_t timer_config[] = {
 #define TIMER_1_CHANNELS    2
 #define TIMER_1_ISR         isr_tc2
 
+/* Timer 2 configuration */
+#define TIMER_2_CHANNELS    2
+#define TIMER_2_ISR         isr_tc4
+
 #define TIMER_NUMOF         ARRAY_SIZE(timer_config)
 /** @} */

how would I go about using this?

kfessel · 2022-07-19T15:14:23Z

maybe the example commit helps reviewing this
I ran the test BOARD=nucleo-f767zi make flash term

I am not sure how to incorporate the extra timer configuration with our boards (stm32 had just one perih_timer prepared for use -not sure how common that is)
If you use your own board just add a timer configuration (as benpico did)

i should have used timer5 (TIM3 has only 16bits)

sys/ztimer/init.c

benpicco · 2022-09-14T16:21:00Z

I can confirm that this works on same54-xpro too, unfortunately I don't see the power savings I had hoped for.

Please squash (& rebase to solve the merge conflict)

benpicco · 2022-09-15T09:34:13Z

tests/ztimer_xsec/Makefile

@@ -4,6 +4,9 @@ USEMODULE += ztimer
 USEMODULE += ztimer_usec
 USEMODULE += ztimer_msec
 USEMODULE += ztimer_sec
+USEMODULE += ztimer_periph_lptimer
+
+CFLAGS += "-DCONFIG_ZTIMER_LPTIMER_DEV=TIMER_DEV(1)" "-DCONFIG_ZTIMER_LPTIMER_FREQ=1000LU" "-DCONFIG_ZTIMER_LPTIMER_WIDTH=32" "-DCONFIG_ZTIMER_LPTIMER_BLOCK_PM_MODE=ZTIMER_CLOCK_NO_REQUIRED_PM_MODE"


This will break for all non-stm32 boards

i will remove that -- maybe i should remove the whole example commit ?

Yea it's probably for the better

kfessel · 2022-09-15T10:33:17Z

I the details a diff can be found adding a second timer for stm32 (may not work on all devices) and using that in the ztimer_xsec example since this PR is about adding the lowpower-timer (lptimer) support to ztimer this was removed from it.

diff --git a/boards/common/stm32/include/cfg_timer_tim2.h b/boards/common/stm32/include/cfg_timer_tim2.h
index d7f6008c6f..c9c7126b30 100644
--- a/boards/common/stm32/include/cfg_timer_tim2.h
+++ b/boards/common/stm32/include/cfg_timer_tim2.h
@@ -47,10 +47,18 @@ static const timer_conf_t timer_config[] = {
 #endif
         .bus      = APB1,
         .irqn     = TIM2_IRQn
-    }
+    },
+    {
+        .dev      = TIM5,
+        .max      = 0xffffffff,
+        .rcc_mask = RCC_APB1ENR_TIM5EN,
+        .bus      = APB1,
+        .irqn     = TIM5_IRQn
+    },
 };
 
 #define TIMER_0_ISR         isr_tim2
+#define TIMER_1_ISR         isr_tim5
 
 #define TIMER_NUMOF         ARRAY_SIZE(timer_config)
 /** @} */
diff --git a/dist/tools/doccheck/exclude_patterns b/dist/tools/doccheck/exclude_patterns
index 362c11d1c3..8c1457d007 100644
--- a/dist/tools/doccheck/exclude_patterns
+++ b/dist/tools/doccheck/exclude_patterns
@@ -13119,3 +13119,4 @@ boards/esp32\-ttgo\-t\-beam/doc\.txt:[0-9]+: warning: unable to resolve referenc
 boards/esp32\-wemos\-lolin\-d32\-pro/doc\.txt:[0-9]+: warning: explicit link request to 'esp32_wemos_lolin_d32_pro_optional_hardware' could not be resolved
 drivers/include/xbee\.h:[0-9]+: warning: found documented return type for xbee_setup that does not return anything
 boards/nrf52840dongle/doc\.txt:[0-9]+: warning: unable to resolve reference to 'nrf52840dongle_flash' for \\ref command
+boards/common/stm32/include/cfg_timer_tim2\.h:[0-9]+: warning: Member TIMER_1_ISR \(macro definition\) of file cfg_timer_tim2\.h is not documented\.
diff --git a/tests/ztimer_xsec/Makefile b/tests/ztimer_xsec/Makefile
index 8709ee2154..f34aa56d08 100644
--- a/tests/ztimer_xsec/Makefile
+++ b/tests/ztimer_xsec/Makefile
@@ -4,6 +4,9 @@ USEMODULE += ztimer
 USEMODULE += ztimer_usec
 USEMODULE += ztimer_msec
 USEMODULE += ztimer_sec
+USEMODULE += ztimer_periph_lptimer
+
+CFLAGS += "-DCONFIG_ZTIMER_LPTIMER_DEV=TIMER_DEV(1)" "-DCONFIG_ZTIMER_LPTIMER_FREQ=1000LU" "-DCONFIG_ZTIMER_LPTIMER_WIDTH=32" "-DCONFIG_ZTIMER_LPTIMER_BLOCK_PM_MODE=ZTIMER_CLOCK_NO_REQUIRED_PM_MODE"
 
 # microbit qemu lacks rtt
 TEST_ON_CI_BLACKLIST += microbit
diff --git a/tests/ztimer_xsec/main.c b/tests/ztimer_xsec/main.c
index 993edfa344..4dc0d69d7b 100644
--- a/tests/ztimer_xsec/main.c
+++ b/tests/ztimer_xsec/main.c
@@ -56,7 +56,7 @@ int main(void)
 {
     puts("starting ztimers");
     /* start a timer on each high level ztimer*/
-    ztimer_set(ZTIMER_SEC, &sec_tim, 1);
+    ztimer_set(ZTIMER_SEC, &sec_tim, 3);
     ztimer_set(ZTIMER_MSEC, &msec_tim, 200);
     ztimer_set(ZTIMER_USEC, &usec_tim, 100 * US_PER_MS);

kfessel requested a review from jue89 February 14, 2022 15:06

github-actions bot added Area: sys Area: System Area: timers Area: timer subsystems labels Feb 14, 2022

kfessel requested review from kaspar030, chrysn and maribu February 14, 2022 15:07

kfessel changed the title ~~P ztimer lptimer~~ sys/ztimer: add LPTIMER auto init Feb 14, 2022

jue89 mentioned this pull request Feb 14, 2022

ztimer with two instances of ztimer_periph_timer #17611

Closed

kfessel mentioned this pull request May 5, 2022

timers: Increase test variation, increase EFM32 flexibility #18052

Open

kfessel requested a review from benpicco June 28, 2022 09:04

kfessel marked this pull request as ready for review June 28, 2022 09:08

kfessel requested a review from bergzand as a code owner June 28, 2022 09:08

kfessel requested review from smlng, leandrolanzieri, aabadie, MichelRottleuthner and fjmolinas as code owners July 19, 2022 15:12

github-actions bot added Area: boards Area: Board ports Area: tests Area: tests and testing framework labels Jul 19, 2022

kfessel force-pushed the p-ztimer-lptimer branch from 6057078 to 00afe56 Compare July 19, 2022 15:41

benpicco reviewed Sep 14, 2022

View reviewed changes

sys/ztimer/init.c Outdated Show resolved Hide resolved

github-actions bot added the Area: tools Area: Supplementary tools label Sep 14, 2022

kfessel added 2 commits September 15, 2022 11:26

sys/ztimer: auto_init react to possibly missing ztimer_periph_timer

594fe83

sys/ztimer: add LPTIMER auto init

81d06c8

kfessel force-pushed the p-ztimer-lptimer branch from 384843f to 3bb2929 Compare September 15, 2022 09:29

benpicco reviewed Sep 15, 2022

View reviewed changes

kfessel force-pushed the p-ztimer-lptimer branch from 3bb2929 to 81d06c8 Compare September 15, 2022 10:34

github-actions bot removed Area: tools Area: Supplementary tools Area: tests Area: tests and testing framework Area: boards Area: Board ports labels Sep 15, 2022

benpicco approved these changes Sep 15, 2022

View reviewed changes

benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Sep 15, 2022

benpicco merged commit 1be4da5 into RIOT-OS:master Sep 15, 2022

maribu added this to the Release 2022.10 milestone Oct 14, 2022

jue89 mentioned this pull request Oct 21, 2022

sys/ztimer: model ztimer_periph_lptimer for Kconfig #18783

Merged

kfessel mentioned this pull request Jun 6, 2023

sys/ztimer: auto_init react to possibly missing ztimer_periph_timer #16342

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sys/ztimer: add LPTIMER auto init #17654

sys/ztimer: add LPTIMER auto init #17654

kfessel commented Feb 14, 2022 •

edited

Loading

maribu commented Feb 15, 2022

benpicco commented Jul 18, 2022

kfessel commented Jul 19, 2022 •

edited

Loading

benpicco commented Sep 14, 2022

benpicco Sep 15, 2022

kfessel Sep 15, 2022

benpicco Sep 15, 2022

kfessel commented Sep 15, 2022 •

edited

Loading

sys/ztimer: add LPTIMER auto init #17654

sys/ztimer: add LPTIMER auto init #17654

Conversation

kfessel commented Feb 14, 2022 • edited Loading

Contribution description

Testing procedure

Issues/PRs references

maribu commented Feb 15, 2022

benpicco commented Jul 18, 2022

kfessel commented Jul 19, 2022 • edited Loading

benpicco commented Sep 14, 2022

benpicco Sep 15, 2022

Choose a reason for hiding this comment

kfessel Sep 15, 2022

Choose a reason for hiding this comment

benpicco Sep 15, 2022

Choose a reason for hiding this comment

kfessel commented Sep 15, 2022 • edited Loading

kfessel commented Feb 14, 2022 •

edited

Loading

kfessel commented Jul 19, 2022 •

edited

Loading

kfessel commented Sep 15, 2022 •

edited

Loading