[PATCH 0/2] Introduce BACKGROUND_COLOR DRM CRTC property

Cristian Ciocaltea posted 2 patches 1 month ago
drivers/gpu/drm/drm_atomic_state_helper.c    |  1 +
drivers/gpu/drm/drm_atomic_uapi.c            |  4 +++
drivers/gpu/drm/drm_blend.c                  | 37 +++++++++++++++++++++++++---
drivers/gpu/drm/drm_mode_config.c            |  6 +++++
drivers/gpu/drm/rockchip/rockchip_drm_vop2.c | 13 +++++++++-
drivers/gpu/drm/rockchip/rockchip_drm_vop2.h |  4 +++
include/drm/drm_blend.h                      |  4 ++-
include/drm/drm_crtc.h                       | 12 +++++++++
include/drm/drm_mode_config.h                |  5 ++++
include/uapi/drm/drm_mode.h                  | 30 ++++++++++++++++++++++
10 files changed, 110 insertions(+), 6 deletions(-)
[PATCH 0/2] Introduce BACKGROUND_COLOR DRM CRTC property
Posted by Cristian Ciocaltea 1 month ago
Some display controllers can be hardware-configured to present non-black
colors for pixels which are not covered by any plane (or are exposed
through transparent regions of higher planes).

The first patch of the series introduces the BACKGROUND_COLOR DRM
property that can be attached to a CRTC via a dedicated helper function.
A 64-bit ARGB color value format is also defined and can be manipulated
with the help of a few utility macros.

Note this is a reworked version of the patch [1] submitted (many) years
ago by Matt Roper.  The main changes are:

* Dropped drm_arg() in favor of drm_argb64() to get rid of the bpc
  parameter and the related shifting for more flexibility in operation,
  e.g. when user-space cannot make use of the helper and/or when it
  doesn't now the actual precision supported by the HW.  This also
  simplifies the property verification/validation testing (see below).
  It works by extracting the specified number of least-significant bits
  from each color component.
* Renamed DRM_ARGB_*() to DRM_ARGB64_*_LSB() while providing convenience
  wrappers to extract all 16 bits of a specific color via DRM_ARGB64_*()
* Replaced GENMASK_ULL(63, 0) with U64_MAX when calling
  drm_property_create_range() to create the BACKGROUND_COLOR property
* Moved crtc_state->bgcolor initialization from
  __drm_atomic_helper_crtc_reset() to
  __drm_atomic_helper_crtc_state_reset()
* Replaced '*bgcolor*' occurrences to '*background_color*' for
  consistency with the actual property name in both storage field and
  helper functions names

The second patch adds background color support to the VOP2 display
controller used in the RK3568, RK3576, and RK3588 Rockchip SoC families.

For the moment this has been validated using a modetest wrapper script
[2], which is able to execute several tests - see an example of a
generated report at the end.  Proper support in Weston is currently in
development, and I will provide a reference once it becomes available.

The tests were performed on the Radxa boards listed below.  Please note
that as of next-20250901, there are a few known regressions; for each
case, I mentioned the actual problem and its related fix/workaround
accordingly:

