From 7c3360e4d6f988bc9d5b2cc72b6d6c20af377cf0 Mon Sep 17 00:00:00 2001
From: Francisco Molina <femolina@uc.cl>
Date: Tue, 2 Nov 2021 10:50:34 +0100
Subject: [PATCH 1/3] sys/ztimer: add 'ztimer_no_periph_rtt'

This is a temporary fix for Issue #17060. It allows to disable
auto inclusion of `ztimer_periph_rtt` in cases where another
module or application requires direct access.

Limitations:
- as ifeq are involved order of inclusion matters, therefore
  these modules should be included early in the build at application
  level and not in modules `Makefile.dep`
- this does not disallow direct inclusions of `ztimer_periph_rtt`,
  since this only disables auto inclusion of these modules

This is a temporary solution since this is already possible with
Kconfig, but not in make.
---
 drivers/include/periph/rtt.h |  4 +++
 sys/include/ztimer.h         |  5 ++++
 sys/ztimer/Kconfig           | 10 ++++++--
 sys/ztimer/Makefile.dep      | 49 +++++++++++++++---------------------
 4 files changed, 37 insertions(+), 31 deletions(-)

diff --git a/drivers/include/periph/rtt.h b/drivers/include/periph/rtt.h
index 59a0a3dfe8..65128f7441 100644
--- a/drivers/include/periph/rtt.h
+++ b/drivers/include/periph/rtt.h
@@ -22,6 +22,10 @@
  * On many CPUs, certain power states might need to be blocked in rtt_init(), so
  * that it is ensured that the RTT will function properly while it is enabled.
  *
