From 5bef0f5664366e122ff8dba439b2e6d9353799f6 Mon Sep 17 00:00:00 2001 From: Chen Jichang Date: Thu, 19 Sep 2024 14:15:15 +0800 Subject: [PATCH] docs(spi_lcd): update supported spi mode description Closes https://github.com/espressif/esp-idf/issues/14605 --- docs/en/api-reference/peripherals/lcd/spi_lcd.rst | 6 ++++-- docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/en/api-reference/peripherals/lcd/spi_lcd.rst b/docs/en/api-reference/peripherals/lcd/spi_lcd.rst index 8f254ca9d9a5..2fbb8fc2a90d 100644 --- a/docs/en/api-reference/peripherals/lcd/spi_lcd.rst +++ b/docs/en/api-reference/peripherals/lcd/spi_lcd.rst @@ -5,14 +5,16 @@ SPI Interfaced LCD #. Create an SPI bus. Please refer to :doc:`SPI Master API doc ` for more details. + Currently the driver supports SPI, Quad SPI and Octal SPI (simulate Intel 8080 timing) modes. + .. code-block:: c spi_bus_config_t buscfg = { .sclk_io_num = EXAMPLE_PIN_NUM_SCLK, .mosi_io_num = EXAMPLE_PIN_NUM_MOSI, .miso_io_num = EXAMPLE_PIN_NUM_MISO, - .quadwp_io_num = -1, // Quad SPI LCD driver is not yet supported - .quadhd_io_num = -1, // Quad SPI LCD driver is not yet supported + .quadwp_io_num = -1, + .quadhd_io_num = -1, .max_transfer_sz = EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t), // transfer 80 lines of pixels (assume pixel is RGB565) at most in one SPI transaction }; ESP_ERROR_CHECK(spi_bus_initialize(LCD_HOST, &buscfg, SPI_DMA_CH_AUTO)); // Enable the DMA feature diff --git a/docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst b/docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst index 1460cd39fc12..44d511c5475c 100644 --- a/docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst +++ b/docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst @@ -5,14 +5,16 @@ SPI 接口的 LCD #. 创建 SPI 总线。详情请参阅 :doc:`SPI 主机 API 文档 `。 + 目前驱动支持 SPI， Quad SPI 和 Octal SPI（模拟 Intel 8080 时序）模式。 + .. code-block:: c spi_bus_config_t buscfg = { .sclk_io_num = EXAMPLE_PIN_NUM_SCLK, .mosi_io_num = EXAMPLE_PIN_NUM_MOSI, .miso_io_num = EXAMPLE_PIN_NUM_MISO, - .quadwp_io_num = -1, // 目前不支持 Quad SPI LCD 驱动 - .quadhd_io_num = -1, // 目前不支持 Quad SPI LCD 驱动 + .quadwp_io_num = -1, + .quadhd_io_num = -1, .max_transfer_sz = EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t), // 单次最多可传输 80 行像素（假设像素格式为 RGB565） }; ESP_ERROR_CHECK(spi_bus_initialize(LCD_HOST, &buscfg, SPI_DMA_CH_AUTO)); // 启用 DMA