drm/atomic: Expand atomic_create_state expectations for drm_private_obj

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>
Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>
Link: https://patch.msgid.link/20260526-drm-mode-config-init-v6-4-852346394200@kernel.org
Signed-off-by: Maxime Ripard <mripard@kernel.org>
This commit is contained in:
Maxime Ripard 2026-05-26 18:46:16 +02:00
parent dcf0292f48
commit bde05d3527
No known key found for this signature in database
GPG Key ID: 275FCE19A23DBE76

View File

@ -265,7 +265,10 @@ 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:
*