mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 19:03:16 +00:00
d860ba1f34
- UiDensity moved to lvgl-module - Deleted tt_hal and tt_hal_gpio (breaks apps, but will fix those right after merging) - Added I2C 8 bit register operations - Added device.properties to simulator - Improved Tab5 hardware init, implement audio - Add README.md to kernel
108 lines
2.5 KiB
C
108 lines
2.5 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
#pragma once
|
|
|
|
/**
|
|
* @file lvgl_module.h
|
|
* @brief LVGL module for Tactility.
|
|
*
|
|
* This module manages the lifecycle of the LVGL library, including initialization,
|
|
* task management, and thread-safety.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
/** Affects LVGL widget style */
|
|
enum UiDensity {
|
|
/** Ideal for very small non-touch screen devices (e.g. Waveshare S3 LCD 1.3") */
|
|
LVGL_UI_DENSITY_COMPACT,
|
|
/** Nothing was changed in the LVGL UI/UX */
|
|
LVGL_UI_DENSITY_DEFAULT
|
|
};
|
|
|
|
/**
|
|
* @brief The LVGL module instance.
|
|
*/
|
|
extern struct Module lvgl_module;
|
|
|
|
/**
|
|
* @brief Configuration for the LVGL module.
|
|
*/
|
|
struct LvglModuleConfig {
|
|
/**
|
|
* @brief Callback invoked when the LVGL task starts.
|
|
* Use this to add devices (e.g. displays, pointers), start services, create widgets, etc.
|
|
*/
|
|
void (*on_start)(void);
|
|
|
|
/**
|
|
* @brief Callback invoked when the LVGL task stops.
|
|
* Use this to remove devices, stop services, etc.
|
|
*/
|
|
void (*on_stop)(void);
|
|
|
|
/** @brief Priority of the LVGL task. */
|
|
int task_priority;
|
|
|
|
/** @brief Stack size of the LVGL task in bytes. */
|
|
int task_stack_size;
|
|
|
|
#ifdef ESP_PLATFORM
|
|
/** @brief CPU affinity of the LVGL task (ESP32 specific). */
|
|
int task_affinity;
|
|
#endif
|
|
};
|
|
|
|
/**
|
|
* @brief Configures the LVGL module.
|
|
*
|
|
* @warning This must be called before starting the module.
|
|
* @param config The configuration to apply.
|
|
*/
|
|
void lvgl_module_configure(struct LvglModuleConfig config);
|
|
|
|
/**
|
|
* @brief Locks the LVGL mutex.
|
|
*
|
|
* This should be called before any LVGL API calls from threads other than the LVGL task.
|
|
* It is a recursive mutex.
|
|
* @retval true when a lock was acquired, false otherwise
|
|
*/
|
|
bool lvgl_lock(void);
|
|
|
|
/**
|
|
* @brief Tries to lock the LVGL mutex with a timeout.
|
|
*
|
|
* @param timeout Timeout in ticks
|
|
* @return true if the lock was acquired, false otherwise.
|
|
*/
|
|
bool lvgl_try_lock(uint32_t timeout);
|
|
|
|
/**
|
|
* @brief Unlocks the LVGL mutex.
|
|
*/
|
|
void lvgl_unlock(void);
|
|
|
|
/**
|
|
* @brief Checks if the LVGL module is currently running.
|
|
*
|
|
* @return true if running, false otherwise.
|
|
*/
|
|
bool lvgl_is_running(void);
|
|
|
|
/**
|
|
* @brief Gets the desired UI density for the target hardware.
|
|
* The density is defined in the `device.properties` of a hardware device.
|
|
* This setting is read by CMakeLists.txt and passed as a target compile definition of the LVGL module.
|
|
* @return the UI density
|
|
*/
|
|
enum UiDensity lvgl_get_ui_density(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|