* ROCK 3A (RK3568)
 - issue: broken networking
 - fix: revert commit da114122b831 ("net: ethernet: stmmac: dwmac-rk: Make
   the clk_phy could be used for external phy")

* ROCK 4D (RK3576)
 - issue: random freezes right after booting
 - fix: add regulator_ignore_unused to kernel cmdline

* ROCK 5B (RK3588)
 - issue: broken networking
 - fix: apply patch [3]

[1] https://lore.kernel.org/all/20190930224707.14904-2-matthew.d.roper@intel.com/
[2] https://gitlab.collabora.com/cristicc/linux-next/-/commits/drm-vop2-bgcolor-test
[3] https://lore.kernel.org/all/20250827230943.17829-1-inochiama@gmail.com/

Validation report on ROCK 5B
============================

$ tools/testing/rk-bgcol-test.sh

---------------------------------------------------------------
 Available Rockchip display connectors
---------------------------------------------------------------
id	type	status	crtc_id	plane_id
85	11	2	0	34
88	11	1	83	40

Selected connector: id=88 crtc=83 plane=40

---------------------------------------------------------------
 Check initial state
---------------------------------------------------------------
Read BACKGROUND_COLOR prop (ARGB64): 0xffff000000000000
    Connector: HDMI-A-2
	background color (10bpc): r=0 g=0 b=0

---------------------------------------------------------------
 Set/get DRM property
---------------------------------------------------------------
Changing prop value to: 0xffff00000000ffff
opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
Read BACKGROUND_COLOR prop (ARGB64): 0xffff00000000ffff
    Connector: HDMI-A-2
	background color (10bpc): r=0 g=0 b=ffff

---------------------------------------------------------------
 Plane display test 40@83:960x540+480+270
---------------------------------------------------------------

Changing prop value to 0xffffffff00000000
Press ENTER to continue..
opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
testing 960x540@XR24 overlay plane 40

Read BACKGROUND_COLOR prop (ARGB64): 0xffffffff00000000
    Connector: HDMI-A-2
	background color (10bpc): r=ffff g=0 b=0

Changing prop value to 0xffff0000ffff0000
Press ENTER to continue..
opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
testing 960x540@XR24 overlay plane 40

Read BACKGROUND_COLOR prop (ARGB64): 0xffff0000ffff0000
    Connector: HDMI-A-2
	background color (10bpc): r=0 g=ffff b=0

Changing prop value to 0xffff00000000ffff
Press ENTER to continue..
opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
testing 960x540@XR24 overlay plane 40

Read BACKGROUND_COLOR prop (ARGB64): 0xffff00000000ffff
    Connector: HDMI-A-2
	background color (10bpc): r=0 g=0 b=ffff

---------------------------------------------------------------
 Restoring state
---------------------------------------------------------------
Changing prop value to: 0xffff000000000000
opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
Read BACKGROUND_COLOR prop (ARGB64): 0xffff000000000000
    Connector: HDMI-A-2
	background color (10bpc): r=0 g=0 b=0

Signed-off-by: Cristian Ciocaltea <cristian.ciocaltea@collabora.com>
---
Cristian Ciocaltea (2):
      drm: Add CRTC background color property
      drm/rockchip: vop2: Support setting custom background color

 drivers/gpu/drm/drm_atomic_state_helper.c    |  1 +
 drivers/gpu/drm/drm_atomic_uapi.c            |  4 +++
 drivers/gpu/drm/drm_blend.c                  | 37 +++++++++++++++++++++++++---
 drivers/gpu/drm/drm_mode_config.c            |  6 +++++
 drivers/gpu/drm/rockchip/rockchip_drm_vop2.c | 13 +++++++++-
 drivers/gpu/drm/rockchip/rockchip_drm_vop2.h |  4 +++
 include/drm/drm_blend.h                      |  4 ++-
 include/drm/drm_crtc.h                       | 12 +++++++++
 include/drm/drm_mode_config.h                |  5 ++++
 include/uapi/drm/drm_mode.h                  | 30 ++++++++++++++++++++++
 10 files changed, 110 insertions(+), 6 deletions(-)
---
base-commit: d0630b758e593506126e8eda6c3d56097d1847c5
change-id: 20250829-rk3588-bgcolor-c1a7b9a507bc
Re: [PATCH 0/2] Introduce BACKGROUND_COLOR DRM CRTC property
Posted by Raphael Gallais-Pou 1 month ago

On 9/2/25 11:27, Cristian Ciocaltea wrote:
> Some display controllers can be hardware-configured to present non-black
> colors for pixels which are not covered by any plane (or are exposed
> through transparent regions of higher planes).
>
> The first patch of the series introduces the BACKGROUND_COLOR DRM
> property that can be attached to a CRTC via a dedicated helper function.
> A 64-bit ARGB color value format is also defined and can be manipulated
> with the help of a few utility macros.

Hi Cristian,

Thanks for this work ! :)

