Implemented ST7789 LCD driver #5020

zjanosy · 2023-12-15T20:37:17Z

Implemented driver model for LCD controllers connected via SPI/parallel port. Implemented support for ST7789.

…nclude paths need to be fixed.

kisvegabor

Thank you, Zoltan. It looks good in general, just a few minor issue caught by the CI should be fixed.

Please run code-format.py in the scripts folder to format the code.

kisvegabor · 2023-12-15T20:40:08Z

src/dev/display/lcd/lv_lcd_panel_commands.h

@@ -0,0 +1,54 @@
+/*


As these are specific to st7789, please move these commands in lv_st7789.c.

List only the really used commands should be enough. If someone needs to use a custom command they need to look into the datasheet anyway.

These commands are common for various controllers, not ST7789 specific.

But not all, so we can't put it into a generic LCD file.
It seems roughly 10 commands are really used in st7789.c. I think it's okay to define them locally to avoid any conflicts later.

src/dev/display/st7789/lv_st7789.c

Co-authored-by: Gabor Kiss-Vamosi <kisvegabor@gmail.com>

src/dev/display/st7789/lv_st7789.h

lvgl-bot · 2023-12-30T01:46:58Z

We need some feedback on this pull request.

Now we mark this as "stale" because there was no activity here for 14 days.

Remove the "stale" label or comment else this will be closed in 7 days.

kisvegabor · 2023-12-30T07:40:28Z

Not stale, will be finished in January.

…trollers that use the same command set. Added drivers for ST7789, ST7796, ILI9341. Initialization command lists are based on LovyanGFX drivers. These improved the color reproduction quite much. Changed API to be able to supply additional flags for panel-dependent mirroring X and/or Y coordinates, and setting RGB order at create time.

…anGFX did not work well on my board).

kisvegabor

Thank you for the update.

Please also run scripts/code-format.py.

kisvegabor · 2024-01-06T08:02:00Z

src/dev/display/ili9341/lv_ili9341.c

+ *      INCLUDES
+ *********************/
+#include "lv_ili9341.h"
+


Please add LV_USE_ILI9341 guard here and and also in lv_conf_template.h (scripts/lv_conf_internal_gen.py needs to run as well)

kisvegabor · 2024-01-06T08:02:16Z

src/dev/display/ili9341/lv_ili9341.c

+ *  STATIC CONSTANTS
+ **********************/
+
+// init commands based on LovyanGFX


Use /**/ comemnts

kisvegabor · 2024-01-06T08:03:28Z

src/dev/display/ili9341/lv_ili9341.h

+ * @param param			parameter buffer
+ * @param param_size	number of bytes of the parameters
+ */
+typedef void (*lv_ili9341_send_cmd_cb_t)(lv_display_t *disp, uint8_t *cmd, size_t cmd_size, uint8_t *param, size_t param_size);


Suggested change

typedef void (*lv_ili9341_send_cmd_cb_t)(lv_display_t *disp, uint8_t *cmd, size_t cmd_size, uint8_t *param, size_t param_size);

typedef lv_ili9341_send_cmd_cb_t lv_lcd_send_cmd_cb_t;

kisvegabor · 2024-01-06T08:05:24Z

src/dev/display/st7735/lv_st7735.c

