Merge pull request #16187 from benpicco/cpu/sam0_common/get_tamper

cpu/sam0_common: add rtc_get_tamper_event()

cpu/sam0_common/include/periph_cpu_common.h

@@ -1144,6 +1144,27 @@ int rtc_tamper_register(gpio_t pin, gpio_flank_t flank);
  * @brief   Enable Tamper Detection IRQs
  */
 void rtc_tamper_enable(void);
+
+/**
+ * @brief   Get and clear the RTC tamper event that has woken the CPU
+ *          from Deep Sleep.
+ *
+ * @return  The set bits in the return value correspond to the tamper
+ *          pin index inside the @ref rtc_tamper_pins array.
+ */
+uint8_t rtc_get_tamper_event(void);
+
+/**
+ * @brief   Get the tamper event mask for a certain pin.
+ *          Can be used together with @ref rtc_get_tamper_event to
+ *          check which RTC  pin caused the tamper event.
+ *
+ * @param pin   Pin to query
+ *
+ * @return  Bit mask with the bit corresponding to @p pin set
+ *          0 if @p pin is no RTC tamper pin
+ */
+uint8_t rtc_tamper_pin_mask(gpio_t pin);
 /** @} */
 
 /**

cpu/sam0_common/periph/rtc_rtt.c

@@ -281,6 +281,7 @@ void rtt_init(void)
 #if RTC_NUM_OF_TAMPERS
 
 static rtc_state_t tamper_cb;
+static uint32_t tampctr;
 
 /* check if pin is a RTC tamper pin */
 static int _rtc_pin(gpio_t pin)
@@ -294,20 +295,32 @@ static int _rtc_pin(gpio_t pin)
     return -1;
 }
 
+static void _set_tampctrl(uint32_t reg)
+{
+    _rtc_set_enabled(0);
+    RTC->MODE0.TAMPCTRL.reg = reg;
+    _rtc_set_enabled(1);
+}
+
 void rtc_tamper_init(void)
 {
-    if (IS_ACTIVE(MODULE_PERIPH_RTC) ||
+    DEBUG("tamper init\n");
-        IS_ACTIVE(MODULE_PERIPH_RTT) ||
+
-        _power_is_on()) {
+    /* configure RTC clock only if it is not already configured */
-        return;
+    if (!IS_ACTIVE(MODULE_PERIPH_RTC) &&
+        !IS_ACTIVE(MODULE_PERIPH_RTT)) {
+
+        if (!_power_is_on()) {
+            _rtt_clock_setup();
+            _poweron();
+        }
+
+        /* disable all interrupt sources */
+        RTC->MODE0.INTENCLR.reg = RTC_MODE0_INTENCLR_MASK;
     }
 
-    _rtt_clock_setup();
+    /* disable old tamper events */
-    _poweron();
+    _set_tampctrl(0);
-
-    /* disable all interrupt sources */
-    RTC->MODE0.INTENCLR.reg = RTC_MODE0_INTENCLR_MASK;
-
     NVIC_EnableIRQ(RTC_IRQn);
 }
 
@@ -319,20 +332,14 @@ int rtc_tamper_register(gpio_t pin, gpio_flank_t flank)
         return -1;
     }
 
-    /* TAMPCTRL is enable-protected */
+    tampctr |= RTC_TAMPCTRL_IN0ACT_WAKE << (2 * in);
-    _rtc_set_enabled(0);
-
-    RTC->MODE0.TAMPCTRL.reg |= RTC_TAMPCTRL_IN0ACT_WAKE << (2 * in);
 
     if (flank == GPIO_RISING) {
-        RTC->MODE0.TAMPCTRL.reg |= RTC_TAMPCTRL_TAMLVL0 << in;
+        tampctr |= RTC_TAMPCTRL_TAMLVL0 << in;
     } else if (flank == GPIO_FALLING) {
-        RTC->MODE0.TAMPCTRL.reg &= ~(RTC_TAMPCTRL_TAMLVL0 << in);
+        tampctr &= ~(RTC_TAMPCTRL_TAMLVL0 << in);
     }
 
-    /* enable the RTC again */
-    _rtc_set_enabled(1);
-
     return 0;
 }
 
@@ -341,7 +348,10 @@ void rtc_tamper_enable(void)
     DEBUG("enable tamper\n");
 
     /* clear tamper id */
-    RTC->MODE0.TAMPID.reg = 0xF;
+    RTC->MODE0.TAMPID.reg = 0x1F;
+
+    /* write TAMPCTRL register */
+    _set_tampctrl(tampctr);
 
     /* work around errata 2.17.4:
      * ignore the first tamper event on the rising edge */
@@ -374,6 +384,26 @@ void rtc_tamper_enable(void)
     DEBUG("tamper enabled\n");
 }
 
+uint8_t rtc_get_tamper_event(void)
+{
+    uint32_t ret = RTC->MODE0.TAMPID.reg;
+
+    /* clear tamper event */
+    RTC->MODE0.INTFLAG.reg = RTC_MODE0_INTFLAG_TAMPER;
+    RTC->MODE0.TAMPID.reg  = ret;
+
+    return ret & RTC_TAMPID_TAMPID_Msk;
+}
+
+uint8_t rtc_tamper_pin_mask(gpio_t pin)
+{
+    int idx = _rtc_pin(pin);
+    if (idx < 0) {
+        return 0;
+    }
+
+    return 1 << idx;
+}
 #endif /* RTC_NUM_OF_TAMPERS */
 
 void rtt_set_overflow_cb(rtt_cb_t cb, void *arg)

tests/periph_gpio/main.c

@@ -429,6 +429,13 @@ int main(void)
          "NOTE: make sure the values you use exist on your platform! The\n"
          "      behavior for not existing ports/pins is not defined!");
 
+#if IS_ACTIVE(MODULE_PERIPH_GPIO_TAMPER_WAKE)
+    uint8_t tamper = rtc_get_tamper_event();
+    if (tamper) {
+        printf("\nWoken by RTC tamper event: %x\n", tamper);
+    }
+#endif
+
     /* start the shell */
     char line_buf[SHELL_DEFAULT_BUFSIZE];
     shell_run(shell_commands, line_buf, SHELL_DEFAULT_BUFSIZE);