wip: initial code changes, starting from @tannewt's sleepio branch

Author: dhalbert

locale/circuitpython.pot

@@ -17,6 +17,13 @@ msgstr ""
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
+#: main.c
+msgid ""
+"\n"
+"\n"
+"------ soft reboot ------\n"
+msgstr ""
+
 #: main.c
 msgid ""
 "\n"
@@ -982,6 +989,10 @@ msgstr ""
 msgid "I2SOut not available"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm_io/__init__.c
+msgid "IOs 0, 2 & 4 do not support internal pullup in sleep"
+msgstr ""
+
 #: shared-bindings/aesio/aes.c
 #, c-format
 msgid "IV must be %d bytes long"
@@ -2793,6 +2804,10 @@ msgstr ""
 msgid "invalid syntax for number"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm_io/__init__.c
+msgid "io must be rtc io"
+msgstr ""
+
 #: py/objtype.c
 msgid "issubclass() arg 1 must be a class"
 msgstr ""
@@ -3313,7 +3328,7 @@ msgstr ""
 msgid "size is defined for ndarrays only"
 msgstr ""
 
-#: shared-bindings/time/__init__.c
+#: shared-bindings/alarm_time/__init__.c shared-bindings/time/__init__.c
 msgid "sleep length must be non-negative"
 msgstr ""
 
@@ -3329,10 +3344,6 @@ msgstr ""
 msgid "small int overflow"
 msgstr ""
 
-#: main.c
-msgid "soft reboot\n"
-msgstr ""
-
 #: extmod/ulab/code/numerical/numerical.c
 msgid "sort argument must be an ndarray"
 msgstr ""
@@ -3417,6 +3428,10 @@ msgstr ""
 msgid "threshold must be in the range 0-65536"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm_time/__init__.c
+msgid "time out of range"
+msgstr ""
+
 #: shared-bindings/time/__init__.c
 msgid "time.struct_time() takes a 9-sequence"
 msgstr ""
@@ -3462,6 +3477,10 @@ msgstr ""
 msgid "trapz is defined for 1D arrays of equal length"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm_io/__init__.c
+msgid "trigger level must be 0 or 1"
+msgstr ""
+
 #: extmod/ulab/code/linalg/linalg.c
 msgid "tuple index out of range"
 msgstr ""
@@ -3604,6 +3623,10 @@ msgstr ""
 msgid "vectors must have same lengths"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm_io/__init__.c
+msgid "wakeup conflict"
+msgstr ""
+
 #: shared-bindings/watchdog/WatchDogTimer.c
 msgid "watchdog timeout must be greater than 0"
 msgstr ""

main.c

@@ -57,6 +57,9 @@
 #include "supervisor/shared/status_leds.h"
 #include "supervisor/shared/stack.h"
 #include "supervisor/serial.h"
+#include "supervisor/usb.h"
+
+#include "shared-bindings/microcontroller/__init__.h"
 
 #include "boards/board.h"
 
@@ -85,6 +88,10 @@
 #include "common-hal/canio/CAN.h"
 #endif
 