+ **********************/
+
+static const uint8_t init_cmd_list[] = {
+#if 0


#if 0s should be removed and only the final code should remain.
If the other options might be used by the users as well, and API functions or other direct way to adjust shall be provided.

kisvegabor · 2024-01-06T08:07:07Z

src/dev/display/lcd/lv_lcd_generic_mipi.h

+#define LV_LCD_FLAG_RGB666								0x00000010UL
+
+/* command list */
+#define LV_LCD_CMD_SPECIAL	0xff


As it's used only as a delay:

Suggested change

#define LV_LCD_CMD_SPECIAL 0xff

#define LV_LCD_CMD_DELAY_MS 0xfe

…ror and BGR settings. Improved init commands for the available LCD drivers. Formatted code. Added LV_USE_ flags and compiler guards.

PGNetHun · 2024-01-09T15:42:16Z

Hello!
Thx for the drivers!
Could you please provide example / doc how to use it, how to initialize?
I see that callbacks must be given (example: send_color_cb ), but don’t know what it should be exactly, how to implement, for example on ESP32 where SPI data can be sent with DMA.
My other question is about RGB565 byte swap: ST7789 display needs that in ESP32 platform, and I don’t see where it is done.
Thx again for the display drivers, I think when this PR is merged, and MicroPython is aligned to use it, then it will further improve FPS (or less CPU usage) in MicroPython binding, and replacing the actual hybrid drivers (if it’s possible).

kisvegabor

Sometime the code formatter needs to be tun multiple times to remove all double empty lines.

As these controllers don't contain any HW dependent parts we can enable them for the CI, so that they will be built and we will see if there are any compile time warnings,
So please enable the controllers here.

Please add docs for each controller. In an example section some dummy callbacks shall be added well.

kisvegabor · 2024-01-09T16:28:37Z

src/dev/display/st7796/lv_st7796.c

+ *********************/
+#include "lv_st7796.h"
+
+#if LV_USE_ST7796


Please add these guards to the header files as well.

kisvegabor · 2024-01-09T16:34:29Z

@PGNetHun According to our plans after these drivers this PR will be finalized. Does it help with MicroPython somehow?

zjanosy · 2024-01-09T16:44:11Z

@PGNetHun

Could you please provide example / doc how to use it, how to initialize?

I will add the documentation soon.

I see that callbacks must be given (example: send_color_cb ), but don’t know what it should be exactly, how to implement, for example on ESP32 where SPI data can be sent with DMA.

I will include a sample implementation. Currently the drivers have been implemented only on STM32, but ESP32 will be added soon.

My other question is about RGB565 byte swap: ST7789 display needs that in ESP32 platform, and I don’t see where it is done.

On the STM32 platform the SPI controller can swap the bytes. I need to check how the ESP32 SPI controller handles this. We may need to do it in software.

kisvegabor · 2024-01-09T16:47:28Z

My other question is about RGB565 byte swap: ST7789 display needs that in ESP32 platform, and I don’t see where it is done.

On the STM32 platform the SPI controller can swap the bytes. I need to check how the ESP32 SPI controller handles this. We may need to do it in software.

As it depends on the periphery if it can swap the bytes, lv_draw_sw_rgb565_swap can be called from the send_color_cb if needed.

PGNetHun · 2024-01-09T19:44:57Z

@PGNetHun According to our plans after these drivers this PR will be finalized. Does it help with MicroPython somehow?

Well, I'm a bit lost.
There is an another thread about (MicroPython) display drivers: https://forum.lvgl.io/t/micropython-display-drivers-part-2/14131

... so at the moment I see 3 different approaches:

the current MicroPython specific drivers (including the ESP32 hybrid display driver ili9xxx.py): https://github.com/lvgl/lv_binding_micropython/tree/master/driver
this PR and related ESP driver
the above mentioned forum thread: https://forum.lvgl.io/t/micropython-display-drivers-part-2/14131

I prefer having C display drivers due to high performance requirement (and less C <-> MicroPython context switch during display flushes)

zjanosy · 2024-01-09T20:33:58Z

@PGNetHun

Well, I'm a bit lost.
There is an another thread about (MicroPython) display drivers: https://forum.lvgl.io/t/micropython-display-drivers-part-2/14131

... so at the moment I see 3 different approaches:

the current MicroPython specific drivers (including the ESP32 hybrid display driver ili9xxx.py): https://github.com/lvgl/lv_binding_micropython/tree/master/driver
this PR and related #4507
the above mentioned forum thread: https://forum.lvgl.io/t/micropython-display-drivers-part-2/14131

The ESP-LCD driver was an initial attempt to implement a unified LCD driver architecture for LVGL. However, we decided to develop the idea further, and the current PR is the result of this. The ESP-LCD driver is now obsolete, and will be replaced by an example implementation of the current driver model.
I don't know much about the MicroPython drivers, but hopefully we can move towards a common solution for all platforms. The goal is to make LVGL work out of the box with the most common LCD controllers, without the need for using 3rd party drivers.

…entation.

…ntation).

