Skip to content

Commit 5bef0f5

Browse files
committed
docs(spi_lcd): update supported spi mode description
Closes #14605
1 parent 7e2a7bd commit 5bef0f5

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/en/api-reference/peripherals/lcd/spi_lcd.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ SPI Interfaced LCD
55

66
#. Create an SPI bus. Please refer to :doc:`SPI Master API doc </api-reference/peripherals/spi_master>` for more details.
77

8+
Currently the driver supports SPI, Quad SPI and Octal SPI (simulate Intel 8080 timing) modes.
9+
810
.. code-block:: c
911
1012
spi_bus_config_t buscfg = {
1113
.sclk_io_num = EXAMPLE_PIN_NUM_SCLK,
1214
.mosi_io_num = EXAMPLE_PIN_NUM_MOSI,
1315
.miso_io_num = EXAMPLE_PIN_NUM_MISO,
14-
.quadwp_io_num = -1, // Quad SPI LCD driver is not yet supported
15-
.quadhd_io_num = -1, // Quad SPI LCD driver is not yet supported
16+
.quadwp_io_num = -1,
17+
.quadhd_io_num = -1,
1618
.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
1719
};
1820
ESP_ERROR_CHECK(spi_bus_initialize(LCD_HOST, &buscfg, SPI_DMA_CH_AUTO)); // Enable the DMA feature

docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ SPI 接口的 LCD
55

66
#. 创建 SPI 总线。详情请参阅 :doc:`SPI 主机 API 文档 </api-reference/peripherals/spi_master>`。
77

8+
目前驱动支持 SPI, Quad SPI 和 Octal SPI(模拟 Intel 8080 时序)模式。
9+
810
.. code-block:: c
911
1012
spi_bus_config_t buscfg = {
1113
.sclk_io_num = EXAMPLE_PIN_NUM_SCLK,
1214
.mosi_io_num = EXAMPLE_PIN_NUM_MOSI,
1315
.miso_io_num = EXAMPLE_PIN_NUM_MISO,
14-
.quadwp_io_num = -1, // 目前不支持 Quad SPI LCD 驱动
15-
.quadhd_io_num = -1, // 目前不支持 Quad SPI LCD 驱动
16+
.quadwp_io_num = -1,
17+
.quadhd_io_num = -1,
1618
.max_transfer_sz = EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t), // 单次最多可传输 80 行像素(假设像素格式为 RGB565)
1719
};
1820
ESP_ERROR_CHECK(spi_bus_initialize(LCD_HOST, &buscfg, SPI_DMA_CH_AUTO)); // 启用 DMA

0 commit comments

Comments
 (0)