WIP: redo API; not compiled yet

adafruit · jepler · Dec 3, 2020 · Oct 25, 2020 · Oct 25, 2020 · Oct 26, 2020
commit 682054a2169c108ad69e84acdb53fdd26405077e
diff --git a/locale/circuitpython.pot b/locale/circuitpython.pot
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-11-04 21:18+0530\n"
+"POT-Creation-Date: 2020-11-19 00:22-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -303,7 +303,8 @@ msgstr ""
 msgid "All I2C peripherals are in use"
 msgstr ""
 
-#: ports/esp32s2/peripherals/pcnt_handler.c
+#: ports/esp32s2/common-hal/countio/Counter.c
+#: ports/esp32s2/common-hal/rotaryio/IncrementalEncoder.c
 msgid "All PCNT units in use"
 msgstr ""
 
@@ -3221,6 +3222,7 @@ msgstr ""
 msgid "pow() with 3 arguments requires integers"
 msgstr ""
 
+#: ports/esp32s2/boards/adafruit_magtag_2.9_grayscale/mpconfigboard.h
 #: ports/esp32s2/boards/adafruit_metro_esp32s2/mpconfigboard.h
 #: ports/esp32s2/boards/electroniccats_bastwifi/mpconfigboard.h
 #: ports/esp32s2/boards/espressif_kaluga_1/mpconfigboard.h
@@ -3328,7 +3330,7 @@ msgstr ""
 msgid "size is defined for ndarrays only"
 msgstr ""
 
-#: shared-bindings/alarm_time/__init__.c shared-bindings/time/__init__.c
+#: shared-bindings/time/__init__.c
 msgid "sleep length must be non-negative"
 msgstr ""
 

diff --git a/ports/esp32s2/mpconfigport.mk b/ports/esp32s2/mpconfigport.mk
@@ -15,9 +15,6 @@ 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

diff --git a/py/circuitpy_defns.mk b/py/circuitpy_defns.mk
@@ -102,15 +102,6 @@ endif
 ifeq ($(CIRCUITPY_ALARM),1)
 SRC_PATTERNS += alarm/%
 endif
-ifeq ($(CIRCUITPY_ALARM_IO),1)
-SRC_PATTERNS += alarm_io/%
-endif
-ifeq ($(CIRCUITPY_ALARM_TIME),1)
-SRC_PATTERNS += alarm_time/%
-endif
-ifeq ($(CIRCUITPY_ALARM_TOUCH),1)
-SRC_PATTERNS += alarm_touch/%
-endif
 ifeq ($(CIRCUITPY_ANALOGIO),1)
 SRC_PATTERNS += analogio/%
 endif
@@ -247,9 +238,6 @@ endif
 ifeq ($(CIRCUITPY_SHARPDISPLAY),1)
 SRC_PATTERNS += sharpdisplay/%
 endif
-ifeq ($(CIRCUITPY_SLEEP),1)
-SRC_PATTERNS += sleep/%
-endif
 ifeq ($(CIRCUITPY_SOCKETPOOL),1)
 SRC_PATTERNS += socketpool/%
 endif
@@ -314,9 +302,9 @@ SRC_COMMON_HAL_ALL = \
 	_pew/PewPew.c \
 	_pew/__init__.c \
 	alarm/__init__.c \
-	alarm_io/__init__.c \
-	alarm_time/__init__.c \
-	alarm_touch/__init__.c \
+	alarm/pin/__init__.c \
+	alarm/time/__init__.c \
+	alarm/touch/__init__.c \
 	analogio/AnalogIn.c \
 	analogio/AnalogOut.c \
 	analogio/__init__.c \
@@ -372,8 +360,8 @@ SRC_COMMON_HAL_ALL = \
 	rtc/__init__.c \
 	sdioio/SDCard.c \
 	sdioio/__init__.c \
-	sleep/__init__.c \
-	sleep/ResetReason.c \
+	sleepio/__init__.c \
+	sleepio/ResetReason.c \
 	socketpool/__init__.c \
 	socketpool/SocketPool.c \
 	socketpool/Socket.c \