kisvegabor · 2024-01-10T11:48:47Z

docs/integration/driver/display/st7789.rst

+Overview
+-------------
+
+The `ST7789 <>`__ SOC is a popular TFT LCD controller chip made by Sitronix. It supports TFT LCD panels with a maximum resolution of 240x320 pixels, and 262k (18 bit) colors.


Link to the datasheet?

docs/integration/driver/display/st7789.rst

…ample and chip specific parts.

kisvegabor

The updated docs looks good!

kisvegabor · 2024-01-11T11:27:12Z

src/dev/display/st7735/lv_st7735.c

+/*********************
+ *      INCLUDES
+ *********************/
+#include "lv_st7735.h"


The docs is still missing for this one.

kisvegabor · 2024-01-11T11:31:40Z

Please enable these controllers for tests, so they can be built by the CI.

…th text from the actual datasheet. Added datasheet links.

… Fixed wrong parameter in the call of lv_lcd_generic_mipi_send_cmd_list().

…k. Change callback function buffer parameters to const pointers (except the color array) in order to avoid compiler warnings.

kisvegabor

Looks good, thank you.
If anything comes up probably we can extend these without API braking the API.

zjanosy and others added 8 commits August 31, 2023 14:51

ESP LCD initial commit

f4f1dcf

test

8e0ad1c

Created separate ESP tick handler. Fixed typos. Compiles and works. I…

31b796d

…nclude paths need to be fixed.

Merge branch 'lvgl:master' into feat/lcd_driver_integration

4df03fe

Update to upstream

a74467c

Add ST7789

2d4148e

Merge branch 'master' of https://github.com/lvgl/lvgl into st7789

3503791

Implemented LCD driver ST7789

77d6671

kisvegabor reviewed Dec 15, 2023

View reviewed changes

zjanosy and others added 4 commits December 15, 2023 21:50

Change send_cmd to send_cmd_cb

47945d6

Co-authored-by: Gabor Kiss-Vamosi <kisvegabor@gmail.com>

Implemented LCD driver ST7789

6256250

Merge branch 'st7789' of https://github.com/zjanosy/lvgl into st7789

7368866

Fix error caused by recent commit

f018b86

kisvegabor reviewed Dec 15, 2023

View reviewed changes

src/dev/display/st7789/lv_st7789.h Outdated Show resolved Hide resolved

kisvegabor mentioned this pull request Dec 20, 2023

ESP IDF v5 support lvgl/lv_port_esp32#314

Open

lvgl-bot added the stale label Dec 30, 2023

lvgl-bot removed the stale label Dec 31, 2023

Zoltan Janosy and others added 4 commits January 5, 2024 17:37

Merge branch 'lvgl:master' into st7789

dca852d

Added ST7735 driver. Uses init command list from BuyDisplay.com (Lovy…

e696a96

…anGFX did not work well on my board).

Merge branch 'st7789' of https://github.com/zjanosy/lvgl into st7789

7b233e5

kisvegabor reviewed Jan 6, 2024

View reviewed changes

Added flags to lcd create functions to be able to specify default mir…

780259b

…ror and BGR settings. Improved init commands for the available LCD drivers. Formatted code. Added LV_USE_ flags and compiler guards.

kisvegabor reviewed Jan 9, 2024

View reviewed changes

Made lv_xxx_send_cmd_list() public.

c76e858

Zoltan Janosy added 2 commits January 9, 2024 21:00

Added documentation of the ILI9341 driver.

b4c3b28

Minor updates to the documentation.

28bc7dc

Zoltan Janosy added 2 commits January 9, 2024 21:56

Added actual working implementation as an example to the driver docum…

4fe0deb

…entation.

Added ST7789 driver documentation (copy&paste from the ILI9341 docume…

ca07da8

…ntation).