+ * @warning     This module will be automatically be used as a backend for
+ *              ZTIMER_SEC and ZTIMER_MSEC. If direct access to RTT is needed
+ *              then include `ztimer_no_periph_rtt` to avoid auto-selection,
+ *              i.e.: `USEMODULE += ztimer_no_periph_rtt`.
  * @{
  * @file
  * @brief       Low-level RTT (Real Time Timer) peripheral driver interface
diff --git a/sys/include/ztimer.h b/sys/include/ztimer.h
index 3579afc0fa..80eaebceff 100644
--- a/sys/include/ztimer.h
+++ b/sys/include/ztimer.h
@@ -197,6 +197,11 @@
  *              if if these are missing it will use same basic timer
  *              as ZTIMER_USEC does.
  *
+ * If `periph_rtt` is required with direct access by another MODULE or
+ * application, `ztimer_no_periph_rtt` can be included to avoid automatic
+ * selection of `ztimer_periph_rtt` as a backend for ZTIMER_SEC and ZTIMER_MSEC.
+ * i.e.: `USEMODULE += ztimer_no_periph_rtt`.
+ *
  * These pointers are defined in `ztimer.h` and can be used like this:
  *
  *     ztimer_now(ZTIMER_USEC);
diff --git a/sys/ztimer/Kconfig b/sys/ztimer/Kconfig
index daad9f11b1..387bace4d9 100644
--- a/sys/ztimer/Kconfig
+++ b/sys/ztimer/Kconfig
@@ -10,6 +10,12 @@ menu "ztimer - High level timer abstraction layer"
 config ZTIMER_CUSTOM_BACKEND_CONFIGURATION
     bool "Override default backend selection"
 
+config MODULE_ZTIMER_NO_PERIPH_RTT
+    bool "Disable ztimer_periph_rtt auto-inclusion"
+    help
+        This module disables the auto-inclusion of ztimer_periph_rtt as a backend
+        for ztimer_msec and ztimer_sec.
+
 menu "Backends"
     visible if ZTIMER_CUSTOM_BACKEND_CONFIGURATION
 
@@ -56,7 +62,7 @@ config MODULE_ZTIMER_MSEC
 choice
     bool "Backend"
     depends on MODULE_ZTIMER_MSEC
-    default ZTIMER_MSEC_BACKEND_RTT
+    default ZTIMER_MSEC_BACKEND_RTT if !MODULE_ZTIMER_NO_PERIPH_RTT
 
 config ZTIMER_MSEC_BACKEND_TIMER
     bool "Timer"
@@ -85,7 +91,7 @@ config ZTIMER_SEC_BACKEND_TIMER
 config ZTIMER_SEC_BACKEND_RTT
     bool "RTT"
     depends on HAS_PERIPH_RTT
-    select MODULE_ZTIMER_PERIPH_RTT
+    select MODULE_ZTIMER_PERIPH_RTT if !MODULE_ZTIMER_NO_PERIPH_RTT
 
 config ZTIMER_SEC_BACKEND_RTC
     bool "RTC"
diff --git a/sys/ztimer/Makefile.dep b/sys/ztimer/Makefile.dep
index 131efa2160..456ec2ddee 100644
--- a/sys/ztimer/Makefile.dep
+++ b/sys/ztimer/Makefile.dep
@@ -87,35 +87,26 @@ ifneq (,$(filter ztimer_usec,$(USEMODULE)))
   USEMODULE += ztimer_periph_timer
 endif
 
-ifneq (,$(filter ztimer_msec,$(USEMODULE)))
+ifneq (,$(filter ztimer_msec ztimer_sec,$(USEMODULE)))
   USEMODULE += ztimer
-  FEATURES_OPTIONAL += periph_rtt
-  # HACK: periph_rtt will get used only in the next iteration but an updated
-  # state for FEATURES_USED is needed here so include `features_check.inc.mk`
-  # here instead.
-  # An other option would be to check FEATURES_PROVIDED this would avoid the
-  # order of inclusion problem but it would no take into account possible conflicts
-  # and is also currently not allowed in the build system.
-  # An other alternative would be to delay to the next loop, but this produce a
-  # case where another loop is not executed and the conditional not evaluated
-  # If these kind of usecases pop up before Kconfig migration is completed
-  # then another alternative would be introduce a variable to require an extra
-  # loop independent of USEMODULE, FEATURES_REQUIRED and USEPKG
-  include $(RIOTMAKE)/features_check.inc.mk
-  ifneq (,$(filter periph_rtt,$(FEATURES_USED)))
-    USEMODULE += ztimer_periph_rtt
-  else
-    USEMODULE += ztimer_periph_timer
-  endif
-endif
-
-ifneq (,$(filter ztimer_sec,$(USEMODULE)))
-  USEMODULE += ztimer
-  FEATURES_OPTIONAL += periph_rtt
-  # HACK: see above
-  ifneq (,$(filter periph_rtt,$(FEATURES_USED)))
-    USEMODULE += ztimer_periph_rtt
-  else
-    USEMODULE += ztimer_periph_timer
+  ifeq (,$(filter ztimer_no_periph_rtt,$(USEMODULE)))
+    FEATURES_OPTIONAL += periph_rtt
+    # HACK: periph_rtt will get used only in the next iteration but an updated
+    # state for FEATURES_USED is needed here so include `features_check.inc.mk`
+    # here instead.
+    # An other option would be to check FEATURES_PROVIDED this would avoid the
+    # order of inclusion problem but it would no take into account possible conflicts
+    # and is also currently not allowed in the build system.
+    # An other alternative would be to delay to the next loop, but this produce a
+    # case where another loop is not executed and the conditional not evaluated
+    # If these kind of usecases pop up before Kconfig migration is completed
+    # then another alternative would be introduce a variable to require an extra
+    # loop independent of USEMODULE, FEATURES_REQUIRED and USEPKG
+    include $(RIOTMAKE)/features_check.inc.mk
+    ifneq (,$(filter periph_rtt,$(FEATURES_USED)))
+      USEMODULE += ztimer_periph_rtt
+    else
+      USEMODULE += ztimer_periph_timer
+    endif
   endif
 endif

From 84ba92a99b2cb60e43775fb78dac0cb91108bf40 Mon Sep 17 00:00:00 2001
From: Francisco Molina <femolina@uc.cl>
Date: Tue, 2 Nov 2021 10:54:37 +0100
Subject: [PATCH 2/3] tests: remove uneeded explicit inclusion of
 ztimer_periph_rt*

---
 tests/ztimer_msg/Makefile       | 8 ++++----
 tests/ztimer_underflow/Makefile | 2 --
 2 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/tests/ztimer_msg/Makefile b/tests/ztimer_msg/Makefile
index 7289b23ccd..247bbc2030 100644
--- a/tests/ztimer_msg/Makefile
+++ b/tests/ztimer_msg/Makefile
@@ -2,10 +2,10 @@ include ../Makefile.tests_common
 
 USEMODULE += ztimer_usec
 
-# uncomment this to test using ztimer msec on rtt
-#USEMODULE += ztimer_msec ztimer_periph_rtt
+# uncomment this to test using ztimer msec
+#USEMODULE += ztimer_msec
 
-# uncomment this to test using ztimer sec on rtc
-#USEMODULE += ztimer_sec ztimer_periph_rtc
+# uncomment this to test using ztimer sec
+#USEMODULE += ztimer_sec
 
 include $(RIOTBASE)/Makefile.include
diff --git a/tests/ztimer_underflow/Makefile b/tests/ztimer_underflow/Makefile
index 2a44cfd641..88ca9a1bb7 100644
--- a/tests/ztimer_underflow/Makefile
+++ b/tests/ztimer_underflow/Makefile
@@ -6,7 +6,6 @@ USEMODULE += ztimer
 USEMODULE += ztimer_usec
 ifeq ($(TEST_ZTIMER_CLOCK), ZTIMER_MSEC)
   USEMODULE += ztimer_msec
-  USEMODULE += ztimer_periph_rtt
 	# the same for Kconfig
   ifeq (1,$(TEST_KCONFIG))
     KCONFIG_ADD_CONFIG += $(APPDIR)/app.config.msec.test
@@ -14,7 +13,6 @@ ifeq ($(TEST_ZTIMER_CLOCK), ZTIMER_MSEC)
 endif
 ifeq ($(TEST_ZTIMER_CLOCK), ZTIMER_SEC)
   USEMODULE += ztimer_sec
-  USEMODULE += ztimer_periph_rtc
 endif
 
 CFLAGS += -DTEST_ZTIMER_CLOCK=$(TEST_ZTIMER_CLOCK)

From 638373eec59968c35eb9ca56b53a669d3bb90b98 Mon Sep 17 00:00:00 2001
From: Francisco Molina <femolina@uc.cl>
Date: Tue, 9 Nov 2021 10:33:14 +0100
Subject: [PATCH 3/3] sys/ztimer: add ztimer_periph_rtt module conflict warning

---
 sys/ztimer/Makefile.include | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/sys/ztimer/Makefile.include b/sys/ztimer/Makefile.include
index dc4f5f3b85..a6e0153de2 100644
--- a/sys/ztimer/Makefile.include
+++ b/sys/ztimer/Makefile.include
@@ -4,6 +4,8 @@ ifneq (,$(filter ztimer_xtimer_compat,$(USEMODULE)))
   PSEUDOMODULES += xtimer
 endif
 
+MODULES_ZTIMER_ON_RTT_CONFLICT = rtt_rtc gnrc_lwmac gnrc_gomach
+
 # By defaul use highest possible RTT_FREQUENCY for platforms that allow it. This
 # might not be the most optimized for conversion guarantees that ztimer_periph_rtt
 # will have a capable backend.
@@ -12,4 +14,10 @@ ifneq (,$(filter ztimer_periph_rtt,$(USEMODULE)))
     RTT_FREQUENCY ?= RTT_MAX_FREQUENCY
     CFLAGS += -DRTT_FREQUENCY=$(RTT_FREQUENCY)
   endif
+
+  MODULES_ZTIMER_ON_RTT_CONFLICTING = $(filter $(MODULES_ZTIMER_ON_RTT_CONFLICT),$(USEMODULE))
+  ifneq (0,$(words $(MODULES_ZTIMER_ON_RTT_CONFLICTING)))
+    $(info $(COLOR_YELLOW)WARNING! The following modules conflict with 'ztimer_periph_rtt': '$(MODULES_ZTIMER_ON_RTT_CONFLICTING)')
+    $(info To disable ztimer periph_rtt auto-inclusion add 'ztimer_no_periph_rtt' to 'USEMODULE'$(COLOR_RESET))
+  endif
 endif