espressif/esp_lcd_spd2010

uploaded 3 weeks ago

# ESP LCD SPD2010 [](https://components.espressif.com/components/espressif/esp_lcd_spd2010) Implementation of the SPD2010 LCD controller with [esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-reference/peripherals/lcd.html) component. | LCD controller | Communication interface | Component name | Link to datasheet | | :------------: | :---------------------: | :-------------: | :-----------------------------------------------------------------------------: | | SPD2010 | SPI/QSPI | esp_lcd_spd2010 | [PDF](https://dl.espressif.com/AE/esp-iot-solution/SPD2010(L-WEA2010)_0.50.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 "espressif/esp_lcd_spd2010" ``` 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). ## Initialization Code ### SPI Interface ```c ESP_LOGI(TAG, "Initialize SPI bus"); const spi_bus_config_t bus_config = SPD2010_PANEL_BUS_SPI_CONFIG(EXAMPLE_PIN_NUM_LCD_PCLK, EXAMPLE_PIN_NUM_LCD_DATA0, EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t)); ESP_ERROR_CHECK(spi_bus_initialize(EXAMPLE_LCD_HOST, &bus_config, 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 = SPD2010_PANEL_IO_SPI_CONFIG(EXAMPLE_PIN_NUM_LCD_CS, EXAMPLE_PIN_NUM_LCD_DC, 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 spd2010_lcd_init_cmd_t lcd_init_cmds[] = { // // {cmd, { data }, data_size, delay_ms} // {0xFF, (uint8_t []){0x20, 0x10, 0x10}, 3, 0}, // {0x0C, (uint8_t []){0x11}, 1, 0}, // {0x10, (uint8_t []){0x02}, 1, 0}, // {0x11, (uint8_t []){0x11}, 1, 0}, // ... // }; ESP_LOGI(TAG, "Install SPD2010 panel driver"); esp_lcd_panel_handle_t panel_handle = NULL; const spd2010_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(spd2010_lcd_init_cmd_t), .flags = { .use_qspi_interface = 0, }, }; 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` (16/18/24) .vendor_config = &vendor_config, }; ESP_ERROR_CHECK(esp_lcd_new_panel_spd2010(io_handle, &panel_config, &panel_handle)); esp_lcd_panel_reset(panel_handle); esp_lcd_panel_init(panel_handle); ``` ### QSPI Interface ```c ESP_LOGI(TAG, "Initialize QSPI bus"); const esp_lcd_panel_io_spi_config_t io_config = SPD2010_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 = SPD2010_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 spd2010_lcd_init_cmd_t lcd_init_cmds[] = { // // {cmd, { data }, data_size, delay_ms} // {0xFF, (uint8_t []){0x20, 0x10, 0x10}, 3, 0}, // {0x0C, (uint8_t []){0x11}, 1, 0}, // {0x10, (uint8_t []){0x02}, 1, 0}, // {0x11, (uint8_t []){0x11}, 1, 0}, // ... // }; ESP_LOGI(TAG, "Install SPD2010 panel driver"); esp_lcd_panel_handle_t panel_handle = NULL; const spd2010_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(spd2010_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` (16/18/24) .vendor_config = &vendor_config, }; ESP_ERROR_CHECK(esp_lcd_new_panel_spd2010(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 using `esp_panel_lcd_draw_bitmap()` to refresh the screen, ensure that both `x_start` and `x_end` are divisible by `4`. This is a requirement of SPD2010. 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; // round the start of coordinate down to the nearest 4M number area->x1 = (x1 >> 2) << 2; // round the end of coordinate up to the nearest 4N+3 number area->x2 = ((x2 >> 2) << 2) + 3; } ```

# ChangeLog ## v0.0.1 - 2023-08-22 ### Enhancements: * Implement the driver for the SPD2010 LCD controller * Support SPI and QSPI interface ## v0.0.2 - 2023-10-07 ### Enhancements: * Support to use ESP-IDF release/v5.0 ## v1.0.0 - 2023-11-03 ### bugfix * Fix the incompatible dependent version of ESP-IDF * Remove LCD command `29h` from the initialization sequence * Add parameter `max_trans_sz` in default bus configuration macro * Check conflicting commands between initialization sequence and driver