Merge pull request #3 from Y1hsiaochunnn/master

Add esp_lcd_sh8601 variant component to ESP32-S3-Touch-AMOLED-1.8

Author: WaveshareCloud

.github/workflows/upload_component.yml

@@ -21,5 +21,6 @@ jobs:
             display/lcd/esp_lcd_jd9365_10_1;
             display/lcd/esp_lcd_hx8394;
             display/lcd/esp_lcd_dsi;
+            display/lcd/esp_lcd_sh8601;
           namespace: "waveshare"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

display/lcd/esp_lcd_sh8601/CHANGELOG.md

@@ -0,0 +1,8 @@
+# ChangeLog
+
+## v1.0.0 - 2025-01-14
+
+### Enhancements:
+
+* Adapted by waveshare electronics according to [esp_lcd_sh8601](https://components.espressif.com/components/espressif/esp_lcd_sh8601)
+

display/lcd/esp_lcd_sh8601/CMakeLists.txt

@@ -0,0 +1,4 @@
+idf_component_register(SRCS "esp_lcd_sh8601.c" INCLUDE_DIRS "include" PRIV_REQUIRES "driver" REQUIRES "esp_lcd")
+
+include(package_manager)
+cu_pkg_define_version(${CMAKE_CURRENT_LIST_DIR})

display/lcd/esp_lcd_sh8601/README.md

@@ -0,0 +1,100 @@
+# Waveshare ESP32-S3-Touch-AMOLED-1.8 Display Support
+
+[![Component Registry](https://components.espressif.com/components/waveshare/esp_lcd_sh8601/badge.svg)](https://components.espressif.com/components/waveshare/esp_lcd_sh8601)
+
+Waveshare ESP32-S3-Touch-AMOLED-1.8 Display used QSPI
+
+| LCD controller | Communication interface | Component name |                               Link to datasheet                               |
+| :------------: |:-----------------------:| :------------: | :---------------------------------------------------------------------------: |
+|     SH8601     |          QSPI           | esp_lcd_sh8601 | [PDF](https://dl.espressif.com/AE/esp-iot-solution/SH8601A0_DataSheet_Preliminary_V0.0_UCS__191107_1_.pdf) |
+
+## Add to project
+
+Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/).
+You can add them to your project via `idf.py add-dependancy`, e.g.
+```
+    idf.py add-dependency "waveshare/esp_lcd_sh8601"
+```
+
+Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
+
+## BackLight
+
+sent 0x51 0x00~0xFF to control backlight
+
+## Initialization Code
+
+
+### QSPI Interface
+
+```c
+    ESP_LOGI(TAG, "Initialize QSPI bus");
+    const esp_lcd_panel_io_spi_config_t io_config = SH8601_PANEL_BUS_QSPI_CONFIG(EXAMPLE_PIN_NUM_LCD_PCLK,
+                                                                                 EXAMPLE_PIN_NUM_LCD_DATA0,
+                                                                                 EXAMPLE_PIN_NUM_LCD_DATA1,
+                                                                                 EXAMPLE_PIN_NUM_LCD_DATA2,
+                                                                                 EXAMPLE_PIN_NUM_LCD_DATA3,
+                                                                                 EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t));
+    ESP_ERROR_CHECK(spi_bus_initialize(EXAMPLE_LCD_HOST, &buscfg, SPI_DMA_CH_AUTO));
+
+    ESP_LOGI(TAG, "Install panel IO");
+    esp_lcd_panel_io_handle_t io_handle = NULL;
+    const esp_lcd_panel_io_spi_config_t io_config = SH8601_PANEL_IO_QSPI_CONFIG(EXAMPLE_PIN_NUM_LCD_CS, callback, &callback_data);
+    ESP_ERROR_CHECK(esp_lcd_new_panel_io_spi((esp_lcd_spi_bus_handle_t)EXAMPLE_LCD_HOST, &io_config, &io_handle));
+
+/**
+ * Uncomment these line if use custom initialization commands.
+ * The array should be declared as static const and positioned outside the function.
+ */
+// static const sh8601_lcd_init_cmd_t lcd_init_cmds[] = {
+// //  {cmd, { data }, data_size, delay_ms}
+//    {0x44, (uint8_t []){0x00, 0xc8}, 2, 0},
+//    {0x35, (uint8_t []){0x00}, 0, 0},
+//    {0x53, (uint8_t []){0x20}, 1, 25},
+//    {0x29, (uint8_t []){0x00}, 0, 120},
+//     ...
+// };
+
+    ESP_LOGI(TAG, "Install SH8601 panel driver");
+    esp_lcd_panel_handle_t panel_handle = NULL;
+    const sh8601_vendor_config_t vendor_config = {
+        // .init_cmds = lcd_init_cmds,         // Uncomment these line if use custom initialization commands
+        // .init_cmds_size = sizeof(lcd_init_cmds) / sizeof(sh8601_lcd_init_cmd_t),
+        .flags = {
+            .use_qspi_interface = 1,
+        },
+    };
+    const esp_lcd_panel_dev_config_t panel_config = {
+        .reset_gpio_num = EXAMPLE_PIN_NUM_LCD_RST,
+        .rgb_ele_order = LCD_RGB_ELEMENT_ORDER_RGB,               // Implemented by LCD command `36h`
+        .bits_per_pixel = 16,                                     // Implemented by LCD command `3Ah`
+        .vendor_config = &vendor_config,
+    };
+    ESP_ERROR_CHECK(esp_lcd_new_panel_sh8601(io_handle, &panel_config, &panel_handle));
+
+    esp_lcd_panel_reset(panel_handle);
+    esp_lcd_panel_init(panel_handle);
+    esp_lcd_panel_disp_on_off(panel_handle, true);
+```
+
+## Notes
+
+* When utilizing `esp_panel_lcd_draw_bitmap()` to refresh the screen, ensure that `x_start`, `y_start`, `x_end` and `y_end` are divisible by `2`. This is a requirement of SH8610. For LVGL, register the following function into `rounder_cb` of `lv_disp_drv_t` to round the coordinates.
+
+```c
+void lvgl_port_rounder_callback(struct _lv_disp_drv_t * disp_drv, lv_area_t * area)
+{
+    uint16_t x1 = area->x1;
+    uint16_t x2 = area->x2;
+    uint16_t y1 = area->y1;
+    uint16_t y2 = area->y2;
+
+    // round the start of area down to the nearest even number
+    area->x1 = (x1 >> 1) << 1;
+    area->y1 = (y1 >> 1) << 1;
+
+    // round the end of area up to the nearest odd number
+    area->x2 = ((x2 >> 1) << 1) + 1;
+    area->y2 = ((y2 >> 1) << 1) + 1;
+}
+```