diff --git a/CMakeLists.txt b/CMakeLists.txt index 06cf2decc..13546940c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -85,7 +85,8 @@ if (NOT DEFINED ENV{ESP_IDF_VERSION}) add_subdirectory(Libraries/QRCode) add_subdirectory(Libraries/minitar) add_subdirectory(Libraries/minmea) - add_subdirectory(Modules/hal-device) + add_subdirectory(Modules/hal-device-module) + add_subdirectory(Modules/lvgl-module) # FreeRTOS set(FREERTOS_CONFIG_FILE_DIRECTORY ${PROJECT_SOURCE_DIR}/Devices/simulator/Source CACHE STRING "") diff --git a/Devices/btt-panda-touch/Source/devices/Display.cpp b/Devices/btt-panda-touch/Source/devices/Display.cpp index 7da8e901e..24607968b 100644 --- a/Devices/btt-panda-touch/Source/devices/Display.cpp +++ b/Devices/btt-panda-touch/Source/devices/Display.cpp @@ -4,7 +4,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 41 and interrupt pin is 40 auto configuration = std::make_unique( I2C_NUM_0, diff --git a/Devices/cyd-4848s040c/Source/devices/St7701Display.cpp b/Devices/cyd-4848s040c/Source/devices/St7701Display.cpp index bc337e4e9..e9c14889b 100644 --- a/Devices/cyd-4848s040c/Source/devices/St7701Display.cpp +++ b/Devices/cyd-4848s040c/Source/devices/St7701Display.cpp @@ -219,7 +219,7 @@ lvgl_port_display_rgb_cfg_t St7701Display::getLvglPortDisplayRgbConfig(esp_lcd_p }; } -std::shared_ptr _Nullable St7701Display::getTouchDevice() { +std::shared_ptr St7701Display::getTouchDevice() { if (touchDevice == nullptr) { auto configuration = std::make_unique( I2C_NUM_0, diff --git a/Devices/cyd-4848s040c/Source/devices/St7701Display.h b/Devices/cyd-4848s040c/Source/devices/St7701Display.h index 2ae12c4f0..49efa45e4 100644 --- a/Devices/cyd-4848s040c/Source/devices/St7701Display.h +++ b/Devices/cyd-4848s040c/Source/devices/St7701Display.h @@ -7,7 +7,7 @@ class St7701Display final : public EspLcdDisplay { - std::shared_ptr _Nullable touchDevice; + std::shared_ptr touchDevice; bool createIoHandle(esp_lcd_panel_io_handle_t& outHandle) override; @@ -27,7 +27,7 @@ class St7701Display final : public EspLcdDisplay { std::string getDescription() const override { return "ST7701S RGB display"; } - std::shared_ptr _Nullable getTouchDevice() override; + std::shared_ptr getTouchDevice() override; void setBacklightDuty(uint8_t backlightDuty) override; diff --git a/Devices/cyd-8048s043c/Source/devices/Display.cpp b/Devices/cyd-8048s043c/Source/devices/Display.cpp index 65a2c5221..2d1e61e20 100644 --- a/Devices/cyd-8048s043c/Source/devices/Display.cpp +++ b/Devices/cyd-8048s043c/Source/devices/Display.cpp @@ -4,7 +4,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 38 and interrupt pin is 18 // or INT = NC, schematic and other info floating around is kinda conflicting... auto configuration = std::make_unique( diff --git a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp index 9440b3d9f..3476d82d4 100644 --- a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp +++ b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp @@ -3,7 +3,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 38 and interrupt pin is 18 // or INT = NC, schematic and other info floating around is kinda conflicting... auto configuration = std::make_unique( diff --git a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp b/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp index 72771a1aa..6a9f70e7e 100644 --- a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp +++ b/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp @@ -4,7 +4,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 38 and interrupt pin is 18 // or INT = NC, schematic and other info floating around is kinda conflicting... auto configuration = std::make_unique( diff --git a/Devices/guition-jc3248w535c/Source/Axs15231b/Axs15231bDisplay.h b/Devices/guition-jc3248w535c/Source/Axs15231b/Axs15231bDisplay.h index 4c9e39b3d..1f8a53dfa 100644 --- a/Devices/guition-jc3248w535c/Source/Axs15231b/Axs15231bDisplay.h +++ b/Devices/guition-jc3248w535c/Source/Axs15231b/Axs15231bDisplay.h @@ -72,23 +72,23 @@ class Axs15231bDisplay final : public tt::hal::display::DisplayDevice { uint32_t bufferSize; // Size in pixel count. 0 means default, which is 1/10 of the screen size lcd_rgb_element_order_t rgbElementOrder; std::shared_ptr touch; - std::function _Nullable backlightDutyFunction = nullptr; + std::function backlightDutyFunction = nullptr; }; private: - esp_lcd_panel_io_handle_t _Nullable ioHandle = nullptr; - esp_lcd_panel_handle_t _Nullable panelHandle = nullptr; - lv_display_t* _Nullable lvglDisplay = nullptr; - uint16_t* _Nullable buffer1 = nullptr; - uint16_t* _Nullable buffer2 = nullptr; - uint16_t* _Nullable tempBuf = nullptr; - SemaphoreHandle_t _Nullable teSyncSemaphore = nullptr; + esp_lcd_panel_io_handle_t ioHandle = nullptr; + esp_lcd_panel_handle_t panelHandle = nullptr; + lv_display_t* lvglDisplay = nullptr; + uint16_t* buffer1 = nullptr; + uint16_t* buffer2 = nullptr; + uint16_t* tempBuf = nullptr; + SemaphoreHandle_t teSyncSemaphore = nullptr; bool teIsrInstalled = false; bool isrServiceInstalledByUs = false; std::unique_ptr configuration; - std::shared_ptr _Nullable displayDriver; + std::shared_ptr displayDriver; bool createIoHandle(); @@ -118,9 +118,9 @@ class Axs15231bDisplay final : public tt::hal::display::DisplayDevice { bool stopLvgl() override; - lv_display_t* _Nullable getLvglDisplay() const override { return lvglDisplay; } + lv_display_t* getLvglDisplay() const override { return lvglDisplay; } - std::shared_ptr _Nullable getTouchDevice() override { return configuration->touch; } + std::shared_ptr getTouchDevice() override { return configuration->touch; } void setBacklightDuty(uint8_t backlightDuty) override { if (configuration->backlightDutyFunction != nullptr) { @@ -132,7 +132,7 @@ class Axs15231bDisplay final : public tt::hal::display::DisplayDevice { bool supportsDisplayDriver() const override { return true; } - std::shared_ptr _Nullable getDisplayDriver() override; + std::shared_ptr getDisplayDriver() override; static void lvgl_port_flush_callback(lv_display_t *drv, const lv_area_t *area, uint8_t *color_map); diff --git a/Devices/guition-jc8048w550c/Source/devices/Display.cpp b/Devices/guition-jc8048w550c/Source/devices/Display.cpp index 65a2c5221..2d1e61e20 100644 --- a/Devices/guition-jc8048w550c/Source/devices/Display.cpp +++ b/Devices/guition-jc8048w550c/Source/devices/Display.cpp @@ -4,7 +4,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 38 and interrupt pin is 18 // or INT = NC, schematic and other info floating around is kinda conflicting... auto configuration = std::make_unique( diff --git a/Devices/lilygo-tdeck/Source/devices/TdeckKeyboard.h b/Devices/lilygo-tdeck/Source/devices/TdeckKeyboard.h index c79b54ddb..7204f1a09 100644 --- a/Devices/lilygo-tdeck/Source/devices/TdeckKeyboard.h +++ b/Devices/lilygo-tdeck/Source/devices/TdeckKeyboard.h @@ -5,7 +5,7 @@ class TdeckKeyboard final : public tt::hal::keyboard::KeyboardDevice { - lv_indev_t* _Nullable deviceHandle = nullptr; + lv_indev_t* deviceHandle = nullptr; public: @@ -15,5 +15,5 @@ class TdeckKeyboard final : public tt::hal::keyboard::KeyboardDevice { bool startLvgl(lv_display_t* display) override; bool stopLvgl() override; bool isAttached() const override; - lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; } + lv_indev_t* getLvglIndev() override { return deviceHandle; } }; diff --git a/Devices/lilygo-tlora-pager/Source/devices/TpagerEncoder.h b/Devices/lilygo-tlora-pager/Source/devices/TpagerEncoder.h index 026d1cb9e..859484704 100644 --- a/Devices/lilygo-tlora-pager/Source/devices/TpagerEncoder.h +++ b/Devices/lilygo-tlora-pager/Source/devices/TpagerEncoder.h @@ -5,7 +5,7 @@ class TpagerEncoder final : public tt::hal::encoder::EncoderDevice { - lv_indev_t* _Nullable encHandle = nullptr; + lv_indev_t* encHandle = nullptr; pcnt_unit_handle_t encPcntUnit = nullptr; bool initEncoder(); @@ -26,5 +26,5 @@ class TpagerEncoder final : public tt::hal::encoder::EncoderDevice { int getEncoderPulses() const; - lv_indev_t* _Nullable getLvglIndev() override { return encHandle; } + lv_indev_t* getLvglIndev() override { return encHandle; } }; diff --git a/Devices/lilygo-tlora-pager/Source/devices/TpagerKeyboard.h b/Devices/lilygo-tlora-pager/Source/devices/TpagerKeyboard.h index 857206ff2..f8a40e5ef 100644 --- a/Devices/lilygo-tlora-pager/Source/devices/TpagerKeyboard.h +++ b/Devices/lilygo-tlora-pager/Source/devices/TpagerKeyboard.h @@ -10,7 +10,7 @@ class TpagerKeyboard final : public tt::hal::keyboard::KeyboardDevice { - lv_indev_t* _Nullable kbHandle = nullptr; + lv_indev_t* kbHandle = nullptr; gpio_num_t backlightPin = GPIO_NUM_NC; ledc_timer_t backlightTimer; ledc_channel_t backlightChannel; @@ -45,7 +45,7 @@ class TpagerKeyboard final : public tt::hal::keyboard::KeyboardDevice { bool stopLvgl() override; bool isAttached() const override; - lv_indev_t* _Nullable getLvglIndev() override { return kbHandle; } + lv_indev_t* getLvglIndev() override { return kbHandle; } bool setBacklightDuty(uint8_t duty); void makeBacklightImpulse(); diff --git a/Devices/lilygo-tlora-pager/Source/drivers/TloraPager.cpp b/Devices/lilygo-tlora-pager/Source/drivers/TloraPager.cpp index a333957a4..741750ae4 100644 --- a/Devices/lilygo-tlora-pager/Source/drivers/TloraPager.cpp +++ b/Devices/lilygo-tlora-pager/Source/drivers/TloraPager.cpp @@ -19,10 +19,10 @@ static int stop(Device* device) { Driver tlora_pager_driver = { .name = "T-Lora Pager", .compatible = (const char*[]) { "lilygo,tlora-pager", nullptr }, - .startDevice = start, - .stopDevice = stop, + .start_device = start, + .stop_device = stop, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = &device_module, .driver_private = nullptr }; diff --git a/Devices/m5stack-cardputer-adv/Source/devices/CardputerKeyboard.h b/Devices/m5stack-cardputer-adv/Source/devices/CardputerKeyboard.h index fecafc095..89f95ba9c 100644 --- a/Devices/m5stack-cardputer-adv/Source/devices/CardputerKeyboard.h +++ b/Devices/m5stack-cardputer-adv/Source/devices/CardputerKeyboard.h @@ -9,7 +9,7 @@ class CardputerKeyboard final : public tt::hal::keyboard::KeyboardDevice { - lv_indev_t* _Nullable kbHandle = nullptr; + lv_indev_t* kbHandle = nullptr; QueueHandle_t queue = nullptr; std::shared_ptr keypad; @@ -42,5 +42,5 @@ class CardputerKeyboard final : public tt::hal::keyboard::KeyboardDevice { bool stopLvgl() override; bool isAttached() const override; - lv_indev_t* _Nullable getLvglIndev() override { return kbHandle; } + lv_indev_t* getLvglIndev() override { return kbHandle; } }; diff --git a/Devices/m5stack-cardputer/Source/devices/CardputerEncoder.h b/Devices/m5stack-cardputer/Source/devices/CardputerEncoder.h index f97ca7cf8..0deea817b 100644 --- a/Devices/m5stack-cardputer/Source/devices/CardputerEncoder.h +++ b/Devices/m5stack-cardputer/Source/devices/CardputerEncoder.h @@ -13,7 +13,7 @@ class CardputerEncoder final : public tt::hal::encoder::EncoderDevice { KEYBOARD::Keyboard keyboard; int lastKeyNum = 0; - lv_indev_t* _Nullable lvglDevice = nullptr; + lv_indev_t* lvglDevice = nullptr; static void readCallback(lv_indev_t* indev, lv_indev_data_t* data); @@ -25,5 +25,5 @@ class CardputerEncoder final : public tt::hal::encoder::EncoderDevice { bool startLvgl(lv_display_t* display) override; bool stopLvgl() override; - lv_indev_t* _Nullable getLvglIndev() override { return lvglDevice; } + lv_indev_t* getLvglIndev() override { return lvglDevice; } }; diff --git a/Devices/m5stack-cardputer/Source/devices/CardputerKeyboard.h b/Devices/m5stack-cardputer/Source/devices/CardputerKeyboard.h index f57dff063..4501ffbd7 100644 --- a/Devices/m5stack-cardputer/Source/devices/CardputerKeyboard.h +++ b/Devices/m5stack-cardputer/Source/devices/CardputerKeyboard.h @@ -8,7 +8,7 @@ class CardputerKeyboard : public tt::hal::keyboard::KeyboardDevice { KEYBOARD::Keyboard keyboard; int lastKeyNum = 0; - lv_indev_t* _Nullable lvglDevice = nullptr; + lv_indev_t* lvglDevice = nullptr; static void readCallback(lv_indev_t* indev, lv_indev_data_t* data); @@ -22,5 +22,5 @@ class CardputerKeyboard : public tt::hal::keyboard::KeyboardDevice { bool isAttached() const override { return true; } - lv_indev_t* _Nullable getLvglIndev() override { return lvglDevice; } + lv_indev_t* getLvglIndev() override { return lvglDevice; } }; diff --git a/Devices/simulator/CMakeLists.txt b/Devices/simulator/CMakeLists.txt index 7750f97a8..6e0dc4a37 100644 --- a/Devices/simulator/CMakeLists.txt +++ b/Devices/simulator/CMakeLists.txt @@ -21,7 +21,4 @@ if (NOT DEFINED ENV{ESP_IDF_VERSION}) target_link_libraries(Simulator PRIVATE ${SDL2_LIBRARIES}) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) - endif() diff --git a/Devices/simulator/Source/LvglTask.cpp b/Devices/simulator/Source/LvglTask.cpp deleted file mode 100644 index eaddf328a..000000000 --- a/Devices/simulator/Source/LvglTask.cpp +++ /dev/null @@ -1,108 +0,0 @@ -#include "LvglTask.h" - -#include -#include -#include -#include -#include - -#include - -static const auto LOGGER = tt::Logger("LvglTask"); - -// Mutex for LVGL drawing -static tt::RecursiveMutex lvgl_mutex; -static tt::RecursiveMutex task_mutex; - -static uint32_t task_max_sleep_ms = 10; -// Mutex for LVGL task state (to modify task_running state) -static bool task_running = false; - -lv_disp_t* displayHandle = nullptr; - -static void lvgl_task(void* arg); - -static bool task_lock(TickType_t timeout) { - return task_mutex.lock(timeout); -} - -static void task_unlock() { - task_mutex.unlock(); -} - -static void task_set_running(bool running) { - assert(task_lock(configTICK_RATE_HZ / 100)); - task_running = running; - task_unlock(); -} - -bool lvgl_task_is_running() { - assert(task_lock(configTICK_RATE_HZ / 100)); - bool result = task_running; - task_unlock(); - return result; -} - -static bool lvgl_lock(uint32_t timeoutMillis) { - return lvgl_mutex.lock(pdMS_TO_TICKS(timeoutMillis)); -} - -static void lvgl_unlock() { - lvgl_mutex.unlock(); -} - -void lvgl_task_interrupt() { - check(task_lock(portMAX_DELAY)); - task_set_running(false); // interrupt task with boolean as flag - task_unlock(); -} - -void lvgl_task_start() { - LOGGER.info("LVGL task starting"); - - tt::lvgl::syncSet(&lvgl_lock, &lvgl_unlock); - - // Create the main app loop, like ESP-IDF - BaseType_t task_result = xTaskCreate( - lvgl_task, - "lvgl", - 8192, - nullptr, - static_cast(tt::Thread::Priority::High), // Should be higher than main app task - nullptr - ); - - assert(task_result == pdTRUE); -} - -static void lvgl_task(void* arg) { - LOGGER.info("LVGL task started"); - - /** Ideally. the display handle would be created during Simulator.start(), - * but somehow that doesn't work. Waiting here from a ThreadFlag when that happens - * also doesn't work. It seems that it must be called from this task. */ - displayHandle = lv_sdl_window_create(320, 240); - lv_sdl_window_set_title(displayHandle, "Tactility"); - - uint32_t task_delay_ms = task_max_sleep_ms; - - task_set_running(true); - - while (lvgl_task_is_running()) { - if (lvgl_lock(10)) { - task_delay_ms = lv_timer_handler(); - lvgl_unlock(); - } - if ((task_delay_ms > task_max_sleep_ms) || (1 == task_delay_ms)) { - task_delay_ms = task_max_sleep_ms; - } else if (task_delay_ms < 1) { - task_delay_ms = 1; - } - vTaskDelay(pdMS_TO_TICKS(task_delay_ms)); - } - - lv_disp_remove(displayHandle); - displayHandle = nullptr; - vTaskDelete(nullptr); -} - diff --git a/Devices/simulator/Source/LvglTask.h b/Devices/simulator/Source/LvglTask.h deleted file mode 100644 index efd22c507..000000000 --- a/Devices/simulator/Source/LvglTask.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -void lvgl_task_start(); -bool lvgl_task_is_running(); -void lvgl_task_interrupt(); diff --git a/Devices/simulator/Source/Main.cpp b/Devices/simulator/Source/Main.cpp index 55f4565c8..94481c1af 100644 --- a/Devices/simulator/Source/Main.cpp +++ b/Devices/simulator/Source/Main.cpp @@ -40,21 +40,3 @@ void freertosMain() { } } // namespace - -/** - * Assert implementation as defined in the FreeRTOSConfig.h - * It allows you to set breakpoints and debug asserts. - */ -void vAssertCalled(unsigned long line, const char* const file) { - volatile uint32_t set_to_nonzero_in_debugger_to_continue = 0; - LOGGER.error("Assert triggered at {}:{}", file, line); - taskENTER_CRITICAL(); - { - // Step out by attaching a debugger and setting set_to_nonzero_in_debugger_to_continue - while (set_to_nonzero_in_debugger_to_continue == 0) { - // NO-OP - } - } - taskEXIT_CRITICAL(); -} - diff --git a/Devices/simulator/Source/Simulator.cpp b/Devices/simulator/Source/Simulator.cpp index 02ceac97f..9903ef6ae 100644 --- a/Devices/simulator/Source/Simulator.cpp +++ b/Devices/simulator/Source/Simulator.cpp @@ -1,4 +1,3 @@ -#include "LvglTask.h" #include "hal/SdlDisplay.h" #include "hal/SdlKeyboard.h" #include "hal/SimulatorPower.h" @@ -11,23 +10,6 @@ using namespace tt::hal; -static bool initBoot() { - lv_init(); - lvgl_task_start(); - return true; -} - -static void deinitPower() { - lvgl_task_interrupt(); - while (lvgl_task_is_running()) { - tt::kernel::delayMillis(10); - } - -#if LV_ENABLE_GC || !LV_MEM_CUSTOM - lv_deinit(); -#endif -} - static std::vector> createDevices() { return { std::make_shared(), @@ -38,7 +20,7 @@ static std::vector> createDevices() { } extern const Configuration hardwareConfiguration = { - .initBoot = initBoot, + .initBoot = nullptr, .createDevices = createDevices, .uart = { uart::Configuration { diff --git a/Devices/simulator/Source/hal/SdlDisplay.h b/Devices/simulator/Source/hal/SdlDisplay.h index fca3cb243..99f8aa657 100644 --- a/Devices/simulator/Source/hal/SdlDisplay.h +++ b/Devices/simulator/Source/hal/SdlDisplay.h @@ -4,26 +4,39 @@ #include #include -/** Hack: variable comes from LvglTask.cpp */ -extern lv_disp_t* displayHandle; - class SdlDisplay final : public tt::hal::display::DisplayDevice { + lv_disp_t* displayHandle = nullptr; + public: std::string getName() const override { return "SDL Display"; } std::string getDescription() const override { return ""; } bool start() override { return true; } - bool stop() override { check(false, "Not supported"); } + + bool stop() override { return true; } bool supportsLvgl() const override { return true; } - bool startLvgl() override { return displayHandle != nullptr; } - bool stopLvgl() override { check(false, "Not supported"); } - lv_display_t* _Nullable getLvglDisplay() const override { return displayHandle; } - std::shared_ptr _Nullable getTouchDevice() override { return std::make_shared(); } + bool startLvgl() override { + if (displayHandle) return true; // already started + displayHandle = lv_sdl_window_create(320, 240); + lv_sdl_window_set_title(displayHandle, "Tactility"); + return displayHandle != nullptr; + } + + bool stopLvgl() override { + if (!displayHandle) return true; + lv_display_delete(displayHandle); + displayHandle = nullptr; + return true; + } + + lv_display_t* getLvglDisplay() const override { return displayHandle; } + + std::shared_ptr getTouchDevice() override { return std::make_shared(); } bool supportsDisplayDriver() const override { return false; } - std::shared_ptr _Nullable getDisplayDriver() override { return nullptr; } + std::shared_ptr getDisplayDriver() override { return nullptr; } }; diff --git a/Devices/simulator/Source/hal/SdlKeyboard.h b/Devices/simulator/Source/hal/SdlKeyboard.h index 6fc1513e2..876bf70d3 100644 --- a/Devices/simulator/Source/hal/SdlKeyboard.h +++ b/Devices/simulator/Source/hal/SdlKeyboard.h @@ -6,7 +6,7 @@ class SdlKeyboard final : public tt::hal::keyboard::KeyboardDevice { - lv_indev_t* _Nullable handle = nullptr; + lv_indev_t* handle = nullptr; public: @@ -22,5 +22,5 @@ class SdlKeyboard final : public tt::hal::keyboard::KeyboardDevice { bool isAttached() const override { return true; } - lv_indev_t* _Nullable getLvglIndev() override { return handle; } + lv_indev_t* getLvglIndev() override { return handle; } }; diff --git a/Devices/simulator/Source/hal/SdlTouch.h b/Devices/simulator/Source/hal/SdlTouch.h index 0c3bead69..09ebc757c 100644 --- a/Devices/simulator/Source/hal/SdlTouch.h +++ b/Devices/simulator/Source/hal/SdlTouch.h @@ -6,7 +6,7 @@ class SdlTouch final : public tt::hal::touch::TouchDevice { - lv_indev_t* _Nullable handle = nullptr; + lv_indev_t* handle = nullptr; public: @@ -27,10 +27,10 @@ class SdlTouch final : public tt::hal::touch::TouchDevice { bool stopLvgl() override { check(false, "Not supported"); } - lv_indev_t* _Nullable getLvglIndev() override { return handle; } + lv_indev_t* getLvglIndev() override { return handle; } bool supportsTouchDriver() override { return false; } - std::shared_ptr _Nullable getTouchDriver() override { return nullptr; }; + std::shared_ptr getTouchDriver() override { return nullptr; }; }; diff --git a/Devices/unphone/Source/devices/Hx8357Display.cpp b/Devices/unphone/Source/devices/Hx8357Display.cpp index 3bd0f0ff7..80a2f7f6b 100644 --- a/Devices/unphone/Source/devices/Hx8357Display.cpp +++ b/Devices/unphone/Source/devices/Hx8357Display.cpp @@ -99,7 +99,7 @@ bool Hx8357Display::stopLvgl() { return true; } -std::shared_ptr _Nullable Hx8357Display::getTouchDevice() { +std::shared_ptr Hx8357Display::getTouchDevice() { if (touchDevice == nullptr) { touchDevice = std::reinterpret_pointer_cast(createTouch()); LOGGER.info("Created touch device"); diff --git a/Devices/unphone/Source/devices/Hx8357Display.h b/Devices/unphone/Source/devices/Hx8357Display.h index e081a452d..3414d2be7 100644 --- a/Devices/unphone/Source/devices/Hx8357Display.h +++ b/Devices/unphone/Source/devices/Hx8357Display.h @@ -21,10 +21,10 @@ class Hx8357Display : public tt::hal::display::DisplayDevice { - uint8_t* _Nullable buffer = nullptr; - lv_display_t* _Nullable lvglDisplay = nullptr; - std::shared_ptr _Nullable touchDevice; - std::shared_ptr _Nullable nativeDisplay; + uint8_t* buffer = nullptr; + lv_display_t* lvglDisplay = nullptr; + std::shared_ptr touchDevice; + std::shared_ptr nativeDisplay; class Hx8357Driver : public tt::hal::display::DisplayDriver { std::shared_ptr lock = tt::hal::spi::getLock(SPI2_HOST); @@ -51,14 +51,14 @@ class Hx8357Display : public tt::hal::display::DisplayDevice { bool stopLvgl() override; - std::shared_ptr _Nullable getTouchDevice() override; + std::shared_ptr getTouchDevice() override; - lv_display_t* _Nullable getLvglDisplay() const override { return lvglDisplay; } + lv_display_t* getLvglDisplay() const override { return lvglDisplay; } // TODO: Set to true after fixing UnPhoneDisplayDriver bool supportsDisplayDriver() const override { return false; } - std::shared_ptr _Nullable getDisplayDriver() override { + std::shared_ptr getDisplayDriver() override { if (nativeDisplay == nullptr) { nativeDisplay = std::make_shared(); } diff --git a/Devices/waveshare-s3-touch-lcd-128/Source/devices/Display.cpp b/Devices/waveshare-s3-touch-lcd-128/Source/devices/Display.cpp index ca1e0e4a8..f152d94f6 100644 --- a/Devices/waveshare-s3-touch-lcd-128/Source/devices/Display.cpp +++ b/Devices/waveshare-s3-touch-lcd-128/Source/devices/Display.cpp @@ -4,7 +4,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { auto configuration = std::make_unique( I2C_NUM_0, 240, diff --git a/Devices/waveshare-s3-touch-lcd-147/Source/devices/Jd9853Display.h b/Devices/waveshare-s3-touch-lcd-147/Source/devices/Jd9853Display.h index b84754e28..fd06223b1 100644 --- a/Devices/waveshare-s3-touch-lcd-147/Source/devices/Jd9853Display.h +++ b/Devices/waveshare-s3-touch-lcd-147/Source/devices/Jd9853Display.h @@ -67,7 +67,7 @@ class Jd9853Display final : public EspLcdDisplay { uint32_t bufferSize; // Size in pixel count. 0 means default, which is 1/10 of the screen size lcd_rgb_element_order_t rgbElementOrder; std::shared_ptr touch; - std::function _Nullable backlightDutyFunction = nullptr; + std::function backlightDutyFunction = nullptr; }; private: @@ -93,7 +93,7 @@ class Jd9853Display final : public EspLcdDisplay { std::string getDescription() const override { return "JD9853 display"; } - std::shared_ptr _Nullable getTouchDevice() override { return configuration->touch; } + std::shared_ptr getTouchDevice() override { return configuration->touch; } void setBacklightDuty(uint8_t backlightDuty) override { if (configuration->backlightDutyFunction != nullptr) { diff --git a/Devices/waveshare-s3-touch-lcd-43/Source/devices/Display.cpp b/Devices/waveshare-s3-touch-lcd-43/Source/devices/Display.cpp index 85ff2ede6..49aba831d 100644 --- a/Devices/waveshare-s3-touch-lcd-43/Source/devices/Display.cpp +++ b/Devices/waveshare-s3-touch-lcd-43/Source/devices/Display.cpp @@ -3,7 +3,7 @@ #include #include -std::shared_ptr _Nullable createTouch() { +std::shared_ptr createTouch() { // Note for future changes: Reset pin is 38 and interrupt pin is 18 // or INT = NC, schematic and other info floating around is kinda conflicting... auto configuration = std::make_unique( diff --git a/Drivers/ButtonControl/Source/ButtonControl.h b/Drivers/ButtonControl/Source/ButtonControl.h index 74886ce6c..146830904 100644 --- a/Drivers/ButtonControl/Source/ButtonControl.h +++ b/Drivers/ButtonControl/Source/ButtonControl.h @@ -37,7 +37,7 @@ class ButtonControl final : public tt::hal::encoder::EncoderDevice { bool triggerLongPress = false; }; - lv_indev_t* _Nullable deviceHandle = nullptr; + lv_indev_t* deviceHandle = nullptr; std::shared_ptr driverThread; bool interruptDriverThread = false; tt::Mutex mutex; @@ -67,7 +67,8 @@ class ButtonControl final : public tt::hal::encoder::EncoderDevice { bool startLvgl(lv_display_t* display) override; bool stopLvgl() override; - lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; } + /** Could return nullptr if not started */ + lv_indev_t* getLvglIndev() override { return deviceHandle; } static std::shared_ptr createOneButtonControl(tt::hal::gpio::Pin pin) { return std::make_shared(std::vector { diff --git a/Drivers/CST816S/Source/Cst816Touch.h b/Drivers/CST816S/Source/Cst816Touch.h index a926c3478..67a0f1a0c 100644 --- a/Drivers/CST816S/Source/Cst816Touch.h +++ b/Drivers/CST816S/Source/Cst816Touch.h @@ -49,7 +49,7 @@ class Cst816sTouch final : public EspLcdTouch { std::unique_ptr configuration; esp_lcd_panel_io_handle_t ioHandle = nullptr; esp_lcd_touch_handle_t touchHandle = nullptr; - lv_indev_t* _Nullable deviceHandle = nullptr; + lv_indev_t* deviceHandle = nullptr; void cleanup(); diff --git a/Drivers/EspLcdCompat/Source/EspLcdDisplay.h b/Drivers/EspLcdCompat/Source/EspLcdDisplay.h index d9ae558d1..2819acd07 100644 --- a/Drivers/EspLcdCompat/Source/EspLcdDisplay.h +++ b/Drivers/EspLcdCompat/Source/EspLcdDisplay.h @@ -10,10 +10,10 @@ /** @deprecated use EspLcdDisplayV2 */ class EspLcdDisplay : public tt::hal::display::DisplayDevice { - esp_lcd_panel_io_handle_t _Nullable ioHandle = nullptr; - esp_lcd_panel_handle_t _Nullable panelHandle = nullptr; - lv_display_t* _Nullable lvglDisplay = nullptr; - std::shared_ptr _Nullable displayDriver; + esp_lcd_panel_io_handle_t ioHandle = nullptr; + esp_lcd_panel_handle_t panelHandle = nullptr; + lv_display_t* lvglDisplay = nullptr; + std::shared_ptr displayDriver; std::shared_ptr lock; lcd_rgb_element_order_t rgbElementOrder; @@ -52,7 +52,7 @@ class EspLcdDisplay : public tt::hal::display::DisplayDevice { bool stopLvgl() final; - lv_display_t* _Nullable getLvglDisplay() const final { return lvglDisplay; } + lv_display_t* getLvglDisplay() const final { return lvglDisplay; } // endregion @@ -61,7 +61,7 @@ class EspLcdDisplay : public tt::hal::display::DisplayDevice { bool supportsDisplayDriver() const override { return true; } /** @return a NativeDisplay instance if this device supports it */ - std::shared_ptr _Nullable getDisplayDriver() final; + std::shared_ptr getDisplayDriver() final; // endregion }; diff --git a/Drivers/EspLcdCompat/Source/EspLcdTouch.h b/Drivers/EspLcdCompat/Source/EspLcdTouch.h index 035c64830..3e7056b76 100644 --- a/Drivers/EspLcdCompat/Source/EspLcdTouch.h +++ b/Drivers/EspLcdCompat/Source/EspLcdTouch.h @@ -11,7 +11,7 @@ class EspLcdTouch : public tt::hal::touch::TouchDevice { esp_lcd_touch_config_t config; esp_lcd_panel_io_handle_t _Nullable ioHandle = nullptr; esp_lcd_touch_handle_t _Nullable touchHandle = nullptr; - lv_indev_t* _Nullable lvglDevice = nullptr; + lv_indev_t* lvglDevice = nullptr; std::shared_ptr touchDriver; protected: @@ -36,7 +36,7 @@ class EspLcdTouch : public tt::hal::touch::TouchDevice { bool stopLvgl() final; - lv_indev_t* _Nullable getLvglIndev() final { return lvglDevice; } + lv_indev_t* getLvglIndev() final { return lvglDevice; } bool supportsTouchDriver() override { return true; } diff --git a/Drivers/FT6x36/Source/Ft6x36Touch.h b/Drivers/FT6x36/Source/Ft6x36Touch.h index e7328a308..bbeb90232 100644 --- a/Drivers/FT6x36/Source/Ft6x36Touch.h +++ b/Drivers/FT6x36/Source/Ft6x36Touch.h @@ -34,7 +34,7 @@ class Ft6x36Touch final : public tt::hal::touch::TouchDevice { private: std::unique_ptr configuration; - lv_indev_t* _Nullable deviceHandle = nullptr; + lv_indev_t* deviceHandle = nullptr; FT6X36 driver = FT6X36(configuration->port, configuration->pinInterrupt); std::shared_ptr driverThread; bool interruptDriverThread = false; @@ -65,7 +65,7 @@ class Ft6x36Touch final : public tt::hal::touch::TouchDevice { bool startLvgl(lv_display_t* display) override; bool stopLvgl() override; - lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; } + lv_indev_t* getLvglIndev() override { return deviceHandle; } class Ft6TouchDriver : public tt::hal::touch::TouchDriver { public: diff --git a/Drivers/ILI934x/Source/Ili934xDisplay.h b/Drivers/ILI934x/Source/Ili934xDisplay.h index d44bde8c3..9337e5f6e 100644 --- a/Drivers/ILI934x/Source/Ili934xDisplay.h +++ b/Drivers/ILI934x/Source/Ili934xDisplay.h @@ -25,7 +25,7 @@ class Ili934xDisplay final : public EspLcdSpiDisplay { bool swapBytes; uint32_t bufferSize; // Pixel count, not byte count. Set to 0 for default (1/10th of display size) std::shared_ptr touch; - std::function _Nullable backlightDutyFunction; + std::function backlightDutyFunction; // Nullable gpio_num_t resetPin; lcd_rgb_element_order_t rgbElementOrder; }; diff --git a/Firmware/CMakeLists.txt b/Firmware/CMakeLists.txt index 8d18c49bf..85d632d79 100644 --- a/Firmware/CMakeLists.txt +++ b/Firmware/CMakeLists.txt @@ -36,14 +36,13 @@ else () TactilityCore TactilityFreeRtos TactilityKernel - hal-device + hal-device-module + lvgl-module Simulator PlatformPosix SDL2::SDL2-static SDL2-static ) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) endif () add_custom_target(AlwaysRun diff --git a/Modules/hal-device/CMakeLists.txt b/Modules/hal-device-module/CMakeLists.txt similarity index 63% rename from Modules/hal-device/CMakeLists.txt rename to Modules/hal-device-module/CMakeLists.txt index c242467f7..0ccdb1197 100644 --- a/Modules/hal-device/CMakeLists.txt +++ b/Modules/hal-device-module/CMakeLists.txt @@ -1,7 +1,8 @@ cmake_minimum_required(VERSION 3.20) +file(GLOB_RECURSE SOURCE_FILES "Source/*.c*") + if (DEFINED ENV{ESP_IDF_VERSION}) - file(GLOB_RECURSE SOURCE_FILES Source/*.c*) list(APPEND REQUIRES_LIST TactilityKernel @@ -21,21 +22,15 @@ if (DEFINED ENV{ESP_IDF_VERSION}) else () - file(GLOB_RECURSE SOURCES "Source/*.c*") - - add_library(hal-device OBJECT) + add_library(hal-device-module OBJECT) - target_sources(hal-device PRIVATE ${SOURCES}) + target_sources(hal-device-module PRIVATE ${SOURCE_FILES}) - target_include_directories(hal-device - PRIVATE Private/ + target_include_directories(hal-device-module PUBLIC Include/ ) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) - - target_link_libraries(hal-device PUBLIC + target_link_libraries(hal-device-module PUBLIC TactilityFreeRtos TactilityCore TactilityKernel diff --git a/Modules/hal-device/Include/tactility/drivers/hal_device.h b/Modules/hal-device-module/Include/tactility/drivers/hal_device.h similarity index 100% rename from Modules/hal-device/Include/tactility/drivers/hal_device.h rename to Modules/hal-device-module/Include/tactility/drivers/hal_device.h diff --git a/Modules/hal-device/Include/tactility/drivers/hal_device.hpp b/Modules/hal-device-module/Include/tactility/drivers/hal_device.hpp similarity index 100% rename from Modules/hal-device/Include/tactility/drivers/hal_device.hpp rename to Modules/hal-device-module/Include/tactility/drivers/hal_device.hpp diff --git a/Modules/hal-device/Include/tactility/hal/Device.h b/Modules/hal-device-module/Include/tactility/hal/Device.h similarity index 88% rename from Modules/hal-device/Include/tactility/hal/Device.h rename to Modules/hal-device-module/Include/tactility/hal/Device.h index d25dfa230..db7e68a60 100644 --- a/Modules/hal-device/Include/tactility/hal/Device.h +++ b/Modules/hal-device-module/Include/tactility/hal/Device.h @@ -79,17 +79,17 @@ void registerDevice(const std::shared_ptr& device); /** Remove a device from the registry. */ void deregisterDevice(const std::shared_ptr& device); -/** Find a single device with a custom filter */ -std::shared_ptr _Nullable findDevice(const std::function&)>& filterFunction); +/** Find a single device with a custom filter. Could return nullptr if not found. */ +std::shared_ptr findDevice(const std::function&)>& filterFunction); /** Find devices with a custom filter */ std::vector> findDevices(const std::function&)>& filterFunction); -/** Find a device in the registry by its name. */ -std::shared_ptr _Nullable findDevice(std::string name); +/** Find a device in the registry by its name. Could return nullptr if not found. */ +std::shared_ptr findDevice(std::string name); -/** Find a device in the registry by its identifier. */ -std::shared_ptr _Nullable findDevice(Device::Id id); +/** Find a device in the registry by its identifier. Could return nullptr if not found.*/ +std::shared_ptr findDevice(Device::Id id); /** Find 0, 1 or more devices in the registry by type. */ std::vector> findDevices(Device::Type type); diff --git a/Modules/hal-device/Include/tactility/hal_device_module.h b/Modules/hal-device-module/Include/tactility/hal_device_module.h similarity index 100% rename from Modules/hal-device/Include/tactility/hal_device_module.h rename to Modules/hal-device-module/Include/tactility/hal_device_module.h diff --git a/Modules/hal-device/LICENSE-Apache-2.0.md b/Modules/hal-device-module/LICENSE-Apache-2.0.md similarity index 100% rename from Modules/hal-device/LICENSE-Apache-2.0.md rename to Modules/hal-device-module/LICENSE-Apache-2.0.md diff --git a/Modules/hal-device/README.md b/Modules/hal-device-module/README.md similarity index 100% rename from Modules/hal-device/README.md rename to Modules/hal-device-module/README.md diff --git a/Modules/hal-device/Source/drivers/hal_device.cpp b/Modules/hal-device-module/Source/drivers/hal_device.cpp similarity index 97% rename from Modules/hal-device/Source/drivers/hal_device.cpp rename to Modules/hal-device-module/Source/drivers/hal_device.cpp index 7b37198f0..d20e62568 100644 --- a/Modules/hal-device/Source/drivers/hal_device.cpp +++ b/Modules/hal-device-module/Source/drivers/hal_device.cpp @@ -115,10 +115,10 @@ extern struct Module hal_device_module; Driver hal_device_driver = { .name = "hal-device", .compatible = (const char*[]) {"hal-device", nullptr}, - .startDevice = start, - .stopDevice = stop, + .start_device = start, + .stop_device = stop, .api = nullptr, - .deviceType = &HAL_DEVICE_TYPE, + .device_type = &HAL_DEVICE_TYPE, .owner = &hal_device_module, .driver_private = nullptr }; diff --git a/Modules/hal-device/Source/hal/Device.cpp b/Modules/hal-device-module/Source/hal/Device.cpp similarity index 94% rename from Modules/hal-device/Source/hal/Device.cpp rename to Modules/hal-device-module/Source/hal/Device.cpp index 2aab71b07..7b47a1dea 100644 --- a/Modules/hal-device/Source/hal/Device.cpp +++ b/Modules/hal-device-module/Source/hal/Device.cpp @@ -88,7 +88,7 @@ std::vector> findDevices(const std::function _Nullable findDevice(const std::function&)>& filterFunction) { +std::shared_ptr findDevice(const std::function&)>& filterFunction) { auto scoped_mutex = mutex.asScopedLock(); scoped_mutex.lock(); @@ -102,13 +102,13 @@ std::shared_ptr _Nullable findDevice(const std::function _Nullable findDevice(std::string name) { +std::shared_ptr findDevice(std::string name) { return findDevice([&name](auto& device){ return device->getName() == name; }); } -std::shared_ptr _Nullable findDevice(Device::Id id) { +std::shared_ptr findDevice(Device::Id id) { return findDevice([id](auto& device){ return device->getId() == id; }); diff --git a/Modules/hal-device/Source/module.cpp b/Modules/hal-device-module/Source/module.cpp similarity index 100% rename from Modules/hal-device/Source/module.cpp rename to Modules/hal-device-module/Source/module.cpp diff --git a/Modules/lvgl-module/CMakeLists.txt b/Modules/lvgl-module/CMakeLists.txt new file mode 100644 index 000000000..2f299fe67 --- /dev/null +++ b/Modules/lvgl-module/CMakeLists.txt @@ -0,0 +1,30 @@ +cmake_minimum_required(VERSION 3.20) + +file(GLOB_RECURSE SOURCE_FILES Source/*.c*) + +if (DEFINED ENV{ESP_IDF_VERSION}) + + idf_component_register( + SRCS ${SOURCE_FILES} + INCLUDE_DIRS "Include/" + REQUIRES TactilityKernel lvgl esp_lvgl_port + ) + +else () + + add_library(lvgl-module OBJECT) + + target_sources(lvgl-module PRIVATE ${SOURCE_FILES}) + + target_include_directories(lvgl-module + PUBLIC Include/ + ) + + target_link_libraries(lvgl-module PUBLIC + TactilityKernel + freertos_kernel + lvgl + ) + +endif () + diff --git a/Modules/lvgl-module/Include/tactility/lvgl_module.h b/Modules/lvgl-module/Include/tactility/lvgl_module.h new file mode 100644 index 000000000..e18e3a530 --- /dev/null +++ b/Modules/lvgl-module/Include/tactility/lvgl_module.h @@ -0,0 +1,91 @@ +// 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 +#include + +/** + * @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_timed(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(); + +#ifdef __cplusplus +} +#endif diff --git a/Modules/lvgl-module/LICENSE-GPL-3.0.md b/Modules/lvgl-module/LICENSE-GPL-3.0.md new file mode 100644 index 000000000..496acdb2a --- /dev/null +++ b/Modules/lvgl-module/LICENSE-GPL-3.0.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/Modules/lvgl-module/README.md b/Modules/lvgl-module/README.md new file mode 100644 index 000000000..183590a8d --- /dev/null +++ b/Modules/lvgl-module/README.md @@ -0,0 +1,8 @@ +**WARNING: This module contains deprecated code** + +This module is the basis for the old Tactility HAL. +This HAL existed before TactilityKernel. + +The C++ `tt::hal::Device` class is replaced by `struct Device` from TactilityKernel. + +License: Apache v2.0 \ No newline at end of file diff --git a/Modules/lvgl-module/Source/arch/lvgl_esp32.c b/Modules/lvgl-module/Source/arch/lvgl_esp32.c new file mode 100644 index 000000000..9c26a6f66 --- /dev/null +++ b/Modules/lvgl-module/Source/arch/lvgl_esp32.c @@ -0,0 +1,66 @@ +// SPDX-License-Identifier: GPL-3.0-only +#ifdef ESP_PLATFORM + +#include + +#include +#include +#include + +extern struct LvglModuleConfig lvgl_module_config; + +static bool initialized = false; + +bool lvgl_lock(void) { + if (!initialized) return false; + return lvgl_port_lock(portMAX_DELAY); +} + +bool lvgl_try_lock_timed(uint32_t timeout) { + if (!initialized) return false; + return lvgl_port_lock(millis_to_ticks(timeout)); +} + +void lvgl_unlock(void) { + if (!initialized) return; + lvgl_port_unlock(); +} + +error_t lvgl_arch_start() { + const lvgl_port_cfg_t lvgl_cfg = { + .task_priority = lvgl_module_config.task_priority, + .task_stack = lvgl_module_config.task_stack_size, + .task_affinity = lvgl_module_config.task_affinity, + .task_max_sleep_ms = 500, + .timer_period_ms = 5 + }; + + if (lvgl_port_init(&lvgl_cfg) != ESP_OK) { + return ERROR_RESOURCE; + } + + // We must have the state set to "initialized" so that the lvgl lock works + // when we call listener functions. These functions could create new + // devices and services. The latter might start adding widgets immediately. + initialized = true; + + if (lvgl_module_config.on_start) lvgl_module_config.on_start(); + + return ERROR_NONE; +} + +error_t lvgl_arch_stop() { + if (lvgl_module_config.on_stop) lvgl_module_config.on_stop(); + + if (lvgl_port_deinit() != ESP_OK) { + // Call on_start again to recover + if (lvgl_module_config.on_start) lvgl_module_config.on_start(); + return ERROR_RESOURCE; + } + + initialized = false; + + return ERROR_NONE; +} + +#endif \ No newline at end of file diff --git a/Modules/lvgl-module/Source/arch/lvgl_posix.c b/Modules/lvgl-module/Source/arch/lvgl_posix.c new file mode 100644 index 000000000..846af03e4 --- /dev/null +++ b/Modules/lvgl-module/Source/arch/lvgl_posix.c @@ -0,0 +1,148 @@ +// SPDX-License-Identifier: GPL-3.0-only +#ifndef ESP_PLATFORM + +#include +#include +#include +#include +#include +#include + +#include + +#include "tactility/lvgl_module.h" + +extern struct LvglModuleConfig lvgl_module_config; + +// Mutex for LVGL drawing +static struct RecursiveMutex lvgl_mutex; +static bool lvgl_mutex_initialised = false; +static struct RecursiveMutex task_mutex; +static bool task_mutex_initialised = false; + +static uint32_t task_max_sleep_ms = 10; +static TaskHandle_t lvgl_task_handle = NULL; +static bool lvgl_task_interrupt_requested = false; + +#define LVGL_STOP_POLL_INTERVAL 10 +#define LVGL_STOP_TIMEOUT 5000 + +static void task_lock(void) { + if (!task_mutex_initialised) return; + recursive_mutex_lock(&task_mutex); +} + +static void task_unlock(void) { + if (!task_mutex_initialised) return; + recursive_mutex_unlock(&task_mutex); +} + +bool lvgl_lock(void) { + if (!lvgl_mutex_initialised) return false; + recursive_mutex_lock(&lvgl_mutex); + return true; +} + +bool lvgl_try_lock_timed(uint32_t timeout) { + if (!lvgl_mutex_initialised) return false; + return recursive_mutex_try_lock_timed(&lvgl_mutex, millis_to_ticks(timeout)); +} + +void lvgl_unlock(void) { + if (!lvgl_mutex_initialised) return; + recursive_mutex_unlock(&lvgl_mutex); +} + +static void lvgl_task_set_interrupted(bool interrupted) { + task_lock(); + lvgl_task_interrupt_requested = interrupted; + task_unlock(); +} + +static bool lvgl_task_is_interrupt_requested() { + task_lock(); + bool result = lvgl_task_interrupt_requested; + task_unlock(); + return result; +} + +static void lvgl_task(void* arg) { + uint32_t task_delay_ms = task_max_sleep_ms; + + check(!lvgl_task_is_interrupt_requested()); + + // on_start must be called from the task, otherwise the display doesn't work + if (lvgl_module_config.on_start) lvgl_module_config.on_start(); + + while (!lvgl_task_is_interrupt_requested()) { + if (lvgl_try_lock_timed(10)) { + task_delay_ms = lv_timer_handler(); + lvgl_unlock(); + } + if ((task_delay_ms > task_max_sleep_ms) || (1 == task_delay_ms)) { + task_delay_ms = task_max_sleep_ms; + } else if (task_delay_ms < 1) { + task_delay_ms = 1; + } + vTaskDelay(pdMS_TO_TICKS(task_delay_ms)); + } + + if (lvgl_module_config.on_stop) lvgl_module_config.on_stop(); + + task_lock(); + lvgl_task_handle = NULL; + task_unlock(); + + vTaskDelete(NULL); +} + +error_t lvgl_arch_start() { + if (!lvgl_mutex_initialised) { + recursive_mutex_construct(&lvgl_mutex); + lvgl_mutex_initialised = true; + } + + if (!task_mutex_initialised) { + recursive_mutex_construct(&task_mutex); + task_mutex_initialised = true; + } + + lvgl_task_set_interrupted(false); + + lv_init(); + + // Create the main app loop, like ESP-IDF + BaseType_t task_result = xTaskCreate( + lvgl_task, + "lvgl", + lvgl_module_config.task_stack_size, + NULL, + lvgl_module_config.task_priority, + &lvgl_task_handle + ); + + return (task_result == pdTRUE) ? ERROR_NONE : ERROR_RESOURCE; +} + +error_t lvgl_arch_stop() { + TickType_t start_ticks = get_ticks(); + lvgl_task_set_interrupted(true); + while (true) { + task_lock(); + bool done = (lvgl_task_handle == NULL); + task_unlock(); + if (done) break; + + delay_ticks(LVGL_STOP_POLL_INTERVAL); + + if (get_ticks() - start_ticks > LVGL_STOP_TIMEOUT) { + return ERROR_TIMEOUT; + } + } + + lv_deinit(); + + return ERROR_NONE; +} + +#endif diff --git a/Modules/lvgl-module/Source/lvgl_module.c b/Modules/lvgl-module/Source/lvgl_module.c new file mode 100644 index 000000000..2c48c29ce --- /dev/null +++ b/Modules/lvgl-module/Source/lvgl_module.c @@ -0,0 +1,67 @@ +// SPDX-License-Identifier: GPL-3.0-only +#include +#include +#include +#include + + +error_t lvgl_arch_start(); +error_t lvgl_arch_stop(); + +static bool is_running = false; +static bool is_configured = false; + +struct LvglModuleConfig lvgl_module_config = { + NULL, + NULL, + 0, + 0, +#ifdef ESP_PLATFORM + 0, +#endif +}; + +void lvgl_module_configure(const struct LvglModuleConfig config) { + is_configured = true; + memcpy(&lvgl_module_config, &config, sizeof(struct LvglModuleConfig)); +} + +static error_t start() { + if (!is_configured) { + return ERROR_INVALID_STATE; + } + + if (is_running) { + return ERROR_NONE; + } + + error_t result = lvgl_arch_start(); + if (result == ERROR_NONE) { + is_running = true; + } + + return result; +} + +static error_t stop() { + if (!is_running) { + return ERROR_NONE; + } + + error_t error = lvgl_arch_stop(); + if (error == ERROR_NONE) { + is_running = false; + } + + return error; +} + +bool lvgl_is_running() { + return is_running; +} + +struct Module lvgl_module = { + .name = "lvgl", + .start = start, + .stop = stop +}; diff --git a/Platforms/PlatformEsp32/Source/drivers/esp32_gpio.cpp b/Platforms/PlatformEsp32/Source/drivers/esp32_gpio.cpp index 3e3c1dd19..a71d06314 100644 --- a/Platforms/PlatformEsp32/Source/drivers/esp32_gpio.cpp +++ b/Platforms/PlatformEsp32/Source/drivers/esp32_gpio.cpp @@ -118,10 +118,10 @@ extern struct Module platform_module; Driver esp32_gpio_driver = { .name = "esp32_gpio", .compatible = (const char*[]) { "espressif,esp32-gpio", nullptr }, - .startDevice = start, - .stopDevice = stop, + .start_device = start, + .stop_device = stop, .api = (void*)&esp32_gpio_api, - .deviceType = &GPIO_CONTROLLER_TYPE, + .device_type = &GPIO_CONTROLLER_TYPE, .owner = &platform_module, .driver_private = nullptr }; diff --git a/Platforms/PlatformEsp32/Source/drivers/esp32_i2c.cpp b/Platforms/PlatformEsp32/Source/drivers/esp32_i2c.cpp index 309aec821..969b382ef 100644 --- a/Platforms/PlatformEsp32/Source/drivers/esp32_i2c.cpp +++ b/Platforms/PlatformEsp32/Source/drivers/esp32_i2c.cpp @@ -211,10 +211,10 @@ extern struct Module platform_module; Driver esp32_i2c_driver = { .name = "esp32_i2c", .compatible = (const char*[]) { "espressif,esp32-i2c", nullptr }, - .startDevice = start, - .stopDevice = stop, + .start_device = start, + .stop_device = stop, .api = (void*)&esp32_i2c_api, - .deviceType = &I2C_CONTROLLER_TYPE, + .device_type = &I2C_CONTROLLER_TYPE, .owner = &platform_module, .driver_private = nullptr }; diff --git a/Platforms/PlatformPosix/Source/freertos.c b/Platforms/PlatformPosix/Source/freertos.c new file mode 100644 index 000000000..b99b1c7bf --- /dev/null +++ b/Platforms/PlatformPosix/Source/freertos.c @@ -0,0 +1,20 @@ +#include +#if defined(__GLIBC__) +#include +#endif +#include +#include + +#define TAG LOG_TAG(freertos) + +/** + * Assert implementation as defined in the FreeRTOSConfig.h + */ +void vAssertCalled(unsigned long line, const char* const file) { + LOG_E("Assert triggered at {}:{}", file, line); +#if defined(__GLIBC__) + __assert_fail("assert failed", file, line, ""); +#else + abort(); +#endif +} diff --git a/Platforms/PlatformPosix/Source/module.cpp b/Platforms/PlatformPosix/Source/module.cpp index c199b7b60..5a12aa9ee 100644 --- a/Platforms/PlatformPosix/Source/module.cpp +++ b/Platforms/PlatformPosix/Source/module.cpp @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: Apache-2.0 #include extern "C" { diff --git a/Tactility/CMakeLists.txt b/Tactility/CMakeLists.txt index ab506210b..647eae2ed 100644 --- a/Tactility/CMakeLists.txt +++ b/Tactility/CMakeLists.txt @@ -8,8 +8,8 @@ if (DEFINED ENV{ESP_IDF_VERSION}) PlatformEsp32 TactilityCore TactilityFreeRtos - hal-device - lvgl + hal-device-module + lvgl-module driver elf_loader lv_screenshot @@ -17,7 +17,6 @@ if (DEFINED ENV{ESP_IDF_VERSION}) esp_http_server esp_http_client esp-tls - esp_lvgl_port esp_wifi json minitar @@ -63,16 +62,14 @@ else() PUBLIC Include/ ) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) - target_link_libraries(Tactility PUBLIC cJSON TactilityFreeRtos TactilityCore TactilityKernel PlatformPosix - hal-device + hal-device-module + lvgl-module freertos_kernel lvgl lv_screenshot diff --git a/Tactility/Include/Tactility/Tactility.h b/Tactility/Include/Tactility/Tactility.h index 612694d2e..4e2bc337d 100644 --- a/Tactility/Include/Tactility/Tactility.h +++ b/Tactility/Include/Tactility/Tactility.h @@ -27,9 +27,10 @@ void run(const Configuration& config, Module* platformModule, Module* deviceModu /** * While technically nullable, this instance is always set if tt_init() succeeds. + * Could return nullptr if init was not called. * @return the Configuration instance that was passed on to tt_init() if init is successful */ -const Configuration* _Nullable getConfiguration(); +const Configuration* getConfiguration(); /** Provides access to the dispatcher that runs on the main task. * @warning This dispatcher is used for WiFi and might block for some time during WiFi connection. @@ -40,7 +41,7 @@ Dispatcher& getMainDispatcher(); namespace hal { /** While technically this configuration is nullable, it's never null after initHeadless() is called. */ -const Configuration* _Nullable getConfiguration(); +const Configuration* getConfiguration(); } // namespace hal diff --git a/Tactility/Include/Tactility/app/App.h b/Tactility/Include/Tactility/app/App.h index 5bab58040..e60bd5919 100644 --- a/Tactility/Include/Tactility/app/App.h +++ b/Tactility/Include/Tactility/app/App.h @@ -44,7 +44,8 @@ class App { virtual void onDestroy(AppContext& appContext) {} virtual void onShow(AppContext& appContext, lv_obj_t* parent) {} virtual void onHide(AppContext& appContext) {} - virtual void onResult(AppContext& appContext, LaunchId launchId, Result result, std::unique_ptr _Nullable resultData) {} + /** resultData could be null */ + virtual void onResult(AppContext& appContext, LaunchId launchId, Result result, std::unique_ptr resultData) {} Mutex& getMutex() { return mutex; } @@ -81,9 +82,9 @@ std::shared_ptr create() { return std::shared_ptr(new T); } /** * @brief Start an app * @param[in] id application name or id - * @param[in] parameters optional parameters to pass onto the application + * @param[in] parameters optional parameters to pass onto the application. can be nullptr. */ -LaunchId start(const std::string& id, std::shared_ptr _Nullable parameters = nullptr); +LaunchId start(const std::string& id, std::shared_ptr parameters = nullptr); /** @brief Stop the currently showing app. Show the previous app if any app was still running. */ void stop(); @@ -103,10 +104,10 @@ void stopAll(const std::string& id); bool isRunning(const std::string& id); /** @return the currently running app context (it is only ever null before the splash screen is shown) */ -std::shared_ptr _Nullable getCurrentAppContext(); +std::shared_ptr getCurrentAppContext(); /** @return the currently running app (it is only ever null before the splash screen is shown) */ -std::shared_ptr _Nullable getCurrentApp(); +std::shared_ptr getCurrentApp(); bool install(const std::string& path); diff --git a/Tactility/Include/Tactility/app/AppRegistration.h b/Tactility/Include/Tactility/app/AppRegistration.h index 9890a016f..dc6595d63 100644 --- a/Tactility/Include/Tactility/app/AppRegistration.h +++ b/Tactility/Include/Tactility/app/AppRegistration.h @@ -18,7 +18,7 @@ bool removeAppManifest(const std::string& id); * @param[in] id the manifest id * @return the application manifest if it was found */ -_Nullable std::shared_ptr findAppManifestById(const std::string& id); +std::shared_ptr findAppManifestById(const std::string& id); /** @return a list of all registered apps. This includes user and system apps. */ std::vector> getAppManifests(); diff --git a/Tactility/Include/Tactility/app/ElfApp.h b/Tactility/Include/Tactility/app/ElfApp.h index b1dd61f20..6a3d9f35c 100644 --- a/Tactility/Include/Tactility/app/ElfApp.h +++ b/Tactility/Include/Tactility/app/ElfApp.h @@ -8,20 +8,26 @@ namespace tt::app { typedef void* (*CreateData)(); typedef void (*DestroyData)(void* data); -typedef void (*OnCreate)(void* appContext, void* _Nullable data); -typedef void (*OnDestroy)(void* appContext, void* _Nullable data); -typedef void (*OnShow)(void* appContext, void* _Nullable data, lv_obj_t* parent); -typedef void (*OnHide)(void* appContext, void* _Nullable data); -typedef void (*OnResult)(void* appContext, void* _Nullable data, LaunchId launchId, Result result, Bundle* resultData); +/** data is nullable */ +typedef void (*OnCreate)(void* appContext, void* data); +/** data is nullable */ +typedef void (*OnDestroy)(void* appContext, void* data); +/** data is nullable */ +typedef void (*OnShow)(void* appContext, void* data, lv_obj_t* parent); +/** data is nullable */ +typedef void (*OnHide)(void* appContext, void* data); +/** data is nullable, resultData is nullable. */ +typedef void (*OnResult)(void* appContext, void* data, LaunchId launchId, Result result, Bundle* resultData); +/** All fields are nullable */ void setElfAppParameters( - CreateData _Nullable createData, - DestroyData _Nullable destroyData, - OnCreate _Nullable onCreate, - OnDestroy _Nullable onDestroy, - OnShow _Nullable onShow, - OnHide _Nullable onHide, - OnResult _Nullable onResult + CreateData createData, + DestroyData destroyData, + OnCreate onCreate, + OnDestroy onDestroy, + OnShow onShow, + OnHide onHide, + OnResult onResult ); std::shared_ptr createElfApp(const std::shared_ptr& manifest); diff --git a/Tactility/Include/Tactility/file/FileLock.h b/Tactility/Include/Tactility/file/FileLock.h index 06fc62f20..a7b615801 100644 --- a/Tactility/Include/Tactility/file/FileLock.h +++ b/Tactility/Include/Tactility/file/FileLock.h @@ -15,6 +15,6 @@ namespace tt::file { * @param[in] path the path to find a lock for * @return a lock instance when a lock was found, otherwise nullptr */ -std::shared_ptr _Nullable findLock(const std::string& path); +std::shared_ptr findLock(const std::string& path); } diff --git a/Tactility/Include/Tactility/hal/Configuration.h b/Tactility/Include/Tactility/hal/Configuration.h index f78f2d56f..bbaad9c58 100644 --- a/Tactility/Include/Tactility/hal/Configuration.h +++ b/Tactility/Include/Tactility/hal/Configuration.h @@ -31,7 +31,7 @@ struct Configuration { * Called before I2C/SPI/etc is initialized. * Used for powering on the peripherals manually. */ - const InitBoot _Nullable initBoot = nullptr; + const InitBoot initBoot = nullptr; /** Init behaviour: default (esp_lvgl_port for ESP32, nothing for PC) or None (nothing on any platform). Only used in Tactility, not in TactilityHeadless. */ const LvglInit lvglInit = LvglInit::Default; diff --git a/Tactility/Include/Tactility/hal/display/DisplayDevice.h b/Tactility/Include/Tactility/hal/display/DisplayDevice.h index d7da87161..7620dfd8b 100644 --- a/Tactility/Include/Tactility/hal/display/DisplayDevice.h +++ b/Tactility/Include/Tactility/hal/display/DisplayDevice.h @@ -26,7 +26,8 @@ class DisplayDevice : public Device { virtual bool isPoweredOn() const { return true; } virtual bool supportsPowerControl() const { return false; } - virtual std::shared_ptr _Nullable getTouchDevice() = 0; + /** Could return nullptr if not started */ + virtual std::shared_ptr getTouchDevice() = 0; /** Set a value in the range [0, 255] */ virtual void setBacklightDuty(uint8_t backlightDuty) { /* NO-OP */ } @@ -40,10 +41,12 @@ class DisplayDevice : public Device { virtual bool startLvgl() = 0; virtual bool stopLvgl() = 0; - virtual lv_display_t* _Nullable getLvglDisplay() const = 0; + /** Could return nullptr if not started */ + virtual lv_display_t* getLvglDisplay() const = 0; virtual bool supportsDisplayDriver() const = 0; - virtual std::shared_ptr _Nullable getDisplayDriver() = 0; + /** Could return nullptr if not supported */ + virtual std::shared_ptr getDisplayDriver() = 0; }; } // namespace tt::hal::display diff --git a/Tactility/Include/Tactility/hal/encoder/EncoderDevice.h b/Tactility/Include/Tactility/hal/encoder/EncoderDevice.h index 14e6e7a82..7880c45a4 100644 --- a/Tactility/Include/Tactility/hal/encoder/EncoderDevice.h +++ b/Tactility/Include/Tactility/hal/encoder/EncoderDevice.h @@ -17,7 +17,8 @@ class EncoderDevice : public Device { virtual bool startLvgl(lv_display_t* display) = 0; virtual bool stopLvgl() = 0; - virtual lv_indev_t* _Nullable getLvglIndev() = 0; + /** Could return nullptr if not started */ + virtual lv_indev_t* getLvglIndev() = 0; }; } diff --git a/Tactility/Include/Tactility/hal/gps/GpsDevice.h b/Tactility/Include/Tactility/hal/gps/GpsDevice.h index 74b5b2ea6..c9355e933 100644 --- a/Tactility/Include/Tactility/hal/gps/GpsDevice.h +++ b/Tactility/Include/Tactility/hal/gps/GpsDevice.h @@ -48,7 +48,7 @@ class GpsDevice : public Device { const GpsConfiguration configuration; RecursiveMutex mutex; - std::unique_ptr _Nullable thread; + std::unique_ptr thread; bool threadInterrupted = false; std::vector ggaSubscriptions; std::vector rmcSubscriptions; diff --git a/Tactility/Include/Tactility/hal/keyboard/KeyboardDevice.h b/Tactility/Include/Tactility/hal/keyboard/KeyboardDevice.h index 71630a093..7c996569a 100644 --- a/Tactility/Include/Tactility/hal/keyboard/KeyboardDevice.h +++ b/Tactility/Include/Tactility/hal/keyboard/KeyboardDevice.h @@ -20,7 +20,8 @@ class KeyboardDevice : public Device { /** @return true when the keyboard currently is physically attached */ virtual bool isAttached() const = 0; - virtual lv_indev_t* _Nullable getLvglIndev() = 0; + /** Could return nullptr if not started */ + virtual lv_indev_t* getLvglIndev() = 0; }; } diff --git a/Tactility/Include/Tactility/hal/sdcard/SdCardDevice.h b/Tactility/Include/Tactility/hal/sdcard/SdCardDevice.h index 208be2d7c..a9588e242 100644 --- a/Tactility/Include/Tactility/hal/sdcard/SdCardDevice.h +++ b/Tactility/Include/Tactility/hal/sdcard/SdCardDevice.h @@ -67,8 +67,8 @@ class SdCardDevice : public Device { bool isMounted(TickType_t timeout = kernel::MAX_TICKS) const { return getState(timeout) == State::Mounted; } }; -/** Return the SdCard device if the path is within the SdCard mounted path (path std::string::starts_with() check)*/ -std::shared_ptr _Nullable find(const std::string& path); +/** Return the SdCard device if the path is within the SdCard mounted path (path std::string::starts_with() check), otherwise return nullptr */ +std::shared_ptr find(const std::string& path); /** * Attempt to find an SD card that the specified belongs to, diff --git a/Tactility/Include/Tactility/hal/sdcard/SdmmcDevice.h b/Tactility/Include/Tactility/hal/sdcard/SdmmcDevice.h index 113b60bb0..e1e50e0d1 100644 --- a/Tactility/Include/Tactility/hal/sdcard/SdmmcDevice.h +++ b/Tactility/Include/Tactility/hal/sdcard/SdmmcDevice.h @@ -82,7 +82,8 @@ class SdmmcDevice final : public SdCardDevice { State getState(TickType_t timeout) const override; - sdmmc_card_t* _Nullable getCard() { return card; } + /** return card when mounted, otherwise return nullptr */ + sdmmc_card_t* getCard() { return card; } }; } diff --git a/Tactility/Include/Tactility/hal/sdcard/SpiSdCardDevice.h b/Tactility/Include/Tactility/hal/sdcard/SpiSdCardDevice.h index 4ca1877ed..61c80efdd 100644 --- a/Tactility/Include/Tactility/hal/sdcard/SpiSdCardDevice.h +++ b/Tactility/Include/Tactility/hal/sdcard/SpiSdCardDevice.h @@ -29,7 +29,7 @@ class SpiSdCardDevice final : public SdCardDevice { gpio_num_t spiPinInt, MountBehaviour mountBehaviourAtBoot, /** When customLock is a nullptr, use the SPI default one */ - std::shared_ptr _Nullable customLock = nullptr, + std::shared_ptr customLock = nullptr, std::vector csPinWorkAround = std::vector(), spi_host_device_t spiHost = SPI2_HOST, int spiFrequencyKhz = SDMMC_FREQ_DEFAULT @@ -50,7 +50,7 @@ class SpiSdCardDevice final : public SdCardDevice { gpio_num_t spiPinWp; // Write-protect gpio_num_t spiPinInt; // Interrupt MountBehaviour mountBehaviourAtBoot; - std::shared_ptr _Nullable customLock; + std::shared_ptr customLock; // can be nullptr std::vector csPinWorkAround; spi_host_device_t spiHost; bool formatOnMountFailed = false; @@ -91,7 +91,8 @@ class SpiSdCardDevice final : public SdCardDevice { State getState(TickType_t timeout) const override; - sdmmc_card_t* _Nullable getCard() { return card; } + /** return card when mounted, otherwise return nullptr */ + sdmmc_card_t* getCard() { return card; } }; } diff --git a/Tactility/Include/Tactility/hal/spi/Spi.h b/Tactility/Include/Tactility/hal/spi/Spi.h index 4ca52f098..2a48acd22 100644 --- a/Tactility/Include/Tactility/hal/spi/Spi.h +++ b/Tactility/Include/Tactility/hal/spi/Spi.h @@ -24,7 +24,7 @@ struct Configuration { /** Whether configuration can be changed. */ bool isMutable; /** Optional custom lock - otherwise creates one internally */ - std::shared_ptr _Nullable lock; + std::shared_ptr lock; }; enum class Status { diff --git a/Tactility/Include/Tactility/hal/touch/TouchDevice.h b/Tactility/Include/Tactility/hal/touch/TouchDevice.h index 9616aab6e..84c97e313 100644 --- a/Tactility/Include/Tactility/hal/touch/TouchDevice.h +++ b/Tactility/Include/Tactility/hal/touch/TouchDevice.h @@ -22,11 +22,13 @@ class TouchDevice : public Device { virtual bool startLvgl(lv_display_t* display) = 0; virtual bool stopLvgl() = 0; - virtual lv_indev_t* _Nullable getLvglIndev() = 0; + /** Could return nullptr if not started */ + virtual lv_indev_t* getLvglIndev() = 0; virtual bool supportsTouchDriver() = 0; - virtual std::shared_ptr _Nullable getTouchDriver() = 0; + /** Could return nullptr if not supported */ + virtual std::shared_ptr getTouchDriver() = 0; }; } diff --git a/Tactility/Include/Tactility/hal/touch/TouchDriver.h b/Tactility/Include/Tactility/hal/touch/TouchDriver.h index a14f3abb5..4db3b2c7f 100644 --- a/Tactility/Include/Tactility/hal/touch/TouchDriver.h +++ b/Tactility/Include/Tactility/hal/touch/TouchDriver.h @@ -11,13 +11,13 @@ class TouchDriver { * * @param[in] x array of X coordinates * @param[in] y array of Y coordinates - * @param[in] strength optional array of strengths + * @param[in] strength optional array of strengths (nullable) * @param[in] pointCount the number of points currently touched on the screen * @param[in] maxPointCount the maximum number of points that can be touched at once * * @return true when touched and coordinates are available */ - virtual bool getTouchedPoints(uint16_t* x, uint16_t* y, uint16_t* _Nullable strength, uint8_t* pointCount, uint8_t maxPointCount) = 0; + virtual bool getTouchedPoints(uint16_t* x, uint16_t* y, uint16_t* strength, uint8_t* pointCount, uint8_t maxPointCount) = 0; }; } diff --git a/Tactility/Include/Tactility/kernel/SystemEvents.h b/Tactility/Include/Tactility/kernel/SystemEvents.h index 80f3e485c..dc2daa3c1 100644 --- a/Tactility/Include/Tactility/kernel/SystemEvents.h +++ b/Tactility/Include/Tactility/kernel/SystemEvents.h @@ -12,11 +12,6 @@ enum class SystemEvent { /** Gained IP address */ NetworkConnected, NetworkDisconnected, - /** LVGL devices are initialized and usable */ - LvglStarted, - /** LVGL devices were removed and not usable anymore */ - LvglStopped, - /** An important system time-related event, such as NTP update or time-zone change */ Time, }; diff --git a/Tactility/Include/Tactility/lvgl/LvglSync.h b/Tactility/Include/Tactility/lvgl/LvglSync.h index 35a057972..f579358db 100644 --- a/Tactility/Include/Tactility/lvgl/LvglSync.h +++ b/Tactility/Include/Tactility/lvgl/LvglSync.h @@ -8,23 +8,13 @@ namespace tt::lvgl { constexpr TickType_t defaultLockTime = 500 / portTICK_PERIOD_MS; -/** - * LVGL locking function - * @param[in] timeoutMillis timeout in milliseconds. waits forever when 0 is passed. - * @warning this works with milliseconds, as opposed to every other FreeRTOS function that works in ticks! - * @warning when passing zero, we wait forever, as this is the default behaviour for esp_lvgl_port, and we want it to remain consistent - */ -typedef bool (*LvglLock)(uint32_t timeoutMillis); -typedef void (*LvglUnlock)(); - -void syncSet(LvglLock lock, LvglUnlock unlock); - /** * LVGL locking function * @param[in] timeout as ticks * @warning when passing zero, we wait forever, as this is the default behaviour for esp_lvgl_port, and we want it to remain consistent */ -bool lock(TickType_t timeout); +bool lock(TickType_t timeout = portMAX_DELAY); + void unlock(); std::shared_ptr getSyncLock(); diff --git a/Tactility/Include/Tactility/service/ServiceRegistration.h b/Tactility/Include/Tactility/service/ServiceRegistration.h index ed5c24a98..a23a882ac 100644 --- a/Tactility/Include/Tactility/service/ServiceRegistration.h +++ b/Tactility/Include/Tactility/service/ServiceRegistration.h @@ -40,26 +40,26 @@ State getState(const std::string& id); * @param[in] id the id as defined in the manifest * @return the matching manifest or nullptr when it wasn't found */ -std::shared_ptr _Nullable findManifestById(const std::string& id); +std::shared_ptr findManifestById(const std::string& id); /** Find a ServiceContext by its manifest id. * @param[in] id the id as defined in the manifest * @return the service context or nullptr when it wasn't found */ -std::shared_ptr _Nullable findServiceContextById(const std::string& id); +std::shared_ptr findServiceContextById(const std::string& id); /** Find a Service by its manifest id. * @param[in] id the id as defined in the manifest * @return the service context or nullptr when it wasn't found */ -std::shared_ptr _Nullable findServiceById(const std::string& id); +std::shared_ptr findServiceById(const std::string& id); /** Find a Service by its manifest id. * @param[in] id the id as defined in the manifest * @return the service context or nullptr when it wasn't found */ template -std::shared_ptr _Nullable findServiceById(const std::string& id) { +std::shared_ptr findServiceById(const std::string& id) { return std::static_pointer_cast(findServiceById(id)); } diff --git a/Tactility/Include/Tactility/service/gps/GpsService.h b/Tactility/Include/Tactility/service/gps/GpsService.h index 011bd3785..4c1fc6c57 100644 --- a/Tactility/Include/Tactility/service/gps/GpsService.h +++ b/Tactility/Include/Tactility/service/gps/GpsService.h @@ -34,7 +34,8 @@ class GpsService final : public Service { bool startGpsDevice(GpsDeviceRecord& deviceRecord); static bool stopGpsDevice(GpsDeviceRecord& deviceRecord); - GpsDeviceRecord* _Nullable findGpsRecord(const std::shared_ptr& record); + /** return nullptr when not found */ + GpsDeviceRecord* findGpsRecord(const std::shared_ptr& record); void onGgaSentence(hal::Device::Id deviceId, const minmea_sentence_gga& gga); void onRmcSentence(hal::Device::Id deviceId, const minmea_sentence_rmc& rmc); diff --git a/Tactility/Include/Tactility/service/loader/Loader.h b/Tactility/Include/Tactility/service/loader/Loader.h index aeee37258..de78ed41f 100644 --- a/Tactility/Include/Tactility/service/loader/Loader.h +++ b/Tactility/Include/Tactility/service/loader/Loader.h @@ -62,10 +62,10 @@ class LoaderService final : public Service { /** * @brief Start an app given an app id and an optional bundle with parameters * @param id the app identifier - * @param parameters optional parameter bundle + * @param parameters optional parameter bundle (nullable) * @return the launch id */ - app::LaunchId start(const std::string& id, std::shared_ptr _Nullable parameters); + app::LaunchId start(const std::string& id, std::shared_ptr parameters); /** * @brief Stops the top-most app (the one that is currently active shown to the user @@ -85,8 +85,8 @@ class LoaderService final : public Service { */ void stopAll(const std::string& id); - /** @return the AppContext of the top-most application */ - std::shared_ptr _Nullable getCurrentAppContext(); + /** @return the AppContext of the top-most application, or nullptr if no app is running. */ + std::shared_ptr getCurrentAppContext(); /** @return true if the app is running anywhere in the app stack (the app does not have to be the top-most one for this to return true) */ bool isRunning(const std::string& id) const; @@ -95,6 +95,7 @@ class LoaderService final : public Service { std::shared_ptr> getPubsub() const { return pubsubExternal; } }; -std::shared_ptr _Nullable findLoaderService(); +/** return the service or nullptr if it's not running */ +std::shared_ptr findLoaderService(); } // namespace diff --git a/Tactility/Private/Tactility/app/AppInstance.h b/Tactility/Private/Tactility/app/AppInstance.h index 3e54ee8f5..f671392a0 100644 --- a/Tactility/Private/Tactility/app/AppInstance.h +++ b/Tactility/Private/Tactility/app/AppInstance.h @@ -36,7 +36,7 @@ class AppInstance : public AppContext { * When these are stored in the app struct, the struct takes ownership. * Do not mutate after app creation. */ - std::shared_ptr _Nullable parameters; + std::shared_ptr parameters; std::shared_ptr app; diff --git a/Tactility/Private/Tactility/lvgl/EspLvglPort.h b/Tactility/Private/Tactility/lvgl/EspLvglPort.h deleted file mode 100644 index a1db1de01..000000000 --- a/Tactility/Private/Tactility/lvgl/EspLvglPort.h +++ /dev/null @@ -1,11 +0,0 @@ -#pragma once - -#ifdef ESP_PLATFORM - -namespace tt::lvgl { - -bool initEspLvglPort(); - -} - -#endif diff --git a/Tactility/Private/Tactility/lvgl/LvglPrivate.h b/Tactility/Private/Tactility/lvgl/LvglPrivate.h index 76dfd4937..0567d1681 100644 --- a/Tactility/Private/Tactility/lvgl/LvglPrivate.h +++ b/Tactility/Private/Tactility/lvgl/LvglPrivate.h @@ -1,9 +1,11 @@ #pragma once -#include +#include namespace tt::lvgl { -void init(const hal::Configuration& config); +void attachDevices(); -} // namespace +void detachDevices(); + +} diff --git a/Tactility/Private/Tactility/service/gui/GuiService.h b/Tactility/Private/Tactility/service/gui/GuiService.h index a3830774f..9ae0f3da0 100644 --- a/Tactility/Private/Tactility/service/gui/GuiService.h +++ b/Tactility/Private/Tactility/service/gui/GuiService.h @@ -39,7 +39,7 @@ class GuiService final : public Service { // App-specific std::shared_ptr appToRender = nullptr; - lv_obj_t* _Nullable keyboard = nullptr; + lv_obj_t* keyboard = nullptr; lv_group_t* keyboardGroup = nullptr; bool isStarted = false; diff --git a/Tactility/Private/Tactility/service/screenshot/Screenshot.h b/Tactility/Private/Tactility/service/screenshot/Screenshot.h index 0e4dd641c..2fe89576a 100644 --- a/Tactility/Private/Tactility/service/screenshot/Screenshot.h +++ b/Tactility/Private/Tactility/service/screenshot/Screenshot.h @@ -48,7 +48,7 @@ class ScreenshotService final : public Service { void stop(); }; -std::shared_ptr _Nullable optScreenshotService(); +std::shared_ptr optScreenshotService(); } // namespace diff --git a/Tactility/Source/Tactility.cpp b/Tactility/Source/Tactility.cpp index e628fbdce..1445fb91a 100644 --- a/Tactility/Source/Tactility.cpp +++ b/Tactility/Source/Tactility.cpp @@ -2,11 +2,15 @@ #include #endif +#include +#include + #include #include #include #include +#include #include #include #include @@ -19,14 +23,12 @@ #include #include #include -#include #include +#include #include #include - -#include -#include +#include #ifdef ESP_PLATFORM #include @@ -336,8 +338,9 @@ void run(const Configuration& config, Module* platformModule, Module* deviceModu return; } - // HAL compatibility module: it creates kernel driver wrappers for tt::hal::Device + // Module parent check(module_parent_construct(&tactility_module_parent) == ERROR_NONE); + // hal-device-module check(module_set_parent(&hal_device_module, &tactility_module_parent) == ERROR_NONE); check(module_start(&hal_device_module) == ERROR_NONE); @@ -355,7 +358,22 @@ void run(const Configuration& config, Module* platformModule, Module* deviceModu network::ntp::init(); registerAndStartPrimaryServices(); - lvgl::init(hardware); + + lvgl_module_configure((LvglModuleConfig) { + .on_start = lvgl::attachDevices, + .on_stop = lvgl::detachDevices, + .task_priority = THREAD_PRIORITY_HIGHER, + /** Minimum seems to be about 3500. In some scenarios, the WiFi app crashes at 8192, + * so we now have 9120 to run in a stable manner. We should figure out a way to avoid this. + * Perhaps we can give apps their own stack space and deal with lvgl callback handlers in a clever way. */ + .task_stack_size = 9120, +#ifdef ESP_PLATFORM + .task_affinity = getCpuAffinityConfiguration().graphics +#endif + }); + check(module_set_parent(&lvgl_module, &tactility_module_parent) == ERROR_NONE); + lvgl::start(); + registerAndStartSecondaryServices(); LOGGER.info("Core systems ready"); @@ -371,7 +389,8 @@ void run(const Configuration& config, Module* platformModule, Module* deviceModu } } -const Configuration* _Nullable getConfiguration() { +/** return the configuration or nullptr if it's not initialized */ +const Configuration* getConfiguration() { return config_instance; } diff --git a/Tactility/Source/app/App.cpp b/Tactility/Source/app/App.cpp index 63a2a80c8..598cbe56b 100644 --- a/Tactility/Source/app/App.cpp +++ b/Tactility/Source/app/App.cpp @@ -5,7 +5,7 @@ namespace tt::app { constexpr auto* TAG = "App"; -LaunchId start(const std::string& id, std::shared_ptr _Nullable parameters) { +LaunchId start(const std::string& id, std::shared_ptr parameters) { const auto service = service::loader::findLoaderService(); assert(service != nullptr); return service->start(id, std::move(parameters)); @@ -35,15 +35,15 @@ bool isRunning(const std::string& id) { return service->isRunning(id); } -std::shared_ptr _Nullable getCurrentAppContext() { +std::shared_ptr getCurrentAppContext() { const auto service = service::loader::findLoaderService(); assert(service != nullptr); return service->getCurrentAppContext(); } -std::shared_ptr _Nullable getCurrentApp() { +std::shared_ptr getCurrentApp() { const auto app_context = getCurrentAppContext(); - return (app_context != nullptr) ? app_context->getApp() : nullptr; + return (app_context != nullptr) ? app_context->getApp() : nullptr; } } diff --git a/Tactility/Source/app/AppRegistration.cpp b/Tactility/Source/app/AppRegistration.cpp index 1fa97976d..e2db7b4c4 100644 --- a/Tactility/Source/app/AppRegistration.cpp +++ b/Tactility/Source/app/AppRegistration.cpp @@ -39,7 +39,7 @@ bool removeAppManifest(const std::string& id) { return app_manifest_map.erase(id) == 1; } -_Nullable std::shared_ptr findAppManifestById(const std::string& id) { +std::shared_ptr findAppManifestById(const std::string& id) { hash_mutex.lock(); auto result = app_manifest_map.find(id); hash_mutex.unlock(); diff --git a/Tactility/Source/app/ElfApp.cpp b/Tactility/Source/app/ElfApp.cpp index 384a9a996..59d99c8a9 100644 --- a/Tactility/Source/app/ElfApp.cpp +++ b/Tactility/Source/app/ElfApp.cpp @@ -34,13 +34,13 @@ class ElfApp final : public App { public: struct Parameters { - CreateData _Nullable createData = nullptr; - DestroyData _Nullable destroyData = nullptr; - OnCreate _Nullable onCreate = nullptr; - OnDestroy _Nullable onDestroy = nullptr; - OnShow _Nullable onShow = nullptr; - OnHide _Nullable onHide = nullptr; - OnResult _Nullable onResult = nullptr; + CreateData createData = nullptr; + DestroyData destroyData = nullptr; + OnCreate onCreate = nullptr; + OnDestroy onDestroy = nullptr; + OnShow onShow = nullptr; + OnHide onHide = nullptr; + OnResult onResult = nullptr; }; static void setParameters(const Parameters& parameters) { @@ -202,13 +202,13 @@ size_t ElfApp::staticParametersSetCount = 0; std::shared_ptr ElfApp::staticParametersLock = std::make_shared(); void setElfAppParameters( - CreateData _Nullable createData, - DestroyData _Nullable destroyData, - OnCreate _Nullable onCreate, - OnDestroy _Nullable onDestroy, - OnShow _Nullable onShow, - OnHide _Nullable onHide, - OnResult _Nullable onResult + CreateData createData, + DestroyData destroyData, + OnCreate onCreate, + OnDestroy onDestroy, + OnShow onShow, + OnHide onHide, + OnResult onResult ) { ElfApp::setParameters({ .createData = createData, diff --git a/Tactility/Source/app/apphub/AppHubApp.cpp b/Tactility/Source/app/apphub/AppHubApp.cpp index a65960249..bed3fa2d9 100644 --- a/Tactility/Source/app/apphub/AppHubApp.cpp +++ b/Tactility/Source/app/apphub/AppHubApp.cpp @@ -30,7 +30,7 @@ class AppHubApp final : public App { std::vector entries; Mutex mutex; - static std::shared_ptr _Nullable findAppInstance() { + static std::shared_ptr findAppInstance() { auto app_context = getCurrentAppContext(); if (app_context->getManifest().appId != manifest.appId) { return nullptr; diff --git a/Tactility/Source/app/i2cscanner/I2cScanner.cpp b/Tactility/Source/app/i2cscanner/I2cScanner.cpp index 280142b5c..e1156edec 100644 --- a/Tactility/Source/app/i2cscanner/I2cScanner.cpp +++ b/Tactility/Source/app/i2cscanner/I2cScanner.cpp @@ -71,7 +71,7 @@ class I2cScannerApp final : public App { }; /** Returns the app data if the app is active. Note that this could clash if the same app is started twice and a background thread is slow. */ -std::shared_ptr _Nullable optApp() { +std::shared_ptr optApp() { auto appContext = getCurrentAppContext(); if (appContext != nullptr && appContext->getManifest().appId == manifest.appId) { return std::static_pointer_cast(appContext->getApp()); diff --git a/Tactility/Source/app/power/Power.cpp b/Tactility/Source/app/power/Power.cpp index 571b7e210..7bf50b12c 100644 --- a/Tactility/Source/app/power/Power.cpp +++ b/Tactility/Source/app/power/Power.cpp @@ -20,7 +20,7 @@ extern const AppManifest manifest; class PowerApp; /** Returns the app data if the app is active. Note that this could clash if the same app is started twice and a background thread is slow. */ -std::shared_ptr _Nullable optApp() { +std::shared_ptr optApp() { auto appContext = getCurrentAppContext(); if (appContext != nullptr && appContext->getManifest().appId == manifest.appId) { return std::static_pointer_cast(appContext->getApp()); diff --git a/Tactility/Source/app/screenshot/Screenshot.cpp b/Tactility/Source/app/screenshot/Screenshot.cpp index bf25fb0dc..d5db25b81 100644 --- a/Tactility/Source/app/screenshot/Screenshot.cpp +++ b/Tactility/Source/app/screenshot/Screenshot.cpp @@ -49,7 +49,7 @@ class ScreenshotApp final : public App { /** Returns the app data if the app is active. Note that this could clash if the same app is started twice and a background thread is slow. */ -std::shared_ptr _Nullable optApp() { +std::shared_ptr optApp() { auto appContext = getCurrentAppContext(); if (appContext != nullptr && appContext->getManifest().appId == manifest.appId) { return std::static_pointer_cast(appContext->getApp()); diff --git a/Tactility/Source/app/systeminfo/SystemInfo.cpp b/Tactility/Source/app/systeminfo/SystemInfo.cpp index e46d20b01..771c1cd3d 100644 --- a/Tactility/Source/app/systeminfo/SystemInfo.cpp +++ b/Tactility/Source/app/systeminfo/SystemInfo.cpp @@ -274,7 +274,7 @@ extern const AppManifest manifest; class SystemInfoApp; -static std::shared_ptr _Nullable optApp() { +static std::shared_ptr optApp() { auto appContext = getCurrentAppContext(); if (appContext != nullptr && appContext->getManifest().appId == manifest.appId) { return std::static_pointer_cast(appContext->getApp()); diff --git a/Tactility/Source/app/wifimanage/View.cpp b/Tactility/Source/app/wifimanage/View.cpp index 159d839e4..17a69f831 100644 --- a/Tactility/Source/app/wifimanage/View.cpp +++ b/Tactility/Source/app/wifimanage/View.cpp @@ -16,7 +16,7 @@ namespace tt::app::wifimanage { static const auto LOGGER = Logger("WifiManageView"); -std::shared_ptr _Nullable optWifiManage(); +std::shared_ptr optWifiManage(); static uint8_t mapRssiToPercentage(int rssi) { auto abs_rssi = std::abs(rssi); diff --git a/Tactility/Source/file/FileLock.cpp b/Tactility/Source/file/FileLock.cpp index be8dfcb1b..3af36820b 100644 --- a/Tactility/Source/file/FileLock.cpp +++ b/Tactility/Source/file/FileLock.cpp @@ -5,7 +5,7 @@ namespace tt::file { -std::shared_ptr _Nullable findLock(const std::string& path) { +std::shared_ptr findLock(const std::string& path) { return hal::sdcard::findSdCardLock(path); } diff --git a/Tactility/Source/hal/sdcard/SdCard.cpp b/Tactility/Source/hal/sdcard/SdCard.cpp index 78e75e215..8a284ea4f 100644 --- a/Tactility/Source/hal/sdcard/SdCard.cpp +++ b/Tactility/Source/hal/sdcard/SdCard.cpp @@ -3,7 +3,7 @@ namespace tt::hal::sdcard { -std::shared_ptr _Nullable find(const std::string& path) { +std::shared_ptr find(const std::string& path) { auto sdcards = findDevices(Device::Type::SdCard); for (auto& sdcard : sdcards) { if (sdcard->isMounted() && path.starts_with(sdcard->getMountPath())) { diff --git a/Tactility/Source/hal/usb/Usb.cpp b/Tactility/Source/hal/usb/Usb.cpp index f8c1ceee5..6138ff3c7 100644 --- a/Tactility/Source/hal/usb/Usb.cpp +++ b/Tactility/Source/hal/usb/Usb.cpp @@ -20,7 +20,7 @@ struct BootModeData { static Mode currentMode = Mode::Default; static RTC_NOINIT_ATTR BootModeData bootModeData; -sdmmc_card_t* _Nullable getCard() { +sdmmc_card_t* getCard() { auto sdcards = findDevices(Device::Type::SdCard); std::shared_ptr usable_sdcard; diff --git a/Tactility/Source/hal/usb/UsbTusb.cpp b/Tactility/Source/hal/usb/UsbTusb.cpp index 12a550df2..b20f64134 100644 --- a/Tactility/Source/hal/usb/UsbTusb.cpp +++ b/Tactility/Source/hal/usb/UsbTusb.cpp @@ -19,7 +19,7 @@ static const auto LOGGER = tt::Logger("USB"); namespace tt::hal::usb { - extern sdmmc_card_t* _Nullable getCard(); + extern sdmmc_card_t* getCard(); } enum { diff --git a/Tactility/Source/kernel/SystemEvents.cpp b/Tactility/Source/kernel/SystemEvents.cpp index e4ad94a13..ae1532eaa 100644 --- a/Tactility/Source/kernel/SystemEvents.cpp +++ b/Tactility/Source/kernel/SystemEvents.cpp @@ -34,10 +34,6 @@ static const char* getEventName(SystemEvent event) { return TT_STRINGIFY(NetworkConnected); case NetworkDisconnected: return TT_STRINGIFY(NetworkDisconnected); - case LvglStarted: - return TT_STRINGIFY(LvglStarted); - case LvglStopped: - return TT_STRINGIFY(LvglStopped); case Time: return TT_STRINGIFY(Time); } diff --git a/Tactility/Source/lvgl/EspLvglPort.cpp b/Tactility/Source/lvgl/EspLvglPort.cpp deleted file mode 100644 index 1114b3cd4..000000000 --- a/Tactility/Source/lvgl/EspLvglPort.cpp +++ /dev/null @@ -1,42 +0,0 @@ -#ifdef ESP_PLATFORM - -#include -#include -#include -#include -#include - -#include - -namespace tt::lvgl { - -// LVGL -// The minimum task stack seems to be about 3500, but that crashes the wifi app in some scenarios -// At 8192, it sometimes crashes when wifi-auto enables and is busy connecting and then you open WifiManage -constexpr auto LVGL_TASK_STACK_DEPTH = 9216; - -static const auto LOGGER = Logger("EspLvglPort"); - -bool initEspLvglPort() { - LOGGER.debug("Init"); - const lvgl_port_cfg_t lvgl_cfg = { - .task_priority = static_cast(Thread::Priority::Critical), - .task_stack = LVGL_TASK_STACK_DEPTH, - .task_affinity = getCpuAffinityConfiguration().graphics, - .task_max_sleep_ms = 500, - .timer_period_ms = 5 - }; - - if (lvgl_port_init(&lvgl_cfg) != ESP_OK) { - LOGGER.error("Init failed"); - return false; - } - - syncSet(&lvgl_port_lock, &lvgl_port_unlock); - - return true; -} - -} // namespace tt::lvgl - -#endif diff --git a/Tactility/Source/lvgl/Lvgl.cpp b/Tactility/Source/lvgl/Lvgl.cpp index fc60155ca..b6a3af208 100644 --- a/Tactility/Source/lvgl/Lvgl.cpp +++ b/Tactility/Source/lvgl/Lvgl.cpp @@ -7,47 +7,24 @@ #include #include #include -#include #include #include -#ifdef ESP_PLATFORM -#include -#endif +#include +#include #include namespace tt::lvgl { -static const auto LOGGER = Logger("Lvgl"); - -static bool started = false; - -void init(const hal::Configuration& config) { - LOGGER.info("Init started"); - -#ifdef ESP_PLATFORM - if (config.lvglInit == hal::LvglInit::Default && !initEspLvglPort()) { - return; - } -#endif - - start(); - - LOGGER.info("Init finished"); -} +static const auto LOGGER = Logger("LVGL"); bool isStarted() { - return started; + return module_is_started(&lvgl_module); } -void start() { - LOGGER.info("Start LVGL"); - - if (started) { - LOGGER.warn("Can't start LVGL twice"); - return; - } +void attachDevices() { + LOGGER.info("Adding devices"); auto lock = getSyncLock()->asScopedLock(); lock.lock(); @@ -56,7 +33,7 @@ void start() { LOGGER.info("Start displays"); auto displays = hal::findDevices(hal::Device::Type::Display); - for (const auto& display : displays) { + for (const auto& display: displays) { if (display->supportsLvgl()) { if (display->startLvgl()) { LOGGER.info("Started {}", display->getName()); @@ -82,7 +59,7 @@ void start() { if (primary_display != nullptr) { LOGGER.info("Start touch devices"); auto touch_devices = hal::findDevices(hal::Device::Type::Touch); - for (const auto& touch_device : touch_devices) { + for (const auto& touch_device: touch_devices) { // Start any touch devices that haven't been started yet if (touch_device->supportsLvgl() && touch_device->getLvglIndev() == nullptr) { if (touch_device->startLvgl(primary_display->getLvglDisplay())) { @@ -96,7 +73,7 @@ void start() { // Start keyboards LOGGER.info("Start keyboards"); auto keyboards = hal::findDevices(hal::Device::Type::Keyboard); - for (const auto& keyboard : keyboards) { + for (const auto& keyboard: keyboards) { if (keyboard->isAttached()) { if (keyboard->startLvgl(primary_display->getLvglDisplay())) { lv_indev_t* keyboard_indev = keyboard->getLvglIndev(); @@ -111,7 +88,7 @@ void start() { // Start encoders LOGGER.info("Start encoders"); auto encoders = hal::findDevices(hal::Device::Type::Encoder); - for (const auto& encoder : encoders) { + for (const auto& encoder: encoders) { if (encoder->startLvgl(primary_display->getLvglDisplay())) { LOGGER.info("Started {}", encoder->getName()); } else { @@ -141,21 +118,10 @@ void start() { LOGGER.error("Statusbar service is not in Stopped state"); } } - - // Finalize - - kernel::publishSystemEvent(kernel::SystemEvent::LvglStarted); - - started = true; } -void stop() { - LOGGER.info("Stopping LVGL"); - - if (!started) { - LOGGER.warn("Can't stop LVGL: not started"); - return; - } +void detachDevices() { + LOGGER.info("Removing devices"); auto lock = getSyncLock()->asScopedLock(); lock.lock(); @@ -169,7 +135,7 @@ void stop() { LOGGER.info("Stopping keyboards"); auto keyboards = hal::findDevices(hal::Device::Type::Keyboard); - for (auto keyboard : keyboards) { + for (auto keyboard: keyboards) { if (keyboard->getLvglIndev() != nullptr) { keyboard->stopLvgl(); } @@ -180,7 +146,7 @@ void stop() { LOGGER.info("Stopping touch"); // The display generally stops their own touch devices, but we'll clean up anything that didn't auto touch_devices = hal::findDevices(hal::Device::Type::Touch); - for (auto touch_device : touch_devices) { + for (auto touch_device: touch_devices) { if (touch_device->getLvglIndev() != nullptr) { touch_device->stopLvgl(); } @@ -191,7 +157,7 @@ void stop() { LOGGER.info("Stopping encoders"); // The display generally stops their own touch devices, but we'll clean up anything that didn't auto encoder_devices = hal::findDevices(hal::Device::Type::Encoder); - for (auto encoder_device : encoder_devices) { + for (auto encoder_device: encoder_devices) { if (encoder_device->getLvglIndev() != nullptr) { encoder_device->stopLvgl(); } @@ -200,17 +166,19 @@ void stop() { LOGGER.info("Stopping displays"); auto displays = hal::findDevices(hal::Device::Type::Display); - for (auto display : displays) { + for (auto display: displays) { if (display->supportsLvgl() && display->getLvglDisplay() != nullptr && !display->stopLvgl()) { LOGGER.error("Failed to detach display from LVGL"); } } +} - started = false; - - kernel::publishSystemEvent(kernel::SystemEvent::LvglStopped); +void start() { + check(module_start(&lvgl_module) == ERROR_NONE); +} - LOGGER.info("Stopped LVGL"); +void stop() { + check(module_stop(&lvgl_module) == ERROR_NONE); } } // namespace diff --git a/Tactility/Source/lvgl/LvglSync.cpp b/Tactility/Source/lvgl/LvglSync.cpp index 45c3ab48a..9d6f4fc5f 100644 --- a/Tactility/Source/lvgl/LvglSync.cpp +++ b/Tactility/Source/lvgl/LvglSync.cpp @@ -1,39 +1,16 @@ #include "Tactility/lvgl/LvglSync.h" #include +#include namespace tt::lvgl { -static Mutex lockMutex; - -static bool defaultLock(uint32_t timeoutMillis) { - return lockMutex.lock(timeoutMillis); -} - -static void defaultUnlock() { - lockMutex.unlock(); -} - -static LvglLock lock_singleton = defaultLock; -static LvglUnlock unlock_singleton = defaultUnlock; - -void syncSet(LvglLock lock, LvglUnlock unlock) { - auto old_lock = lock_singleton; - auto old_unlock = unlock_singleton; - - // Ensure the old lock is not engaged when changing locks - old_lock((uint32_t)kernel::MAX_TICKS); - lock_singleton = lock; - unlock_singleton = unlock; - old_unlock(); -} - bool lock(TickType_t timeout) { - return lock_singleton(pdMS_TO_TICKS(timeout == 0 ? kernel::MAX_TICKS : timeout)); + return lvgl_try_lock_timed(timeout); } void unlock() { - unlock_singleton(); + lvgl_unlock(); } class LvglSync : public Lock { @@ -41,11 +18,11 @@ class LvglSync : public Lock { ~LvglSync() override = default; bool lock(TickType_t timeoutTicks) const override { - return lvgl::lock(timeoutTicks); + return lvgl_try_lock_timed(timeoutTicks); } void unlock() const override { - lvgl::unlock(); + lvgl_unlock(); } }; diff --git a/Tactility/Source/service/ServiceRegistration.cpp b/Tactility/Source/service/ServiceRegistration.cpp index 3e24e7b1a..f13b07173 100644 --- a/Tactility/Source/service/ServiceRegistration.cpp +++ b/Tactility/Source/service/ServiceRegistration.cpp @@ -44,7 +44,7 @@ void addService(const ServiceManifest& manifest, bool autoStart) { addService(std::make_shared(manifest), autoStart); } -std::shared_ptr _Nullable findManifestById(const std::string& id) { +std::shared_ptr findManifestById(const std::string& id) { manifest_mutex.lock(); auto iterator = service_manifest_map.find(id); auto manifest = iterator != service_manifest_map.end() ? iterator->second : nullptr; @@ -52,7 +52,7 @@ std::shared_ptr _Nullable findManifestById(const std::str return manifest; } -static std::shared_ptr _Nullable findServiceInstanceById(const std::string& id) { +static std::shared_ptr findServiceInstanceById(const std::string& id) { manifest_mutex.lock(); auto iterator = service_instance_map.find(id); auto service = iterator != service_instance_map.end() ? iterator->second : nullptr; @@ -92,11 +92,11 @@ bool startService(const std::string& id) { return true; } -std::shared_ptr _Nullable findServiceContextById(const std::string& id) { +std::shared_ptr findServiceContextById(const std::string& id) { return findServiceInstanceById(id); } -std::shared_ptr _Nullable findServiceById(const std::string& id) { +std::shared_ptr findServiceById(const std::string& id) { auto instance = findServiceInstanceById(id); return instance != nullptr ? instance->getService() : nullptr; } diff --git a/Tactility/Source/service/gps/GpsService.cpp b/Tactility/Source/service/gps/GpsService.cpp index 359b02691..3b6d49757 100644 --- a/Tactility/Source/service/gps/GpsService.cpp +++ b/Tactility/Source/service/gps/GpsService.cpp @@ -17,7 +17,7 @@ constexpr bool hasTimeElapsed(TickType_t now, TickType_t timeInThePast, TickType return (now - timeInThePast) >= expireTimeInTicks; } -GpsService::GpsDeviceRecord* _Nullable GpsService::findGpsRecord(const std::shared_ptr& device) { +GpsService::GpsDeviceRecord* GpsService::findGpsRecord(const std::shared_ptr& device) { auto lock = mutex.asScopedLock(); lock.lock(); diff --git a/Tactility/Source/service/gui/GuiService.cpp b/Tactility/Source/service/gui/GuiService.cpp index c24adc291..83b605eab 100644 --- a/Tactility/Source/service/gui/GuiService.cpp +++ b/Tactility/Source/service/gui/GuiService.cpp @@ -40,6 +40,47 @@ void GuiService::onLoaderEvent(LoaderService::Event event) { int32_t GuiService::guiMain() { auto service = findServiceById(manifest.id); + if (!lvgl::lock(5000)) { + LOGGER.error("LVGL guiMain start failed as LVGL couldn't be locked"); + return 0; + } + + // The screen root is created in the main task instead of during onStart because + // it allows onStart() to succeed faster and allows widget creation to happen in the background + + auto* screen_root = lv_screen_active(); + if (screen_root == nullptr) { + LOGGER.error("No display found, exiting GUI task"); + lvgl::unlock(); + return 0; + } + + service->keyboardGroup = lv_group_create(); + lv_obj_set_style_border_width(screen_root, 0, LV_STATE_DEFAULT); + lv_obj_set_style_pad_all(screen_root, 0, LV_STATE_DEFAULT); + + lv_obj_t* vertical_container = lv_obj_create(screen_root); + lv_obj_set_size(vertical_container, LV_PCT(100), LV_PCT(100)); + lv_obj_set_flex_flow(vertical_container, LV_FLEX_FLOW_COLUMN); + lv_obj_set_style_pad_all(vertical_container, 0, LV_STATE_DEFAULT); + lv_obj_set_style_pad_gap(vertical_container, 0, LV_STATE_DEFAULT); + lv_obj_set_style_bg_color(vertical_container, lv_color_black(), LV_STATE_DEFAULT); + lv_obj_set_style_border_width(vertical_container, 0, LV_STATE_DEFAULT); + lv_obj_set_style_radius(vertical_container, 0, LV_STATE_DEFAULT); + + service->statusbarWidget = lvgl::statusbar_create(vertical_container); + + auto* app_container = lv_obj_create(vertical_container); + lv_obj_set_style_pad_all(app_container, 0, LV_STATE_DEFAULT); + lv_obj_set_style_border_width(app_container, 0, LV_STATE_DEFAULT); + lv_obj_set_width(app_container, LV_PCT(100)); + lv_obj_set_flex_grow(app_container, 1); + lv_obj_set_flex_flow(app_container, LV_FLEX_FLOW_COLUMN); + + service->appRootWidget = app_container; + + lvgl::unlock(); + while (true) { uint32_t flags = 0; if (service->threadFlags.wait(GUI_THREAD_FLAG_ALL, false, true, &flags, portMAX_DELAY)) { @@ -62,6 +103,9 @@ int32_t GuiService::guiMain() { } } + service->appRootWidget = nullptr; + service->statusbarWidget = nullptr; + return 0; } @@ -87,6 +131,12 @@ void GuiService::redraw() { // Lock GUI and LVGL lock(); + if (appRootWidget == nullptr) { + LOGGER.warn("No root widget"); + unlock(); + return; + } + if (lvgl::lock(1000)) { lv_obj_clean(appRootWidget); @@ -113,7 +163,7 @@ void GuiService::redraw() { lv_obj_t* container = createAppViews(appRootWidget); appToRender->getApp()->onShow(*appToRender, container); } else { - LOGGER.warn("nothing to draw"); + LOGGER.warn("Nothing to draw"); } // Unlock GUI and LVGL @@ -126,18 +176,11 @@ void GuiService::redraw() { } bool GuiService::onStart(ServiceContext& service) { - auto* screen_root = lv_screen_active(); - if (screen_root == nullptr) { - LOGGER.error("No display found"); - return false; - } - thread = new Thread( GUI_TASK_NAME, 4096, // Last known minimum was 2800 for launching desktop - []() { return guiMain(); } + guiMain ); - thread->setPriority(THREAD_PRIORITY_SERVICE); const auto loader = findLoaderService(); @@ -146,37 +189,8 @@ bool GuiService::onStart(ServiceContext& service) { onLoaderEvent(event); }); - lvgl::lock(portMAX_DELAY); - - keyboardGroup = lv_group_create(); - lv_obj_set_style_border_width(screen_root, 0, LV_STATE_DEFAULT); - lv_obj_set_style_pad_all(screen_root, 0, LV_STATE_DEFAULT); - - lv_obj_t* vertical_container = lv_obj_create(screen_root); - lv_obj_set_size(vertical_container, LV_PCT(100), LV_PCT(100)); - lv_obj_set_flex_flow(vertical_container, LV_FLEX_FLOW_COLUMN); - lv_obj_set_style_pad_all(vertical_container, 0, LV_STATE_DEFAULT); - lv_obj_set_style_pad_gap(vertical_container, 0, LV_STATE_DEFAULT); - lv_obj_set_style_bg_color(vertical_container, lv_color_black(), LV_STATE_DEFAULT); - lv_obj_set_style_border_width(vertical_container, 0, LV_STATE_DEFAULT); - lv_obj_set_style_radius(vertical_container, 0, LV_STATE_DEFAULT); - - statusbarWidget = lvgl::statusbar_create(vertical_container); - - auto* app_container = lv_obj_create(vertical_container); - lv_obj_set_style_pad_all(app_container, 0, LV_STATE_DEFAULT); - lv_obj_set_style_border_width(app_container, 0, LV_STATE_DEFAULT); - lv_obj_set_width(app_container, LV_PCT(100)); - lv_obj_set_flex_grow(app_container, 1); - lv_obj_set_flex_flow(app_container, LV_FLEX_FLOW_COLUMN); - - appRootWidget = app_container; - - lvgl::unlock(); - isStarted = true; - thread->setPriority(THREAD_PRIORITY_SERVICE); thread->start(); return true; @@ -192,20 +206,24 @@ void GuiService::onStop(ServiceContext& service) { appToRender = nullptr; isStarted = false; - auto task_handle = thread->getTaskHandle(); threadFlags.set(GUI_THREAD_FLAG_EXIT); + unlock(); thread->join(); - delete thread; - unlock(); + if (lvgl::lock()) { + if (keyboardGroup != nullptr) { + lv_group_delete(keyboardGroup); + keyboardGroup = nullptr; + } + lvgl::unlock(); + } else { + LOGGER.error("Failed to lock LVGL during GUI stop"); + } - check(lvgl::lock(1000 / portTICK_PERIOD_MS)); - lv_group_delete(keyboardGroup); - lvgl::unlock(); + delete thread; } void GuiService::requestDraw() { - auto task_handle = thread->getTaskHandle(); threadFlags.set(GUI_THREAD_FLAG_DRAW); } diff --git a/Tactility/Source/service/loader/Loader.cpp b/Tactility/Source/service/loader/Loader.cpp index da2c43a2a..9f52c8cdf 100644 --- a/Tactility/Source/service/loader/Loader.cpp +++ b/Tactility/Source/service/loader/Loader.cpp @@ -18,7 +18,7 @@ namespace tt::service::loader { -static const auto LOGGER = Logger("Boot"); +static const auto LOGGER = Logger("Loader"); constexpr auto LOADER_TIMEOUT = (100 / portTICK_PERIOD_MS); @@ -297,7 +297,7 @@ void LoaderService::stopAll(const std::string& id) { }); } -std::shared_ptr _Nullable LoaderService::getCurrentAppContext() { +std::shared_ptr LoaderService::getCurrentAppContext() { const auto lock = mutex.asScopedLock(); lock.lock(); if (appStack.empty()) { @@ -318,7 +318,7 @@ bool LoaderService::isRunning(const std::string& id) const { return false; } -std::shared_ptr _Nullable findLoaderService() { +std::shared_ptr findLoaderService() { return service::findServiceById(manifest.id); } diff --git a/Tactility/Source/service/screenshot/Screenshot.cpp b/Tactility/Source/service/screenshot/Screenshot.cpp index 64d57a46c..2a086c0d3 100644 --- a/Tactility/Source/service/screenshot/Screenshot.cpp +++ b/Tactility/Source/service/screenshot/Screenshot.cpp @@ -16,7 +16,7 @@ static const auto LOGGER = Logger("ScreenshotService"); extern const ServiceManifest manifest; -std::shared_ptr _Nullable optScreenshotService() { +std::shared_ptr optScreenshotService() { return service::findServiceById(manifest.id); } diff --git a/Tactility/Source/service/statusbar/Statusbar.cpp b/Tactility/Source/service/statusbar/Statusbar.cpp index 34c6dca82..25fa22f7c 100644 --- a/Tactility/Source/service/statusbar/Statusbar.cpp +++ b/Tactility/Source/service/statusbar/Statusbar.cpp @@ -90,7 +90,7 @@ static const char* getSdCardStatusIcon(hal::sdcard::SdCardDevice::State state) { } } -static _Nullable const char* getPowerStatusIcon() { +static const char* getPowerStatusIcon() { // TODO: Support multiple power devices? std::shared_ptr power; hal::findDevices(hal::Device::Type::Power, [&power](const auto& device) { diff --git a/Tactility/Source/service/wifi/WifiEsp.cpp b/Tactility/Source/service/wifi/WifiEsp.cpp index eac21186f..b853b2eb2 100644 --- a/Tactility/Source/service/wifi/WifiEsp.cpp +++ b/Tactility/Source/service/wifi/WifiEsp.cpp @@ -62,9 +62,9 @@ class Wifi { // for example: when scanning and you turn off the radio, the scan should probably stop or turning off // the radio should disable the on/off button in the app as it is pending. /** @brief The network interface when wifi is started */ - esp_netif_t* _Nullable netif = nullptr; + esp_netif_t* netif = nullptr; /** @brief Scanning results */ - wifi_ap_record_t* _Nullable scan_list = nullptr; + wifi_ap_record_t* scan_list = nullptr; /** @brief The current item count in scan_list (-1 when scan_list is NULL) */ uint16_t scan_list_count = 0; /** @brief Maximum amount of records to scan (value > 0) */ diff --git a/TactilityC/CMakeLists.txt b/TactilityC/CMakeLists.txt index 0e7363210..d34e383e0 100644 --- a/TactilityC/CMakeLists.txt +++ b/TactilityC/CMakeLists.txt @@ -19,9 +19,6 @@ else() add_library(TactilityC OBJECT) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) - target_sources(TactilityC PRIVATE ${SOURCES}) include_directories(TactilityC PRIVATE Private/) target_include_directories(TactilityC PUBLIC Include/) diff --git a/TactilityC/Include/tt_app.h b/TactilityC/Include/tt_app.h index cefed07f9..874cf4d6b 100644 --- a/TactilityC/Include/tt_app.h +++ b/TactilityC/Include/tt_app.h @@ -22,46 +22,47 @@ typedef enum { typedef unsigned int AppLaunchId; -/** Important: These function types must map to t::app types exactly */ +/** Important: These function types must map to t::app types exactly. All void* data is nullable. */ typedef void* (*AppCreateData)(); typedef void (*AppDestroyData)(void* data); -typedef void (*AppOnCreate)(AppHandle app, void* _Nullable data); -typedef void (*AppOnDestroy)(AppHandle app, void* _Nullable data); -typedef void (*AppOnShow)(AppHandle app, void* _Nullable data, lv_obj_t* parent); -typedef void (*AppOnHide)(AppHandle app, void* _Nullable data); -typedef void (*AppOnResult)(AppHandle app, void* _Nullable data, AppLaunchId launchId, AppResult result, BundleHandle resultData); +typedef void (*AppOnCreate)(AppHandle app, void* data); +typedef void (*AppOnDestroy)(AppHandle app, void* data); +typedef void (*AppOnShow)(AppHandle app, void* data, lv_obj_t* parent); +typedef void (*AppOnHide)(AppHandle app, void* data); +typedef void (*AppOnResult)(AppHandle app, void* data, AppLaunchId launchId, AppResult result, BundleHandle resultData); +/** All callback types are nullable */ typedef struct { /** The application can allocate data to re-use later (e.g. struct with state) */ - AppCreateData _Nullable createData; + AppCreateData createData; /** If createData is specified, this one must be specified too */ - AppDestroyData _Nullable destroyData; + AppDestroyData destroyData; /** Called when the app is launched (started) */ - AppOnCreate _Nullable onCreate; + AppOnCreate onCreate; /** Called when the app is exited (stopped) */ - AppOnDestroy _Nullable onDestroy; + AppOnDestroy onDestroy; /** Called when the app is about to be shown to the user (app becomes visible) */ - AppOnShow _Nullable onShow; + AppOnShow onShow; /** Called when the app is about to be invisible to the user (e.g. other app was launched by this app, and this app goes to the background) */ - AppOnHide _Nullable onHide; + AppOnHide onHide; /** Called when the app receives a result after launching another app */ - AppOnResult _Nullable onResult; + AppOnResult onResult; } AppRegistration; /** This is used to register the manifest of an external app. */ void tt_app_register(const AppRegistration app); /** @return the bundle that belongs to this application, or null if it wasn't started with parameters. */ -BundleHandle _Nullable tt_app_get_parameters(AppHandle handle); +BundleHandle tt_app_get_parameters(AppHandle handle); /** * Set the result before closing an app. * The result and bundle are passed along to the app that launched this app, when this app is closed. * @param[in] handle the app handle to set the result for * @param[in] result the result state to set - * @param[in] bundle the result bundle to set + * @param[in] bundle the result bundle to set (can be null) */ -void tt_app_set_result(AppHandle handle, AppResult result, BundleHandle _Nullable bundle); +void tt_app_set_result(AppHandle handle, AppResult result, BundleHandle bundle); /** @return true if a result was set for this app context */ bool tt_app_has_result(AppHandle handle); diff --git a/TactilityC/Source/tt_app.cpp b/TactilityC/Source/tt_app.cpp index e87ec87b6..24f6f0011 100644 --- a/TactilityC/Source/tt_app.cpp +++ b/TactilityC/Source/tt_app.cpp @@ -32,11 +32,11 @@ void tt_app_register( #endif } -BundleHandle _Nullable tt_app_get_parameters(AppHandle handle) { +BundleHandle tt_app_get_parameters(AppHandle handle) { return (BundleHandle)HANDLE_AS_APP_CONTEXT(handle)->getParameters().get(); } -void tt_app_set_result(AppHandle handle, AppResult result, BundleHandle _Nullable bundle) { +void tt_app_set_result(AppHandle handle, AppResult result, BundleHandle bundle) { auto shared_bundle = std::unique_ptr(static_cast(bundle)); HANDLE_AS_APP_CONTEXT(handle)->getApp()->setResult(static_cast(result), std::move(shared_bundle)); } diff --git a/TactilityC/Source/tt_hal_touch.cpp b/TactilityC/Source/tt_hal_touch.cpp index fd1055539..9572275dc 100644 --- a/TactilityC/Source/tt_hal_touch.cpp +++ b/TactilityC/Source/tt_hal_touch.cpp @@ -35,7 +35,7 @@ void tt_hal_touch_driver_free(TouchDriverHandle handle) { delete wrapper; } -bool tt_hal_touch_driver_get_touched_points(TouchDriverHandle handle, uint16_t* x, uint16_t* y, uint16_t* _Nullable strength, uint8_t* pointCount, uint8_t maxPointCount) { +bool tt_hal_touch_driver_get_touched_points(TouchDriverHandle handle, uint16_t* x, uint16_t* y, uint16_t* strength, uint8_t* pointCount, uint8_t maxPointCount) { DriverWrapper* wrapper = static_cast(handle); return wrapper->driver->getTouchedPoints(x, y, strength, pointCount, maxPointCount); } diff --git a/TactilityCore/CMakeLists.txt b/TactilityCore/CMakeLists.txt index 1824f94db..47f47aa3b 100644 --- a/TactilityCore/CMakeLists.txt +++ b/TactilityCore/CMakeLists.txt @@ -23,9 +23,6 @@ else() target_include_directories(TactilityCore PUBLIC Include/) - add_definitions(-D_Nullable=) - add_definitions(-D_Nonnull=) - target_link_libraries(TactilityCore PUBLIC TactilityFreeRtos TactilityKernel diff --git a/TactilityCore/Include/Tactility/file/File.h b/TactilityCore/Include/Tactility/file/File.h index fa102d99b..0f2371e2c 100644 --- a/TactilityCore/Include/Tactility/file/File.h +++ b/TactilityCore/Include/Tactility/file/File.h @@ -151,15 +151,15 @@ bool listDirectory( * * @param[in] path path the scan for files and directories * @param[out] outList a pointer to vector of dirent - * @param[in] filter an optional filter to filter out specific items - * @param[in] sort an optional sorting function + * @param[in] filter an optional filter to filter out specific items (nullable) + * @param[in] sort an optional sorting function (nullable) * @return the amount of items that were stored in "output" or -1 when an error occurred */ int scandir( const std::string& path, std::vector& outList, - ScandirFilter _Nullable filter = nullptr, - ScandirSort _Nullable sort = nullptr + ScandirFilter filter = nullptr, + ScandirSort sort = nullptr ); bool readLines(const std::string& filePath, bool stripNewLine, std::function callback); diff --git a/TactilityCore/Source/file/File.cpp b/TactilityCore/Source/file/File.cpp index c84bc86a5..e45c6c4be 100644 --- a/TactilityCore/Source/file/File.cpp +++ b/TactilityCore/Source/file/File.cpp @@ -92,8 +92,8 @@ bool listDirectory( int scandir( const std::string& path, std::vector& outList, - ScandirFilter _Nullable filterMethod, - ScandirSort _Nullable sortMethod + ScandirFilter filterMethod, + ScandirSort sortMethod ) { auto lock = getLock(path)->asScopedLock(); lock.lock(); diff --git a/TactilityFreeRtos/Include/Tactility/Thread.h b/TactilityFreeRtos/Include/Tactility/Thread.h index 552cc8170..c34263dd7 100644 --- a/TactilityFreeRtos/Include/Tactility/Thread.h +++ b/TactilityFreeRtos/Include/Tactility/Thread.h @@ -155,7 +155,7 @@ class Thread final { mutex.unlock(); } - void setStateCallback(StateCallback callback, _Nullable void* callbackContext = nullptr) { + void setStateCallback(StateCallback callback, void* callbackContext = nullptr) { mutex.lock(); assert(state == State::Stopped); stateCallback = callback; diff --git a/TactilityKernel/Include/tactility/device.h b/TactilityKernel/Include/tactility/device.h index e1be7d121..bec85efc6 100644 --- a/TactilityKernel/Include/tactility/device.h +++ b/TactilityKernel/Include/tactility/device.h @@ -181,7 +181,7 @@ static inline void device_unlock(struct Device* device) { } static inline const struct DeviceType* device_get_type(struct Device* device) { - return device->internal.driver ? device->internal.driver->deviceType : NULL; + return device->internal.driver ? device->internal.driver->device_type : NULL; } /** * Iterate through all the known devices diff --git a/TactilityKernel/Include/tactility/driver.h b/TactilityKernel/Include/tactility/driver.h index 478252d58..0311fbfdb 100644 --- a/TactilityKernel/Include/tactility/driver.h +++ b/TactilityKernel/Include/tactility/driver.h @@ -20,13 +20,13 @@ struct Driver { /** Array of const char*, terminated by NULL */ const char**compatible; /** Function to initialize the driver for a device */ - error_t (*startDevice)(struct Device* dev); + error_t (*start_device)(struct Device* dev); /** Function to deinitialize the driver for a device */ - error_t (*stopDevice)(struct Device* dev); + error_t (*stop_device)(struct Device* dev); /** Contains the driver's functions */ const void* api; /** Which type of devices this driver creates (can be NULL) */ - const struct DeviceType* deviceType; + const struct DeviceType* device_type; /** The module that owns this driver. When it is NULL, the system owns the driver and it cannot be removed from registration. */ const struct Module* owner; /** Internal data */ @@ -54,7 +54,7 @@ bool driver_is_compatible(struct Driver* driver, const char* compatible); struct Driver* driver_find_compatible(const char* compatible); static inline const struct DeviceType* driver_get_device_type(struct Driver* driver) { - return driver->deviceType; + return driver->device_type; } #ifdef __cplusplus diff --git a/TactilityKernel/Include/tactility/module.h b/TactilityKernel/Include/tactility/module.h index ff555bc14..bd47e34ee 100644 --- a/TactilityKernel/Include/tactility/module.h +++ b/TactilityKernel/Include/tactility/module.h @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: Apache-2.0 #pragma once #ifdef __cplusplus diff --git a/TactilityKernel/Include/tactility/time.h b/TactilityKernel/Include/tactility/time.h index 99964ed39..af5ff11cc 100644 --- a/TactilityKernel/Include/tactility/time.h +++ b/TactilityKernel/Include/tactility/time.h @@ -5,6 +5,9 @@ */ #pragma once +#ifndef __cplusplus +#include +#endif #include #include "defines.h" @@ -17,8 +20,16 @@ #include #endif +#ifdef __cplusplus +extern "C" { +#endif + // Projects that include this header must align with Tactility's frequency (e.g. apps) +#ifdef __cplusplus static_assert(configTICK_RATE_HZ == 1000); +#else +static_assert(configTICK_RATE_HZ == 1000, "configTICK_RATE_HZ must be 1000"); +#endif static inline uint32_t get_tick_frequency() { return configTICK_RATE_HZ; @@ -54,26 +65,30 @@ static inline int64_t get_micros_since_boot() { #ifdef ESP_PLATFORM return esp_timer_get_time(); #else - timespec ts; + struct timespec ts; if (clock_gettime(CLOCK_MONOTONIC, &ts) == 0) { - return (static_cast(ts.tv_sec) * 1000000LL) + (ts.tv_nsec / 1000); + return ((int64_t)ts.tv_sec * 1000000LL) + (ts.tv_nsec / 1000); } - timeval tv; - gettimeofday(&tv, nullptr); - return (static_cast(tv.tv_sec) * 1000000LL) + tv.tv_usec; + struct timeval tv; + gettimeofday(&tv, NULL); + return ((int64_t)tv.tv_sec * 1000000LL) + tv.tv_usec; #endif } /** Convert seconds to ticks */ static inline TickType_t seconds_to_ticks(uint32_t seconds) { - return static_cast(seconds) * 1000U / portTICK_PERIOD_MS; + return (uint64_t)seconds * 1000U / portTICK_PERIOD_MS; } /** Convert milliseconds to ticks */ static inline TickType_t millis_to_ticks(uint32_t milliSeconds) { #if configTICK_RATE_HZ == 1000 - return static_cast(milliSeconds); + return (TickType_t)milliSeconds; #else return static_cast(((float)configTICK_RATE_HZ) / 1000.0f * (float)milliSeconds); #endif } + +#ifdef __cplusplus +} +#endif diff --git a/TactilityKernel/Source/device.cpp b/TactilityKernel/Source/device.cpp index 8a02d4a10..2e5452ddc 100644 --- a/TactilityKernel/Source/device.cpp +++ b/TactilityKernel/Source/device.cpp @@ -264,7 +264,7 @@ void for_each_device_of_type(const DeviceType* type, void* callbackContext, bool for (auto* device : ledger.devices) { auto* driver = device->internal.driver; if (driver != nullptr) { - if (driver->deviceType == type) { + if (driver->device_type == type) { if (!on_device(device, callbackContext)) { break; } diff --git a/TactilityKernel/Source/driver.cpp b/TactilityKernel/Source/driver.cpp index 0bba72992..bd93f7a75 100644 --- a/TactilityKernel/Source/driver.cpp +++ b/TactilityKernel/Source/driver.cpp @@ -159,8 +159,8 @@ error_t driver_bind(Driver* driver, Device* device) { goto error; } - if (driver->startDevice != nullptr) { - error = driver->startDevice(device); + if (driver->start_device != nullptr) { + error = driver->start_device(device); if (error != ERROR_NONE) { goto error; } @@ -187,8 +187,8 @@ error_t driver_unbind(Driver* driver, Device* device) { goto error; } - if (driver->stopDevice != nullptr) { - error = driver->stopDevice(device); + if (driver->stop_device != nullptr) { + error = driver->stop_device(device); if (error != ERROR_NONE) { goto error; } diff --git a/TactilityKernel/Source/drivers/root.cpp b/TactilityKernel/Source/drivers/root.cpp index 524a37f93..f52ffdd23 100644 --- a/TactilityKernel/Source/drivers/root.cpp +++ b/TactilityKernel/Source/drivers/root.cpp @@ -8,10 +8,10 @@ extern "C" { Driver root_driver = { .name = "root", .compatible = (const char*[]) { "root", nullptr }, - .startDevice = nullptr, - .stopDevice = nullptr, + .start_device = nullptr, + .stop_device = nullptr, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = nullptr, .driver_private = nullptr }; diff --git a/Tests/Tactility/CMakeLists.txt b/Tests/Tactility/CMakeLists.txt index 8cc860ec4..9a070b7c9 100644 --- a/Tests/Tactility/CMakeLists.txt +++ b/Tests/Tactility/CMakeLists.txt @@ -7,9 +7,6 @@ set(CMAKE_CXX_COMPILER g++) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) add_executable(TactilityTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) -add_definitions(-D_Nullable=) -add_definitions(-D_Nonnull=) - target_include_directories(TactilityTests PRIVATE ${DOCTESTINC} ) @@ -23,7 +20,8 @@ target_link_libraries(TactilityTests PRIVATE TactilityCore TactilityKernel PlatformPosix - hal-device - Simulator + hal-device-module + lvgl-module + lvgl SDL2::SDL2-static SDL2-static ) diff --git a/Tests/Tactility/Main.cpp b/Tests/Tactility/Main.cpp index b31ff550f..e613b1566 100644 --- a/Tests/Tactility/Main.cpp +++ b/Tests/Tactility/Main.cpp @@ -7,7 +7,6 @@ #include #include - typedef struct { int argc; char** argv; @@ -17,8 +16,6 @@ typedef struct { extern "C" { // From the relevant platform extern struct Module platform_module; -// From the relevant device -extern struct Module device_module; } struct ModuleParent tactility_tests_module_parent { @@ -36,7 +33,7 @@ void test_task(void* parameter) { // overrides context.setOption("no-breaks", true); // don't break in the debugger when assertions fail - check(kernel_init(&platform_module, &device_module, nullptr) == ERROR_NONE); + check(kernel_init(&platform_module, nullptr, nullptr) == ERROR_NONE); // HAL compatibility module: it creates kernel driver wrappers for tt::hal::Device check(module_parent_construct(&tactility_tests_module_parent) == ERROR_NONE); check(module_set_parent(&hal_device_module, &tactility_tests_module_parent) == ERROR_NONE); diff --git a/Tests/TactilityCore/CMakeLists.txt b/Tests/TactilityCore/CMakeLists.txt index 550cedfe9..a97a301b7 100644 --- a/Tests/TactilityCore/CMakeLists.txt +++ b/Tests/TactilityCore/CMakeLists.txt @@ -7,9 +7,6 @@ set(CMAKE_CXX_COMPILER g++) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) add_executable(TactilityCoreTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) -add_definitions(-D_Nullable=) -add_definitions(-D_Nonnull=) - target_include_directories(TactilityCoreTests PRIVATE ${DOCTESTINC} ) diff --git a/Tests/TactilityCore/Main.cpp b/Tests/TactilityCore/Main.cpp index 5866a9fe2..e065f22ad 100644 --- a/Tests/TactilityCore/Main.cpp +++ b/Tests/TactilityCore/Main.cpp @@ -50,9 +50,10 @@ int main(int argc, char** argv) { return data.result; } +// NOTE: This is normally provided by the platform kernel module, but that's not loaded for TactilityCore extern "C" { - // Required for FreeRTOS - void vAssertCalled(unsigned long line, const char* const file) { - __assert_fail("assert failed", file, line, ""); - } +// Required for FreeRTOS +void vAssertCalled(unsigned long line, const char* const file) { + __assert_fail("assert failed", file, line, ""); +} } diff --git a/Tests/TactilityFreeRtos/CMakeLists.txt b/Tests/TactilityFreeRtos/CMakeLists.txt index 788f2f67b..883244e45 100644 --- a/Tests/TactilityFreeRtos/CMakeLists.txt +++ b/Tests/TactilityFreeRtos/CMakeLists.txt @@ -7,9 +7,6 @@ set(CMAKE_CXX_COMPILER g++) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) add_executable(TactilityFreeRtosTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) -add_definitions(-D_Nullable=) -add_definitions(-D_Nonnull=) - target_include_directories(TactilityFreeRtosTests PRIVATE ${DOCTESTINC} ) diff --git a/Tests/TactilityFreeRtos/Main.cpp b/Tests/TactilityFreeRtos/Main.cpp index 5866a9fe2..e065f22ad 100644 --- a/Tests/TactilityFreeRtos/Main.cpp +++ b/Tests/TactilityFreeRtos/Main.cpp @@ -50,9 +50,10 @@ int main(int argc, char** argv) { return data.result; } +// NOTE: This is normally provided by the platform kernel module, but that's not loaded for TactilityCore extern "C" { - // Required for FreeRTOS - void vAssertCalled(unsigned long line, const char* const file) { - __assert_fail("assert failed", file, line, ""); - } +// Required for FreeRTOS +void vAssertCalled(unsigned long line, const char* const file) { + __assert_fail("assert failed", file, line, ""); +} } diff --git a/Tests/TactilityKernel/CMakeLists.txt b/Tests/TactilityKernel/CMakeLists.txt index 620fee5c7..37589f7ae 100644 --- a/Tests/TactilityKernel/CMakeLists.txt +++ b/Tests/TactilityKernel/CMakeLists.txt @@ -14,5 +14,4 @@ add_test(NAME TactilityKernelTests COMMAND TactilityKernelTests) target_link_libraries(TactilityKernelTests PUBLIC TactilityKernel PlatformPosix - hal-device ) diff --git a/Tests/TactilityKernel/DeviceTest.cpp b/Tests/TactilityKernel/DeviceTest.cpp index e1f661957..1497ff1b9 100644 --- a/Tests/TactilityKernel/DeviceTest.cpp +++ b/Tests/TactilityKernel/DeviceTest.cpp @@ -167,10 +167,10 @@ TEST_CASE("device_is_ready should return true only when it is started") { Driver driver = { .name = "test_driver", .compatible = compatible, - .startDevice = nullptr, - .stopDevice = nullptr, + .start_device = nullptr, + .stop_device = nullptr, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = &module, .driver_private = nullptr }; diff --git a/Tests/TactilityKernel/DriverIntegrationTest.cpp b/Tests/TactilityKernel/DriverIntegrationTest.cpp index 6e7fb6fad..afb825677 100644 --- a/Tests/TactilityKernel/DriverIntegrationTest.cpp +++ b/Tests/TactilityKernel/DriverIntegrationTest.cpp @@ -33,10 +33,10 @@ static int stop(Device* device) { static Driver integration_driver = { .name = "integration_test_driver", .compatible = (const char*[]) { "integration", nullptr }, - .startDevice = start, - .stopDevice = stop, + .start_device = start, + .stop_device = stop, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = &module, .driver_private = nullptr, }; diff --git a/Tests/TactilityKernel/DriverTest.cpp b/Tests/TactilityKernel/DriverTest.cpp index 93184afd2..f75312020 100644 --- a/Tests/TactilityKernel/DriverTest.cpp +++ b/Tests/TactilityKernel/DriverTest.cpp @@ -35,10 +35,10 @@ TEST_CASE("driver_is_compatible should return true if a compatible value is foun Driver driver = { .name = "test_driver", .compatible = compatible, - .startDevice = nullptr, - .stopDevice = nullptr, + .start_device = nullptr, + .stop_device = nullptr, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = &module, .driver_private = nullptr }; @@ -52,10 +52,10 @@ TEST_CASE("driver_find should only find a compatible driver when the driver was Driver driver = { .name = "test_driver", .compatible = compatible, - .startDevice = nullptr, - .stopDevice = nullptr, + .start_device = nullptr, + .stop_device = nullptr, .api = nullptr, - .deviceType = nullptr, + .device_type = nullptr, .owner = &module, .driver_private = nullptr }; diff --git a/Tests/TactilityKernel/Main.cpp b/Tests/TactilityKernel/Main.cpp index 3026b3014..ed234f762 100644 --- a/Tests/TactilityKernel/Main.cpp +++ b/Tests/TactilityKernel/Main.cpp @@ -57,9 +57,3 @@ int main(int argc, char** argv) { return data.result; } -extern "C" { - // Required for FreeRTOS - void vAssertCalled(unsigned long line, const char* const file) { - __assert_fail("assert failed", file, line, ""); - } -}