From: Maxime Ripard <mripard@kernel•org>
To: "Maarten Lankhorst" <maarten.lankhorst@linux•intel.com>,
"Thomas Zimmermann" <tzimmermann@suse•de>,
"David Airlie" <airlied@gmail•com>,
"Simona Vetter" <simona@ffwll•ch>,
"Jonathan Corbet" <corbet@lwn•net>,
"Shuah Khan" <skhan@linuxfoundation•org>,
"Dmitry Baryshkov" <dmitry.baryshkov@oss•qualcomm.com>,
"Jyri Sarha" <jyri.sarha@iki•fi>,
"Tomi Valkeinen" <tomi.valkeinen@ideasonboard•com>,
"Andrzej Hajda" <andrzej.hajda@intel•com>,
"Neil Armstrong" <neil.armstrong@linaro•org>,
"Robert Foss" <rfoss@kernel•org>,
"Laurent Pinchart" <Laurent.pinchart@ideasonboard•com>,
"Jonas Karlman" <jonas@kwiboo•se>,
"Jernej Skrabec" <jernej.skrabec@gmail•com>,
"Simon Ser" <contact@emersion•fr>,
"Harry Wentland" <harry.wentland@amd•com>,
"Melissa Wen" <mwen@igalia•com>,
"Sebastian Wick" <sebastian.wick@redhat•com>,
"Alex Hung" <alex.hung@amd•com>,
"Jani Nikula" <jani.nikula@linux•intel.com>,
"Rodrigo Vivi" <rodrigo.vivi@intel•com>,
"Joonas Lahtinen" <joonas.lahtinen@linux•intel.com>,
"Tvrtko Ursulin" <tursulin@ursulin•net>,
"Chen-Yu Tsai" <wens@kernel•org>,
"Samuel Holland" <samuel@sholland•org>,
"Dave Stevenson" <dave.stevenson@raspberrypi•com>,
"Maíra Canal" <mcanal@igalia•com>,
"Raspberry Pi Kernel Maintenance" <kernel-list@raspberrypi•com>
Cc: dri-devel@lists•freedesktop.org, linux-doc@vger•kernel.org,
linux-kernel@vger•kernel.org,
Daniel Stone <daniels@collabora•com>,
intel-gfx@lists•freedesktop.org, intel-xe@lists•freedesktop.org,
linux-arm-kernel@lists•infradead.org,
linux-sunxi@lists•linux.dev, Maxime Ripard <mripard@kernel•org>,
Laurent Pinchart <laurent.pinchart+renesas@ideasonboard•com>
Subject: [PATCH v5 04/19] drm/atomic: Expand atomic_create_state expectations for drm_private_obj
Date: Tue, 19 May 2026 11:01:46 +0200 [thread overview]
Message-ID: <20260519-drm-mode-config-init-v5-4-388b03321e38@kernel.org> (raw)
In-Reply-To: <20260519-drm-mode-config-init-v5-0-388b03321e38@kernel.org>
The atomic_create_state callback documentation for planes, CRTCs, and
connectors explicitly states the expected behaviour: the returned
state must not be assigned to the object's state pointer, and hardware
must not be touched.
The drm_private_state_funcs.atomic_create_state documentation is
missing this clarification. Add it for consistency.
Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard•com>
Signed-off-by: Maxime Ripard <mripard@kernel•org>
---
include/drm/drm_atomic.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h
index 1a80a8cdf269..88087910ab1a 100644
--- a/include/drm/drm_atomic.h
+++ b/include/drm/drm_atomic.h
@@ -263,11 +263,14 @@ struct drm_private_state;
struct drm_private_state_funcs {
/**
* @atomic_create_state:
*
* Allocates a pristine, initialized, state for the private
- * object and returns it.
+ * object and returns it. This callback must have no side
+ * effects: in particular, the returned state must not be
+ * assigned to the object's state pointer and it must not affect
+ * the hardware state.
*
* RETURNS:
*
* A new, pristine, private state instance or an error pointer
* on failure.
--
2.54.0
next prev parent reply other threads:[~2026-05-19 9:02 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-19 9:01 [PATCH v5 00/19] drm/atomic: Rework initial state allocation Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 01/19] drm/atomic: Document atomic commit lifetime Maxime Ripard
2026-05-26 8:59 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 02/19] drm/colorop: Fix typos in the doc Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 03/19] drm/atomic: Drop drm_private_obj.state assignment from create_state Maxime Ripard
2026-05-26 9:03 ` Thomas Zimmermann
2026-05-19 9:01 ` Maxime Ripard [this message]
2026-05-26 9:03 ` [PATCH v5 04/19] drm/atomic: Expand atomic_create_state expectations for drm_private_obj Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 05/19] drm/mode-config: Document drm_private_obj exclusion from drm_mode_config_reset() Maxime Ripard
2026-05-26 9:05 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 06/19] drm/colorop: Rename __drm_colorop_state_reset() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 07/19] drm/colorop: Create drm_atomic_helper_colorop_create_state() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 08/19] drm/atomic-state-helper: Fix __drm_atomic_helper_plane_reset() doc typo Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 09/19] drm/atomic-state-helper: Rename __drm_atomic_helper_plane_state_reset() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 10/19] drm/plane: Add new atomic_create_state callback Maxime Ripard
2026-05-26 9:08 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 11/19] drm/atomic-state-helper: Rename __drm_atomic_helper_crtc_state_reset() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 12/19] drm/crtc: Add new atomic_create_state callback Maxime Ripard
2026-05-26 9:22 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 13/19] drm/atomic-state-helper: Rename __drm_atomic_helper_connector_state_reset() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 14/19] drm/hdmi: Rename __drm_atomic_helper_connector_hdmi_reset() Maxime Ripard
2026-05-19 9:01 ` [PATCH v5 15/19] drm/connector: Add new atomic_create_state callback Maxime Ripard
2026-05-26 9:28 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 16/19] drm/mode-config: Create drm_mode_config_create_initial_state() Maxime Ripard
2026-05-26 9:33 ` Thomas Zimmermann
2026-05-19 9:01 ` [PATCH v5 17/19] drm/drv: Switch skeleton to drm_mode_config_create_initial_state() Maxime Ripard
2026-05-26 9:34 ` Thomas Zimmermann
2026-05-19 9:02 ` [PATCH v5 18/19] drm/tidss: Convert to atomic_create_state Maxime Ripard
2026-05-19 9:02 ` [PATCH v5 19/19] drm/bridge_connector: " Maxime Ripard
2026-05-26 9:36 ` [PATCH v5 00/19] drm/atomic: Rework initial state allocation Thomas Zimmermann
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=20260519-drm-mode-config-init-v5-4-388b03321e38@kernel.org \
--to=mripard@kernel$(echo .)org \
--cc=Laurent.pinchart@ideasonboard$(echo .)com \
--cc=airlied@gmail$(echo .)com \
--cc=alex.hung@amd$(echo .)com \
--cc=andrzej.hajda@intel$(echo .)com \
--cc=contact@emersion$(echo .)fr \
--cc=corbet@lwn$(echo .)net \
--cc=daniels@collabora$(echo .)com \
--cc=dave.stevenson@raspberrypi$(echo .)com \
--cc=dmitry.baryshkov@oss$(echo .)qualcomm.com \
--cc=dri-devel@lists$(echo .)freedesktop.org \
--cc=harry.wentland@amd$(echo .)com \
--cc=intel-gfx@lists$(echo .)freedesktop.org \
--cc=intel-xe@lists$(echo .)freedesktop.org \
--cc=jani.nikula@linux$(echo .)intel.com \
--cc=jernej.skrabec@gmail$(echo .)com \
--cc=jonas@kwiboo$(echo .)se \
--cc=joonas.lahtinen@linux$(echo .)intel.com \
--cc=jyri.sarha@iki$(echo .)fi \
--cc=kernel-list@raspberrypi$(echo .)com \
--cc=laurent.pinchart+renesas@ideasonboard$(echo .)com \
--cc=linux-arm-kernel@lists$(echo .)infradead.org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=linux-sunxi@lists$(echo .)linux.dev \
--cc=maarten.lankhorst@linux$(echo .)intel.com \
--cc=mcanal@igalia$(echo .)com \
--cc=mwen@igalia$(echo .)com \
--cc=neil.armstrong@linaro$(echo .)org \
--cc=rfoss@kernel$(echo .)org \
--cc=rodrigo.vivi@intel$(echo .)com \
--cc=samuel@sholland$(echo .)org \
--cc=sebastian.wick@redhat$(echo .)com \
--cc=simona@ffwll$(echo .)ch \
--cc=skhan@linuxfoundation$(echo .)org \
--cc=tomi.valkeinen@ideasonboard$(echo .)com \
--cc=tursulin@ursulin$(echo .)net \
--cc=tzimmermann@suse$(echo .)de \
--cc=wens@kernel$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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