Add wayland support #51

etag4048 · 2024-07-22T15:51:45Z

Add support for wayland
Update lv_conf with the lastest version
Update readme
Update CMakelists.txt

BTW the commit made 5h ago made changes to the Makefile, but the documentation states that it's currently broken..
Haven't tried to build with the makefile

kisvegabor · 2024-07-24T21:34:10Z

Let's wait for merging Wayland in LVGL and update the submodule here too.

BTW the commit made 5h ago made changes to the Makefile, but the documentation states that it's currently broken..

@100ask does the Makefile work well now?

100ask · 2024-07-25T03:10:34Z

does the Makefile work well now?

I am currently planning to fix this issue, the meaning here is not to abandon Makefile, right?

etag4048 · 2024-07-25T06:54:29Z

@100ask Correct it means that's it's currently broken, and that cmake should be used instead. I've only removed the 'shall' verb, it was in future tense, making it slightly ambiguous. That's great news, let me know when you've fixed so that I can test it and even add the wayland target.

kisvegabor · 2024-07-25T11:20:30Z

main.c

+    bool err = false;
+
+    /* Default values */
+    fullscreen = maximize = false;


Move the config part into function for better readibility.

Do you mean move the switch/case used to get the options to a dedicated function ? Yes sure can

Yes, just to keep main() easier to read.

kisvegabor · 2024-07-25T11:22:46Z

main.c

+        if (tickless == 0 && sleep_wait > 0) {
+            lv_tick_inc(sleep_wait);
+        }
+
+        /* Handle any Wayland/LVGL timers/events */
+        time_till_next = lv_wayland_timer_handler();
+
+        /* Run until the last window closes */
+        if (!lv_wayland_window_is_open(NULL)) {
+            break;
+        }
+
+        /* Wait for something for an event to happen */
+        if (time_till_next == LV_NO_TIMER_READY) {
+            sleep_wait = -1;
+        } else if (time_till_next > INT_MAX) {
+            sleep_wait = INT_MAX;
+        } else {
+            sleep_wait = time_till_next;
+        }
+
+        while ((poll(&pfd, 1, sleep_wait) < 0) && (errno == EINTR));


Can it be part of the Wayland driver?
It would be nice to keep using lv_timer_handler as it is. Can we have a timer are theard in the driver for polling?

lv_wayland_timer_handler was introduced by previous contributors, to poll for events, if there are no events the application sleeps until the next refresh. I don't see how it's possible to do this in the driver, the call to poll(2) needs to know the time to next flush so it must be called from the main run loop.

I am open for suggestions, but it's going to take some more time to refactor and re-test

What about just wrapping the whole polling + lv_timer_handler into an lv_wayland_event_loop? Similar to QNX. It' won't keep lv_timer_handlervisible, but at least it's less glue code for the user.

At first I tried disabling the event driven timer handling, to move out the call to lv_timer_handler out of the driver. But early window maximization/fullscreen doesn't work anymore on weston... It crashes because the shared memory buffers are resized and thus re-arranged. So the references in the draw units of weston become incorrect and it crashes... This is the problem I had a few months back. And the 'solution' was to build fixes around the event driven timer handler, simply because it gives more control over when the lvgl flush occurs. It can not occur in the middle of a commit. To add on top of it the event driven timer was a 'bit of hack' to begin with lvgl/lv_drivers#207. I will study the QNX driver more carefully, I see that they are pausing the timer. Will come up with something similar and make it run on weston...

After the import, it's also probably a good idea to start a re-write, it needs it...

@kisvegabor I've adjusted the driver as much as I could to match the other ones lvgl/lvgl@7783303
I prefer to implement the sleeping when the window hidden or minimized, once we refactor the driver. It currently works well on weston and Mutter which is great. Is that fine with you ? If yes, I will take of the stubs this evening/tommorow

Re-introduced the sleep when hidden feature, by using the frame done event. It's a slightly different approach than original. Works well, tested and documented.

YobeZhou · 2024-07-27T16:33:38Z

CMakeLists.txt

+# Please set the wanted option to 'ON'. By default, FBDEV is used
+# be sure to also enable the selected driver in lv_conf.h
+
+option(LV_USE_WAYLAND "Use the wayland client backend" OFF)


Hi, there is a potential issue here: https://cmake.org/cmake/help/latest/command/option.html

Before that, it should be ensured that the cache has been cleared, e.g:

if(DEFINED LV_USE_WAYLAND) unset(LV_USE_WAYLAND CACHE) endif()

