Documentation: gpu: Mention the requirements for new properties
Subsystems (3)
PATCH v4 1/1 Documentation: gpu: Mention the requirements for new properties
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in Cc
Changes from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor name
Changes from v1:
- Typos and wording reported by Daniel and Alex
--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)
Documentation/gpu/drm-kms.rst +19 -0
@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections. +Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used. + +- It must provide a generic helper in the core code to register that + property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable. + Property Types and Blob Property Support ----------------------------------------
Signature · 1 line
2.31.1
Quoted 124 lines · On Wed, 16 Jun 2021 16:38:42 +0200 Maxime Ripard <[email protected]> wrote:
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
Cc Alexandre Belloni <[email protected]>Cc Alexandre Torgue <[email protected]>Cc Alex Deucher <[email protected]>Cc Alison Wang <[email protected]>Cc Alyssa Rosenzweig <[email protected]>Cc Andrew Jeffery <[email protected]>Cc Andrzej Hajda <[email protected]>Cc Anitha Chrisanthus <[email protected]>Cc Benjamin Gaignard <[email protected]>Cc Ben Skeggs <[email protected]>Cc Boris Brezillon <[email protected]>Cc Brian Starkey <[email protected]>Cc Chen Feng <[email protected]>Cc Chen-Yu Tsai <[email protected]>Cc Christian Gmeiner <[email protected]>Cc "Christian König" <[email protected]>Cc Chun-Kuang Hu <[email protected]>Cc Edmund Dea <[email protected]>Cc Eric Anholt <[email protected]>Cc Fabio Estevam <[email protected]>Cc Gerd Hoffmann <[email protected]>Cc Haneen Mohammed <[email protected]>Cc Hans de Goede <[email protected]>Cc "Heiko Stübner" <[email protected]>Cc Huang Rui <[email protected]>Cc Hyun Kwon <[email protected]>Cc Inki Dae <[email protected]>Cc Jani Nikula <[email protected]>Cc Jernej Skrabec <[email protected]>Cc Jerome Brunet <[email protected]>Cc Joel Stanley <[email protected]>Cc John Stultz <[email protected]>Cc Jonas Karlman <[email protected]>Cc Jonathan Hunter <[email protected]>Cc Joonas Lahtinen <[email protected]>Cc Joonyoung Shim <[email protected]>Cc Jyri Sarha <[email protected]>Cc Kevin Hilman <[email protected]>Cc Kieran Bingham <[email protected]>Cc Krzysztof Kozlowski <[email protected]>Cc Kyungmin Park <[email protected]>Cc Laurent Pinchart <[email protected]>Cc Linus Walleij <[email protected]>Cc Liviu Dudau <[email protected]>Cc Lucas Stach <[email protected]>Cc Ludovic Desroches <[email protected]>Cc Marek Vasut <[email protected]>Cc Martin Blumenstingl <[email protected]>Cc Matthias Brugger <[email protected]>Cc Maxime Coquelin <[email protected]>Cc Maxime Ripard <[email protected]>Cc Melissa Wen <[email protected]>Cc Neil Armstrong <[email protected]>Cc Nicolas Ferre <[email protected]>Cc "Noralf Trønnes" <[email protected]>Cc NXP Linux Team <[email protected]>Cc Oleksandr Andrushchenko <[email protected]>Cc Patrik Jakobsson <[email protected]>Cc Paul Cercueil <[email protected]>Cc Pekka Paalanen <[email protected]>Cc Pengutronix Kernel Team <[email protected]>Cc Philippe Cornu <[email protected]>Cc Philipp Zabel <[email protected]>Cc Qiang Yu <[email protected]>Cc Rob Clark <[email protected]>Cc Robert Foss <[email protected]>Cc Rob Herring <[email protected]>Cc Rodrigo Siqueira <[email protected]>Cc Rodrigo Vivi <[email protected]>Cc Roland Scheidegger <[email protected]>Cc Russell King <[email protected]>Cc Sam Ravnborg <[email protected]>Cc Sandy Huang <[email protected]>Cc Sascha Hauer <[email protected]>Cc Sean Paul <[email protected]>Cc Seung-Woo Kim <[email protected]>Cc Shawn Guo <[email protected]>Cc Simon Ser <[email protected]>Cc Stefan Agner <[email protected]>Cc Steven Price <[email protected]>Cc Sumit Semwal <[email protected]>Cc Thierry Reding <[email protected]>Cc Tian Tao <[email protected]>Cc Tomeu Vizoso <[email protected]>Cc Tomi Valkeinen <[email protected]>Cc VMware Graphics <[email protected]>Cc Xinliang Liu <[email protected]>Cc Xinwei Kong <[email protected]>Cc Yannick Fertre <[email protected]>Cc Zack Rusin <[email protected]>Reviewed-by Daniel Vetter <[email protected]>Signed-off-by Maxime Ripard <[email protected]>---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in CcChanges from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor nameChanges from v1:
- Typos and wording reported by Daniel and Alex--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)Documentation/gpu/drm-kms.rst +0
-0@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections.
Documentation/gpu/drm-kms.rst KMS Properties · line 474
Quoted 10 lines
Documentation/gpu/drm-kms.rst +9
-0+Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used.
Hi,
I might replace "some" with "full" documentation. Also not only how it can be used but also what it does.
FYI, some common things that tend to be forgotten IME:
- Spell out exactly the name string for the property in the documentation so that it is unambiguous what string userspace should look for.
- The same for string names of enum values.
- Explicitly document what each enum value means, do not trust that the value name describes it well enough.
- Explain how the property interacts with other, existing properties.
Not sure if these should be written down here or anywhere though. Interaction with other properties is kind of important.
Documentation/gpu/drm-kms.rst KMS Properties · line 483
Quoted 9 lines
Documentation/gpu/drm-kms.rst +9
-0+ +- It must provide a generic helper in the core code to register that + property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable.
Would it be too much to replace "where reasonable" with "if it is at all possible to write a test."?
Documentation/gpu/drm-kms.rst KMS Properties · line 484
Quoted 1 line
Documentation/gpu/drm-kms.rst +1
-0+
How about adding the following somewhere?
- The initial state of the property (set during driver initialization) must match how the driver+hardware behaved before introducing this property. It may be some fixed value or it may be inherited from e.g. the firmware that booted the system. How the initial state is determined must also be documented, that is, where does it come from.
The initial state must not be called "default", because I want to reserve the term default for something else if possible: the phrase "reset everything to defaults", which is a whole another discussion.
How about also saying that fbcon/fbdev must set this property when taking over? That sounds to be like a common omission leading to funky KMS state in fbcon. The value fbdev sets it to only needs to make sense to fbdev, and it does not need to be ~~the initial value~~ nor the default value. Or are we hoping to kill fbcon in favor of a userspace kmscon soon? ;-)
Ooh, maybe the KMS property documentation should also say what value fbdev will set the property to. That's kind of UABI, because userspace probably implicitly relies on it in many cases. ...which means fbdev should set the property to its initial value, otherwise userspace will break.
Thanks,
pq
Hi Pekka,
Quoted 178 lines · Pekka Paalanen
Quoted 124 lines · On Wed, 16 Jun 2021 16:38:42 +0200 Maxime Ripard <[email protected]> wrote:
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
Cc Alexandre Belloni <[email protected]>Cc Alexandre Torgue <[email protected]>Cc Alex Deucher <[email protected]>Cc Alison Wang <[email protected]>Cc Alyssa Rosenzweig <[email protected]>Cc Andrew Jeffery <[email protected]>Cc Andrzej Hajda <[email protected]>Cc Anitha Chrisanthus <[email protected]>Cc Benjamin Gaignard <[email protected]>Cc Ben Skeggs <[email protected]>Cc Boris Brezillon <[email protected]>Cc Brian Starkey <[email protected]>Cc Chen Feng <[email protected]>Cc Chen-Yu Tsai <[email protected]>Cc Christian Gmeiner <[email protected]>Cc "Christian König" <[email protected]>Cc Chun-Kuang Hu <[email protected]>Cc Edmund Dea <[email protected]>Cc Eric Anholt <[email protected]>Cc Fabio Estevam <[email protected]>Cc Gerd Hoffmann <[email protected]>Cc Haneen Mohammed <[email protected]>Cc Hans de Goede <[email protected]>Cc "Heiko Stübner" <[email protected]>Cc Huang Rui <[email protected]>Cc Hyun Kwon <[email protected]>Cc Inki Dae <[email protected]>Cc Jani Nikula <[email protected]>Cc Jernej Skrabec <[email protected]>Cc Jerome Brunet <[email protected]>Cc Joel Stanley <[email protected]>Cc John Stultz <[email protected]>Cc Jonas Karlman <[email protected]>Cc Jonathan Hunter <[email protected]>Cc Joonas Lahtinen <[email protected]>Cc Joonyoung Shim <[email protected]>Cc Jyri Sarha <[email protected]>Cc Kevin Hilman <[email protected]>Cc Kieran Bingham <[email protected]>Cc Krzysztof Kozlowski <[email protected]>Cc Kyungmin Park <[email protected]>Cc Laurent Pinchart <[email protected]>Cc Linus Walleij <[email protected]>Cc Liviu Dudau <[email protected]>Cc Lucas Stach <[email protected]>Cc Ludovic Desroches <[email protected]>Cc Marek Vasut <[email protected]>Cc Martin Blumenstingl <[email protected]>Cc Matthias Brugger <[email protected]>Cc Maxime Coquelin <[email protected]>Cc Maxime Ripard <[email protected]>Cc Melissa Wen <[email protected]>Cc Neil Armstrong <[email protected]>Cc Nicolas Ferre <[email protected]>Cc "Noralf Trønnes" <[email protected]>Cc NXP Linux Team <[email protected]>Cc Oleksandr Andrushchenko <[email protected]>Cc Patrik Jakobsson <[email protected]>Cc Paul Cercueil <[email protected]>Cc Pekka Paalanen <[email protected]>Cc Pengutronix Kernel Team <[email protected]>Cc Philippe Cornu <[email protected]>Cc Philipp Zabel <[email protected]>Cc Qiang Yu <[email protected]>Cc Rob Clark <[email protected]>Cc Robert Foss <[email protected]>Cc Rob Herring <[email protected]>Cc Rodrigo Siqueira <[email protected]>Cc Rodrigo Vivi <[email protected]>Cc Roland Scheidegger <[email protected]>Cc Russell King <[email protected]>Cc Sam Ravnborg <[email protected]>Cc Sandy Huang <[email protected]>Cc Sascha Hauer <[email protected]>Cc Sean Paul <[email protected]>Cc Seung-Woo Kim <[email protected]>Cc Shawn Guo <[email protected]>Cc Simon Ser <[email protected]>Cc Stefan Agner <[email protected]>Cc Steven Price <[email protected]>Cc Sumit Semwal <[email protected]>Cc Thierry Reding <[email protected]>Cc Tian Tao <[email protected]>Cc Tomeu Vizoso <[email protected]>Cc Tomi Valkeinen <[email protected]>Cc VMware Graphics <[email protected]>Cc Xinliang Liu <[email protected]>Cc Xinwei Kong <[email protected]>Cc Yannick Fertre <[email protected]>Cc Zack Rusin <[email protected]>Reviewed-by Daniel Vetter <[email protected]>Signed-off-by Maxime Ripard <[email protected]>---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in CcChanges from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor nameChanges from v1:
- Typos and wording reported by Daniel and Alex--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)Documentation/gpu/drm-kms.rst +0
-0@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections.Documentation/gpu/drm-kms.rst KMS Properties · line 474
Quoted 10 lines
Documentation/gpu/drm-kms.rst +9
-0+Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used.Hi,
I might replace "some" with "full" documentation. Also not only how it can be used but also what it does.
FYI, some common things that tend to be forgotten IME:
- Spell out exactly the name string for the property in the documentation so that it is unambiguous what string userspace should look for.
- The same for string names of enum values.
- Explicitly document what each enum value means, do not trust that the value name describes it well enough.
- Explain how the property interacts with other, existing properties.Not sure if these should be written down here or anywhere though. Interaction with other properties is kind of important.
Documentation/gpu/drm-kms.rst KMS Properties · line 483
Quoted 9 lines
Documentation/gpu/drm-kms.rst +9
-0+ +- It must provide a generic helper in the core code to register that + property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable.Would it be too much to replace "where reasonable" with "if it is at all possible to write a test."?
Documentation/gpu/drm-kms.rst KMS Properties · line 484
Quoted 1 line
Documentation/gpu/drm-kms.rst +1
-0+How about adding the following somewhere?
- The initial state of the property (set during driver initialization) must match how the driver+hardware behaved before introducing this property. It may be some fixed value or it may be inherited from e.g. the firmware that booted the system. How the initial state is determined must also be documented, that is, where does it come from.
Quoted 3 lines
The initial state must not be called "default", because I want to reserve the term default for something else if possible: the phrase "reset everything to defaults", which is a whole another discussion.
I've taken into account your previous comments, thanks
Quoted 7 lines
How about also saying that fbcon/fbdev must set this property when taking over? That sounds to be like a common omission leading to funky KMS state in fbcon. The value fbdev sets it to only needs to make sense to fbdev, and it does not need to be ~~the initial value~~ nor the default value. Or are we hoping to kill fbcon in favor of a userspace kmscon soon? ;-)
Quoted 5 lines
Ooh, maybe the KMS property documentation should also say what value fbdev will set the property to. That's kind of UABI, because userspace probably implicitly relies on it in many cases. ...which means fbdev should set the property to its initial value, otherwise userspace will break.
I'm not sure about this one: fbdev and fbcon are still optional features of the kernel and can be disabled at the user discretion. Having any part of the user-space rely on the fbdev behavior seems a bit broken, especially when we have a mechanism to retrieve the state when the application starts.
Maxime
Quoted 200 lines · On Tue, 6 Jul 2021 10:52:02 +0200 Maxime Ripard <[email protected]> wrote:
Hi Pekka,
Quoted 178 lines · Pekka Paalanen
Quoted 124 lines · On Wed, 16 Jun 2021 16:38:42 +0200 Maxime Ripard <[email protected]> wrote:
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
Cc Alexandre Belloni <[email protected]>Cc Alexandre Torgue <[email protected]>Cc Alex Deucher <[email protected]>Cc Alison Wang <[email protected]>Cc Alyssa Rosenzweig <[email protected]>Cc Andrew Jeffery <[email protected]>Cc Andrzej Hajda <[email protected]>Cc Anitha Chrisanthus <[email protected]>Cc Benjamin Gaignard <[email protected]>Cc Ben Skeggs <[email protected]>Cc Boris Brezillon <[email protected]>Cc Brian Starkey <[email protected]>Cc Chen Feng <[email protected]>Cc Chen-Yu Tsai <[email protected]>Cc Christian Gmeiner <[email protected]>Cc "Christian König" <[email protected]>Cc Chun-Kuang Hu <[email protected]>Cc Edmund Dea <[email protected]>Cc Eric Anholt <[email protected]>Cc Fabio Estevam <[email protected]>Cc Gerd Hoffmann <[email protected]>Cc Haneen Mohammed <[email protected]>Cc Hans de Goede <[email protected]>Cc "Heiko Stübner" <[email protected]>Cc Huang Rui <[email protected]>Cc Hyun Kwon <[email protected]>Cc Inki Dae <[email protected]>Cc Jani Nikula <[email protected]>Cc Jernej Skrabec <[email protected]>Cc Jerome Brunet <[email protected]>Cc Joel Stanley <[email protected]>Cc John Stultz <[email protected]>Cc Jonas Karlman <[email protected]>Cc Jonathan Hunter <[email protected]>Cc Joonas Lahtinen <[email protected]>Cc Joonyoung Shim <[email protected]>Cc Jyri Sarha <[email protected]>Cc Kevin Hilman <[email protected]>Cc Kieran Bingham <[email protected]>Cc Krzysztof Kozlowski <[email protected]>Cc Kyungmin Park <[email protected]>Cc Laurent Pinchart <[email protected]>Cc Linus Walleij <[email protected]>Cc Liviu Dudau <[email protected]>Cc Lucas Stach <[email protected]>Cc Ludovic Desroches <[email protected]>Cc Marek Vasut <[email protected]>Cc Martin Blumenstingl <[email protected]>Cc Matthias Brugger <[email protected]>Cc Maxime Coquelin <[email protected]>Cc Maxime Ripard <[email protected]>Cc Melissa Wen <[email protected]>Cc Neil Armstrong <[email protected]>Cc Nicolas Ferre <[email protected]>Cc "Noralf Trønnes" <[email protected]>Cc NXP Linux Team <[email protected]>Cc Oleksandr Andrushchenko <[email protected]>Cc Patrik Jakobsson <[email protected]>Cc Paul Cercueil <[email protected]>Cc Pekka Paalanen <[email protected]>Cc Pengutronix Kernel Team <[email protected]>Cc Philippe Cornu <[email protected]>Cc Philipp Zabel <[email protected]>Cc Qiang Yu <[email protected]>Cc Rob Clark <[email protected]>Cc Robert Foss <[email protected]>Cc Rob Herring <[email protected]>Cc Rodrigo Siqueira <[email protected]>Cc Rodrigo Vivi <[email protected]>Cc Roland Scheidegger <[email protected]>Cc Russell King <[email protected]>Cc Sam Ravnborg <[email protected]>Cc Sandy Huang <[email protected]>Cc Sascha Hauer <[email protected]>Cc Sean Paul <[email protected]>Cc Seung-Woo Kim <[email protected]>Cc Shawn Guo <[email protected]>Cc Simon Ser <[email protected]>Cc Stefan Agner <[email protected]>Cc Steven Price <[email protected]>Cc Sumit Semwal <[email protected]>Cc Thierry Reding <[email protected]>Cc Tian Tao <[email protected]>Cc Tomeu Vizoso <[email protected]>Cc Tomi Valkeinen <[email protected]>Cc VMware Graphics <[email protected]>Cc Xinliang Liu <[email protected]>Cc Xinwei Kong <[email protected]>Cc Yannick Fertre <[email protected]>Cc Zack Rusin <[email protected]>Reviewed-by Daniel Vetter <[email protected]>Signed-off-by Maxime Ripard <[email protected]>---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in CcChanges from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor nameChanges from v1:
- Typos and wording reported by Daniel and Alex--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)Documentation/gpu/drm-kms.rst +0
-0@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections.Documentation/gpu/drm-kms.rst KMS Properties · line 474
Quoted 10 lines
Documentation/gpu/drm-kms.rst +9
-0+Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used.Hi,
I might replace "some" with "full" documentation. Also not only how it can be used but also what it does.
FYI, some common things that tend to be forgotten IME:
- Spell out exactly the name string for the property in the documentation so that it is unambiguous what string userspace should look for.
- The same for string names of enum values.
- Explicitly document what each enum value means, do not trust that the value name describes it well enough.
- Explain how the property interacts with other, existing properties.Not sure if these should be written down here or anywhere though. Interaction with other properties is kind of important.
Documentation/gpu/drm-kms.rst KMS Properties · line 483
Quoted 9 lines
Documentation/gpu/drm-kms.rst +9
-0+ +- It must provide a generic helper in the core code to register that + property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable.Would it be too much to replace "where reasonable" with "if it is at all possible to write a test."?
Documentation/gpu/drm-kms.rst KMS Properties · line 484
Quoted 1 line
Documentation/gpu/drm-kms.rst +1
-0+How about adding the following somewhere?
- The initial state of the property (set during driver initialization) must match how the driver+hardware behaved before introducing this property. It may be some fixed value or it may be inherited from e.g. the firmware that booted the system. How the initial state is determined must also be documented, that is, where does it come from.
Quoted 3 lines
The initial state must not be called "default", because I want to reserve the term default for something else if possible: the phrase "reset everything to defaults", which is a whole another discussion.
I've taken into account your previous comments, thanks
Quoted 7 lines
How about also saying that fbcon/fbdev must set this property when taking over? That sounds to be like a common omission leading to funky KMS state in fbcon. The value fbdev sets it to only needs to make sense to fbdev, and it does not need to be ~~the initial value~~ nor the default value. Or are we hoping to kill fbcon in favor of a userspace kmscon soon? ;-)
Quoted 5 lines
Ooh, maybe the KMS property documentation should also say what value fbdev will set the property to. That's kind of UABI, because userspace probably implicitly relies on it in many cases. ...which means fbdev should set the property to its initial value, otherwise userspace will break.
Quoted 5 lines
I'm not sure about this one: fbdev and fbcon are still optional features of the kernel and can be disabled at the user discretion. Having any part of the user-space rely on the fbdev behavior seems a bit broken, especially when we have a mechanism to retrieve the state when the application starts.
Hi,
yes, exactly that is why fbdev/fbcon should reset the properties to their initial values. You would not want userspace inheriting a different KMS state with vs. without fbcon when it starts.
Retrieving the current KMS state is useless if the current KMS state is somehow wonky and the application does not understand that specific KMS property that is wonky. It cannot set the property to any value other than it already had without user intervention.
I'd say fbcon causing all KMS state to be reset is a quality of life thing. It's possible to live without by rebooting, but it would certainly make at least developers' and testers' life easier until we get the real "reset KMS" knob (which fbcon could then use too).
Besides, even if it is broken for userspace to rely on the KMS state set by fbcon/fbdev, userspace is already doing that and not on purpose because new KMS properties get added in the kernel. I would bet that there is not a single userspace program that would actually set all KMS properties that drivers might expose. So they are depending on inherited KMS state, which could be left by driver initialization, by fbdev/fbcon, or by any other userspace.
But yeah, this idea is something new, so don't let this discussion delay landing the docs.
Thanks,
pq
Quoted 47 lines · Pekka Paalanen
Quoted 41 lines
Quoted 22 lines
Documentation/gpu/drm-kms.rst KMS Properties · line 483
Quoted 8 lines
+- It must provide a generic helper in the core code to register that
Documentation/gpu/drm-kms.rst +7
-0+ property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable.Would it be too much to replace "where reasonable" with "if it is at all possible to write a test."?
Quoted 1 line
+
How about adding the following somewhere?
- The initial state of the property (set during driver initialization) must match how the driver+hardware behaved before introducing this property. It may be some fixed value or it may be inherited from e.g. the firmware that booted the system. How the initial state is determined must also be documented, that is, where does it come from.
Quoted 3 lines
The initial state must not be called "default", because I want to reserve the term default for something else if possible: the phrase "reset everything to defaults", which is a whole another discussion.
I've taken into account your previous comments, thanks
Quoted 7 lines
How about also saying that fbcon/fbdev must set this property when taking over? That sounds to be like a common omission leading to funky KMS state in fbcon. The value fbdev sets it to only needs to make sense to fbdev, and it does not need to be ~~the initial value~~ nor the default value. Or are we hoping to kill fbcon in favor of a userspace kmscon soon? ;-)
Quoted 5 lines
Ooh, maybe the KMS property documentation should also say what value fbdev will set the property to. That's kind of UABI, because userspace probably implicitly relies on it in many cases. ...which means fbdev should set the property to its initial value, otherwise userspace will break.
Quoted 5 lines
I'm not sure about this one: fbdev and fbcon are still optional features of the kernel and can be disabled at the user discretion. Having any part of the user-space rely on the fbdev behavior seems a bit broken, especially when we have a mechanism to retrieve the state when the application starts.
Quoted 3 lines
yes, exactly that is why fbdev/fbcon should reset the properties to their initial values. You would not want userspace inheriting a different KMS state with vs. without fbcon when it starts.
I'm not sure I'm following you when fbdev/fbcon should reset these properties. When a master takes over?
If we consider fbdev as any KMS client, isn't it a fundamental change with how it's currently done? I haven't seen anywhere that a compositor (or any client for that matter) should put the KMS device in the same state that it started it with. In case of a crash it would be fairly difficult to achieve.
Quoted 4 lines
Retrieving the current KMS state is useless if the current KMS state is somehow wonky and the application does not understand that specific KMS property that is wonky. It cannot set the property to any value other than it already had without user intervention.
Yeah, that's true. But the same could be said if you switch from one client to the other for example, at the moment there's no guarantee that the first one didn't change a property to a value you don't expect in the second. Unless we manage to tie that somehow to a first open of the device?
Quoted 13 lines
I'd say fbcon causing all KMS state to be reset is a quality of life thing. It's possible to live without by rebooting, but it would certainly make at least developers' and testers' life easier until we get the real "reset KMS" knob (which fbcon could then use too).
Besides, even if it is broken for userspace to rely on the KMS state set by fbcon/fbdev, userspace is already doing that and not on purpose because new KMS properties get added in the kernel. I would bet that there is not a single userspace program that would actually set all KMS properties that drivers might expose. So they are depending on inherited KMS state, which could be left by driver initialization, by fbdev/fbcon, or by any other userspace.
Quoted 2 lines
But yeah, this idea is something new, so don't let this discussion delay landing the docs.
Ack, I've sent a new version
Thanks!
Maxime
Quoted 48 lines · On Tue, 6 Jul 2021 18:42:41 +0200 Maxime Ripard <[email protected]> wrote:
Quoted 47 lines · Pekka Paalanen
Quoted 46 lines
Quoted 22 lines
Documentation/gpu/drm-kms.rst KMS Properties · line 483
Quoted 8 lines
+- It must provide a generic helper in the core code to register that
Documentation/gpu/drm-kms.rst +7
-0+ property on the object it attaches to. + +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable.Would it be too much to replace "where reasonable" with "if it is at all possible to write a test."?
Quoted 1 line
+
How about adding the following somewhere?
- The initial state of the property (set during driver initialization) must match how the driver+hardware behaved before introducing this property. It may be some fixed value or it may be inherited from e.g. the firmware that booted the system. How the initial state is determined must also be documented, that is, where does it come from.
Quoted 3 lines
The initial state must not be called "default", because I want to reserve the term default for something else if possible: the phrase "reset everything to defaults", which is a whole another discussion.
I've taken into account your previous comments, thanks
Quoted 7 lines
How about also saying that fbcon/fbdev must set this property when taking over? That sounds to be like a common omission leading to funky KMS state in fbcon. The value fbdev sets it to only needs to make sense to fbdev, and it does not need to be ~~the initial value~~ nor the default value. Or are we hoping to kill fbcon in favor of a userspace kmscon soon? ;-)
Quoted 5 lines
Ooh, maybe the KMS property documentation should also say what value fbdev will set the property to. That's kind of UABI, because userspace probably implicitly relies on it in many cases. ...which means fbdev should set the property to its initial value, otherwise userspace will break.
I'm not sure about this one: fbdev and fbcon are still optional features of the kernel and can be disabled at the user discretion. Having any part of the user-space rely on the fbdev behavior seems a bit broken, especially when we have a mechanism to retrieve the state when the application starts.
Quoted 6 lines
Quoted 3 lines
yes, exactly that is why fbdev/fbcon should reset the properties to their initial values. You would not want userspace inheriting a different KMS state with vs. without fbcon when it starts.
I'm not sure I'm following you when fbdev/fbcon should reset these properties. When a master takes over?
Hi,
when fbcon/fbdev takes over. If it doesn't reset things like GAMMA LUT, it's possible it won't be readable even though nothing fails.
(Let's say you fumble with an xrandr incantation and manage to set a LUT that turns everything into a single shade of green or something. How do you recover?)
When a userspace KMS client hands off to another userspace KMS client, fbcon/fbdev should not do anything. If it did, that would cause extra flicker.
I'm assuming fbcon/fbdev already implement all the necessary mechanisms, but they just don't poke at all the KMS properties necessary, as is evident from e.g. Michel Dänzer's testing seeing wrong colors in fbcon after a userspace KMS client changed GAMMA or DEGAMMA once.
Handling this properly would offer an escape hatch without reboot when something goes wrong in a display server. It's not a fix for userspace KMS client handing off to another userspace KMS client, for that we need something else.
Quoted 5 lines
If we consider fbdev as any KMS client, isn't it a fundamental change with how it's currently done? I haven't seen anywhere that a compositor (or any client for that matter) should put the KMS device in the same state that it started it with. In case of a crash it would be fairly difficult to achieve.
It has long been agreed IMO but never implemented anywhere AFAIK that a userspace KMS client should fully reset the whole KMS state to the KMS state it started with when it *comes back* after being switched away. I have talked with Daniel Vetter about this several times over the years. The problem with resetting the full KMS state is what to do with those KMS properties the KMS client does not understand but are exposed by the driver.
When a userspace KMS client switches out or quits, what is implemented and what should be implemented differs again. I believe that KMS clients of today do not change anything, so that the number of modesets is minimized. This is sufficient if the KMS client didn't use any less commonly used KMS properties. It's also consistent with crash behaviour.
If the KMS client wants to support seamless hand-off to another KMS client, the practical approach is "reset everything to the sane KMS state except keep the video mode" so that if the next KMS client doesn't understand everything, it still works. I don't know if display servers care to implement this, or do they just assume switching to another instance of themselves in which case they know what the next KMS client does. Or maybe the don't even use KMS properties others don't use too.
Btw. Xorg understands very few KMS properties by itself I think. It just exposes everything via RandR and assumes that whatever X11 clients are running, some of them will take care of the KMS properties. So one cannot look at Xorg as a single entity, one also needs to look at all the different desktop environments and whatever.
Another idea that has come up is that userspace should invent a KMS hand-off protocol completely in userspace. I'm not aware of anyone working on that. It would allow better smooth KMS hand-off between KMS clients, as the current and the next KMS client could negotiate about which KMS properties they understand and which need to be reset abruptly.
In any case, consensus seems to be that when a KMS client switches back in, there are no guarantees at all about the KMS state it inherits at that point. Therefore fbcon as a KMS client needs to reset everything. People just don't seem to care about fbcon working that much.
There is also the assumption that when a KMS client starts, the KMS state it inherits is... "reasonable". This should be true if the KMS state is the initial state chosen by a driver, and also if the state has been touched by fbcon, because it's not uncommon for fbcon to be up before the first KMS userspace client starts. But after the first KMS userspace client has started, all bets are practically off for the next KMS client starting.
Quoted 10 lines
Quoted 4 lines
Retrieving the current KMS state is useless if the current KMS state is somehow wonky and the application does not understand that specific KMS property that is wonky. It cannot set the property to any value other than it already had without user intervention.
Yeah, that's true. But the same could be said if you switch from one client to the other for example, at the moment there's no guarantee that the first one didn't change a property to a value you don't expect in the second. Unless we manage to tie that somehow to a first open of the device?
As I wrote above, yes, this is an open problem. Fbcon being just a KMS client needs a solution like all KMS clients. None of it is a regression per se, unless you see adding new KMS properties that provoke this problem more as a regression.
The idea I've been pondering about is a flag in atomic commit: instead of basing the changes on the current KMS state, start with "the default KMS state".
The definition of the default KMS state is tricky, because it should not depend on e.g. firmware. So it is not the same as the initial KMS state programmed in driver initialization. It needs to be defined separately and individually for each KMS property. In my opinion, the default KMS state should be defined as everything being off (planes, crtcs), disabled (dithering, HDR), pass-through/identity (GAMMA, DEGAMMA, CTM), "auto" where that applies and is the initial state, and so on. The goal is to make it as neutral and as "off" as possible while still giving good chances of letting the simpler KMS clients work correctly.
If there was a mechanism for this "reset to default", fbdev could just hit it.
There have been opinions that this problem does not need solving, because an average Linux user will never switch between arbitrary KMS clients. At most, they switch from bootsplash to a login manager, and then to a desktop compositor. Bootsplash won't change "advanced" KMS state, and the login manager's display server acts as the resetting entity as it is maintained to explicitly(?) support all the different desktops. If a desktop uses a new KMS property, the login manager is updated(?) to reset that property.
Hence I didn't go all the way suggesting in the rules that the default state needs to be defined.
And if fbcon is good to leave rotting, then no need to mention that either.
Quoted 13 lines
Quoted 13 lines
I'd say fbcon causing all KMS state to be reset is a quality of life thing. It's possible to live without by rebooting, but it would certainly make at least developers' and testers' life easier until we get the real "reset KMS" knob (which fbcon could then use too).
Besides, even if it is broken for userspace to rely on the KMS state set by fbcon/fbdev, userspace is already doing that and not on purpose because new KMS properties get added in the kernel. I would bet that there is not a single userspace program that would actually set all KMS properties that drivers might expose. So they are depending on inherited KMS state, which could be left by driver initialization, by fbdev/fbcon, or by any other userspace.
Quoted 4 lines
Quoted 2 lines
But yeah, this idea is something new, so don't let this discussion delay landing the docs.
Ack, I've sent a new version
Thank you!
pq
Quoted 138 lines · Maxime Ripard
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
Cc Alexandre Belloni <[email protected]>Cc Alexandre Torgue <[email protected]>Cc Alex Deucher <[email protected]>Cc Alison Wang <[email protected]>Cc Alyssa Rosenzweig <[email protected]>Cc Andrew Jeffery <[email protected]>Cc Andrzej Hajda <[email protected]>Cc Anitha Chrisanthus <[email protected]>Cc Benjamin Gaignard <[email protected]>Cc Ben Skeggs <[email protected]>Cc Boris Brezillon <[email protected]>Cc Brian Starkey <[email protected]>Cc Chen Feng <[email protected]>Cc Chen-Yu Tsai <[email protected]>Cc Christian Gmeiner <[email protected]>Cc "Christian König" <[email protected]>Cc Chun-Kuang Hu <[email protected]>Cc Edmund Dea <[email protected]>Cc Eric Anholt <[email protected]>Cc Fabio Estevam <[email protected]>Cc Gerd Hoffmann <[email protected]>Cc Haneen Mohammed <[email protected]>Cc Hans de Goede <[email protected]>Cc "Heiko Stübner" <[email protected]>Cc Huang Rui <[email protected]>Cc Hyun Kwon <[email protected]>Cc Inki Dae <[email protected]>Cc Jani Nikula <[email protected]>Cc Jernej Skrabec <[email protected]>Cc Jerome Brunet <[email protected]>Cc Joel Stanley <[email protected]>Cc John Stultz <[email protected]>Cc Jonas Karlman <[email protected]>Cc Jonathan Hunter <[email protected]>Cc Joonas Lahtinen <[email protected]>Cc Joonyoung Shim <[email protected]>Cc Jyri Sarha <[email protected]>Cc Kevin Hilman <[email protected]>Cc Kieran Bingham <[email protected]>Cc Krzysztof Kozlowski <[email protected]>Cc Kyungmin Park <[email protected]>Cc Laurent Pinchart <[email protected]>Cc Linus Walleij <[email protected]>Cc Liviu Dudau <[email protected]>Cc Lucas Stach <[email protected]>Cc Ludovic Desroches <[email protected]>Cc Marek Vasut <[email protected]>Cc Martin Blumenstingl <[email protected]>Cc Matthias Brugger <[email protected]>Cc Maxime Coquelin <[email protected]>Cc Maxime Ripard <[email protected]>Cc Melissa Wen <[email protected]>Cc Neil Armstrong <[email protected]>Cc Nicolas Ferre <[email protected]>Cc "Noralf Trønnes" <[email protected]>Cc NXP Linux Team <[email protected]>Cc Oleksandr Andrushchenko <[email protected]>Cc Patrik Jakobsson <[email protected]>Cc Paul Cercueil <[email protected]>Cc Pekka Paalanen <[email protected]>Cc Pengutronix Kernel Team <[email protected]>Cc Philippe Cornu <[email protected]>Cc Philipp Zabel <[email protected]>Cc Qiang Yu <[email protected]>Cc Rob Clark <[email protected]>Cc Robert Foss <[email protected]>Cc Rob Herring <[email protected]>Cc Rodrigo Siqueira <[email protected]>Cc Rodrigo Vivi <[email protected]>Cc Roland Scheidegger <[email protected]>Cc Russell King <[email protected]>Cc Sam Ravnborg <[email protected]>Cc Sandy Huang <[email protected]>Cc Sascha Hauer <[email protected]>Cc Sean Paul <[email protected]>Cc Seung-Woo Kim <[email protected]>Cc Shawn Guo <[email protected]>Cc Simon Ser <[email protected]>Cc Stefan Agner <[email protected]>Cc Steven Price <[email protected]>Cc Sumit Semwal <[email protected]>Cc Thierry Reding <[email protected]>Cc Tian Tao <[email protected]>Cc Tomeu Vizoso <[email protected]>Cc Tomi Valkeinen <[email protected]>Cc VMware Graphics <[email protected]>Cc Xinliang Liu <[email protected]>Cc Xinwei Kong <[email protected]>Cc Yannick Fertre <[email protected]>Cc Zack Rusin <[email protected]>Reviewed-by Daniel Vetter <[email protected]>Signed-off-by Maxime Ripard <[email protected]>---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in CcChanges from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor nameChanges from v1:
- Typos and wording reported by Daniel and Alex--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)Documentation/gpu/drm-kms.rst +12
-0@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections. +Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used. + +- It must provide a generic helper in the core code to register that + property on the object it attaches to.
Documentation/gpu/drm-kms.rst KMS Properties · line 487
Quoted 10 lines
Documentation/gpu/drm-kms.rst +7
-0+ +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable. + Property Types and Blob Property Support ----------------------------------------
Hi,
Regarding properties, we have a “case study example” related in a certain way to this documentation update :-)
The use case: on a front desk at an exhibition, there is a welcome screen you can touch for searching various information. When this welcome screen is in idle, a small logo is displayed at its center (around 20% of the fullscreen). The logo has a white background color. We want to reduce the ddr usage for lowering the power (the board is battery powered) so the idea is to use a white background color around this logo, produced by the drm CRTC so the image in ddr is only the size of the logo.
Reading the thread https://lists.freedesktop.org/archives/dri-devel/2019-October/239733.html dissuade us from coding a generic solution, so we started to implement a "STM_" private background color property, it works... but we are not at all convince this is the right way and we clearly prefer mainline/generic sw for both kernel & userland.
So now, what are our options... well, this v4 documentation update is I think clear enough: we have to document + provide a generic helper in the core code (similar to the original patch) + update IGT test, right?
Thanks
Philippe :-)
Note: It is really a pleasure to read such interesting thread, exposing the “complexity” of our job, dealing with various hw and sw... thank you to all of you.
Quoted 170 lines · Philippe CORNU
Quoted 136 lines · Maxime Ripard
New KMS properties come with a bunch of requirements to avoid each driver from running their own, inconsistent, set of properties, eventually leading to issues like property conflicts, inconsistencies between drivers and semantics, etc.
Let's document what we expect.
Cc Alexandre Belloni <[email protected]>Cc Alexandre Torgue <[email protected]>Cc Alex Deucher <[email protected]>Cc Alison Wang <[email protected]>Cc Alyssa Rosenzweig <[email protected]>Cc Andrew Jeffery <[email protected]>Cc Andrzej Hajda <[email protected]>Cc Anitha Chrisanthus <[email protected]>Cc Benjamin Gaignard <[email protected]>Cc Ben Skeggs <[email protected]>Cc Boris Brezillon <[email protected]>Cc Brian Starkey <[email protected]>Cc Chen Feng <[email protected]>Cc Chen-Yu Tsai <[email protected]>Cc Christian Gmeiner <[email protected]>Cc "Christian König" <[email protected]>Cc Chun-Kuang Hu <[email protected]>Cc Edmund Dea <[email protected]>Cc Eric Anholt <[email protected]>Cc Fabio Estevam <[email protected]>Cc Gerd Hoffmann <[email protected]>Cc Haneen Mohammed <[email protected]>Cc Hans de Goede <[email protected]>Cc "Heiko Stübner" <[email protected]>Cc Huang Rui <[email protected]>Cc Hyun Kwon <[email protected]>Cc Inki Dae <[email protected]>Cc Jani Nikula <[email protected]>Cc Jernej Skrabec <[email protected]>Cc Jerome Brunet <[email protected]>Cc Joel Stanley <[email protected]>Cc John Stultz <[email protected]>Cc Jonas Karlman <[email protected]>Cc Jonathan Hunter <[email protected]>Cc Joonas Lahtinen <[email protected]>Cc Joonyoung Shim <[email protected]>Cc Jyri Sarha <[email protected]>Cc Kevin Hilman <[email protected]>Cc Kieran Bingham <[email protected]>Cc Krzysztof Kozlowski <[email protected]>Cc Kyungmin Park <[email protected]>Cc Laurent Pinchart <[email protected]>Cc Linus Walleij <[email protected]>Cc Liviu Dudau <[email protected]>Cc Lucas Stach <[email protected]>Cc Ludovic Desroches <[email protected]>Cc Marek Vasut <[email protected]>Cc Martin Blumenstingl <[email protected]>Cc Matthias Brugger <[email protected]>Cc Maxime Coquelin <[email protected]>Cc Maxime Ripard <[email protected]>Cc Melissa Wen <[email protected]>Cc Neil Armstrong <[email protected]>Cc Nicolas Ferre <[email protected]>Cc "Noralf Trønnes" <[email protected]>Cc NXP Linux Team <[email protected]>Cc Oleksandr Andrushchenko <[email protected]>Cc Patrik Jakobsson <[email protected]>Cc Paul Cercueil <[email protected]>Cc Pekka Paalanen <[email protected]>Cc Pengutronix Kernel Team <[email protected]>Cc Philippe Cornu <[email protected]>Cc Philipp Zabel <[email protected]>Cc Qiang Yu <[email protected]>Cc Rob Clark <[email protected]>Cc Robert Foss <[email protected]>Cc Rob Herring <[email protected]>Cc Rodrigo Siqueira <[email protected]>Cc Rodrigo Vivi <[email protected]>Cc Roland Scheidegger <[email protected]>Cc Russell King <[email protected]>Cc Sam Ravnborg <[email protected]>Cc Sandy Huang <[email protected]>Cc Sascha Hauer <[email protected]>Cc Sean Paul <[email protected]>Cc Seung-Woo Kim <[email protected]>Cc Shawn Guo <[email protected]>Cc Simon Ser <[email protected]>Cc Stefan Agner <[email protected]>Cc Steven Price <[email protected]>Cc Sumit Semwal <[email protected]>Cc Thierry Reding <[email protected]>Cc Tian Tao <[email protected]>Cc Tomeu Vizoso <[email protected]>Cc Tomi Valkeinen <[email protected]>Cc VMware Graphics <[email protected]>Cc Xinliang Liu <[email protected]>Cc Xinwei Kong <[email protected]>Cc Yannick Fertre <[email protected]>Cc Zack Rusin <[email protected]>Reviewed-by Daniel Vetter <[email protected]>Signed-off-by Maxime Ripard <[email protected]>---
Changes from v3:
- Roll back to the v2
- Add Simon and Pekka in CcChanges from v2:
- Take into account the feedback from Laurent and Lidiu to no longer force generic properties, but prefix vendor-specific properties with the vendor nameChanges from v1:
- Typos and wording reported by Daniel and Alex--- Documentation/gpu/drm-kms.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)Documentation/gpu/drm-kms.rst +12
-0@@ -463,6 +463,25 @@ KMS Properties This section of the documentation is primarily aimed at user-space developers. For the driver APIs, see the other sections. +Requirements +------------ + +KMS drivers might need to add extra properties to support new features. +Each new property introduced in a driver need to meet a few +requirements, in addition to the one mentioned above.: + +- It must be standardized, with some documentation to describe how the + property can be used. + +- It must provide a generic helper in the core code to register that + property on the object it attaches to.Documentation/gpu/drm-kms.rst KMS Properties · line 486
Quoted 10 lines
Documentation/gpu/drm-kms.rst +7
-0+ +- Its content must be decoded by the core and provided in the object's + associated state structure. That includes anything drivers might want to + precompute, like :c:type:`struct drm_clip_rect <drm_clip_rect>` for planes. + +- An IGT test must be submitted where reasonable. + Property Types and Blob Property Support ----------------------------------------Hi,
Regarding properties, we have a “case study example” related in a certain way to this documentation update :-)
The use case: on a front desk at an exhibition, there is a welcome screen you can touch for searching various information. When this welcome screen is in idle, a small logo is displayed at its center (around 20% of the fullscreen). The logo has a white background color. We want to reduce the ddr usage for lowering the power (the board is battery powered) so the idea is to use a white background color around this logo, produced by the drm CRTC so the image in ddr is only the size of the logo.
Reading the thread
https://lists.freedesktop.org/archives/dri-devel/2019-October/239733.html
dissuade us from coding a generic solution, so we started to implement a "STM_" private background color property, it works... but we are not at all convince this is the right way and we clearly prefer mainline/generic sw for both kernel & userland.
Quoted 3 lines
So now, what are our options... well, this v4 documentation update is I think clear enough: we have to document + provide a generic helper in the core code (similar to the original patch) + update IGT test, right?
Yeah, also background color has been talked about for a while (lots of hw can do it), it's just that no one ever found a use-case to make the background somethign else than "black". There's a pile of drivers who could expose this, so definitely makes sense to have this generic. -Daniel
Quoted 9 lines
Thanks
Philippe :-)Note: It is really a pleasure to read such interesting thread, exposing the “complexity” of our job, dealing with various hw and sw... thank you to all of you.
Signature · 3 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch