drm_atomic_h...setup_commit(9)

📦 version 7.3.1, in nixpkgs unstable

✨ drm_atomic_helper_setup_commit(9) ✨

okay bestie, welcome to the Kernel API Manual 💖 this one's all about drm_atomic_helper_setup_commit — setup for a possibly nonblocking commit. slay.

🌸 NAME 🌸

drm_atomic_helper_setup_commit — setup possibly nonblocking commit. yes literally that's the whole vibe.

🦋 SYNOPSIS 🦋

int drm_atomic_helper_setup_commit (struct drm_atomic_commit *state ,
bool nonblock );

🎀 ARGUMENTS 🎀

  • state — the new modeset state that's finna be committed.
  • nonblock — whether nonblocking behavior is requested. like, do you want it async or not, queen?

💅 DESCRIPTION 💅

okay so this function prepares state to be used by the atomic helper's support for nonblocking commits. drivers that are using the nonblocking commit infrastructure should always call this function from their drm_mode_config_funcs.atomic_commit hook. always always, no cap 🙏

drivers that need to extend the commit setup to private objects can use the drm_mode_config_helper_funcs.atomic_commit_setup hook. icon behavior.

to be able to use this support, drivers need to use a few more helper functions. drm_atomic_helper_wait_for_dependencies must be called before actually committing the hardware state, and for nonblocking commits this call must be placed in the async worker. also see drm_atomic_helper_swap_state and its stall parameter — that's for when a driver's commit hooks look at the drm_crtc.state, drm_plane.state or drm_connector.state pointer directly. iykyk.

completion of the hardware commit step must be signalled using drm_atomic_helper_commit_hw_done. after this step the driver is not allowed to read or change any permanent software or hardware modeset state. the only exception is state protected by other means than drm_modeset_lock locks. only the free standing state with pointers to the old state structures can be inspected, e.g. to clean up old buffers using drm_atomic_helper_cleanup_planes.

at the very end, before cleaning up state, drivers must call drm_atomic_helper_commit_cleanup_done. don't skip it bestie 😭

this is all implemented by in drm_atomic_helper_commit, giving drivers a complete and easy-to-use default implementation of the atomic_commit hook. it's giving "built-in bestie."

the tracking of asynchronously executed and still pending commits is done using the core structure drm_crtc_commit. love that for us.

by default there's no need to clean up resources allocated by this function explicitly: drm_atomic_commit_default_clear will take care of that automatically. she handles it 💅

🔥 RETURN 🔥

  • 0 on success, periodt.
  • -EBUSY when userspace schedules nonblocking commits too fast (slow down babes)
  • -ENOMEM on allocation failures
  • -EINTR when a signal is pending

🌈 SEE ALSO 🌈

and that's the tea, bestie 🫶 this lil page lives at ./drivers/gpu/drm, dated October 2026, and the header at the top is literally just drm_atomic_h...setup_commit(9) again. mwah 💋 go commit something iconic.

📦 where this page comes from