drivers/sx127x: pkg/semtech-loramac: replace xtimer by ztimer #14547

aabadie · 2020-07-17T15:00:03Z

Contribution description

This PR replaces the xtimer used by the sx127x radio driver and package semtech-loramac by the new ztimer and especially its rtt based backend version.
This should allow lower power consumption, even between the TX and RX windows phases, but it will also allow the use of STOP mode (with RAM retention) on STM32 without the need to disable the duty-cycle check. I tested this particular point with #11237 and this PR and now it works.

Note that to be able to use the RTT backend one cannot rely on usec precision timers. msec precision delays cannot be used with radio reset delays but loramac uses ms precision delays all the time, so it can be used there. As a result, all timeouts that were provided in microseconds are now converted to milliseconds.

Testing procedure

verify that examples/lorawan and pkg/semtech_loramac are still functional

Issues/PRs references

Will be usefull for #11237

drivers/sx127x/Makefile.dep

fjmolinas · 2020-08-11T09:42:19Z

Would be nice if you start posting your test results ouput in the PR description.

fjmolinas · 2020-08-11T09:58:37Z

I'll run the release tests for both applications :)

fjmolinas · 2020-08-11T10:05:09Z

All good with tests/pkg_semtech_loramac:

IOTLAB_NODE=st-lrwan1-10.saclay.iot-lab.info make -C tests/pkg_semtech-loramac/ flash test -j3

main(): This is RIOT! (Version: 2020.10-devel-474-g5b8be-pr-14547)
All up, running the shell now
> loramac get devaddr
loramac get devaddr
DEVADDR: 2601107E
> loramac get nwkskey
loramac get nwkskey
NWKSKEY: 6CCC73B2681EC60142C5D4933BFE8D34
> loramac get appskey
loramac get appskey
APPSKEY: 07683C44D66D201B557B0DF7EFEF8391
> TEST PASSED

fjmolinas · 2020-08-11T10:07:24Z

examples/lorawan is not working for me:

main(): This is RIOT! (Version: 2020.10-devel-669-g2fb7d-HEAD)
LoRaWAN Class A low-power application
=====================================
Starting join procedure
Join procedure succeeded
Sending: This is RIOT!
# Nothing happens here ...

fjmolinas · 2020-08-11T10:14:12Z

examples/lorawan is not working for me:

Hmm seems to be an issue with iotlab boards, works with locally connected boards:

main(): This is RIOT! (Version: 2020.10-devel-474-g5b8be-pr-14547)
LoRaWAN Class A low-power application
=====================================
Starting join procedure
Join procedure succeeded
Sending: This is RIOT!
Sending: This is RIOT!
Sending: This is RIOT!
Sending: This is RIOT!
Sending: This is RIOT!
TESST PASSED

fjmolinas · 2020-08-11T10:14:59Z

@aabadie changes make sense and are working, once you take a look at my ztimer comment I'll ACK.

fjmolinas · 2020-08-11T10:16:38Z

BTW works with st-lrwan1-19.saclay.iot-lab.info but not with st-lrwan1-10.saclay.iot-lab.info'/st-lrwan1-11.saclay.iot-lab.info'at least.

fjmolinas

ACK.

fjmolinas · 2020-08-12T07:47:28Z

@aabadie murdock spotted many conflicts, can you take a look?

aabadie · 2020-08-12T12:49:03Z

murdock spotted many conflicts, can you take a look?

There were several issues:

rtc and rtt features are conflicting on efm32 so I blacklisted these platform for examples/lorawan (since it uses both) => 61ab47e
the xtimer defines for lobaro-lorabox were in the wrong file, this is fixed by 1579614
for cpu with timer clocked at 250kHZ (Atmega), there was an issue in the ztimer auto_init code. I fixed it in 7c3e14e but I'm not 100% sure of the fix.

I can provide the last 2 commits in separate PRs to ease review if you want.

examples/lorawan/Makefile

sys/ztimer/auto_init.c

boards/derfmega128/include/board.h

fjmolinas · 2020-08-13T07:05:26Z

pkg/semtech-loramac/Makefile.dep

@@ -6,6 +6,9 @@ USEMODULE += semtech_loramac_mac_region
 USEMODULE += semtech_loramac_crypto
 USEMODULE += semtech_loramac_arch

