diff --git a/Devices/btt-panda-touch/CMakeLists.txt b/Devices/btt-panda-touch/CMakeLists.txt index c6e98b90..b8286377 100644 --- a/Devices/btt-panda-touch/CMakeLists.txt +++ b/Devices/btt-panda-touch/CMakeLists.txt @@ -1,7 +1,7 @@ -file(GLOB_RECURSE SOURCE_FILES Source/*.c*) +file(GLOB_RECURSE SOURCE_FILES source/*.c*) idf_component_register( SRCS ${SOURCE_FILES} - INCLUDE_DIRS "Source" - REQUIRES Tactility esp_lvgl_port esp_lcd RgbDisplay GT911 PwmBacklight driver vfs fatfs + INCLUDE_DIRS "source" + REQUIRES Tactility ) diff --git a/Devices/btt-panda-touch/Source/Configuration.cpp b/Devices/btt-panda-touch/Source/Configuration.cpp deleted file mode 100644 index 443fbb3f..00000000 --- a/Devices/btt-panda-touch/Source/Configuration.cpp +++ /dev/null @@ -1,31 +0,0 @@ -#include -#include "devices/Display.h" - -#include -#include -#include -#include - -using namespace tt::hal; - -static bool initBoot() { - //Display Reset - ESP_ERROR_CHECK(gpio_set_direction(GPIO_NUM_46, GPIO_MODE_OUTPUT)); - ESP_ERROR_CHECK(gpio_set_level(GPIO_NUM_46, 0)); - vTaskDelay(pdMS_TO_TICKS(100)); - ESP_ERROR_CHECK(gpio_set_level(GPIO_NUM_46, 1)); - vTaskDelay(pdMS_TO_TICKS(10)); - - return driver::pwmbacklight::init(GPIO_NUM_21); -} - -static DeviceVector createDevices() { - return { - createDisplay() - }; -} - -extern const Configuration hardwareConfiguration = { - .initBoot = initBoot, - .createDevices = createDevices -}; diff --git a/Devices/btt-panda-touch/Source/devices/Display.cpp b/Devices/btt-panda-touch/Source/devices/Display.cpp deleted file mode 100644 index c534a556..00000000 --- a/Devices/btt-panda-touch/Source/devices/Display.cpp +++ /dev/null @@ -1,107 +0,0 @@ -#include "Display.h" - -#include -#include -#include -#include -#include - -std::shared_ptr createTouch() { - // Note for future changes: Reset pin is 41 and interrupt pin is 40 - auto* i2c = device_find_by_name("i2c0"); - check(i2c); - auto configuration = std::make_unique( - i2c, - 800, - 480 - ); - - return std::make_shared(std::move(configuration)); -} - -std::shared_ptr createDisplay() { - auto touch = createTouch(); - - constexpr uint32_t bufferPixels = 800 * 10; - - esp_lcd_rgb_panel_config_t rgb_panel_config = { - .clk_src = LCD_CLK_SRC_DEFAULT, - .timings = { - .pclk_hz = 14000000, - .h_res = 800, - .v_res = 480, - .hsync_pulse_width = 4, - .hsync_back_porch = 8, - .hsync_front_porch = 8, - .vsync_pulse_width = 4, - .vsync_back_porch = 16, - .vsync_front_porch = 16, - .flags = { - .hsync_idle_low = false, - .vsync_idle_low = false, - .de_idle_high = false, - .pclk_active_neg = true, - .pclk_idle_high = true - } - }, - .data_width = 16, - .bits_per_pixel = 0, - .num_fbs = 2, - .bounce_buffer_size_px = bufferPixels, - .sram_trans_align = 8, - .psram_trans_align = 64, - .hsync_gpio_num = GPIO_NUM_NC, - .vsync_gpio_num = GPIO_NUM_NC, - .de_gpio_num = GPIO_NUM_38, - .pclk_gpio_num = GPIO_NUM_5, - .disp_gpio_num = GPIO_NUM_NC, - .data_gpio_nums = { - GPIO_NUM_17, // B - GPIO_NUM_18, // B - GPIO_NUM_48, // B - GPIO_NUM_47, // B - GPIO_NUM_39, // B - GPIO_NUM_11, // G - GPIO_NUM_12, // G - GPIO_NUM_13, // G - GPIO_NUM_14, // G - GPIO_NUM_15, // G - GPIO_NUM_16, // G - GPIO_NUM_6, // R - GPIO_NUM_7, // R - GPIO_NUM_8, // R - GPIO_NUM_9, // R - GPIO_NUM_10, // R - }, - .flags = { - .disp_active_low = false, - .refresh_on_demand = false, - .fb_in_psram = true, - .double_fb = true, - .no_fb = false, - .bb_invalidate_cache = false - } - }; - - RgbDisplay::BufferConfiguration buffer_config = { - .size = (800 * 480), - .useSpi = true, - .doubleBuffer = true, - .bounceBufferMode = true, - .avoidTearing = false - }; - - auto configuration = std::make_unique( - rgb_panel_config, - buffer_config, - touch, - LV_COLOR_FORMAT_RGB565, - false, - false, - false, - false, - driver::pwmbacklight::setBacklightDuty - ); - - return std::make_shared(std::move(configuration)); -} \ No newline at end of file diff --git a/Devices/btt-panda-touch/Source/devices/Display.h b/Devices/btt-panda-touch/Source/devices/Display.h deleted file mode 100644 index 7a9b967d..00000000 --- a/Devices/btt-panda-touch/Source/devices/Display.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#include - -std::shared_ptr createDisplay(); diff --git a/Devices/btt-panda-touch/bigtreetech,panda-touch.dts b/Devices/btt-panda-touch/bigtreetech,panda-touch.dts index 10bca414..6f56d6a7 100644 --- a/Devices/btt-panda-touch/bigtreetech,panda-touch.dts +++ b/Devices/btt-panda-touch/bigtreetech,panda-touch.dts @@ -6,6 +6,9 @@ #include #include #include +#include +#include +#include // Reference: https://github.com/bigtreetech/PandaTouch_PlatformIO/blob/master/docs/PINOUT.md / { @@ -33,6 +36,15 @@ clock-frequency = <400000>; pin-sda = <&gpio0 2 GPIO_FLAG_NONE>; pin-scl = <&gpio0 1 GPIO_FLAG_NONE>; + + touch0 { + // Reset pin 41 and interrupt pin 40 exist on the board but are not wired up here + // (unverified - left disconnected like the original deprecated-HAL config). + compatible = "goodix,gt911"; + reg = <0x5D>; + x-max = <800>; + y-max = <480>; + }; }; i2c_external: i2c1 { @@ -43,6 +55,49 @@ pin-scl = <&gpio0 3 GPIO_FLAG_NONE>; }; + display_backlight { + compatible = "espressif,esp32-ledc-backlight"; + pin-backlight = <&gpio0 21 GPIO_FLAG_NONE>; + }; + + display0 { + compatible = "espressif,esp32-rgb-display"; + horizontal-resolution = <800>; + vertical-resolution = <480>; + pixel-clock-hz = <14000000>; + hsync-pulse-width = <4>; + hsync-back-porch = <8>; + hsync-front-porch = <8>; + vsync-pulse-width = <4>; + vsync-back-porch = <16>; + vsync-front-porch = <16>; + pclk-active-neg; + pclk-idle-high; + num-fbs = <2>; + double-fb; + bounce-buffer-size-px = <8000>; + pin-de = <&gpio0 38 GPIO_FLAG_NONE>; + pin-pclk = <&gpio0 5 GPIO_FLAG_NONE>; + pin-reset = <&gpio0 46 GPIO_FLAG_NONE>; + pin-data0 = <&gpio0 17 GPIO_FLAG_NONE>; // B + pin-data1 = <&gpio0 18 GPIO_FLAG_NONE>; // B + pin-data2 = <&gpio0 48 GPIO_FLAG_NONE>; // B + pin-data3 = <&gpio0 47 GPIO_FLAG_NONE>; // B + pin-data4 = <&gpio0 39 GPIO_FLAG_NONE>; // B + pin-data5 = <&gpio0 11 GPIO_FLAG_NONE>; // G + pin-data6 = <&gpio0 12 GPIO_FLAG_NONE>; // G + pin-data7 = <&gpio0 13 GPIO_FLAG_NONE>; // G + pin-data8 = <&gpio0 14 GPIO_FLAG_NONE>; // G + pin-data9 = <&gpio0 15 GPIO_FLAG_NONE>; // G + pin-data10 = <&gpio0 16 GPIO_FLAG_NONE>; // G + pin-data11 = <&gpio0 6 GPIO_FLAG_NONE>; // R + pin-data12 = <&gpio0 7 GPIO_FLAG_NONE>; // R + pin-data13 = <&gpio0 8 GPIO_FLAG_NONE>; // R + pin-data14 = <&gpio0 9 GPIO_FLAG_NONE>; // R + pin-data15 = <&gpio0 10 GPIO_FLAG_NONE>; // R + backlight = <&display_backlight>; + }; + usbhost0 { compatible = "espressif,esp32-usbhost"; diff --git a/Devices/btt-panda-touch/device.properties b/Devices/btt-panda-touch/device.properties index 8e65fa6d..e9e58bfc 100644 --- a/Devices/btt-panda-touch/device.properties +++ b/Devices/btt-panda-touch/device.properties @@ -12,6 +12,8 @@ hardware.esptoolFlashFreq=120M hardware.bluetooth=true hardware.usbHostEnabled=true +dependencies.useDeprecatedHal=false + storage.userDataLocation=Internal display.size=5" diff --git a/Devices/btt-panda-touch/devicetree.yaml b/Devices/btt-panda-touch/devicetree.yaml index 63084cb8..b02d1ed0 100644 --- a/Devices/btt-panda-touch/devicetree.yaml +++ b/Devices/btt-panda-touch/devicetree.yaml @@ -1,3 +1,5 @@ dependencies: - Platforms/platform-esp32 + - Drivers/rgb-display-module + - Drivers/gt911-module dts: bigtreetech,panda-touch.dts diff --git a/Devices/btt-panda-touch/Source/module.cpp b/Devices/btt-panda-touch/source/module.cpp similarity index 88% rename from Devices/btt-panda-touch/Source/module.cpp rename to Devices/btt-panda-touch/source/module.cpp index 798a66c6..1471676b 100644 --- a/Devices/btt-panda-touch/Source/module.cpp +++ b/Devices/btt-panda-touch/source/module.cpp @@ -3,12 +3,10 @@ extern "C" { static error_t start() { - // Empty for now return ERROR_NONE; } static error_t stop() { - // Empty for now return ERROR_NONE; } diff --git a/Devices/cyd-2432s024c/cyd,2432s024c.dts b/Devices/cyd-2432s024c/cyd,2432s024c.dts index a082d513..ee304999 100644 --- a/Devices/cyd-2432s024c/cyd,2432s024c.dts +++ b/Devices/cyd-2432s024c/cyd,2432s024c.dts @@ -74,7 +74,8 @@ pin-mosi = <&gpio0 23 GPIO_FLAG_NONE>; pin-miso = <&gpio0 19 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 18 GPIO_FLAG_NONE>; - + miso-pull-up; + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; diff --git a/Devices/elecrow-crowpanel-advance-35/elecrow,crowpanel-advance-35.dts b/Devices/elecrow-crowpanel-advance-35/elecrow,crowpanel-advance-35.dts index d4b106b8..e6f6cf16 100644 --- a/Devices/elecrow-crowpanel-advance-35/elecrow,crowpanel-advance-35.dts +++ b/Devices/elecrow-crowpanel-advance-35/elecrow,crowpanel-advance-35.dts @@ -81,7 +81,8 @@ pin-mosi = <&gpio0 6 GPIO_FLAG_NONE>; pin-miso = <&gpio0 4 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 5 GPIO_FLAG_NONE>; - + miso-pull-up; + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; diff --git a/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt b/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt index b414f655..b8286377 100644 --- a/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt +++ b/Devices/elecrow-crowpanel-advance-50/CMakeLists.txt @@ -1,7 +1,7 @@ -file(GLOB_RECURSE SOURCE_FILES Source/*.c*) +file(GLOB_RECURSE SOURCE_FILES source/*.c*) idf_component_register( SRCS ${SOURCE_FILES} - INCLUDE_DIRS "Source" - REQUIRES Tactility esp_lvgl_port RgbDisplay GT911 TCA9534 driver + INCLUDE_DIRS "source" + REQUIRES Tactility ) diff --git a/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp b/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp deleted file mode 100644 index 42d3e88a..00000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/Configuration.cpp +++ /dev/null @@ -1,32 +0,0 @@ -#include "devices/Display.h" - -#include -#include - -using namespace tt::hal; - -static bool initBoot() { - TCA9534_IO_EXP io_expander = { - .I2C_ADDR = 0x18, - .i2c_master_port = I2C_NUM_0, - .interrupt_pin = GPIO_NUM_NC, - .interrupt_task = nullptr - }; - - // Enable LCD backlight - set_tca9534_io_pin_direction(&io_expander, TCA9534_IO1, TCA9534_OUTPUT); - set_tca9534_io_pin_output_state(&io_expander, TCA9534_IO1, 255); - - return true; -} - -static DeviceVector createDevices() { - return { - createDisplay(), - }; -} - -extern const Configuration hardwareConfiguration = { - .initBoot = initBoot, - .createDevices = createDevices -}; diff --git a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp deleted file mode 100644 index 26f9bdc7..00000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.cpp +++ /dev/null @@ -1,106 +0,0 @@ -#include "Display.h" - -#include -#include -#include -#include - -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* i2c = device_find_by_name("i2c0"); - check(i2c); - auto configuration = std::make_unique( - i2c, - 800, - 480 - ); - - return std::make_shared(std::move(configuration)); -} - -std::shared_ptr createDisplay() { - auto touch = createTouch(); - - constexpr uint32_t bufferPixels = 800 * 10; - - esp_lcd_rgb_panel_config_t rgb_panel_config = { - .clk_src = LCD_CLK_SRC_DEFAULT, - .timings = { - .pclk_hz = 15000000, // TODO: 21 MHz was too much and caused drift when opening wifi/SD/apps. Try something inbetween 15 and 21 MHz. - .h_res = 800, - .v_res = 480, - .hsync_pulse_width = 4, - .hsync_back_porch = 8, - .hsync_front_porch = 8, - .vsync_pulse_width = 4, - .vsync_back_porch = 8, - .vsync_front_porch = 8, - .flags = { - .hsync_idle_low = false, - .vsync_idle_low = false, - .de_idle_high = false, - .pclk_active_neg = true, - .pclk_idle_high = false - } - }, - .data_width = 16, - .bits_per_pixel = 0, - .num_fbs = 2, - .bounce_buffer_size_px = bufferPixels, - .sram_trans_align = 8, - .psram_trans_align = 64, - .hsync_gpio_num = GPIO_NUM_40, - .vsync_gpio_num = GPIO_NUM_41, - .de_gpio_num = GPIO_NUM_42 , - .pclk_gpio_num = GPIO_NUM_39, - .disp_gpio_num = GPIO_NUM_NC, - .data_gpio_nums = { - GPIO_NUM_21, // B3 - GPIO_NUM_47, // B4 - GPIO_NUM_48, // B5 - GPIO_NUM_45, // B6 - GPIO_NUM_38, // B7 - GPIO_NUM_9, // G2 - GPIO_NUM_10, // G3 - GPIO_NUM_11, // G4 - GPIO_NUM_12, // G5 - GPIO_NUM_13, // G6 - GPIO_NUM_14, // G7 - GPIO_NUM_7, // R3 - GPIO_NUM_17, // R4 - GPIO_NUM_18, // R5 - GPIO_NUM_3, // R6 - GPIO_NUM_46, // R7 - }, - .flags = { - .disp_active_low = false, - .refresh_on_demand = false, - .fb_in_psram = true, - .double_fb = true, - .no_fb = false, - .bb_invalidate_cache = false - } - }; - - RgbDisplay::BufferConfiguration buffer_config = { - .size = (800 * 480), - .useSpi = true, - .doubleBuffer = true, - .bounceBufferMode = true, - .avoidTearing = false - }; - - auto configuration = std::make_unique( - rgb_panel_config, - buffer_config, - touch, - LV_COLOR_FORMAT_RGB565, - false, - false, - false, - false - ); - - return std::make_shared(std::move(configuration)); -} diff --git a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h b/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h deleted file mode 100644 index 7a9b967d..00000000 --- a/Devices/elecrow-crowpanel-advance-50/Source/devices/Display.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#include - -std::shared_ptr createDisplay(); diff --git a/Devices/elecrow-crowpanel-advance-50/device.properties b/Devices/elecrow-crowpanel-advance-50/device.properties index 9fa787d6..8ef94df0 100644 --- a/Devices/elecrow-crowpanel-advance-50/device.properties +++ b/Devices/elecrow-crowpanel-advance-50/device.properties @@ -12,6 +12,8 @@ hardware.tinyUsb=true hardware.esptoolFlashFreq=120M hardware.bluetooth=true +dependencies.useDeprecatedHal=false + storage.userDataLocation=SD display.size=5" diff --git a/Devices/elecrow-crowpanel-advance-50/devicetree.yaml b/Devices/elecrow-crowpanel-advance-50/devicetree.yaml index 23c65cc5..0273223b 100644 --- a/Devices/elecrow-crowpanel-advance-50/devicetree.yaml +++ b/Devices/elecrow-crowpanel-advance-50/devicetree.yaml @@ -1,3 +1,6 @@ dependencies: - Platforms/platform-esp32 + - Drivers/rgb-display-module + - Drivers/gt911-module + - Drivers/tca9534-module dts: elecrow,crowpanel-advance-50.dts diff --git a/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts b/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts index 7024ca43..0be96a1e 100644 --- a/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts +++ b/Devices/elecrow-crowpanel-advance-50/elecrow,crowpanel-advance-50.dts @@ -8,6 +8,10 @@ #include #include #include +#include +#include +#include +#include / { compatible = "root"; @@ -34,6 +38,21 @@ clock-frequency = <400000>; pin-sda = <&gpio0 15 GPIO_FLAG_NONE>; pin-scl = <&gpio0 16 GPIO_FLAG_NONE>; + + io_expander0 { + compatible = "ti,tca9534"; + reg = <0x18>; + }; + + touch0 { + // Reset pin 38 and interrupt pin 18 (or INT = NC) exist on the board but are not + // wired up here - conflicting schematic info, unverified (matches the original + // deprecated-HAL config). + compatible = "goodix,gt911"; + reg = <0x5D>; + x-max = <800>; + y-max = <480>; + }; }; spi0 { @@ -43,13 +62,56 @@ pin-mosi = <&gpio0 6 GPIO_FLAG_NONE>; pin-miso = <&gpio0 4 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 5 GPIO_FLAG_NONE>; - + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; }; }; + display_backlight { + compatible = "espressif,esp32-gpio-backlight"; + pin-backlight = <&io_expander0 1 GPIO_FLAG_NONE>; + }; + + display0 { + compatible = "espressif,esp32-rgb-display"; + horizontal-resolution = <800>; + vertical-resolution = <480>; + pixel-clock-hz = <15000000>; + hsync-pulse-width = <4>; + hsync-back-porch = <8>; + hsync-front-porch = <8>; + vsync-pulse-width = <4>; + vsync-back-porch = <8>; + vsync-front-porch = <8>; + pclk-active-neg; + num-fbs = <2>; + double-fb; + bounce-buffer-size-px = <8000>; + pin-hsync = <&gpio0 40 GPIO_FLAG_NONE>; + pin-vsync = <&gpio0 41 GPIO_FLAG_NONE>; + pin-de = <&gpio0 42 GPIO_FLAG_NONE>; + pin-pclk = <&gpio0 39 GPIO_FLAG_NONE>; + pin-data0 = <&gpio0 21 GPIO_FLAG_NONE>; // B3 + pin-data1 = <&gpio0 47 GPIO_FLAG_NONE>; // B4 + pin-data2 = <&gpio0 48 GPIO_FLAG_NONE>; // B5 + pin-data3 = <&gpio0 45 GPIO_FLAG_NONE>; // B6 + pin-data4 = <&gpio0 38 GPIO_FLAG_NONE>; // B7 + pin-data5 = <&gpio0 9 GPIO_FLAG_NONE>; // G2 + pin-data6 = <&gpio0 10 GPIO_FLAG_NONE>; // G3 + pin-data7 = <&gpio0 11 GPIO_FLAG_NONE>; // G4 + pin-data8 = <&gpio0 12 GPIO_FLAG_NONE>; // G5 + pin-data9 = <&gpio0 13 GPIO_FLAG_NONE>; // G6 + pin-data10 = <&gpio0 14 GPIO_FLAG_NONE>; // G7 + pin-data11 = <&gpio0 7 GPIO_FLAG_NONE>; // R3 + pin-data12 = <&gpio0 17 GPIO_FLAG_NONE>; // R4 + pin-data13 = <&gpio0 18 GPIO_FLAG_NONE>; // R5 + pin-data14 = <&gpio0 3 GPIO_FLAG_NONE>; // R6 + pin-data15 = <&gpio0 46 GPIO_FLAG_NONE>; // R7 + backlight = <&display_backlight>; + }; + uart0 { compatible = "espressif,esp32-uart"; port = ; diff --git a/Devices/elecrow-crowpanel-advance-50/Source/module.cpp b/Devices/elecrow-crowpanel-advance-50/source/module.cpp similarity index 88% rename from Devices/elecrow-crowpanel-advance-50/Source/module.cpp rename to Devices/elecrow-crowpanel-advance-50/source/module.cpp index e89e3765..392ea2e5 100644 --- a/Devices/elecrow-crowpanel-advance-50/Source/module.cpp +++ b/Devices/elecrow-crowpanel-advance-50/source/module.cpp @@ -3,12 +3,10 @@ extern "C" { static error_t start() { - // Empty for now return ERROR_NONE; } static error_t stop() { - // Empty for now return ERROR_NONE; } diff --git a/Devices/elecrow-crowpanel-basic-35/elecrow,crowpanel-basic-35.dts b/Devices/elecrow-crowpanel-basic-35/elecrow,crowpanel-basic-35.dts index 764b11c6..e7f888b5 100644 --- a/Devices/elecrow-crowpanel-basic-35/elecrow,crowpanel-basic-35.dts +++ b/Devices/elecrow-crowpanel-basic-35/elecrow,crowpanel-basic-35.dts @@ -77,7 +77,8 @@ pin-mosi = <&gpio0 23 GPIO_FLAG_NONE>; pin-miso = <&gpio0 19 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 18 GPIO_FLAG_NONE>; - + miso-pull-up; + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; diff --git a/Devices/elecrow-crowpanel-basic-50/CMakeLists.txt b/Devices/elecrow-crowpanel-basic-50/CMakeLists.txt index be7e933c..b8286377 100644 --- a/Devices/elecrow-crowpanel-basic-50/CMakeLists.txt +++ b/Devices/elecrow-crowpanel-basic-50/CMakeLists.txt @@ -1,7 +1,7 @@ -file(GLOB_RECURSE SOURCE_FILES Source/*.c*) +file(GLOB_RECURSE SOURCE_FILES source/*.c*) idf_component_register( SRCS ${SOURCE_FILES} - INCLUDE_DIRS "Source" - REQUIRES Tactility esp_lvgl_port RgbDisplay GT911 PwmBacklight driver + INCLUDE_DIRS "source" + REQUIRES Tactility ) diff --git a/Devices/elecrow-crowpanel-basic-50/Source/Configuration.cpp b/Devices/elecrow-crowpanel-basic-50/Source/Configuration.cpp deleted file mode 100644 index 0d7f313e..00000000 --- a/Devices/elecrow-crowpanel-basic-50/Source/Configuration.cpp +++ /dev/null @@ -1,22 +0,0 @@ -#include "devices/Display.h" - -#include -#include - -using namespace tt::hal; - -static bool initBoot() { - // Note: I tried 100 Hz to 100 kHz and couldn't get the flickering to stop - return driver::pwmbacklight::init(GPIO_NUM_2); -} - -static DeviceVector createDevices() { - return { - createDisplay(), - }; -} - -extern const Configuration hardwareConfiguration = { - .initBoot = initBoot, - .createDevices = createDevices -}; diff --git a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp b/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp deleted file mode 100644 index 8149bfa4..00000000 --- a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.cpp +++ /dev/null @@ -1,109 +0,0 @@ -#include "Display.h" - -#include -#include -#include -#include -#include - -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* i2c = device_find_by_name("i2c0"); - check(i2c); - auto configuration = std::make_unique( - i2c, - 800, - 480 - ); - - return std::make_shared(std::move(configuration)); -} - -std::shared_ptr createDisplay() { - auto touch = createTouch(); - - constexpr uint32_t bufferPixels = 800 * 10; - - esp_lcd_rgb_panel_config_t rgb_panel_config = { - .clk_src = LCD_CLK_SRC_DEFAULT, - .timings = { - .pclk_hz = 15000000, - .h_res = 800, - .v_res = 480, - .hsync_pulse_width = 4, - .hsync_back_porch = 43, - .hsync_front_porch = 8, - .vsync_pulse_width = 4, - .vsync_back_porch = 12, - .vsync_front_porch = 8, - .flags = { - .hsync_idle_low = false, - .vsync_idle_low = false, - .de_idle_high = false, - .pclk_active_neg = true, - .pclk_idle_high = false - } - }, - .data_width = 16, - .bits_per_pixel = 0, - .num_fbs = 2, - .bounce_buffer_size_px = bufferPixels, - .sram_trans_align = 8, - .psram_trans_align = 64, - .hsync_gpio_num = GPIO_NUM_39, - .vsync_gpio_num = GPIO_NUM_41, - .de_gpio_num = GPIO_NUM_40 , - .pclk_gpio_num = GPIO_NUM_0, - .disp_gpio_num = GPIO_NUM_NC, - .data_gpio_nums = { - GPIO_NUM_8, // B0 - GPIO_NUM_3, // B1 - GPIO_NUM_46, // B2 - GPIO_NUM_9, // B3 - GPIO_NUM_1, // B4 - GPIO_NUM_5, // G0 - GPIO_NUM_6, // G1 - GPIO_NUM_7, // G2 - GPIO_NUM_15, // G3 - GPIO_NUM_16, // G4 - GPIO_NUM_4, // G5 - GPIO_NUM_45, // R0 - GPIO_NUM_48, // R1 - GPIO_NUM_47, // R2 - GPIO_NUM_21, // R3 - GPIO_NUM_14, // R4 - }, - .flags = { - .disp_active_low = false, - .refresh_on_demand = false, - .fb_in_psram = true, - .double_fb = true, - .no_fb = false, - .bb_invalidate_cache = false - } - }; - - RgbDisplay::BufferConfiguration buffer_config = { - .size = (800 * 480), - .useSpi = true, - .doubleBuffer = true, - .bounceBufferMode = true, - .avoidTearing = false - }; - - auto configuration = std::make_unique( - rgb_panel_config, - buffer_config, - touch, - LV_COLOR_FORMAT_RGB565, - false, - false, - false, - false, - driver::pwmbacklight::setBacklightDuty - ); - - auto display = std::make_shared(std::move(configuration)); - return std::reinterpret_pointer_cast(display); -} diff --git a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.h b/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.h deleted file mode 100644 index 7a9b967d..00000000 --- a/Devices/elecrow-crowpanel-basic-50/Source/devices/Display.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#include - -std::shared_ptr createDisplay(); diff --git a/Devices/elecrow-crowpanel-basic-50/device.properties b/Devices/elecrow-crowpanel-basic-50/device.properties index 69633d2a..75d39c8a 100644 --- a/Devices/elecrow-crowpanel-basic-50/device.properties +++ b/Devices/elecrow-crowpanel-basic-50/device.properties @@ -12,6 +12,8 @@ hardware.tinyUsb=true hardware.esptoolFlashFreq=120M hardware.bluetooth=true +dependencies.useDeprecatedHal=false + storage.userDataLocation=SD display.size=5.0" diff --git a/Devices/elecrow-crowpanel-basic-50/devicetree.yaml b/Devices/elecrow-crowpanel-basic-50/devicetree.yaml index bb3e38a8..8d7898b9 100644 --- a/Devices/elecrow-crowpanel-basic-50/devicetree.yaml +++ b/Devices/elecrow-crowpanel-basic-50/devicetree.yaml @@ -1,3 +1,5 @@ dependencies: - Platforms/platform-esp32 + - Drivers/rgb-display-module + - Drivers/gt911-module dts: elecrow,crowpanel-basic-50.dts diff --git a/Devices/elecrow-crowpanel-basic-50/elecrow,crowpanel-basic-50.dts b/Devices/elecrow-crowpanel-basic-50/elecrow,crowpanel-basic-50.dts index cf4bdc19..8477a403 100644 --- a/Devices/elecrow-crowpanel-basic-50/elecrow,crowpanel-basic-50.dts +++ b/Devices/elecrow-crowpanel-basic-50/elecrow,crowpanel-basic-50.dts @@ -8,6 +8,9 @@ #include #include #include +#include +#include +#include / { compatible = "root"; @@ -34,6 +37,16 @@ clock-frequency = <400000>; pin-sda = <&gpio0 19 GPIO_FLAG_NONE>; pin-scl = <&gpio0 20 GPIO_FLAG_NONE>; + + touch0 { + // Reset pin 38 and interrupt pin 18 (or INT = NC) exist on the board but are not + // wired up here - conflicting schematic info, unverified (matches the original + // deprecated-HAL config). + compatible = "goodix,gt911"; + reg = <0x5D>; + x-max = <800>; + y-max = <480>; + }; }; spi0 { @@ -50,6 +63,50 @@ }; }; + display_backlight { + compatible = "espressif,esp32-ledc-backlight"; + pin-backlight = <&gpio0 2 GPIO_FLAG_NONE>; + frequency-hz = <512>; + }; + + display0 { + compatible = "espressif,esp32-rgb-display"; + horizontal-resolution = <800>; + vertical-resolution = <480>; + pixel-clock-hz = <15000000>; + hsync-pulse-width = <4>; + hsync-back-porch = <43>; + hsync-front-porch = <8>; + vsync-pulse-width = <4>; + vsync-back-porch = <12>; + vsync-front-porch = <8>; + pclk-active-neg; + num-fbs = <2>; + double-fb; + bounce-buffer-size-px = <8000>; + pin-hsync = <&gpio0 39 GPIO_FLAG_NONE>; + pin-vsync = <&gpio0 41 GPIO_FLAG_NONE>; + pin-de = <&gpio0 40 GPIO_FLAG_NONE>; + pin-pclk = <&gpio0 0 GPIO_FLAG_NONE>; + pin-data0 = <&gpio0 8 GPIO_FLAG_NONE>; // B0 + pin-data1 = <&gpio0 3 GPIO_FLAG_NONE>; // B1 + pin-data2 = <&gpio0 46 GPIO_FLAG_NONE>; // B2 + pin-data3 = <&gpio0 9 GPIO_FLAG_NONE>; // B3 + pin-data4 = <&gpio0 1 GPIO_FLAG_NONE>; // B4 + pin-data5 = <&gpio0 5 GPIO_FLAG_NONE>; // G0 + pin-data6 = <&gpio0 6 GPIO_FLAG_NONE>; // G1 + pin-data7 = <&gpio0 7 GPIO_FLAG_NONE>; // G2 + pin-data8 = <&gpio0 15 GPIO_FLAG_NONE>; // G3 + pin-data9 = <&gpio0 16 GPIO_FLAG_NONE>; // G4 + pin-data10 = <&gpio0 4 GPIO_FLAG_NONE>; // G5 + pin-data11 = <&gpio0 45 GPIO_FLAG_NONE>; // R0 + pin-data12 = <&gpio0 48 GPIO_FLAG_NONE>; // R1 + pin-data13 = <&gpio0 47 GPIO_FLAG_NONE>; // R2 + pin-data14 = <&gpio0 21 GPIO_FLAG_NONE>; // R3 + pin-data15 = <&gpio0 14 GPIO_FLAG_NONE>; // R4 + backlight = <&display_backlight>; + }; + uart0 { compatible = "espressif,esp32-uart"; port = ; diff --git a/Devices/elecrow-crowpanel-basic-50/Source/module.cpp b/Devices/elecrow-crowpanel-basic-50/source/module.cpp similarity index 88% rename from Devices/elecrow-crowpanel-basic-50/Source/module.cpp rename to Devices/elecrow-crowpanel-basic-50/source/module.cpp index b1e495e0..392d7cba 100644 --- a/Devices/elecrow-crowpanel-basic-50/Source/module.cpp +++ b/Devices/elecrow-crowpanel-basic-50/source/module.cpp @@ -3,12 +3,10 @@ extern "C" { static error_t start() { - // Empty for now return ERROR_NONE; } static error_t stop() { - // Empty for now return ERROR_NONE; } diff --git a/Devices/lilygo-tdeck-plus/lilygo,tdeck-plus.dts b/Devices/lilygo-tdeck-plus/lilygo,tdeck-plus.dts index 263503a4..6e7b737f 100644 --- a/Devices/lilygo-tdeck-plus/lilygo,tdeck-plus.dts +++ b/Devices/lilygo-tdeck-plus/lilygo,tdeck-plus.dts @@ -101,6 +101,7 @@ pin-sda = <&gpio0 18 GPIO_FLAG_NONE>; pin-scl = <&gpio0 8 GPIO_FLAG_NONE>; + // WARNING: Don't use the interrupt pin as it's unstable on some devices touch { compatible = "goodix,gt911"; reg = <0x5D>; @@ -108,7 +109,6 @@ y-max = <320>; swap-xy; mirror-x; - pin-interrupt = <&gpio0 16 GPIO_FLAG_NONE>; }; keyboard { diff --git a/Devices/lilygo-tdeck/lilygo,tdeck.dts b/Devices/lilygo-tdeck/lilygo,tdeck.dts index 265c3c6d..da408c31 100644 --- a/Devices/lilygo-tdeck/lilygo,tdeck.dts +++ b/Devices/lilygo-tdeck/lilygo,tdeck.dts @@ -101,6 +101,7 @@ pin-sda = <&gpio0 18 GPIO_FLAG_NONE>; pin-scl = <&gpio0 8 GPIO_FLAG_NONE>; + // WARNING: Don't use the interrupt pin as it's unstable on some devices touch { compatible = "goodix,gt911"; reg = <0x5D>; @@ -108,7 +109,6 @@ y-max = <320>; swap-xy; mirror-x; - pin-interrupt = <&gpio0 16 GPIO_FLAG_NONE>; }; keyboard { diff --git a/Devices/m5stack-cardputer-adv/m5stack,cardputer-adv.dts b/Devices/m5stack-cardputer-adv/m5stack,cardputer-adv.dts index 535dd0eb..a0014508 100644 --- a/Devices/m5stack-cardputer-adv/m5stack,cardputer-adv.dts +++ b/Devices/m5stack-cardputer-adv/m5stack,cardputer-adv.dts @@ -122,7 +122,8 @@ pin-mosi = <&gpio0 14 GPIO_FLAG_NONE>; pin-miso = <&gpio0 39 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 40 GPIO_FLAG_NONE>; - + miso-pull-up; + sdcard@0 { compatible = "espressif,esp32-sdspi"; status = "disabled"; diff --git a/Devices/m5stack-cardputer/m5stack,cardputer.dts b/Devices/m5stack-cardputer/m5stack,cardputer.dts index 90e7383e..cc34fca9 100644 --- a/Devices/m5stack-cardputer/m5stack,cardputer.dts +++ b/Devices/m5stack-cardputer/m5stack,cardputer.dts @@ -104,7 +104,8 @@ pin-mosi = <&gpio0 14 GPIO_FLAG_NONE>; pin-miso = <&gpio0 39 GPIO_FLAG_NONE>; pin-sclk = <&gpio0 40 GPIO_FLAG_NONE>; - + miso-pull-up; + sdcard@0 { compatible = "espressif,esp32-sdspi"; frequency-khz = <20000>; diff --git a/Documentation/ideas.md b/Documentation/ideas.md index f0fd9959..59e41d27 100644 --- a/Documentation/ideas.md +++ b/Documentation/ideas.md @@ -12,6 +12,7 @@ ## Higher Priority +- When display orientation is changed, show a dialog that asks if it succeeded. If the user doesn't click "ok" then restore the previous settings. - Add font design tokens such as "regular", "title" and "smaller". Perhaps via the LVGL kernel module. - Add kernel listening mechanism so that the root device init can be notified when a device becomes available: Callback for device/start stop with filtering on device type: diff --git a/Drivers/rgb-display-module/CMakeLists.txt b/Drivers/rgb-display-module/CMakeLists.txt new file mode 100644 index 00000000..3a6edda5 --- /dev/null +++ b/Drivers/rgb-display-module/CMakeLists.txt @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.20) + +include("${CMAKE_CURRENT_LIST_DIR}/../../Buildscripts/module.cmake") + +file(GLOB_RECURSE SOURCE_FILES "source/*.c*") + +tactility_add_module(rgb-display-module + SRCS ${SOURCE_FILES} + INCLUDE_DIRS include/ + REQUIRES TactilityKernel platform-esp32 esp_lcd driver +) diff --git a/Drivers/rgb-display-module/LICENSE-Apache-2.0.md b/Drivers/rgb-display-module/LICENSE-Apache-2.0.md new file mode 100644 index 00000000..f5f4b8b5 --- /dev/null +++ b/Drivers/rgb-display-module/LICENSE-Apache-2.0.md @@ -0,0 +1,195 @@ +Apache License +============== + +_Version 2.0, January 2004_ +_<>_ + +### Terms and Conditions for use, reproduction, and distribution + +#### 1. Definitions + +“License” shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +“Licensor” shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +“Legal Entity” shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, “control” means **(i)** the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the +outstanding shares, or **(iii)** beneficial ownership of such entity. + +“You” (or “Your”) shall mean an individual or Legal Entity exercising +permissions granted by this License. + +“Source” form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +“Object” form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +“Work” shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +“Derivative Works” shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +“Contribution” shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +“submitted” means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as “Not a Contribution.” + +“Contributor” shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +#### 2. Grant of Copyright License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +#### 3. Grant of Patent License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +#### 4. Redistribution + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +* **(a)** You must give any other recipients of the Work or Derivative Works a copy of +this License; and +* **(b)** You must cause any modified files to carry prominent notices stating that You +changed the files; and +* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +#### 5. Submission of Contributions + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +#### 6. Trademarks + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +#### 7. Disclaimer of Warranty + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +#### 8. Limitation of Liability + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +#### 9. Accepting Warranty or Additional Liability + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +_END OF TERMS AND CONDITIONS_ + +### APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets `[]` replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same “printed page” as the copyright notice for easier identification within +third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/Drivers/rgb-display-module/README.md b/Drivers/rgb-display-module/README.md new file mode 100644 index 00000000..c76f24af --- /dev/null +++ b/Drivers/rgb-display-module/README.md @@ -0,0 +1,5 @@ +# RGB Display Driver + +A kernel driver for ESP32 RGB (parallel timing-driven) LCD panels, built on ESP-IDF's `esp_lcd_rgb_panel` component. Unlike SPI/i8080 panels, an RGB panel owns its GPIOs directly and has no command interface, so it doesn't sit behind a shared bus controller device - kernel driver equivalent of the deprecated HAL's `RgbDisplay`. + +License: [Apache v2.0](LICENSE-Apache-2.0.md) diff --git a/Drivers/rgb-display-module/bindings/espressif,esp32-rgb-display.yaml b/Drivers/rgb-display-module/bindings/espressif,esp32-rgb-display.yaml new file mode 100644 index 00000000..f0d43a66 --- /dev/null +++ b/Drivers/rgb-display-module/bindings/espressif,esp32-rgb-display.yaml @@ -0,0 +1,224 @@ +description: > + ESP32 RGB (parallel timing-driven) LCD panel, built on ESP-IDF's esp_lcd_rgb_panel + component. Unlike SPI/i8080 panels, an RGB panel has no command interface and owns its + GPIOs directly rather than sitting behind a shared bus controller device. + +compatible: "espressif,esp32-rgb-display" + +properties: + horizontal-resolution: + type: int + required: true + description: Horizontal resolution in pixels + vertical-resolution: + type: int + required: true + description: Vertical resolution in pixels + pixel-clock-hz: + type: int + required: true + description: Pixel clock frequency in Hz + hsync-pulse-width: + type: int + required: true + description: Horizontal sync width, in PCLK periods + hsync-back-porch: + type: int + required: true + description: Number of PCLK periods between hsync and the start of line active data + hsync-front-porch: + type: int + required: true + description: Number of PCLK periods between the end of active data and the next hsync + vsync-pulse-width: + type: int + required: true + description: Vertical sync width, in lines + vsync-back-porch: + type: int + required: true + description: Number of invalid lines between vsync and the start of the frame + vsync-front-porch: + type: int + required: true + description: Number of invalid lines between the end of the frame and the next vsync + hsync-idle-low: + type: boolean + default: false + description: The hsync signal is low in the idle state + vsync-idle-low: + type: boolean + default: false + description: The vsync signal is low in the idle state + de-idle-high: + type: boolean + default: false + description: The DE signal is high in the idle state + pclk-active-neg: + type: boolean + default: false + description: Whether display data is clocked out on the falling edge of PCLK + pclk-idle-high: + type: boolean + default: false + description: The PCLK signal stays high in the idle phase + data-width: + type: int + default: 16 + description: Number of parallel data lines wired (8 or 16) + bits-per-pixel: + type: int + default: 0 + description: Frame buffer color depth in bpp. 0 defaults to data-width. + num-fbs: + type: int + default: 1 + description: Number of screen-sized frame buffers to allocate (0 or 1 = single-buffered) + bounce-buffer-size-px: + type: int + default: 0 + description: Non-zero enables the DRAM bounce-buffer DMA path, sized in pixels + sram-trans-align: + type: int + default: 8 + description: Alignment of buffers allocated in internal SRAM + psram-trans-align: + type: int + default: 64 + description: Alignment of buffers allocated in PSRAM + pin-hsync: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: HSYNC GPIO pin, optional for panels that only need DE (data-enable) sync + pin-vsync: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: VSYNC GPIO pin, optional for panels that only need DE (data-enable) sync + pin-de: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data-enable GPIO pin, optional + pin-pclk: + type: phandles + required: true + description: Pixel-clock GPIO pin + pin-disp: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Optional display-enable control GPIO pin + pin-reset: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Optional hardware reset pin for the panel's own driver IC, pulsed once at start() + reset-active-high: + type: boolean + default: false + description: Whether the reset pin is active high + pin-data0: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 0 GPIO pin + pin-data1: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 1 GPIO pin + pin-data2: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 2 GPIO pin + pin-data3: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 3 GPIO pin + pin-data4: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 4 GPIO pin + pin-data5: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 5 GPIO pin + pin-data6: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 6 GPIO pin + pin-data7: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 7 GPIO pin + pin-data8: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 8 GPIO pin + pin-data9: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 9 GPIO pin + pin-data10: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 10 GPIO pin + pin-data11: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 11 GPIO pin + pin-data12: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 12 GPIO pin + pin-data13: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 13 GPIO pin + pin-data14: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 14 GPIO pin + pin-data15: + type: phandles + default: GPIO_PIN_SPEC_NONE + description: Data bus bit 15 GPIO pin + disp-active-low: + type: boolean + default: false + description: A low level on the display-enable control signal turns the screen on + refresh-on-demand: + type: boolean + default: false + description: Only refresh the frame buffer on explicit draw_bitmap calls + fb-in-psram: + type: boolean + default: true + description: Allocate the frame buffer from PSRAM, preferentially + double-fb: + type: boolean + default: false + description: Allocate two screen-sized frame buffers (equivalent to num-fbs = 2) + no-fb: + type: boolean + default: false + description: Don't allocate a frame buffer; bounce buffer must be filled manually + bb-invalidate-cache: + type: boolean + default: false + description: Invalidate cache on bounce-buffer reads (can be dangerous with multi-core writers) + swap-xy: + type: boolean + default: false + description: Swap the X and Y axes + mirror-x: + type: boolean + default: false + description: Mirror the X axis + mirror-y: + type: boolean + default: false + description: Mirror the Y axis + invert-color: + type: boolean + default: false + description: Invert the panel's color output + backlight: + type: phandle + default: "NULL" + description: Optional reference to this display's backlight device diff --git a/Drivers/rgb-display-module/devicetree.yaml b/Drivers/rgb-display-module/devicetree.yaml new file mode 100644 index 00000000..a07d6f33 --- /dev/null +++ b/Drivers/rgb-display-module/devicetree.yaml @@ -0,0 +1,3 @@ +dependencies: + - TactilityKernel +bindings: bindings diff --git a/Drivers/rgb-display-module/include/bindings/rgb_display.h b/Drivers/rgb-display-module/include/bindings/rgb_display.h new file mode 100644 index 00000000..3075705f --- /dev/null +++ b/Drivers/rgb-display-module/include/bindings/rgb_display.h @@ -0,0 +1,10 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include +#include + +// The devicetree compiler derives the expected config typedef name from the compatible +// string's suffix (e.g. "espressif,esp32-rgb-display" -> esp32_rgb_display_config_dt), not +// from the node name or driver name, so the tag here must match that exactly. +DEFINE_DEVICETREE(esp32_rgb_display, struct RgbDisplayConfig) diff --git a/Drivers/rgb-display-module/include/drivers/rgb_display.h b/Drivers/rgb-display-module/include/drivers/rgb_display.h new file mode 100644 index 00000000..f6aff1f0 --- /dev/null +++ b/Drivers/rgb-display-module/include/drivers/rgb_display.h @@ -0,0 +1,91 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include + +#include +#include + +struct RgbDisplayConfig { + uint16_t horizontal_resolution; + uint16_t vertical_resolution; + + uint32_t pixel_clock_hz; + uint32_t hsync_pulse_width; + uint32_t hsync_back_porch; + uint32_t hsync_front_porch; + uint32_t vsync_pulse_width; + uint32_t vsync_back_porch; + uint32_t vsync_front_porch; + bool hsync_idle_low; + bool vsync_idle_low; + bool de_idle_high; + bool pclk_active_neg; + bool pclk_idle_high; + + // Number of parallel data lines actually wired (8 or 16). Only the first data_width + // pin-dataN fields below are used; the rest are ignored. + uint8_t data_width; + // Frame buffer color depth in bpp. 0 defaults to data_width. + uint8_t bits_per_pixel; + // Number of screen-sized frame buffers the driver allocates (0 or 1 = single-buffered). + uint8_t num_fbs; + // Non-zero enables the DRAM bounce-buffer DMA path, sized in pixels. + uint32_t bounce_buffer_size_px; + uint32_t sram_trans_align; + uint32_t psram_trans_align; + + struct GpioPinSpec pin_hsync; + struct GpioPinSpec pin_vsync; + struct GpioPinSpec pin_de; + struct GpioPinSpec pin_pclk; + // Optional display-enable control pin, GPIO_PIN_SPEC_NONE if unused. + struct GpioPinSpec pin_disp; + // Optional hardware reset pin for the panel's own driver IC, pulsed once at start() before + // the RGB peripheral is brought up. GPIO_PIN_SPEC_NONE if the panel has none (esp_lcd_rgb_panel + // itself has no reset concept - some RGB panels still have a separate reset line on their + // internal driver IC even though pixel data is fed over the RGB bus). + struct GpioPinSpec pin_reset; + bool reset_active_high; + + struct GpioPinSpec pin_data0; + struct GpioPinSpec pin_data1; + struct GpioPinSpec pin_data2; + struct GpioPinSpec pin_data3; + struct GpioPinSpec pin_data4; + struct GpioPinSpec pin_data5; + struct GpioPinSpec pin_data6; + struct GpioPinSpec pin_data7; + struct GpioPinSpec pin_data8; + struct GpioPinSpec pin_data9; + struct GpioPinSpec pin_data10; + struct GpioPinSpec pin_data11; + struct GpioPinSpec pin_data12; + struct GpioPinSpec pin_data13; + struct GpioPinSpec pin_data14; + struct GpioPinSpec pin_data15; + + bool disp_active_low; + bool refresh_on_demand; + bool fb_in_psram; + bool double_fb; + bool no_fb; + bool bb_invalidate_cache; + + bool swap_xy; + bool mirror_x; + bool mirror_y; + bool invert_color; + + // Optional reference to this display's backlight device, NULL if none. + struct Device* backlight; +}; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/rgb-display-module/include/rgb_display_module.h b/Drivers/rgb-display-module/include/rgb_display_module.h new file mode 100644 index 00000000..044263bc --- /dev/null +++ b/Drivers/rgb-display-module/include/rgb_display_module.h @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +extern struct Module rgb_display_module; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/rgb-display-module/source/module.cpp b/Drivers/rgb-display-module/source/module.cpp new file mode 100644 index 00000000..79db516c --- /dev/null +++ b/Drivers/rgb-display-module/source/module.cpp @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#include +#include + +extern "C" { + +extern Driver rgb_display_driver; + +static error_t start() { + /* We crash when construct fails, because if a single driver fails to construct, + * there is no guarantee that the previously constructed drivers can be destroyed */ + check(driver_construct_add(&rgb_display_driver) == ERROR_NONE); + return ERROR_NONE; +} + +static error_t stop() { + /* We crash when destruct fails, because if a single driver fails to destruct, + * there is no guarantee that the previously destroyed drivers can be recovered */ + check(driver_remove_destruct(&rgb_display_driver) == ERROR_NONE); + return ERROR_NONE; +} + +Module rgb_display_module = { + .name = "rgb_display", + .start = start, + .stop = stop, + .symbols = nullptr, + .internal = nullptr +}; + +} // extern "C" diff --git a/Drivers/rgb-display-module/source/rgb_display.cpp b/Drivers/rgb-display-module/source/rgb_display.cpp new file mode 100644 index 00000000..93cdccbe --- /dev/null +++ b/Drivers/rgb-display-module/source/rgb_display.cpp @@ -0,0 +1,413 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#if SOC_LCD_RGB_SUPPORTED + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include +#include + +#include + +#define TAG "RgbDisplay" +#define GET_CONFIG(device) (static_cast((device)->config)) + +// Generic lvgl-module display glue (Modules/lvgl-module/source/lvgl_display.c) only ever asks +// for frame buffer index 0 and 1, so caching more than that would be dead weight. +constexpr size_t MAX_CACHED_FRAME_BUFFERS = 2; + +struct RgbDisplayInternal { + esp_lcd_panel_handle_t panel_handle; + void* frame_buffers[MAX_CACHED_FRAME_BUFFERS]; + uint8_t frame_buffer_count; + // Signaled by on_frame_buf_complete once per real DMA scan-out of a whole frame. Only + // waited on in draw_bitmap() when frame_buffer_count > 0 - see the comment there for why. + SemaphoreHandle_t frame_complete_semaphore; +}; + +// esp_lcd_rgb_panel's draw_bitmap() has a zero-copy path when color_data is one of the panel's +// own frame buffers (as returned by esp_lcd_rgb_panel_get_frame_buffer()): it just repoints which +// buffer is scanned out and returns almost instantly - well before the RGB peripheral's DMA has +// actually finished scanning out the *previous* buffer, let alone started on this one. Callers in +// full/direct LVGL render mode render straight into these real frame buffers, so if draw_bitmap() +// returned that quickly, LVGL would be free to start overwriting the *other* buffer - which may +// still be mid-scanout - producing visible tearing/flashing. on_frame_buf_complete fires once per +// actual whole-frame DMA completion (continuously, at the panel's refresh rate, independent of +// draw_bitmap calls), so waiting for the next occurrence after each draw_bitmap() genuinely +// blocks until it's safe to start writing into the frame buffers again. +static bool IRAM_ATTR on_frame_buf_complete(esp_lcd_panel_handle_t, const esp_lcd_rgb_panel_event_data_t*, void* user_ctx) { + auto* internal = static_cast(user_ctx); + BaseType_t high_task_woken = pdFALSE; + xSemaphoreGiveFromISR(internal->frame_complete_semaphore, &high_task_woken); + return high_task_woken == pdTRUE; +} + +static int pin_or_unused(const GpioPinSpec& pin) { + return pin.gpio_controller == nullptr ? -1 : static_cast(pin.pin); +} + +// Pulses the panel's own driver-IC reset line, if configured. Transient: the descriptor is +// released immediately after, since nothing else needs to touch this pin afterward. +static error_t perform_hardware_reset(const RgbDisplayConfig* config) { + if (config->pin_reset.gpio_controller == nullptr) { + return ERROR_NONE; + } + + auto* descriptor = gpio_descriptor_acquire(config->pin_reset.gpio_controller, config->pin_reset.pin, GPIO_OWNER_GPIO); + if (descriptor == nullptr) { + LOG_E(TAG, "Failed to acquire reset GPIO descriptor"); + return ERROR_RESOURCE; + } + + bool ok = gpio_descriptor_set_flags(descriptor, GPIO_FLAG_DIRECTION_OUTPUT) == ERROR_NONE; + ok = ok && gpio_descriptor_set_level(descriptor, config->reset_active_high) == ERROR_NONE; + if (ok) { + delay_millis(100); + ok = gpio_descriptor_set_level(descriptor, !config->reset_active_high) == ERROR_NONE; + delay_millis(10); + } + + gpio_descriptor_release(descriptor); + return ok ? ERROR_NONE : ERROR_RESOURCE; +} + +// region Driver lifecycle + +static error_t cache_frame_buffers(RgbDisplayInternal* internal, const RgbDisplayConfig* config) { + internal->frame_buffer_count = 0; + if (config->num_fbs == 0) { + return ERROR_NONE; + } + + // esp_lcd_rgb_panel_get_frame_buffer() is variadic: the number of out-pointer arguments + // passed must match fb_num exactly, so this can't be a loop. + size_t fb_num = config->num_fbs < MAX_CACHED_FRAME_BUFFERS ? config->num_fbs : MAX_CACHED_FRAME_BUFFERS; + esp_err_t ret; + switch (fb_num) { + case 1: + ret = esp_lcd_rgb_panel_get_frame_buffer(internal->panel_handle, 1, &internal->frame_buffers[0]); + break; + case 2: + ret = esp_lcd_rgb_panel_get_frame_buffer(internal->panel_handle, 2, &internal->frame_buffers[0], &internal->frame_buffers[1]); + break; + default: + return ERROR_NONE; + } + + if (ret != ESP_OK) { + LOG_E(TAG, "Failed to get frame buffer(s): %s", esp_err_to_name(ret)); + return ERROR_RESOURCE; + } + + internal->frame_buffer_count = (uint8_t)fb_num; + return ERROR_NONE; +} + +static error_t start(Device* device) { + const auto* config = GET_CONFIG(device); + + auto* internal = static_cast(malloc(sizeof(RgbDisplayInternal))); + if (internal == nullptr) { + return ERROR_OUT_OF_MEMORY; + } + + error_t reset_error = perform_hardware_reset(config); + if (reset_error != ERROR_NONE) { + LOG_E(TAG, "Failed to reset panel"); + free(internal); + return reset_error; + } + + esp_lcd_rgb_panel_config_t panel_config = { + .clk_src = LCD_CLK_SRC_DEFAULT, + .timings = { + .pclk_hz = config->pixel_clock_hz, + .h_res = config->horizontal_resolution, + .v_res = config->vertical_resolution, + .hsync_pulse_width = config->hsync_pulse_width, + .hsync_back_porch = config->hsync_back_porch, + .hsync_front_porch = config->hsync_front_porch, + .vsync_pulse_width = config->vsync_pulse_width, + .vsync_back_porch = config->vsync_back_porch, + .vsync_front_porch = config->vsync_front_porch, + .flags = { + .hsync_idle_low = config->hsync_idle_low, + .vsync_idle_low = config->vsync_idle_low, + .de_idle_high = config->de_idle_high, + .pclk_active_neg = config->pclk_active_neg, + .pclk_idle_high = config->pclk_idle_high, + } + }, + .data_width = config->data_width, + .bits_per_pixel = config->bits_per_pixel, + .num_fbs = config->num_fbs, + .bounce_buffer_size_px = config->bounce_buffer_size_px, + .sram_trans_align = config->sram_trans_align, + .psram_trans_align = config->psram_trans_align, + .hsync_gpio_num = pin_or_unused(config->pin_hsync), + .vsync_gpio_num = pin_or_unused(config->pin_vsync), + .de_gpio_num = pin_or_unused(config->pin_de), + .pclk_gpio_num = pin_or_unused(config->pin_pclk), + .disp_gpio_num = pin_or_unused(config->pin_disp), + .data_gpio_nums = { + pin_or_unused(config->pin_data0), + pin_or_unused(config->pin_data1), + pin_or_unused(config->pin_data2), + pin_or_unused(config->pin_data3), + pin_or_unused(config->pin_data4), + pin_or_unused(config->pin_data5), + pin_or_unused(config->pin_data6), + pin_or_unused(config->pin_data7), + pin_or_unused(config->pin_data8), + pin_or_unused(config->pin_data9), + pin_or_unused(config->pin_data10), + pin_or_unused(config->pin_data11), + pin_or_unused(config->pin_data12), + pin_or_unused(config->pin_data13), + pin_or_unused(config->pin_data14), + pin_or_unused(config->pin_data15), + }, + .flags = { + .disp_active_low = config->disp_active_low, + .refresh_on_demand = config->refresh_on_demand, + .fb_in_psram = config->fb_in_psram, + .double_fb = config->double_fb, + .no_fb = config->no_fb, + .bb_invalidate_cache = config->bb_invalidate_cache, + } + }; + + // This Config struct only exposes 16 named data pins, so on chips whose RGB peripheral has + // more data lines than that (e.g. ESP32-P4's 24), the tail of the array must be explicitly + // marked unused rather than left as the aggregate-init default of 0 (which would look like + // "GPIO0 is wired to this line"). + for (size_t i = 16; i < sizeof(panel_config.data_gpio_nums) / sizeof(panel_config.data_gpio_nums[0]); i++) { + panel_config.data_gpio_nums[i] = -1; + } + + esp_err_t ret = esp_lcd_new_rgb_panel(&panel_config, &internal->panel_handle); + if (ret != ESP_OK) { + LOG_E(TAG, "Failed to create panel: %s", esp_err_to_name(ret)); + free(internal); + return ERROR_RESOURCE; + } + + bool ok = + esp_lcd_panel_reset(internal->panel_handle) == ESP_OK && + esp_lcd_panel_init(internal->panel_handle) == ESP_OK && + esp_lcd_panel_swap_xy(internal->panel_handle, config->swap_xy) == ESP_OK && + esp_lcd_panel_mirror(internal->panel_handle, config->mirror_x, config->mirror_y) == ESP_OK && + esp_lcd_panel_invert_color(internal->panel_handle, config->invert_color) == ESP_OK; + + if (!ok) { + LOG_E(TAG, "Failed to bring up panel"); + esp_lcd_panel_del(internal->panel_handle); + free(internal); + return ERROR_RESOURCE; + } + + error_t error = cache_frame_buffers(internal, config); + if (error != ERROR_NONE) { + esp_lcd_panel_del(internal->panel_handle); + free(internal); + return error; + } + + internal->frame_complete_semaphore = xSemaphoreCreateBinary(); + if (internal->frame_complete_semaphore == nullptr) { + esp_lcd_panel_del(internal->panel_handle); + free(internal); + return ERROR_OUT_OF_MEMORY; + } + + esp_lcd_rgb_panel_event_callbacks_t callbacks = {}; + callbacks.on_frame_buf_complete = on_frame_buf_complete; + if (esp_lcd_rgb_panel_register_event_callbacks(internal->panel_handle, &callbacks, internal) != ESP_OK) { + LOG_E(TAG, "Failed to register panel event callbacks"); + vSemaphoreDelete(internal->frame_complete_semaphore); + esp_lcd_panel_del(internal->panel_handle); + free(internal); + return ERROR_RESOURCE; + } + + device_set_driver_data(device, internal); + return ERROR_NONE; +} + +static error_t stop(Device* device) { + auto* internal = static_cast(device_get_driver_data(device)); + + if (esp_lcd_panel_del(internal->panel_handle) != ESP_OK) { + LOG_E(TAG, "Failed to delete panel"); + vSemaphoreDelete(internal->frame_complete_semaphore); + free(internal); + return ERROR_RESOURCE; + } + + vSemaphoreDelete(internal->frame_complete_semaphore); + free(internal); + return ERROR_NONE; +} + +// endregion + +// region DisplayApi + +static error_t rgb_display_reset(Device* device) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_reset(internal->panel_handle) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +static error_t rgb_display_init(Device* device) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_init(internal->panel_handle) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +static error_t rgb_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)); + + // Only block for scan-out completion when the caller could be writing straight into one of + // the panel's own frame buffers (see on_frame_buf_complete's comment above for why that + // matters). With no real frame buffer of ours involved (frame_buffer_count == 0, e.g. LVGL + // partial-render mode with its own separate buffer), draw_bitmap does a real memcpy into the + // panel's buffer and there's no reuse race to guard against, so don't pay the up-to-one-frame + // latency cost for every small partial update. + bool wait_for_scanout = internal->frame_buffer_count > 0; + if (wait_for_scanout) { + xSemaphoreTake(internal->frame_complete_semaphore, 0); // clear any already-pending signal + } + + if (esp_lcd_panel_draw_bitmap(internal->panel_handle, x_start, y_start, x_end, y_end, color_data) != ESP_OK) { + return ERROR_RESOURCE; + } + + if (wait_for_scanout) { + xSemaphoreTake(internal->frame_complete_semaphore, portMAX_DELAY); + } + + return ERROR_NONE; +} + +static error_t rgb_display_mirror(Device* device, bool x_axis, bool y_axis) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_mirror(internal->panel_handle, x_axis, y_axis) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +static error_t rgb_display_swap_xy(Device* device, bool swap_axes) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_swap_xy(internal->panel_handle, swap_axes) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +static bool rgb_display_get_swap_xy(Device* device) { + return GET_CONFIG(device)->swap_xy; +} + +static bool rgb_display_get_mirror_x(Device* device) { + return GET_CONFIG(device)->mirror_x; +} + +static bool rgb_display_get_mirror_y(Device* device) { + return GET_CONFIG(device)->mirror_y; +} + +// RGB panels are raw scan-out framebuffers with no addressable-window concept the way MIPI/SPI +// panels have, so there's no gap to set. +static error_t rgb_display_set_gap(Device*, int32_t, int32_t) { + return ERROR_NOT_SUPPORTED; +} + +static error_t rgb_display_invert_color(Device* device, bool invert_color_data) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_invert_color(internal->panel_handle, invert_color_data) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +static error_t rgb_display_disp_on_off(Device* device, bool on_off) { + auto* internal = static_cast(device_get_driver_data(device)); + return esp_lcd_panel_disp_on_off(internal->panel_handle, on_off) == ESP_OK ? ERROR_NONE : ERROR_RESOURCE; +} + +// RGB panels have no MIPI DCS command interface, so there's no sleep mode to enter. +static error_t rgb_display_disp_sleep(Device*, bool) { + return ERROR_NOT_SUPPORTED; +} + +static enum DisplayColorFormat rgb_display_get_color_format(Device*) { + return DISPLAY_COLOR_FORMAT_RGB565; +} + +static uint16_t rgb_display_get_resolution_x(Device* device) { + return GET_CONFIG(device)->horizontal_resolution; +} + +static uint16_t rgb_display_get_resolution_y(Device* device) { + return GET_CONFIG(device)->vertical_resolution; +} + +static void rgb_display_get_frame_buffer(Device* device, uint8_t index, void** out_buffer) { + auto* internal = static_cast(device_get_driver_data(device)); + *out_buffer = index < internal->frame_buffer_count ? internal->frame_buffers[index] : nullptr; +} + +static uint8_t rgb_display_get_frame_buffer_count(Device* device) { + auto* internal = static_cast(device_get_driver_data(device)); + return internal->frame_buffer_count; +} + +static error_t rgb_display_get_backlight(Device* device, Device** backlight) { + auto* configured_backlight = GET_CONFIG(device)->backlight; + if (configured_backlight == nullptr) { + return ERROR_NOT_SUPPORTED; + } + *backlight = configured_backlight; + return ERROR_NONE; +} + +// endregion + +static const DisplayApi rgb_display_api = { + .reset = rgb_display_reset, + .init = rgb_display_init, + .draw_bitmap = rgb_display_draw_bitmap, + .mirror = rgb_display_mirror, + .swap_xy = rgb_display_swap_xy, + .get_swap_xy = rgb_display_get_swap_xy, + .get_mirror_x = rgb_display_get_mirror_x, + .get_mirror_y = rgb_display_get_mirror_y, + .set_gap = rgb_display_set_gap, + .invert_color = rgb_display_invert_color, + .disp_on_off = rgb_display_disp_on_off, + .disp_sleep = rgb_display_disp_sleep, + .get_color_format = rgb_display_get_color_format, + .get_resolution_x = rgb_display_get_resolution_x, + .get_resolution_y = rgb_display_get_resolution_y, + .get_frame_buffer = rgb_display_get_frame_buffer, + .get_frame_buffer_count = rgb_display_get_frame_buffer_count, + .get_backlight = rgb_display_get_backlight, +}; + +Driver rgb_display_driver = { + .name = "rgb_display", + .compatible = (const char*[]) { "espressif,esp32-rgb-display", nullptr }, + .start_device = start, + .stop_device = stop, + .api = &rgb_display_api, + .device_type = &DISPLAY_TYPE, + .owner = &rgb_display_module, + .internal = nullptr +}; + +#endif // SOC_LCD_RGB_SUPPORTED diff --git a/Drivers/tca9534-module/CMakeLists.txt b/Drivers/tca9534-module/CMakeLists.txt new file mode 100644 index 00000000..515c8f20 --- /dev/null +++ b/Drivers/tca9534-module/CMakeLists.txt @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.20) + +include("${CMAKE_CURRENT_LIST_DIR}/../../Buildscripts/module.cmake") + +file(GLOB_RECURSE SOURCE_FILES "source/*.c*") + +tactility_add_module(tca9534-module + SRCS ${SOURCE_FILES} + INCLUDE_DIRS include/ + REQUIRES TactilityKernel +) diff --git a/Drivers/tca9534-module/LICENSE-Apache-2.0.md b/Drivers/tca9534-module/LICENSE-Apache-2.0.md new file mode 100644 index 00000000..f5f4b8b5 --- /dev/null +++ b/Drivers/tca9534-module/LICENSE-Apache-2.0.md @@ -0,0 +1,195 @@ +Apache License +============== + +_Version 2.0, January 2004_ +_<>_ + +### Terms and Conditions for use, reproduction, and distribution + +#### 1. Definitions + +“License” shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +“Licensor” shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +“Legal Entity” shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, “control” means **(i)** the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the +outstanding shares, or **(iii)** beneficial ownership of such entity. + +“You” (or “Your”) shall mean an individual or Legal Entity exercising +permissions granted by this License. + +“Source” form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +“Object” form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +“Work” shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +“Derivative Works” shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +“Contribution” shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +“submitted” means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as “Not a Contribution.” + +“Contributor” shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +#### 2. Grant of Copyright License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +#### 3. Grant of Patent License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +#### 4. Redistribution + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +* **(a)** You must give any other recipients of the Work or Derivative Works a copy of +this License; and +* **(b)** You must cause any modified files to carry prominent notices stating that You +changed the files; and +* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +#### 5. Submission of Contributions + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +#### 6. Trademarks + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +#### 7. Disclaimer of Warranty + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +#### 8. Limitation of Liability + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +#### 9. Accepting Warranty or Additional Liability + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +_END OF TERMS AND CONDITIONS_ + +### APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets `[]` replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same “printed page” as the copyright notice for easier identification within +third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/Drivers/tca9534-module/README.md b/Drivers/tca9534-module/README.md new file mode 100644 index 00000000..4e02fd5c --- /dev/null +++ b/Drivers/tca9534-module/README.md @@ -0,0 +1,7 @@ +# TCA9534 I/O expander + +A driver for the `TCA9534` 8-bit I2C-bus I/O expander by Texas Instruments. + +See https://www.ti.com/product/TCA9534 + +License: [Apache v2.0](LICENSE-Apache-2.0.md) diff --git a/Drivers/tca9534-module/bindings/ti,tca9534.yaml b/Drivers/tca9534-module/bindings/ti,tca9534.yaml new file mode 100644 index 00000000..eae87c4b --- /dev/null +++ b/Drivers/tca9534-module/bindings/ti,tca9534.yaml @@ -0,0 +1,5 @@ +description: TI TCA9534 8-bit I2C-bus I/O expander + +include: ["i2c-device.yaml"] + +compatible: "ti,tca9534" diff --git a/Drivers/tca9534-module/devicetree.yaml b/Drivers/tca9534-module/devicetree.yaml new file mode 100644 index 00000000..a07d6f33 --- /dev/null +++ b/Drivers/tca9534-module/devicetree.yaml @@ -0,0 +1,3 @@ +dependencies: + - TactilityKernel +bindings: bindings diff --git a/Drivers/tca9534-module/include/bindings/tca9534.h b/Drivers/tca9534-module/include/bindings/tca9534.h new file mode 100644 index 00000000..d2223605 --- /dev/null +++ b/Drivers/tca9534-module/include/bindings/tca9534.h @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +DEFINE_DEVICETREE(tca9534, struct Tca9534Config) + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/include/drivers/tca9534.h b/Drivers/tca9534-module/include/drivers/tca9534.h new file mode 100644 index 00000000..5fc1ccf2 --- /dev/null +++ b/Drivers/tca9534-module/include/drivers/tca9534.h @@ -0,0 +1,17 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +struct Tca9534Config { + /** Address on bus */ + uint8_t address; +}; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/include/tca9534_module.h b/Drivers/tca9534-module/include/tca9534_module.h new file mode 100644 index 00000000..602807c1 --- /dev/null +++ b/Drivers/tca9534-module/include/tca9534_module.h @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: Apache-2.0 +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +extern struct Module tca9534_module; + +#ifdef __cplusplus +} +#endif diff --git a/Drivers/tca9534-module/source/module.cpp b/Drivers/tca9534-module/source/module.cpp new file mode 100644 index 00000000..96f43aa5 --- /dev/null +++ b/Drivers/tca9534-module/source/module.cpp @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#include +#include + +extern "C" { + +extern Driver tca9534_driver; + +static error_t start() { + /* We crash when construct fails, because if a single driver fails to construct, + * there is no guarantee that the previously constructed drivers can be destroyed */ + check(driver_construct_add(&tca9534_driver) == ERROR_NONE); + return ERROR_NONE; +} + +static error_t stop() { + /* We crash when destruct fails, because if a single driver fails to destruct, + * there is no guarantee that the previously destroyed drivers can be recovered */ + check(driver_remove_destruct(&tca9534_driver) == ERROR_NONE); + return ERROR_NONE; +} + +Module tca9534_module = { + .name = "tca9534", + .start = start, + .stop = stop, + .symbols = nullptr, + .internal = nullptr +}; + +} diff --git a/Drivers/tca9534-module/source/tca9534.cpp b/Drivers/tca9534-module/source/tca9534.cpp new file mode 100644 index 00000000..3fc5eb97 --- /dev/null +++ b/Drivers/tca9534-module/source/tca9534.cpp @@ -0,0 +1,169 @@ +// SPDX-License-Identifier: Apache-2.0 +#include +#include +#include +#include +#include +#include +#include +#include + +#define TAG "TCA9534" + +#define GET_CONFIG(device) (static_cast((device)->config)) + +constexpr auto TCA9534_REGISTER_INPUT = 0x00; +constexpr auto TCA9534_REGISTER_OUTPUT = 0x01; +constexpr auto TCA9534_REGISTER_POLARITY = 0x02; +constexpr auto TCA9534_REGISTER_CONFIG = 0x03; + +static error_t start(Device* device) { + auto* parent = device_get_parent(device); + if (device_get_type(parent) != &I2C_CONTROLLER_TYPE) { + LOG_E(TAG, "Parent device is not I2C"); + return ERROR_RESOURCE; + } + + return gpio_controller_init_descriptors(device, 8, nullptr); +} + +static error_t stop(Device* device) { + check(gpio_controller_deinit_descriptors(device) == ERROR_NONE); + return ERROR_NONE; +} + +extern "C" { + +static error_t set_level(GpioDescriptor* descriptor, bool high) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + + return high + ? i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_OUTPUT, bit, portMAX_DELAY) + : i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_OUTPUT, bit, portMAX_DELAY); +} + +static error_t get_level(GpioDescriptor* descriptor, bool* high) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bits; + + error_t err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_INPUT, &bits, portMAX_DELAY); + if (err != ERROR_NONE) { + return err; + } + + *high = (bits & (1 << descriptor->pin)) != 0; + return ERROR_NONE; +} + +static error_t set_flags(GpioDescriptor* descriptor, gpio_flags_t flags) { + // The TCA9534 only supports direction and polarity inversion. Pull-up/down and + // high-impedance are not present in its register map. + if (flags & (GPIO_FLAG_PULL_UP | GPIO_FLAG_PULL_DOWN | GPIO_FLAG_HIGH_IMPEDANCE)) { + return ERROR_NOT_SUPPORTED; + } + + // The polarity register only inverts what's read back from an input pin; + // set_level() still drives outputs at the raw level. Accepting ACTIVE_LOW + // on an output would silently not do what it implies. + if ((flags & GPIO_FLAG_ACTIVE_LOW) && (flags & GPIO_FLAG_DIRECTION_OUTPUT)) { + return ERROR_NOT_SUPPORTED; + } + + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + error_t err; + + // Direction: configuration bit is 1 for input, 0 for output. + if (flags & GPIO_FLAG_DIRECTION_OUTPUT) { + err = i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_CONFIG, bit, portMAX_DELAY); + } else { + err = i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_CONFIG, bit, portMAX_DELAY); + } + + if (err != ERROR_NONE) { + return err; + } + + // Polarity inversion (mainly relevant for active-low inputs). + if (flags & GPIO_FLAG_ACTIVE_LOW) { + err = i2c_controller_register8_set_bits(parent, address, TCA9534_REGISTER_POLARITY, bit, portMAX_DELAY); + } else { + err = i2c_controller_register8_reset_bits(parent, address, TCA9534_REGISTER_POLARITY, bit, portMAX_DELAY); + } + + return err; +} + +static error_t get_flags(GpioDescriptor* descriptor, gpio_flags_t* flags) { + auto* device = descriptor->controller; + auto* parent = device_get_parent(device); + auto address = GET_CONFIG(device)->address; + uint8_t bit = 1 << descriptor->pin; + uint8_t val; + error_t err; + + gpio_flags_t f = GPIO_FLAG_NONE; + + err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_CONFIG, &val, portMAX_DELAY); + if (err != ERROR_NONE) return err; + f |= (val & bit) ? GPIO_FLAG_DIRECTION_INPUT : GPIO_FLAG_DIRECTION_OUTPUT; + + err = i2c_controller_register8_get(parent, address, TCA9534_REGISTER_POLARITY, &val, portMAX_DELAY); + if (err != ERROR_NONE) return err; + f |= (val & bit) ? GPIO_FLAG_ACTIVE_LOW : GPIO_FLAG_ACTIVE_HIGH; + + *flags = f; + return ERROR_NONE; +} + +static error_t get_native_pin_number(GpioDescriptor* descriptor, void* pin_number) { + return ERROR_NOT_SUPPORTED; +} + +static error_t add_callback(GpioDescriptor* descriptor, void (*callback)(void*), void* arg) { + return ERROR_NOT_SUPPORTED; +} + +static error_t remove_callback(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +static error_t enable_interrupt(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +static error_t disable_interrupt(GpioDescriptor* descriptor) { + return ERROR_NOT_SUPPORTED; +} + +const static GpioControllerApi tca9534_gpio_api = { + .set_level = set_level, + .get_level = get_level, + .set_flags = set_flags, + .get_flags = get_flags, + .get_native_pin_number = get_native_pin_number, + .add_callback = add_callback, + .remove_callback = remove_callback, + .enable_interrupt = enable_interrupt, + .disable_interrupt = disable_interrupt +}; + +Driver tca9534_driver = { + .name = "tca9534", + .compatible = (const char*[]) { "ti,tca9534", nullptr }, + .start_device = start, + .stop_device = stop, + .api = static_cast(&tca9534_gpio_api), + .device_type = &GPIO_CONTROLLER_TYPE, + .owner = &tca9534_module, + .internal = nullptr +}; + +} diff --git a/Platforms/platform-esp32/bindings/espressif,esp32-spi.yaml b/Platforms/platform-esp32/bindings/espressif,esp32-spi.yaml index 95e16a87..10abdd7b 100644 --- a/Platforms/platform-esp32/bindings/espressif,esp32-spi.yaml +++ b/Platforms/platform-esp32/bindings/espressif,esp32-spi.yaml @@ -41,3 +41,11 @@ properties: element-type: "struct GpioPinSpec" default: "{ }" description: Null-terminated array of chip select GPIO pin specs for peripherals on this bus + miso-pull-up: + type: boolean + default: false + description: > + Enables a weak internal pull-up on MISO, which floats between transactions/while another + device on the bus is selected. Helps some SPI peripherals (a garbled/invalid response on + CMD8/if_cond has been observed for SD-over-SPI on some boards) but has been observed to + break others (prevents the SD card from responding to CMD0 at all) - opt in per board. diff --git a/Platforms/platform-esp32/include/tactility/drivers/esp32_spi.h b/Platforms/platform-esp32/include/tactility/drivers/esp32_spi.h index c49051fa..3645deff 100644 --- a/Platforms/platform-esp32/include/tactility/drivers/esp32_spi.h +++ b/Platforms/platform-esp32/include/tactility/drivers/esp32_spi.h @@ -27,6 +27,14 @@ struct Esp32SpiConfig { struct GpioPinSpec* cs_gpios; /** The item count of cs_gpios */ uint8_t cs_gpios_count; + /** + * Enables a weak internal pull-up on MISO, which floats between transactions/while + * another device on the bus is selected. Helps some SPI peripherals (a garbled/invalid + * response on CMD8/if_cond has been observed for SD-over-SPI on some boards) but has been + * observed to break others (e.g. prevents the SD card from responding to CMD0 at all on + * some boards) - opt in per board rather than defaulting it on for everyone. + */ + bool miso_pull_up; }; /** diff --git a/Platforms/platform-esp32/source/drivers/esp32_spi.cpp b/Platforms/platform-esp32/source/drivers/esp32_spi.cpp index 711540b3..721d7892 100644 --- a/Platforms/platform-esp32/source/drivers/esp32_spi.cpp +++ b/Platforms/platform-esp32/source/drivers/esp32_spi.cpp @@ -129,8 +129,9 @@ static error_t start(Device* device) { // MISO is only actively driven by the selected slave; between commands (and briefly during // slave selection/response) it floats, which can be read as spurious bits. A weak pull-up // costs nothing against an actively-driven line and avoids that, e.g. on SD-over-SPI this - // shows up as CMD8/if_cond failing with a garbled/invalid response. - if (data->miso_descriptor != nullptr) { + // shows up as CMD8/if_cond failing with a garbled/invalid response. Opt-in per board though: + // it's been observed to instead prevent an SD card from responding to CMD0 at all elsewhere. + if (data->miso_descriptor != nullptr && dts_config->miso_pull_up) { gpio_descriptor_set_flags(data->miso_descriptor, GPIO_FLAG_DIRECTION_INPUT | GPIO_FLAG_PULL_UP); }