address review comments

Author: dhalbert

lib/utils/pyexec.c

@@ -101,7 +101,7 @@ STATIC int parse_compile_execute(const void *source, mp_parse_input_kind_t input
             #endif
         }
 
-        // If the code was loaded from a file its likely to be running for a while so we'll long
+        // If the code was loaded from a file it's likely to be running for a while so we'll long
         // live it and collect any garbage before running.
         if (input_kind == MP_PARSE_FILE_INPUT) {
             module_fun = make_obj_long_lived(module_fun, 6);
@@ -132,6 +132,10 @@ STATIC int parse_compile_execute(const void *source, mp_parse_input_kind_t input
         if (mp_obj_is_subclass_fast(mp_obj_get_type((mp_obj_t)nlr.ret_val), &mp_type_SystemExit)) {
             // at the moment, the value of SystemExit is unused
             ret = pyexec_system_exit;
+#if CIRCUITPY_ALARM
+        } else if (mp_obj_is_subclass_fast(mp_obj_get_type((mp_obj_t)nlr.ret_val), &mp_type_DeepSleepRequest)) {
+            ret = PYEXEC_DEEP_SLEEP;
+#endif
         } else {
             if ((mp_obj_t) nlr.ret_val != MP_OBJ_FROM_PTR(&MP_STATE_VM(mp_reload_exception))) {
                 mp_obj_print_exception(&mp_plat_print, (mp_obj_t)nlr.ret_val);

lib/utils/pyexec.h

@@ -49,6 +49,7 @@ extern int pyexec_system_exit;
 #define PYEXEC_FORCED_EXIT (0x100)
 #define PYEXEC_SWITCH_MODE (0x200)
 #define PYEXEC_EXCEPTION   (0x400)
+#define PYEXEC_DEEP_SLEEP  (0x800)
 
 int pyexec_raw_repl(void);
 int pyexec_friendly_repl(void);

main.c

@@ -291,11 +291,21 @@ STATIC bool run_code_py(safe_mode_t safe_mode) {
             }
         }
         #endif
+
+        // TODO: on deep sleep, make sure display is refreshed before sleeping (for e-ink).
+
         cleanup_after_vm(heap);
 
         if (result.return_code & PYEXEC_FORCED_EXIT) {
             return reload_requested;
         }
+
+        #if CIRCUITPY_ALARM
+        if (result.return_code & PYEXEC_DEEP_SLEEP) {
+            common_hal_alarm_enter_deep_sleep();
+            // Does not return.
+        }
+        #endif
     }
 
     // Program has finished running.

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

@@ -352,5 +352,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

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

@@ -50,5 +50,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

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

@@ -29,15 +29,16 @@
 #include "py/objtuple.h"
 #include "py/runtime.h"
 
-#include "shared-bindings/alarm/__init__.h"
 #include "shared-bindings/alarm/pin/PinAlarm.h"
 #include "shared-bindings/alarm/time/TimeAlarm.h"
 #include "shared-bindings/microcontroller/__init__.h"
 #include "shared-bindings/time/__init__.h"
+#include "shared-bindings/wifi/__init__.h"
+
+#include "common-hal/alarm/__init__.h"
 
 #include "esp_log.h"
 #include "esp_sleep.h"
-#include "esp_wifi.h"
 
 STATIC mp_obj_tuple_t *_deep_sleep_alarms;
 
@@ -101,7 +102,7 @@ STATIC void setup_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms) {
         mp_float_t now_secs = uint64_to_float(common_hal_time_monotonic_ms()) / 1000.0f;
         mp_float_t wakeup_in_secs = MAX(0.0f, time_alarm->monotonic_time - now_secs);
         const uint64_t sleep_for_us = (uint64_t) (wakeup_in_secs * 1000000);
-        ESP_LOGI("ALARM", "Sleep for us: %lld", sleep_for_us);
+        ESP_LOGI("ALARM", "will sleep for us: %lld", sleep_for_us);
         esp_sleep_enable_timer_wakeup(sleep_for_us);
     }
 }
@@ -157,25 +158,41 @@ mp_obj_t common_hal_alarm_wait_until_alarms(size_t n_alarms, const mp_obj_t *ala
     return mp_const_none;
 }
 