FWIW I sent a series also based on Matt's work four years ago:
https://lore.kernel.org/dri-devel/20210707084557.22443-2-raphael.gallais-pou@foss.st.com/

IIRC at the time there was some questions around the pixel format used for the
property, and non-opaque color vs alpha pre-multiplication.
Mind that on STM32MP platforms alpha channel for the background color is not
supported.

Hope the thread can bring some insights.

Best regards,
Raphaël
>
> Note this is a reworked version of the patch [1] submitted (many) years
> ago by Matt Roper.  The main changes are:
>
> * Dropped drm_arg() in favor of drm_argb64() to get rid of the bpc
>   parameter and the related shifting for more flexibility in operation,
>   e.g. when user-space cannot make use of the helper and/or when it
>   doesn't now the actual precision supported by the HW.  This also
>   simplifies the property verification/validation testing (see below).
>   It works by extracting the specified number of least-significant bits
>   from each color component.
> * Renamed DRM_ARGB_*() to DRM_ARGB64_*_LSB() while providing convenience
>   wrappers to extract all 16 bits of a specific color via DRM_ARGB64_*()
> * Replaced GENMASK_ULL(63, 0) with U64_MAX when calling
>   drm_property_create_range() to create the BACKGROUND_COLOR property
> * Moved crtc_state->bgcolor initialization from
>   __drm_atomic_helper_crtc_reset() to
>   __drm_atomic_helper_crtc_state_reset()
> * Replaced '*bgcolor*' occurrences to '*background_color*' for
>   consistency with the actual property name in both storage field and
>   helper functions names
>
> The second patch adds background color support to the VOP2 display
> controller used in the RK3568, RK3576, and RK3588 Rockchip SoC families.
>
> For the moment this has been validated using a modetest wrapper script
> [2], which is able to execute several tests - see an example of a
> generated report at the end.  Proper support in Weston is currently in
> development, and I will provide a reference once it becomes available.
>
> The tests were performed on the Radxa boards listed below.  Please note
> that as of next-20250901, there are a few known regressions; for each
> case, I mentioned the actual problem and its related fix/workaround
> accordingly:
>
> * ROCK 3A (RK3568)
>  - issue: broken networking
>  - fix: revert commit da114122b831 ("net: ethernet: stmmac: dwmac-rk: Make
>    the clk_phy could be used for external phy")
>
> * ROCK 4D (RK3576)
>  - issue: random freezes right after booting
>  - fix: add regulator_ignore_unused to kernel cmdline
>
> * ROCK 5B (RK3588)
>  - issue: broken networking
>  - fix: apply patch [3]
>
> [1] https://lore.kernel.org/all/20190930224707.14904-2-matthew.d.roper@intel.com/
> [2] https://gitlab.collabora.com/cristicc/linux-next/-/commits/drm-vop2-bgcolor-test
> [3] https://lore.kernel.org/all/20250827230943.17829-1-inochiama@gmail.com/
>
> Validation report on ROCK 5B
> ============================
>
> $ tools/testing/rk-bgcol-test.sh
>
> ---------------------------------------------------------------
>  Available Rockchip display connectors
> ---------------------------------------------------------------
> id	type	status	crtc_id	plane_id
> 85	11	2	0	34
> 88	11	1	83	40
>
> Selected connector: id=88 crtc=83 plane=40
>
> ---------------------------------------------------------------
>  Check initial state
> ---------------------------------------------------------------
> Read BACKGROUND_COLOR prop (ARGB64): 0xffff000000000000
>     Connector: HDMI-A-2
> 	background color (10bpc): r=0 g=0 b=0
>
> ---------------------------------------------------------------
>  Set/get DRM property
> ---------------------------------------------------------------
> Changing prop value to: 0xffff00000000ffff
> opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
> Read BACKGROUND_COLOR prop (ARGB64): 0xffff00000000ffff
>     Connector: HDMI-A-2
> 	background color (10bpc): r=0 g=0 b=ffff
>
> ---------------------------------------------------------------
>  Plane display test 40@83:960x540+480+270
> ---------------------------------------------------------------
>
> Changing prop value to 0xffffffff00000000
> Press ENTER to continue..
> opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
> testing 960x540@XR24 overlay plane 40
>
> Read BACKGROUND_COLOR prop (ARGB64): 0xffffffff00000000
>     Connector: HDMI-A-2
> 	background color (10bpc): r=ffff g=0 b=0
>
> Changing prop value to 0xffff0000ffff0000
> Press ENTER to continue..
> opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
> testing 960x540@XR24 overlay plane 40
>
> Read BACKGROUND_COLOR prop (ARGB64): 0xffff0000ffff0000
>     Connector: HDMI-A-2
> 	background color (10bpc): r=0 g=ffff b=0
>
> Changing prop value to 0xffff00000000ffff
> Press ENTER to continue..
> opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
> testing 960x540@XR24 overlay plane 40
>
> Read BACKGROUND_COLOR prop (ARGB64): 0xffff00000000ffff
>     Connector: HDMI-A-2
> 	background color (10bpc): r=0 g=0 b=ffff
>
> ---------------------------------------------------------------
>  Restoring state
> ---------------------------------------------------------------
> Changing prop value to: 0xffff000000000000
> opened device `RockChip Soc DRM` on driver `rockchip` (version 1.0.0 at 0)
> Read BACKGROUND_COLOR prop (ARGB64): 0xffff000000000000
>     Connector: HDMI-A-2
> 	background color (10bpc): r=0 g=0 b=0
>
> Signed-off-by: Cristian Ciocaltea <cristian.ciocaltea@collabora.com>
> ---
> Cristian Ciocaltea (2):
>       drm: Add CRTC background color property
>       drm/rockchip: vop2: Support setting custom background color
>
>  drivers/gpu/drm/drm_atomic_state_helper.c    |  1 +
>  drivers/gpu/drm/drm_atomic_uapi.c            |  4 +++
>  drivers/gpu/drm/drm_blend.c                  | 37 +++++++++++++++++++++++++---
>  drivers/gpu/drm/drm_mode_config.c            |  6 +++++
>  drivers/gpu/drm/rockchip/rockchip_drm_vop2.c | 13 +++++++++-
>  drivers/gpu/drm/rockchip/rockchip_drm_vop2.h |  4 +++
>  include/drm/drm_blend.h                      |  4 ++-
>  include/drm/drm_crtc.h                       | 12 +++++++++
>  include/drm/drm_mode_config.h                |  5 ++++
>  include/uapi/drm/drm_mode.h                  | 30 ++++++++++++++++++++++
>  10 files changed, 110 insertions(+), 6 deletions(-)
> ---
> base-commit: d0630b758e593506126e8eda6c3d56097d1847c5
> change-id: 20250829-rk3588-bgcolor-c1a7b9a507bc
>

Re: [PATCH 0/2] Introduce BACKGROUND_COLOR DRM CRTC property
Posted by Cristian Ciocaltea 1 month ago
Hi Raphael,

On 9/2/25 4:19 PM, Raphael Gallais-Pou wrote:
> 
> 
> On 9/2/25 11:27, Cristian Ciocaltea wrote:
>> Some display controllers can be hardware-configured to present non-black
>> colors for pixels which are not covered by any plane (or are exposed
>> through transparent regions of higher planes).
>>
>> The first patch of the series introduces the BACKGROUND_COLOR DRM
>> property that can be attached to a CRTC via a dedicated helper function.
>> A 64-bit ARGB color value format is also defined and can be manipulated
>> with the help of a few utility macros.
> 
> Hi Cristian,
> 
> Thanks for this work ! :)
> 
> FWIW I sent a series also based on Matt's work four years ago:
> https://lore.kernel.org/dri-devel/20210707084557.22443-2-raphael.gallais-pou@foss.st.com/
> 
> IIRC at the time there was some questions around the pixel format used for the
> property, and non-opaque color vs alpha pre-multiplication.
> Mind that on STM32MP platforms alpha channel for the background color is not
> supported.
> 
> Hope the thread can bring some insights.

Thanks for pointing this out, I will consider it for v2.

Regards,
Cristian