lvgl · controlol · Feb 12, 2021 · Feb 15, 2021 · Mar 2, 2021 · Mar 2, 2021
diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,13 @@ modules.order
 Module.symvers
 Mkfile.old
 dkms.conf
+
+# MacOS
+.DS_Store
+
+# ESP-IDF build dir
+build
+
+# Kconfig files
+sdkconfig
+sdkconfig.old
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,8 +3,7 @@ if(ESP_PLATFORM)
 file(GLOB SOURCES *.c)
 set(LVGL_INCLUDE_DIRS . lvgl_tft)
 list(APPEND SOURCES "lvgl_tft/disp_driver.c")
-
-#@todo add SimleInclude macro here
+list(APPEND SOURCES "lvgl_tft/esp_lcd_backlight.c")
 
 # Include only the source file of the selected
 # display controller.
@@ -41,6 +40,10 @@ elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_RA8875)
     list(APPEND SOURCES "lvgl_tft/ra8875.c")
 elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_GC9A01)
     list(APPEND SOURCES "lvgl_tft/GC9A01.c")
+elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C)
+    list(APPEND SOURCES "lvgl_tft/ili9163c.c")
+elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_PCD8544)
+    list(APPEND SOURCES "lvgl_tft/pcd8544.c")
 else()
     message(WARNING "LVGL ESP32 drivers: Display controller not defined.")
 endif()
@@ -68,19 +71,23 @@ if(CONFIG_LV_TOUCH_CONTROLLER)
         list(APPEND SOURCES "lvgl_touch/FT81x.c")
     elseif(CONFIG_LV_TOUCH_CONTROLLER_RA8875)
         list(APPEND SOURCES "lvgl_touch/ra8875_touch.c")
+    elseif(CONFIG_LV_TOUCH_CONTROLLER_GT911)
+        list(APPEND SOURCES "lvgl_touch/gt911.c")
     endif()
 
     if(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)
         list(APPEND SOURCES "lvgl_touch/tp_spi.c")
-    elseif(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_I2C)
-        list(APPEND SOURCES "lvgl_touch/tp_i2c.c")
     endif()
 endif()
 
+if(CONFIG_LV_I2C)
+    list(APPEND SOURCES "lvgl_i2c/i2c_manager.c")
+endif()
+
 idf_component_register(SRCS ${SOURCES}
                        INCLUDE_DIRS ${LVGL_INCLUDE_DIRS}
-                       REQUIRES lvgl)
-                       
+                       REQUIRES lvgl driver)
+
 target_compile_definitions(${COMPONENT_LIB} PUBLIC "-DLV_LVGL_H_INCLUDE_SIMPLE")
 
 else()

