Merge pull request #6907 from dhalbert/preserve-pins-on-deep-sleep

allow preserving pin state during deep sleep

Author: microdev1

locale/circuitpython.pot

@@ -66,13 +66,16 @@ msgid ""
 "%d address pins, %d rgb pins and %d tiles indicate a height of %d, not %d"
 msgstr ""
 
+#: ports/atmel-samd/common-hal/alarm/__init__.c
 #: ports/cxd56/common-hal/analogio/AnalogOut.c ports/cxd56/common-hal/rtc/RTC.c
 #: ports/espressif/common-hal/rtc/RTC.c
 #: ports/mimxrt10xx/common-hal/analogio/AnalogOut.c
-#: ports/mimxrt10xx/common-hal/rtc/RTC.c
+#: ports/mimxrt10xx/common-hal/rtc/RTC.c ports/nrf/common-hal/alarm/__init__.c
 #: ports/nrf/common-hal/analogio/AnalogOut.c ports/nrf/common-hal/rtc/RTC.c
+#: ports/raspberrypi/common-hal/alarm/__init__.c
 #: ports/raspberrypi/common-hal/analogio/AnalogOut.c
-#: ports/raspberrypi/common-hal/rtc/RTC.c ports/stm/common-hal/rtc/RTC.c
+#: ports/raspberrypi/common-hal/rtc/RTC.c ports/stm/common-hal/alarm/__init__.c
+#: ports/stm/common-hal/rtc/RTC.c
 msgid "%q"
 msgstr ""
 
@@ -902,13 +905,14 @@ msgstr ""
 
 #: ports/raspberrypi/bindings/rp2pio/StateMachine.c py/enum.c
 #: shared-bindings/_bleio/__init__.c shared-bindings/aesio/aes.c
-#: shared-bindings/busio/SPI.c shared-bindings/microcontroller/Pin.c
+#: shared-bindings/alarm/__init__.c shared-bindings/busio/SPI.c
+#: shared-bindings/microcontroller/Pin.c
 #: shared-bindings/neopixel_write/__init__.c
 msgid "Expected a %q"
 msgstr ""
 
 #: shared-bindings/alarm/__init__.c
-msgid "Expected an alarm"
+msgid "Expected an %q"
 msgstr ""
 
 #: ports/espressif/common-hal/_bleio/Adapter.c
@@ -3798,6 +3802,7 @@ msgstr ""
 #: ports/espressif/boards/adafruit_qtpy_esp32c3/mpconfigboard.h
 #: ports/espressif/boards/beetle-esp32-c3/mpconfigboard.h
 #: ports/espressif/boards/lolin_c3_mini/mpconfigboard.h
+#: ports/espressif/boards/microdev_micro_c3/mpconfigboard.h
 #: supervisor/shared/safe_mode.c
 msgid "pressing boot button at start up.\n"
 msgstr ""

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

@@ -142,7 +142,10 @@ mp_obj_t common_hal_alarm_light_sleep_until_alarms(size_t n_alarms, const mp_obj
     return wake_alarm;
 }
 
-void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms) {
+void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms, size_t n_dios, digitalio_digitalinout_obj_t **preserve_dios) {
+    if (n_dios > 0) {
+        mp_raise_NotImplementedError_varg(translate("%q"), MP_QSTR_preserve_dios);
+    }
     _setup_sleep_alarms(true, n_alarms, alarms);
 }
 

ports/espressif/boards/adafruit_feather_esp32_v2/board.c

@@ -31,17 +31,14 @@
 #include "components/hal/include/hal/gpio_hal.h"
 #include "common-hal/microcontroller/Pin.h"
 
-void board_init(void) {
-    reset_board();
-}
-
-void reset_board(void) {
-    // Turn on NeoPixel and I2C power by default.
-    gpio_set_direction(2, GPIO_MODE_DEF_OUTPUT);
-    gpio_set_level(2, true);
-}
-
 bool espressif_board_reset_pin_number(gpio_num_t pin_number) {
+    if (pin_number == 2) {
+        // Turn on NeoPixel and I2C power by default.
+        gpio_set_direction(pin_number, GPIO_MODE_DEF_OUTPUT);
+        gpio_set_level(pin_number, true);
+        return true;
+    }
+
     return false;
 }
 

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

@@ -31,15 +31,14 @@
 #include "common-hal/alarm/SleepMemory.h"
 #include "shared-bindings/alarm/SleepMemory.h"
 