-mp_obj_t common_hal_alarm_sleep_until_alarms(size_t n_alarms, const mp_obj_t *alarms) {
+// Is it safe to do a light sleep? Check whether WiFi is on or there are
+// other ongoing tasks that should not be shut down.
+static bool light_sleep_ok(void) {
+    return !common_hal_wifi_radio_get_enabled(&common_hal_wifi_radio_obj);
+}
+
+mp_obj_t common_hal_alarm_light_sleep_until_alarms(size_t n_alarms, const mp_obj_t *alarms) {
     if (n_alarms == 0) {
         return mp_const_none;
     }
 
-    setup_sleep_alarms(n_alarms, alarms);
-
-    // Shut down wifi cleanly.
-    esp_wifi_stop();
-    ESP_LOGI("ALARM", "start light sleep");
-    esp_light_sleep_start();
-    return common_hal_alarm_get_wake_alarm();
+    if (light_sleep_ok()) {
+        ESP_LOGI("ALARM", "start light sleep");
+        setup_sleep_alarms(n_alarms, alarms);
+        esp_light_sleep_start();
+        return common_hal_alarm_get_wake_alarm();
+    } else {
+        // Don't do an ESP32 light sleep.
+        return common_hal_alarm_wait_until_alarms(n_alarms, alarms);
+    }
 }
 
 void common_hal_alarm_exit_and_deep_sleep_until_alarms(size_t n_alarms, const mp_obj_t *alarms) {
     setup_sleep_alarms(n_alarms, alarms);
 
-    // Shut down wifi cleanly.
-    esp_wifi_stop();
+    // Raise an exception, which will be processed in main.c.
+    mp_raise_arg1(&mp_type_DeepSleepRequest, NULL);
+}
+
+void common_hal_alarm_prepare_for_deep_sleep(void) {
+    // Turn off WiFi and anything else that should be shut down cleanly.
+    common_hal_wifi_radio_set_enabled(&common_hal_wifi_radio_obj, false);
+}
+
+void NORETURN common_hal_alarm_enter_deep_sleep(void) {
     ESP_LOGI("ALARM", "start deep sleep");
     esp_deep_sleep_start();
 }

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

@@ -29,26 +29,21 @@
 #include "shared-bindings/alarm/pin/PinAlarm.h"
 #include "shared-bindings/microcontroller/Pin.h"
 
-void common_hal_alarm_pin_pin_alarm_construct(alarm_pin_pin_alarm_obj_t *self, const mp_obj_t pins[], size_t num_pins, bool value, bool all_same_value, bool edge, bool pull) {
-    self->pins = mp_obj_new_tuple(num_pins, pins);
+void common_hal_alarm_pin_pin_alarm_construct(alarm_pin_pin_alarm_obj_t *self, mcu_pin_obj_t *pin, bool value, bool edge, bool pull) {
+    self->pin = pin;
     self->value = value;
-    self->all_same_value = all_same_value;
     self->edge = edge;
     self->pull = pull;
 }
 
-mp_obj_tuple_t *common_hal_alarm_pin_pin_alarm_get_pins(alarm_pin_pin_alarm_obj_t *self) {
-    return self->pins;
+mcu_pin_obj_t *common_hal_alarm_pin_pin_alarm_get_pin(alarm_pin_pin_alarm_obj_t *self) {
+    return self->pin;
 }
 
 bool common_hal_alarm_pin_pin_alarm_get_value(alarm_pin_pin_alarm_obj_t *self) {
     return self->value;
 }
 
-bool common_hal_alarm_pin_pin_alarm_get_all_same_value(alarm_pin_pin_alarm_obj_t *self) {
-    return self->all_same_value;
-}
-
 bool common_hal_alarm_pin_pin_alarm_get_edge(alarm_pin_pin_alarm_obj_t *self) {
     return self->edge;
 }

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

@@ -29,7 +29,7 @@
 
 typedef struct {
     mp_obj_base_t base;
-    mp_obj_tuple_t *pins;
+    mcu_pin_obj_t *pin;
     bool value;
     bool all_same_value;
     bool edge;

ports/litex/common-hal/microcontroller/Processor.c

@@ -66,5 +66,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

ports/mimxrt10xx/common-hal/microcontroller/Processor.c

@@ -73,5 +73,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

ports/nrf/common-hal/microcontroller/Processor.c

@@ -123,5 +123,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

ports/stm/common-hal/microcontroller/Processor.c

@@ -143,5 +143,5 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 }
 
 mcu_reset_reason_t common_hal_mcu_processor_get_reset_reason(void) {
-    return RESET_REASON_POWER_ON;
+    return RESET_REASON_UNKNOWN;
 }

py/obj.h

@@ -640,6 +640,10 @@ extern const mp_obj_type_t mp_type_UnicodeError;
 extern const mp_obj_type_t mp_type_ValueError;
 extern const mp_obj_type_t mp_type_ViperTypeError;
 extern const mp_obj_type_t mp_type_ZeroDivisionError;
+#if CIRCUITPY_ALARM
+extern const mp_obj_type_t mp_type_DeepSleepRequest;
+#endif
+
 
 // Constant objects, globally accessible
 // The macros are for convenience only

py/objexcept.c

@@ -318,6 +318,9 @@ MP_DEFINE_EXCEPTION(Exception, BaseException)
 #if MICROPY_PY_BUILTINS_STR_UNICODE
     MP_DEFINE_EXCEPTION(UnicodeError, ValueError)
     //TODO: Implement more UnicodeError subclasses which take arguments
+#endif
+#if CIRCUITPY_ALARM
+    MP_DEFINE_EXCEPTION(DeepSleepRequest, BaseException)
 #endif
     MP_DEFINE_EXCEPTION(MpyError, ValueError)
   /*

py/reload.c

@@ -1,6 +1,22 @@
-//
-// Created by Roy Hooper on 2018-05-14.
-//
+ /*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 by Roy Hooper
+ * 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 "reload.h"
 #include "py/mpstate.h"

py/reload.h

@@ -1,6 +1,22 @@
-//
-// Created by Roy Hooper on 2018-05-14.
-//
+ /*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 by Roy Hooper
+ * 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 CIRCUITPYTHON_RELOAD_H
 #define CIRCUITPYTHON_RELOAD_H