Merge pull request #4816 from hierophect/rp2040-alarms

RP2040: add Alarm module

locale/circuitpython.pot

@@ -1702,6 +1702,7 @@ msgstr ""
 
 #: ports/esp32s2/common-hal/alarm/time/TimeAlarm.c
 #: ports/nrf/common-hal/alarm/time/TimeAlarm.c
+#: ports/raspberrypi/common-hal/alarm/time/TimeAlarm.c
 #: ports/stm/common-hal/alarm/time/TimeAlarm.c
 msgid "Only one alarm.time alarm can be set."
 msgstr ""
@@ -2035,6 +2036,7 @@ msgstr ""
 msgid "Size not supported"
 msgstr ""
 
+#: ports/raspberrypi/common-hal/alarm/SleepMemory.c
 #: ports/stm/common-hal/alarm/SleepMemory.c
 msgid "Sleep Memory not available"
 msgstr ""
@@ -2179,6 +2181,7 @@ msgstr ""
 msgid "Total data to write is larger than %q"
 msgstr ""
 
+#: ports/raspberrypi/common-hal/alarm/touch/TouchAlarm.c
 #: ports/stm/common-hal/alarm/touch/TouchAlarm.c
 msgid "Touch alarms not available"
 msgstr ""

ports/raspberrypi/boards/adafruit_feather_rp2040/board.c

@@ -38,3 +38,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/adafruit_itsybitsy_rp2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/adafruit_macropad_rp2040/board.c

