drm_atomic_h...eanup_planes(9)

📦 version 7.3.1, in nixpkgs unstable

💅 drm_atomic_helper_cleanup_planes(9) — the Kernel API Manual glow-up ✨

okay bestie, buckle up, because this one is a little function with a big job. It's from the Linux Kernel API Manual, it lives in ./drivers/gpu/drm, and it is literally the cleanup crew that shows up after the atomic commit party is over. 🧹🎀

🌸 NAME 🌸

drm_atomic_helper_cleanup_planes — cleanup plane resources after commit 💖

✨ SYNOPSIS ✨

void drm_atomic_helper_cleanup_planes (struct drm_device *dev , struct
drm_atomic_commit *state );

like, that's the whole signature. short and iconic. 👑

🫶 ARGUMENTS 🫶

  • dev — the DRM device. your main character. 🖥️
  • state — the atomic state object that's being committed. the whole vibe of this operation lives in here. 🦋

💖 DESCRIPTION 💖

so what does this actually do? It cleans up plane state — and specifically framebuffers — from the old configuration. Note the word old, bestie, because it matters: the old configuration has to still be preserved in state for this function to even be callable. no old config, no cleanup. that's just the rules. 😭

and here's the part you cannot skip, fr fr:

This function may not be called on the new state when the atomic update fails at any point after calling drm_atomic_helper_prepare_planes. If your atomic update face-planted after that point, use drm_atomic_helper_unprepare_planes instead. no cap. 🚨

like, that's the whole trap. wrong helper, wrong state, and things get ugly. respect the prepare/unprepare pairing and you're golden. 🌈

🎀 SEE ALSO 🎀

the whole friend group 💅 — every single one, because they all hang out in ./drivers/gpu/drm/drm_atomic_helper.c (that's the kernel file overview, go read it, it ate):

okay that's the page!! 🍓 this little bundle of joy ships out of ./drivers/gpu/drm, dated October 2026, and yes the page title is still drm_atomic_h...eanup_planes(9) because the man page gods truncated it and we respect their choices. mwah 💋 stay clean, stay atomic, and don't forget to unprepare 🧚‍♀️✨

📦 where this page comes from