-#include "esp_log.h"
 #include "esp_sleep.h"
 
 // Data storage for singleton instance of SleepMemory.
 // Might be RTC_SLOW_MEM or RTC_FAST_MEM, depending on setting of CONFIG_ESP32S2_RTCDATA_IN_FAST_MEM.
 static RTC_DATA_ATTR uint8_t _sleep_mem[SLEEP_MEMORY_LENGTH];
 
 void alarm_sleep_memory_reset(void) {
-    // ESP-IDF build system takes care of doing esp_sleep_pd_config() or the equivalentwith
+    // ESP-IDF build system takes care of doing esp_sleep_pd_config() or the equivalent with
     // the correct settings, depending on which RTC mem we are using.
     // https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-reference/system/sleep_modes.html#power-down-of-rtc-peripherals-and-memories
 }

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

@@ -39,12 +39,15 @@
 #include "shared-bindings/wifi/__init__.h"
 #include "shared-bindings/microcontroller/__init__.h"
 
+#include "common-hal/digitalio/DigitalInOut.h"
+
 #include "supervisor/port.h"
 #include "supervisor/shared/workflow.h"
 
 #include "esp_sleep.h"
 
 #include "soc/rtc_cntl_reg.h"
+#include "components/driver/include/driver/gpio.h"
 #include "components/driver/include/driver/uart.h"
 
 // Singleton instance of SleepMemory.
@@ -158,14 +161,21 @@ mp_obj_t common_hal_alarm_light_sleep_until_alarms(size_t n_alarms, const mp_obj
     return wake_alarm;
 }
 