diff --git a/py/circuitpy_mpconfig.h b/py/circuitpy_mpconfig.h
@@ -250,27 +250,6 @@ extern const struct _mp_obj_module_t alarm_module;
 #define ALARM_MODULE
 #endif
 
-#if CIRCUITPY_ALARM_IO
-extern const struct _mp_obj_module_t alarm_io_module;
-#define ALARM_IO_MODULE        { MP_OBJ_NEW_QSTR(MP_QSTR_alarm_io), (mp_obj_t)&alarm_io_module },
-#else
-#define ALARM_IO_MODULE
-#endif
-
-#if CIRCUITPY_ALARM_TIME
-extern const struct _mp_obj_module_t alarm_time_module;
-#define ALARM_TIME_MODULE      { MP_OBJ_NEW_QSTR(MP_QSTR_alarm_time), (mp_obj_t)&alarm_time_module },
-#else
-#define ALARM_TIME_MODULE
-#endif
-
-#if CIRCUITPY_ALARM_TOUCH
-extern const struct _mp_obj_module_t alarm_touch_module;
-#define ALARM_TOUCH_MODULE      { MP_OBJ_NEW_QSTR(MP_QSTR_alarm_touch), (mp_obj_t)&alarm_touch_module },
-#else
-#define ALARM_TOUCH_MODULE
-#endif
-
 #if CIRCUITPY_ANALOGIO
 #define ANALOGIO_MODULE        { MP_OBJ_NEW_QSTR(MP_QSTR_analogio), (mp_obj_t)&analogio_module },
 extern const struct _mp_obj_module_t analogio_module;
@@ -642,13 +621,6 @@ extern const struct _mp_obj_module_t sharpdisplay_module;
 #define SHARPDISPLAY_MODULE
 #endif
 
-#if CIRCUITPY_SLEEP
-extern const struct _mp_obj_module_t sleep_module;
-#define SLEEP_MODULE        { MP_OBJ_NEW_QSTR(MP_QSTR_sleep),(mp_obj_t)&sleep_module },
-#else
-#define SLEEP_MODULE
-#endif
-
 #if CIRCUITPY_SOCKETPOOL
 extern const struct _mp_obj_module_t socketpool_module;
 #define SOCKETPOOL_MODULE           { MP_OBJ_NEW_QSTR(MP_QSTR_socketpool), (mp_obj_t)&socketpool_module },
@@ -807,9 +779,6 @@ extern const struct _mp_obj_module_t wifi_module;
 #define MICROPY_PORT_BUILTIN_MODULES_STRONG_LINKS \
     AESIO_MODULE \
     ALARM_MODULE \
-    ALARM_IO_MODULE \
-    ALARM_TIME_MODULE \
-    ALARM_TOUCH_MODULE \
     ANALOGIO_MODULE \
     AUDIOBUSIO_MODULE \
     AUDIOCORE_MODULE \
@@ -862,7 +831,6 @@ extern const struct _mp_obj_module_t wifi_module;
     SDCARDIO_MODULE \
     SDIOIO_MODULE \
     SHARPDISPLAY_MODULE \
-    SLEEP_MODULE \
     SOCKETPOOL_MODULE \
     SSL_MODULE \
     STAGE_MODULE \

diff --git a/py/circuitpy_mpconfig.mk b/py/circuitpy_mpconfig.mk
@@ -39,18 +39,15 @@ CFLAGS += -DMICROPY_PY_ASYNC_AWAIT=$(MICROPY_PY_ASYNC_AWAIT)
 CIRCUITPY_AESIO ?= 0
 CFLAGS += -DCIRCUITPY_AESIO=$(CIRCUITPY_AESIO)
 
+# TODO: CIRCUITPY_ALARM will gradually be added to
+# as many ports as possible
+# so make this 1 or CIRCUITPY_FULL_BUILD eventually
+CIRCUITPY_SLEEPIO ?= 0
+CFLAGS += -DCIRCUITPY_SLEEPIO=$(CIRCUITPY_SLEEPIO)
+
 CIRCUITPY_ALARM ?= 0
 CFLAGS += -DCIRCUITPY_ALARM=$(CIRCUITPY_ALARM)
 