diff --git a/Kconfig b/Kconfig
@@ -1,2 +1,14 @@
-rsource "lvgl_tft/Kconfig"
-rsource "lvgl_touch/Kconfig"
+menu "LVGL ESP Drivers"
+
+    rsource "lvgl_tft/Kconfig"
+
+    rsource "lvgl_touch/Kconfig"
+
+endmenu
+
+menu "I2C Port Settings"
+    depends on LV_I2C && !HAVE_I2C_MANAGER
+
+    rsource "lvgl_i2c/Kconfig"
+
+endmenu
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ For a ready to use ESP32 project take look at the [lv_port_esp32](https://github
 - [Supported display controllers](#supported-display-controllers)
 - [Supported indev controllers](#supported-indev-controllers)
 - [Support for predefined development kits](#support-for-predefined-development-kits)
+- [Thread-safe I2C with I2C Manager](#thread-safe-i2c-with-i2c-manager)
+- [Backlight control](#backlight-control)
 
 **NOTE:** You need to set the display horizontal and vertical size, color depth and
 swap of RGB565 color on the LVGL configuration menuconfig (it's not handled automatically).
@@ -17,6 +19,7 @@ swap of RGB565 color on the LVGL configuration menuconfig (it's not handled auto
 | Display Controller                          | Type       | Interface              | Color depth (LV_COLOR_DEPTH) | Swap RGB565 color (LV_COLOR_16_SWAP)   |
 |---------------------------------------------|------------|------------------------|------------------------------|----------------------------------------|
 | ILI9341                                     | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
+| ILI9163C                                    | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
 | ILI9486                                     | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
 | ILI9488                                     | TFT        | SPI                    | 16: RGB565                   | No                                     |
 | HX8357B/HX8357D                             | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
@@ -27,15 +30,16 @@ swap of RGB565 color on the LVGL configuration menuconfig (it's not handled auto
 | RA8875                                      | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
 | SH1107                                      | Monochrome | SPI                    | 1: 1byte per pixel           | No                                     |
 | SSD1306                                     | Monochrome | I2C                    | 1: 1byte per pixel           | No                                     |
+| PCD8544                                     | Monochrome | SPI                    | 1: 1byte per pixel           | No                                     |
 | IL3820                                      | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
 | UC8151D/ GoodDisplay GDEW0154M10 DES        | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
 | FitiPower JD79653A/ GoodDisplay GDEW0154M09 | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
 
 ## Supported indev controllers
 
 - XPT2046
-- FT3236
-- other FT6X36 or the FT6206 controllers should work as well (not tested)
+- FT3236, FT6X36
+- FT6206 controllers should work as well (not tested)
 - STMPE610
 - FT81x (Single, Dual, and Quad SPI)
 
@@ -51,6 +55,7 @@ and sets the gpio numbers for the interface.
 |---------------------------|-----------------------|-----------|-----------|-----------|
 | ESP Wrover Kit v4.1       | ILI9341               | SPI       | 240       | 320       |
 | M5Stack                   | ILI9341               | SPI       | 240       | 320       |
+| M5Stack Core2             | ILI9341               | SPI       | 240       | 320       |
 | M5Stick                   | SH1107                | SPI       | -         | -         |
 | M5StickC                  | ST7735S               | SPI       | 80        | 160       |
 | Adafruit 3.5 Featherwing  | HX8357                | SPI       | 480       | 320       |
@@ -63,3 +68,27 @@ and sets the gpio numbers for the interface.
 
 **NOTE:** See [Supported display controllers](#supported-display-controllers) for more information on display configuration.
 **NOTE:** See [Supported indev controllers](#supported-indev-controllers) for more information about indev configuration.
+
+
+## Thread-safe I2C with I2C Manager
+
+LVGL can use I2C to read from a touch sensor or write to a display, possibly
+many times a second. Meanwhile, other tasks may also want to read from i2c
+devices on the same bus. I2C using the ESP-IDF is not thread-safe.
+
+I2C Manager (`i2c_manager`) is a component that will let code in multiple threads
+talk to devices on the I2C ports without getting in each other's way. These drivers
+use a built-in copy of I2C Manager to talk to the I2C port, but you can also use 
+the I2C Manager component itself and have others play nice with LVGL and vice-versa.
+[Click here](i2c_manager/README.md) for details.
+
+
+## Backlight control
+
+Control of LCD's backlight is provided by separate module that is independent from the display driver.
+Configuration of the backlight controller can be found in menuconfig `LVGL ESP Drivers -> LVGL TFT Display controller`.
+
+There are three modes of operation:
+1. Off - No backlight control
+2. Switch - Allows ON/OFF control
+3. PWM - Allows brightness control (by Pulse-Width-Modulated signal)
diff --git a/component.mk b/component.mk
@@ -1,7 +1,7 @@
 # LVGL ESP32 drivers
 
 # Define sources and include dirs
-COMPONENT_SRCDIRS := . lvgl_tft lvgl_touch
+COMPONENT_SRCDIRS := . lvgl_tft lvgl_touch lvgl_i2c
 COMPONENT_ADD_INCLUDEDIRS := .
 
 # LVGL is supposed to be used as a ESP-IDF component
@@ -44,4 +44,6 @@ $(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CON
 $(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_RA8875)), lvgl_touch/ra8875_touch.o)
 
 $(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)), lvgl_touch/tp_spi.o)
-$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_I2C)), lvgl_touch/tp_i2c.o)
+
+# I2C Manager
+$(call compile_only_if,$(CONFIG_LV_I2C), lvgl_i2c/i2c_manager.o)
diff --git a/lvgl_helpers.c b/lvgl_helpers.c
@@ -14,14 +14,13 @@
 #include "lvgl_touch/tp_spi.h"
 
 #include "lvgl_spi_conf.h"
-#include "lvgl_i2c_conf.h"
 
-#include "driver/i2c.h"
+#include "lvgl_i2c/i2c_manager.h"
 
 #ifdef LV_LVGL_H_INCLUDE_SIMPLE
-#include "src/lv_core/lv_refr.h"
+#include "lvgl.h"
 #else
-#include "lvgl/src/lv_core/lv_refr.h"
+#include "lvgl/lvgl.h"
 #endif
 
 /*********************
@@ -53,7 +52,12 @@
 /* Interface and driver initialization */
 void lvgl_driver_init(void)
 {
+    /* Since LVGL v8 LV_HOR_RES_MAX and LV_VER_RES_MAX are not defined, so
+     * print it only if they are defined. */
+#if (LVGL_VERSION_MAJOR < 8)
     ESP_LOGI(TAG, "Display hor size: %d, ver size: %d", LV_HOR_RES_MAX, LV_VER_RES_MAX);
+#endif
+
     ESP_LOGI(TAG, "Display buffer size: %d", DISP_BUF_SIZE);
 
 #if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
@@ -63,7 +67,7 @@ void lvgl_driver_init(void)
         DISP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
         SPI_BUS_MAX_TRANSFER_SZ, 1,
         DISP_SPI_IO2, DISP_SPI_IO3);
-    
+
     disp_spi_add_device(TFT_SPI_HOST);
     disp_driver_init();
 
@@ -81,48 +85,29 @@ void lvgl_driver_init(void)
         TP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
         SPI_BUS_MAX_TRANSFER_SZ, 1,
         -1, -1);
-    
+
     disp_spi_add_device(TFT_SPI_HOST);
     tp_spi_add_device(TOUCH_SPI_HOST);
-
-    disp_driver_init();
-    touch_driver_init();
-
-    return;
-#endif
 
-#if defined (SHARED_I2C_BUS)
-    ESP_LOGI(TAG, "Initializing shared I2C master");
-
-    lvgl_i2c_driver_init(DISP_I2C_PORT,
-        DISP_I2C_SDA, DISP_I2C_SCL,
-        DISP_I2C_SPEED_HZ);
-
     disp_driver_init();
     touch_driver_init();
-    
+
     return;
 #endif
 
 /* Display controller initialization */
 #if defined CONFIG_LV_TFT_DISPLAY_PROTOCOL_SPI
     ESP_LOGI(TAG, "Initializing SPI master for display");
-    
+
     lvgl_spi_driver_init(TFT_SPI_HOST,
         DISP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
-        SPI_BUS_MAX_TRANSFER_SZ, 1,
+        SPI_BUS_MAX_TRANSFER_SZ, SPI_DMA_CH_AUTO,
         DISP_SPI_IO2, DISP_SPI_IO3);
-    
+
     disp_spi_add_device(TFT_SPI_HOST);
-    
+
     disp_driver_init();
-#elif defined (CONFIG_LV_TFT_DISPLAY_PROTOCOL_I2C)
-    ESP_LOGI(TAG, "Initializing I2C master for display");
-    /* Init the i2c master on the display driver code */
-    lvgl_i2c_driver_init(DISP_I2C_PORT,
-        DISP_I2C_SDA, DISP_I2C_SCL,
-        DISP_I2C_SPEED_HZ);
-
+#elif defined (CONFIG_LV_I2C_DISPLAY)
     disp_driver_init();
 #else
 #error "No protocol defined for display controller"
@@ -132,22 +117,16 @@ void lvgl_driver_init(void)
 #if CONFIG_LV_TOUCH_CONTROLLER != TOUCH_CONTROLLER_NONE
     #if defined (CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)
         ESP_LOGI(TAG, "Initializing SPI master for touch");
-        
+
         lvgl_spi_driver_init(TOUCH_SPI_HOST,
             TP_SPI_MISO, TP_SPI_MOSI, TP_SPI_CLK,
             0 /* Defaults to 4094 */, 2,
             -1, -1);
-        
+
         tp_spi_add_device(TOUCH_SPI_HOST);
-        
+
         touch_driver_init();
-    #elif defined (CONFIG_LV_TOUCH_DRIVER_PROTOCOL_I2C)
-        ESP_LOGI(TAG, "Initializing I2C master for touch");
-
-        lvgl_i2c_driver_init(TOUCH_I2C_PORT,
-            TOUCH_I2C_SDA, TOUCH_I2C_SCL,
-            TOUCH_I2C_SPEED_HZ);
-
+    #elif defined (CONFIG_LV_I2C_TOUCH)
         touch_driver_init();
     #elif defined (CONFIG_LV_TOUCH_DRIVER_ADC)
         touch_driver_init();
@@ -160,81 +139,47 @@ void lvgl_driver_init(void)
 #endif
 }
 
-/* Config the i2c master
+
+/* Initialize spi bus master
  *
- * This should init the i2c master to be used on display and touch controllers.
- * So we should be able to know if the display and touch controllers shares the
- * same i2c master.
+ * NOTE: dma_chan type and value changed to int instead of spi_dma_chan_t
+ * for backwards compatibility with ESP-IDF versions prior v4.3.
+ *
+ * We could use the ESP_IDF_VERSION_VAL macro available in the "esp_idf_version.h"
+ * header available since ESP-IDF v4.
  */
-bool lvgl_i2c_driver_init(int port, int sda_pin, int scl_pin, int speed_hz)
-{
-    esp_err_t err;
-
-    ESP_LOGI(TAG, "Initializing I2C master port %d...", port);
-    ESP_LOGI(TAG, "SDA pin: %d, SCL pin: %d, Speed: %d (Hz)",
-        sda_pin, scl_pin, speed_hz);
-
-    i2c_config_t conf = {
-        .mode               = I2C_MODE_MASTER,
-        .sda_io_num         = sda_pin,
-        .sda_pullup_en      = GPIO_PULLUP_ENABLE,
-        .scl_io_num         = scl_pin,
-        .scl_pullup_en      = GPIO_PULLUP_ENABLE,
-        .master.clk_speed   = speed_hz,
-    };
-
-    ESP_LOGI(TAG, "Setting I2C master configuration...");
-    err = i2c_param_config(port, &conf);
-    assert(ESP_OK == err);
-
-    ESP_LOGI(TAG, "Installing I2C master driver...");
-    err = i2c_driver_install(port,
-        I2C_MODE_MASTER,
-        0, 0 /*I2C_MASTER_RX_BUF_DISABLE, I2C_MASTER_TX_BUF_DISABLE */,
-        0 /* intr_alloc_flags */);
-    assert(ESP_OK == err);
-
-    return ESP_OK != err;
-}
-
-/* Initialize spi bus master */
 bool lvgl_spi_driver_init(int host,
     int miso_pin, int mosi_pin, int sclk_pin,
     int max_transfer_sz,
     int dma_channel,
     int quadwp_pin, int quadhd_pin)
 {
-#if defined (CONFIG_IDF_TARGET_ESP32)
-    assert((SPI_HOST <= host) && (VSPI_HOST >= host));
-    const char *spi_names[] = {
-        "SPI_HOST", "HSPI_HOST", "VSPI_HOST"
-    };
-#elif defined (CONFIG_IDF_TARGET_ESP32S2)
-    assert((SPI_HOST <= host) && (HSPI_HOST >= host));
+    assert((0 <= host) && (SPI_HOST_MAX > host));
     const char *spi_names[] = {
-        "SPI_HOST", "", ""
+        "SPI1_HOST", "SPI2_HOST", "SPI3_HOST"
     };
-#endif
 
-    ESP_LOGI(TAG, "Configuring SPI host %s (%d)", spi_names[host], host);
+    ESP_LOGI(TAG, "Configuring SPI host %s", spi_names[host]);
     ESP_LOGI(TAG, "MISO pin: %d, MOSI pin: %d, SCLK pin: %d, IO2/WP pin: %d, IO3/HD pin: %d",
         miso_pin, mosi_pin, sclk_pin, quadwp_pin, quadhd_pin);
 
     ESP_LOGI(TAG, "Max transfer size: %d (bytes)", max_transfer_sz);
 
     spi_bus_config_t buscfg = {
         .miso_io_num = miso_pin,
-	.mosi_io_num = mosi_pin,
-	.sclk_io_num = sclk_pin,
-	.quadwp_io_num = quadwp_pin,
-	.quadhd_io_num = quadhd_pin,
+        .mosi_io_num = mosi_pin,
+        .sclk_io_num = sclk_pin,
+        .quadwp_io_num = quadwp_pin,
+        .quadhd_io_num = quadhd_pin,
         .max_transfer_sz = max_transfer_sz
     };
 
     ESP_LOGI(TAG, "Initializing SPI bus...");
-    esp_err_t ret = spi_bus_initialize(host, &buscfg, dma_channel);
+    #if defined (CONFIG_IDF_TARGET_ESP32C3)
+    dma_channel = SPI_DMA_CH_AUTO;
+    #endif
+    esp_err_t ret = spi_bus_initialize(host, &buscfg, (spi_dma_chan_t)dma_channel);
     assert(ret == ESP_OK);
 
     return ESP_OK != ret;
 }
-