+USEMODULE += ztimer_msec
+USEMODULE += ztimer_periph_rtt


Suggested change

USEMODULE += ztimer_periph_rtt

# If RTT feature is available use the RTT backend of ztimer

FEATURES_OPTIONAL += periph_rtt

ifneq (,$(filter periph_rtt,$(FEATURES_USED)))

USEMODULE += ztimer_periph_rtt

endif

I prefer keeping the actual state for the loramac pkg: it's important to ensure that the rtt is used because of the duty-cycle timer. In a deep sleep mode with RAM retention, a regular timer will be stopped but not a rtt based timer.

But why enforce it? Low Power modes are not enabled by default, only examples/lorawan does that.

ztimer is an internal implementation detail of the package adaption to RIOT. There's no need to enforce developers to add this dependency in their lorawan applications.

I think is a question of keeping flexibility or having things that work out of the box. I think you want the later, that is OK for me since you are maintaining this. Can you then add some documentation to the pkg on the implementation status, I think it would be good to say why rtt is required or when it is required. And in the same sense, what is needed for the pkg to work, what is needed for the pkg to work with sleep modes, etc... For me this is not very clear without having a knowledge of the code/implementation internals.

fjmolinas · 2020-08-13T07:22:05Z

@aabadie The fact that rtc and rtt are required seems very stm32 specific since with stm32 only rtc can wake up the cpu. It seems like a shame to blacklist architectures because of this.

Don't agree with latest changes.

aabadie · 2020-08-13T15:09:32Z

with stm32 only rtc can wake up the cpu

only in standby mode. In stop mode, rtt can wakeup the cpu.

It's not stm32 specific, it's just that examples/lorawan is using the rtc as a periodic alarm to send to next message. It could be done differently of course.
But I prefer using the RTC alarm so there's support for standby mode (or any mode without RAM retention) with lorawan. This is an important use case.

fjmolinas · 2020-08-13T15:19:23Z

It's not stm32 specific, it's just that examples/lorawan is using the rtc as a periodic alarm to send to next message. It could be done differently of course.
But I prefer using the RTC alarm so there's support for standby mode (or any mode without RAM retention) with lorawan. This is an important use case.

Ok I guess this is just an examples, and tests/pkg_semtech_loramac is more flexible.

fjmolinas · 2020-08-20T10:45:18Z

@aabadie only static tests did not pass, only #14547 (comment) has not yet been addressed

aabadie · 2020-08-20T12:08:50Z

squashed (to fix static tests) and added documentation to address #14547 (comment)

fjmolinas

ACK, lets wait for murdock

aabadie · 2020-08-20T13:14:23Z

Thanks for reviewing @fjmolinas !

aabadie added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: pkg Area: External package ports Area: drivers Area: Device drivers Area: LoRa Area: LoRa radio support labels Jul 17, 2020

aabadie requested a review from jia200x as a code owner July 17, 2020 15:00

aabadie requested a review from fjmolinas July 17, 2020 15:02

aabadie mentioned this pull request Jul 17, 2020

examples/lorawan: add the possibility to use ABP activation procedure #11237

Merged

aabadie force-pushed the pr/lora/ztimer branch from db71cc5 to 5b8becd Compare July 31, 2020 15:10

fjmolinas reviewed Aug 11, 2020

View reviewed changes

drivers/sx127x/Makefile.dep Outdated Show resolved Hide resolved

fjmolinas self-assigned this Aug 11, 2020

aabadie force-pushed the pr/lora/ztimer branch from 5b8becd to 161c1da Compare August 11, 2020 13:48

aabadie mentioned this pull request Aug 11, 2020

examples/lorawan: fix typo in automatic test script #14746

Merged

fjmolinas previously approved these changes Aug 11, 2020

View reviewed changes

fjmolinas added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Aug 11, 2020

aabadie requested review from bergzand, kaspar030 and leandrolanzieri as code owners August 12, 2020 12:43

fjmolinas reviewed Aug 12, 2020

View reviewed changes

examples/lorawan/Makefile Outdated Show resolved Hide resolved

fjmolinas reviewed Aug 12, 2020

View reviewed changes

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

fjmolinas reviewed Aug 12, 2020

