// SPDX-License-Identifier: Apache-2.0 #include "papers3_display.h" #include #include #include #include #include #include #include #include #include #include #define TAG "Papers3Display" #define GET_CONFIG(device) (static_cast((device)->config)) // Maps each src byte (8px, MSB-first, bit=1 -> white/0x0F) to the 4 packed dst bytes // (2px/byte, EPDiy MODE_PACKING_2PPB nibble order) it produces, replacing a per-pixel // branch loop with a table lookup. static uint32_t s_unpack_lut[256]; static void init_unpack_lut() { for (uint32_t byte = 0; byte < 256; byte++) { uint8_t dst[4]; for (int32_t pair = 0; pair < 4; pair++) { const uint8_t bit0 = (byte >> (7 - pair * 2)) & 0x01U; const uint8_t bit1 = (byte >> (7 - pair * 2 - 1)) & 0x01U; const uint8_t p0 = bit0 ? 0x0FU : 0x00U; const uint8_t p1 = bit1 ? 0x0FU : 0x00U; dst[pair] = static_cast((p1 << 4U) | p0); } memcpy(&s_unpack_lut[byte], dst, sizeof(dst)); } } extern "C" { extern Module m5stack_papers3_module; // epd_hl_init() sets an internal already_initialized flag and has no matching deinit, so the // highlevel state (and the framebuffer it owns) must persist across stop()/start() cycles and be // reused rather than recreated - ported from the old deprecated-HAL EpdiyDisplay's identical // s_hlInitialized/s_hlState statics. static bool s_hl_initialized = false; static EpdiyHighlevelState s_hl_state = {}; struct Papers3DisplayInternal { EpdiyHighlevelState hl_state; uint8_t* framebuffer; // Scratch buffer for the I1(1bpp)->EPDiy(4bpp packed, 2px/byte) conversion in draw_bitmap(). uint8_t* packed_buffer; bool powered; }; static void power_on(Papers3DisplayInternal* internal) { if (!internal->powered) { epd_poweron(); internal->powered = true; } } // region DisplayApi static error_t papers3_display_reset(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); // EPD has no discrete reset pin/sequence the way SPI TFT panels do - epd_init() (in start()) // already performs the real one-time hardware bring-up. A power-cycle is the closest // equivalent available at runtime. epd_poweroff(); internal->powered = false; power_on(internal); return ERROR_NONE; } static error_t papers3_display_init(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); power_on(internal); epd_clear(); epd_hl_set_all_white(&internal->hl_state); return ERROR_NONE; } // LVGL only ever calls this with the full frame: DISPLAY_COLOR_FORMAT_MONOCHROME forces // LV_DISPLAY_RENDER_MODE_FULL in the generic kernel LVGL bridge (lvgl_display.c), and FULL mode // only presents (calls draw_bitmap) once per render cycle, with the complete 0,0..hres,vres rect. static error_t papers3_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 auto* config = GET_CONFIG(device); const int32_t width = x_end - x_start; const int32_t height = y_end - y_start; // color_data is DISPLAY_COLOR_FORMAT_MONOCHROME: row-major, MSB-first 1bpp (LVGL's LV_COLOR_FORMAT_I1 // with the palette header already stripped by the caller). Bit 1 = white/lit (LVGL's I1 blend // sets a bit when the source luminance is above its threshold), bit 0 = black. const auto* src = static_cast(color_data); const size_t src_stride = static_cast(width + 7) / 8; const size_t packed_stride = static_cast(width + 1) / 2; for (int32_t row = 0; row < height; row++) { const uint8_t* src_row = src + static_cast(row) * src_stride; uint8_t* dst_row = internal->packed_buffer + static_cast(row) * packed_stride; int32_t col = 0; // Bulk path: one LUT lookup + 4-byte copy per 8 source pixels. for (; col + 8 <= width; col += 8) { memcpy(dst_row + col / 2, &s_unpack_lut[src_row[col / 8]], 4); } // Tail: fewer than 8 pixels left (width not a multiple of 8). for (; col < width; col += 2) { const uint8_t bit0 = (src_row[col / 8] >> (7 - (col % 8))) & 0x01U; const uint8_t p0 = bit0 ? 0x0FU : 0x00U; uint8_t p1 = 0; if (col + 1 < width) { const uint8_t bit1 = (src_row[(col + 1) / 8] >> (7 - ((col + 1) % 8))) & 0x01U; p1 = bit1 ? 0x0FU : 0x00U; } dst_row[col / 2] = static_cast((p1 << 4U) | p0); } } const EpdRect update_area = { .x = x_start, .y = y_start, .width = static_cast(width), .height = static_cast(height) }; power_on(internal); epd_draw_rotated_image(update_area, internal->packed_buffer, internal->framebuffer); auto draw_result = epd_hl_update_area( &internal->hl_state, static_cast(config->draw_mode | MODE_PACKING_2PPB), config->temperature_celsius, update_area ); return draw_result == EPD_DRAW_SUCCESS ? ERROR_NONE : ERROR_RESOURCE; } static error_t papers3_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) { epd_poweroff(); internal->powered = false; } return ERROR_NONE; } static DisplayColorFormat papers3_display_get_color_format(Device*) { return DISPLAY_COLOR_FORMAT_MONOCHROME; } // epd_width()/epd_height() are the panel's native, unrotated dimensions (display->width/height in // epdiy.c) - epd_rotated_display_width()/height() swap them for EPD_ROT_PORTRAIT/INVERTED_PORTRAIT. // epd_draw_rotated_image() clamps its input rect against the *rotated* dims and epd_draw_pixel() // applies the rotation transform on top of that (see _rotate() in epdiy.c), so both LVGL's canvas // size and draw_bitmap()'s rect must be in rotated-space, not native-space - using the native // epd_width()/epd_height() here fed rotated-space code a landscape-sized canvas, which produced // exactly the "rotated + landscape" symptom this was fixed for. static uint16_t papers3_display_get_resolution_x(Device*) { return static_cast(epd_rotated_display_width()); } static uint16_t papers3_display_get_resolution_y(Device*) { return static_cast(epd_rotated_display_height()); } static void papers3_display_get_frame_buffer(Device*, uint8_t, void** out_buffer) { // Not exposed via the generic fb-direct path: EPDiy's framebuffer is its own 4bpp packed // format, not the DISPLAY_COLOR_FORMAT_MONOCHROME (1bpp) this driver reports - see // get_frame_buffer_count() and draw_bitmap()'s conversion. *out_buffer = nullptr; } static uint8_t papers3_display_get_frame_buffer_count(Device*) { return 0; } // endregion static const DisplayApi papers3_display_api = { .capabilities = DISPLAY_CAPABILITY_ON_OFF | DISPLAY_CAPABILITY_REQUIRES_FULL_FRAME | DISPLAY_CAPABILITY_SLOW_REFRESH, .reset = papers3_display_reset, .init = papers3_display_init, .draw_bitmap = papers3_display_draw_bitmap, .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 = papers3_display_disp_on_off, .disp_sleep = nullptr, .get_color_format = papers3_display_get_color_format, .get_resolution_x = papers3_display_get_resolution_x, .get_resolution_y = papers3_display_get_resolution_y, .get_frame_buffer = papers3_display_get_frame_buffer, .get_frame_buffer_count = papers3_display_get_frame_buffer_count, .get_backlight = nullptr, .has_capability = nullptr, }; // region Driver lifecycle static error_t start(Device* device) { const auto* config = GET_CONFIG(device); static bool s_lut_initialized = false; if (!s_lut_initialized) { init_unpack_lut(); s_lut_initialized = true; } auto* internal = static_cast(malloc(sizeof(Papers3DisplayInternal))); if (internal == nullptr) { return ERROR_OUT_OF_MEMORY; } internal->powered = false; epd_init(&epd_board_m5papers3, &ED047TC1, static_cast(EPD_LUT_1K | EPD_FEED_QUEUE_32)); epd_set_rotation(config->rotation); if (!s_hl_initialized) { s_hl_state = epd_hl_init(EPD_BUILTIN_WAVEFORM); if (s_hl_state.front_fb == nullptr) { LOG_E(TAG, "Failed to initialize EPDiy highlevel state"); epd_deinit(); free(internal); return ERROR_RESOURCE; } s_hl_initialized = true; } else { LOG_I(TAG, "Reusing existing EPDiy highlevel state"); } internal->hl_state = s_hl_state; internal->framebuffer = epd_hl_get_framebuffer(&internal->hl_state); // Sized for the rotated (LVGL-facing) resolution - see get_resolution_x()/y()'s comment. const size_t packed_buffer_size = static_cast((epd_rotated_display_width() + 1) / 2) * static_cast(epd_rotated_display_height()); internal->packed_buffer = static_cast(malloc(packed_buffer_size)); if (internal->packed_buffer == nullptr) { LOG_E(TAG, "Failed to allocate packed pixel buffer"); epd_deinit(); free(internal); return ERROR_OUT_OF_MEMORY; } device_set_driver_data(device, internal); LOG_I(TAG, "EPDiy initialized (%dx%d native, %dx%d rotated)", epd_width(), epd_height(), epd_rotated_display_width(), epd_rotated_display_height()); return ERROR_NONE; } static error_t stop(Device* device) { auto* internal = static_cast(device_get_driver_data(device)); if (internal->powered) { epd_poweroff(); internal->powered = false; } epd_deinit(); free(internal->packed_buffer); free(internal); device_set_driver_data(device, nullptr); return ERROR_NONE; } // endregion Driver papers3_display_driver = { .name = "papers3-display", .compatible = (const char*[]) { "m5stack,papers3-display", nullptr }, .start_device = start, .stop_device = stop, .api = &papers3_display_api, .device_type = &DISPLAY_TYPE, .owner = &m5stack_papers3_module, .internal = nullptr }; }