Update LVGL binding to use USER_C_MODULE approach

lib/lv_utils.py

@@ -12,27 +12,27 @@
 #        event_loop = lv_utils.event_loop()
 #
 #
-# uasyncio example with SDL:
+# asyncio example with SDL:
 #
 #        SDL.init(auto_refresh=False)
 #        # Register SDL display driver.
 #        # Register SDL mouse driver
 #        event_loop = lv_utils.event_loop(asynchronous=True)
-#        uasyncio.Loop.run_forever()
+#        asyncio.Loop.run_forever()
 #
-# uasyncio example with ili9341:
+# asyncio example with ili9341:
 #
 #        event_loop = lv_utils.event_loop(asynchronous=True) # Optional!
 #        self.disp = ili9341(asynchronous=True)
-#        uasyncio.Loop.run_forever()
+#        asyncio.Loop.run_forever()
 #
 # MIT license; Copyright (c) 2021 Amir Gonnen
 #
 ##############################################################################
 
 import lvgl as lv
 import micropython
-import usys
+import sys
 
 # Try standard machine.Timer, or custom timer from lv_timer, if available
 
@@ -42,34 +42,45 @@
     try:
         from lv_timer import Timer
     except:
-        raise RuntimeError("Missing machine.Timer implementation!")
+        if sys.platform != "darwin":
+            raise RuntimeError("Missing machine.Timer implementation!")
+        Timer = False
 
 # Try to determine default timer id
 
 default_timer_id = 0
-if usys.platform == 'pyboard':
+if sys.platform == "pyboard":
     # stm32 only supports SW timer -1
     default_timer_id = -1
-    
-if usys.platform == 'rp2':
+
+if sys.platform == "rp2":
     # rp2 only supports SW timer -1
     default_timer_id = -1
 
-# Try importing uasyncio, if available
+# Try importing asyncio, if available
 
 try:
-    import uasyncio
-    uasyncio_available = True
+    import asyncio
+
+    asyncio_available = True
 except:
-    uasyncio_available = False
+    asyncio_available = False
 
 ##############################################################################
 
-class event_loop():
 
+class event_loop:
     _current_instance = None
 
-    def __init__(self, freq=25, timer_id=default_timer_id, max_scheduled=2, refresh_cb=None, asynchronous=False, exception_sink=None):
+    def __init__(
+        self,
+        freq=25,
+        timer_id=default_timer_id,
+        max_scheduled=2,
+        refresh_cb=None,
+        asynchronous=False,
+        exception_sink=None,
+    ):
         if self.is_running():
             raise RuntimeError("Event loop is already running!")
 
