Merge branch 'refactor/rgb_lcd_gpio_assign' into 'master'

feat(lcd): add Kconfig to assign default GPIO for RGB LCD example

See merge request espressif/esp-idf!33734

Author: suda-morris

examples/peripherals/camera/camera_dsi/components/dsi_init/include/example_dsi_init_config.h

@@ -13,7 +13,7 @@ extern "C" {
 #endif
 
 #if CONFIG_EXAMPLE_LCD_PATTERN_ILI9881C
-// FPS = 80000000/(40+140+40+800)/(4+16+16+1280) = 60Hz
+// Refresh Rate = 80000000/(40+140+40+800)/(4+16+16+1280) = 60Hz
 #define EXAMPLE_MIPI_DSI_DPI_CLK_MHZ              80
 #define EXAMPLE_MIPI_DSI_IMAGE_HSYNC              40
 #define EXAMPLE_MIPI_DSI_IMAGE_HBP                140
@@ -22,7 +22,7 @@ extern "C" {
 #define EXAMPLE_MIPI_DSI_IMAGE_VBP                16
 #define EXAMPLE_MIPI_DSI_IMAGE_VFP                16
 #elif CONFIG_EXAMPLE_LCD_PATTERN_EK79007
-// FPS = 48000000/(10+120+120+1024)/(1+20+10+600) = 60Hz
+// Refresh Rate = 48000000/(10+120+120+1024)/(1+20+10+600) = 60Hz
 #define EXAMPLE_MIPI_DSI_DPI_CLK_MHZ              48
 #define EXAMPLE_MIPI_DSI_IMAGE_HSYNC              10
 #define EXAMPLE_MIPI_DSI_IMAGE_HBP                120

examples/peripherals/lcd/mipi_dsi/README.md

@@ -51,8 +51,8 @@ Run `idf.py menuconfig` and go to `Example Configuration`:
 
 * Choose the LCD model in `Select MIPI LCD model` according to your board.
 * Choose whether to `Use DMA2D to copy draw buffer to frame buffer` asynchronously. If you choose `No`, the draw buffer will be copied to the frame buffer synchronously by CPU.
-* Choose if you want to `Monitor FPS by GPIO`. If you choose `Yes`, then you can attach an oscilloscope or logic analyzer to the GPIO pin to monitor the FPS of the display.
-  Please note, the actual FPS should be **double** the square wave frequency.
+* Choose if you want to `Monitor Refresh Rate by GPIO`. If you choose `Yes`, then you can attach an oscilloscope or logic analyzer to the GPIO pin to monitor the Refresh Rate of the display.
+  Please note, the actual Refresh Rate should be **double** the square wave frequency.
 
 ### Build and Flash
 

examples/peripherals/lcd/mipi_dsi/main/Kconfig.projbuild

@@ -6,12 +6,12 @@ menu "Example Configuration"
             Enable this option, DMA2D will be used to copy the LVGL draw buffer to the target frame buffer.
             This can save some CPU time and improve the performance.
 
-    config EXAMPLE_MONITOR_FPS_BY_GPIO
-        bool "Monitor FPS by GPIO"
+    config EXAMPLE_MONITOR_REFRESH_BY_GPIO
+        bool "Monitor Refresh Rate by GPIO"
         default y
         help
-            Enable this option, you can visualize the FPS by attaching a logic analyzer to a specific GPIO.
-            The GPIO will output a square wave with the frequency of FPS/2.
+            Enable this option, you can visualize the refresh rate by attaching a logic analyzer to a specific GPIO.
+            The GPIO will output a square wave with the frequency equals to half of the refresh rate.
 
     choice
         prompt "Select MIPI LCD model"

examples/peripherals/lcd/mipi_dsi/main/idf_component.yml

@@ -1,4 +1,4 @@
 dependencies:
-  lvgl/lvgl: "^9.0.0"
+  lvgl/lvgl: "~9.2.0"
   esp_lcd_ili9881c: "^1.0.0"
   esp_lcd_ek79007: "^1.0.0"

examples/peripherals/lcd/mipi_dsi/main/mipi_dsi_lcd_example_main.c

@@ -29,7 +29,7 @@ static const char *TAG = "example";
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 #if CONFIG_EXAMPLE_LCD_USE_ILI9881C
-// FPS = 80000000/(40+140+40+800)/(4+16+16+1280) = 60Hz
+// Refresh Rate = 80000000/(40+140+40+800)/(4+16+16+1280) = 60Hz
 #define EXAMPLE_MIPI_DSI_DPI_CLK_MHZ  80
 #define EXAMPLE_MIPI_DSI_LCD_H_RES    800
 #define EXAMPLE_MIPI_DSI_LCD_V_RES    1280
@@ -40,7 +40,7 @@ static const char *TAG = "example";
 #define EXAMPLE_MIPI_DSI_LCD_VBP      16
 #define EXAMPLE_MIPI_DSI_LCD_VFP      16
 #elif CONFIG_EXAMPLE_LCD_USE_EK79007
-// FPS = 48000000/(10+120+120+1024)/(1+20+10+600) = 60Hz
+// Refresh Rate = 48000000/(10+120+120+1024)/(1+20+10+600) = 60Hz
 #define EXAMPLE_MIPI_DSI_DPI_CLK_MHZ  48
 #define EXAMPLE_MIPI_DSI_LCD_H_RES    1024
 #define EXAMPLE_MIPI_DSI_LCD_V_RES    600
@@ -67,8 +67,8 @@ static const char *TAG = "example";
 #define EXAMPLE_PIN_NUM_BK_LIGHT                -1
 #define EXAMPLE_PIN_NUM_LCD_RST                 -1
 
-#if CONFIG_EXAMPLE_MONITOR_FPS_BY_GPIO
-#define EXAMPLE_PIN_NUM_FPS_MONITOR             20  // Monitor the FPS by toggling the GPIO
+#if CONFIG_EXAMPLE_MONITOR_REFRESH_BY_GPIO
+#define EXAMPLE_PIN_NUM_REFRESH_MONITOR         20  // Monitor the Refresh Rate by toggling the GPIO
 #endif
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -110,6 +110,11 @@ static void example_lvgl_port_task(void *arg)
         _lock_acquire(&lvgl_api_lock);
         time_till_next_ms = lv_timer_handler();
         _lock_release(&lvgl_api_lock);
+
+        // in case of task watch dog timeout, set the minimal delay to 10ms
+        if (time_till_next_ms < 10) {
+            time_till_next_ms = 10;
+        }
         usleep(1000 * time_till_next_ms);
     }
 }