-CIRCUITPY_ALARM_IO ?= 0
-CFLAGS += -DCIRCUITPY_ALARM_IO=$(CIRCUITPY_ALARM_IO)
-
-CIRCUITPY_ALARM_TIME ?= 0
-CFLAGS += -DCIRCUITPY_ALARM_TIME=$(CIRCUITPY_ALARM_TIME)
-
-CIRCUITPY_ALARM_TOUCH ?= 0
-CFLAGS += -DCIRCUITPY_ALARM_TOUCH=$(CIRCUITPY_ALARM_TOUCH)
-
 CIRCUITPY_ANALOGIO ?= 1
 CFLAGS += -DCIRCUITPY_ANALOGIO=$(CIRCUITPY_ANALOGIO)
 
@@ -221,11 +218,6 @@ CFLAGS += -DCIRCUITPY_SDIOIO=$(CIRCUITPY_SDIOIO)
 CIRCUITPY_SHARPDISPLAY ?= $(CIRCUITPY_FRAMEBUFFERIO)
 CFLAGS += -DCIRCUITPY_SHARPDISPLAY=$(CIRCUITPY_SHARPDISPLAY)
 
-# TODO: CIRCUITPY_SLEEP will gradually be added to all ports
-# even if it doesn't actually sleep, so make this 1 eventually.
-CIRCUITPY_SLEEP ?= 0
-CFLAGS += -DCIRCUITPY_SLEEP=$(CIRCUITPY_SLEEP)
-
 CIRCUITPY_SOCKETPOOL ?= $(CIRCUITPY_WIFI)
 CFLAGS += -DCIRCUITPY_SOCKETPOOL=$(CIRCUITPY_SOCKETPOOL)
 

diff --git a/shared-bindings/sleep/ResetReason.c → shared-bindings/alarm/ResetReason.c b/shared-bindings/sleep/ResetReason.c → shared-bindings/alarm/ResetReason.c
@@ -26,12 +26,12 @@
 
 #include "py/enum.h"
 
-#include "shared-bindings/sleep/ResetReason.h"
+#include "shared-bindings/alarm/ResetReason.h"
 
-MAKE_ENUM_VALUE(sleep_reset_reason_type, reset_reason, POWER_VALID, RESET_REASON_POWER_VALID);
-MAKE_ENUM_VALUE(sleep_reset_reason_type, reset_reason, SOFTWARE, RESET_REASON_SOFTWARE);
-MAKE_ENUM_VALUE(sleep_reset_reason_type, reset_reason, DEEP_SLEEP_ALARM, RESET_REASON_DEEP_SLEEP_ALARM);
-MAKE_ENUM_VALUE(sleep_reset_reason_type, reset_reason, EXTERNAL, RESET_REASON_EXTERNAL);
+MAKE_ENUM_VALUE(alarm_reset_reason_type, reset_reason, POWER_VALID, RESET_REASON_POWER_VALID);
+MAKE_ENUM_VALUE(alarm_reset_reason_type, reset_reason, SOFTWARE, RESET_REASON_SOFTWARE);
+MAKE_ENUM_VALUE(alarm_reset_reason_type, reset_reason, DEEP_SLEEP_ALARM, RESET_REASON_DEEP_SLEEP_ALARM);
+MAKE_ENUM_VALUE(alarm_reset_reason_type, reset_reason, EXTERNAL, RESET_REASON_EXTERNAL);
 
 //| class ResetReason:
 //|     """The reason the chip was last reset"""