-void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms) {
+void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms, size_t n_dios, digitalio_digitalinout_obj_t *preserve_dios[]) {
+    digitalio_digitalinout_preserve_for_deep_sleep(n_dios, preserve_dios);
     _setup_sleep_alarms(true, n_alarms, alarms);
 }
 
 void NORETURN common_hal_alarm_enter_deep_sleep(void) {
     alarm_pin_pinalarm_prepare_for_deep_sleep();
     alarm_touch_touchalarm_prepare_for_deep_sleep();
 
+    // We no longer need to remember the pin preservations, since any pin resets are all done.
+    clear_pin_preservations();
+
+    // Allow pin holds to work during deep sleep.
+    gpio_deep_sleep_hold_en();
+
     // The ESP-IDF caches the deep sleep settings and applies them before sleep.
     // We don't need to worry about resetting them in the interim.
     esp_deep_sleep_start();

ports/espressif/common-hal/digitalio/DigitalInOut.c

@@ -32,6 +32,20 @@
 
 #include "components/hal/include/hal/gpio_hal.h"
 
+STATIC bool _pin_is_input(uint8_t pin_number) {
+    const uint32_t iomux = READ_PERI_REG(GPIO_PIN_MUX_REG[pin_number]);
+    return (iomux & FUN_IE) != 0;
+}
+
+void digitalio_digitalinout_preserve_for_deep_sleep(size_t n_dios, digitalio_digitalinout_obj_t *preserve_dios[]) {
+    // Mark the pin states of the given DigitalInOuts for preservation during deep sleep
+    for (size_t i = 0; i < n_dios; i++) {
+        if (!common_hal_digitalio_digitalinout_deinited(preserve_dios[i])) {
+            preserve_pin_number(preserve_dios[i]->pin->number);
+        }
+    }
+}
+
 void common_hal_digitalio_digitalinout_never_reset(
     digitalio_digitalinout_obj_t *self) {
     never_reset_pin_number(self->pin->number);
@@ -83,8 +97,7 @@ digitalinout_result_t common_hal_digitalio_digitalinout_switch_to_output(
 
 digitalio_direction_t common_hal_digitalio_digitalinout_get_direction(
     digitalio_digitalinout_obj_t *self) {
-    uint32_t iomux = READ_PERI_REG(GPIO_PIN_MUX_REG[self->pin->number]);
-    if ((iomux & FUN_IE) != 0) {
+    if (_pin_is_input(self->pin->number)) {
         return DIRECTION_INPUT;
     }
     return DIRECTION_OUTPUT;

ports/espressif/common-hal/digitalio/DigitalInOut.h

@@ -36,4 +36,6 @@ typedef struct {
     bool output_value;
 } digitalio_digitalinout_obj_t;
 
+extern void digitalio_digitalinout_preserve_for_deep_sleep(size_t n_dios, digitalio_digitalinout_obj_t *preserve_dios[]);
+
 #endif // MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_DIGITALIO_DIGITALINOUT_H

ports/espressif/common-hal/esp32_camera/Camera.c

@@ -191,8 +191,6 @@ framesize_t common_hal_esp32_camera_camera_get_frame_size(esp32_camera_camera_ob
     return self->camera_config.frame_size;
 }
 
-#include "esp_log.h"
-
 void common_hal_esp32_camera_camera_reconfigure(esp32_camera_camera_obj_t *self, framesize_t frame_size, pixformat_t pixel_format, camera_grab_mode_t grab_mode, mp_int_t framebuffer_count) {
     sensor_t *sensor = esp_camera_sensor_get();
     camera_sensor_info_t *sensor_info = esp_camera_sensor_get_info(&sensor->id);

ports/espressif/common-hal/microcontroller/Pin.c

@@ -33,14 +33,13 @@
 #include "components/driver/include/driver/gpio.h"
 #include "components/hal/include/hal/gpio_hal.h"
 
-STATIC uint64_t never_reset_pins;
-STATIC uint64_t in_use;
+STATIC uint64_t _never_reset_pin_mask;
+STATIC uint64_t _preserved_pin_mask;
+STATIC uint64_t _in_use_pin_mask;
 
-// 64-bit pin mask for a single bit
-#define PIN_BIT(pin_number) (((uint64_t)1) << pin_number)
-
-// Bit mask of all pins that should never ever be reset.
+// Bit mask of all pins that should never EVER be reset.
 // Typically these are SPI flash and PSRAM control pins, and communication pins.
+// "Reset forbidden" is stronger than "never reset" below, which may only be temporary.
 static const uint64_t pin_mask_reset_forbidden =
     #if defined(CONFIG_IDF_TARGET_ESP32)
     // Never ever reset serial pins for bootloader and possibly USB-serial converter.
@@ -105,7 +104,7 @@ void never_reset_pin_number(gpio_num_t pin_number) {
     if (pin_number == NO_PIN || pin_number == (uint8_t)NO_PIN) {
         return;
     }
-    never_reset_pins |= PIN_BIT(pin_number);
+    _never_reset_pin_mask |= PIN_BIT(pin_number);
 }
 
 void common_hal_never_reset_pin(const mcu_pin_obj_t *pin) {
@@ -119,12 +118,29 @@ MP_WEAK bool espressif_board_reset_pin_number(gpio_num_t pin_number) {
     return false;
 }
 
+STATIC bool _reset_forbidden(gpio_num_t pin_number) {
+    return pin_mask_reset_forbidden & PIN_BIT(pin_number);
+}
+
+STATIC bool _never_reset(gpio_num_t pin_number) {
+    return _never_reset_pin_mask & PIN_BIT(pin_number);
+}
+
+STATIC bool _preserved_pin(gpio_num_t pin_number) {
+    return _preserved_pin_mask & PIN_BIT(pin_number);
+}
+
 STATIC void _reset_pin(gpio_num_t pin_number) {
     // Never ever reset pins used for flash, RAM, and basic communication.
-    if (pin_mask_reset_forbidden & PIN_BIT(pin_number)) {
+    if (_reset_forbidden(pin_number)) {
         return;
     }
 
+    // Disable any existing hold on this pin,
+    if (GPIO_IS_VALID_OUTPUT_GPIO(pin_number)) {
+        gpio_hold_dis(pin_number);
+    }
+
     // Give the board a chance to reset the pin in a particular way.
     if (espressif_board_reset_pin_number(pin_number)) {
         return;
@@ -152,15 +168,27 @@ STATIC void _reset_pin(gpio_num_t pin_number) {
     }
 }
 
+void preserve_pin_number(gpio_num_t pin_number) {
+    if (GPIO_IS_VALID_OUTPUT_GPIO(pin_number)) {
+        gpio_hold_en(pin_number);
+        _preserved_pin_mask |= PIN_BIT(pin_number);
+    }
+}
+
+void clear_pin_preservations(void) {
+    _preserved_pin_mask = 0;
+}
+
+
 // Mark pin as free and return it to a quiescent state.
 void reset_pin_number(gpio_num_t pin_number) {
     // Some CircuitPython APIs deal in uint8_t pin numbers, but NO_PIN is -1.
     // Also allow pin 255 to be treated as NO_PIN to avoid crashes
     if (pin_number == NO_PIN || pin_number == (uint8_t)NO_PIN) {
         return;
     }
-    never_reset_pins &= ~PIN_BIT(pin_number);
-    in_use &= ~PIN_BIT(pin_number);
+    _never_reset_pin_mask &= ~PIN_BIT(pin_number);
+    _in_use_pin_mask &= ~PIN_BIT(pin_number);
 
     _reset_pin(pin_number);
 }
@@ -177,15 +205,20 @@ void common_hal_reset_pin(const mcu_pin_obj_t *pin) {
 }
 
 void reset_all_pins(void) {
+    // Undo deep sleep holds in case we woke up from deep sleep.
+    // We still need to unhold individual pins, which is done by _reset_pin.
+    gpio_deep_sleep_hold_dis();
+
     for (uint8_t i = 0; i < GPIO_PIN_COUNT; i++) {
         uint32_t iomux_address = GPIO_PIN_MUX_REG[i];
         if (iomux_address == 0 ||
-            (never_reset_pins & PIN_BIT(i))) {
+            _never_reset(i) ||
+            _preserved_pin(i)) {
             continue;
         }
         _reset_pin(i);
     }
-    in_use = never_reset_pins;
+    _in_use_pin_mask = _never_reset_pin_mask;
 }
 
 void claim_pin_number(gpio_num_t pin_number) {
@@ -194,7 +227,7 @@ void claim_pin_number(gpio_num_t pin_number) {
     if (pin_number == NO_PIN || pin_number == (uint8_t)NO_PIN) {
         return;
     }
-    in_use |= PIN_BIT(pin_number);
+    _in_use_pin_mask |= PIN_BIT(pin_number);
 }
 
 void claim_pin(const mcu_pin_obj_t *pin) {
@@ -206,7 +239,7 @@ void common_hal_mcu_pin_claim(const mcu_pin_obj_t *pin) {
 }
 
 bool pin_number_is_free(gpio_num_t pin_number) {
-    return !(in_use & PIN_BIT(pin_number));
+    return !(_in_use_pin_mask & PIN_BIT(pin_number));
 }
 
 bool common_hal_mcu_pin_is_free(const mcu_pin_obj_t *pin) {

ports/espressif/common-hal/microcontroller/Pin.h

@@ -31,21 +31,28 @@
 
 #include "peripherals/pins.h"
 
-void reset_all_pins(void);
+// 64-bit pin mask for a single bit
+#define PIN_BIT(pin_number) (((uint64_t)1) << pin_number)
+
+extern void common_hal_reset_pin(const mcu_pin_obj_t *pin);
+extern void common_hal_never_reset_pin(const mcu_pin_obj_t *pin);
+
+extern void reset_all_pins(void);
 // reset_pin_number takes the pin number instead of the pointer so that objects don't
 // need to store a full pointer.
-void reset_pin_number(gpio_num_t pin_number);
-void common_hal_reset_pin(const mcu_pin_obj_t *pin);
-void common_hal_never_reset_pin(const mcu_pin_obj_t *pin);
-void claim_pin(const mcu_pin_obj_t *pin);
-void claim_pin_number(gpio_num_t pin_number);
-bool pin_number_is_free(gpio_num_t pin_number);
-void never_reset_pin_number(gpio_num_t pin_number);
+extern void reset_pin_number(gpio_num_t pin_number);
+extern void claim_pin(const mcu_pin_obj_t *pin);
+extern void claim_pin_number(gpio_num_t pin_number);
+extern bool pin_number_is_free(gpio_num_t pin_number);
+extern void never_reset_pin_number(gpio_num_t pin_number);
+
+extern void preserve_pin_number(gpio_num_t pin_number);
+extern void clear_pin_preservations(void);
 
 // Allow the board to reset a pin in a board-specific way. This can be used
 // for LEDs or enable pins to put them in a state beside the default pull-up.
 // Return true to indicate that the pin was reset. Returning false will lead to
 // the port-default reset behavior.
-bool espressif_board_reset_pin_number(gpio_num_t pin_number);
+extern bool espressif_board_reset_pin_number(gpio_num_t pin_number);
 
 #endif // MICROPY_INCLUDED_ESPRESSIF_COMMON_HAL_MICROCONTROLLER_PIN_H