@@ -121,12 +126,12 @@ static bool example_notify_lvgl_flush_ready(esp_lcd_panel_handle_t panel, esp_lc
     return false;
 }
 
-#if CONFIG_EXAMPLE_MONITOR_FPS_BY_GPIO
-static bool example_monitor_fps(esp_lcd_panel_handle_t panel, esp_lcd_dpi_panel_event_data_t *edata, void *user_ctx)
+#if CONFIG_EXAMPLE_MONITOR_REFRESH_BY_GPIO
+static bool example_monitor_refresh_rate(esp_lcd_panel_handle_t panel, esp_lcd_dpi_panel_event_data_t *edata, void *user_ctx)
 {
     static int io_level = 0;
-    // please note, the real FPS should be 2*frequency of this GPIO toggling
-    gpio_set_level(EXAMPLE_PIN_NUM_FPS_MONITOR, io_level);
+    // please note, the real refresh rate should be 2*frequency of this GPIO toggling
+    gpio_set_level(EXAMPLE_PIN_NUM_REFRESH_MONITOR, io_level);
     io_level = !io_level;
     return false;
 }
@@ -164,21 +169,21 @@ static void example_bsp_set_lcd_backlight(uint32_t level)
 #endif
 }
 
-#if CONFIG_EXAMPLE_MONITOR_FPS_BY_GPIO
-static void example_bsp_init_fps_monitor_io(void)
+#if CONFIG_EXAMPLE_MONITOR_REFRESH_BY_GPIO
+static void example_bsp_init_refresh_monitor_io(void)
 {
     gpio_config_t monitor_io_conf = {
         .mode = GPIO_MODE_OUTPUT,
-        .pin_bit_mask = 1ULL << EXAMPLE_PIN_NUM_FPS_MONITOR,
+        .pin_bit_mask = 1ULL << EXAMPLE_PIN_NUM_REFRESH_MONITOR,
     };
     ESP_ERROR_CHECK(gpio_config(&monitor_io_conf));
 }
 #endif
 
 void app_main(void)
 {
-#if CONFIG_EXAMPLE_MONITOR_FPS_BY_GPIO
-    example_bsp_init_fps_monitor_io();
+#if CONFIG_EXAMPLE_MONITOR_REFRESH_BY_GPIO
+    example_bsp_init_refresh_monitor_io();
 #endif
 
     example_bsp_enable_dsi_phy_power();
@@ -291,8 +296,8 @@ void app_main(void)
     ESP_LOGI(TAG, "Register DPI panel event callback for LVGL flush ready notification");
     esp_lcd_dpi_panel_event_callbacks_t cbs = {
         .on_color_trans_done = example_notify_lvgl_flush_ready,
-#if CONFIG_EXAMPLE_MONITOR_FPS_BY_GPIO
-        .on_refresh_done = example_monitor_fps,
+#if CONFIG_EXAMPLE_MONITOR_REFRESH_BY_GPIO
+        .on_refresh_done = example_monitor_refresh_rate,
 #endif
     };
     ESP_ERROR_CHECK(esp_lcd_dpi_panel_register_event_callbacks(mipi_dpi_panel, &cbs, display));

examples/peripherals/lcd/rgb_panel/README.md

@@ -27,7 +27,7 @@ This example uses 3 kinds of **buffering mode**:
 
 The connection between ESP Board and the LCD is as follows:
 
-```
+```text
        ESP Board                           RGB  Panel
 +-----------------------+              +-------------------+
 |                   GND +--------------+GND                |
@@ -51,19 +51,15 @@ The connection between ESP Board and the LCD is as follows:
                                        +-------------------+
 ```
 
-The GPIO number used by this example can be changed in [lvgl_example_main.c](main/rgb_lcd_example_main.c).
-
-Especially, please pay attention to the level used to turn on the LCD backlight, some LCD module needs a low level to turn it on, while others take a high level. You can change the backlight level macro `EXAMPLE_LCD_BK_LIGHT_ON_LEVEL` in [lvgl_example_main.c](main/rgb_lcd_example_main.c).
-
-If the RGB LCD panel only supports DE mode, you can even bypass the `HSYNC` and `VSYNC` signals, by assigning `EXAMPLE_PIN_NUM_HSYNC` and `EXAMPLE_PIN_NUM_VSYNC` with `-1`.
-
 ### Configure
 
 Run `idf.py menuconfig` and go to `Example Configuration`:
 
 1. Choose whether to `Use double Frame Buffer`
 2. Choose whether to `Avoid tearing effect` (available only when step `1` was chosen to false)
 3. Choose whether to `Use bounce buffer` (available only when step `1` was chosen to false)
+4. Choose the number of LCD data lines in `RGB LCD Data Lines`
+5. Set the GPIOs used by RGB LCD peripheral in `GPIO assignment`, e.g. the synchronization signals (HSYNC, VSYNC, DE) and the data lines
 
 ### Build and Flash
 
@@ -79,29 +75,28 @@ See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/l
 
 ```bash
 ...
-I (0) cpu_start: Starting scheduler on APP CPU.
-I (856) esp_psram: Reserving pool of 32K of internal memory for DMA/internal allocations
-I (856) example: Create semaphores
-I (866) example: Turn off LCD backlight
-I (866) gpio: GPIO[4]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0
-I (876) example: Install RGB LCD panel driver
-I (906) example: Register event callbacks
-I (906) example: Initialize RGB LCD panel
-I (906) example: Turn on LCD backlight
-I (906) example: Initialize LVGL library
-I (916) example: Allocate separate LVGL draw buffers from PSRAM
-I (916) example: Register display driver to LVGL
-I (926) example: Install LVGL tick timer
-I (926) example: Create LVGL task
-I (926) example: Starting LVGL task
-I (926) example: Display LVGL Scatter Chart
+I (872) main_task: Started on CPU0
+I (882) esp_psram: Reserving pool of 32K of internal memory for DMA/internal allocations
+I (882) main_task: Calling app_main()
+I (892) example: Turn off LCD backlight
+I (892) example: Install RGB LCD panel driver
+I (922) example: Initialize RGB LCD panel
+I (922) example: Turn on LCD backlight
+I (922) example: Initialize LVGL library
+I (932) example: Allocate LVGL draw buffers
+I (932) example: Register event callbacks
+I (932) example: Install LVGL tick timer
+I (942) example: Create LVGL task
+I (942) example: Starting LVGL task
+I (992) example: Display LVGL UI
+I (1102) main_task: Returned from app_main()
 ...
 ```
 
 ## Troubleshooting
 
 * Why the LCD doesn't light up?
-  * Check the backlight's turn-on level, and update it in `EXAMPLE_LCD_BK_LIGHT_ON_LEVEL`
+  * Please pay attention to the level used to turn on the LCD backlight, some LCD module needs a low level to turn it on, while others take a high level. You can change the backlight level macro `EXAMPLE_LCD_BK_LIGHT_ON_LEVEL` in [lvgl_example_main.c](main/rgb_lcd_example_main.c).
 * No memory for frame buffer
   * The frame buffer of RGB panel is located in ESP side (unlike other controller based LCDs, where the frame buffer is located in external chip). As the frame buffer usually consumes much RAM (depends on the LCD resolution and color depth), we recommend to put the frame buffer into PSRAM (like what we do in this example). However, putting frame buffer in PSRAM will limit the maximum PCLK due to the bandwidth of **SPI0**.
 * LCD screen drift

examples/peripherals/lcd/rgb_panel/main/Kconfig.projbuild

@@ -18,4 +18,101 @@ menu "Example Configuration"
         help
             Enable this option, the example will use a pair of semaphores to avoid the tearing effect.
             Note, if the Double Frame Buffer is used, then we can also avoid the tearing effect without the lock.
+
+    choice EXAMPLE_LCD_DATA_LINES
+        prompt "RGB LCD Data Lines"
+        default EXAMPLE_LCD_DATA_LINES_16
+        help
+            Select the number of data lines of the RGB LCD.
+
+        config EXAMPLE_LCD_DATA_LINES_16
+            bool "16 data lines"
+    endchoice
+
+    config EXAMPLE_LCD_DATA_LINES
+        int
+        default 16 if EXAMPLE_LCD_DATA_LINES_16
+
+    menu "GPIO assignment"
+        config EXAMPLE_LCD_VSYNC_GPIO
+            int "VSYNC GPIO"
+            help
+                GPIO pin number for VSYNC signal.
+        config EXAMPLE_LCD_HSYNC_GPIO
+            int "HSYNC GPIO"
+            help
+                GPIO pin number for HSYNC signal.
+        config EXAMPLE_LCD_DE_GPIO
+            int "DE GPIO"
+            help
+                GPIO pin number for DE signal.
+        config EXAMPLE_LCD_PCLK_GPIO
+            int "PCLK GPIO"
+            help
+                GPIO pin number for PCLK signal.
+        config EXAMPLE_LCD_DATA0_GPIO
+            int "DATA0 GPIO"
+            help
+                GPIO pin number for data bus[0].
+        config EXAMPLE_LCD_DATA1_GPIO
+            int "DATA1 GPIO"
+            help
+                GPIO pin number for data bus[1].
+        config EXAMPLE_LCD_DATA2_GPIO
+            int "DATA2 GPIO"
+            help
+                GPIO pin number for data bus[2].
+        config EXAMPLE_LCD_DATA3_GPIO
+            int "DATA3 GPIO"
+            help
+                GPIO pin number for data bus[3].
+        config EXAMPLE_LCD_DATA4_GPIO
+            int "DATA4 GPIO"
+            help
+                GPIO pin number for data bus[4].
+        config EXAMPLE_LCD_DATA5_GPIO
+            int "DATA5 GPIO"
+            help
+                GPIO pin number for data bus[5].
+        config EXAMPLE_LCD_DATA6_GPIO
+            int "DATA6 GPIO"
+            help
+                GPIO pin number for data bus[6].
+        config EXAMPLE_LCD_DATA7_GPIO
+            int "DATA7 GPIO"
+            help
+                GPIO pin number for data bus[7].
+        config EXAMPLE_LCD_DATA8_GPIO
+            int "DATA8 GPIO"
+            help
+                GPIO pin number for data bus[8].
+        config EXAMPLE_LCD_DATA9_GPIO
+            int "DATA9 GPIO"
+            help
+                GPIO pin number for data bus[9].
+        config EXAMPLE_LCD_DATA10_GPIO
+            int "DATA10 GPIO"
+            help
+                GPIO pin number for data bus[10].
+        config EXAMPLE_LCD_DATA11_GPIO
+            int "DATA11 GPIO"
+            help
+                GPIO pin number for data bus[11].
+        config EXAMPLE_LCD_DATA12_GPIO
+            int "DATA12 GPIO"
+            help
+                GPIO pin number for data bus[12].
+        config EXAMPLE_LCD_DATA13_GPIO
+            int "DATA13 GPIO"
+            help
+                GPIO pin number for data bus[13].
+        config EXAMPLE_LCD_DATA14_GPIO
+            int "DATA14 GPIO"
+            help
+                GPIO pin number for data bus[14].
+        config EXAMPLE_LCD_DATA15_GPIO
+            int "DATA15 GPIO"
+            help
+                GPIO pin number for data bus[15].
+    endmenu
 endmenu

examples/peripherals/lcd/rgb_panel/main/idf_component.yml

@@ -1,2 +1,2 @@
 dependencies:
-  lvgl/lvgl: "^9.0.0"
+  lvgl/lvgl: "~9.2.0"