@@ -48,14 +48,14 @@ MAKE_ENUM_VALUE(sleep_reset_reason_type, reset_reason, EXTERNAL, RESET_REASON_EX
 //|     EXTERNAL: object
 //|     """The chip was reset by an external input such as a button."""
 //|
-MAKE_ENUM_MAP(sleep_reset_reason) {
+MAKE_ENUM_MAP(alarm_reset_reason) {
     MAKE_ENUM_MAP_ENTRY(reset_reason, POWER_VALID),
     MAKE_ENUM_MAP_ENTRY(reset_reason, SOFTWARE),
     MAKE_ENUM_MAP_ENTRY(reset_reason, DEEP_SLEEP_ALARM),
     MAKE_ENUM_MAP_ENTRY(reset_reason, EXTERNAL),
 };
-STATIC MP_DEFINE_CONST_DICT(sleep_reset_reason_locals_dict, sleep_reset_reason_locals_table);
+STATIC MP_DEFINE_CONST_DICT(alarm_reset_reason_locals_dict, alarm_reset_reason_locals_table);
 
-MAKE_PRINTER(sleep, sleep_reset_reason);
+MAKE_PRINTER(alarm, alarm_reset_reason);
 
-MAKE_ENUM_TYPE(sleep, ResetReason, sleep_reset_reason);
+MAKE_ENUM_TYPE(alarm, ResetReason, alarm_reset_reason);
diff --git a/shared-bindings/sleep/ResetReason.h → shared-bindings/alarm/ResetReason.h b/shared-bindings/sleep/ResetReason.h → shared-bindings/alarm/ResetReason.h
@@ -24,13 +24,16 @@
  * THE SOFTWARE.
  */
 
-#pragma once
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_ALARM__RESET_REASON__H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_ALARM__RESET_REASON__H
 
 typedef enum {
     RESET_REASON_POWER_APPLIED,
     RESET_REASON_SOFTWARE,
     RESET_REASON_DEEP_SLEEP_ALARM,
     RESET_REASON_BUTTON,
-} sleep_reset_reason_t;
+} alarm_reset_reason_t;
 
-extern const mp_obj_type_t sleep_reset_reason_type;
+extern const mp_obj_type_t alarm_reset_reason_type;
+
+#endif // MICROPY_INCLUDED_SHARED_BINDINGS_ALARM__RESET_REASON__H
diff --git a/shared-bindings/alarm/__init__.c b/shared-bindings/alarm/__init__.c
@@ -0,0 +1,130 @@
+//| """Power-saving light and deep sleep. Alarms can be set to wake up from sleep.
+//|
+//| The `alarm` module provides sleep related functionality. There are two supported levels of
+//| sleep, light and deep.
+//|
+//| Light sleep leaves the CPU and RAM powered so that CircuitPython can resume where it left off
+//| after being woken up. CircuitPython automatically goes into a light sleep when `time.sleep()` is
+//| called. To light sleep until a non-time alarm use `alarm.sleep_until_alarm()`. Any active
+//| peripherals, such as I2C, are left on.
+//|
+//| Deep sleep shuts down power to nearly all of the chip including the CPU and RAM. This can save
+//| a more significant amount of power, but CircuitPython must start ``code.py`` from the beginning when woken
+//| up. CircuitPython will enter deep sleep automatically when the current program exits without error
+//| or calls `sys.exit(0)`.
+//| If an error causes CircuitPython to exit, error LED error flashes will be done periodically.
+//| An error includes an uncaught exception, or sys.exit called with a non-zero argumetn.
+//| To set alarms for deep sleep use `alarm.reload_on_alarm()` they will apply to next deep sleep only."""
+//|
+
+//| wake_alarm: Alarm
+//| """The most recent alarm to wake us up from a sleep (light or deep.)"""
+//|
+
+//| reset_reason: ResetReason
+//| """The reason the chip started up from reset state. This can may be power up or due to an alarm."""
+//|
+
+//| def sleep(alarm: Alarm, ...) -> Alarm:
+//|     """Performs a light sleep until woken by one of the alarms. The alarm that triggers the wake
+//|        is returned, and is also available as `alarm.wake_alarm`
+//|     ...
+//|
+
+#include "py/obj.h"
+#include "py/runtime.h"
+
+#include "shared-bindings/alarm/pin/__init__.h"
+#include "shared-bindings/alarm/time/__init__.h"
+
+STATIC mp_obj_t alarm_sleep_until_alarm(size_t n_args, const mp_obj_t *args) {
+    // TODO
+}
+MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(alarm_sleep_until_alarm_obj, 1, MP_OBJ_FUN_ARGS_MAX, alarm_sleep_until_alarm);
+
+//| def restart_on_alarm(alarm: Alarm, ...) -> None:
+//|     """Set one or more alarms to wake up from a deep sleep.
+//|     When awakened, ``code.py`` will restart from the beginning.
+//|     The last alarm to wake us up is available as `wake_alarm`.
+//|     """
+//|     ...
+//|
+STATIC mp_obj_t alarm_restart_on_alarm(size_t n_args, const mp_obj_t *args) {
+    // TODO
+}
+MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(alarm_restart_on_alarm_obj, 1, MP_OBJ_FUN_ARGS_MAX, alarm_restart_on_alarm);
+
+//| """The `alarm.pin` module contains alarm attributes and classes related to pins
+//| """
+//|
+mp_map_elem_t alarm_pin_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_pin) },
+
+    { MP_ROM_QSTR(MP_QSTR_PinAlarm), MP_ROM_PTR(&alarm_pin_pin_alarm_type) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(alarm_pin_globals, alarm_pin_globals_table);
+
+const mp_obj_module_t alarm_pin_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t*)&alarm_pinn_globals,
+};
+
+//| """The `alarm.time` module contains alarm attributes and classes related to time-keeping.
+//| """
+//|
+mp_map_elem_t alarm_time_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_time) },
+
+    { MP_ROM_QSTR(MP_QSTR_DurationAlarm), MP_ROM_PTR(&alarm_time_duration_alarm_type) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(alarm_time_globals, alarm_time_globals_table);
+
+const mp_obj_module_t alarm_time_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t*)&alarm_time_globals,
+};
+
+mp_map_elem_t alarm_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_alarm) },
+
+    // wake_alarm and reset_reason are mutable attributes.
+    { MP_ROM_QSTR(MP_QSTR_wake_alarm), mp_const_none },
+    { MP_ROM_QSTR(MP_QSTR_reset_reason), mp_const_none },
+
+    { MP_ROM_QSTR(MP_QSTR_sleep_until_alarm), MP_ROM_PTR(&alarm_sleep_until_alarm_obj) },
+    { MP_ROM_QSTR(MP_QSTR_restart_on_alarm), MP_ROM_PTR(&alarm_restart_on_alarm_obj) },
+
+    { MP_ROM_QSTR(MP_QSTR_pin), MP_ROM_PTR(&alarm_pin_module) },
+    { MP_ROM_QSTR(MP_QSTR_time), MP_ROM_PTR(&alarm_time_module) }
+
+};
+STATIC MP_DEFINE_MUTABLE_DICT(alarm_module_globals, alarm_module_globals_table);
+
+// These are called from common_hal code to set the current wake alarm.
+void common_hal_alarm_set_wake_alarm(mp_obj_t alarm) {
+    // Equivalent of:
+    // alarm.wake_alarm = alarm
+    mp_map_elem_t *elem =
+        mp_map_lookup(&alarm_module_globals_table, MP_ROM_QSTR(MP_QSTR_wake_alarm), MP_MAP_LOOKUP);
+    if (elem) {
+        elem->value = alarm;
+    }
+}
+
+// These are called from common hal code to set the current wake alarm.
+void common_hal_alarm_set_reset_reason(mp_obj_t reset_reason) {
+    // Equivalent of:
+    // alarm.reset_reason = reset_reason
+    mp_map_elem_t *elem =
+        mp_map_lookup(&alarm_module_globals_table, MP_ROM_QSTR(MP_QSTR_reset_reason), MP_MAP_LOOKUP);
+    if (elem) {
+        elem->value = reset_reason;
+    }
+}
+
+const mp_obj_module_t alarm_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t*)&alarm_module_globals,
+};