ports/zephyr: Add machine lightsleep.

Signed-off-by: Patrick Joy <[email protected]>

Author: ThinkTransit

docs/zephyr/quickref.rst

@@ -104,6 +104,21 @@ Hardware SPI is accessed via the :ref:`machine.SPI <machine.SPI>` class::
     spi.write_readinto(b'abcd', buf)    # write to MOSI and read from MISO into the buffer
     spi.write_readinto(buf, buf)        # write buf to MOSI and read back into the buf
 
+Light-sleep mode
+----------------
+
+The following code can be used to sleep, reducing power consumption::
+
+    import machine
+
+    # put the device to sleep for 10 seconds
+    machine.lightsleep(10000)
+
+Notes:
+
+* Calling ``lightsleep()`` suspends the micropython thread, allowing Zephyr power management to reduce power consumption.
+
+
 Disk Access
 -----------
 

ports/zephyr/boards/beagleconnect_freedom.conf

@@ -5,3 +5,7 @@ CONFIG_SPI=y
 # Flash drivers
 CONFIG_FLASH=y
 CONFIG_FLASH_MAP=y
+
+# Disable PM
+CONFIG_PM=n
+CONFIG_PM_DEVICE=n

ports/zephyr/modmachine.c

@@ -31,6 +31,8 @@
 
 #include <stdio.h>
 #include <zephyr/sys/reboot.h>
+#include <zephyr/pm/pm.h>
+#include <zephyr/pm/device.h>
 
 #include "modmachine.h"
 
@@ -61,3 +63,40 @@ MP_DEFINE_CONST_FUN_OBJ_0(machine_reset_cause_obj, machine_reset_cause);
 static void mp_machine_idle(void) {
     k_yield();
 }
+
+#ifdef CONFIG_PM_DEVICE
+static void mp_machine_lightsleep(size_t n_args, const mp_obj_t *args) {
+    // Check if no argument is provided
+    if (n_args == 0) {
+        mp_raise_ValueError(MP_ERROR_TEXT("value must be provided"));
+    }
+    mp_int_t milliseconds = mp_obj_get_int(args[0]);
+    // Get the UART device
+    const struct device *uart0 = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
+    // Set UART device to low power state
+    pm_device_action_run(uart0, PM_DEVICE_ACTION_SUSPEND);
+    k_sleep(K_MSEC(milliseconds));
+    // Set UART device back to active state
+    pm_device_action_run(uart0, PM_DEVICE_ACTION_RESUME);
+}
+#else
+static void mp_machine_lightsleep(size_t n_args, const mp_obj_t *args) {
+    mp_raise_ValueError(MP_ERROR_TEXT("not implemented"));
+}
+#endif
+
+static void mp_machine_deepsleep(size_t n_args, const mp_obj_t *args) {
+    mp_raise_ValueError(MP_ERROR_TEXT("not implemented"));
+}
+
+static mp_obj_t mp_machine_get_freq(void) {
+    mp_raise_ValueError(MP_ERROR_TEXT("not implemented"));
+}
+
+static void mp_machine_set_freq(size_t n_args, const mp_obj_t *args) {
+    mp_raise_ValueError(MP_ERROR_TEXT("not implemented"));
+}
+
+static mp_obj_t mp_machine_unique_id(void) {
+    mp_raise_ValueError(MP_ERROR_TEXT("not implemented"));
+}

ports/zephyr/mpconfigport.h

@@ -61,6 +61,7 @@
 #define MICROPY_PY_MICROPYTHON_MEM_INFO (1)
 #define MICROPY_PY_MACHINE          (1)
 #define MICROPY_PY_MACHINE_INCLUDEFILE "ports/zephyr/modmachine.c"
+#define MICROPY_PY_MACHINE_BARE_METAL_FUNCS (1)
 #define MICROPY_PY_MACHINE_I2C      (1)
 #define MICROPY_PY_MACHINE_SPI      (1)
 #define MICROPY_PY_MACHINE_SPI_MSB (SPI_TRANSFER_MSB)

ports/zephyr/prj.conf

@@ -16,6 +16,8 @@ CONFIG_FPU=y
 CONFIG_MAIN_STACK_SIZE=4736
 CONFIG_POLL=y
 
+CONFIG_PM=y
+CONFIG_PM_DEVICE=y
 CONFIG_DEVICE_DT_METADATA=y
 
 # Enable sensor subsystem (doesn't add code if not used).