Unverified Commit d0ac5722 authored by Maxime Ripard's avatar Maxime Ripard
Browse files

drm/todo: Add entry to rename drm_atomic_state 



The name of the structure drm_atomic_state is confusing. Let's add an
entry to our todo list to rename it.

Reviewed-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: https://lore.kernel.org/r/20231214100917.277842-5-mripard@kernel.org


Signed-off-by: default avatarMaxime Ripard <mripard@kernel.org>
parent ab9fabea

Documentation/gpu/todo.rst

+23 −0
Original line number Diff line number Diff line
@@ -120,6 +120,29 @@ Contact: Daniel Vetter, respective driver maintainers 


Level: Advanced



Rename drm_atomic_state

-----------------------



The KMS framework uses two slightly different definitions for the ``state``

concept. For a given object (plane, CRTC, encoder, etc., so

``drm_$OBJECT_state``), the state is the entire state of that object. However,

at the device level, ``drm_atomic_state`` refers to a state update for a

limited number of objects.



The state isn't the entire device state, but only the full state of some

objects in that device. This is confusing to newcomers, and

``drm_atomic_state`` should be renamed to something clearer like

``drm_atomic_commit``.



In addition to renaming the structure itself, it would also imply renaming some

related functions (``drm_atomic_state_alloc``, ``drm_atomic_state_get``,

``drm_atomic_state_put``, ``drm_atomic_state_init``,

``__drm_atomic_state_free``, etc.).



Contact: Maxime Ripard <mripard@kernel.org>



Level: Advanced



Fallout from atomic KMS

-----------------------