kisvegabor reviewed Jan 10, 2024

View reviewed changes

Separated LCD driver documentation into generic MIPI driver, STM32 ex…

b74fe83

…ample and chip specific parts.

kisvegabor reviewed Jan 11, 2024

View reviewed changes

Zoltan Janosy and others added 10 commits January 11, 2024 13:36

Added guard to header files as well.

d46eeb3

Added documentation files for ST7735 and ST7796. Replaced Overview wi…

c693817

…th text from the actual datasheet. Added datasheet links.

Remove unused functions get_driver() and send_cmd() from LCD drivers.…

a85a2cd

… Fixed wrong parameter in the call of lv_lcd_generic_mipi_send_cmd_list().

Remove double empty lines.

a20c598

Enable CI tests for LCD drivers.

99446b3

Merge branch 'master' into st7789

2143f1f

add #if guard to st7735.h

806599a

fix code formatting

4859083

feat(st7789): Define separate type for command and color send callbac…

4092ef2

…k. Change callback function buffer parameters to const pointers (except the color array) in order to avoid compiler warnings.

Merge branch 'lvgl:master' into st7789

c0fe85d

kisvegabor approved these changes Jan 12, 2024

View reviewed changes

kisvegabor merged commit a61e51f into lvgl:master Jan 12, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented ST7789 LCD driver #5020

Implemented ST7789 LCD driver #5020

zjanosy commented Dec 15, 2023

kisvegabor left a comment

kisvegabor Dec 15, 2023 •

edited

Loading

zjanosy Dec 15, 2023

kisvegabor Dec 15, 2023

lvgl-bot commented Dec 30, 2023

kisvegabor commented Dec 30, 2023

kisvegabor left a comment

kisvegabor Jan 6, 2024

kisvegabor Jan 6, 2024

kisvegabor Jan 6, 2024

kisvegabor Jan 6, 2024

kisvegabor Jan 6, 2024

PGNetHun commented Jan 9, 2024 •

edited

Loading

kisvegabor left a comment •

edited

Loading

kisvegabor Jan 9, 2024 •

edited

Loading

kisvegabor commented Jan 9, 2024

zjanosy commented Jan 9, 2024

kisvegabor commented Jan 9, 2024

PGNetHun commented Jan 9, 2024

zjanosy commented Jan 9, 2024

kisvegabor Jan 10, 2024

kisvegabor left a comment

kisvegabor Jan 11, 2024

kisvegabor commented Jan 11, 2024

kisvegabor left a comment

	typedef void (lv_ili9341_send_cmd_cb_t)(lv_display_t disp, uint8_t cmd, size_t cmd_size, uint8_t param, size_t param_size);
	typedef lv_ili9341_send_cmd_cb_t lv_lcd_send_cmd_cb_t;

	#define LV_LCD_CMD_SPECIAL 0xff
	#define LV_LCD_CMD_DELAY_MS 0xfe

Implemented ST7789 LCD driver #5020

Implemented ST7789 LCD driver #5020

Conversation

zjanosy commented Dec 15, 2023

kisvegabor left a comment

Choose a reason for hiding this comment

kisvegabor Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lvgl-bot commented Dec 30, 2023

kisvegabor commented Dec 30, 2023

kisvegabor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PGNetHun commented Jan 9, 2024 • edited Loading

kisvegabor left a comment • edited Loading

Choose a reason for hiding this comment

kisvegabor Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

kisvegabor commented Jan 9, 2024

zjanosy commented Jan 9, 2024

kisvegabor commented Jan 9, 2024

PGNetHun commented Jan 9, 2024

zjanosy commented Jan 9, 2024

Choose a reason for hiding this comment

kisvegabor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kisvegabor commented Jan 11, 2024

kisvegabor left a comment

Choose a reason for hiding this comment

kisvegabor Dec 15, 2023 •

edited

Loading

PGNetHun commented Jan 9, 2024 •

edited

Loading

kisvegabor left a comment •

edited

Loading

kisvegabor Jan 9, 2024 •

edited

Loading