@@ -80,28 +91,41 @@ def __init__(self, freq=25, timer_id=default_timer_id, max_scheduled=2, refresh_
 
         self.delay = 1000 // freq
         self.refresh_cb = refresh_cb
-        self.exception_sink = exception_sink if exception_sink else self.default_exception_sink
+        self.exception_sink = (
+            exception_sink if exception_sink else self.default_exception_sink
+        )
 
         self.asynchronous = asynchronous
         if self.asynchronous:
-            if not uasyncio_available:
-                raise RuntimeError("Cannot run asynchronous event loop. uasyncio is not available!")
-            self.refresh_event = uasyncio.Event()
-            self.refresh_task = uasyncio.create_task(self.async_refresh())
-            self.timer_task = uasyncio.create_task(self.async_timer())
+            if not asyncio_available:
+                raise RuntimeError(
+                    "Cannot run asynchronous event loop. asyncio is not available!"
+                )
+            self.refresh_event = asyncio.Event()
+            self.refresh_task = asyncio.create_task(self.async_refresh())
+            self.timer_task = asyncio.create_task(self.async_timer())
         else:
-            self.timer = Timer(timer_id)
+            if Timer:
+                self.timer = Timer(timer_id)
+                self.timer.init(
+                    mode=Timer.PERIODIC, period=self.delay, callback=self.timer_cb
+                )
             self.task_handler_ref = self.task_handler  # Allocation occurs here
-            self.timer.init(mode=Timer.PERIODIC, period=self.delay, callback=self.timer_cb)
             self.max_scheduled = max_scheduled
             self.scheduled = 0
 
+    def init_async(self):
+        self.refresh_event = asyncio.Event()
+        self.refresh_task = asyncio.create_task(self.async_refresh())
+        self.timer_task = asyncio.create_task(self.async_timer())
+
     def deinit(self):
         if self.asynchronous:
             self.refresh_task.cancel()
             self.timer_task.cancel()
         else:
-            self.timer.deinit()
+            if Timer:
+                self.timer.deinit()
         event_loop._current_instance = None
 
     def disable(self):
@@ -122,12 +146,21 @@ def task_handler(self, _):
         try:
             if lv._nesting.value == 0:
                 lv.task_handler()
-                if self.refresh_cb: self.refresh_cb()
+                if self.refresh_cb:
+                    self.refresh_cb()
             self.scheduled -= 1
         except Exception as e:
             if self.exception_sink:
                 self.exception_sink(e)
 
+    def tick(self):
+        self.timer_cb(None)
+
+    def run(self):
+        if sys.platform == "darwin":
+            while True:
+                self.tick()
+
     def timer_cb(self, t):
         # Can be called in Interrupt context
         # Use task_handler_ref since passing self.task_handler would cause allocation.
@@ -149,15 +182,15 @@ async def async_refresh(self):
                 except Exception as e:
                     if self.exception_sink:
                         self.exception_sink(e)
-                if self.refresh_cb: self.refresh_cb()
+                if self.refresh_cb:
+                    self.refresh_cb()
 
     async def async_timer(self):
         while True:
-            await uasyncio.sleep_ms(self.delay)
+            await asyncio.sleep_ms(self.delay)
             lv.tick_inc(self.delay)
             self.refresh_event.set()
-
 
     def default_exception_sink(self, e):
-        usys.print_exception(e)
-        event_loop.current_instance().deinit()
+        sys.print_exception(e)
+        # event_loop.current_instance().deinit()

lv_conf.h

@@ -295,11 +295,16 @@
 /*-------------
  * Others
  *-----------*/
+/* PRIVATE API */
+
+#define LV_USE_PRIVATE_API 1
 
 /*Garbage Collector settings
  *Used if LVGL is bound to higher level language and the memory is managed by that language*/
 extern void mp_lv_init_gc();
+extern void mp_lv_deinit_gc();
 #define LV_GC_INIT() mp_lv_init_gc()
+#define LV_GC_DEINIT() mp_lv_deinit_gc()
 
 #define LV_ENABLE_GLOBAL_CUSTOM 1
 #if LV_ENABLE_GLOBAL_CUSTOM

micropython.cmake

@@ -0,0 +1,63 @@
+
+# This file is to be given as "make USER_C_MODULES=..." when building Micropython port
+
+# Include LVGL component, ignore KCONFIG
+
+idf_build_set_property(LV_MICROPYTHON 1)
+idf_build_component(${CMAKE_CURRENT_LIST_DIR}/lvgl)
+idf_build_set_property(COMPILE_DEFINITIONS "-DLV_KCONFIG_IGNORE" APPEND)
+separate_arguments(LV_CFLAGS_ENV UNIX_COMMAND $ENV{LV_CFLAGS})
+idf_build_set_property(COMPILE_DEFINITIONS "${LV_CFLAGS}" APPEND)
+idf_build_set_property(COMPILE_OPTIONS "-Wno-unused-function" APPEND)
+idf_build_set_property(SRCS "${LV_SRC}" APPEND)
+idf_build_set_property(INCLUDE_DIRS "${LV_INCLUDE}" APPEND)
+
+# idf_build_set_property(INCLUDE_DIRS "${LV_INCLUDE}" APPEND)
+
+# DEBUG LV_CONF_PATH
+message(STATUS "LV_CONF_PATH=${LV_CONF_PATH}")
+
+# Fix for idf 5.2.x
+idf_build_get_property(component_targets __COMPONENT_TARGETS)
+string(REPLACE "___idf_lvgl" "" component_targets "${component_targets}")
+idf_build_set_property(__COMPONENT_TARGETS "${component_targets}")
+
+include(${CMAKE_CURRENT_LIST_DIR}/mkrules_usermod.cmake)
+
+# Add lv_bindings rules
+
+all_lv_bindings()
+
+
+# # # make usermod (target declared by Micropython for all user compiled modules) link to bindings
+# # # this way the bindings (and transitively lvgl_interface) get proper compilation flags
+# target_link_libraries(usermod INTERFACE usermod_lvgl)
+
+file(GLOB_RECURSE SOURCES ${CMAKE_CURRENT_LIST_DIR}/lvgl/src/*.c)
+
+add_library(lvgl_interface INTERFACE)
+
+target_sources(lvgl_interface INTERFACE ${SOURCES})
+target_compile_options(lvgl_interface INTERFACE ${LV_CFLAGS})
+
+# # lvgl bindings target (the mpy module)
+
+add_library(usermod_lvgl INTERFACE)
+target_sources(usermod_lvgl INTERFACE ${LV_SRC})
+target_include_directories(usermod_lvgl INTERFACE ${LV_INCLUDE})
+if (DEFINED LV_CONF_DIR)
+    target_include_directories(usermod_lvgl INTERFACE ${LV_CONF_DIR})
+endif()
+
+file(WRITE ${LV_MP} "")
+
+target_link_libraries(usermod_lvgl INTERFACE lvgl_interface)
+
+# # # make usermod (target declared by Micropython for all user compiled modules) link to bindings
+# # # this way the bindings (and transitively lvgl_interface) get proper compilation flags
+if (DEFINED LV_CONF_DIR)
+    target_include_directories(usermod INTERFACE ${LV_CONF_DIR})
+endif()
+target_compile_options(usermod INTERFACE -DLV_CONF_PATH="${LV_CONF_PATH}")
+target_link_libraries(usermod INTERFACE usermod_lvgl)
+

micropython.mk

@@ -0,0 +1,91 @@
+
+################################################################################
+# LVGL unix optional libraries
+# Update CFLAGS_USERMOD and LDFLAGS_USERMOD for LVGL extenral library,
+# but do that only on the unix port, for unix specific dependencies
+ifeq ($(notdir $(CURDIR)),unix)
+ifneq ($(UNAME_S),Darwin)
+CFLAGS_USERMOD += -DMICROPY_FB=1
+endif
+
+SDL_CFLAGS_USERMOD :=  $(shell pkg-config --silence-errors --cflags sdl2)
+SDL_LDFLAGS_USERMOD := $(shell pkg-config --silence-errors --libs   sdl2)
+ifneq ($(SDL_LDFLAGS_USERMOD),)
+CFLAGS_USERMOD += $(SDL_CFLAGS_USERMOD) -DMICROPY_SDL=1
+LDFLAGS_USERMOD += $(SDL_LDFLAGS_USERMOD)
+endif
+
+# Avoid including unwanted local headers other than sdl2 
+ifeq ($(UNAME_S),Darwin)
+CFLAGS_USERMOD:=$(filter-out -I/usr/local/include,$(CFLAGS_USERMOD))
+endif
+
+RLOTTIE_CFLAGS_USERMOD :=  $(shell pkg-config --silence-errors --cflags rlottie)
+RLOTTIE_LDFLAGS_USERMOD := $(shell pkg-config --silence-errors --libs   rlottie)
+ifneq ($(RLOTTIE_LDFLAGS_USERMOD),)
+CFLAGS_USERMOD += $(RLOTTIE_CFLAGS_USERMOD) -DMICROPY_RLOTTIE=1
+LDFLAGS_USERMOD += $(RLOTTIE_LDFLAGS_USERMOD)
+endif
+
+FREETYPE_CFLAGS_USERMOD :=  $(shell pkg-config --silence-errors --cflags freetype2)
+FREETYPE_LDFLAGS_USERMOD := $(shell pkg-config --silence-errors --libs   freetype2)
+ifneq ($(FREETYPE_LDFLAGS_USERMOD),)
+CFLAGS_USERMOD += $(FREETYPE_CFLAGS_USERMOD) -DMICROPY_FREETYPE=1
+LDFLAGS_USERMOD += $(FREETYPE_LDFLAGS_USERMOD)
+endif
+
+# Enable FFMPEG
+# FFMPEG_LIBS := libavformat libavcodec libswscale libavutil
+# FFMPEG_CFLAGS_USERMOD :=  $(shell pkg-config --silence-errors --cflags $(FFMPEG_LIBS))
+# FFMPEG_LDFLAGS_USERMOD := $(shell pkg-config --silence-errors --libs   $(FFMPEG_LIBS))
+# ifneq ($(FFMPEG_LDFLAGS_USERMOD),)
+# CFLAGS_USERMOD += $(FFMPEG_CFLAGS_USERMOD) -DMICROPY_FFMPEG=1
+# LDFLAGS_USERMOD += $(FFMPEG_LDFLAGS_USERMOD)
+# endif
+
+endif
+
+################################################################################
+
+# LVGL build rules
+
+
+LVGL_BINDING_DIR := $(USERMOD_DIR)
+ifeq ($(LV_CONF_PATH),)
+LV_CONF_PATH = $(LVGL_BINDING_DIR)/lv_conf.h
+endif
+
+# LV_CONF_PATH DEBUG
+$(info    LV_CONF_PATH is $(LV_CONF_PATH))
+
+
+LVGL_DIR = $(LVGL_BINDING_DIR)/lvgl
+LVGL_GENERIC_DRV_DIR = $(LVGL_BINDING_DIR)/driver/generic
+INC += -I$(LVGL_BINDING_DIR)
+ALL_LVGL_SRC = $(shell find $(LVGL_DIR) -type f -name '*.h') $(LV_CONF_PATH)
+LVGL_PP = $(BUILD)/lvgl/lvgl.pp.c
+LVGL_MPY = $(BUILD)/lvgl/lv_mpy.c
+LVGL_MPY_METADATA = $(BUILD)/lvgl/lv_mpy.json
+CFLAGS_USERMOD += $(LV_CFLAGS)
+
+# MAKE SURE LV_CONF_PATH is a STRING
+CFLAGS_USERMOD += -DLV_CONF_PATH='"$(LV_CONF_PATH)"'
+# CFLAGS_USERMOD += -DLV_CONF_PATH=$(LV_CONF_PATH)
+
+
+# CFLAGS DEBUG
+$(info CFLAGS_USERMOD is $(CFLAGS_USERMOD))
+
+$(LVGL_MPY): $(ALL_LVGL_SRC) $(LVGL_BINDING_DIR)/gen/gen_mpy.py 
+	$(ECHO) "LVGL-GEN $@"
+	$(Q)mkdir -p $(dir $@)
+	$(Q)$(CPP) $(CFLAGS_USERMOD) -DPYCPARSER -x c -I $(LVGL_BINDING_DIR)/pycparser/utils/fake_libc_include $(INC) $(LVGL_DIR)/lvgl.h > $(LVGL_PP)
+	$(Q)$(PYTHON) $(LVGL_BINDING_DIR)/gen/gen_mpy.py -M lvgl -MP lv -MD $(LVGL_MPY_METADATA) -E $(LVGL_PP) $(LVGL_DIR)/lvgl.h > $@
+
+.PHONY: LVGL_MPY
+LVGL_MPY: $(LVGL_MPY)
+
+CFLAGS_USERMOD += -Wno-unused-function
+CFLAGS_EXTRA += -Wno-unused-function
+SRC_USERMOD_LIB_C += $(subst $(TOP)/,,$(shell find $(LVGL_DIR)/src $(LVGL_DIR)/examples $(LVGL_GENERIC_DRV_DIR) -type f -name "*.c"))
+SRC_USERMOD_C += $(LVGL_MPY)