+#if CIRCUITPY_SLEEP
+#include "shared-bindings/sleep/__init__.h"
+#endif
+
 void do_str(const char *src, mp_parse_input_kind_t input_kind) {
     mp_lexer_t *lex = mp_lexer_new_from_str_len(MP_QSTR__lt_stdin_gt_, src, strlen(src), 0);
     if (lex == NULL) {
@@ -312,6 +319,14 @@ bool run_code_py(safe_mode_t safe_mode) {
     bool refreshed_epaper_display = false;
     #endif
     rgb_status_animation_t animation;
+    bool ok = result->return_code != PYEXEC_EXCEPTION;
+    #if CIRCUITPY_SLEEP
+    // If USB isn't enumerated then deep sleep.
+    if (ok && !supervisor_workflow_active() && supervisor_ticks_ms64() > CIRCUITPY_USB_ENUMERATION_DELAY * 1024) {
+        common_hal_sleep_deep_sleep();
+    }
+    #endif
+    // Show the animation every N seconds.
     prep_rgb_status_animation(&result, found_main, safe_mode, &animation);
     while (true) {
         RUN_BACKGROUND_TASKS;
@@ -344,8 +359,24 @@ bool run_code_py(safe_mode_t safe_mode) {
             refreshed_epaper_display = maybe_refresh_epaperdisplay();
         }
         #endif
-
-        tick_rgb_status_animation(&animation);
+        bool animation_done = tick_rgb_status_animation(&animation);
+        if (animation_done && supervisor_workflow_active()) {
+            #if CIRCUITPY_SLEEP
+            int64_t remaining_enumeration_wait = CIRCUITPY_USB_ENUMERATION_DELAY * 1024 - supervisor_ticks_ms64();
+            // If USB isn't enumerated then deep sleep after our waiting period.
+            if (ok && remaining_enumeration_wait < 0) {
+                common_hal_sleep_deep_sleep();
+                return; // Doesn't actually get here.
+            }
+            #endif
+            // Wake up every so often to flash the error code.
+            if (!ok) {
+                port_interrupt_after_ticks(CIRCUITPY_FLASH_ERROR_PERIOD * 1024);
+            } else {
+                port_interrupt_after_ticks(remaining_enumeration_wait);
+            }
+            port_sleep_until_interrupt();
+        }
     }
 }
 
@@ -392,7 +423,9 @@ void __attribute__ ((noinline)) run_boot_py(safe_mode_t safe_mode) {
         if (!skip_boot_output) {
             // Wait 1.5 seconds before opening CIRCUITPY_BOOT_OUTPUT_FILE for write,
             // in case power is momentary or will fail shortly due to, say a low, battery.
-            mp_hal_delay_ms(1500);
+            if (common_hal_sleep_get_reset_reason() == RESET_REASON_POWER_VALID) {
+                mp_hal_delay_ms(1500);
+            }
 
             // USB isn't up, so we can write the file.
             filesystem_set_internal_writable_by_usb(false);
@@ -511,7 +544,7 @@ int __attribute__((used)) main(void) {
         }
         if (exit_code == PYEXEC_FORCED_EXIT) {
             if (!first_run) {
-                serial_write_compressed(translate("soft reboot\n"));
+                serial_write_compressed(translate("\n\n------ soft reboot ------\n"));
             }
             first_run = false;
             skip_repl = run_code_py(safe_mode);

ports/atmel-samd/common-hal/microcontroller/__init__.c

@@ -84,6 +84,10 @@ void common_hal_mcu_reset(void) {
     reset();
 }
 
+void common_hal_mcu_deep_sleep(void) {
+    //deep sleep call here
+}
+
 // The singleton microcontroller.Processor object, bound to microcontroller.cpu
 // It currently only has properties, and no state.
 const mcu_processor_obj_t common_hal_mcu_processor_obj = {

ports/cxd56/common-hal/microcontroller/__init__.c

@@ -81,6 +81,10 @@ void common_hal_mcu_reset(void) {
     boardctl(BOARDIOC_RESET, 0);
 }
 
+void common_hal_mcu_deep_sleep(void) {
+    //deep sleep call here
+}
+
 STATIC const mp_rom_map_elem_t mcu_pin_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_UART2_RXD), MP_ROM_PTR(&pin_UART2_RXD) },
     { MP_ROM_QSTR(MP_QSTR_UART2_TXD), MP_ROM_PTR(&pin_UART2_TXD) },

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

@@ -0,0 +1,60 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
+ * Copyright (c) 2019 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/__init__.h"
+#include "shared-bindings/alarm_io/__init__.h"
+#include "shared-bindings/alarm_time/__init__.h"
+
+#include "esp_sleep.h"
+
+void common_hal_alarm_disable_all(void) {
+    esp_sleep_disable_wakeup_source(ESP_SLEEP_WAKEUP_ALL);
+}
+
+mp_obj_t common_hal_alarm_get_wake_alarm(void) {
+    switch (esp_sleep_get_wakeup_cause()) {
+        case ESP_SLEEP_WAKEUP_TIMER: ;
+            //Wake up from timer.
+            alarm_time_obj_t *timer = m_new_obj(alarm_time_obj_t);
+            timer->base.type = &alarm_time_type;
+            return timer;
+        case ESP_SLEEP_WAKEUP_EXT0: ;
+            //Wake up from GPIO
+            alarm_io_obj_t *ext0 = m_new_obj(alarm_io_obj_t);
+            ext0->base.type = &alarm_io_type;
+            return ext0;
+        case ESP_SLEEP_WAKEUP_TOUCHPAD:
+            //TODO: implement TouchIO
+            //Wake up from touch on pad, esp_sleep_get_touchpad_wakeup_status()
+            break;
+        case ESP_SLEEP_WAKEUP_UNDEFINED:
+        default:
+            //Not a deep sleep reset
+            break;
+    }
+    return mp_const_none;
+}

ports/esp32s2/common-hal/alarm_io/__init__.c

@@ -0,0 +1,35 @@
+#include "shared-bindings/alarm_io/__init__.h"
+
+#include "esp_sleep.h"
+#include "driver/rtc_io.h"
+
+mp_obj_t common_hal_alarm_io_pin_state (alarm_io_obj_t *self_in) {
+    if (!rtc_gpio_is_valid_gpio(self_in->gpio)) {
+        mp_raise_ValueError(translate("io must be rtc io"));
+    }
+
+    if (self_in->pull && !self_in->level) {
+        for (uint8_t i = 0; i<=4; i+=2) {
+            if (self_in->gpio == i) {
+                mp_raise_ValueError(translate("IOs 0, 2 & 4 do not support internal pullup in sleep"));
+            }
+        }
+    }
+
+    switch(esp_sleep_enable_ext0_wakeup(self_in->gpio, self_in->level)) {
+        case ESP_ERR_INVALID_ARG:
+            mp_raise_ValueError(translate("trigger level must be 0 or 1"));
+        case ESP_ERR_INVALID_STATE:
+            mp_raise_RuntimeError(translate("wakeup conflict"));
+        default:
+            break;
+    }
+
+    if (self_in->pull) { (self_in->level) ? rtc_gpio_pulldown_en(self_in->gpio) : rtc_gpio_pullup_en(self_in->gpio); }
+
+    return self_in;
+}
+
+void common_hal_alarm_io_disable (void) {
+    esp_sleep_disable_wakeup_source(ESP_SLEEP_WAKEUP_EXT0 | ESP_SLEEP_WAKEUP_EXT1);
+}

ports/esp32s2/common-hal/alarm_time/__init__.c

@@ -0,0 +1,13 @@
+#include "esp_sleep.h"
+
+#include "shared-bindings/alarm_time/__init__.h"
+
+void common_hal_alarm_time_duration (uint32_t ms) {
+    if (esp_sleep_enable_timer_wakeup((ms) * 1000) == ESP_ERR_INVALID_ARG) {
+        mp_raise_ValueError(translate("time out of range"));
+    }
+}
+
+void common_hal_alarm_time_disable (void) {
+    esp_sleep_disable_wakeup_source(ESP_SLEEP_WAKEUP_TIMER);
+}

ports/esp32s2/common-hal/microcontroller/__init__.c

@@ -25,8 +25,8 @@
  * THE SOFTWARE.
  */
 
-#include "py/mphal.h"
 #include "py/obj.h"
+#include "py/mphal.h"
 #include "py/runtime.h"
 
 #include "common-hal/microcontroller/Pin.h"
@@ -41,6 +41,8 @@
 
 #include "freertos/FreeRTOS.h"
 
+#include "esp_sleep.h"
+
 void common_hal_mcu_delay_us(uint32_t delay) {
 
 }
@@ -77,6 +79,10 @@ void common_hal_mcu_reset(void) {
     while(1);
 }
 
+void common_hal_mcu_deep_sleep(void) {
+    esp_deep_sleep_start();
+}
+
 // The singleton microcontroller.Processor object, bound to microcontroller.cpu
 // It currently only has properties, and no state.
 const mcu_processor_obj_t common_hal_mcu_processor_obj = {

ports/esp32s2/mpconfigport.mk

@@ -14,6 +14,10 @@ LONGINT_IMPL = MPZ
 
 # These modules are implemented in ports/<port>/common-hal:
 CIRCUITPY_FULL_BUILD = 1
+CIRCUITPY_ALARM = 1
+CIRCUITPY_ALARM_IO = 1
+CIRCUITPY_ALARM_TIME = 1
+CIRCUITPY_ALARM_TOUCH = 1
 CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_AUDIOIO = 0
 CIRCUITPY_CANIO = 1
@@ -22,6 +26,7 @@ CIRCUITPY_FREQUENCYIO = 0
 CIRCUITPY_I2CPERIPHERAL = 0
 CIRCUITPY_ROTARYIO = 1
 CIRCUITPY_NVM = 0
+
 # We don't have enough endpoints to include MIDI.
 CIRCUITPY_USB_MIDI = 0
 CIRCUITPY_WIFI = 1

ports/esp32s2/supervisor/port.c

@@ -36,13 +36,13 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 
-#include "common-hal/microcontroller/Pin.h"
 #include "common-hal/analogio/AnalogOut.h"
 #include "common-hal/busio/I2C.h"
 #include "common-hal/busio/SPI.h"
 #include "common-hal/busio/UART.h"
-#include "common-hal/pulseio/PulseIn.h"
 #include "common-hal/pwmio/PWMOut.h"
+#include "common-hal/pulseio/PulseIn.h"
+#include "common-hal/microcontroller/Pin.h"
 #include "common-hal/wifi/__init__.h"
 #include "supervisor/memory.h"
 #include "supervisor/shared/tick.h"