From: Pekka Paalanen <ppaalanen@gmail.com>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: "Haneen Mohammed" <hamohammed.sa@gmail.com>,
"Alexandre Belloni" <alexandre.belloni@bootlin.com>,
linux-doc@vger.kernel.org, "David Airlie" <airlied@linux.ie>,
"Daniel Vetter" <daniel.vetter@ffwll.ch>,
"Edmund Dea" <edmund.j.dea@intel.com>,
"Alexandre Torgue" <alexandre.torgue@foss.st.com>,
dri-devel@lists.freedesktop.org,
"Russell King" <linux@armlinux.org.uk>,
"Melissa Wen" <melissa.srw@gmail.com>,
"Eric Anholt" <eric@anholt.net>,
"Thierry Reding" <thierry.reding@gmail.com>,
"Laurent Pinchart" <Laurent.pinchart@ideasonboard.com>,
"Benjamin Gaignard" <benjamin.gaignard@linaro.org>,
"Anitha Chrisanthus" <anitha.chrisanthus@intel.com>,
"Daniel Vetter" <daniel.vetter@intel.com>,
"Steven Price" <steven.price@arm.com>,
"Sam Ravnborg" <sam@ravnborg.org>,
"Jyri Sarha" <jyri.sarha@iki.fi>,
"Jerome Brunet" <jbrunet@baylibre.com>,
"Paul Cercueil" <paul@crapouillou.net>,
"Marek Vasut" <marex@denx.de>,
"Joonyoung Shim" <jy0922.shim@samsung.com>,
"Qiang Yu" <yuq825@gmail.com>,
"Krzysztof Kozlowski" <krzysztof.kozlowski@canonical.com>,
"Kevin Hilman" <khilman@baylibre.com>,
"Tomi Valkeinen" <tomba@kernel.org>,
"Neil Armstrong" <narmstrong@baylibre.com>,
"Alyssa Rosenzweig" <alyssa.rosenzweig@collabora.com>,
"Xinwei Kong" <kong.kongxinwei@hisilicon.com>,
"Jonathan Hunter" <jonathanh@nvidia.com>,
"Xinliang Liu" <xinliang.liu@linaro.org>,
"Ludovic Desroches" <ludovic.desroches@microchip.com>,
"Kieran Bingham" <kieran.bingham+renesas@ideasonboard.com>,
"VMware Graphics" <linux-graphics-maintainer@vmware.com>,
"NXP Linux Team" <linux-imx@nxp.com>,
"Chen Feng" <puck.chen@hisilicon.com>,
"Liviu Dudau" <liviu.dudau@arm.com>,
"Ben Skeggs" <bskeggs@redhat.com>,
"Chun-Kuang Hu" <chunkuang.hu@kernel.org>,
"Pengutronix Kernel Team" <kernel@pengutronix.de>,
"Jonas Karlman" <jonas@kwiboo.se>,
"Martin Blumenstingl" <martin.blumenstingl@googlemail.com>,
"Roland Scheidegger" <sroland@vmware.com>,
"Sascha Hauer" <s.hauer@pengutronix.de>,
"Alison Wang" <alison.wang@nxp.com>,
"Andrzej Hajda" <a.hajda@samsung.com>,
"Hans de Goede" <hdegoede@redhat.com>,
"Maxime Ripard" <maxime@cerno.tech>,
"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
"Matthias Brugger" <matthias.bgg@gmail.com>,
"Nicolas Ferre" <nicolas.ferre@microchip.com>,
"Chen-Yu Tsai" <wens@csie.org>, "Sean Paul" <sean@poorly.run>,
"Maxime Coquelin" <mcoquelin.stm32@gmail.com>,
"Jernej Skrabec" <jernej.skrabec@siol.net>,
"Rodrigo Siqueira" <rodrigosiqueiramelo@gmail.com>,
"Hyun Kwon" <hyun.kwon@xilinx.com>,
"Boris Brezillon" <bbrezillon@kernel.org>,
"Andrew Jeffery" <andrew@aj.id.au>,
"Huang Rui" <ray.huang@amd.com>,
"Yannick Fertre" <yannick.fertre@foss.st.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Seung-Woo Kim" <sw0312.kim@samsung.com>,
"Sandy Huang" <hjc@rock-chips.com>,
"Robert Foss" <robert.foss@linaro.org>,
"Tomeu Vizoso" <tomeu.vizoso@collabora.com>,
"Kyungmin Park" <kyungmin.park@samsung.com>,
"Noralf Trønnes" <noralf@tronnes.org>,
"Philippe Cornu" <philippe.cornu@foss.st.com>,
"Thomas Zimmermann" <tzimmermann@suse.de>,
"Alex Deucher" <alexander.deucher@amd.com>,
"Tian Tao" <tiantao6@hisilicon.com>,
"Oleksandr Andrushchenko" <oleksandr_andrushchenko@epam.com>,
"Shawn Guo" <shawnguo@kernel.org>,
"Christian König" <christian.koenig@amd.com>,
"Gerd Hoffmann" <kraxel@redhat.com>
Subject: Re: [PATCH v5] Documentation: gpu: Mention the requirements for new properties
Date: Fri, 9 Jul 2021 12:08:14 +0300 [thread overview]
Message-ID: <20210709120814.48a90aa1@eldfell> (raw)
In-Reply-To: <YOgClII3UwckkPkb@phenom.ffwll.local>
[-- Attachment #1: Type: text/plain, Size: 4136 bytes --]
On Fri, 9 Jul 2021 10:02:28 +0200
Daniel Vetter <daniel@ffwll.ch> wrote:
> On Fri, Jul 09, 2021 at 10:24:44AM +0300, Pekka Paalanen wrote:
> > On Tue, 6 Jul 2021 18:12:44 +0200
> > Maxime Ripard <maxime@cerno.tech> 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.
> >
> > ...
> >
> > > Changes from v4:
> > > - Changes suggested by Pekka
> > >
> > > 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 | 30 ++++++++++++++++++++++++++++++
> > > 1 file changed, 30 insertions(+)
> > >
> > > diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> > > index 87e5023e3f55..47994890fd1e 100644
> > > --- a/Documentation/gpu/drm-kms.rst
> > > +++ b/Documentation/gpu/drm-kms.rst
> > > @@ -463,6 +463,36 @@ 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, documenting:
> > > +
> > > + * The full, exact, name string;
> > > + * If the property is an enum, all the valid variants name;
> >
> > Hi,
> >
> > "variant" feels a little off to me, I would have used "value name
> > strings".
> >
> > > + * What values are accepted, and what these values mean;
> > > + * What the property does and how it can be used;
> > > + * How the property might interact with other, existing properties.
> > > +
> > > +* 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.
> > > +
> > > +* Its initial state must match the behavior prior to the property
> > > + introduction. This might be a fixed value matching what the hardware
> > > + does, or it may be inherited from the state the firmware left the
> > > + system in during boot.
> >
> > I'd like to point out that this rule should apply also to
> > properties that already exist in general, but are newly exposed in a
> > driver for hardware that didn't expose the property before.
>
> I think we should just make this a very strong recommendation, and in
> general encourage people to use the tests against their driver?
>
> Otherwise a small "I'll just enable this" thing can become a huge project.
> And in general I think grandfathering existing things in is the pragmatic
> choice.
>
> But maybe that could be a follow-up patch?
Sure, I don't mind. Just saying now that it came to mind. Drivers do
not arbitrarily change behaviour without exposing more properties
either, right?
Thanks,
pq
> -Daniel
>
> >
> > > +
> > > +* An IGT test must be submitted where reasonable.
> > > +
> > > Property Types and Blob Property Support
> > > ----------------------------------------
> > >
> >
> > Regardless of my comments above:
> >
> > Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.com>
> >
> >
> > Thanks,
> > pq
>
>
>
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2021-07-09 9:08 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-06 16:12 [PATCH v5] Documentation: gpu: Mention the requirements for new properties Maxime Ripard
2021-07-06 21:56 ` Daniel Vetter
2021-07-09 7:24 ` Pekka Paalanen
2021-07-09 8:02 ` Daniel Vetter
2021-07-09 9:08 ` Pekka Paalanen [this message]
2021-07-12 14:07 ` Daniel Vetter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210709120814.48a90aa1@eldfell \
--to=ppaalanen@gmail.com \
--cc=Laurent.pinchart@ideasonboard.com \
--cc=a.hajda@samsung.com \
--cc=airlied@linux.ie \
--cc=alexander.deucher@amd.com \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandre.torgue@foss.st.com \
--cc=alison.wang@nxp.com \
--cc=alyssa.rosenzweig@collabora.com \
--cc=andrew@aj.id.au \
--cc=anitha.chrisanthus@intel.com \
--cc=bbrezillon@kernel.org \
--cc=benjamin.gaignard@linaro.org \
--cc=bskeggs@redhat.com \
--cc=christian.koenig@amd.com \
--cc=chunkuang.hu@kernel.org \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=daniel.vetter@intel.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=edmund.j.dea@intel.com \
--cc=eric@anholt.net \
--cc=hamohammed.sa@gmail.com \
--cc=hdegoede@redhat.com \
--cc=hjc@rock-chips.com \
--cc=hyun.kwon@xilinx.com \
--cc=jbrunet@baylibre.com \
--cc=jernej.skrabec@siol.net \
--cc=jonas@kwiboo.se \
--cc=jonathanh@nvidia.com \
--cc=jy0922.shim@samsung.com \
--cc=jyri.sarha@iki.fi \
--cc=kernel@pengutronix.de \
--cc=khilman@baylibre.com \
--cc=kieran.bingham+renesas@ideasonboard.com \
--cc=kong.kongxinwei@hisilicon.com \
--cc=kraxel@redhat.com \
--cc=krzysztof.kozlowski@canonical.com \
--cc=kyungmin.park@samsung.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-graphics-maintainer@vmware.com \
--cc=linux-imx@nxp.com \
--cc=linux@armlinux.org.uk \
--cc=liviu.dudau@arm.com \
--cc=ludovic.desroches@microchip.com \
--cc=marex@denx.de \
--cc=martin.blumenstingl@googlemail.com \
--cc=matthias.bgg@gmail.com \
--cc=maxime@cerno.tech \
--cc=mcoquelin.stm32@gmail.com \
--cc=melissa.srw@gmail.com \
--cc=narmstrong@baylibre.com \
--cc=nicolas.ferre@microchip.com \
--cc=noralf@tronnes.org \
--cc=oleksandr_andrushchenko@epam.com \
--cc=paul@crapouillou.net \
--cc=philippe.cornu@foss.st.com \
--cc=puck.chen@hisilicon.com \
--cc=ray.huang@amd.com \
--cc=robert.foss@linaro.org \
--cc=rodrigo.vivi@intel.com \
--cc=rodrigosiqueiramelo@gmail.com \
--cc=s.hauer@pengutronix.de \
--cc=sam@ravnborg.org \
--cc=sean@poorly.run \
--cc=shawnguo@kernel.org \
--cc=sroland@vmware.com \
--cc=steven.price@arm.com \
--cc=sw0312.kim@samsung.com \
--cc=thierry.reding@gmail.com \
--cc=tiantao6@hisilicon.com \
--cc=tomba@kernel.org \
--cc=tomeu.vizoso@collabora.com \
--cc=tzimmermann@suse.de \
--cc=wens@csie.org \
--cc=xinliang.liu@linaro.org \
--cc=yannick.fertre@foss.st.com \
--cc=yuq825@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).