esp-idf/components/esp_lcd
morris 36ee689125 Merge branch 'ci/re-enable_spi_lcd_test_on_p4' into 'master'
Ci(spi_lcd): re-enable spi lcd test on p4

Closes IDF-8975

See merge request espressif/esp-idf!31824
2024-07-03 18:32:21 +08:00
..
dsi change(dsi): use DW_GDMA as the flow controller 2024-05-28 22:36:03 +08:00
i2c feat(build): add COMPILER_STATIC_ANALYZER option 2024-06-18 14:25:37 +08:00
i80 feat(i80_lcd): add help function to allocate draw buffer with proper alignment 2024-05-30 18:33:31 +08:00
include feat(spi_lcd): add spi cs timing parameters 2024-07-02 10:55:34 +08:00
interface fix(drivers): fix typos found by codespell 2024-03-28 10:01:27 +08:00
priv_include feat(dma2d): added help driver for copying frame buffer with DMA2D 2024-01-30 18:45:36 +08:00
rgb change(rgb_lcd): set DMA transfer burst size 2024-05-24 22:43:55 +08:00
spi feat(spi_lcd): add spi cs timing parameters 2024-07-02 10:55:34 +08:00
src feat(build): add COMPILER_STATIC_ANALYZER option 2024-06-18 14:25:37 +08:00
test_apps ci(spi_lcd): re-enable spi_lcd test on p4 2024-07-03 11:12:44 +08:00
CMakeLists.txt change(esp_lcd): split header files by different IO interface 2024-05-30 18:33:31 +08:00
Kconfig feat(mipi_dsi): support isr iram safe 2024-04-23 18:31:16 +08:00
linker.lf refactor(hal): use hal utils to calculate clock division 2023-09-20 23:33:25 +08:00
README.md feat(dsi): add mipi dsi driver to esp_lcd 2024-01-20 16:50:22 +08:00

esp_lcd Driver Design

Class Diagram

esp_lcd driver focuses on two parts: panel driver and IO driver. The panel driver is a bunch of operations on the frame-buffer, no matter where the frame-buffer is located. The IO driver is mainly consumed by the controller-based LCD panel drivers (e.g. ST7789). Usually such LCD controller can support various IO interfaces (e.g. I80, SPI, I2C, etc). So we define an abstract interface for the IO driver.

classDiagram
    class esp_lcd_panel_t {
        <<interface>>
        +reset() esp_err_t
        +init() esp_err_t
        +draw_bitmap(int x_start, int y_start, int x_end, int y_end, const void *color_data) esp_err_t
        +mirror(bool x_axis, bool y_axis) esp_err_t
        +swap_xy(bool swap_axes) esp_err_t
        +set_gap(int x_gap, int y_gap) esp_err_t
        +invert_color(bool invert_color_data) esp_err_t
        +disp_on_off(bool on_off) esp_err_t
    }

    esp_lcd_rgb_panel_t --|> esp_lcd_panel_t : Inheritance
    class esp_lcd_rgb_panel_t {
        -int panel_id
        -size_t data_width
        -int disp_gpio
        -intr_handle_t intr
        -uint8_t* frame_buffer
        -gdma_channel_handle_t gdma_channel
        -dma_descriptor_t* dma_nodes
        -on_vsync(void* user_data) bool
    }

    esp_lcd_panel_model_t --|> esp_lcd_panel_t : Inheritance
    esp_lcd_panel_model_t "1" --> "1" esp_lcd_panel_io_t : Use
    class esp_lcd_panel_model_t {
        -esp_lcd_panel_io_t* io
        -int reset_gpio_num
    }

    class esp_lcd_panel_io_t {
        <<interface>>
        +rx_param(int lcd_cmd, void *param, size_t param_size)
        +tx_param(int lcd_cmd, const void *param, size_t param_size)
        +tx_color(int lcd_cmd, const void *color, size_t color_size)
    }

    esp_lcd_panel_io_i2c_t --|> esp_lcd_panel_io_t : Inheritance
    class esp_lcd_panel_io_i2c_t {
        -int i2c_bus_id
        -int ctrl_phase_cmd
        -int ctrl_phase_data
        -on_color_trans_done(void* user_data) bool
    }

    esp_lcd_panel_io_spi_t --|> esp_lcd_panel_io_t : Inheritance
    class esp_lcd_panel_io_spi_t {
        -spi_device_handle_t spi_dev
        -int dc_gpio_num
        -spi_transaction_t trans_worker
        -on_color_trans_done(void* user_data) bool
    }

    esp_lcd_panel_io_dbi_t --|> esp_lcd_panel_io_t : Inheritance
    class esp_lcd_panel_io_dbi_t {
        -esp_lcd_dsi_bus_t* bus
        -int virtual_channel
    }

    esp_lcd_dpi_panel_t --|> esp_lcd_panel_t : Inheritance
    class esp_lcd_dpi_panel_t {
        -esp_lcd_dsi_bus_t* bus
        -int virtual_channel
        -void *frame_buffer
        -dw_gdma_channel_handle_t dma_chan
    }

    esp_lcd_dsi_bus_t "1" --> "1..*" esp_lcd_panel_io_dbi_t : Has
    esp_lcd_dsi_bus_t "1" --> "1..*" esp_lcd_dpi_panel_t : Has
    class esp_lcd_dsi_bus_t {
        -int bus_id
    }

    esp_lcd_panel_io_i80_t --|> esp_lcd_panel_io_t : Inheritance
    class esp_lcd_panel_io_i80_t {
        -esp_lcd_i80_bus_t* bus
        -int cs_gpio_num
        -int dc_level
        -size_t pclk_hz
        -QueueHandle_t trans_queue
        -QueueHandle_t done_queue
        -on_color_trans_done(void* user_data) bool
    }

    esp_lcd_i80_bus_t "1" --> "1..*" esp_lcd_panel_io_i80_t : Has
    class esp_lcd_i80_bus_t {
        -int bus_id
        -size_t data_width
        -intr_handle_t intr
        -gdma_cannel_handle_t dma_chan
        -dma_descriptor_t* dma_nodes
        -list_t i80_devices
    }