View reviewed changes

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

aabadie force-pushed the pr/lora/ztimer branch from 8484474 to 2ce34f8 Compare August 12, 2020 16:24

cgundogan added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Aug 12, 2020

fjmolinas reviewed Aug 13, 2020

View reviewed changes

boards/derfmega128/include/board.h Outdated Show resolved Hide resolved

fjmolinas reviewed Aug 13, 2020

View reviewed changes

fjmolinas mentioned this pull request Aug 13, 2020

makefiles/info-global.inc.mk: include FEATURES_CONFLICTS #14753

Merged

aabadie force-pushed the pr/lora/ztimer branch 2 times, most recently from b5efadd to 79eea38 Compare August 20, 2020 09:48

aabadie added 5 commits August 20, 2020 13:41

drivers/sx127x: migrate to ztimer

6199ada

pkg/semtech-loramac: migrate to ztimer usage

52748dd

boards/lobaro-lorabox: move xtimer defines to board.h

f4bc27e

sys/ztimer: fix ztimer msec convert for 250kHz timers

f1d5e98

pkg/semtech-loramac: add documentation about ztimer

abfbc8a

aabadie force-pushed the pr/lora/ztimer branch from 79eea38 to abfbc8a Compare August 20, 2020 12:08

fjmolinas approved these changes Aug 20, 2020

View reviewed changes

aabadie merged commit 73b3d2a into RIOT-OS:master Aug 20, 2020

aabadie deleted the pr/lora/ztimer branch August 20, 2020 13:14

fjmolinas mentioned this pull request Apr 26, 2021

Unsatisfied features RIOT-OS stm32f0discovery #16369

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers/sx127x: pkg/semtech-loramac: replace xtimer by ztimer #14547

drivers/sx127x: pkg/semtech-loramac: replace xtimer by ztimer #14547

aabadie commented Jul 17, 2020 •

edited

Loading

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas left a comment

fjmolinas commented Aug 12, 2020

aabadie commented Aug 12, 2020 •

edited

Loading

fjmolinas Aug 13, 2020 •

edited

Loading

aabadie Aug 13, 2020

fjmolinas Aug 13, 2020

aabadie Aug 13, 2020

fjmolinas Aug 18, 2020

fjmolinas commented Aug 13, 2020

aabadie commented Aug 13, 2020

fjmolinas commented Aug 13, 2020

fjmolinas commented Aug 20, 2020

aabadie commented Aug 20, 2020

fjmolinas left a comment

aabadie commented Aug 20, 2020

-USEMODULE += ztimer_periph_rtt
+# If RTT feature is available use the RTT backend of ztimer
+FEATURES_OPTIONAL += periph_rtt
+ifneq (,$(filter periph_rtt,$(FEATURES_USED)))
+  USEMODULE += ztimer_periph_rtt
+endif

drivers/sx127x: pkg/semtech-loramac: replace xtimer by ztimer #14547

drivers/sx127x: pkg/semtech-loramac: replace xtimer by ztimer #14547

Conversation

aabadie commented Jul 17, 2020 • edited Loading

Contribution description

Testing procedure

Issues/PRs references

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas commented Aug 11, 2020

fjmolinas left a comment

Choose a reason for hiding this comment

fjmolinas commented Aug 12, 2020

aabadie commented Aug 12, 2020 • edited Loading

fjmolinas Aug 13, 2020 • edited Loading

Choose a reason for hiding this comment

aabadie Aug 13, 2020

Choose a reason for hiding this comment

fjmolinas Aug 13, 2020

Choose a reason for hiding this comment

aabadie Aug 13, 2020

Choose a reason for hiding this comment

fjmolinas Aug 18, 2020

Choose a reason for hiding this comment

fjmolinas commented Aug 13, 2020

aabadie commented Aug 13, 2020

fjmolinas commented Aug 13, 2020

fjmolinas commented Aug 20, 2020

aabadie commented Aug 20, 2020

fjmolinas left a comment

Choose a reason for hiding this comment

aabadie commented Aug 20, 2020

aabadie commented Jul 17, 2020 •

edited

Loading

aabadie commented Aug 12, 2020 •

edited

Loading

fjmolinas Aug 13, 2020 •

edited

Loading