@@ -41,3 +41,6 @@ void reset_board(void) {
     // turn off any left over LED
     board_reset_user_neopixels(&pin_GPIO19, 12);
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/adafruit_qt2040_trinkey/board.c

@@ -38,3 +38,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/adafruit_qtpy_rp2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/arduino_nano_rp2040_connect/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/cytron_maker_pi_rp2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_keybow2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_pga2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_picolipo_16mb/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_picolipo_4mb/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_picosystem/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/pimoroni_tiny2040/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/raspberry_pi_pico/board.c

@@ -35,3 +35,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/sparkfun_micromod_rp2040/board.c

@@ -38,3 +38,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/sparkfun_pro_micro_rp2040/board.c

@@ -38,3 +38,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/boards/sparkfun_thing_plus_rp2040/board.c

@@ -38,3 +38,6 @@ bool board_requests_safe_mode(void) {
 
 void reset_board(void) {
 }
+
+void board_deinit(void) {
+}

ports/raspberrypi/common-hal/alarm/SleepMemory.c

@@ -0,0 +1,47 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <string.h>
+
+#include "py/runtime.h"
+#include "common-hal/alarm/SleepMemory.h"
+
+void alarm_sleep_memory_reset(void) {
+}
+
+uint32_t common_hal_alarm_sleep_memory_get_length(alarm_sleep_memory_obj_t *self) {
+    mp_raise_NotImplementedError(translate("Sleep Memory not available"));
+    return 0;
+}
+
+bool common_hal_alarm_sleep_memory_set_bytes(alarm_sleep_memory_obj_t *self, uint32_t start_index, const uint8_t *values, uint32_t len) {
+    mp_raise_NotImplementedError(translate("Sleep Memory not available"));
+    return false;
+}
+
+void common_hal_alarm_sleep_memory_get_bytes(alarm_sleep_memory_obj_t *self, uint32_t start_index, uint8_t *values, uint32_t len) {
+    mp_raise_NotImplementedError(translate("Sleep Memory not available"));
+}

ports/raspberrypi/common-hal/alarm/SleepMemory.h

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_SLEEPMEMORY_H
+#define MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_SLEEPMEMORY_H
+
+#include "py/obj.h"
+
+typedef struct {
+    mp_obj_base_t base;
+} alarm_sleep_memory_obj_t;
+
+extern void alarm_sleep_memory_reset(void);
+
+#endif // MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_SLEEPMEMORY_H

ports/raspberrypi/common-hal/alarm/__init__.c

@@ -0,0 +1,258 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/gc.h"
+#include "py/obj.h"
+#include "py/objtuple.h"
+#include "py/runtime.h"
+#include "lib/utils/interrupt_char.h"
+
+#include "shared-bindings/alarm/__init__.h"
+#include "shared-bindings/alarm/SleepMemory.h"
+#include "shared-bindings/alarm/pin/PinAlarm.h"
+#include "shared-bindings/alarm/time/TimeAlarm.h"
+#include "shared-bindings/alarm/touch/TouchAlarm.h"
+
+#include "shared-bindings/microcontroller/__init__.h"
+
+#include "supervisor/port.h"
+#include "supervisor/shared/workflow.h"
+
+#include "pico/stdlib.h"
+#include "hardware/sync.h"
+#include "hardware/clocks.h"
+#include "hardware/xosc.h"
+#include "hardware/structs/scb.h"
+#include "hardware/watchdog.h"
+#include "hardware/structs/watchdog.h"
+
+// XOSC shutdown
+#include "hardware/rtc.h"
+#include "hardware/pll.h"
+#include "hardware/regs/io_bank0.h"
+
+// Watchdog scratch register
+// Not used elsewhere in the SDK for now, keep an eye on it
+#define RP_WKUP_SCRATCH_REG 0
+
+// Light sleep turns off nonvolatile Busio and other wake-only peripherals
+// TODO: this only saves about 2mA right now, expand with other non-essentials
+const uint32_t RP_LIGHTSLEEP_EN0_MASK = ~(
+    CLOCKS_SLEEP_EN0_CLK_SYS_SPI1_BITS |
+    CLOCKS_SLEEP_EN0_CLK_PERI_SPI1_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_SPI0_BITS |
+    CLOCKS_SLEEP_EN0_CLK_PERI_SPI0_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_PWM_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_PIO1_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_PIO0_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_I2C1_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_I2C0_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_ADC_BITS |
+    CLOCKS_SLEEP_EN0_CLK_ADC_ADC_BITS
+    );
+// This bank has the USB clocks in it, leave it for now
+const uint32_t RP_LIGHTSLEEP_EN1_MASK = CLOCKS_SLEEP_EN1_RESET;
+
+// Light sleeps used for TimeAlarm deep sleep turn off almost everything
+const uint32_t RP_LIGHTSLEEP_EN0_MASK_HARSH = (
+    CLOCKS_SLEEP_EN0_CLK_RTC_RTC_BITS |
+    CLOCKS_SLEEP_EN0_CLK_SYS_PADS_BITS
+    );
+const uint32_t RP_LIGHTSLEEP_EN1_MASK_HARSH = 0x0;
+
+STATIC void prepare_for_dormant_xosc(void);
+
+// Singleton instance of SleepMemory.
+const alarm_sleep_memory_obj_t alarm_sleep_memory_obj = {
+    .base = {
+        .type = &alarm_sleep_memory_type,
+    },
+};
+
+void alarm_reset(void) {
+    alarm_sleep_memory_reset();
+    alarm_pin_pinalarm_reset();
+    alarm_time_timealarm_reset();
+
+    // Reset the scratch source
+    watchdog_hw->scratch[RP_WKUP_SCRATCH_REG] = RP_SLEEP_WAKEUP_UNDEF;
+}
+
+STATIC uint8_t _get_wakeup_cause(void) {
+    // First check if the modules remember what last woke up
+    if (alarm_pin_pinalarm_woke_this_cycle()) {
+        return RP_SLEEP_WAKEUP_GPIO;
+    }
+    if (alarm_time_timealarm_woke_this_cycle()) {
+        return RP_SLEEP_WAKEUP_RTC;
+    }
+    // If waking from true deep sleep, modules will have lost their state,
+    // so check the deep wakeup cause manually
+    if (watchdog_hw->scratch[RP_WKUP_SCRATCH_REG] != RP_SLEEP_WAKEUP_UNDEF) {
+        return watchdog_hw->scratch[RP_WKUP_SCRATCH_REG];
+    }
+    return RP_SLEEP_WAKEUP_UNDEF;
+}
+
+// Set up light sleep or deep sleep alarms.
+STATIC void _setup_sleep_alarms(bool deep_sleep, size_t n_alarms, const mp_obj_t *alarms) {
+    alarm_pin_pinalarm_set_alarms(deep_sleep, n_alarms, alarms);
+    alarm_time_timealarm_set_alarms(deep_sleep, n_alarms, alarms);
+}
+
+bool common_hal_alarm_woken_from_sleep(void) {
+    return _get_wakeup_cause() != RP_SLEEP_WAKEUP_UNDEF;
+}
+
+mp_obj_t common_hal_alarm_create_wake_alarm(void) {
+    // If woken from deep sleep, create a copy alarm similar to what would have
+    // been passed in originally. Otherwise, just return none
+    uint8_t cause = _get_wakeup_cause();
+    switch (cause) {
+        case RP_SLEEP_WAKEUP_RTC: {
+            return alarm_time_timealarm_create_wakeup_alarm();
+        }
+
+        case RP_SLEEP_WAKEUP_GPIO: {
+            return alarm_pin_pinalarm_create_wakeup_alarm();
+        }
+
+        case RP_SLEEP_WAKEUP_UNDEF:
+        default:
+            // Not a deep sleep reset.
+            break;
+    }
+    return mp_const_none;
+}
+
+mp_obj_t common_hal_alarm_light_sleep_until_alarms(size_t n_alarms, const mp_obj_t *alarms) {
+    _setup_sleep_alarms(false, n_alarms, alarms);
+
+    mp_obj_t wake_alarm = mp_const_none;
+
+    while (!mp_hal_is_interrupted()) {
+        RUN_BACKGROUND_TASKS;
+        // Detect if interrupt was alarm or ctrl-C interrupt.
+        if (common_hal_alarm_woken_from_sleep()) {
+            uint8_t cause = _get_wakeup_cause();
+            switch (cause) {
+                case RP_SLEEP_WAKEUP_RTC: {
+                    wake_alarm = alarm_time_timealarm_find_triggered_alarm(n_alarms,alarms);
+                    break;
+                }
+                case RP_SLEEP_WAKEUP_GPIO: {
+                    wake_alarm = alarm_pin_pinalarm_find_triggered_alarm(n_alarms,alarms);
+                    break;
+                }
+                default:
+                    // Should not reach this, if all light sleep types are covered correctly
+                    break;
+            }
+            shared_alarm_save_wake_alarm(wake_alarm);
+            break;
+        }
+
+        // Prune the clock for sleep
+        clocks_hw->sleep_en0 &= RP_LIGHTSLEEP_EN0_MASK;
+        clocks_hw->sleep_en1 = RP_LIGHTSLEEP_EN1_MASK;
+
+        // Enable System Control Block (SCB) deep sleep
+        uint save = scb_hw->scr;
+        scb_hw->scr = save | M0PLUS_SCR_SLEEPDEEP_BITS;
+
+        __wfi();
+    }
+
+    if (mp_hal_is_interrupted()) {
+        return mp_const_none; // Shouldn't be given to python code because exception handling should kick in.
+    }
+
+    alarm_reset();
+    return wake_alarm;
+}
+
+void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms) {
+    _setup_sleep_alarms(true, n_alarms, alarms);
+}
+
+void NORETURN common_hal_alarm_enter_deep_sleep(void) {
+    bool timealarm_set = alarm_time_timealarm_is_set();
+
+    // If there's a timealarm, just enter a very deep light sleep
+    if (timealarm_set) {
+        // Prune the clock for sleep
+        clocks_hw->sleep_en0 &= RP_LIGHTSLEEP_EN0_MASK_HARSH;
+        clocks_hw->sleep_en1 = RP_LIGHTSLEEP_EN1_MASK_HARSH;
+        // Enable System Control Block (SCB) deep sleep
+        uint save = scb_hw->scr;
+        scb_hw->scr = save | M0PLUS_SCR_SLEEPDEEP_BITS;
+        __wfi();
+    } else {
+        prepare_for_dormant_xosc();
+        xosc_dormant();
+    }
+    // // TODO: support ROSC when available in SDK
+    // rosc_set_dormant();
+
+    // Reset uses the watchdog. Use scratch registers to store wake reason
+    watchdog_hw->scratch[RP_WKUP_SCRATCH_REG] = _get_wakeup_cause();
+    reset_cpu();
+}
+
+void common_hal_alarm_gc_collect(void) {
+    gc_collect_ptr(shared_alarm_get_wake_alarm());
+}
+
+STATIC void prepare_for_dormant_xosc(void) {
+    // TODO: add ROSC support with sleep_run_from_dormant_source when it's added to SDK
+    uint src_hz = XOSC_MHZ * MHZ;
+    uint clk_ref_src = CLOCKS_CLK_REF_CTRL_SRC_VALUE_XOSC_CLKSRC;
+    clock_configure(clk_ref,
+        clk_ref_src,
+        0,         // No aux mux
+        src_hz,
+        src_hz);
+    clock_configure(clk_sys,
+        CLOCKS_CLK_SYS_CTRL_SRC_VALUE_CLK_REF,
+        0,             // Using glitchless mux
+        src_hz,
+        src_hz);
+    clock_stop(clk_usb);
+    clock_stop(clk_adc);
+    uint clk_rtc_src = CLOCKS_CLK_RTC_CTRL_AUXSRC_VALUE_XOSC_CLKSRC;
+    clock_configure(clk_rtc,
+        0,         // No GLMUX
+        clk_rtc_src,
+        src_hz,
+        46875);
+    clock_configure(clk_peri,
+        0,
+        CLOCKS_CLK_PERI_CTRL_AUXSRC_VALUE_CLK_SYS,
+        src_hz,
+        src_hz);
+    pll_deinit(pll_sys);
+    pll_deinit(pll_usb);
+}

ports/raspberrypi/common-hal/alarm/__init__.h

@@ -0,0 +1,42 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM__INIT__H
+#define MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM__INIT__H
+
+#include "common-hal/alarm/SleepMemory.h"
+
+#include "hardware/regs/clocks.h"
+
+#define RP_SLEEP_WAKEUP_UNDEF   0
+#define RP_SLEEP_WAKEUP_GPIO    1
+#define RP_SLEEP_WAKEUP_RTC     2
+
+extern const alarm_sleep_memory_obj_t alarm_sleep_memory_obj;
+
+extern void alarm_reset(void);
+
+#endif // MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM__INIT__H

ports/raspberrypi/common-hal/alarm/pin/PinAlarm.c

@@ -0,0 +1,164 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/runtime.h"
+
+#include "shared-bindings/alarm/pin/PinAlarm.h"
+#include "shared-bindings/microcontroller/__init__.h"
+#include "common-hal/microcontroller/__init__.h"
+#include "shared-bindings/microcontroller/Pin.h"
+
+#include "pico/stdlib.h"
+#include "hardware/gpio.h"
+#include "hardware/structs/iobank0.h"
+
+STATIC bool woke_up;
+STATIC uint64_t alarm_triggered_pins; // 36 actual pins
+STATIC uint64_t alarm_reserved_pins; // 36 actual pins
+STATIC bool _pinalarm_set = false;
+
+#define GPIO_IRQ_ALL_EVENTS 0x15u
+
+void gpio_callback(uint gpio, uint32_t events) {
+    alarm_triggered_pins |= (1 << gpio);
+    woke_up = true;
+
+    // does this need to be called, to prevent IRQ from constantly going off?
+    gpio_acknowledge_irq(gpio, events);
+
+    // Disable IRQ automatically
+    gpio_set_irq_enabled(gpio, events, false);
+    gpio_set_dormant_irq_enabled(gpio, events, false);
+}
+
+void common_hal_alarm_pin_pinalarm_construct(alarm_pin_pinalarm_obj_t *self, const mcu_pin_obj_t *pin, bool value, bool edge, bool pull) {
+    self->pin = pin;
+    self->value = value;
+    self->edge = edge;
+    self->pull = pull;
+}
+
+const mcu_pin_obj_t *common_hal_alarm_pin_pinalarm_get_pin(alarm_pin_pinalarm_obj_t *self) {
+    return self->pin;
+}
+
+bool common_hal_alarm_pin_pinalarm_get_value(alarm_pin_pinalarm_obj_t *self) {
+    return self->value;
+}
+
+bool common_hal_alarm_pin_pinalarm_get_edge(alarm_pin_pinalarm_obj_t *self) {
+    return self->edge;
+}
+
+bool common_hal_alarm_pin_pinalarm_get_pull(alarm_pin_pinalarm_obj_t *self) {
+    return self->pull;
+}
+
+bool alarm_pin_pinalarm_woke_this_cycle(void) {
+    return woke_up;
+}
+
+mp_obj_t alarm_pin_pinalarm_find_triggered_alarm(size_t n_alarms, const mp_obj_t *alarms) {
+    for (size_t i = 0; i < n_alarms; i++) {
+        if (!mp_obj_is_type(alarms[i], &alarm_pin_pinalarm_type)) {
+            continue;
+        }
+        alarm_pin_pinalarm_obj_t *alarm = MP_OBJ_TO_PTR(alarms[i]);
+        if (alarm_triggered_pins & (1 << alarm->pin->number)) {
+            return alarms[i];
+        }
+    }
+    return mp_const_none;
+}
+
+mp_obj_t alarm_pin_pinalarm_create_wakeup_alarm(void) {
+    alarm_pin_pinalarm_obj_t *alarm = m_new_obj(alarm_pin_pinalarm_obj_t);
+    alarm->base.type = &alarm_pin_pinalarm_type;
+    // TODO: how to obtain the correct pin from memory?
+    return alarm;
+}
+
+void alarm_pin_pinalarm_reset(void) {
+    alarm_triggered_pins = 0;
+    woke_up = false;
+
+    // Clear all GPIO interrupts
+    for (uint8_t i = 0; i < 4; i++) {
+        iobank0_hw->intr[i] = 0;
+    }
+
+    // Reset pins and pin IRQs
+    for (size_t i = 0; i < TOTAL_GPIO_COUNT; i++) {
+        if (alarm_reserved_pins & (1 << i)) {
+            gpio_set_irq_enabled(i, GPIO_IRQ_ALL_EVENTS, false);
+            reset_pin_number(i);
+        }
+    }
+    alarm_reserved_pins = 0;
+}
+
+void alarm_pin_pinalarm_set_alarms(bool deep_sleep, size_t n_alarms, const mp_obj_t *alarms) {
+    for (size_t i = 0; i < n_alarms; i++) {
+        if (mp_obj_is_type(alarms[i], &alarm_pin_pinalarm_type)) {
+            alarm_pin_pinalarm_obj_t *alarm = MP_OBJ_TO_PTR(alarms[i]);
+
+            gpio_init(alarm->pin->number);
+            if (alarm->pull) {
+                // If value is high, the pullup should be off, and vice versa
+                gpio_set_pulls(alarm->pin->number, !alarm->value, alarm->value);
+            } else {
+                // Clear in case the pulls are already on
+                gpio_set_pulls(alarm->pin->number, false, false);
+            }
+            gpio_set_dir(alarm->pin->number, GPIO_IN);
+            // Don't reset at end of VM (instead, pinalarm_reset will reset before next VM)
+            common_hal_never_reset_pin(alarm->pin);
+            alarm_reserved_pins |= (1 << alarm->pin->number);
+
+            uint32_t event;
+            if (alarm->value == true && alarm->edge == true) {
+                event = GPIO_IRQ_EDGE_RISE;
+            } else if (alarm->value == false && alarm->edge == true) {
+                event = GPIO_IRQ_EDGE_FALL;
+            } else if (alarm->value == true && alarm->edge == false) {
+                event = GPIO_IRQ_LEVEL_HIGH;
+            } else { // both false
+                event = GPIO_IRQ_LEVEL_LOW;
+            }
+
+            gpio_set_irq_enabled_with_callback((uint)alarm->pin->number, event, true, &gpio_callback);
+            if (deep_sleep) {
+                gpio_set_dormant_irq_enabled((uint)alarm->pin->number, event, true);
+            }
+
+            _pinalarm_set = true;
+        }
+    }
+}
+
+bool alarm_pin_pinalarm_is_set(void) {
+    return _pinalarm_set;
+}

ports/raspberrypi/common-hal/alarm/pin/PinAlarm.h

@@ -0,0 +1,45 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/obj.h"
+#include "py/objtuple.h"
+
+typedef struct {
+    mp_obj_base_t base;
+    const mcu_pin_obj_t *pin;
+    bool value;
+    bool pull;
+    bool edge;
+} alarm_pin_pinalarm_obj_t;
+
+mp_obj_t alarm_pin_pinalarm_find_triggered_alarm(size_t n_alarms, const mp_obj_t *alarms);
+mp_obj_t alarm_pin_pinalarm_create_wakeup_alarm(void);
+
+void alarm_pin_pinalarm_reset(void);
+void alarm_pin_pinalarm_light_reset(void);
+void alarm_pin_pinalarm_set_alarms(bool deep_sleep, size_t n_alarms, const mp_obj_t *alarms);
+bool alarm_pin_pinalarm_woke_this_cycle(void);
+bool alarm_pin_pinalarm_is_set(void);

ports/raspberrypi/common-hal/alarm/time/TimeAlarm.c

@@ -0,0 +1,130 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/runtime.h"
+
+#include "shared-bindings/alarm/time/TimeAlarm.h"
+#include "shared-bindings/time/__init__.h"
+
+#include "lib/timeutils/timeutils.h"
+
+#include "hardware/gpio.h"
+#include "hardware/rtc.h"
+
+STATIC bool woke_up = false;
+STATIC bool _timealarm_set = false;
+
+void timer_callback(void) {
+    woke_up = true;
+}
+
+void common_hal_alarm_time_timealarm_construct(alarm_time_timealarm_obj_t *self, mp_float_t monotonic_time) {
+    self->monotonic_time = monotonic_time;
+}
+
+mp_float_t common_hal_alarm_time_timealarm_get_monotonic_time(alarm_time_timealarm_obj_t *self) {
+    return self->monotonic_time;
+}
+
+mp_obj_t alarm_time_timealarm_find_triggered_alarm(size_t n_alarms, const mp_obj_t *alarms) {
+    for (size_t i = 0; i < n_alarms; i++) {
+        if (mp_obj_is_type(alarms[i], &alarm_time_timealarm_type)) {
+            return alarms[i];
+        }
+    }
+    return mp_const_none;
+}
+
+mp_obj_t alarm_time_timealarm_create_wakeup_alarm(void) {
+    alarm_time_timealarm_obj_t *timer = m_new_obj(alarm_time_timealarm_obj_t);
+    timer->base.type = &alarm_time_timealarm_type;
+    // TODO: Set monotonic_time based on the RTC state.
+    timer->monotonic_time = 0.0f;
+    return timer;
+}
+
+bool alarm_time_timealarm_woke_this_cycle(void) {
+    return woke_up;
+}
+
+void alarm_time_timealarm_reset(void) {
+    rtc_disable_alarm();
+    woke_up = false;
+}
+
+void alarm_time_timealarm_set_alarms(bool deep_sleep, size_t n_alarms, const mp_obj_t *alarms) {
+    bool timealarm_set = false;
+    alarm_time_timealarm_obj_t *timealarm = MP_OBJ_NULL;
+
+    for (size_t i = 0; i < n_alarms; i++) {
+        if (!mp_obj_is_type(alarms[i], &alarm_time_timealarm_type)) {
+            continue;
+        }
+        if (timealarm_set) {
+            mp_raise_ValueError(translate("Only one alarm.time alarm can be set."));
+        }
+        timealarm = MP_OBJ_TO_PTR(alarms[i]);
+        timealarm_set = true;
+    }
+    if (!timealarm_set) {
+        return;
+    }
+    if (deep_sleep) {
+        _timealarm_set = true;
+    }
+
+    // Compute how long to actually sleep, considering the time now.
+    mp_float_t mono_seconds_to_date = uint64_to_float(common_hal_time_monotonic_ms()) / 1000.0f;
+    mp_float_t wakeup_in_secs = MAX(0.0f, timealarm->monotonic_time - mono_seconds_to_date);
+    datetime_t t;
+
+    rtc_get_datetime(&t);
+
+    uint32_t rtc_seconds_to_date = timeutils_seconds_since_2000(t.year, t.month,
+        t.day, t.hour, t.min, t.sec);
+
+    // The float value is always slightly under, so add 1 to compensate
+    uint32_t alarm_seconds = rtc_seconds_to_date + (uint32_t)wakeup_in_secs + 1;
+    timeutils_struct_time_t tm;
+    timeutils_seconds_since_2000_to_struct_time(alarm_seconds, &tm);
+
+    // reuse t
+    t.hour = tm.tm_hour;
+    t.min = tm.tm_min;
+    t.sec = tm.tm_sec;
+    t.day = tm.tm_mday;
+    t.month = tm.tm_mon;
+    t.year = tm.tm_year;
+    t.dotw = (tm.tm_wday + 1) % 7;
+
+    rtc_set_alarm(&t, &timer_callback);
+
+    woke_up = false;
+}
+
+bool alarm_time_timealarm_is_set(void) {
+    return _timealarm_set;
+}

ports/raspberrypi/common-hal/alarm/time/TimeAlarm.h

@@ -0,0 +1,41 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+
+#include "py/obj.h"
+
+typedef struct {
+    mp_obj_base_t base;
+    mp_float_t monotonic_time;
+} alarm_time_timealarm_obj_t;
+
+mp_obj_t alarm_time_timealarm_find_triggered_alarm(size_t n_alarms, const mp_obj_t *alarms);
+mp_obj_t alarm_time_timealarm_create_wakeup_alarm(void);
+
+void alarm_time_timealarm_reset(void);
+void alarm_time_timealarm_set_alarms(bool deep_sleep, size_t n_alarms, const mp_obj_t *alarms);
+bool alarm_time_timealarm_woke_this_cycle(void);
+bool alarm_time_timealarm_is_set(void);

ports/raspberrypi/common-hal/alarm/touch/TouchAlarm.c

@@ -0,0 +1,32 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "shared-bindings/alarm/touch/TouchAlarm.h"
+#include "shared-bindings/microcontroller/__init__.h"
+
+void common_hal_alarm_touch_touchalarm_construct(alarm_touch_touchalarm_obj_t *self, const mcu_pin_obj_t *pin) {
+    mp_raise_NotImplementedError(translate("Touch alarms not available"));
+}

ports/raspberrypi/common-hal/alarm/touch/TouchAlarm.h

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Lucian Copeland for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_TOUCH_TOUCHALARM_H
+#define MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_TOUCH_TOUCHALARM_H
+
+#include "py/obj.h"
+#include "common-hal/microcontroller/Pin.h"
+
+typedef struct {
+    mp_obj_base_t base;
+    const mcu_pin_obj_t *pin;
+} alarm_touch_touchalarm_obj_t;
+
+#endif  // MICROPY_INCLUDED_RASPBERRYPI_COMMON_HAL_ALARM_TOUCH_TOUCHALARM_H

ports/raspberrypi/mpconfigport.mk

@@ -17,6 +17,8 @@ endif
 # All raspberrypi ports have longints.
 LONGINT_IMPL = MPZ
 
+CIRCUITPY_ALARM ?= 1
+
 CIRCUITPY_RP2PIO ?= 1
 CIRCUITPY_NEOPIXEL_WRITE ?= $(CIRCUITPY_RP2PIO)
 CIRCUITPY_FRAMEBUFFERIO ?= 1