// SPDX-License-Identifier: Apache-2.0 #include #include #include #include #include #include #include #include #include "t5s3_epd.h" #include #include #define TAG "T5s3Display" #define GET_CONFIG(device) (static_cast((device)->config)) // An update covering at least this fraction of the panel is a full-screen change and gets a quality refresh static constexpr float FULL_AREA_QUALITY_THRESHOLD = 0.6f; // Fast updates allowed before a quality refresh limits ghosting. A full-screen redraw takes about 10 updates, so this must be higher static constexpr uint32_t QUALITY_REFRESH_PARTIAL_COUNT = 20; // Updates within this time after a quality update also use quality mode, so the tiles of one redraw stay consistent. // It must stay well below the duration of a quality update. static constexpr uint32_t QUALITY_HOLD_MS = 50; // Maximum time that consecutive quality updates keep extending the hold window static constexpr uint32_t QUALITY_HOLD_SESSION_MAX_MS = 200; // 4x4 ordered (Bayer) dither thresholds, spread evenly across a 0-15 nibble range. static constexpr uint8_t BAYER_4X4[4][4] = { { 0, 8, 2, 10 }, { 12, 4, 14, 6 }, { 3, 11, 1, 9 }, { 15, 7, 13, 5 }, }; // Dithers an 8-bit luminance (0x00 black to 0xFF white) to a 4-bit level (0x0 black to 0xF white) static inline uint8_t dither_to_nibble(uint8_t luminance, int32_t x, int32_t y) { // Scaling by 17 spreads the thresholds over one full quantization step const uint32_t threshold = BAYER_4X4[y & 3][x & 3] * 17U; const uint32_t level = (static_cast(luminance) * 15U + threshold) / 255U; return static_cast(level > 15U ? 15U : level); } // Binary variant for fast updates, which only draw black and white static inline uint8_t dither_to_bw_nibble(uint8_t luminance, int32_t x, int32_t y) { // Scaling by 16 keeps the highest threshold at 240, so pure white (0xFF) is never classified as black const uint32_t threshold = BAYER_4X4[y & 3][x & 3] * 16U; return luminance > threshold ? 0xF : 0x0; } extern "C" { struct T5s3DisplayInternal { uint8_t* framebuffer; bool powered; // Fast updates since the last quality refresh uint32_t partial_count_since_quality; // Until this tick every update uses quality mode TickType_t quality_hold_until_tick; // Tick at which the current hold window started TickType_t quality_hold_session_start_tick; }; static void power_on(T5s3DisplayInternal* internal) { if (!internal->powered) { t5s3_epd_power_on(); internal->powered = true; } } // region DisplayApi static error_t t5s3_display_reset(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); // The panel has no reset line, so a power cycle is the closest equivalent t5s3_epd_power_off(); internal->powered = false; power_on(internal); return ERROR_NONE; } /** Initialization is done in start() */ static error_t t5s3_display_init(Device*) { return ERROR_NONE; } /** Fills the panel white with one full update, without the flashing cycles of the initial clear */ static error_t t5s3_display_clear(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); power_on(internal); t5s3_epd_fill_white(); const bool success = t5s3_epd_update(T5s3EpdMode::Full, 0, T5S3_EPD_HEIGHT); if (success) { internal->partial_count_since_quality = 0; internal->quality_hold_until_tick = 0; } return success ? ERROR_NONE : ERROR_RESOURCE; } /** * Redraws the current content with a quality update to remove ghosting. * The update skips pixels that did not change, so every pixel is invalidated first. */ static error_t t5s3_display_refresh(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); power_on(internal); t5s3_epd_invalidate(); const bool success = t5s3_epd_update(T5s3EpdMode::Full, 0, T5S3_EPD_HEIGHT); if (success) { internal->partial_count_since_quality = 0; internal->quality_hold_until_tick = 0; } return success ? ERROR_NONE : ERROR_RESOURCE; } // Decides between a quality refresh and a fast update, *out_within_hold tells if the hold window applied static bool should_use_quality_mode(T5s3DisplayInternal* internal, int32_t width, int32_t height, bool* out_within_hold) { const TickType_t now = get_ticks(); const uint32_t area = static_cast(width) * static_cast(height); const bool is_full_screen_change = area >= static_cast( static_cast(T5S3_EPD_WIDTH * T5S3_EPD_HEIGHT) * FULL_AREA_QUALITY_THRESHOLD ); const bool partial_count_exceeded = internal->partial_count_since_quality >= QUALITY_REFRESH_PARTIAL_COUNT; // Signed difference stays correct across the tick counter wrap, 0 means no hold const TickType_t hold_until = internal->quality_hold_until_tick; const bool within_hold = hold_until != 0 && static_cast(hold_until - now) > 0; *out_within_hold = within_hold; return is_full_screen_change || partial_count_exceeded || within_hold; } // Updates the counters after an update. A failed quality update leaves them unchanged and a failed fast update still counts. // A quality update starts or extends the hold window, up to QUALITY_HOLD_SESSION_MAX_MS. static void commit_quality_mode_decision(T5s3DisplayInternal* internal, bool used_quality, bool draw_succeeded, bool was_within_hold) { if (used_quality) { if (draw_succeeded) { internal->partial_count_since_quality = 0; const TickType_t now = get_ticks(); if (!was_within_hold) { internal->quality_hold_session_start_tick = now; } const TickType_t session_elapsed = now - internal->quality_hold_session_start_tick; if (session_elapsed < millis_to_ticks(QUALITY_HOLD_SESSION_MAX_MS)) { internal->quality_hold_until_tick = now + millis_to_ticks(QUALITY_HOLD_MS); } else { internal->quality_hold_until_tick = 0; } } } else { internal->partial_count_since_quality++; } } // Reports GRAYSCALE8 so that draw_bitmap() is called per changed tile static error_t t5s3_display_draw_bitmap(Device* device, int32_t x_start, int32_t y_start, int32_t x_end, int32_t y_end, const void* color_data) { auto* internal = static_cast(device_get_driver_data(device)); const int32_t width = x_end - x_start; const int32_t height = y_end - y_start; bool within_hold = false; const bool use_quality = should_use_quality_mode(internal, width, height, &within_hold); // color_data is 8-bit luminance (0x00 black to 0xFF white) and the panel wants 4-bit levels (0x0 black to 0xF white) // Dithering uses 16 levels for quality updates and 2 levels for fast updates const auto* src = static_cast(color_data); const size_t src_stride = static_cast(width); for (int32_t row = 0; row < height; row++) { const uint8_t* src_row = src + static_cast(row) * src_stride; const int32_t display_y = y_start + row; for (int32_t col = 0; col < width; col++) { const int32_t display_x = x_start + col; const uint8_t nibble = use_quality ? dither_to_nibble(src_row[col], display_x, display_y) : dither_to_bw_nibble(src_row[col], display_x, display_y); t5s3_epd_set_pixel(internal->framebuffer, display_x, display_y, nibble); } } power_on(internal); const bool success = t5s3_epd_update(use_quality ? T5s3EpdMode::Quality : T5s3EpdMode::Fast, y_start, y_end); commit_quality_mode_decision(internal, use_quality, success, within_hold); return success ? ERROR_NONE : ERROR_RESOURCE; } static error_t t5s3_display_disp_on_off(Device* device, bool on_off) { auto* internal = static_cast(device_get_driver_data(device)); if (on_off) { power_on(internal); } else if (internal->powered) { t5s3_epd_power_off(); internal->powered = false; } return ERROR_NONE; } static DisplayColorFormat t5s3_display_get_color_format(Device*) { return DISPLAY_COLOR_FORMAT_GRAYSCALE8; } static uint16_t t5s3_display_get_resolution_x(Device*) { return T5S3_EPD_WIDTH; } static uint16_t t5s3_display_get_resolution_y(Device*) { return T5S3_EPD_HEIGHT; } // endregion static const DisplayApi t5s3_display_api = { // The driver converts into its own framebuffer, so the LVGL draw buffers may live in external RAM .capabilities = DISPLAY_CAPABILITY_ON_OFF | DISPLAY_CAPABILITY_SLOW_REFRESH | DISPLAY_CAPABILITY_PREFER_EXTERNAL_RAM, .reset = t5s3_display_reset, .init = t5s3_display_init, .draw_bitmap = t5s3_display_draw_bitmap, .clear = t5s3_display_clear, .refresh = t5s3_display_refresh, .mirror = nullptr, .swap_xy = nullptr, .get_swap_xy = nullptr, .get_mirror_x = nullptr, .get_mirror_y = nullptr, .set_gap = nullptr, .get_gap_x = nullptr, .get_gap_y = nullptr, .invert_color = nullptr, .disp_on_off = t5s3_display_disp_on_off, .disp_sleep = nullptr, .get_color_format = t5s3_display_get_color_format, .get_resolution_x = t5s3_display_get_resolution_x, .get_resolution_y = t5s3_display_get_resolution_y, // The framebuffer is 4bpp and not in the reported GRAYSCALE8 format .get_frame_buffer = nullptr, .get_frame_buffer_count = nullptr, .get_backlight = nullptr, .has_capability = nullptr, }; // region Driver lifecycle static error_t start(Device* device) { const auto* config = GET_CONFIG(device); auto* internal = static_cast(malloc(sizeof(T5s3DisplayInternal))); if (internal == nullptr) { return ERROR_OUT_OF_MEMORY; } internal->powered = false; if (!t5s3_epd_init(config->pixel_clock_hz)) { free(internal); return ERROR_RESOURCE; } internal->framebuffer = t5s3_epd_framebuffer(); internal->partial_count_since_quality = 0; internal->quality_hold_until_tick = 0; internal->quality_hold_session_start_tick = 0; device_set_driver_data(device, internal); // The boot splash leaves ghosting, so clear the panel with the full flash cycle before LVGL draws power_on(internal); t5s3_epd_clear(); LOG_I(TAG, "Initialized (%dx%d)", T5S3_EPD_WIDTH, T5S3_EPD_HEIGHT); return ERROR_NONE; } static error_t stop(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); if (internal->powered) { t5s3_epd_power_off(); internal->powered = false; } t5s3_epd_deinit(); free(internal); device_set_driver_data(device, nullptr); return ERROR_NONE; } // endregion Driver t5s3_display_driver = { .name = "t5s3-display", .compatible = (const char*[]) { "lilygo,t5s3-display", nullptr }, .start_device = start, .stop_device = stop, .probe = nullptr, .api = &t5s3_display_api, .device_type = &DISPLAY_TYPE, .internal = nullptr }; }