Hal refactored (#99)

Boards/LilygoTdeck/CMakeLists.txt

@@ -1,5 +1,5 @@
 idf_component_register(
-    SRC_DIRS "."
-    INCLUDE_DIRS "."
+    SRC_DIRS "Source" "Source/hal"
+    INCLUDE_DIRS "Source"
     REQUIRES Tactility esp_lvgl_port esp_lcd esp_lcd_touch_gt911 driver vfs fatfs
 )

Boards/LilygoTdeck/Source/InitHardware.cpp

@@ -1,11 +1,25 @@
 #include "TactilityCore.h"
-#include "config.h"
-#include "display.h"
-#include "keyboard.h"
+#include "hal/TdeckDisplayConstants.h"
 #include <driver/spi_common.h>
+#include <soc/gpio_num.h>
+#include <driver/ledc.h>
 
 #define TAG "tdeck"
 
+// SPI
+#define TDECK_SPI_HOST SPI2_HOST
+#define TDECK_SPI_PIN_SCLK GPIO_NUM_40
+#define TDECK_SPI_PIN_MOSI GPIO_NUM_41
+#define TDECK_SPI_PIN_MISO GPIO_NUM_38
+#define TDECK_SPI_TRANSFER_SIZE_LIMIT (TDECK_LCD_HORIZONTAL_RESOLUTION * TDECK_LCD_SPI_TRANSFER_HEIGHT * (TDECK_LCD_BITS_PER_PIXEL / 8))
+
+#define TDECK_LCD_BACKLIGHT_LEDC_TIMER LEDC_TIMER_0
+#define TDECK_LCD_BACKLIGHT_LEDC_MODE LEDC_LOW_SPEED_MODE
+#define TDECK_LCD_BACKLIGHT_LEDC_CHANNEL LEDC_CHANNEL_0
+#define TDECK_LCD_BACKLIGHT_LEDC_DUTY_RES LEDC_TIMER_8_BIT
+#define TDECK_LCD_BACKLIGHT_LEDC_FREQUENCY (4000)
+
+
 static bool init_spi() {
     spi_bus_config_t bus_config = {
         .mosi_io_num = TDECK_SPI_PIN_MOSI,
@@ -21,20 +35,11 @@ static bool init_spi() {
 
 bool tdeck_init_hardware() {
     TT_LOG_I(TAG, "Init SPI");
+
     if (!init_spi()) {
         TT_LOG_E(TAG, "Init SPI failed");
         return false;
     }
 
-    // Don't turn the backlight on yet - Tactility init will take care of it
-    TT_LOG_I(TAG, "Init backlight");
-    if (!tdeck_backlight_init()) {
-        TT_LOG_E(TAG, "Init backlight failed");
-        return false;
-    }
-
-    // We wait for the keyboard peripheral to be booted up
-    keyboard_wait_for_response();
-
     return true;
 }

Boards/LilygoTdeck/Source/LilygoTdeck.cpp

@@ -1,5 +1,7 @@
-#include "lilygo_tdeck.h"
-#include "display.h"
+#include "hal/Configuration.h"
+#include "hal/TdeckDisplay.h"
+#include "hal/TdeckKeyboard.h"
+#include "hal/sdcard/Sdcard.h"
 
 bool tdeck_init_power();
 bool tdeck_init_hardware();
@@ -8,12 +10,11 @@ bool tdeck_init_lvgl();
 extern const tt::hal::sdcard::SdCard tdeck_sdcard;
 
 extern const tt::hal::Configuration lilygo_tdeck = {
-    .initPower = tdeck_init_power,
+    .initBoot = tdeck_init_power,
     .initHardware = tdeck_init_hardware,
-    .initLvgl = &tdeck_init_lvgl,
-    .display = {
-        .setBacklightDuty = &tdeck_backlight_set
-    },
+    .initLvgl = tdeck_init_lvgl,
+    .createDisplay = createDisplay,
+    .createKeyboard = createKeyboard,
     .sdcard = &tdeck_sdcard,
     .power = nullptr,
     .i2c = {

Boards/LilygoTdeck/Source/LilygoTdeck.h

@@ -1,5 +1,5 @@
 #pragma once
 
-#include "hal/Configuration.h"
+#include <hal/Configuration.h>
 
 extern const tt::hal::Configuration lilygo_tdeck;

Boards/LilygoTdeck/Source/Lvgl.cpp

@@ -0,0 +1,33 @@
+#include "Log.h"
+#include "Thread.h"
+#include "lvgl/LvglSync.h"
+#include "esp_lvgl_port.h"
+#include "hal/TdeckDisplay.h"
+
+#define TAG "tdeck_lvgl"
+
+// LVGL
+// The minimum task stack seems to be about 3500, but that crashes the wifi app in some scenarios
+// At 4000, it crashes when the fps renderer is available
+#define TDECK_LVGL_TASK_STACK_DEPTH 8192
+
+bool tdeck_init_lvgl() {
+    static lv_disp_t* display = nullptr;
+    const lvgl_port_cfg_t lvgl_cfg = {
+        .task_priority = tt::THREAD_PRIORITY_RENDER,
+        .task_stack = TDECK_LVGL_TASK_STACK_DEPTH,
+        .task_affinity = -1, // core pinning
+        .task_max_sleep_ms = 500,
+        .timer_period_ms = 5
+    };
+
+    TT_LOG_D(TAG, "LVGL port init");
+    if (lvgl_port_init(&lvgl_cfg) != ESP_OK) {
+        TT_LOG_E(TAG, "LVGL port init failed");
+        return false;
+    }
+
+    tt::lvgl::syncSet(&lvgl_port_lock, &lvgl_port_unlock);
+
+    return true;
+}

Boards/LilygoTdeck/Source/PowerOn.cpp

@@ -1,8 +1,11 @@
-#include "config.h"
+#include <driver/gpio.h>
 #include "TactilityCore.h"
 
 #define TAG "tdeck"
 
+// Power on
+#define TDECK_POWERON_GPIO GPIO_NUM_10
+
 static bool tdeck_power_on() {
     gpio_config_t device_power_signal_config = {
         .pin_bit_mask = BIT64(TDECK_POWERON_GPIO),
@@ -30,17 +33,5 @@ bool tdeck_init_power() {
         return false;
     }
 
-    /**
-     * Without this delay, the touch driver randomly fails when the device is USB-powered:
-     *  > lcd_panel.io.i2c: panel_io_i2c_rx_buffer(135): i2c transaction failed
-     *  > GT911: touch_gt911_read_cfg(352): GT911 read error!
-     * This might not be a problem with a lipo, but I haven't been able to test that.
-     * I tried to solve it just like I did with the keyboard:
-     * By reading from I2C until it succeeds and to then init the driver.
-     * It doesn't work, because it never recovers from the error.
-     */
-    TT_LOG_I(TAG, "Waiting after power-on");
-    tt::delay_ms(TDECK_POWERON_DELAY);
-
     return true;
 }

Boards/LilygoTdeck/Source/Sdcard.cpp

@@ -1,7 +1,6 @@
 #include "hal/sdcard/Sdcard.h"
 #include "Check.h"
 #include "Log.h"
-#include "config.h"
 
 #include "esp_vfs_fat.h"
 #include "sdmmc_cmd.h"
@@ -9,6 +8,18 @@
 
 #define TAG "tdeck_sdcard"
 
+#define TDECK_SDCARD_SPI_HOST SPI2_HOST
+#define TDECK_SDCARD_PIN_CS GPIO_NUM_39
+#define TDECK_SDCARD_SPI_FREQUENCY 800000U
+#define TDECK_SDCARD_FORMAT_ON_MOUNT_FAILED false
+#define TDECK_SDCARD_MAX_OPEN_FILES 4
+#define TDECK_SDCARD_ALLOC_UNIT_SIZE (16 * 1024)
+#define TDECK_SDCARD_STATUS_CHECK_ENABLED false
+
+// Other
+#define TDECK_LCD_PIN_CS GPIO_NUM_12
+#define TDECK_RADIO_PIN_CS GPIO_NUM_9
+
 typedef struct {
     const char* mount_point;
     sdmmc_card_t* card;
@@ -85,7 +96,7 @@ static void* _Nullable sdcard_mount(const char* mount_point) {
         } else {
             TT_LOG_E(TAG, "Mounting failed (%s)", esp_err_to_name(ret));
         }
-        return NULL;
+        return nullptr;
     }
 
     auto* data = static_cast<MountData*>(malloc(sizeof(MountData)));
@@ -100,7 +111,7 @@ static void* _Nullable sdcard_mount(const char* mount_point) {
 static void* sdcard_init_and_mount(const char* mount_point) {
     if (!sdcard_init()) {
         TT_LOG_E(TAG, "Failed to set SPI CS pins high. This is a pre-requisite for mounting.");
-        return NULL;
+        return nullptr;
     }
     auto* data = static_cast<MountData*>(sdcard_mount(mount_point));
     if (data == nullptr) {
@@ -125,6 +136,7 @@ static void sdcard_unmount(void* context) {
     free(data);
 }
 
+// TODO: Refactor to "bool getStatus(Status* status)" method so that it can fail when the lvgl lock fails
 static bool sdcard_is_mounted(void* context) {
     auto* data = static_cast<MountData*>(context);
     /**
@@ -132,13 +144,18 @@ static bool sdcard_is_mounted(void* context) {
      * Writing and reading to the bus from 2 devices at the same time causes crashes.
      * This work-around ensures that this check is only happening when LVGL isn't rendering.
      */
-    if (tt::lvgl::lock(100)) {
-        bool result = (data != nullptr) && (sdmmc_get_status(data->card) == ESP_OK);
-        tt::lvgl::unlock();
-        return result;
-    } else {
-        return false;
+    bool locked = tt::lvgl::lock(100); // TODO: Refactor to a more reliable locking mechanism
+    if (!locked) {
+        TT_LOG_W(TAG, "Failed to get LVGL lock");
     }
+
+    bool result = (data != nullptr) && (sdmmc_get_status(data->card) == ESP_OK);
+
+    if (locked) {
+        tt::lvgl::unlock();
+    }
+
+    return result;
 }
 
 extern const tt::hal::sdcard::SdCard tdeck_sdcard = {

Boards/LilygoTdeck/Source/hal/TdeckDisplay.cpp

@@ -1,15 +1,23 @@
-#include "config.h"
+#include "TdeckDisplay.h"
+#include "TdeckDisplayConstants.h"
+#include "TdeckTouch.h"
+#include "Log.h"
+
+#include <TactilityCore.h>
+
 #include "driver/ledc.h"
 #include "driver/spi_master.h"
 #include "esp_err.h"
 #include "esp_lcd_panel_ops.h"
 #include "esp_lcd_panel_vendor.h"
 #include "esp_lvgl_port.h"
-#include "Log.h"
 
 #define TAG "tdeck_display"
 
-bool tdeck_backlight_init() {
+static bool isBacklightInitialized = false;
+
+static bool initBacklight() {
+    TT_LOG_I(TAG, "Init backlight");
     ledc_timer_config_t ledc_timer = {
         .speed_mode = TDECK_LCD_BACKLIGHT_LEDC_MODE,
         .duty_resolution = TDECK_LCD_BACKLIGHT_LEDC_DUTY_RES,
@@ -27,7 +35,7 @@ bool tdeck_backlight_init() {
     return true;
 }
 
-void tdeck_backlight_set(uint8_t duty) {
+static bool setBacklight(uint8_t duty) {
     ledc_channel_config_t ledc_channel = {
         .gpio_num = TDECK_LCD_PIN_BACKLIGHT,
         .speed_mode = TDECK_LCD_BACKLIGHT_LEDC_MODE,
@@ -43,12 +51,12 @@ void tdeck_backlight_set(uint8_t duty) {
 
     // Setting the config in the timer init and then calling ledc_set_duty() doesn't work when
     // the app is running. For an unknown reason we have to call this config method every time:
-    if (ledc_channel_config(&ledc_channel) != ESP_OK) {
-        TT_LOG_E(TAG, "Failed to configure display backlight");
-    }
+    return ledc_channel_config(&ledc_channel) == ESP_OK;
 }
 
-lv_display_t* tdeck_display_init() {
+bool TdeckDisplay::start() {
+    TT_LOG_I(TAG, "Starting");
+
     const esp_lcd_panel_io_spi_config_t panel_io_config = {
         .cs_gpio_num = TDECK_LCD_PIN_CS,
         .dc_gpio_num = TDECK_LCD_PIN_DC,
@@ -71,10 +79,9 @@ lv_display_t* tdeck_display_init() {
         }
     };
 
-    esp_lcd_panel_io_handle_t io_handle;
-    if (esp_lcd_new_panel_io_spi((esp_lcd_spi_bus_handle_t)TDECK_LCD_SPI_HOST, &panel_io_config, &io_handle) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to create panel IO");
-        return nullptr;
+    if (esp_lcd_new_panel_io_spi((esp_lcd_spi_bus_handle_t)TDECK_LCD_SPI_HOST, &panel_io_config, &ioHandle) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to create panel IO");
+        return false;
     }
 
     const esp_lcd_panel_dev_config_t panel_config = {
@@ -88,45 +95,44 @@ lv_display_t* tdeck_display_init() {
         .vendor_config = nullptr
     };
 
-    esp_lcd_panel_handle_t panel_handle;
-    if (esp_lcd_new_panel_st7789(io_handle, &panel_config, &panel_handle) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to create panel");
-        return nullptr;
+    if (esp_lcd_new_panel_st7789(ioHandle, &panel_config, &panelHandle) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to create panel");
+        return false;
     }
 
-    if (esp_lcd_panel_reset(panel_handle) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to reset panel");
-        return nullptr;
+    if (esp_lcd_panel_reset(panelHandle) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to reset panel");
+        return false;
     }
 
-    if (esp_lcd_panel_init(panel_handle) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to init panel");
-        return nullptr;
+    if (esp_lcd_panel_init(panelHandle) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to init panel");
+        return false;
     }
 
-    if (esp_lcd_panel_invert_color(panel_handle, true) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to init panel");
-        return nullptr;
+    if (esp_lcd_panel_invert_color(panelHandle, true) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to init panel");
+        return false;
     }
 
-    if (esp_lcd_panel_swap_xy(panel_handle, true) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to init panel");
-        return nullptr;
+    if (esp_lcd_panel_swap_xy(panelHandle, true) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to init panel");
+        return false;
     }
 
-    if (esp_lcd_panel_mirror(panel_handle, true, false) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to init panel");
-        return nullptr;
+    if (esp_lcd_panel_mirror(panelHandle, true, false) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to init panel");
+        return false;
     }
 
-    if (esp_lcd_panel_disp_on_off(panel_handle, true) != ESP_OK) {
-        TT_LOG_E(TAG, "failed to turn display on");
-        return nullptr;
+    if (esp_lcd_panel_disp_on_off(panelHandle, true) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to turn display on");
+        return false;
     }
 
     const lvgl_port_display_cfg_t disp_cfg = {
-        .io_handle = io_handle,
-        .panel_handle = panel_handle,
+        .io_handle = ioHandle,
+        .panel_handle = panelHandle,
         .buffer_size = TDECK_LCD_HORIZONTAL_RESOLUTION * TDECK_LCD_DRAW_BUFFER_HEIGHT * (TDECK_LCD_BITS_PER_PIXEL / 8),
         .double_buffer = true, // Disable to free up SPIRAM
         .trans_size = 0,
@@ -146,5 +152,55 @@ lv_display_t* tdeck_display_init() {
         },
     };
 
-    return lvgl_port_add_disp(&disp_cfg);
+    displayHandle = lvgl_port_add_disp(&disp_cfg);
+    TT_LOG_I(TAG, "Finished");
+    return displayHandle != nullptr;
+}
+
+bool TdeckDisplay::stop() {
+    tt_assert(displayHandle != nullptr);
+
+    lvgl_port_remove_disp(displayHandle);
+
+    if (esp_lcd_panel_del(panelHandle) != ESP_OK) {
+        return false;
+    }
+
+    if (esp_lcd_panel_io_del(ioHandle) != ESP_OK) {
+        return false;
+    }
+
+    displayHandle = nullptr;
+    return true;
+
+}
+
+void TdeckDisplay::setPowerOn(bool turnOn) {
+    if (esp_lcd_panel_disp_on_off(panelHandle, turnOn) != ESP_OK) {
+        TT_LOG_E(TAG, "Failed to turn display on/off");
+    } else {
+        poweredOn = turnOn;
+    }
+}
+
+tt::hal::Touch* _Nullable TdeckDisplay::createTouch() {
+    return static_cast<tt::hal::Touch*>(new TdeckTouch());
+}
+
+void TdeckDisplay::setBacklightDuty(uint8_t backlightDuty) {
+    if (!isBacklightInitialized) {
+        tt_check(initBacklight());
+        isBacklightInitialized = true;
+    }
+
+    if (setBacklight(backlightDuty)) {
+        TT_LOG_I(TAG, "Backlight set: %d", backlightDuty);
+        lastBacklightDuty = backlightDuty;
+    } else {
+        TT_LOG_E(TAG, "Failed to configure display backlight");
+    }
+}
+
+tt::hal::Display* createDisplay() {
+    return static_cast<tt::hal::Display*>(new TdeckDisplay());
 }

Boards/LilygoTdeck/Source/hal/TdeckDisplay.h

@@ -0,0 +1,42 @@
+#pragma once
+
+#include <esp_lcd_types.h>
+#include "lvgl.h"
+#include "hal/Display.h"
+
+extern lv_disp_t* displayHandle;
+
+class TdeckDisplay : public tt::hal::Display {
+
+private:
+
+    esp_lcd_panel_io_handle_t ioHandle = nullptr;
+    esp_lcd_panel_handle_t panelHandle = nullptr;
+    lv_display_t* displayHandle = nullptr;
+    uint8_t lastBacklightDuty = 255;
+    bool poweredOn = false;
+
+public:
+
+    bool start() override;
+
+    bool stop() override;
+
+    void setPowerOn(bool turnOn) override;
+    bool isPoweredOn() const override { return poweredOn; };
+    bool supportsPowerControl() const override { return true; }
+
+    tt::hal::Touch* _Nullable createTouch() override;
+
+    void setBacklightDuty(uint8_t backlightDuty) override;
+    uint8_t getBacklightDuty() const override { return lastBacklightDuty; }
+    bool supportsBacklightDuty() const override { return true; }
+
+    lv_display_t* _Nullable getLvglDisplay() const override { return displayHandle; }
+
+private:
+
+    static bool startBacklight();
+};
+
+tt::hal::Display* createDisplay();

Boards/LilygoTdeck/Source/hal/TdeckDisplayConstants.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#define TDECK_LCD_SPI_HOST SPI2_HOST
+#define TDECK_LCD_PIN_CS GPIO_NUM_12
+#define TDECK_LCD_PIN_DC GPIO_NUM_11 // RS
+#define TDECK_LCD_PIN_BACKLIGHT GPIO_NUM_42
+#define TDECK_LCD_SPI_FREQUENCY 40000000
+#define TDECK_LCD_HORIZONTAL_RESOLUTION 320
+#define TDECK_LCD_VERTICAL_RESOLUTION 240
+#define TDECK_LCD_BITS_PER_PIXEL 16
+#define TDECK_LCD_DRAW_BUFFER_HEIGHT (TDECK_LCD_VERTICAL_RESOLUTION / 10)
+#define TDECK_LCD_SPI_TRANSFER_HEIGHT (TDECK_LCD_VERTICAL_RESOLUTION / 10)
+
+// Backlight (PWM)
+#define TDECK_LCD_BACKLIGHT_LEDC_TIMER LEDC_TIMER_0
+#define TDECK_LCD_BACKLIGHT_LEDC_MODE LEDC_LOW_SPEED_MODE
+#define TDECK_LCD_BACKLIGHT_LEDC_CHANNEL LEDC_CHANNEL_0
+#define TDECK_LCD_BACKLIGHT_LEDC_DUTY_RES LEDC_TIMER_8_BIT
+#define TDECK_LCD_BACKLIGHT_LEDC_FREQUENCY (4000)
+

Boards/LilygoTdeck/Source/hal/TdeckKeyboard.cpp

@@ -1,34 +1,16 @@
-#include "keyboard.h"
-#include "config.h"
-#include "lvgl.h"
-#include "TactilityCore.h"
-#include "lvgl/LvglKeypad.h"
+#include "TdeckKeyboard.h"
 #include "hal/i2c/I2c.h"
 #include <driver/i2c.h>
 
 #define TAG "tdeck_keyboard"
 
-typedef struct {
-    lv_indev_t* device;
-} KeyboardData;
+#define TDECK_KEYBOARD_I2C_BUS_HANDLE I2C_NUM_0
+#define TDECK_KEYBOARD_SLAVE_ADDRESS 0x55
 
 static inline bool keyboard_i2c_read(uint8_t* output) {
     return tt::hal::i2c::masterRead(TDECK_KEYBOARD_I2C_BUS_HANDLE, TDECK_KEYBOARD_SLAVE_ADDRESS, output, 1, 100 / portTICK_PERIOD_MS);
 }
 
-void keyboard_wait_for_response() {
-    TT_LOG_I(TAG, "Waiting for keyboard response...");
-    bool awake = false;
-    uint8_t read_buffer = 0x00;
-    do {
-        awake = keyboard_i2c_read(&read_buffer);
-        if (!awake) {
-            tt::delay_ms(100);
-        }
-    } while (!awake);
-    TT_LOG_I(TAG, "Keyboard responded");
-}
-
 /**
  * The callback simulates press and release events, because the T-Deck
  * keyboard only publishes press events on I2C.
@@ -61,21 +43,25 @@ static void keyboard_read_callback(TT_UNUSED lv_indev_t* indev, lv_indev_data_t*
     last_buffer = read_buffer;
 }
 
-Keyboard keyboard_alloc(_Nullable lv_disp_t* display) {
-    auto* data = static_cast<KeyboardData*>(malloc(sizeof(KeyboardData)));
-
-    data->device = lv_indev_create();
-    lv_indev_set_type(data->device, LV_INDEV_TYPE_KEYPAD);
-    lv_indev_set_read_cb(data->device, &keyboard_read_callback);
-    lv_indev_set_display(data->device, display);
-
-    tt::lvgl::keypad_set_indev(data->device);
-
-    return data;
+bool TdeckKeyboard::start(lv_display_t* display) {
+    deviceHandle = lv_indev_create();
+    lv_indev_set_type(deviceHandle, LV_INDEV_TYPE_KEYPAD);
+    lv_indev_set_read_cb(deviceHandle, &keyboard_read_callback);
+    lv_indev_set_display(deviceHandle, display);
+    lv_indev_set_user_data(deviceHandle, this);
+    return true;
 }
 
-void keyboard_free(Keyboard keyboard) {
-    auto* data = static_cast<KeyboardData*>(keyboard);
-    lv_indev_delete(data->device);
-    free(data);
+bool TdeckKeyboard::stop() {
+    lv_indev_delete(deviceHandle);
+    deviceHandle = nullptr;
+    return true;
+}
+
+bool TdeckKeyboard::isAttached() const {
+    return tt::hal::i2c::masterCheckAddressForDevice(TDECK_KEYBOARD_I2C_BUS_HANDLE, TDECK_KEYBOARD_SLAVE_ADDRESS, 100);
+}
+
+tt::hal::Keyboard* createKeyboard() {
+    return dynamic_cast<tt::hal::Keyboard*>(new TdeckKeyboard());
 }

Boards/LilygoTdeck/Source/hal/TdeckKeyboard.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "hal/Keyboard.h"
+#include <TactilityCore.h>
+#include "esp_lcd_panel_io_interface.h"
+#include "esp_lcd_touch.h"
+
+class TdeckKeyboard : public tt::hal::Keyboard {
+private:
+    lv_indev_t* _Nullable deviceHandle = nullptr;
+public:
+    bool start(lv_display_t* display) override;
+    bool stop() override;
+    bool isAttached() const override;
+    lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; }
+};
+
+tt::hal::Keyboard* createKeyboard();

Boards/LilygoTdeck/Source/hal/TdeckTouch.cpp

@@ -0,0 +1,97 @@
+#include "TdeckTouch.h"
+
+#include "esp_err.h"
+#include "esp_lcd_touch_gt911.h"
+#include "Log.h"
+#include "Kernel.h"
+#include "esp_lvgl_port.h"
+
+#define TAG "tdeck_touch"
+
+// Touch (GT911)
+#define TDECK_TOUCH_I2C_BUS_HANDLE I2C_NUM_0
+#define TDECK_TOUCH_X_MAX 240
+#define TDECK_TOUCH_Y_MAX 320
+#define TDECK_TOUCH_PIN_INT GPIO_NUM_16
+
+bool TdeckTouch::start(lv_display_t* display) {
+    const esp_lcd_panel_io_i2c_config_t io_config = ESP_LCD_TOUCH_IO_I2C_GT911_CONFIG();
+
+    // TODO: Revert on new ESP-IDF version
+    static_assert(ESP_IDF_VERSION == ESP_IDF_VERSION_VAL(5, 3, 1));
+    esp_lcd_new_panel_io_i2c(
+        (esp_lcd_i2c_bus_handle_t)TDECK_TOUCH_I2C_BUS_HANDLE,
+        &io_config,
+        &ioHandle
+    );
+    /*
+    if (
+        esp_lcd_new_panel_io_i2c(
+            (esp_lcd_i2c_bus_handle_t)TDECK_TOUCH_I2C_BUS_HANDLE,
+            &touch_io_config,
+            &ioHandle
+        ) != ESP_OK
+    ) {
+        TT_LOG_E(TAG, "touch io i2c creation failed");
+        return false;
+    }
+    */
+
+    esp_lcd_touch_config_t config = {
+        .x_max = TDECK_TOUCH_X_MAX,
+        .y_max = TDECK_TOUCH_Y_MAX,
+        .rst_gpio_num = GPIO_NUM_NC,
+        .int_gpio_num = TDECK_TOUCH_PIN_INT,
+        .levels = {
+            .reset = 0,
+            .interrupt = 0,
+        },
+        .flags = {
+            .swap_xy = 1,
+            .mirror_x = 1,
+            .mirror_y = 0,
+        },
+        .process_coordinates = nullptr,
+        .interrupt_callback = nullptr,
+        .user_data = nullptr,
+        .driver_data = nullptr
+    };
+
+    if (esp_lcd_touch_new_i2c_gt911(ioHandle, &config, &touchHandle) != ESP_OK) {
+        TT_LOG_E(TAG, "GT199 driver init failed");
+        // TODO: De-init IO
+        return false;
+    }
+
+    const lvgl_port_touch_cfg_t touch_cfg = {
+        .disp = display,
+        .handle = touchHandle,
+    };
+
+    TT_LOG_I(TAG, "Adding touch to LVGL");
+    deviceHandle = lvgl_port_add_touch(&touch_cfg);
+    if (deviceHandle == nullptr) {
+        TT_LOG_E(TAG, "Adding touch failed");
+        return false;
+    }
+
+    return true;
+}
+
+bool TdeckTouch::stop() {
+    if (esp_lcd_touch_del(touchHandle) == ESP_OK) {
+        touchHandle = nullptr;
+    } else {
+        TT_LOG_E(TAG, "Deleting driver failed");
+        return false;
+    }
+
+    if (esp_lcd_panel_io_del(ioHandle) == ESP_OK) {
+        ioHandle = nullptr;
+    } else {
+        TT_LOG_E(TAG, "Deleting IO handle failed");
+        return false;
+    }
+
+    return true;
+}

Boards/LilygoTdeck/Source/hal/TdeckTouch.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include "hal/Touch.h"
+#include "TactilityCore.h"
+#include "esp_lcd_panel_io_interface.h"
+#include "esp_lcd_touch.h"
+
+class TdeckTouch : public tt::hal::Touch {
+private:
+    esp_lcd_panel_io_handle_t _Nullable ioHandle = nullptr;
+    esp_lcd_touch_handle_t _Nullable touchHandle = nullptr;
+    lv_indev_t* _Nullable deviceHandle = nullptr;
+public:
+    bool start(lv_display_t* display) override;
+    bool stop() override;
+    lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; }
+};

Boards/LilygoTdeck/config.h

@@ -1,64 +0,0 @@
-#pragma once
-
-#include "driver/i2c.h"
-#include "driver/gpio.h"
-
-// Main bus, used by GT911 touch hardware and keyboard
-#define TDECK_I2C_BUS_HANDLE I2C_NUM_0
-
-// SPI
-#define TDECK_SPI_HOST SPI2_HOST
-#define TDECK_SPI_PIN_SCLK GPIO_NUM_40
-#define TDECK_SPI_PIN_MOSI GPIO_NUM_41
-#define TDECK_SPI_PIN_MISO GPIO_NUM_38
-#define TDECK_SPI_TRANSFER_SIZE_LIMIT (TDECK_LCD_HORIZONTAL_RESOLUTION * TDECK_LCD_SPI_TRANSFER_HEIGHT * (TDECK_LCD_BITS_PER_PIXEL / 8))
-
-// Power on
-#define TDECK_POWERON_GPIO GPIO_NUM_10
-#define TDECK_POWERON_DELAY 2000 // milliseconds - see bootstrap.c for explanation
-
-// Display
-#define TDECK_LCD_SPI_HOST SPI2_HOST
-#define TDECK_LCD_PIN_CS GPIO_NUM_12
-#define TDECK_LCD_PIN_DC GPIO_NUM_11 // RS
-#define TDECK_LCD_PIN_BACKLIGHT GPIO_NUM_42
-#define TDECK_LCD_SPI_FREQUENCY 40000000
-#define TDECK_LCD_HORIZONTAL_RESOLUTION 320
-#define TDECK_LCD_VERTICAL_RESOLUTION 240
-#define TDECK_LCD_BITS_PER_PIXEL 16
-#define TDECK_LCD_DRAW_BUFFER_HEIGHT (TDECK_LCD_VERTICAL_RESOLUTION / 10)
-#define TDECK_LCD_SPI_TRANSFER_HEIGHT (TDECK_LCD_VERTICAL_RESOLUTION / 10)
-
-// LVGL
-// The minimum task stack seems to be about 3500, but that crashes the wifi app in some scenarios
-// At 4000, it crashes when the fps renderer is available
-#define TDECK_LVGL_TASK_STACK_DEPTH 8192
-
-// Dipslay backlight (PWM)
-#define TDECK_LCD_BACKLIGHT_LEDC_TIMER LEDC_TIMER_0
-#define TDECK_LCD_BACKLIGHT_LEDC_MODE LEDC_LOW_SPEED_MODE
-#define TDECK_LCD_BACKLIGHT_LEDC_CHANNEL LEDC_CHANNEL_0
-#define TDECK_LCD_BACKLIGHT_LEDC_DUTY_RES LEDC_TIMER_8_BIT
-#define TDECK_LCD_BACKLIGHT_LEDC_FREQUENCY (4000)
-
-// Touch (GT911)
-#define TDECK_TOUCH_I2C_BUS_HANDLE TDECK_I2C_BUS_HANDLE
-#define TDECK_TOUCH_X_MAX 240
-#define TDECK_TOUCH_Y_MAX 320
-#define TDECK_TOUCH_PIN_INT GPIO_NUM_16
-
-// SD Card
-#define TDECK_SDCARD_SPI_HOST SPI2_HOST
-#define TDECK_SDCARD_PIN_CS GPIO_NUM_39
-#define TDECK_SDCARD_SPI_FREQUENCY 800000U
-#define TDECK_SDCARD_FORMAT_ON_MOUNT_FAILED false
-#define TDECK_SDCARD_MAX_OPEN_FILES 4
-#define TDECK_SDCARD_ALLOC_UNIT_SIZE (16 * 1024)
-#define TDECK_SDCARD_STATUS_CHECK_ENABLED false
-
-// Keyboard
-#define TDECK_KEYBOARD_I2C_BUS_HANDLE TDECK_I2C_BUS_HANDLE
-#define TDECK_KEYBOARD_SLAVE_ADDRESS 0x55
-
-// Lora (optional)
-#define TDECK_RADIO_PIN_CS GPIO_NUM_9

Boards/LilygoTdeck/display.h

@@ -1,9 +0,0 @@
-#pragma once
-
-#include "lvgl.h"
-
-lv_display_t* tdeck_display_init();
-
-bool tdeck_backlight_init();
-
-void tdeck_backlight_set(uint8_t duty);

Boards/LilygoTdeck/keyboard.h

@@ -1,10 +0,0 @@
-#pragma once
-
-#include "lvgl.h"
-
-void keyboard_wait_for_response();
-
-typedef void* Keyboard;
-
-Keyboard keyboard_alloc(_Nullable lv_disp_t* display);
-void keyboard_free(Keyboard keyboard);

Boards/LilygoTdeck/lvgl.cpp

@@ -1,67 +0,0 @@
-#include "Log.h"
-#include "Thread.h"
-#include "lvgl/LvglSync.h"
-#include "config.h"
-#include "display.h"
-#include "esp_lvgl_port.h"
-#include "keyboard.h"
-
-#define TAG "tdeck_lvgl"
-
-bool tdeck_init_touch(esp_lcd_panel_io_handle_t* io_handle, esp_lcd_touch_handle_t* touch_handle);
-
-bool tdeck_init_lvgl() {
-    static lv_disp_t* display = nullptr;
-    static esp_lcd_panel_io_handle_t touch_io_handle;
-    static esp_lcd_touch_handle_t touch_handle;
-
-    const lvgl_port_cfg_t lvgl_cfg = {
-        .task_priority = tt::THREAD_PRIORITY_RENDER,
-        .task_stack = TDECK_LVGL_TASK_STACK_DEPTH,
-        .task_affinity = -1, // core pinning
-        .task_max_sleep_ms = 500,
-        .timer_period_ms = 5
-    };
-
-    TT_LOG_D(TAG, "LVGL port init");
-    if (lvgl_port_init(&lvgl_cfg) != ESP_OK) {
-        TT_LOG_E(TAG, "LVGL port init failed");
-        return false;
-    }
-
-    // Add display
-
-    TT_LOG_D(TAG, "Creating display");
-    display = tdeck_display_init();
-    if (display == nullptr) {
-        TT_LOG_E(TAG, "Creating display failed");
-        return false;
-    }
-
-    // Add touch
-
-    TT_LOG_D(TAG, "Creating touch");
-    if (!tdeck_init_touch(&touch_io_handle, &touch_handle)) {
-        TT_LOG_E(TAG, "Creating touch failed");
-        return false;
-    }
-
-    const lvgl_port_touch_cfg_t touch_cfg = {
-        .disp = display,
-        .handle = touch_handle,
-    };
-
-    TT_LOG_D(TAG, "Adding touch");
-    lv_indev_t _Nullable* touch_indev = lvgl_port_add_touch(&touch_cfg);
-    if (touch_indev == nullptr) {
-        TT_LOG_E(TAG, "Adding touch failed");
-        return false;
-    }
-
-    // Set syncing functions
-    tt::lvgl::syncSet(&lvgl_port_lock, &lvgl_port_unlock);
-
-    keyboard_alloc(display);
-
-    return true;
-}

Boards/LilygoTdeck/touch.cpp

@@ -1,58 +0,0 @@
-#include "config.h"
-#include "esp_err.h"
-#include "esp_lcd_panel_io_interface.h"
-#include "esp_lcd_touch_gt911.h"
-#include "Log.h"
-#include "Kernel.h"
-
-#define TAG "tdeck_touch"
-
-bool tdeck_init_touch(esp_lcd_panel_io_handle_t* io_handle, esp_lcd_touch_handle_t* touch_handle) {
-    const esp_lcd_panel_io_i2c_config_t touch_io_config = ESP_LCD_TOUCH_IO_I2C_GT911_CONFIG();
-
-    // TODO: Revert on new ESP-IDF version
-    static_assert(ESP_IDF_VERSION == ESP_IDF_VERSION_VAL(5, 3, 1));
-    esp_lcd_new_panel_io_i2c(
-        (esp_lcd_i2c_bus_handle_t)TDECK_TOUCH_I2C_BUS_HANDLE,
-        &touch_io_config,
-        io_handle
-    );
-    /*
-    if (
-        esp_lcd_new_panel_io_i2c(
-            (esp_lcd_i2c_bus_handle_t)TDECK_TOUCH_I2C_BUS_HANDLE,
-            &touch_io_config,
-            io_handle
-        ) != ESP_OK
-    ) {
-        TT_LOG_E(TAG, "touch io i2c creation failed");
-        return false;
-    }
-    */
-
-    esp_lcd_touch_config_t config = {
-        .x_max = TDECK_TOUCH_X_MAX,
-        .y_max = TDECK_TOUCH_Y_MAX,
-        .rst_gpio_num = GPIO_NUM_NC,
-        .int_gpio_num = TDECK_TOUCH_PIN_INT,
-        .levels = {
-            .reset = 0,
-            .interrupt = 0,
-        },
-        .flags = {
-            .swap_xy = 1,
-            .mirror_x = 1,
-            .mirror_y = 0,
-        },
-        .process_coordinates = nullptr,
-        .interrupt_callback = nullptr,
-        .user_data = nullptr
-    };
-
-    if (esp_lcd_touch_new_i2c_gt911(*io_handle, &config, touch_handle) != ESP_OK) {
-        TT_LOG_E(TAG, "gt911 driver creation failed");
-        return false;
-    }
-
-    return true;
-}