Hey @YobeZhou I am not quite well versed at CMake, I've copied what I found in the existing SDL simulator https://github.com/lvgl/lv_port_pc_vscode/blob/master/CMakeLists.txt

I usually rm -rf build when I change options.

100ask · 2024-07-29T09:51:34Z

@100ask Correct it means that's it's currently broken, and that cmake should be used instead. I've only removed the 'shall' verb, it was in future tense, making it slightly ambiguous. That's great news, let me know when you've fixed so that I can test it and even add the wayland target.

Makefile fixed: #53

kisvegabor · 2024-08-01T07:32:21Z

lv_conf.h

-    #define LV_LINUX_FBDEV_RENDER_MODE   LV_DISPLAY_RENDER_MODE_DIRECT
-    #define LV_LINUX_FBDEV_BUFFER_COUNT  1
+    #define LV_LINUX_FBDEV_RENDER_MODE   LV_DISPLAY_RENDER_MODE_PARTIAL
+    #define LV_LINUX_FBDEV_BUFFER_COUNT  0
    #define LV_LINUX_FBDEV_BUFFER_SIZE   60
 #endif


LV_USE_WAYLAND is missing from here.

anaGrad · 2024-09-17T11:16:24Z

Hello! Any updates on this PR?

kisvegabor · 2024-09-17T13:42:59Z

It seems it was forgotten. @etag4048 Will you have time to finalize it?

etag4048 · 2024-09-17T13:46:35Z

@kisvegabor @anaGrad Will attempt to finish this week, I wanted to add wayland to the regular makefile too.

kisvegabor · 2024-09-17T14:40:49Z

Fantastic, thank you! 👍

nicusorcitu · 2024-10-01T12:53:49Z

Hi @etag4048 any progress with this PR? Thanks.

etag4048 · 2024-10-03T07:04:49Z

@nicusorcitu my colleague @EDGEMTech-GabrielC is currently reviewing, testing as well as making adjustments.

etag4048 · 2024-10-11T09:00:31Z

@nicusorcitu it should be working now, can you test please ?

nicusorcitu · 2024-10-11T09:58:54Z

@anaGrad can you please verify? Thanks.

anaGrad · 2024-10-14T11:45:28Z

I tested and on first run it looks great!

nicusorcitu · 2024-10-14T12:28:34Z

Will it work also with LVGL master/v9.2 branch? can you please verify?

anaGrad · 2024-10-14T12:34:47Z

Yes, works fine

kisvegabor · 2024-10-16T11:35:35Z

@etag4048 please resolve the conflict and we are good to go 🙂

…mpleted

Use external scripts to obtain the selected backend in lv_conf.h Generate wayland protocol via a shell script instead of CMake

Remove the step that tells to edit the CMakeLists.txt file and manually enable the option to select the backend

Solve merge conflit with the main branch

…imer fires up

etag4048 · 2024-10-24T06:40:26Z

@kisvegabor Ready.

kisvegabor · 2024-10-24T07:35:44Z

Thank you Erik.

Pleas take a look at the CI, now all the test are failing. :(

kisvegabor · 2024-10-24T08:29:47Z

Thank you, Erik! Merging.

etag4048 · 2024-10-24T08:31:20Z

@kisvegabor Fixed the CI... I am not familiar with the RHEL, oraclelinux and rocky linux. Not my style of distributions @debug-richard Could you help out and please tell me the name of the packages for wayland-scanner and wayland-client in those distributions? Before the CI I've never had issues compiling on Ubuntu 22.04, I am interested in what issues did you experience when you say you had a hard time building.

debug-richard · 2024-10-24T10:40:46Z

@etag4048
About my experience:

This project did not specify the required build dependencies. To run the example I had to find the correct dependencies which can take hours and is not very satisfying 😉. They are now documented in the Dockerfiles.
The find_package command tries to find the cmake config for this library. This file is not provided on Debian and Ubuntu. There is a hack on Stackoverflow that suggests creating the file manually, but this is not portable. pkg-config is the distribution independent standard for this.
It is the purpose of CI to build in a clean environment to detect these problems

Unfortunately, you forgot to enable the wayland build in the CI file which means the dependencies for the wayland build are currently missing.

I fired up the Docker containers and these seem to be the required dependencies:

RHEL:
dnf -y install libxkbcommon-devel wayland-devel wayland-protocols-devel

DEBIAN:
apt-get install -y libxkbcommon-dev libwayland-dev wayland-protocols

etag4048 · 2024-10-24T10:52:14Z

@debug-richard Thanks for the package names, at least on Ubuntu one can use apt-cache search <term> to find packages, but oracle linux idk.. :)
I did not forget to add the wayland test, it's just that I don't want to mess with RHEL

