While the old and new state pointers are somewhat self-explanatory, the state pointer and its relation to the other two really isn't.
Now that we've cleaned up everything and it isn't used in any modesetting path, we can document what it's still useful for: to free the right state when we free the global state. Reviewed-by: Luca Ceresoli <[email protected]> Reviewed-by: Ville Syrjälä <[email protected]> Signed-off-by: Maxime Ripard <[email protected]> --- include/drm/drm_atomic.h | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h index 6b634b7474900d0d2bc51bd645ccedf718a1cb02..c8ab2163bf658cd06b12a8dabada7c088a328654 100644 --- a/include/drm/drm_atomic.h +++ b/include/drm/drm_atomic.h @@ -389,11 +389,27 @@ struct drm_private_state { struct drm_private_obj *obj; }; struct __drm_private_objs_state { struct drm_private_obj *ptr; - struct drm_private_state *state, *old_state, *new_state; + + /** + * @state: + * + * Used to track the @drm_private_state we will need to free + * when tearing down the associated &drm_atomic_state in + * $drm_mode_config_funcs.atomic_state_clear or + * drm_atomic_state_default_clear(). + * + * Before a commit, and the call to + * drm_atomic_helper_swap_state() in particular, it points to + * the same state than @new_state. After a commit, it points to + * the same state than @old_state. + */ + struct drm_private_state *state; + + struct drm_private_state *old_state, *new_state; }; /** * struct drm_atomic_state - Atomic commit structure * -- 2.51.0
