ghubcoder · flashbtw · Oct 25, 2021 · Oct 29, 2021 · Nov 6, 2021 · Nov 6, 2021
diff --git a/.gitmodules b/.gitmodules
@@ -41,3 +41,6 @@
 [submodule "lib/pico-sdk"]
 	path = lib/pico-sdk
 	url = https://github.com/raspberrypi/pico-sdk.git
+[submodule "lib/pico-extras"]
+	path = lib/pico-extras
+	url = https://github.com/raspberrypi/pico-extras.git
diff --git a/README.md b/README.md
@@ -1,4 +1,40 @@
-[![CI badge](https://github.com/micropython/micropython/workflows/unix%20port/badge.svg)](https://github.com/micropython/micropython/actions?query=branch%3Amaster+event%3Apush) [![codecov](https://codecov.io/gh/micropython/micropython/branch/master/graph/badge.svg?token=I92PfD05sD)](https://codecov.io/gh/micropython/micropython)
+This is a fork of the MicroPython project to allow deep sleeping and waking
+from the internal real time clock of the Raspberry Pico.
+
+This can be built with the following commands:
+
+```bash
+git clone https://github.com/ghubcoder/micropython-pico-deepsleep.git
+cd micropython-pico-deepsleep/
+make -C mpy-cross/
+git submodule update --init -- lib/pico-sdk
+git submodule update --init -- lib/pico-extras
+git submodule update --init -- lib/tinyusb
+cd ports/rp2sleep
+make -j4
+```
+
+This will create a `firmware.uf2` file which can then be loaded onto your
+Pico in the usual way using the BOOTSEL button.
+
+A precompiled binary can be found [here](https://github.com/ghubcoder/micropython-pico-deepsleep/releases/tag/v1.0-pico-deepsleep).
+
+Example usage:
+
+```python
+import picosleep
+import time
+
+# Make sure this is present, otherwise the pico won't have control over devices such as GPIO Pins.
+time.sleep(1)
+
+picosleep.seconds(60)
+```
+
+Please see [this](https://ghubcoder.github.io/posts/deep-sleeping-the-pico-micropython/)
+post for more information.
+
+Original readme follows:
 
 The MicroPython project
 =======================

diff --git a/lib/pico-extras b/lib/pico-extras
diff --git a/ports/rp2sleep/CMakeLists.txt b/ports/rp2sleep/CMakeLists.txt
@@ -0,0 +1,291 @@
+cmake_minimum_required(VERSION 3.12)
+
+# Set build type to reduce firmware size
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE MinSizeRel)
+endif()
+
+# Set main target and component locations
+set(MICROPY_TARGET firmware)
+get_filename_component(MICROPY_DIR "../.." ABSOLUTE)
+if (PICO_SDK_PATH_OVERRIDE)
+    set(PICO_SDK_PATH ${PICO_SDK_PATH_OVERRIDE})
+else()
+    set(PICO_SDK_PATH ../../lib/pico-sdk)
+endif()
+
+if (PICO_EXTRAS_PATH_OVERRIDE)
+    set(PICO_EXTRAS_PATH ${PICO_EXTRAS_PATH_OVERRIDE})
+else()
+    set(PICO_EXTRAS_PATH ../../lib/pico-extras)
+endif()
+
+# Use the local tinyusb instead of the one in pico-sdk
+set(PICO_TINYUSB_PATH ${MICROPY_DIR}/lib/tinyusb)
+
+# Set the location of this port's directory.
+set(MICROPY_PORT_DIR ${CMAKE_SOURCE_DIR})
+
+# Set the board if it's not already set.
+if(NOT MICROPY_BOARD)
+    set(MICROPY_BOARD PICO)
+endif()
+
+# Set the PICO_BOARD if it's not already set.
+if(NOT PICO_BOARD)
+    string(TOLOWER ${MICROPY_BOARD} PICO_BOARD)
+endif()
+
+# Set the board directory and check that it exists.
+if(NOT MICROPY_BOARD_DIR)
+    set(MICROPY_BOARD_DIR ${MICROPY_PORT_DIR}/boards/${MICROPY_BOARD})
+endif()
+if(NOT EXISTS ${MICROPY_BOARD_DIR}/mpconfigboard.cmake)
+    message(FATAL_ERROR "Invalid MICROPY_BOARD specified: ${MICROPY_BOARD}")
+endif()
+
+# Include board config
+include(${MICROPY_BOARD_DIR}/mpconfigboard.cmake) 
+
+# Include component cmake fragments
+include(${MICROPY_DIR}/py/py.cmake)
+include(${MICROPY_DIR}/extmod/extmod.cmake)
+include(${PICO_SDK_PATH}/pico_sdk_init.cmake)
+include(pico_extras_import.cmake)
+
+# Define the top-level project
+project(${MICROPY_TARGET})
+
+pico_sdk_init()
+
+include(${MICROPY_DIR}/py/usermod.cmake)
+
+add_executable(${MICROPY_TARGET})
+
+set(MICROPY_QSTRDEFS_PORT
+    ${PROJECT_SOURCE_DIR}/qstrdefsport.h
+)
+
+set(MICROPY_SOURCE_LIB
+    ${MICROPY_DIR}/lib/littlefs/lfs1.c
+    ${MICROPY_DIR}/lib/littlefs/lfs1_util.c
+    ${MICROPY_DIR}/lib/littlefs/lfs2.c
+    ${MICROPY_DIR}/lib/littlefs/lfs2_util.c
+    ${MICROPY_DIR}/lib/oofatfs/ff.c
+    ${MICROPY_DIR}/lib/oofatfs/ffunicode.c
+    ${MICROPY_DIR}/shared/netutils/netutils.c
+    ${MICROPY_DIR}/shared/readline/readline.c
+    ${MICROPY_DIR}/shared/runtime/gchelper_m0.s
+    ${MICROPY_DIR}/shared/runtime/gchelper_native.c
+    ${MICROPY_DIR}/shared/runtime/mpirq.c
+    ${MICROPY_DIR}/shared/runtime/pyexec.c
+    ${MICROPY_DIR}/shared/runtime/stdout_helpers.c
+    ${MICROPY_DIR}/shared/runtime/sys_stdio_mphal.c
+    ${MICROPY_DIR}/shared/timeutils/timeutils.c
+)
+
+set(MICROPY_SOURCE_DRIVERS
+    ${MICROPY_DIR}/drivers/bus/softspi.c
+)
+
+set(MICROPY_SOURCE_PORT
+    fatfs_port.c
+    machine_adc.c
+    machine_i2c.c
+    machine_pin.c
+    machine_rtc.c
+    machine_spi.c
+    machine_timer.c
+    machine_uart.c
+    machine_wdt.c
+    main.c
+    modpicosleep.c
+    modmachine.c
+    modrp2.c
+    moduos.c
+    modutime.c
+    mphalport.c
+    mpthreadport.c
+    rp2_flash.c
+    rp2_pio.c
+    tusb_port.c
+    uart.c
+)
+
+set(MICROPY_SOURCE_QSTR
+    ${MICROPY_SOURCE_PY}
+    ${MICROPY_SOURCE_EXTMOD}
+    ${MICROPY_SOURCE_USERMOD}
+    ${MICROPY_DIR}/shared/runtime/mpirq.c
+    ${MICROPY_DIR}/shared/runtime/sys_stdio_mphal.c
+    ${PROJECT_SOURCE_DIR}/machine_adc.c
+    ${PROJECT_SOURCE_DIR}/machine_i2c.c
+    ${PROJECT_SOURCE_DIR}/machine_pin.c
+    ${PROJECT_SOURCE_DIR}/machine_rtc.c
+    ${PROJECT_SOURCE_DIR}/machine_spi.c
+    ${PROJECT_SOURCE_DIR}/machine_timer.c
+    ${PROJECT_SOURCE_DIR}/machine_uart.c
+    ${PROJECT_SOURCE_DIR}/machine_wdt.c
+    ${PROJECT_SOURCE_DIR}/modpicosleep.c
+    ${PROJECT_SOURCE_DIR}/modmachine.c
+    ${PROJECT_SOURCE_DIR}/modrp2.c
+    ${PROJECT_SOURCE_DIR}/moduos.c
+    ${PROJECT_SOURCE_DIR}/modutime.c
+    ${PROJECT_SOURCE_DIR}/rp2_flash.c
+    ${PROJECT_SOURCE_DIR}/rp2_pio.c
+)
+
+set(PICO_SDK_COMPONENTS
+    hardware_adc
+    hardware_base
+    hardware_clocks
+    hardware_dma
+    hardware_flash
+    hardware_gpio
+    hardware_i2c
+    hardware_irq
+    hardware_pio
+    hardware_pwm
+    hardware_regs
+    hardware_rtc
+    hardware_rosc
+    hardware_sleep
+    hardware_spi
+    hardware_structs
+    hardware_sync
+    hardware_timer
+    hardware_uart
+    hardware_watchdog
+    pico_base_headers
+    pico_binary_info
+    pico_bootrom
+    pico_multicore
+    pico_platform
+    pico_runtime
+    pico_stdio
+    pico_stdlib
+    pico_sync
+    pico_time
+    pico_unique_id
+    pico_util
+    tinyusb_common
+    tinyusb_device
+)
+
+if(MICROPY_PY_BLUETOOTH)
+    list(APPEND MICROPY_SOURCE_PORT mpbthciport.c)
+    target_compile_definitions(${MICROPY_TARGET} PRIVATE
+        MICROPY_PY_BLUETOOTH=1
+        MICROPY_PY_BLUETOOTH_ENABLE_CENTRAL_MODE=1
+        MICROPY_PY_BLUETOOTH_ENABLE_PAIRING_BONDING=1
+        MICROPY_PY_BLUETOOTH_ENABLE_L2CAP_CHANNELS=1
+    )
+endif()
+
+if(MICROPY_BLUETOOTH_NIMBLE)
+    list(APPEND MICROPY_SOURCE_PORT mpnimbleport.c)
+    target_compile_definitions(${MICROPY_TARGET} PRIVATE
+        MICROPY_BLUETOOTH_NIMBLE=1
+        MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY=0
+    )
+    target_compile_options(${MICROPY_TARGET} PRIVATE
+    # TODO: This flag is currently needed to make nimble build.
+    -Wno-unused-but-set-variable
+    )
+    include(${MICROPY_DIR}/extmod/nimble/nimble.cmake)
+    target_link_libraries(${MICROPY_TARGET} micropy_extmod_nimble)
+    get_target_property(NIMBLE_INCLUDE micropy_extmod_nimble INTERFACE_INCLUDE_DIRECTORIES)
+    list(APPEND MICROPY_INC_CORE ${NIMBLE_INCLUDE})
+endif()
+
+# Define mpy-cross flags and frozen manifest
+set(MICROPY_CROSS_FLAGS -march=armv7m)
+if (NOT MICROPY_FROZEN_MANIFEST)
+    set(MICROPY_FROZEN_MANIFEST ${PROJECT_SOURCE_DIR}/boards/manifest.py)
+endif()
+
+target_sources(${MICROPY_TARGET} PRIVATE
+    ${MICROPY_SOURCE_PY}
+    ${MICROPY_SOURCE_EXTMOD}
+    ${MICROPY_SOURCE_LIB}
+    ${MICROPY_SOURCE_DRIVERS}
+    ${MICROPY_SOURCE_PORT}
+)
+
+target_link_libraries(${MICROPY_TARGET} usermod)
+
+target_include_directories(${MICROPY_TARGET} PRIVATE
+    ${MICROPY_INC_CORE}
+    ${MICROPY_INC_USERMOD}
+    ${MICROPY_BOARD_DIR}
+    "${PROJECT_SOURCE_DIR}"
+    "${CMAKE_BINARY_DIR}"
+)
+
+target_compile_options(${MICROPY_TARGET} PRIVATE
+    -Wall
+    -Werror
+)
+
+set_source_files_properties(
+    ${PICO_SDK_PATH}/src/rp2_common/pico_double/double_math.c
+    ${PICO_SDK_PATH}/src/rp2_common/pico_float/float_math.c
+    PROPERTIES
+    COMPILE_OPTIONS "-Wno-error=uninitialized"
+)
+
+set_source_files_properties(
+    ${PICO_TINYUSB_PATH}/src/portable/raspberrypi/rp2040/dcd_rp2040.c
+    ${PICO_TINYUSB_PATH}/src/portable/raspberrypi/rp2040/rp2040_usb.c
+    PROPERTIES
+    COMPILE_OPTIONS "-Wno-error=array-bounds;-Wno-error=unused-but-set-variable"
+)
+
+target_compile_definitions(${MICROPY_TARGET} PRIVATE
+    FFCONF_H=\"${MICROPY_OOFATFS_DIR}/ffconf.h\"
+    LFS1_NO_MALLOC LFS1_NO_DEBUG LFS1_NO_WARN LFS1_NO_ERROR LFS1_NO_ASSERT
+    LFS2_NO_MALLOC LFS2_NO_DEBUG LFS2_NO_WARN LFS2_NO_ERROR LFS2_NO_ASSERT
+    PICO_FLOAT_PROPAGATE_NANS=1
+    PICO_STACK_SIZE=0x2000
+    PICO_CORE1_STACK_SIZE=0
+    PICO_PROGRAM_NAME="MicroPython"
+    PICO_NO_PROGRAM_VERSION_STRING=1 # do it ourselves in main.c
+    MICROPY_BUILD_TYPE="${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION} ${CMAKE_BUILD_TYPE}"
+    PICO_NO_BI_STDIO_UART=1 # we call it UART REPL
+    PICO_RP2040_USB_DEVICE_ENUMERATION_FIX=1
+)
+
+target_link_libraries(${MICROPY_TARGET}
+    ${PICO_SDK_COMPONENTS}
+)
+
+if (MICROPY_HW_ENABLE_DOUBLE_TAP)
+# Enable double tap reset into bootrom.
+target_link_libraries(${MICROPY_TARGET}
+    pico_bootsel_via_double_reset
+)
+endif()
+
+# todo this is a bit brittle, but we want to move a few source files into RAM (which requires
+#  a linker script modification) until we explicitly add  macro calls around the function
+#  defs to move them into RAM.
+if (PICO_ON_DEVICE AND NOT PICO_NO_FLASH AND NOT PICO_COPY_TO_RAM)
+    pico_set_linker_script(${MICROPY_TARGET} ${CMAKE_CURRENT_LIST_DIR}/memmap_mp.ld)
+endif()
+
+pico_add_extra_outputs(${MICROPY_TARGET})
+
+add_custom_command(TARGET ${MICROPY_TARGET}
+    POST_BUILD
+    COMMAND arm-none-eabi-size --format=berkeley ${PROJECT_BINARY_DIR}/${MICROPY_TARGET}.elf
+    VERBATIM
+)
+
+# Collect all the include directories and compile definitions for the pico-sdk components.
+foreach(comp ${PICO_SDK_COMPONENTS})
+    micropy_gather_target_properties(${comp})
+    micropy_gather_target_properties(${comp}_headers)
+endforeach()
+
+# Include the main MicroPython cmake rules.
+include(${MICROPY_DIR}/py/mkrules.cmake)
diff --git a/ports/rp2sleep/Makefile b/ports/rp2sleep/Makefile
@@ -0,0 +1,27 @@
+# Makefile for micropython on Raspberry Pi RP2
+#
+# This is a simple wrapper around cmake
+
+BOARD ?= PICO
+
+BUILD ?= build-$(BOARD)
+
+$(VERBOSE)MAKESILENT = -s
+
+CMAKE_ARGS = -DMICROPY_BOARD=$(BOARD)
+
+ifdef USER_C_MODULES
+CMAKE_ARGS += -DUSER_C_MODULES=${USER_C_MODULES}
+endif
+
+all:
+	[ -d $(BUILD) ] || cmake -S . -B $(BUILD) -DPICO_BUILD_DOCS=0 ${CMAKE_ARGS}
+	$(MAKE) $(MAKESILENT) -C $(BUILD)
+
+clean:
+	$(RM) -rf $(BUILD)
+
+GIT_SUBMODULES += lib/pico-sdk lib/tinyusb
+
+submodules:
+	$(MAKE) -f ../../py/mkrules.mk GIT_SUBMODULES="$(GIT_SUBMODULES)" submodules