etag4048 · 2024-10-24T12:21:15Z

@nicusorcitu I want to perform some small refactoring, like doing a separate file per backend. Improve the readme, to list the required dependencies for popular distros. Also integrating the backend selection to the GNU Makefile would be nice.

nicusorcitu · 2024-10-24T12:23:01Z

Sure, any improvement is much appreciated :)

kisvegabor reviewed Jul 25, 2024

View reviewed changes

etag4048 marked this pull request as draft July 26, 2024 10:30

YobeZhou reviewed Jul 27, 2024

View reviewed changes

etag4048 marked this pull request as ready for review July 29, 2024 09:28

100ask mentioned this pull request Jul 29, 2024

fix(Makefile): fix Makefile #53

Merged

100ask closed this Jul 29, 2024

100ask reopened this Jul 29, 2024

kisvegabor reviewed Aug 1, 2024

View reviewed changes

etag4048 force-pushed the add-wayland-support branch from 4b3f802 to 743a790 Compare October 11, 2024 08:52

etag4048 requested a review from kisvegabor October 11, 2024 09:41

etag4048 added 4 commits October 24, 2024 08:27

fix(wayland) Rebase master to get the latest changes

8df235d

chore(wayland) adjust example code

e1dfb2d

chore(wayland) align with driver, wait only if the cycle was fully co…

10715fe

…mpleted

feat(wayland) Simplify CMakeLists file

a9dc761

Use external scripts to obtain the selected backend in lv_conf.h Generate wayland protocol via a shell script instead of CMake

etag4048 added 4 commits October 24, 2024 08:34

fix(wayland) - Remove test script

744d90c

doc(wayland) Update documentation

0d9d157

Remove the step that tells to edit the CMakeLists.txt file and manually enable the option to select the backend

feat(wayland) Move wayland display init and runloop to a separate file

26797eb

Solve merge conflit with the main branch

fix(wayland) Re-apply the delay timer execution only until the next t…

b28dc67

…imer fires up

etag4048 force-pushed the add-wayland-support branch from abe682d to b28dc67 Compare October 24, 2024 06:39

etag4048 added 2 commits October 24, 2024 10:15

fix(wayland) adjust CI

17c44f9

fix(wayland) fix CI

b33bffc

kisvegabor merged commit 8b106e2 into lvgl:master Oct 24, 2024
8 checks passed

Add wayland support #51

Add wayland support #51

Conversation

etag4048 commented Jul 22, 2024

kisvegabor commented Jul 24, 2024

100ask commented Jul 25, 2024

etag4048 commented Jul 25, 2024 • edited Loading

kisvegabor Jul 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kisvegabor Jul 25, 2024 • edited Loading

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

kisvegabor Jul 25, 2024 • edited Loading

Choose a reason for hiding this comment

etag4048 Jul 26, 2024 • edited Loading

Choose a reason for hiding this comment

etag4048 Jul 26, 2024 • edited Loading

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

100ask commented Jul 29, 2024

Choose a reason for hiding this comment

anaGrad commented Sep 17, 2024

kisvegabor commented Sep 17, 2024

etag4048 commented Sep 17, 2024

kisvegabor commented Sep 17, 2024

nicusorcitu commented Oct 1, 2024

etag4048 commented Oct 3, 2024

etag4048 commented Oct 11, 2024

nicusorcitu commented Oct 11, 2024

anaGrad commented Oct 14, 2024

nicusorcitu commented Oct 14, 2024

anaGrad commented Oct 14, 2024

kisvegabor commented Oct 16, 2024

etag4048 commented Oct 24, 2024

kisvegabor commented Oct 24, 2024

kisvegabor commented Oct 24, 2024

etag4048 commented Oct 24, 2024

debug-richard commented Oct 24, 2024

etag4048 commented Oct 24, 2024 • edited Loading

etag4048 commented Oct 24, 2024

nicusorcitu commented Oct 24, 2024

etag4048 commented Jul 25, 2024 •

edited

Loading

kisvegabor Jul 25, 2024 •

edited

Loading

kisvegabor Jul 25, 2024 •

edited

Loading

kisvegabor Jul 25, 2024 •

edited

Loading

etag4048 Jul 26, 2024 •

edited

Loading

etag4048 Jul 26, 2024 •

edited

Loading

etag4048 commented Oct 24, 2024 •

edited

Loading