Skip to content

Commit

Permalink
docs(spi_lcd): update supported spi mode description
Browse files Browse the repository at this point in the history
Closes #14605
  • Loading branch information
Kainarx committed Sep 19, 2024
1 parent 7e2a7bd commit 5bef0f5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/en/api-reference/peripherals/lcd/spi_lcd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ SPI Interfaced LCD

#. Create an SPI bus. Please refer to :doc:`SPI Master API doc </api-reference/peripherals/spi_master>` 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
Expand Down
6 changes: 4 additions & 2 deletions docs/zh_CN/api-reference/peripherals/lcd/spi_lcd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ SPI 接口的 LCD

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

目前驱动支持 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
Expand Down

0 comments on commit 5bef0f5

Please sign in to comment.