From 06afa771883c71f5992e0bcc436e36cd5afbfdb2 Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Tue, 13 Sep 2022 11:12:10 -0500 Subject: [PATCH 01/12] Add LVGL submodule --- .gitmodules | 4 ++++ lib/lvgl | 1 + 2 files changed, 5 insertions(+) create mode 160000 lib/lvgl diff --git a/.gitmodules b/.gitmodules index 48c7035afa44..cbb225edf56a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -21,3 +21,7 @@ [submodule "lib/pico-sdk"] path = lib/pico-sdk url = https://github.com/qmk/pico-sdk.git +[submodule "lib/lvgl"] + path = lib/lvgl + url = https://github.com/lvgl/lvgl.git + branch = release/v8.2 diff --git a/lib/lvgl b/lib/lvgl new file mode 160000 index 000000000000..e19410f8f8a2 --- /dev/null +++ b/lib/lvgl @@ -0,0 +1 @@ +Subproject commit e19410f8f8a256609da72cff549598e0df6fa4cf From f3171c7e3b9cd1582c69be955022c1c5f1b25830 Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Wed, 14 Sep 2022 17:59:37 -0500 Subject: [PATCH 02/12] Add LVGL --- quantum/main.c | 6 + quantum/painter/lvgl/lv_conf.h | 760 +++++++++++++++++++++++++++++++++ quantum/painter/lvgl/qp_lvgl.c | 120 ++++++ quantum/painter/lvgl/qp_lvgl.h | 61 +++ quantum/painter/lvgl/rules.mk | 26 ++ quantum/painter/rules.mk | 4 + 6 files changed, 977 insertions(+) create mode 100644 quantum/painter/lvgl/lv_conf.h create mode 100644 quantum/painter/lvgl/qp_lvgl.c create mode 100644 quantum/painter/lvgl/qp_lvgl.h create mode 100644 quantum/painter/lvgl/rules.mk diff --git a/quantum/main.c b/quantum/main.c index 2d5911b708df..77af20b2445d 100644 --- a/quantum/main.c +++ b/quantum/main.c @@ -63,6 +63,12 @@ int main(void) { // Run Quantum Painter animations void qp_internal_animation_tick(void); qp_internal_animation_tick(); + + #ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE + // Run LVGL ticks + void qp_lvgl_internal_tick(void); + qp_lvgl_internal_tick(); + #endif #endif #ifdef DEFERRED_EXEC_ENABLE diff --git a/quantum/painter/lvgl/lv_conf.h b/quantum/painter/lvgl/lv_conf.h new file mode 100644 index 000000000000..1cfcdb8b13c7 --- /dev/null +++ b/quantum/painter/lvgl/lv_conf.h @@ -0,0 +1,760 @@ +/** + * @file lv_conf.h + * Configuration file for v8.3.1 + */ + +/* + * Copy this file as `lv_conf.h` + * 1. simply next to the `lvgl` folder + * 2. or any other places and + * - define `LV_CONF_INCLUDE_SIMPLE` + * - add the path as include path + */ + +/* clang-format off */ +#if 1 /*Set it to "1" to enable content*/ + +#ifndef LV_CONF_H +#define LV_CONF_H + +#include +#include "qp_lvgl.h" + +/*==================== + COLOR SETTINGS + *====================*/ + +/*Color depth: 1 (1 byte per pixel), 8 (RGB332), 16 (RGB565), 32 (ARGB8888)*/ +#define LV_COLOR_DEPTH QUANTUM_PAINTER_LVGL_COLOR_DEPTH + +/*Swap the 2 bytes of RGB565 color. Useful if the display has an 8-bit interface (e.g. SPI)*/ +#define LV_COLOR_16_SWAP QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES + +/*Enable features to draw on transparent background. + *It's required if opa, and transform_* style properties are used. + *Can be also used if the UI is above another layer, e.g. an OSD menu or video player.*/ +#define LV_COLOR_SCREEN_TRANSP 0 + +/* Adjust color mix functions rounding. GPUs might calculate color mix (blending) differently. + * 0: round down, 64: round up from x.75, 128: round up from half, 192: round up from x.25, 254: round up */ +#define LV_COLOR_MIX_ROUND_OFS 0 + +/*Images pixels with this color will not be drawn if they are chroma keyed)*/ +#define LV_COLOR_CHROMA_KEY lv_color_hex(0x00ff00) /*pure green*/ + +/*========================= + MEMORY SETTINGS + *=========================*/ + +/*1: use custom malloc/free, 0: use the built-in `lv_mem_alloc()` and `lv_mem_free()`*/ +#define LV_MEM_CUSTOM 0 +#if LV_MEM_CUSTOM == 0 + /*Size of the memory available for `lv_mem_alloc()` in bytes (>= 2kB)*/ + #define LV_MEM_SIZE (48U * 1024U) /*[bytes]*/ + + /*Set an address for the memory pool instead of allocating it as a normal array. Can be in external SRAM too.*/ + #define LV_MEM_ADR 0 /*0: unused*/ + /*Instead of an address give a memory allocator that will be called to get a memory pool for LVGL. E.g. my_malloc*/ + #if LV_MEM_ADR == 0 + #undef LV_MEM_POOL_INCLUDE + #undef LV_MEM_POOL_ALLOC + #endif + +#else /*LV_MEM_CUSTOM*/ + #define LV_MEM_CUSTOM_INCLUDE /*Header for the dynamic memory function*/ + #define LV_MEM_CUSTOM_ALLOC malloc + #define LV_MEM_CUSTOM_FREE free + #define LV_MEM_CUSTOM_REALLOC realloc +#endif /*LV_MEM_CUSTOM*/ + +/*Number of the intermediate memory buffer used during rendering and other internal processing mechanisms. + *You will see an error log message if there wasn't enough buffers. */ +#define LV_MEM_BUF_MAX_NUM 16 + +/*Use the standard `memcpy` and `memset` instead of LVGL's own functions. (Might or might not be faster).*/ +#define LV_MEMCPY_MEMSET_STD 0 + +/*==================== + HAL SETTINGS + *====================*/ + +/*Default display refresh period. LVG will redraw changed areas with this period time*/ +#define LV_DISP_DEF_REFR_PERIOD 30 /*[ms]*/ + +/*Input device read period in milliseconds*/ +#define LV_INDEV_DEF_READ_PERIOD 30 /*[ms]*/ + +/*Use a custom tick source that tells the elapsed time in milliseconds. + *It removes the need to manually update the tick with `lv_tick_inc()`)*/ +#define LV_TICK_CUSTOM 0 +#if LV_TICK_CUSTOM + #define LV_TICK_CUSTOM_INCLUDE "Arduino.h" /*Header for the system time function*/ + #define LV_TICK_CUSTOM_SYS_TIME_EXPR (millis()) /*Expression evaluating to current system time in ms*/ +#endif /*LV_TICK_CUSTOM*/ + +/*Default Dot Per Inch. Used to initialize default sizes such as widgets sized, style paddings. + *(Not so important, you can adjust it to modify default sizes and spaces)*/ +#define LV_DPI_DEF 130 /*[px/inch]*/ + +/*======================= + * FEATURE CONFIGURATION + *=======================*/ + +/*------------- + * Drawing + *-----------*/ + +/*Enable complex draw engine. + *Required to draw shadow, gradient, rounded corners, circles, arc, skew lines, image transformations or any masks*/ +#define LV_DRAW_COMPLEX 1 +#if LV_DRAW_COMPLEX != 0 + + /*Allow buffering some shadow calculation. + *LV_SHADOW_CACHE_SIZE is the max. shadow size to buffer, where shadow size is `shadow_width + radius` + *Caching has LV_SHADOW_CACHE_SIZE^2 RAM cost*/ + #define LV_SHADOW_CACHE_SIZE 0 + + /* Set number of maximally cached circle data. + * The circumference of 1/4 circle are saved for anti-aliasing + * radius * 4 bytes are used per circle (the most often used radiuses are saved) + * 0: to disable caching */ + #define LV_CIRCLE_CACHE_SIZE 4 +#endif /*LV_DRAW_COMPLEX*/ + +/** + * "Simple layers" are used when a widget has `style_opa < 255` to buffer the widget into a layer + * and blend it as an image with the given opacity. + * Note that `bg_opa`, `text_opa` etc don't require buffering into layer) + * The widget can be buffered in smaller chunks to avoid using large buffers. + * + * - LV_LAYER_SIMPLE_BUF_SIZE: [bytes] the optimal target buffer size. LVGL will try to allocate it + * - LV_LAYER_SIMPLE_FALLBACK_BUF_SIZE: [bytes] used if `LV_LAYER_SIMPLE_BUF_SIZE` couldn't be allocated. + * + * Both buffer sizes are in bytes. + * "Transformed layers" (where transform_angle/zoom properties are used) use larger buffers + * and can't be drawn in chunks. So these settings affects only widgets with opacity. + */ +#define LV_LAYER_SIMPLE_BUF_SIZE (24 * 1024) +#define LV_LAYER_SIMPLE_FALLBACK_BUF_SIZE (3 * 1024) + +/*Default image cache size. Image caching keeps the images opened. + *If only the built-in image formats are used there is no real advantage of caching. (I.e. if no new image decoder is added) + *With complex image decoders (e.g. PNG or JPG) caching can save the continuous open/decode of images. + *However the opened images might consume additional RAM. + *0: to disable caching*/ +#define LV_IMG_CACHE_DEF_SIZE 0 + +/*Number of stops allowed per gradient. Increase this to allow more stops. + *This adds (sizeof(lv_color_t) + 1) bytes per additional stop*/ +#define LV_GRADIENT_MAX_STOPS 2 + +/*Default gradient buffer size. + *When LVGL calculates the gradient "maps" it can save them into a cache to avoid calculating them again. + *LV_GRAD_CACHE_DEF_SIZE sets the size of this cache in bytes. + *If the cache is too small the map will be allocated only while it's required for the drawing. + *0 mean no caching.*/ +#define LV_GRAD_CACHE_DEF_SIZE 0 + +/*Allow dithering the gradients (to achieve visual smooth color gradients on limited color depth display) + *LV_DITHER_GRADIENT implies allocating one or two more lines of the object's rendering surface + *The increase in memory consumption is (32 bits * object width) plus 24 bits * object width if using error diffusion */ +#define LV_DITHER_GRADIENT 0 +#if LV_DITHER_GRADIENT + /*Add support for error diffusion dithering. + *Error diffusion dithering gets a much better visual result, but implies more CPU consumption and memory when drawing. + *The increase in memory consumption is (24 bits * object's width)*/ + #define LV_DITHER_ERROR_DIFFUSION 0 +#endif + +/*Maximum buffer size to allocate for rotation. + *Only used if software rotation is enabled in the display driver.*/ +#define LV_DISP_ROT_MAX_BUF (10*1024) + +/*------------- + * GPU + *-----------*/ + +/*Use Arm's 2D acceleration library Arm-2D */ +#define LV_USE_GPU_ARM2D 0 + +/*Use STM32's DMA2D (aka Chrom Art) GPU*/ +#define LV_USE_GPU_STM32_DMA2D 0 +#if LV_USE_GPU_STM32_DMA2D + /*Must be defined to include path of CMSIS header of target processor + e.g. "stm32f769xx.h" or "stm32f429xx.h"*/ + #define LV_GPU_DMA2D_CMSIS_INCLUDE +#endif + +/*Use SWM341's DMA2D GPU*/ +#define LV_USE_GPU_SWM341_DMA2D 0 +#if LV_USE_GPU_SWM341_DMA2D + #define LV_GPU_SWM341_DMA2D_INCLUDE "SWM341.h" +#endif + +/*Use NXP's PXP GPU iMX RTxxx platforms*/ +#define LV_USE_GPU_NXP_PXP 0 +#if LV_USE_GPU_NXP_PXP + /*1: Add default bare metal and FreeRTOS interrupt handling routines for PXP (lv_gpu_nxp_pxp_osa.c) + * and call lv_gpu_nxp_pxp_init() automatically during lv_init(). Note that symbol SDK_OS_FREE_RTOS + * has to be defined in order to use FreeRTOS OSA, otherwise bare-metal implementation is selected. + *0: lv_gpu_nxp_pxp_init() has to be called manually before lv_init() + */ + #define LV_USE_GPU_NXP_PXP_AUTO_INIT 0 +#endif + +/*Use NXP's VG-Lite GPU iMX RTxxx platforms*/ +#define LV_USE_GPU_NXP_VG_LITE 0 + +/*Use SDL renderer API*/ +#define LV_USE_GPU_SDL 0 +#if LV_USE_GPU_SDL + #define LV_GPU_SDL_INCLUDE_PATH + /*Texture cache size, 8MB by default*/ + #define LV_GPU_SDL_LRU_SIZE (1024 * 1024 * 8) + /*Custom blend mode for mask drawing, disable if you need to link with older SDL2 lib*/ + #define LV_GPU_SDL_CUSTOM_BLEND_MODE (SDL_VERSION_ATLEAST(2, 0, 6)) +#endif + +/*------------- + * Logging + *-----------*/ + +/*Enable the log module*/ +#define LV_USE_LOG 0 +#if LV_USE_LOG + + /*How important log should be added: + *LV_LOG_LEVEL_TRACE A lot of logs to give detailed information + *LV_LOG_LEVEL_INFO Log important events + *LV_LOG_LEVEL_WARN Log if something unwanted happened but didn't cause a problem + *LV_LOG_LEVEL_ERROR Only critical issue, when the system may fail + *LV_LOG_LEVEL_USER Only logs added by the user + *LV_LOG_LEVEL_NONE Do not log anything*/ + #define LV_LOG_LEVEL LV_LOG_LEVEL_WARN + + /*1: Print the log with 'printf'; + *0: User need to register a callback with `lv_log_register_print_cb()`*/ + #define LV_LOG_PRINTF 0 + + /*Enable/disable LV_LOG_TRACE in modules that produces a huge number of logs*/ + #define LV_LOG_TRACE_MEM 1 + #define LV_LOG_TRACE_TIMER 1 + #define LV_LOG_TRACE_INDEV 1 + #define LV_LOG_TRACE_DISP_REFR 1 + #define LV_LOG_TRACE_EVENT 1 + #define LV_LOG_TRACE_OBJ_CREATE 1 + #define LV_LOG_TRACE_LAYOUT 1 + #define LV_LOG_TRACE_ANIM 1 + +#endif /*LV_USE_LOG*/ + +/*------------- + * Asserts + *-----------*/ + +/*Enable asserts if an operation is failed or an invalid data is found. + *If LV_USE_LOG is enabled an error message will be printed on failure*/ +#define LV_USE_ASSERT_NULL 1 /*Check if the parameter is NULL. (Very fast, recommended)*/ +#define LV_USE_ASSERT_MALLOC 1 /*Checks is the memory is successfully allocated or no. (Very fast, recommended)*/ +#define LV_USE_ASSERT_STYLE 0 /*Check if the styles are properly initialized. (Very fast, recommended)*/ +#define LV_USE_ASSERT_MEM_INTEGRITY 0 /*Check the integrity of `lv_mem` after critical operations. (Slow)*/ +#define LV_USE_ASSERT_OBJ 0 /*Check the object's type and existence (e.g. not deleted). (Slow)*/ + +/*Add a custom handler when assert happens e.g. to restart the MCU*/ +#define LV_ASSERT_HANDLER_INCLUDE +#define LV_ASSERT_HANDLER while(1); /*Halt by default*/ + +/*------------- + * Others + *-----------*/ + +/*1: Show CPU usage and FPS count*/ +#define LV_USE_PERF_MONITOR 0 +#if LV_USE_PERF_MONITOR + #define LV_USE_PERF_MONITOR_POS LV_ALIGN_BOTTOM_RIGHT +#endif + +/*1: Show the used memory and the memory fragmentation + * Requires LV_MEM_CUSTOM = 0*/ +#define LV_USE_MEM_MONITOR 0 +#if LV_USE_MEM_MONITOR + #define LV_USE_MEM_MONITOR_POS LV_ALIGN_BOTTOM_LEFT +#endif + +/*1: Draw random colored rectangles over the redrawn areas*/ +#define LV_USE_REFR_DEBUG 0 + +/*Change the built in (v)snprintf functions*/ +#define LV_SPRINTF_CUSTOM 1 +#if LV_SPRINTF_CUSTOM + #define LV_SPRINTF_INCLUDE + #define lv_snprintf snprintf + #define lv_vsnprintf vsnprintf +#else /*LV_SPRINTF_CUSTOM*/ + #define LV_SPRINTF_USE_FLOAT 0 +#endif /*LV_SPRINTF_CUSTOM*/ + +#define LV_USE_USER_DATA 1 + +/*Garbage Collector settings + *Used if lvgl is bound to higher level language and the memory is managed by that language*/ +#define LV_ENABLE_GC 0 +#if LV_ENABLE_GC != 0 + #define LV_GC_INCLUDE "gc.h" /*Include Garbage Collector related things*/ +#endif /*LV_ENABLE_GC*/ + +/*===================== + * COMPILER SETTINGS + *====================*/ + +/*For big endian systems set to 1*/ +#define LV_BIG_ENDIAN_SYSTEM 0 + +/*Define a custom attribute to `lv_tick_inc` function*/ +#define LV_ATTRIBUTE_TICK_INC + +/*Define a custom attribute to `lv_timer_handler` function*/ +#define LV_ATTRIBUTE_TIMER_HANDLER + +/*Define a custom attribute to `lv_disp_flush_ready` function*/ +#define LV_ATTRIBUTE_FLUSH_READY + +/*Required alignment size for buffers*/ +#define LV_ATTRIBUTE_MEM_ALIGN_SIZE 1 + +/*Will be added where memories needs to be aligned (with -Os data might not be aligned to boundary by default). + * E.g. __attribute__((aligned(4)))*/ +#define LV_ATTRIBUTE_MEM_ALIGN + +/*Attribute to mark large constant arrays for example font's bitmaps*/ +#define LV_ATTRIBUTE_LARGE_CONST + +/*Compiler prefix for a big array declaration in RAM*/ +#define LV_ATTRIBUTE_LARGE_RAM_ARRAY + +/*Place performance critical functions into a faster memory (e.g RAM)*/ +#define LV_ATTRIBUTE_FAST_MEM + +/*Prefix variables that are used in GPU accelerated operations, often these need to be placed in RAM sections that are DMA accessible*/ +#define LV_ATTRIBUTE_DMA + +/*Export integer constant to binding. This macro is used with constants in the form of LV_ that + *should also appear on LVGL binding API such as Micropython.*/ +#define LV_EXPORT_CONST_INT(int_value) struct _silence_gcc_warning /*The default value just prevents GCC warning*/ + +/*Extend the default -32k..32k coordinate range to -4M..4M by using int32_t for coordinates instead of int16_t*/ +#define LV_USE_LARGE_COORD 0 + +/*================== + * FONT USAGE + *===================*/ + +/*Montserrat fonts with ASCII range and some symbols using bpp = 4 + *https://fonts.google.com/specimen/Montserrat*/ +#define LV_FONT_MONTSERRAT_8 0 +#define LV_FONT_MONTSERRAT_10 0 +#define LV_FONT_MONTSERRAT_12 0 +#define LV_FONT_MONTSERRAT_14 1 +#define LV_FONT_MONTSERRAT_16 0 +#define LV_FONT_MONTSERRAT_18 0 +#define LV_FONT_MONTSERRAT_20 0 +#define LV_FONT_MONTSERRAT_22 0 +#define LV_FONT_MONTSERRAT_24 0 +#define LV_FONT_MONTSERRAT_26 0 +#define LV_FONT_MONTSERRAT_28 0 +#define LV_FONT_MONTSERRAT_30 0 +#define LV_FONT_MONTSERRAT_32 0 +#define LV_FONT_MONTSERRAT_34 0 +#define LV_FONT_MONTSERRAT_36 0 +#define LV_FONT_MONTSERRAT_38 0 +#define LV_FONT_MONTSERRAT_40 0 +#define LV_FONT_MONTSERRAT_42 0 +#define LV_FONT_MONTSERRAT_44 0 +#define LV_FONT_MONTSERRAT_46 0 +#define LV_FONT_MONTSERRAT_48 0 + +/*Demonstrate special features*/ +#define LV_FONT_MONTSERRAT_12_SUBPX 0 +#define LV_FONT_MONTSERRAT_28_COMPRESSED 0 /*bpp = 3*/ +#define LV_FONT_DEJAVU_16_PERSIAN_HEBREW 0 /*Hebrew, Arabic, Persian letters and all their forms*/ +#define LV_FONT_SIMSUN_16_CJK 0 /*1000 most common CJK radicals*/ + +/*Pixel perfect monospace fonts*/ +#define LV_FONT_UNSCII_8 0 +#define LV_FONT_UNSCII_16 0 + +/*Optionally declare custom fonts here. + *You can use these fonts as default font too and they will be available globally. + *E.g. #define LV_FONT_CUSTOM_DECLARE LV_FONT_DECLARE(my_font_1) LV_FONT_DECLARE(my_font_2)*/ +#define LV_FONT_CUSTOM_DECLARE + +/*Always set a default font*/ +#define LV_FONT_DEFAULT &lv_font_montserrat_14 + +/*Enable handling large font and/or fonts with a lot of characters. + *The limit depends on the font size, font face and bpp. + *Compiler error will be triggered if a font needs it.*/ +#define LV_FONT_FMT_TXT_LARGE 0 + +/*Enables/disables support for compressed fonts.*/ +#define LV_USE_FONT_COMPRESSED 0 + +/*Enable subpixel rendering*/ +#define LV_USE_FONT_SUBPX 0 +#if LV_USE_FONT_SUBPX + /*Set the pixel order of the display. Physical order of RGB channels. Doesn't matter with "normal" fonts.*/ + #define LV_FONT_SUBPX_BGR 0 /*0: RGB; 1:BGR order*/ +#endif + +/*Enable drawing placeholders when glyph dsc is not found*/ +#define LV_USE_FONT_PLACEHOLDER 1 + +/*================= + * TEXT SETTINGS + *=================*/ + +/** + * Select a character encoding for strings. + * Your IDE or editor should have the same character encoding + * - LV_TXT_ENC_UTF8 + * - LV_TXT_ENC_ASCII + */ +#define LV_TXT_ENC LV_TXT_ENC_UTF8 + +/*Can break (wrap) texts on these chars*/ +#define LV_TXT_BREAK_CHARS " ,.;:-_" + +/*If a word is at least this long, will break wherever "prettiest" + *To disable, set to a value <= 0*/ +#define LV_TXT_LINE_BREAK_LONG_LEN 0 + +/*Minimum number of characters in a long word to put on a line before a break. + *Depends on LV_TXT_LINE_BREAK_LONG_LEN.*/ +#define LV_TXT_LINE_BREAK_LONG_PRE_MIN_LEN 3 + +/*Minimum number of characters in a long word to put on a line after a break. + *Depends on LV_TXT_LINE_BREAK_LONG_LEN.*/ +#define LV_TXT_LINE_BREAK_LONG_POST_MIN_LEN 3 + +/*The control character to use for signalling text recoloring.*/ +#define LV_TXT_COLOR_CMD "#" + +/*Support bidirectional texts. Allows mixing Left-to-Right and Right-to-Left texts. + *The direction will be processed according to the Unicode Bidirectional Algorithm: + *https://www.w3.org/International/articles/inline-bidi-markup/uba-basics*/ +#define LV_USE_BIDI 0 +#if LV_USE_BIDI + /*Set the default direction. Supported values: + *`LV_BASE_DIR_LTR` Left-to-Right + *`LV_BASE_DIR_RTL` Right-to-Left + *`LV_BASE_DIR_AUTO` detect texts base direction*/ + #define LV_BIDI_BASE_DIR_DEF LV_BASE_DIR_AUTO +#endif + +/*Enable Arabic/Persian processing + *In these languages characters should be replaced with an other form based on their position in the text*/ +#define LV_USE_ARABIC_PERSIAN_CHARS 0 + +/*================== + * WIDGET USAGE + *================*/ + +/*Documentation of the widgets: https://docs.lvgl.io/latest/en/html/widgets/index.html*/ + +#define LV_USE_ARC 1 + +#define LV_USE_BAR 1 + +#define LV_USE_BTN 1 + +#define LV_USE_BTNMATRIX 1 + +#define LV_USE_CANVAS 1 + +#define LV_USE_CHECKBOX 1 + +#define LV_USE_DROPDOWN 1 /*Requires: lv_label*/ + +#define LV_USE_IMG 1 /*Requires: lv_label*/ + +#define LV_USE_LABEL 1 +#if LV_USE_LABEL + #define LV_LABEL_TEXT_SELECTION 1 /*Enable selecting text of the label*/ + #define LV_LABEL_LONG_TXT_HINT 1 /*Store some extra info in labels to speed up drawing of very long texts*/ +#endif + +#define LV_USE_LINE 1 + +#define LV_USE_ROLLER 1 /*Requires: lv_label*/ +#if LV_USE_ROLLER + #define LV_ROLLER_INF_PAGES 7 /*Number of extra "pages" when the roller is infinite*/ +#endif + +#define LV_USE_SLIDER 1 /*Requires: lv_bar*/ + +#define LV_USE_SWITCH 1 + +#define LV_USE_TEXTAREA 1 /*Requires: lv_label*/ +#if LV_USE_TEXTAREA != 0 + #define LV_TEXTAREA_DEF_PWD_SHOW_TIME 1500 /*ms*/ +#endif + +#define LV_USE_TABLE 1 + +/*================== + * EXTRA COMPONENTS + *==================*/ + +/*----------- + * Widgets + *----------*/ +#define LV_USE_ANIMIMG 1 + +#define LV_USE_CALENDAR 1 +#if LV_USE_CALENDAR + #define LV_CALENDAR_WEEK_STARTS_MONDAY 0 + #if LV_CALENDAR_WEEK_STARTS_MONDAY + #define LV_CALENDAR_DEFAULT_DAY_NAMES {"Mo", "Tu", "We", "Th", "Fr", "Sa", "Su"} + #else + #define LV_CALENDAR_DEFAULT_DAY_NAMES {"Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"} + #endif + + #define LV_CALENDAR_DEFAULT_MONTH_NAMES {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"} + #define LV_USE_CALENDAR_HEADER_ARROW 1 + #define LV_USE_CALENDAR_HEADER_DROPDOWN 1 +#endif /*LV_USE_CALENDAR*/ + +#define LV_USE_CHART 1 + +#define LV_USE_COLORWHEEL 1 + +#define LV_USE_IMGBTN 1 + +#define LV_USE_KEYBOARD 1 + +#define LV_USE_LED 1 + +#define LV_USE_LIST 1 + +#define LV_USE_MENU 1 + +#define LV_USE_METER 1 + +#define LV_USE_MSGBOX 1 + +#define LV_USE_SPAN 1 +#if LV_USE_SPAN + /*A line text can contain maximum num of span descriptor */ + #define LV_SPAN_SNIPPET_STACK_SIZE 64 +#endif + +#define LV_USE_SPINBOX 1 + +#define LV_USE_SPINNER 1 + +#define LV_USE_TABVIEW 1 + +#define LV_USE_TILEVIEW 1 + +#define LV_USE_WIN 1 + +/*----------- + * Themes + *----------*/ + +/*A simple, impressive and very complete theme*/ +#define LV_USE_THEME_DEFAULT 1 +#if LV_USE_THEME_DEFAULT + + /*0: Light mode; 1: Dark mode*/ + #define LV_THEME_DEFAULT_DARK 0 + + /*1: Enable grow on press*/ + #define LV_THEME_DEFAULT_GROW 1 + + /*Default transition time in [ms]*/ + #define LV_THEME_DEFAULT_TRANSITION_TIME 80 +#endif /*LV_USE_THEME_DEFAULT*/ + +/*A very simple theme that is a good starting point for a custom theme*/ +#define LV_USE_THEME_BASIC 1 + +/*A theme designed for monochrome displays*/ +#define LV_USE_THEME_MONO 1 + +/*----------- + * Layouts + *----------*/ + +/*A layout similar to Flexbox in CSS.*/ +#define LV_USE_FLEX 1 + +/*A layout similar to Grid in CSS.*/ +#define LV_USE_GRID 1 + +/*--------------------- + * 3rd party libraries + *--------------------*/ + +/*File system interfaces for common APIs */ + +/*API for fopen, fread, etc*/ +#define LV_USE_FS_STDIO 0 +#if LV_USE_FS_STDIO + #define LV_FS_STDIO_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ + #define LV_FS_STDIO_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ + #define LV_FS_STDIO_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ +#endif + +/*API for open, read, etc*/ +#define LV_USE_FS_POSIX 0 +#if LV_USE_FS_POSIX + #define LV_FS_POSIX_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ + #define LV_FS_POSIX_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ + #define LV_FS_POSIX_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ +#endif + +/*API for CreateFile, ReadFile, etc*/ +#define LV_USE_FS_WIN32 0 +#if LV_USE_FS_WIN32 + #define LV_FS_WIN32_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ + #define LV_FS_WIN32_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ + #define LV_FS_WIN32_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ +#endif + +/*API for FATFS (needs to be added separately). Uses f_open, f_read, etc*/ +#define LV_USE_FS_FATFS 0 +#if LV_USE_FS_FATFS + #define LV_FS_FATFS_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ + #define LV_FS_FATFS_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ +#endif + +/*PNG decoder library*/ +#define LV_USE_PNG 0 + +/*BMP decoder library*/ +#define LV_USE_BMP 0 + +/* JPG + split JPG decoder library. + * Split JPG is a custom format optimized for embedded systems. */ +#define LV_USE_SJPG 0 + +/*GIF decoder library*/ +#define LV_USE_GIF 0 + +/*QR code library*/ +#define LV_USE_QRCODE 0 + +/*FreeType library*/ +#define LV_USE_FREETYPE 0 +#if LV_USE_FREETYPE + /*Memory used by FreeType to cache characters [bytes] (-1: no caching)*/ + #define LV_FREETYPE_CACHE_SIZE (16 * 1024) + #if LV_FREETYPE_CACHE_SIZE >= 0 + /* 1: bitmap cache use the sbit cache, 0:bitmap cache use the image cache. */ + /* sbit cache:it is much more memory efficient for small bitmaps(font size < 256) */ + /* if font size >= 256, must be configured as image cache */ + #define LV_FREETYPE_SBIT_CACHE 0 + /* Maximum number of opened FT_Face/FT_Size objects managed by this cache instance. */ + /* (0:use system defaults) */ + #define LV_FREETYPE_CACHE_FT_FACES 0 + #define LV_FREETYPE_CACHE_FT_SIZES 0 + #endif +#endif + +/*Rlottie library*/ +#define LV_USE_RLOTTIE 0 + +/*FFmpeg library for image decoding and playing videos + *Supports all major image formats so do not enable other image decoder with it*/ +#define LV_USE_FFMPEG 0 +#if LV_USE_FFMPEG + /*Dump input information to stderr*/ + #define LV_FFMPEG_DUMP_FORMAT 0 +#endif + +/*----------- + * Others + *----------*/ + +/*1: Enable API to take snapshot for object*/ +#define LV_USE_SNAPSHOT 0 + +/*1: Enable Monkey test*/ +#define LV_USE_MONKEY 0 + +/*1: Enable grid navigation*/ +#define LV_USE_GRIDNAV 0 + +/*1: Enable lv_obj fragment*/ +#define LV_USE_FRAGMENT 0 + +/*1: Support using images as font in label or span widgets */ +#define LV_USE_IMGFONT 0 + +/*1: Enable a published subscriber based messaging system */ +#define LV_USE_MSG 0 + +/*1: Enable Pinyin input method*/ +/*Requires: lv_keyboard*/ +#define LV_USE_IME_PINYIN 0 +#if LV_USE_IME_PINYIN + /*1: Use default thesaurus*/ + /*If you do not use the default thesaurus, be sure to use `lv_ime_pinyin` after setting the thesauruss*/ + #define LV_IME_PINYIN_USE_DEFAULT_DICT 1 + /*Set the maximum number of candidate panels that can be displayed*/ + /*This needs to be adjusted according to the size of the screen*/ + #define LV_IME_PINYIN_CAND_TEXT_NUM 6 + + /*Use 9 key input(k9)*/ + #define LV_IME_PINYIN_USE_K9_MODE 1 + #if LV_IME_PINYIN_USE_K9_MODE == 1 + #define LV_IME_PINYIN_K9_CAND_TEXT_NUM 3 + #endif // LV_IME_PINYIN_USE_K9_MODE +#endif + +/*================== +* EXAMPLES +*==================*/ + +/*Enable the examples to be built with the library*/ +#define LV_BUILD_EXAMPLES 1 + +/*=================== + * DEMO USAGE + ====================*/ + +/*Show some widget. It might be required to increase `LV_MEM_SIZE` */ +#define LV_USE_DEMO_WIDGETS 0 +#if LV_USE_DEMO_WIDGETS +#define LV_DEMO_WIDGETS_SLIDESHOW 0 +#endif + +/*Demonstrate the usage of encoder and keyboard*/ +#define LV_USE_DEMO_KEYPAD_AND_ENCODER 0 + +/*Benchmark your system*/ +#define LV_USE_DEMO_BENCHMARK 0 +#if LV_USE_DEMO_BENCHMARK +/*Use RGB565A8 images with 16 bit color depth instead of ARGB8565*/ +#define LV_DEMO_BENCHMARK_RGB565A8 0 +#endif + +/*Stress test for LVGL*/ +#define LV_USE_DEMO_STRESS 0 + +/*Music player demo*/ +#define LV_USE_DEMO_MUSIC 0 +#if LV_USE_DEMO_MUSIC + #define LV_DEMO_MUSIC_SQUARE 0 + #define LV_DEMO_MUSIC_LANDSCAPE 0 + #define LV_DEMO_MUSIC_ROUND 0 + #define LV_DEMO_MUSIC_LARGE 0 + #define LV_DEMO_MUSIC_AUTO_PLAY 0 +#endif + +/*--END OF LV_CONF_H--*/ + +#endif /*LV_CONF_H*/ + +#endif /*End of "Content enable"*/ diff --git a/quantum/painter/lvgl/qp_lvgl.c b/quantum/painter/lvgl/qp_lvgl.c new file mode 100644 index 000000000000..0e298fba2f69 --- /dev/null +++ b/quantum/painter/lvgl/qp_lvgl.c @@ -0,0 +1,120 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + +#include "qp_lvgl.h" +#include "deferred_exec.h" +#include "lvgl.h" + +typedef struct lvgl_state_t { + uint8_t fnc_id; // Ideally this should be the pointer of the function to run + uint16_t delay_ms; + deferred_token defer_token; +} lvgl_state_t; + +static deferred_executor_t lvgl_executors[2] = {0}; // For lv_tick_inc and lv_task_handler +static lvgl_state_t lvgl_states[2] = {0}; // For lv_tick_inc and lv_task_handler + +painter_device_t selected_display; + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter LVGL Integration Internal: qp_lvgl_flush + +void qp_lvgl_flush(lv_disp_drv_t * disp, const lv_area_t * area, lv_color_t * color_p) { + uint32_t number_pixels = (area->x2 - area->x1 + 1) * (area->y2 - area->y1 + 1); + qp_viewport(selected_display, area->x1, area->y1, area->x2, area->y2); + qp_pixdata(selected_display, (void *)color_p, number_pixels); + qp_flush(selected_display); + lv_disp_flush_ready(disp); +} + +static uint32_t tick_task_callback(uint32_t trigger_time, void *cb_arg) { + lvgl_state_t *state = (lvgl_state_t *)cb_arg; + + switch (state->fnc_id) + { + case 0: + lv_tick_inc(1); + break; + case 1: + lv_task_handler(); + break; + + default: + break; + } + + // The tasks should run indefinitely + return state->delay_ms; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter LVGL Integration API: qp_lvgl_start + +bool qp_lvgl_start(painter_device_t device) { + qp_dprintf("qp_lvgl_start: entry\n"); + + struct painter_driver_t *driver = (struct painter_driver_t *)device; + if (!driver->validate_ok) { + qp_dprintf("qp_lvgl_start: fail (validation_ok == false)\n"); + return false; + } + + selected_display = device; + + // Setting up the tasks + lvgl_state_t *lv_tick_inc_state = &lvgl_states[0]; + lv_tick_inc_state->fnc_id = 0; + lv_tick_inc_state->delay_ms = 1; + lv_tick_inc_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 1, tick_task_callback, lv_tick_inc_state); + + if (lv_tick_inc_state->defer_token == INVALID_DEFERRED_TOKEN) { + qp_dprintf("qp_lvgl_start_tasks: fail (could not set up qp_lvgl executor)\n"); + return false; + } + + lvgl_state_t *lv_task_handler_state = &lvgl_states[1]; + lv_task_handler_state->fnc_id = 1; + lv_task_handler_state->delay_ms = 5; + lv_task_handler_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 5, tick_task_callback, lv_task_handler_state); + + if (lv_task_handler_state->defer_token == INVALID_DEFERRED_TOKEN) { + qp_dprintf("qp_lvgl_start_tasks: fail (could not set up qp_lvgl executor)\n"); + return false; + } + + // Init LVGL + lv_init(); + + // Setting up lvgl display buffer + static lv_disp_draw_buf_t draw_buf; + static lv_color_t color_buffer[QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*10]; /*Declare a buffer for 1/10 screen size*/ + lv_disp_draw_buf_init(&draw_buf, color_buffer, NULL, QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*10); /*Initialize the display buffer.*/ + + // Setting up display driver + static lv_disp_drv_t disp_drv; /*Descriptor of a display driver*/ + lv_disp_drv_init(&disp_drv); /*Basic initialization*/ + disp_drv.flush_cb = qp_lvgl_flush; /*Set your driver function*/ + disp_drv.draw_buf = &draw_buf; /*Assign the buffer to the display*/ + disp_drv.hor_res = QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH; /*Set the horizontal resolution of the display*/ + disp_drv.ver_res = QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT; /*Set the vertical resolution of the display*/ + lv_disp_drv_register(&disp_drv); /*Finally register the driver*/ + + return true; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter LVGL Integration API: qp_lvgl_stop_tasks + +void qp_lvgl_stop_tasks() { + for (int i = 0; i < 2; ++i) { + cancel_deferred_exec_advanced(lvgl_executors, 2, lvgl_states[i].defer_token); + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter LVGL Integration Internal: qp_lvgl_internal_tick + +void qp_lvgl_internal_tick(void) { + static uint32_t last_lvgl_exec = 0; + deferred_exec_advanced_task(lvgl_executors, 2, &last_lvgl_exec); +} diff --git a/quantum/painter/lvgl/qp_lvgl.h b/quantum/painter/lvgl/qp_lvgl.h new file mode 100644 index 000000000000..6f43fe32df48 --- /dev/null +++ b/quantum/painter/lvgl/qp_lvgl.h @@ -0,0 +1,61 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include "qp.h" + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter - LVGL global configurables (add to your keyboard's config.h) + +#ifndef QUANTUM_PAINTER_LVGL_INIT_DELAY +/** + * @def This controls the delay to start the deferred execution of the LVGL task. + */ +# define QUANTUM_PAINTER_LVGL_INIT_DELAY 5 +#endif // QUANTUM_PAINTER_LVGL_INIT_DELAY + +#ifndef QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH +/** + * @def Define width of display + */ +# define QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH 240 +#endif // QUANTUM_PAINTER_LVGL_DISPLaY_WIDTH + +#ifndef QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT +/** + * @def Define height of display + */ +# define QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT 240 +#endif // QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT + +#ifndef QUANTUM_PAINTER_LVGL_COLOR_DEPTH +/** + * @def Define color depth of display: 1 (1 byte per pixel), 8 (RGB332), 16 (RGB565), 32 (ARGB8888) + */ +# define QUANTUM_PAINTER_LVGL_COLOR_DEPTH 16 +#endif // QUANTUM_PAINTER_LVGL_COLOR_DEPTH + +#ifndef QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES +/** + * @def Define if LVGL should swap HILOW bits for 16-bit color displays + */ +# define QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES 1 +#endif // QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter - LVGL External API + +/** + * Sets ups LVGL. + * + * @param device[in] the handle of the device to control + * @return true if init. of LVGL succeeded + * @return false if init. of LVGL failed + */ +bool qp_lvgl_start(painter_device_t device); + +/** + * Stops the tasks used by LVGL. + */ +void qp_lvgl_stop_tasks(void); diff --git a/quantum/painter/lvgl/rules.mk b/quantum/painter/lvgl/rules.mk new file mode 100644 index 000000000000..07d1abae4743 --- /dev/null +++ b/quantum/painter/lvgl/rules.mk @@ -0,0 +1,26 @@ +# LVGL Integration + +OPT_DEFS += -DQUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE +DEFERRED_EXEC_ENABLE := yes + +LVGL_DIR_NAME = lvgl +LVGL_DIR = $(LIB_DIR) +LVGL_PATH = $(LVGL_DIR)/$(LVGL_DIR_NAME) + +COMMON_VPATH += \ + $(QUANTUM_DIR)/painter/$(LVGL_DIR_NAME) \ + $(LVGL_PATH) + +SRC += $(QUANTUM_DIR)/painter/$(LVGL_DIR_NAME)/qp_lvgl.c +SRC += $(shell find $(LVGL_PATH)/src -type f -name '*.c') +CFLAGS += "-I$(LVGL_PATH)" + +# Fix this: Should include their makefile +# include $(LVGL_PATH)/src/extra/extra.mk +# include $(LVGL_PATH)/src/core/lv_core.mk +# include $(LVGL_PATH)/src/draw/lv_draw.mk +# include $(LVGL_PATH)/src/draw/sw/lv_draw_sw.mk +# include $(LVGL_PATH)/src/font/lv_font.mk +# include $(LVGL_PATH)/src/hal/lv_hal.mk +# include $(LVGL_PATH)/src/misc/lv_misc.mk +# include $(LVGL_PATH)/src/widgets/lv_widgets.mk diff --git a/quantum/painter/rules.mk b/quantum/painter/rules.mk index 5ac374a96ea5..75d22fe6ed04 100644 --- a/quantum/painter/rules.mk +++ b/quantum/painter/rules.mk @@ -152,3 +152,7 @@ ifeq ($(strip $(QUANTUM_PAINTER_NEEDS_COMMS_SPI)), yes) endif endif +# Check if LVGL needs to be enabled +ifeq ($(strip $(QUANTUM_PAINTER_LVGL_INTEGRATION)), yes) + include $(QUANTUM_DIR)/painter/lvgl/rules.mk +endif From e1a15591b787460f7d271aa265a3e00da55befa3 Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Fri, 23 Sep 2022 21:23:12 -0500 Subject: [PATCH 03/12] use lvgl 8.2 conf file, let user use custom conf --- quantum/painter/lvgl/lv_conf.h | 141 ++++++++++----------------------- quantum/painter/lvgl/qp_lvgl.c | 4 +- quantum/painter/lvgl/rules.mk | 6 ++ 3 files changed, 49 insertions(+), 102 deletions(-) diff --git a/quantum/painter/lvgl/lv_conf.h b/quantum/painter/lvgl/lv_conf.h index 1cfcdb8b13c7..75f914f1fbe9 100644 --- a/quantum/painter/lvgl/lv_conf.h +++ b/quantum/painter/lvgl/lv_conf.h @@ -1,6 +1,6 @@ /** * @file lv_conf.h - * Configuration file for v8.3.1 + * Configuration file for v8.2.0 */ /* @@ -12,7 +12,7 @@ */ /* clang-format off */ -#if 1 /*Set it to "1" to enable content*/ +#ifndef QUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF #ifndef LV_CONF_H #define LV_CONF_H @@ -30,14 +30,14 @@ /*Swap the 2 bytes of RGB565 color. Useful if the display has an 8-bit interface (e.g. SPI)*/ #define LV_COLOR_16_SWAP QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES -/*Enable features to draw on transparent background. - *It's required if opa, and transform_* style properties are used. - *Can be also used if the UI is above another layer, e.g. an OSD menu or video player.*/ +/*Enable more complex drawing routines to manage screens transparency. + *Can be used if the UI is above another layer, e.g. an OSD menu or video player. + *Requires `LV_COLOR_DEPTH = 32` colors and the screen's `bg_opa` should be set to non LV_OPA_COVER value*/ #define LV_COLOR_SCREEN_TRANSP 0 /* Adjust color mix functions rounding. GPUs might calculate color mix (blending) differently. * 0: round down, 64: round up from x.75, 128: round up from half, 192: round up from x.25, 254: round up */ -#define LV_COLOR_MIX_ROUND_OFS 0 +#define LV_COLOR_MIX_ROUND_OFS (LV_COLOR_DEPTH == 32 ? 0: 128) /*Images pixels with this color will not be drawn if they are chroma keyed)*/ #define LV_COLOR_CHROMA_KEY lv_color_hex(0x00ff00) /*pure green*/ @@ -47,7 +47,7 @@ *=========================*/ /*1: use custom malloc/free, 0: use the built-in `lv_mem_alloc()` and `lv_mem_free()`*/ -#define LV_MEM_CUSTOM 0 +#define LV_MEM_CUSTOM 1 #if LV_MEM_CUSTOM == 0 /*Size of the memory available for `lv_mem_alloc()` in bytes (>= 2kB)*/ #define LV_MEM_SIZE (48U * 1024U) /*[bytes]*/ @@ -56,8 +56,8 @@ #define LV_MEM_ADR 0 /*0: unused*/ /*Instead of an address give a memory allocator that will be called to get a memory pool for LVGL. E.g. my_malloc*/ #if LV_MEM_ADR == 0 - #undef LV_MEM_POOL_INCLUDE - #undef LV_MEM_POOL_ALLOC + //#define LV_MEM_POOL_INCLUDE your_alloc_library /* Uncomment if using an external allocator*/ + //#define LV_MEM_POOL_ALLOC your_alloc /* Uncomment if using an external allocator*/ #endif #else /*LV_MEM_CUSTOM*/ @@ -121,49 +121,33 @@ #define LV_CIRCLE_CACHE_SIZE 4 #endif /*LV_DRAW_COMPLEX*/ -/** - * "Simple layers" are used when a widget has `style_opa < 255` to buffer the widget into a layer - * and blend it as an image with the given opacity. - * Note that `bg_opa`, `text_opa` etc don't require buffering into layer) - * The widget can be buffered in smaller chunks to avoid using large buffers. - * - * - LV_LAYER_SIMPLE_BUF_SIZE: [bytes] the optimal target buffer size. LVGL will try to allocate it - * - LV_LAYER_SIMPLE_FALLBACK_BUF_SIZE: [bytes] used if `LV_LAYER_SIMPLE_BUF_SIZE` couldn't be allocated. - * - * Both buffer sizes are in bytes. - * "Transformed layers" (where transform_angle/zoom properties are used) use larger buffers - * and can't be drawn in chunks. So these settings affects only widgets with opacity. - */ -#define LV_LAYER_SIMPLE_BUF_SIZE (24 * 1024) -#define LV_LAYER_SIMPLE_FALLBACK_BUF_SIZE (3 * 1024) - /*Default image cache size. Image caching keeps the images opened. *If only the built-in image formats are used there is no real advantage of caching. (I.e. if no new image decoder is added) *With complex image decoders (e.g. PNG or JPG) caching can save the continuous open/decode of images. *However the opened images might consume additional RAM. *0: to disable caching*/ -#define LV_IMG_CACHE_DEF_SIZE 0 +#define LV_IMG_CACHE_DEF_SIZE 0 /*Number of stops allowed per gradient. Increase this to allow more stops. *This adds (sizeof(lv_color_t) + 1) bytes per additional stop*/ -#define LV_GRADIENT_MAX_STOPS 2 +#define LV_GRADIENT_MAX_STOPS 2 /*Default gradient buffer size. *When LVGL calculates the gradient "maps" it can save them into a cache to avoid calculating them again. *LV_GRAD_CACHE_DEF_SIZE sets the size of this cache in bytes. *If the cache is too small the map will be allocated only while it's required for the drawing. *0 mean no caching.*/ -#define LV_GRAD_CACHE_DEF_SIZE 0 +#define LV_GRAD_CACHE_DEF_SIZE 0 /*Allow dithering the gradients (to achieve visual smooth color gradients on limited color depth display) *LV_DITHER_GRADIENT implies allocating one or two more lines of the object's rendering surface *The increase in memory consumption is (32 bits * object width) plus 24 bits * object width if using error diffusion */ -#define LV_DITHER_GRADIENT 0 +#define LV_DITHER_GRADIENT 0 #if LV_DITHER_GRADIENT /*Add support for error diffusion dithering. *Error diffusion dithering gets a much better visual result, but implies more CPU consumption and memory when drawing. *The increase in memory consumption is (24 bits * object's width)*/ - #define LV_DITHER_ERROR_DIFFUSION 0 + #define LV_DITHER_ERROR_DIFFUSION 0 #endif /*Maximum buffer size to allocate for rotation. @@ -174,9 +158,6 @@ * GPU *-----------*/ -/*Use Arm's 2D acceleration library Arm-2D */ -#define LV_USE_GPU_ARM2D 0 - /*Use STM32's DMA2D (aka Chrom Art) GPU*/ #define LV_USE_GPU_STM32_DMA2D 0 #if LV_USE_GPU_STM32_DMA2D @@ -185,12 +166,6 @@ #define LV_GPU_DMA2D_CMSIS_INCLUDE #endif -/*Use SWM341's DMA2D GPU*/ -#define LV_USE_GPU_SWM341_DMA2D 0 -#if LV_USE_GPU_SWM341_DMA2D - #define LV_GPU_SWM341_DMA2D_INCLUDE "SWM341.h" -#endif - /*Use NXP's PXP GPU iMX RTxxx platforms*/ #define LV_USE_GPU_NXP_PXP 0 #if LV_USE_GPU_NXP_PXP @@ -406,9 +381,6 @@ #define LV_FONT_SUBPX_BGR 0 /*0: RGB; 1:BGR order*/ #endif -/*Enable drawing placeholders when glyph dsc is not found*/ -#define LV_USE_FONT_PLACEHOLDER 1 - /*================= * TEXT SETTINGS *=================*/ @@ -463,6 +435,8 @@ #define LV_USE_ARC 1 +#define LV_USE_ANIMIMG 1 + #define LV_USE_BAR 1 #define LV_USE_BTN 1 @@ -508,8 +482,6 @@ /*----------- * Widgets *----------*/ -#define LV_USE_ANIMIMG 1 - #define LV_USE_CALENDAR 1 #if LV_USE_CALENDAR #define LV_CALENDAR_WEEK_STARTS_MONDAY 0 @@ -542,12 +514,6 @@ #define LV_USE_MSGBOX 1 -#define LV_USE_SPAN 1 -#if LV_USE_SPAN - /*A line text can contain maximum num of span descriptor */ - #define LV_SPAN_SNIPPET_STACK_SIZE 64 -#endif - #define LV_USE_SPINBOX 1 #define LV_USE_SPINNER 1 @@ -558,6 +524,12 @@ #define LV_USE_WIN 1 +#define LV_USE_SPAN 1 +#if LV_USE_SPAN + /*A line text can contain maximum num of span descriptor */ + #define LV_SPAN_SNIPPET_STACK_SIZE 64 +#endif + /*----------- * Themes *----------*/ @@ -603,7 +575,7 @@ #if LV_USE_FS_STDIO #define LV_FS_STDIO_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_STDIO_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ - #define LV_FS_STDIO_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ + #define LV_FS_STDIO_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ #endif /*API for open, read, etc*/ @@ -611,19 +583,19 @@ #if LV_USE_FS_POSIX #define LV_FS_POSIX_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_POSIX_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ - #define LV_FS_POSIX_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ + #define LV_FS_POSIX_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ #endif /*API for CreateFile, ReadFile, etc*/ #define LV_USE_FS_WIN32 0 #if LV_USE_FS_WIN32 - #define LV_FS_WIN32_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ + #define LV_FS_WIN32_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_WIN32_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ #define LV_FS_WIN32_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ #endif /*API for FATFS (needs to be added separately). Uses f_open, f_read, etc*/ -#define LV_USE_FS_FATFS 0 +#define LV_USE_FS_FATFS 0 #if LV_USE_FS_FATFS #define LV_FS_FATFS_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_FATFS_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ @@ -667,10 +639,10 @@ /*FFmpeg library for image decoding and playing videos *Supports all major image formats so do not enable other image decoder with it*/ -#define LV_USE_FFMPEG 0 +#define LV_USE_FFMPEG 0 #if LV_USE_FFMPEG /*Dump input information to stderr*/ - #define LV_FFMPEG_DUMP_FORMAT 0 + #define LV_FFMPEG_AV_DUMP_FORMAT 0 #endif /*----------- @@ -681,37 +653,10 @@ #define LV_USE_SNAPSHOT 0 /*1: Enable Monkey test*/ -#define LV_USE_MONKEY 0 +#define LV_USE_MONKEY 0 /*1: Enable grid navigation*/ -#define LV_USE_GRIDNAV 0 - -/*1: Enable lv_obj fragment*/ -#define LV_USE_FRAGMENT 0 - -/*1: Support using images as font in label or span widgets */ -#define LV_USE_IMGFONT 0 - -/*1: Enable a published subscriber based messaging system */ -#define LV_USE_MSG 0 - -/*1: Enable Pinyin input method*/ -/*Requires: lv_keyboard*/ -#define LV_USE_IME_PINYIN 0 -#if LV_USE_IME_PINYIN - /*1: Use default thesaurus*/ - /*If you do not use the default thesaurus, be sure to use `lv_ime_pinyin` after setting the thesauruss*/ - #define LV_IME_PINYIN_USE_DEFAULT_DICT 1 - /*Set the maximum number of candidate panels that can be displayed*/ - /*This needs to be adjusted according to the size of the screen*/ - #define LV_IME_PINYIN_CAND_TEXT_NUM 6 - - /*Use 9 key input(k9)*/ - #define LV_IME_PINYIN_USE_K9_MODE 1 - #if LV_IME_PINYIN_USE_K9_MODE == 1 - #define LV_IME_PINYIN_K9_CAND_TEXT_NUM 3 - #endif // LV_IME_PINYIN_USE_K9_MODE -#endif +#define LV_USE_GRIDNAV 0 /*================== * EXAMPLES @@ -725,32 +670,28 @@ ====================*/ /*Show some widget. It might be required to increase `LV_MEM_SIZE` */ -#define LV_USE_DEMO_WIDGETS 0 +#define LV_USE_DEMO_WIDGETS 0 #if LV_USE_DEMO_WIDGETS -#define LV_DEMO_WIDGETS_SLIDESHOW 0 +#define LV_DEMO_WIDGETS_SLIDESHOW 0 #endif /*Demonstrate the usage of encoder and keyboard*/ -#define LV_USE_DEMO_KEYPAD_AND_ENCODER 0 +#define LV_USE_DEMO_KEYPAD_AND_ENCODER 0 /*Benchmark your system*/ -#define LV_USE_DEMO_BENCHMARK 0 -#if LV_USE_DEMO_BENCHMARK -/*Use RGB565A8 images with 16 bit color depth instead of ARGB8565*/ -#define LV_DEMO_BENCHMARK_RGB565A8 0 -#endif +#define LV_USE_DEMO_BENCHMARK 0 /*Stress test for LVGL*/ -#define LV_USE_DEMO_STRESS 0 +#define LV_USE_DEMO_STRESS 0 /*Music player demo*/ -#define LV_USE_DEMO_MUSIC 0 +#define LV_USE_DEMO_MUSIC 0 #if LV_USE_DEMO_MUSIC - #define LV_DEMO_MUSIC_SQUARE 0 - #define LV_DEMO_MUSIC_LANDSCAPE 0 - #define LV_DEMO_MUSIC_ROUND 0 - #define LV_DEMO_MUSIC_LARGE 0 - #define LV_DEMO_MUSIC_AUTO_PLAY 0 +# define LV_DEMO_MUSIC_SQUARE 0 +# define LV_DEMO_MUSIC_LANDSCAPE 0 +# define LV_DEMO_MUSIC_ROUND 0 +# define LV_DEMO_MUSIC_LARGE 0 +# define LV_DEMO_MUSIC_AUTO_PLAY 0 #endif /*--END OF LV_CONF_H--*/ diff --git a/quantum/painter/lvgl/qp_lvgl.c b/quantum/painter/lvgl/qp_lvgl.c index 0e298fba2f69..d1b06aab1311 100644 --- a/quantum/painter/lvgl/qp_lvgl.c +++ b/quantum/painter/lvgl/qp_lvgl.c @@ -87,8 +87,8 @@ bool qp_lvgl_start(painter_device_t device) { // Setting up lvgl display buffer static lv_disp_draw_buf_t draw_buf; - static lv_color_t color_buffer[QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*10]; /*Declare a buffer for 1/10 screen size*/ - lv_disp_draw_buf_init(&draw_buf, color_buffer, NULL, QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*10); /*Initialize the display buffer.*/ + static lv_color_t color_buffer[QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*(QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT / 10)]; /*Declare a buffer for 1/10 screen size*/ + lv_disp_draw_buf_init(&draw_buf, color_buffer, NULL, QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*(QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT / 10)); /*Initialize the display buffer.*/ // Setting up display driver static lv_disp_drv_t disp_drv; /*Descriptor of a display driver*/ diff --git a/quantum/painter/lvgl/rules.mk b/quantum/painter/lvgl/rules.mk index 07d1abae4743..ca6616a65d77 100644 --- a/quantum/painter/lvgl/rules.mk +++ b/quantum/painter/lvgl/rules.mk @@ -7,6 +7,11 @@ LVGL_DIR_NAME = lvgl LVGL_DIR = $(LIB_DIR) LVGL_PATH = $(LVGL_DIR)/$(LVGL_DIR_NAME) +ifeq ($(strip $(QUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF)), yes) + OPT_DEFS += -DLV_CONF_INCLUDE_SIMPLE + OPT_DEFS += -DQUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF +endif + COMMON_VPATH += \ $(QUANTUM_DIR)/painter/$(LVGL_DIR_NAME) \ $(LVGL_PATH) @@ -16,6 +21,7 @@ SRC += $(shell find $(LVGL_PATH)/src -type f -name '*.c') CFLAGS += "-I$(LVGL_PATH)" # Fix this: Should include their makefile + # include $(LVGL_PATH)/src/extra/extra.mk # include $(LVGL_PATH)/src/core/lv_core.mk # include $(LVGL_PATH)/src/draw/lv_draw.mk From 2d534ef7799e666d3f295f83c4eb8270b9b3d5ce Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Sun, 25 Sep 2022 20:34:30 +1000 Subject: [PATCH 04/12] Cleanup. --- .../chibios}/board.h | 0 .../chibios}/chconf.h | 0 .../chibios}/halconf.h | 0 .../chibios}/mcuconf.h | 0 .../common/lv_conf.h | 10 ++ {quantum/painter/lvgl => platforms}/lv_conf.h | 63 +++++++++- quantum/main.c | 10 +- quantum/painter/lvgl/qp_lvgl.c | 108 +++++++++++------- quantum/painter/lvgl/qp_lvgl.h | 51 ++------- quantum/painter/lvgl/rules.mk | 32 ++---- quantum/painter/rules.mk | 2 + 11 files changed, 164 insertions(+), 112 deletions(-) rename {platforms/chibios/boards/keyboard-config-templates => data/keyboard-config-templates/chibios}/board.h (100%) rename {platforms/chibios/boards/keyboard-config-templates => data/keyboard-config-templates/chibios}/chconf.h (100%) rename {platforms/chibios/boards/keyboard-config-templates => data/keyboard-config-templates/chibios}/halconf.h (100%) rename {platforms/chibios/boards/keyboard-config-templates => data/keyboard-config-templates/chibios}/mcuconf.h (100%) create mode 100644 data/keyboard-config-templates/common/lv_conf.h rename {quantum/painter/lvgl => platforms}/lv_conf.h (94%) diff --git a/platforms/chibios/boards/keyboard-config-templates/board.h b/data/keyboard-config-templates/chibios/board.h similarity index 100% rename from platforms/chibios/boards/keyboard-config-templates/board.h rename to data/keyboard-config-templates/chibios/board.h diff --git a/platforms/chibios/boards/keyboard-config-templates/chconf.h b/data/keyboard-config-templates/chibios/chconf.h similarity index 100% rename from platforms/chibios/boards/keyboard-config-templates/chconf.h rename to data/keyboard-config-templates/chibios/chconf.h diff --git a/platforms/chibios/boards/keyboard-config-templates/halconf.h b/data/keyboard-config-templates/chibios/halconf.h similarity index 100% rename from platforms/chibios/boards/keyboard-config-templates/halconf.h rename to data/keyboard-config-templates/chibios/halconf.h diff --git a/platforms/chibios/boards/keyboard-config-templates/mcuconf.h b/data/keyboard-config-templates/chibios/mcuconf.h similarity index 100% rename from platforms/chibios/boards/keyboard-config-templates/mcuconf.h rename to data/keyboard-config-templates/chibios/mcuconf.h diff --git a/data/keyboard-config-templates/common/lv_conf.h b/data/keyboard-config-templates/common/lv_conf.h new file mode 100644 index 000000000000..5c003a6a10c5 --- /dev/null +++ b/data/keyboard-config-templates/common/lv_conf.h @@ -0,0 +1,10 @@ +// Copyright 2022 Nick Brassel (@tzarc) +// SPDX-License-Identifier: GPL-2.0-or-later +#pragma once + +// #define LV_DITHER_GRADIENT 1 + +#include_next + +// #undef LV_COLOR_16_SWAP +// #define LV_COLOR_16_SWAP 0 diff --git a/quantum/painter/lvgl/lv_conf.h b/platforms/lv_conf.h similarity index 94% rename from quantum/painter/lvgl/lv_conf.h rename to platforms/lv_conf.h index 75f914f1fbe9..d02d87bfc76e 100644 --- a/quantum/painter/lvgl/lv_conf.h +++ b/platforms/lv_conf.h @@ -12,23 +12,22 @@ */ /* clang-format off */ -#ifndef QUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF +#if 1 /*Set it to "1" to enable content*/ #ifndef LV_CONF_H #define LV_CONF_H #include -#include "qp_lvgl.h" /*==================== COLOR SETTINGS *====================*/ /*Color depth: 1 (1 byte per pixel), 8 (RGB332), 16 (RGB565), 32 (ARGB8888)*/ -#define LV_COLOR_DEPTH QUANTUM_PAINTER_LVGL_COLOR_DEPTH +#define LV_COLOR_DEPTH 16 /*Swap the 2 bytes of RGB565 color. Useful if the display has an 8-bit interface (e.g. SPI)*/ -#define LV_COLOR_16_SWAP QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES +#define LV_COLOR_16_SWAP 1 /*Enable more complex drawing routines to manage screens transparency. *Can be used if the UI is above another layer, e.g. an OSD menu or video player. @@ -47,7 +46,9 @@ *=========================*/ /*1: use custom malloc/free, 0: use the built-in `lv_mem_alloc()` and `lv_mem_free()`*/ +#ifndef LV_MEM_CUSTOM #define LV_MEM_CUSTOM 1 +#endif // LV_MEM_CUSTOM #if LV_MEM_CUSTOM == 0 /*Size of the memory available for `lv_mem_alloc()` in bytes (>= 2kB)*/ #define LV_MEM_SIZE (48U * 1024U) /*[bytes]*/ @@ -86,7 +87,9 @@ /*Use a custom tick source that tells the elapsed time in milliseconds. *It removes the need to manually update the tick with `lv_tick_inc()`)*/ +#ifndef LV_TICK_CUSTOM #define LV_TICK_CUSTOM 0 +#endif // LV_TICK_CUSTOM #if LV_TICK_CUSTOM #define LV_TICK_CUSTOM_INCLUDE "Arduino.h" /*Header for the system time function*/ #define LV_TICK_CUSTOM_SYS_TIME_EXPR (millis()) /*Expression evaluating to current system time in ms*/ @@ -106,7 +109,9 @@ /*Enable complex draw engine. *Required to draw shadow, gradient, rounded corners, circles, arc, skew lines, image transformations or any masks*/ +#ifndef LV_DRAW_COMPLEX #define LV_DRAW_COMPLEX 1 +#endif // LV_DRAW_COMPLEX #if LV_DRAW_COMPLEX != 0 /*Allow buffering some shadow calculation. @@ -142,7 +147,9 @@ /*Allow dithering the gradients (to achieve visual smooth color gradients on limited color depth display) *LV_DITHER_GRADIENT implies allocating one or two more lines of the object's rendering surface *The increase in memory consumption is (32 bits * object width) plus 24 bits * object width if using error diffusion */ +#ifndef LV_DITHER_GRADIENT #define LV_DITHER_GRADIENT 0 +#endif #if LV_DITHER_GRADIENT /*Add support for error diffusion dithering. *Error diffusion dithering gets a much better visual result, but implies more CPU consumption and memory when drawing. @@ -159,7 +166,9 @@ *-----------*/ /*Use STM32's DMA2D (aka Chrom Art) GPU*/ +#ifndef LV_USE_GPU_STM32_DMA2D #define LV_USE_GPU_STM32_DMA2D 0 +#endif // LV_USE_GPU_STM32_DMA2D #if LV_USE_GPU_STM32_DMA2D /*Must be defined to include path of CMSIS header of target processor e.g. "stm32f769xx.h" or "stm32f429xx.h"*/ @@ -167,7 +176,9 @@ #endif /*Use NXP's PXP GPU iMX RTxxx platforms*/ +#ifndef LV_USE_GPU_NXP_PXP #define LV_USE_GPU_NXP_PXP 0 +#endif // LV_USE_GPU_NXP_PXP #if LV_USE_GPU_NXP_PXP /*1: Add default bare metal and FreeRTOS interrupt handling routines for PXP (lv_gpu_nxp_pxp_osa.c) * and call lv_gpu_nxp_pxp_init() automatically during lv_init(). Note that symbol SDK_OS_FREE_RTOS @@ -181,7 +192,9 @@ #define LV_USE_GPU_NXP_VG_LITE 0 /*Use SDL renderer API*/ +#ifndef LV_USE_GPU_SDL #define LV_USE_GPU_SDL 0 +#endif // LV_USE_GPU_SDL #if LV_USE_GPU_SDL #define LV_GPU_SDL_INCLUDE_PATH /*Texture cache size, 8MB by default*/ @@ -195,7 +208,9 @@ *-----------*/ /*Enable the log module*/ +#ifndef LV_USE_LOG #define LV_USE_LOG 0 +#endif // LV_USE_LOG #if LV_USE_LOG /*How important log should be added: @@ -244,14 +259,18 @@ *-----------*/ /*1: Show CPU usage and FPS count*/ +#ifndef LV_USE_PERF_MONITOR #define LV_USE_PERF_MONITOR 0 +#endif // LV_USE_PERF_MONITOR #if LV_USE_PERF_MONITOR #define LV_USE_PERF_MONITOR_POS LV_ALIGN_BOTTOM_RIGHT #endif /*1: Show the used memory and the memory fragmentation * Requires LV_MEM_CUSTOM = 0*/ +#ifndef LV_USE_MEM_MONITOR #define LV_USE_MEM_MONITOR 0 +#endif // LV_USE_MEM_MONITOR #if LV_USE_MEM_MONITOR #define LV_USE_MEM_MONITOR_POS LV_ALIGN_BOTTOM_LEFT #endif @@ -260,7 +279,9 @@ #define LV_USE_REFR_DEBUG 0 /*Change the built in (v)snprintf functions*/ +#ifndef LV_SPRINTF_CUSTOM #define LV_SPRINTF_CUSTOM 1 +#endif // LV_SPRINTF_CUSTOM #if LV_SPRINTF_CUSTOM #define LV_SPRINTF_INCLUDE #define lv_snprintf snprintf @@ -273,7 +294,9 @@ /*Garbage Collector settings *Used if lvgl is bound to higher level language and the memory is managed by that language*/ +#ifndef LV_ENABLE_GC #define LV_ENABLE_GC 0 +#endif // LV_ENABLE_GC #if LV_ENABLE_GC != 0 #define LV_GC_INCLUDE "gc.h" /*Include Garbage Collector related things*/ #endif /*LV_ENABLE_GC*/ @@ -375,7 +398,9 @@ #define LV_USE_FONT_COMPRESSED 0 /*Enable subpixel rendering*/ +#ifndef LV_USE_FONT_SUBPX #define LV_USE_FONT_SUBPX 0 +#endif // LV_USE_FONT_SUBPX #if LV_USE_FONT_SUBPX /*Set the pixel order of the display. Physical order of RGB channels. Doesn't matter with "normal" fonts.*/ #define LV_FONT_SUBPX_BGR 0 /*0: RGB; 1:BGR order*/ @@ -414,7 +439,9 @@ /*Support bidirectional texts. Allows mixing Left-to-Right and Right-to-Left texts. *The direction will be processed according to the Unicode Bidirectional Algorithm: *https://www.w3.org/International/articles/inline-bidi-markup/uba-basics*/ +#ifndef LV_USE_BIDI #define LV_USE_BIDI 0 +#endif // LV_USE_BIDI #if LV_USE_BIDI /*Set the default direction. Supported values: *`LV_BASE_DIR_LTR` Left-to-Right @@ -451,7 +478,9 @@ #define LV_USE_IMG 1 /*Requires: lv_label*/ +#ifndef LV_USE_LABEL #define LV_USE_LABEL 1 +#endif // LV_USE_LABEL #if LV_USE_LABEL #define LV_LABEL_TEXT_SELECTION 1 /*Enable selecting text of the label*/ #define LV_LABEL_LONG_TXT_HINT 1 /*Store some extra info in labels to speed up drawing of very long texts*/ @@ -459,7 +488,9 @@ #define LV_USE_LINE 1 +#ifndef LV_USE_ROLLER #define LV_USE_ROLLER 1 /*Requires: lv_label*/ +#endif // LV_USE_ROLLER #if LV_USE_ROLLER #define LV_ROLLER_INF_PAGES 7 /*Number of extra "pages" when the roller is infinite*/ #endif @@ -468,7 +499,9 @@ #define LV_USE_SWITCH 1 +#ifndef LV_USE_TEXTAREA #define LV_USE_TEXTAREA 1 /*Requires: lv_label*/ +#endif // LV_USE_TEXTAREA #if LV_USE_TEXTAREA != 0 #define LV_TEXTAREA_DEF_PWD_SHOW_TIME 1500 /*ms*/ #endif @@ -482,7 +515,9 @@ /*----------- * Widgets *----------*/ +#ifndef LV_USE_CALENDAR #define LV_USE_CALENDAR 1 +#endif // LV_USE_CALENDAR #if LV_USE_CALENDAR #define LV_CALENDAR_WEEK_STARTS_MONDAY 0 #if LV_CALENDAR_WEEK_STARTS_MONDAY @@ -524,7 +559,9 @@ #define LV_USE_WIN 1 +#ifndef LV_USE_SPAN #define LV_USE_SPAN 1 +#endif // LV_USE_SPAN #if LV_USE_SPAN /*A line text can contain maximum num of span descriptor */ #define LV_SPAN_SNIPPET_STACK_SIZE 64 @@ -535,7 +572,9 @@ *----------*/ /*A simple, impressive and very complete theme*/ +#ifndef LV_USE_THEME_DEFAULT #define LV_USE_THEME_DEFAULT 1 +#endif // LV_USE_THEME_DEFAULT #if LV_USE_THEME_DEFAULT /*0: Light mode; 1: Dark mode*/ @@ -571,7 +610,9 @@ /*File system interfaces for common APIs */ /*API for fopen, fread, etc*/ +#ifndef LV_USE_FS_STDIO #define LV_USE_FS_STDIO 0 +#endif // LV_USE_FS_STDIO #if LV_USE_FS_STDIO #define LV_FS_STDIO_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_STDIO_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ @@ -579,7 +620,9 @@ #endif /*API for open, read, etc*/ +#ifndef LV_USE_FS_POSIX #define LV_USE_FS_POSIX 0 +#endif // LV_USE_FS_POSIX #if LV_USE_FS_POSIX #define LV_FS_POSIX_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_POSIX_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ @@ -587,7 +630,9 @@ #endif /*API for CreateFile, ReadFile, etc*/ +#ifndef LV_USE_FS_WIN32 #define LV_USE_FS_WIN32 0 +#endif // LV_USE_FS_WIN32 #if LV_USE_FS_WIN32 #define LV_FS_WIN32_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_WIN32_PATH "" /*Set the working directory. File/directory paths will be appended to it.*/ @@ -595,7 +640,9 @@ #endif /*API for FATFS (needs to be added separately). Uses f_open, f_read, etc*/ +#ifndef LV_USE_FS_FATFS #define LV_USE_FS_FATFS 0 +#endif // LV_USE_FS_FATFS #if LV_USE_FS_FATFS #define LV_FS_FATFS_LETTER '\0' /*Set an upper cased letter on which the drive will accessible (e.g. 'A')*/ #define LV_FS_FATFS_CACHE_SIZE 0 /*>0 to cache this number of bytes in lv_fs_read()*/ @@ -618,7 +665,9 @@ #define LV_USE_QRCODE 0 /*FreeType library*/ +#ifndef LV_USE_FREETYPE #define LV_USE_FREETYPE 0 +#endif // LV_USE_FREETYPE #if LV_USE_FREETYPE /*Memory used by FreeType to cache characters [bytes] (-1: no caching)*/ #define LV_FREETYPE_CACHE_SIZE (16 * 1024) @@ -639,7 +688,9 @@ /*FFmpeg library for image decoding and playing videos *Supports all major image formats so do not enable other image decoder with it*/ +#ifndef LV_USE_FFMPEG #define LV_USE_FFMPEG 0 +#endif // LV_USE_FFMPEG #if LV_USE_FFMPEG /*Dump input information to stderr*/ #define LV_FFMPEG_AV_DUMP_FORMAT 0 @@ -670,7 +721,9 @@ ====================*/ /*Show some widget. It might be required to increase `LV_MEM_SIZE` */ +#ifndef LV_USE_DEMO_WIDGETS #define LV_USE_DEMO_WIDGETS 0 +#endif // LV_USE_DEMO_WIDGETS #if LV_USE_DEMO_WIDGETS #define LV_DEMO_WIDGETS_SLIDESHOW 0 #endif @@ -685,7 +738,9 @@ #define LV_USE_DEMO_STRESS 0 /*Music player demo*/ +#ifndef LV_USE_DEMO_MUSIC #define LV_USE_DEMO_MUSIC 0 +#endif // LV_USE_DEMO_MUSIC #if LV_USE_DEMO_MUSIC # define LV_DEMO_MUSIC_SQUARE 0 # define LV_DEMO_MUSIC_LANDSCAPE 0 diff --git a/quantum/main.c b/quantum/main.c index 77af20b2445d..ea440469fa62 100644 --- a/quantum/main.c +++ b/quantum/main.c @@ -64,11 +64,11 @@ int main(void) { void qp_internal_animation_tick(void); qp_internal_animation_tick(); - #ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE - // Run LVGL ticks - void qp_lvgl_internal_tick(void); - qp_lvgl_internal_tick(); - #endif +# ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE + // Run LVGL ticks + void qp_lvgl_internal_tick(void); + qp_lvgl_internal_tick(); +# endif #endif #ifdef DEFERRED_EXEC_ENABLE diff --git a/quantum/painter/lvgl/qp_lvgl.c b/quantum/painter/lvgl/qp_lvgl.c index d1b06aab1311..a19aabed47f4 100644 --- a/quantum/painter/lvgl/qp_lvgl.c +++ b/quantum/painter/lvgl/qp_lvgl.c @@ -1,40 +1,46 @@ // Copyright 2022 Jose Pablo Ramirez (@jpe230) +// Copyright 2022 Nick Brassel (@tzarc) // SPDX-License-Identifier: GPL-2.0-or-later #include "qp_lvgl.h" +#include "timer.h" #include "deferred_exec.h" #include "lvgl.h" typedef struct lvgl_state_t { - uint8_t fnc_id; // Ideally this should be the pointer of the function to run - uint16_t delay_ms; - deferred_token defer_token; + uint8_t fnc_id; // Ideally this should be the pointer of the function to run + uint16_t delay_ms; + deferred_token defer_token; } lvgl_state_t; static deferred_executor_t lvgl_executors[2] = {0}; // For lv_tick_inc and lv_task_handler static lvgl_state_t lvgl_states[2] = {0}; // For lv_tick_inc and lv_task_handler -painter_device_t selected_display; +painter_device_t selected_display = NULL; +void * color_buffer = NULL; //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Quantum Painter LVGL Integration Internal: qp_lvgl_flush -void qp_lvgl_flush(lv_disp_drv_t * disp, const lv_area_t * area, lv_color_t * color_p) { - uint32_t number_pixels = (area->x2 - area->x1 + 1) * (area->y2 - area->y1 + 1); - qp_viewport(selected_display, area->x1, area->y1, area->x2, area->y2); - qp_pixdata(selected_display, (void *)color_p, number_pixels); - qp_flush(selected_display); - lv_disp_flush_ready(disp); +void qp_lvgl_flush(lv_disp_drv_t *disp, const lv_area_t *area, lv_color_t *color_p) { + if (selected_display) { + uint32_t number_pixels = (area->x2 - area->x1 + 1) * (area->y2 - area->y1 + 1); + qp_viewport(selected_display, area->x1, area->y1, area->x2, area->y2); + qp_pixdata(selected_display, (void *)color_p, number_pixels); + qp_flush(selected_display); + lv_disp_flush_ready(disp); + } } static uint32_t tick_task_callback(uint32_t trigger_time, void *cb_arg) { - lvgl_state_t *state = (lvgl_state_t *)cb_arg; - - switch (state->fnc_id) - { - case 0: - lv_tick_inc(1); - break; + lvgl_state_t * state = (lvgl_state_t *)cb_arg; + static uint32_t last_tick = 0; + switch (state->fnc_id) { + case 0: { + uint32_t now = timer_read32(); + lv_tick_inc(TIMER_DIFF_32(now, last_tick)); + last_tick = now; + } break; case 1: lv_task_handler(); break; @@ -48,67 +54,85 @@ static uint32_t tick_task_callback(uint32_t trigger_time, void *cb_arg) { } //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// Quantum Painter LVGL Integration API: qp_lvgl_start +// Quantum Painter LVGL Integration API: qp_lvgl_attach -bool qp_lvgl_start(painter_device_t device) { +bool qp_lvgl_attach(painter_device_t device) { qp_dprintf("qp_lvgl_start: entry\n"); + qp_lvgl_detach(); struct painter_driver_t *driver = (struct painter_driver_t *)device; if (!driver->validate_ok) { - qp_dprintf("qp_lvgl_start: fail (validation_ok == false)\n"); + qp_dprintf("qp_lvgl_attach: fail (validation_ok == false)\n"); + qp_lvgl_detach(); return false; } - selected_display = device; - // Setting up the tasks lvgl_state_t *lv_tick_inc_state = &lvgl_states[0]; - lv_tick_inc_state->fnc_id = 0; - lv_tick_inc_state->delay_ms = 1; - lv_tick_inc_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 1, tick_task_callback, lv_tick_inc_state); + lv_tick_inc_state->fnc_id = 0; + lv_tick_inc_state->delay_ms = 1; + lv_tick_inc_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 1, tick_task_callback, lv_tick_inc_state); if (lv_tick_inc_state->defer_token == INVALID_DEFERRED_TOKEN) { - qp_dprintf("qp_lvgl_start_tasks: fail (could not set up qp_lvgl executor)\n"); + qp_dprintf("qp_lvgl_attach: fail (could not set up qp_lvgl executor)\n"); + qp_lvgl_detach(); return false; } lvgl_state_t *lv_task_handler_state = &lvgl_states[1]; - lv_task_handler_state->fnc_id = 1; - lv_task_handler_state->delay_ms = 5; - lv_task_handler_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 5, tick_task_callback, lv_task_handler_state); + lv_task_handler_state->fnc_id = 1; + lv_task_handler_state->delay_ms = 5; + lv_task_handler_state->defer_token = defer_exec_advanced(lvgl_executors, 2, 5, tick_task_callback, lv_task_handler_state); if (lv_task_handler_state->defer_token == INVALID_DEFERRED_TOKEN) { - qp_dprintf("qp_lvgl_start_tasks: fail (could not set up qp_lvgl executor)\n"); + qp_dprintf("qp_lvgl_attach: fail (could not set up qp_lvgl executor)\n"); + qp_lvgl_detach(); return false; } // Init LVGL lv_init(); - // Setting up lvgl display buffer + // Set up lvgl display buffer static lv_disp_draw_buf_t draw_buf; - static lv_color_t color_buffer[QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*(QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT / 10)]; /*Declare a buffer for 1/10 screen size*/ - lv_disp_draw_buf_init(&draw_buf, color_buffer, NULL, QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH*(QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT / 10)); /*Initialize the display buffer.*/ + // Allocate a buffer for 1/16 screen size + const size_t count_required = driver->panel_width * driver->panel_height / 16; + color_buffer = color_buffer ? realloc(color_buffer, sizeof(lv_color_t) * count_required) : malloc(sizeof(lv_color_t) * count_required); + if (!color_buffer) { + qp_dprintf("qp_lvgl_attach: fail (could not set up memory buffer)\n"); + qp_lvgl_detach(); + return false; + } + memset(color_buffer, 0, sizeof(lv_color_t) * count_required); + // Initialize the display buffer. + lv_disp_draw_buf_init(&draw_buf, color_buffer, NULL, count_required); + + selected_display = device; // Setting up display driver - static lv_disp_drv_t disp_drv; /*Descriptor of a display driver*/ - lv_disp_drv_init(&disp_drv); /*Basic initialization*/ - disp_drv.flush_cb = qp_lvgl_flush; /*Set your driver function*/ - disp_drv.draw_buf = &draw_buf; /*Assign the buffer to the display*/ - disp_drv.hor_res = QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH; /*Set the horizontal resolution of the display*/ - disp_drv.ver_res = QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT; /*Set the vertical resolution of the display*/ - lv_disp_drv_register(&disp_drv); /*Finally register the driver*/ + static lv_disp_drv_t disp_drv; /*Descriptor of a display driver*/ + lv_disp_drv_init(&disp_drv); /*Basic initialization*/ + disp_drv.flush_cb = qp_lvgl_flush; /*Set your driver function*/ + disp_drv.draw_buf = &draw_buf; /*Assign the buffer to the display*/ + disp_drv.hor_res = driver->panel_width; /*Set the horizontal resolution of the display*/ + disp_drv.ver_res = driver->panel_height; /*Set the vertical resolution of the display*/ + lv_disp_drv_register(&disp_drv); /*Finally register the driver*/ return true; } //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// Quantum Painter LVGL Integration API: qp_lvgl_stop_tasks +// Quantum Painter LVGL Integration API: qp_lvgl_detach -void qp_lvgl_stop_tasks() { +void qp_lvgl_detach(void) { for (int i = 0; i < 2; ++i) { cancel_deferred_exec_advanced(lvgl_executors, 2, lvgl_states[i].defer_token); } + if (color_buffer) { + free(color_buffer); + color_buffer = NULL; + } + selected_display = NULL; } //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// diff --git a/quantum/painter/lvgl/qp_lvgl.h b/quantum/painter/lvgl/qp_lvgl.h index 6f43fe32df48..5c303d66c353 100644 --- a/quantum/painter/lvgl/qp_lvgl.h +++ b/quantum/painter/lvgl/qp_lvgl.h @@ -1,61 +1,30 @@ // Copyright 2022 Jose Pablo Ramirez (@jpe230) +// Copyright 2022 Nick Brassel (@tzarc) // SPDX-License-Identifier: GPL-2.0-or-later #pragma once #include "qp.h" -//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// Quantum Painter - LVGL global configurables (add to your keyboard's config.h) - -#ifndef QUANTUM_PAINTER_LVGL_INIT_DELAY -/** - * @def This controls the delay to start the deferred execution of the LVGL task. - */ -# define QUANTUM_PAINTER_LVGL_INIT_DELAY 5 -#endif // QUANTUM_PAINTER_LVGL_INIT_DELAY - -#ifndef QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH -/** - * @def Define width of display - */ -# define QUANTUM_PAINTER_LVGL_DISPLAY_WIDTH 240 -#endif // QUANTUM_PAINTER_LVGL_DISPLaY_WIDTH - -#ifndef QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT -/** - * @def Define height of display - */ -# define QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT 240 -#endif // QUANTUM_PAINTER_LVGL_DISPLAY_HEIGHT - -#ifndef QUANTUM_PAINTER_LVGL_COLOR_DEPTH -/** - * @def Define color depth of display: 1 (1 byte per pixel), 8 (RGB332), 16 (RGB565), 32 (ARGB8888) - */ -# define QUANTUM_PAINTER_LVGL_COLOR_DEPTH 16 -#endif // QUANTUM_PAINTER_LVGL_COLOR_DEPTH - -#ifndef QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES -/** - * @def Define if LVGL should swap HILOW bits for 16-bit color displays - */ -# define QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES 1 -#endif // QUANTUM_PAINTER_LVGL_16BIT_SWAP_BYTES +#if __has_include("lvgl/lvgl.h") +# include "lvgl/lvgl.h" +#else +# include "lvgl.h" +#endif //__has_include("lvgl.h") //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Quantum Painter - LVGL External API /** - * Sets ups LVGL. + * Sets up LVGL with the supplied display. * * @param device[in] the handle of the device to control * @return true if init. of LVGL succeeded * @return false if init. of LVGL failed */ -bool qp_lvgl_start(painter_device_t device); +bool qp_lvgl_attach(painter_device_t device); /** - * Stops the tasks used by LVGL. + * Disconnects LVGL from any attached display */ -void qp_lvgl_stop_tasks(void); +void qp_lvgl_detach(void); diff --git a/quantum/painter/lvgl/rules.mk b/quantum/painter/lvgl/rules.mk index ca6616a65d77..50226941b35a 100644 --- a/quantum/painter/lvgl/rules.mk +++ b/quantum/painter/lvgl/rules.mk @@ -1,32 +1,24 @@ # LVGL Integration -OPT_DEFS += -DQUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE +OPT_DEFS += -DQUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE -DLV_CONF_INCLUDE_SIMPLE DEFERRED_EXEC_ENABLE := yes LVGL_DIR_NAME = lvgl LVGL_DIR = $(LIB_DIR) LVGL_PATH = $(LVGL_DIR)/$(LVGL_DIR_NAME) -ifeq ($(strip $(QUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF)), yes) - OPT_DEFS += -DLV_CONF_INCLUDE_SIMPLE - OPT_DEFS += -DQUANTUM_PAINTER_LVGL_USE_CUSTOM_CONF -endif - -COMMON_VPATH += \ +COMMON_VPATH += $(PLATFORM_PATH) \ $(QUANTUM_DIR)/painter/$(LVGL_DIR_NAME) \ $(LVGL_PATH) -SRC += $(QUANTUM_DIR)/painter/$(LVGL_DIR_NAME)/qp_lvgl.c -SRC += $(shell find $(LVGL_PATH)/src -type f -name '*.c') -CFLAGS += "-I$(LVGL_PATH)" - -# Fix this: Should include their makefile +include $(LVGL_PATH)/src/extra/extra.mk +include $(LVGL_PATH)/src/core/lv_core.mk +include $(LVGL_PATH)/src/draw/lv_draw.mk +include $(LVGL_PATH)/src/draw/sw/lv_draw_sw.mk +include $(LVGL_PATH)/src/font/lv_font.mk +include $(LVGL_PATH)/src/hal/lv_hal.mk +include $(LVGL_PATH)/src/misc/lv_misc.mk +include $(LVGL_PATH)/src/widgets/lv_widgets.mk -# include $(LVGL_PATH)/src/extra/extra.mk -# include $(LVGL_PATH)/src/core/lv_core.mk -# include $(LVGL_PATH)/src/draw/lv_draw.mk -# include $(LVGL_PATH)/src/draw/sw/lv_draw_sw.mk -# include $(LVGL_PATH)/src/font/lv_font.mk -# include $(LVGL_PATH)/src/hal/lv_hal.mk -# include $(LVGL_PATH)/src/misc/lv_misc.mk -# include $(LVGL_PATH)/src/widgets/lv_widgets.mk +SRC += qp_lvgl.c \ + $(CSRCS) diff --git a/quantum/painter/rules.mk b/quantum/painter/rules.mk index 75d22fe6ed04..199e406dd6f4 100644 --- a/quantum/painter/rules.mk +++ b/quantum/painter/rules.mk @@ -2,6 +2,8 @@ QUANTUM_PAINTER_DRIVERS ?= QUANTUM_PAINTER_ANIMATIONS_ENABLE ?= yes +QUANTUM_PAINTER_LVGL_INTEGRATION ?= no + # The list of permissible drivers that can be listed in QUANTUM_PAINTER_DRIVERS VALID_QUANTUM_PAINTER_DRIVERS := \ rgb565_surface \ From cc8fbedd0ebfdcdea094659136946ecc2e0ca100 Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Tue, 27 Sep 2022 07:11:18 +1000 Subject: [PATCH 05/12] Auto-include LVGL. --- quantum/painter/qp.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/quantum/painter/qp.h b/quantum/painter/qp.h index 69bc43596125..e5f595d71d5a 100644 --- a/quantum/painter/qp.h +++ b/quantum/painter/qp.h @@ -463,3 +463,10 @@ int16_t qp_drawtext_recolor(painter_device_t device, uint16_t x, uint16_t y, pai #ifdef QUANTUM_PAINTER_SSD1351_ENABLE # include "qp_ssd1351.h" #endif // QUANTUM_PAINTER_SSD1351_ENABLE + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter Extras + +#ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE +# include "qp_lvgl.h" +#endif // QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE From 5c1d7c8f087214aa595d8442f1309ad6394ab0c6 Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Tue, 27 Sep 2022 07:41:59 +1000 Subject: [PATCH 06/12] Review. --- quantum/painter/lvgl/qp_lvgl.c | 4 ++-- quantum/painter/lvgl/qp_lvgl.h | 7 +------ 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/quantum/painter/lvgl/qp_lvgl.c b/quantum/painter/lvgl/qp_lvgl.c index a19aabed47f4..41ca3f98c248 100644 --- a/quantum/painter/lvgl/qp_lvgl.c +++ b/quantum/painter/lvgl/qp_lvgl.c @@ -95,8 +95,8 @@ bool qp_lvgl_attach(painter_device_t device) { // Set up lvgl display buffer static lv_disp_draw_buf_t draw_buf; - // Allocate a buffer for 1/16 screen size - const size_t count_required = driver->panel_width * driver->panel_height / 16; + // Allocate a buffer for 1/10 screen size + const size_t count_required = driver->panel_width * driver->panel_height / 10; color_buffer = color_buffer ? realloc(color_buffer, sizeof(lv_color_t) * count_required) : malloc(sizeof(lv_color_t) * count_required); if (!color_buffer) { qp_dprintf("qp_lvgl_attach: fail (could not set up memory buffer)\n"); diff --git a/quantum/painter/lvgl/qp_lvgl.h b/quantum/painter/lvgl/qp_lvgl.h index 5c303d66c353..d9ad5e8df1ef 100644 --- a/quantum/painter/lvgl/qp_lvgl.h +++ b/quantum/painter/lvgl/qp_lvgl.h @@ -5,12 +5,7 @@ #pragma once #include "qp.h" - -#if __has_include("lvgl/lvgl.h") -# include "lvgl/lvgl.h" -#else -# include "lvgl.h" -#endif //__has_include("lvgl.h") +#include "lvgl.h" //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Quantum Painter - LVGL External API From 166623787cfa9de09b57e9c4512acd547971cdf1 Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Mon, 26 Sep 2022 20:26:06 -0500 Subject: [PATCH 07/12] Add LVGL documentation --- docs/_summary.md | 1 + docs/quantum_painter_lvgl.md | 53 ++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/quantum_painter_lvgl.md diff --git a/docs/_summary.md b/docs/_summary.md index ca6fb91a79c7..29eed54339ec 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -99,6 +99,7 @@ * Hardware Features * Displays * [Quantum Painter](quantum_painter.md) + * [ Quantum Painter LVGL Integration](quantum_painter_lvgl.md) * [HD44780 LCD Driver](feature_hd44780.md) * [ST7565 LCD Driver](feature_st7565.md) * [OLED Driver](feature_oled_driver.md) diff --git a/docs/quantum_painter_lvgl.md b/docs/quantum_painter_lvgl.md new file mode 100644 index 000000000000..6dbf126d8cf4 --- /dev/null +++ b/docs/quantum_painter_lvgl.md @@ -0,0 +1,53 @@ +# Quantum Painter LVGL Integration :id=lvgl + +LVGL (Light and Versatile Graphics Library) is an open-source graphics library providing everything you need to create an embedded GUI for your board with easy-to-use graphical elements. + +LVGL integrates with [Quantum Painter's](quantum_painter.md) API and drivers to render to the display, the hardware supported by Quantum Painter is also supported by LVGL. + +?> Keep in mind that enabling the LVGL integration has a big impact in firmware size, it is recommeded to use a supported MCU with >256 kB of flash space. + +To learn more about LVGL and how to use it please take a look at their [official documentation](https://docs.lvgl.io/8.2/intro/) + +## Enabling LVGL :id=lvgl-enabling +To enable LVGL to be built into your firmware, add the following to `rules.mk`: + +```make +QUANTUM_PAINTER_ENABLE = yes +QUANTUM_PAINTER_DRIVERS = ...... +QUANTUM_PAINTER_LVGL_INTEGRATION = yes +``` +To configure the Quantum Painter Display Drivers please read the [Quantum Painter Display Drivers](quantum_painter.md#quantum-painter-drivers) section. + +## Quantum Painter LVGL API :id=lvgl-api + +### Quantum Painter LVGL Attach :id=lvgl-api-init + +```c +bool qp_lvgl_attach(painter_device_t device) +``` + +The `qp_lvgl_attach` function is used to set up LVGL with the supplied display, it requires an already configured display. + +```c +static painter_device_t display; +void keyboard_post_init_kb(void) { + display = qp_make_.......; // Create the display + qp_init(display, QP_ROTATION_0); // Initialise the display + + if (qp_lvgl_attach(display)) { // Attach LVGL to the display + ...Your code to draw // Run LVGL specific code to draw + } +} +``` +To init. the display please read the [Display Initialisation](quantum_painter.md#quantum-painter-api-init) section. + +### Quantum Painter LVGL Detach :id=lvgl-api-init + +```c +void qp_lvgl_detach() +``` + +The `qp_lvgl_detach` function stops the internal LVGL ticks and releases resources related to it. + +## Enabling/Disabling LVGL features :id=lvgl-configuring +You can overwrite LVGL specific features in your `lv_conf.h` file. From 4463ac7fb01f73b8196239c06557be984d680adf Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Mon, 26 Sep 2022 20:40:40 -0500 Subject: [PATCH 08/12] Add LVGL onekey keymap --- .../handwired/onekey/keymaps/lvgl/config.h | 10 ++++ .../handwired/onekey/keymaps/lvgl/halconf.h | 9 ++++ .../handwired/onekey/keymaps/lvgl/keymap.c | 47 +++++++++++++++++++ .../handwired/onekey/keymaps/lvgl/mcuconf.h | 6 +++ .../handwired/onekey/keymaps/lvgl/rules.mk | 3 ++ 5 files changed, 75 insertions(+) create mode 100644 keyboards/handwired/onekey/keymaps/lvgl/config.h create mode 100644 keyboards/handwired/onekey/keymaps/lvgl/halconf.h create mode 100644 keyboards/handwired/onekey/keymaps/lvgl/keymap.c create mode 100644 keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h create mode 100644 keyboards/handwired/onekey/keymaps/lvgl/rules.mk diff --git a/keyboards/handwired/onekey/keymaps/lvgl/config.h b/keyboards/handwired/onekey/keymaps/lvgl/config.h new file mode 100644 index 000000000000..acc4a0d4f304 --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/lvgl/config.h @@ -0,0 +1,10 @@ +/* SPI pins */ +#define SPI_DRIVER SPID0 +#define SPI_SCK_PIN GP18 +#define SPI_MOSI_PIN GP19 +#define SPI_MISO_PIN GP20 + +/* LCD Configuration */ +#define LCD_RST_PIN GP0 +#define LCD_DC_PIN GP1 +#define LCD_CS_PIN GP2 diff --git a/keyboards/handwired/onekey/keymaps/lvgl/halconf.h b/keyboards/handwired/onekey/keymaps/lvgl/halconf.h new file mode 100644 index 000000000000..9b90dca4c6f2 --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/lvgl/halconf.h @@ -0,0 +1,9 @@ +#pragma once + +#include_next + +#undef HAL_USE_SPI +#define HAL_USE_SPI TRUE + +#undef SPI_USE_WAIT +#define SPI_USE_WAIT TRUE diff --git a/keyboards/handwired/onekey/keymaps/lvgl/keymap.c b/keyboards/handwired/onekey/keymaps/lvgl/keymap.c new file mode 100644 index 000000000000..4f3e36d02433 --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/lvgl/keymap.c @@ -0,0 +1,47 @@ +#include QMK_KEYBOARD_H +#include "qp.h" + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + LAYOUT_ortho_1x1(JS_BUTTON0) +}; + +painter_device_t lcd; + +void lv_example_arc_2(void); + +void keyboard_post_init_user(void) { + lcd = qp_gc9a01_make_spi_device(240, 240, LCD_CS_PIN, LCD_DC_PIN, LCD_RST_PIN, 4, 0); + qp_init(lcd, QP_ROTATION_0); + qp_rect(lcd, 0, 0, 239, 319, 0, 255, 255, true); + + if (qp_lvgl_attach(lcd)) { + lv_example_arc_2(); + } +} + +static void set_angle(void* obj, int32_t v) { + lv_arc_set_value(obj, v); +} + +/** + * Create an arc which acts as a loader. + */ +void lv_example_arc_2(void) { + /*Create an Arc*/ + lv_obj_t* arc = lv_arc_create(lv_scr_act()); + lv_arc_set_rotation(arc, 270); + lv_arc_set_bg_angles(arc, 0, 360); + lv_obj_remove_style(arc, NULL, LV_PART_KNOB); /*Be sure the knob is not displayed*/ + lv_obj_clear_flag(arc, LV_OBJ_FLAG_CLICKABLE); /*To not allow adjusting by click*/ + lv_obj_center(arc); + + static lv_anim_t a; + lv_anim_init(&a); + lv_anim_set_var(&a, arc); + lv_anim_set_exec_cb(&a, set_angle); + lv_anim_set_time(&a, 1000); + lv_anim_set_repeat_count(&a, LV_ANIM_REPEAT_INFINITE); /*Just for the demo*/ + lv_anim_set_repeat_delay(&a, 500); + lv_anim_set_values(&a, 0, 100); + lv_anim_start(&a); +} diff --git a/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h b/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h new file mode 100644 index 000000000000..969514e4c4ac --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h @@ -0,0 +1,6 @@ +#pragma once + +#include_next + +#undef RP_SPI_USE_SPI0 +#define RP_SPI_USE_SPI0 TRUE diff --git a/keyboards/handwired/onekey/keymaps/lvgl/rules.mk b/keyboards/handwired/onekey/keymaps/lvgl/rules.mk new file mode 100644 index 000000000000..872d12ad6f4c --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/lvgl/rules.mk @@ -0,0 +1,3 @@ +QUANTUM_PAINTER_ENABLE = yes +QUANTUM_PAINTER_LVGL_INTEGRATION = yes +QUANTUM_PAINTER_DRIVERS = gc9a01_spi From 4bf554ea5e84b227b1d3d69f939c5fe4ff1385ac Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Mon, 26 Sep 2022 22:33:30 -0500 Subject: [PATCH 09/12] Update LVGL origin --- .gitmodules | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitmodules b/.gitmodules index cbb225edf56a..7d8dbcb4ed0f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -23,5 +23,5 @@ url = https://github.com/qmk/pico-sdk.git [submodule "lib/lvgl"] path = lib/lvgl - url = https://github.com/lvgl/lvgl.git - branch = release/v8.2 + url = https://github.com/qmk/lvgl.git + branch = release/v8.2 From 9336329ba1d77ed7e263a2b96cf546a874fe1b4e Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Mon, 26 Sep 2022 22:53:02 -0500 Subject: [PATCH 10/12] Apply review --- .../config-overrides}/chibios/board.h | 0 .../config-overrides}/chibios/chconf.h | 0 .../config-overrides}/chibios/halconf.h | 0 .../config-overrides}/chibios/mcuconf.h | 0 .../config-overrides}/common/lv_conf.h | 0 keyboards/handwired/onekey/keymaps/lvgl/config.h | 5 +++++ keyboards/handwired/onekey/keymaps/lvgl/halconf.h | 3 +++ keyboards/handwired/onekey/keymaps/lvgl/keymap.c | 3 +++ keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h | 3 +++ quantum/main.c | 12 +++--------- quantum/painter/qp_draw_image.c | 12 ++++++++++++ 11 files changed, 29 insertions(+), 9 deletions(-) rename data/{keyboard-config-templates => templates/config-overrides}/chibios/board.h (100%) rename data/{keyboard-config-templates => templates/config-overrides}/chibios/chconf.h (100%) rename data/{keyboard-config-templates => templates/config-overrides}/chibios/halconf.h (100%) rename data/{keyboard-config-templates => templates/config-overrides}/chibios/mcuconf.h (100%) rename data/{keyboard-config-templates => templates/config-overrides}/common/lv_conf.h (100%) diff --git a/data/keyboard-config-templates/chibios/board.h b/data/templates/config-overrides/chibios/board.h similarity index 100% rename from data/keyboard-config-templates/chibios/board.h rename to data/templates/config-overrides/chibios/board.h diff --git a/data/keyboard-config-templates/chibios/chconf.h b/data/templates/config-overrides/chibios/chconf.h similarity index 100% rename from data/keyboard-config-templates/chibios/chconf.h rename to data/templates/config-overrides/chibios/chconf.h diff --git a/data/keyboard-config-templates/chibios/halconf.h b/data/templates/config-overrides/chibios/halconf.h similarity index 100% rename from data/keyboard-config-templates/chibios/halconf.h rename to data/templates/config-overrides/chibios/halconf.h diff --git a/data/keyboard-config-templates/chibios/mcuconf.h b/data/templates/config-overrides/chibios/mcuconf.h similarity index 100% rename from data/keyboard-config-templates/chibios/mcuconf.h rename to data/templates/config-overrides/chibios/mcuconf.h diff --git a/data/keyboard-config-templates/common/lv_conf.h b/data/templates/config-overrides/common/lv_conf.h similarity index 100% rename from data/keyboard-config-templates/common/lv_conf.h rename to data/templates/config-overrides/common/lv_conf.h diff --git a/keyboards/handwired/onekey/keymaps/lvgl/config.h b/keyboards/handwired/onekey/keymaps/lvgl/config.h index acc4a0d4f304..38bb5d0cf353 100644 --- a/keyboards/handwired/onekey/keymaps/lvgl/config.h +++ b/keyboards/handwired/onekey/keymaps/lvgl/config.h @@ -1,3 +1,8 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + /* SPI pins */ #define SPI_DRIVER SPID0 #define SPI_SCK_PIN GP18 diff --git a/keyboards/handwired/onekey/keymaps/lvgl/halconf.h b/keyboards/handwired/onekey/keymaps/lvgl/halconf.h index 9b90dca4c6f2..27646bb3f511 100644 --- a/keyboards/handwired/onekey/keymaps/lvgl/halconf.h +++ b/keyboards/handwired/onekey/keymaps/lvgl/halconf.h @@ -1,3 +1,6 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + #pragma once #include_next diff --git a/keyboards/handwired/onekey/keymaps/lvgl/keymap.c b/keyboards/handwired/onekey/keymaps/lvgl/keymap.c index 4f3e36d02433..be1ba48cf9bd 100644 --- a/keyboards/handwired/onekey/keymaps/lvgl/keymap.c +++ b/keyboards/handwired/onekey/keymaps/lvgl/keymap.c @@ -1,3 +1,6 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + #include QMK_KEYBOARD_H #include "qp.h" diff --git a/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h b/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h index 969514e4c4ac..bff74867ff04 100644 --- a/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h +++ b/keyboards/handwired/onekey/keymaps/lvgl/mcuconf.h @@ -1,3 +1,6 @@ +// Copyright 2022 Jose Pablo Ramirez (@jpe230) +// SPDX-License-Identifier: GPL-2.0-or-later + #pragma once #include_next diff --git a/quantum/main.c b/quantum/main.c index ea440469fa62..3b101c522c37 100644 --- a/quantum/main.c +++ b/quantum/main.c @@ -60,15 +60,9 @@ int main(void) { protocol_task(); #ifdef QUANTUM_PAINTER_ENABLE - // Run Quantum Painter animations - void qp_internal_animation_tick(void); - qp_internal_animation_tick(); - -# ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE - // Run LVGL ticks - void qp_lvgl_internal_tick(void); - qp_lvgl_internal_tick(); -# endif + // Run Quantum Painter task + void qp_internal_task(void); + qp_internal_task(); #endif #ifdef DEFERRED_EXEC_ENABLE diff --git a/quantum/painter/qp_draw_image.c b/quantum/painter/qp_draw_image.c index e9b975f23a6c..943cbfef5be8 100644 --- a/quantum/painter/qp_draw_image.c +++ b/quantum/painter/qp_draw_image.c @@ -399,3 +399,15 @@ void qp_internal_animation_tick(void) { static uint32_t last_anim_exec = 0; deferred_exec_advanced_task(animation_executors, QUANTUM_PAINTER_CONCURRENT_ANIMATIONS, &last_anim_exec); } + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Quantum Painter Core API: qp_internal_task + +void qp_internal_task(void) { + qp_internal_animation_tick(); +#ifdef QUANTUM_PAINTER_LVGL_INTEGRATION_ENABLE + // Run LVGL ticks + void qp_lvgl_internal_tick(void); + qp_lvgl_internal_tick(); +#endif +} From 778a51702cb551fe2e3ed474785fb929cf2d5d87 Mon Sep 17 00:00:00 2001 From: jpe230 Date: Fri, 14 Oct 2022 12:39:29 -0500 Subject: [PATCH 11/12] Apply suggestions from code review Co-authored-by: Nick Brassel --- docs/_summary.md | 2 +- docs/quantum_painter_lvgl.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/_summary.md b/docs/_summary.md index 29eed54339ec..8a53a749d31a 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -99,7 +99,7 @@ * Hardware Features * Displays * [Quantum Painter](quantum_painter.md) - * [ Quantum Painter LVGL Integration](quantum_painter_lvgl.md) + * [Quantum Painter LVGL Integration](quantum_painter_lvgl.md) * [HD44780 LCD Driver](feature_hd44780.md) * [ST7565 LCD Driver](feature_st7565.md) * [OLED Driver](feature_oled_driver.md) diff --git a/docs/quantum_painter_lvgl.md b/docs/quantum_painter_lvgl.md index 6dbf126d8cf4..3edb37fbcef3 100644 --- a/docs/quantum_painter_lvgl.md +++ b/docs/quantum_painter_lvgl.md @@ -23,10 +23,10 @@ To configure the Quantum Painter Display Drivers please read the [Quantum Painte ### Quantum Painter LVGL Attach :id=lvgl-api-init ```c -bool qp_lvgl_attach(painter_device_t device) +bool qp_lvgl_attach(painter_device_t device); ``` -The `qp_lvgl_attach` function is used to set up LVGL with the supplied display, it requires an already configured display. +The `qp_lvgl_attach` function is used to set up LVGL with the supplied display, and requires an already configured display. ```c static painter_device_t display; @@ -41,6 +41,7 @@ void keyboard_post_init_kb(void) { ``` To init. the display please read the [Display Initialisation](quantum_painter.md#quantum-painter-api-init) section. +!> Attaching LVGL to a display means LVGL subsequently "owns" the display. Using standard Quantum Painter drawing operations with the display after LVGL attachment will likely result in display artifacts. ### Quantum Painter LVGL Detach :id=lvgl-api-init ```c @@ -50,4 +51,5 @@ void qp_lvgl_detach() The `qp_lvgl_detach` function stops the internal LVGL ticks and releases resources related to it. ## Enabling/Disabling LVGL features :id=lvgl-configuring + You can overwrite LVGL specific features in your `lv_conf.h` file. From 1b69b5147a818e2be8e4f851d2ffcdf1defee49e Mon Sep 17 00:00:00 2001 From: "pablin.123.ra@gmail.com" Date: Fri, 14 Oct 2022 12:42:43 -0500 Subject: [PATCH 12/12] Remove lvgl if present --- Makefile | 2 ++ util/size_regression.sh | 1 + 2 files changed, 3 insertions(+) diff --git a/Makefile b/Makefile index a418576c073f..e5333578460d 100644 --- a/Makefile +++ b/Makefile @@ -402,6 +402,7 @@ ifndef SKIP_GIT if [ ! -e lib/vusb ]; then git submodule sync lib/vusb && git submodule update --depth 50 --init lib/vusb; fi if [ ! -e lib/printf ]; then git submodule sync lib/printf && git submodule update --depth 50 --init lib/printf; fi if [ ! -e lib/pico-sdk ]; then git submodule sync lib/pico-sdk && git submodule update --depth 50 --init lib/pico-sdk; fi + if [ ! -e lib/lvgl ]; then git submodule sync lib/lvgl && git submodule update --depth 50 --init lib/lvgl; fi git submodule status --recursive 2>/dev/null | \ while IFS= read -r x; do \ case "$$x" in \ @@ -432,6 +433,7 @@ git-submodule: [ -e lib/ugfx ] && rm -rf lib/ugfx || true [ -e lib/pico-sdk ] && rm -rf lib/pico-sdk || true [ -e lib/chibios-contrib/ext/mcux-sdk ] && rm -rf lib/chibios-contrib/ext/mcux-sdk || true + [ -e lib/lvgl ] && rm -rf lib/lvgl || true git submodule sync --recursive git submodule update --init --recursive --progress diff --git a/util/size_regression.sh b/util/size_regression.sh index 6da2d360bb93..96555c651957 100755 --- a/util/size_regression.sh +++ b/util/size_regression.sh @@ -64,6 +64,7 @@ fixup_submodules() { [ -e lib/ugfx ] && rm -rf lib/ugfx [ -e lib/pico-sdk ] && rm -rf lib/pico-sdk [ -e lib/chibios-contrib/ext/mcux-sdk ] && rm -rf lib/chibios-contrib/ext/mcux-sdk + [ -e lib/lvgl ] && rm -rf lib/lvgl make git-submodule }