drm/atomic: Rework the object doc a bit
authorMaxime Ripard <mripard@kernel.org>
Thu, 14 Dec 2023 10:09:14 +0000 (11:09 +0100)
committerMaxime Ripard <mripard@kernel.org>
Mon, 18 Dec 2023 10:43:33 +0000 (11:43 +0100)
commit17beda5e951aac35fee26703719c252bb216b56b
tree4536fca0815ddd2cdcd1c54063bd579742bcffb2
parent786f6c2fa4ae3913f0fdcd371e871bd97aff8481
drm/atomic: Rework the object doc a bit

Commits 63e83c1dba54 ("drm: Consolidate connector arrays in
drm_atomic_state"), b8b5342b699b ("drm: Consolidate plane arrays in
drm_atomic_state") and 5d943aa6c0d4 ("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 b430c27a7de3 ("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 <sui.jingfeng@linux.dev>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://lore.kernel.org/r/20231214100917.277842-3-mripard@kernel.org
Signed-off-by: Maxime Ripard <mripard@kernel.org>
include/drm/drm_atomic.h