fb: cfb: Support color display #58817

soburi · 2023-06-04T06:05:11Z

Add color display support for CFB.

The concept of "Invert" depended on monochrome displays.
I reimplemented it with foreground color and background color concepts that are newly introduced with color support.

The CFB is no longer a "(Monochrome) Character Frame Buffer" but
the concept and usage of the API remain the same.
Since I would like to maintain the CFB abbreviation, I am considering renaming it "Compact Frame Buffer."

This PR is part of a series of CFB enhancements (third of four #72177).
I would appreciate it if you could check the #67881 part first.

cfriedt · 2023-08-03T15:30:46Z

dev-review: ping @jfischer-no

MaureenHelm · 2023-08-24T15:50:22Z

@jfischer-no @danieldegrasse will you please take a look?

danieldegrasse

Just some initial comments- but I am still confused about the goal of this rework. First off, the subsystem itself is called Monochrome Character Framebuffer. The subsystem is explicitly:

monochrome
intended for font rendering

If we are going to extend CFB to be what I would consider a small graphics framework, I would like to see the following:

Documentation updates- the current CFB naming is confusing
Additional tests or samples demonstrating usage of this framework, so we can verify rendering functions work as expected

Additionally, I am slightly confused about where a graphics framework would fit versus LVGL. Is the intention of this framework to fit where LVGL can't?

@jfischer-no ping- I'll defer to you on any of these comments, I just want to make sure that if we are extending CFB we keep documentation and samples up to date.

danieldegrasse · 2023-08-29T16:57:11Z

subsys/fb/cfb.c

-	desc.pitch = fb->x_res;
+	if ((fb->pixel_format == PIXEL_FORMAT_MONO01 || fb->pixel_format == PIXEL_FORMAT_MONO10) &&
+	    (fb->screen_info & SCREEN_INFO_MONO_VTILED)) {
+		/* A VTILED format display usually does not support partial region transfers.


Why is the code enforcing this restriction? Wouldn't a user know their display, and if it did not support partial region transfers simply call cfb_framebuffer_finalize instead?

jfischer-no · 2023-08-30T09:03:36Z

include/zephyr/display/cfb.h

+ * @param a The alpha channel of the foreground color
+ *
+ */
+void cfb_framebuffer_set_foreground_color(const struct device *dev, uint8_t r, uint8_t g, uint8_t b,


I do not think we can go with this never ending identifiers, so please use common abbreviation and find shorter names, e.g. cfb_set_fg_color(). And there is no reason to have additional framebuffer to cfb.

jfischer-no · 2023-08-30T09:07:31Z

subsys/fb/Kconfig

@@ -31,6 +31,26 @@ config CHARACTER_FRAMEBUFFER_SHELL_DRIVER_NAME
 	help
 	  Character Framebuffer Display Driver Name

+config CHARACTER_FRAMEBUFFER_TRANSFER_WITH_PIXEL_FORMAT_CONVERSION


Please just CFB_TRANSFER_..., for that you will need to change the three option above to CFB_USE_DEFAULT_FONTS, CFB_SHELL, CFB_SHELL_DRIVER_NAME (this one looks outdated, not sure it is still used).

jfischer-no · 2023-08-30T10:53:16Z

subsys/fb/cfb.c

+		return api->write(dev, 0, 0, &desc, fb->buf);
+	}
+
+#ifdef CONFIG_CHARACTER_FRAMEBUFFER_TRANSFER_WITH_PIXEL_FORMAT_CONVERSION


if(ENABLED(CFB_TRANSFER_WITH_PIXEL_FORMAT_CONVERSION)) { cfb_transfer_with_pixel_conversion(..); }

I do not understand why this code should not always be built, and why it cannot be broken into smaller chunks. As it is now, it is difficult to understand and review.

MaureenHelm · 2023-09-28T15:20:43Z

@soburi do you plan to return to this PR?

soburi · 2023-09-28T21:58:26Z

@soburi do you plan to return to this PR?

I'm in bit busy state. I'll late to update it.

github-actions · 2023-12-30T00:30:02Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

include/zephyr/display/cfb.h

danieldegrasse · 2024-06-11T15:28:14Z

@jfischer-no can you revisit comments on this PR?

kartben

some comments re: docs / migration guide

kartben · 2024-06-12T09:53:07Z

doc/releases/migration-guide-3.7.rst

+  Therefore, use :c:func:`cfb_display_init` instead of deprecated cfb_framebuffer_init.
+  cfb_framebuffer_init has been deprecated.


Suggested change

Therefore, use :c:func:`cfb_display_init` instead of deprecated cfb_framebuffer_init.

cfb_framebuffer_init has been deprecated.

Therefore, use :c:func:`cfb_display_init` instead of deprecated ``cfb_framebuffer_init``.

``cfb_framebuffer_init`` has been deprecated.

kartben · 2024-06-12T09:56:17Z

subsys/fb/Kconfig


-config CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS
+config CFB_USE_DEFAULT_FONTS


renamed kconfigs need to be detailed in the migration guide

kartben · 2024-06-12T10:00:54Z

doc/releases/migration-guide-3.7.rst

+    cfb_print(fb, "Hello!", 0, 0);
+
+
+  Also, please see the sample in ``samples/display/cfb``.


path is wrong, and you may use :zephyr:code-sample: anyway

Suggested change

Also, please see the sample in ``samples/display/cfb``.

Also, please see the :zephyr:code-sample:`cfb-sample`.

kartben · 2024-06-12T10:01:52Z

doc/releases/migration-guide-3.7.rst

+  * :c:func:`cfb_finalize` (renamed from `cfb_framebuffer_finalize`)
+  * :c:func:`cfb_set_font` (renamed from `cfb_framebuffer_finalize`)
+
+  :c:func:`cfb_display_alloc` can use to migrate from `cfb_framebuffer_init`.


not clear what this means?

kartben · 2024-06-12T10:02:22Z

doc/releases/migration-guide-3.7.rst

would be nice to have release note entry as well, but this can come later too.

The logic introduced in zephyrproject-rtos#67881 can also handle fonts with heights other than integer multiple of 8. I remove the restriction. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Add test cases for 1x1 and 11x13 fonts. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Change the arguments of `cfb_invert_area`, `cfb_print`, and `cfb_draw_(point|line|rect)`, which used unsigned integers to specify coordinates to signed integers. This is because coordinate calculations are usually based on real numbers, so it is difficult to use unless negative numbers are accepted. We clip drawings outside the drawable area on the implementation side. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

`cfb_get_font_size` and `cfb_get_numof_fonts` take a `const struct driver *` as a first argument, but not use it. Remove the argument and clean up related sources. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

There are three major changes. - Introducing `struct cfb_display` - Changed the argument `struct device *` to `struct cfb_framebuffer *` - Rename APIs starting with `cfb_framebuffer_*` Introduces struct cfb_display as a data structure to represent the display. As a result, it is now possible to create multiple pieces of data managed using a single static variable in previous implementations, making it possible to handle multiple displays. The old `struct cfb_framebuffer` remains but is now part of the `struct cfb_display` data structure. You can get cfb_framebuffer from cfb_display using the added API `cfb_display_get_framebuffer`. All places where a `struct device *` argument was passed to specify the target will be replaced with a `struct cfb_framebuffer *`. In line with this, API names starting with `cfb_framebuffer_*`, which were redundant and inconsistent names, will remove `_framebuffer` and change to `cfb_*` . Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Add `display select` command to select display. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Add a note about the changes of CFB(Character framebuffer) APIs. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

The pixel per tile value can be calculated from pixel_format, so delete the ppt field. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

If a character that does not exist in the font was specified, it was replaced with a space character, but it will now draw with 0 data. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Added support for color displays. Along with color support, we are introducing the concept of foreground and background colors. Drawing fonts and lines is done with the foreground color, and clear operation fills with the background color. With the introduction of drawing colors, we have removed the process of inverting data before transfer if the inverted flag was enabled during finalizing. Replacing the "Invert" operation by swapping the foreground and background colors. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

I have removed the process to set the display format to monochrome. Also, I added board settings conf files for native_sim and native_sim_64 to change the initial value of the SDL display driver's pixel format. CFB operates according to the pixel format set here. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Added a test to check the display on a color display. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Add the `fgcolor` `bgcolor` and `display pixel_format` to support color display Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

CHARACTER_FRAMEBUFFER_SHELL_DRIVER_NAME is not used. Remove it. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

CFB was an abbreviation for Character Framebuffer. However, it currently supports characters and graphic drawing, so it has become far from actual. However, since there are only a few API changes, I don't want to change symbol names, etc. Therefore, we will keep the abbreviation CFB and change the name to `Compact Framebuffer`. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Update README to update to current specs. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

github-actions · 2024-09-01T00:37:14Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

soburi force-pushed the cfb_transfer_to_color_display branch 2 times, most recently from 05cdc53 to e30ac83 Compare June 5, 2023 05:04

soburi changed the title ~~Cfb transfer to color display~~ cfb: Adding limited color LCD support using transfer buffers Jun 5, 2023

soburi marked this pull request as ready for review June 5, 2023 08:24

soburi requested review from jfischer-no, nashif, carlescufi, galak and MaureenHelm as code owners June 5, 2023 08:24

zephyrbot added the area: Display label Jun 5, 2023

MaureenHelm assigned jfischer-no Jul 13, 2023

soburi requested a review from danieldegrasse August 7, 2023 05:14

danieldegrasse reviewed Aug 29, 2023

View reviewed changes

jfischer-no reviewed Aug 30, 2023

View reviewed changes

carlescufi requested a review from jfischer-no September 13, 2023 10:06

soburi marked this pull request as draft October 30, 2023 04:18

github-actions bot added the Stale label Dec 30, 2023

soburi force-pushed the cfb_transfer_to_color_display branch from e30ac83 to 9b78a29 Compare January 10, 2024 15:23

github-actions bot removed the Stale label Jan 11, 2024

soburi force-pushed the cfb_transfer_to_color_display branch from 9b78a29 to 7b8e69b Compare January 13, 2024 11:20

soburi force-pushed the cfb_transfer_to_color_display branch from 7b8e69b to 453afc5 Compare January 28, 2024 15:02

soburi added the DNM This PR should not be merged (Do Not Merge) label Jan 28, 2024

soburi force-pushed the cfb_transfer_to_color_display branch 3 times, most recently from d0e1ec7 to de85a26 Compare January 28, 2024 22:31

zephyrbot requested review from nordicjm and tejlmand May 2, 2024 03:53

soburi removed the DNM This PR should not be merged (Do Not Merge) label May 2, 2024

cfriedt reviewed May 2, 2024

View reviewed changes

include/zephyr/display/cfb.h Show resolved Hide resolved

soburi force-pushed the cfb_transfer_to_color_display branch from 0d08faf to 10b6d1c Compare May 5, 2024 15:32

cfriedt previously approved these changes Jun 1, 2024

View reviewed changes

kartben requested changes Jun 12, 2024

View reviewed changes

soburi added 16 commits July 2, 2024 19:42

fb: cfb: Remove the restriction for non-x8 heights fonts

48e3d0e

The logic introduced in zephyrproject-rtos#67881 can also handle fonts with heights other than integer multiple of 8. I remove the restriction. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

tests: subsys: display: cfb: Added test for font heights non-x8

426c794

Add test cases for 1x1 and 11x13 fonts. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb: Remove unused argument from font API

dd90916

`cfb_get_font_size` and `cfb_get_numof_fonts` take a `const struct driver *` as a first argument, but not use it. Remove the argument and clean up related sources. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb_shell: Support display selecting

b5954be

Add `display select` command to select display. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

doc: releases: migration-guide: 3.7: list CFB API change

dc2c64a

Add a note about the changes of CFB(Character framebuffer) APIs. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb: Delete ppt field of cfb_framebuffer struct

adbe949

The pixel per tile value can be calculated from pixel_format, so delete the ppt field. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb: Improved behavior when a character not in the font

4f73129

If a character that does not exist in the font was specified, it was replaced with a space character, but it will now draw with 0 data. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

test: subsys: display: cfb: Add test for color display

5206a39

Added a test to check the display on a color display. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb_shell: Add command for color display supporting

6d9d6d1

Add the `fgcolor` `bgcolor` and `display pixel_format` to support color display Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb: Remove unused config

d3b64e9

CHARACTER_FRAMEBUFFER_SHELL_DRIVER_NAME is not used. Remove it. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

fb: cfb_shell: Update README.rst

ca6abc6

Update README to update to current specs. Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

soburi dismissed cfriedt’s stale review via ca6abc6 July 2, 2024 10:46

soburi force-pushed the cfb_transfer_to_color_display branch from 10b6d1c to ca6abc6 Compare July 2, 2024 10:46

soburi marked this pull request as draft July 2, 2024 10:46

github-actions bot added the Stale label Sep 1, 2024

github-actions bot closed this Sep 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fb: cfb: Support color display #58817

fb: cfb: Support color display #58817

soburi commented Jun 4, 2023 •

edited

Loading

cfriedt commented Aug 3, 2023

MaureenHelm commented Aug 24, 2023

danieldegrasse left a comment

danieldegrasse Aug 29, 2023

jfischer-no Aug 30, 2023

jfischer-no Aug 30, 2023

jfischer-no Aug 30, 2023

MaureenHelm commented Sep 28, 2023

soburi commented Sep 28, 2023

github-actions bot commented Dec 30, 2023

danieldegrasse commented Jun 11, 2024

kartben left a comment

kartben Jun 12, 2024

kartben Jun 12, 2024

kartben Jun 12, 2024

kartben Jun 12, 2024

kartben Jun 12, 2024

github-actions bot commented Sep 1, 2024

		Therefore, use :c:func:`cfb_display_init` instead of deprecated cfb_framebuffer_init.
		cfb_framebuffer_init has been deprecated.


		config CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS
		config CFB_USE_DEFAULT_FONTS

		cfb_print(fb, "Hello!", 0, 0);


		Also, please see the sample in ``samples/display/cfb``.

	Also, please see the sample in ``samples/display/cfb``.
	Also, please see the :zephyr:code-sample:`cfb-sample`.

fb: cfb: Support color display #58817

fb: cfb: Support color display #58817

Conversation

soburi commented Jun 4, 2023 • edited Loading

cfriedt commented Aug 3, 2023

MaureenHelm commented Aug 24, 2023

danieldegrasse 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

MaureenHelm commented Sep 28, 2023

soburi commented Sep 28, 2023

github-actions bot commented Dec 30, 2023

danieldegrasse commented Jun 11, 2024

kartben 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

github-actions bot commented Sep 1, 2024

soburi commented Jun 4, 2023 •

edited

Loading