Skip to content

Add configuration option to circumvent internal task creation (BSP-726) #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add configuration option to circumvent internal task creation (BSP-726) #658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59988ae
Add configuration option to circumvent internal task creation
Maldus512 Oct 7, 2025
f011770
Removed unneded config dependency
Maldus512 Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/esp_lvgl_port/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,10 @@ menu "ESP LVGL PORT"
help
Enables using PPA for screen rotation.

config LVGL_PORT_INTERNAL_TASK
bool "Use an internal task for LVGL management"
default y
help
If true, creates an internal task to handle LVGL management. If false the developer is responsible for initializing the stack and calling functions like `lv_timer_handle` and `lv_tick_inc`.

endmenu
30 changes: 29 additions & 1 deletion components/esp_lvgl_port/src/lvgl8/esp_lvgl_port.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ typedef struct lvgl_port_ctx_s {
/*******************************************************************************
* Local variables
*******************************************************************************/
#if CONFIG_LVGL_PORT_INTERNAL_TASK
static lvgl_port_ctx_t lvgl_port_ctx;

/*******************************************************************************
Expand All @@ -47,13 +48,15 @@ static lvgl_port_ctx_t lvgl_port_ctx;
static void lvgl_port_task(void *arg);
static esp_err_t lvgl_port_tick_init(void);
static void lvgl_port_task_deinit(void);
#endif

/*******************************************************************************
* Public API functions
*******************************************************************************/

esp_err_t lvgl_port_init(const lvgl_port_cfg_t *cfg)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_OK;
ESP_GOTO_ON_FALSE(cfg, ESP_ERR_INVALID_ARG, err, TAG, "invalid argument");
ESP_GOTO_ON_FALSE(cfg->task_affinity < (configNUM_CORES), ESP_ERR_INVALID_ARG, err, TAG, "Bad core number for task! Maximum core number is %d", (configNUM_CORES - 1));
Expand Down Expand Up @@ -92,10 +95,14 @@ esp_err_t lvgl_port_init(const lvgl_port_cfg_t *cfg)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_resume(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_ERR_INVALID_STATE;

if (lvgl_port_ctx.tick_timer != NULL) {
Expand All @@ -104,10 +111,14 @@ esp_err_t lvgl_port_resume(void)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_stop(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_ERR_INVALID_STATE;

if (lvgl_port_ctx.tick_timer != NULL) {
Expand All @@ -116,10 +127,14 @@ esp_err_t lvgl_port_stop(void)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_deinit(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
/* Stop and delete timer */
if (lvgl_port_ctx.tick_timer != NULL) {
esp_timer_stop(lvgl_port_ctx.tick_timer);
Expand All @@ -140,22 +155,29 @@ esp_err_t lvgl_port_deinit(void)
ESP_LOGI(TAG, "Stopped LVGL task");

lvgl_port_task_deinit();

#endif
return ESP_OK;
}

bool lvgl_port_lock(uint32_t timeout_ms)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
assert(lvgl_port_ctx.lvgl_mux && "lvgl_port_init must be called first");

const TickType_t timeout_ticks = (timeout_ms == 0) ? portMAX_DELAY : pdMS_TO_TICKS(timeout_ms);
return xSemaphoreTakeRecursive(lvgl_port_ctx.lvgl_mux, timeout_ticks) == pdTRUE;
#else
(void)timeout_ms;
return true;
#endif
}

void lvgl_port_unlock(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
assert(lvgl_port_ctx.lvgl_mux && "lvgl_port_init must be called first");
xSemaphoreGiveRecursive(lvgl_port_ctx.lvgl_mux);
#endif
}

esp_err_t lvgl_port_task_wake(lvgl_port_event_type_t event, void *param)
Expand All @@ -166,6 +188,7 @@ esp_err_t lvgl_port_task_wake(lvgl_port_event_type_t event, void *param)

IRAM_ATTR bool lvgl_port_task_notify(uint32_t value)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
BaseType_t need_yield = pdFALSE;

// Notify LVGL task
Expand All @@ -176,12 +199,16 @@ IRAM_ATTR bool lvgl_port_task_notify(uint32_t value)
}

return (need_yield == pdTRUE);
#else
return false;
#endif
}

/*******************************************************************************
* Private functions
*******************************************************************************/

#if CONFIG_LVGL_PORT_INTERNAL_TASK
static void lvgl_port_task(void *arg)
{
uint32_t task_delay_ms = lvgl_port_ctx.task_max_sleep_ms;
Expand Down Expand Up @@ -246,3 +273,4 @@ static esp_err_t lvgl_port_tick_init(void)
ESP_RETURN_ON_ERROR(esp_timer_create(&lvgl_tick_timer_args, &lvgl_port_ctx.tick_timer), TAG, "Creating LVGL timer filed!");
return esp_timer_start_periodic(lvgl_port_ctx.tick_timer, lvgl_port_ctx.timer_period_ms * 1000);
}
#endif
35 changes: 33 additions & 2 deletions components/esp_lvgl_port/src/lvgl9/esp_lvgl_port.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ typedef struct lvgl_port_ctx_s {
/*******************************************************************************
* Local variables
*******************************************************************************/
#if CONFIG_LVGL_PORT_INTERNAL_TASK
static lvgl_port_ctx_t lvgl_port_ctx;

/*******************************************************************************
Expand All @@ -51,13 +52,15 @@ static lvgl_port_ctx_t lvgl_port_ctx;
static void lvgl_port_task(void *arg);
static esp_err_t lvgl_port_tick_init(void);
static void lvgl_port_task_deinit(void);
#endif

/*******************************************************************************
* Public API functions
*******************************************************************************/

esp_err_t lvgl_port_init(const lvgl_port_cfg_t *cfg)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_OK;
ESP_GOTO_ON_FALSE(cfg, ESP_ERR_INVALID_ARG, err, TAG, "invalid argument");
ESP_GOTO_ON_FALSE(cfg->task_affinity < (configNUM_CORES), ESP_ERR_INVALID_ARG, err, TAG, "Bad core number for task! Maximum core number is %d", (configNUM_CORES - 1));
Expand Down Expand Up @@ -104,10 +107,14 @@ esp_err_t lvgl_port_init(const lvgl_port_cfg_t *cfg)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_resume(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_ERR_INVALID_STATE;

if (lvgl_port_ctx.tick_timer != NULL) {
Expand All @@ -116,10 +123,14 @@ esp_err_t lvgl_port_resume(void)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_stop(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
esp_err_t ret = ESP_ERR_INVALID_STATE;

if (lvgl_port_ctx.tick_timer != NULL) {
Expand All @@ -128,10 +139,14 @@ esp_err_t lvgl_port_stop(void)
}

return ret;
#else
return ESP_OK;
#endif
}

esp_err_t lvgl_port_deinit(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
/* Stop and delete timer */
if (lvgl_port_ctx.tick_timer != NULL) {
esp_timer_stop(lvgl_port_ctx.tick_timer);
Expand All @@ -153,25 +168,34 @@ esp_err_t lvgl_port_deinit(void)

lvgl_port_task_deinit();

#endif
return ESP_OK;
}

bool lvgl_port_lock(uint32_t timeout_ms)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
assert(lvgl_port_ctx.lvgl_mux && "lvgl_port_init must be called first");

const TickType_t timeout_ticks = (timeout_ms == 0) ? portMAX_DELAY : pdMS_TO_TICKS(timeout_ms);
return xSemaphoreTakeRecursive(lvgl_port_ctx.lvgl_mux, timeout_ticks) == pdTRUE;
#else
(void)timeout_ms;
return true;
#endif
}

void lvgl_port_unlock(void)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
assert(lvgl_port_ctx.lvgl_mux && "lvgl_port_init must be called first");
xSemaphoreGiveRecursive(lvgl_port_ctx.lvgl_mux);
#endif
}

esp_err_t lvgl_port_task_wake(lvgl_port_event_type_t event, void *param)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
EventBits_t bits = 0;
if (!lvgl_port_ctx.lvgl_events) {
return ESP_ERR_INVALID_STATE;
Expand All @@ -197,12 +221,13 @@ esp_err_t lvgl_port_task_wake(lvgl_port_event_type_t event, void *param)
} else {
xEventGroupSetBits(lvgl_port_ctx.lvgl_events, bits);
}

#endif
return ESP_OK;
}

IRAM_ATTR bool lvgl_port_task_notify(uint32_t value)
{
#if CONFIG_LVGL_PORT_INTERNAL_TASK
BaseType_t need_yield = pdFALSE;

// Notify LVGL task
Expand All @@ -213,12 +238,16 @@ IRAM_ATTR bool lvgl_port_task_notify(uint32_t value)
}

return (need_yield == pdTRUE);
#else
return false;
#endif
}

/*******************************************************************************
* Private functions
*******************************************************************************/

#if CONFIG_LVGL_PORT_INTERNAL_TASK
static void lvgl_port_task(void *arg)
{
TaskHandle_t task_to_notify = (TaskHandle_t)arg;
Expand All @@ -240,7 +269,7 @@ static void lvgl_port_task(void *arg)
/* Tick init */
lvgl_port_tick_init();

ESP_LOGI(TAG, "Starting LVGL task");
ESP_LOGI(TAG, "Starting LVGL task (custom)");
lvgl_port_ctx.running = true;
while (lvgl_port_ctx.running) {
/* Wait for queue or timeout (sleep task) */
Expand Down Expand Up @@ -321,3 +350,5 @@ static esp_err_t lvgl_port_tick_init(void)
ESP_RETURN_ON_ERROR(esp_timer_create(&lvgl_tick_timer_args, &lvgl_port_ctx.tick_timer), TAG, "Creating LVGL timer filed!");
return esp_timer_start_periodic(lvgl_port_ctx.tick_timer, lvgl_port_ctx.timer_period_ms * 1000);
}

#endif