Skip to content
Snippets Groups Projects
Verified Commit 17beda5e authored by Maxime Ripard's avatar Maxime Ripard
Browse files

drm/atomic: Rework the object doc a bit


Commits 63e83c1d ("drm: Consolidate connector arrays in
drm_atomic_state"), b8b5342b ("drm: Consolidate plane arrays in
drm_atomic_state") and 5d943aa6 ("drm: Consolidate crtc arrays in
drm_atomic_state") moved the object pointer and their state pointer to
an intermediate structure storing both.

The CRTC commit didn't update the doc of the crtcs field to reflect
that, and the doc for the planes and connectors fields mention that they
are pointers to an array of structures with per-$OBJECT data.

The private_objs field was added later on by commit b430c27a ("drm:
Add driver-private objects to atomic state") reusing the same sentence
than the crtcs field, probably due to copy and paste.

While these fields are indeed pointers to an array, each item of that
array contain a pointer to the object structure affected by the update,
and its old and new state. There's no per-object data there, and there's
more than just a pointer to the objects.

Let's rephrase those fields a bit to better match the current situation.

Acked-by: Sui Jingfeng's avatarSui Jingfeng <sui.jingfeng@linux.dev>
Reviewed-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: https://lore.kernel.org/r/20231214100917.277842-3-mripard@kernel.org


Signed-off-by: Maxime Ripard's avatarMaxime Ripard <mripard@kernel.org>
parent 786f6c2f
No related branches found
No related tags found
No related merge requests found
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment