vmw_cursor_plane_cleanup_fb(9)

💅 vmw_cursor_plane_cleanup_fb(9) — from the Kernel API Manual, bestie 🎀

okay so picture this: you're deep in the kernel, in the vmwgfx corner of the DRM world, and somebody hands you a cursor plane that needs its post-atomic glow-up cleaned away. that's this function. it's the cleanup girlie. she tidies up after the party. ✨

---

✨ NAME ✨

vmw_cursor_plane_cleanup_fb — literally just unpins the plane surface. that's the whole job. no cap. 🫶

---

🌸 SYNOPSIS 🌸

void vmw_cursor_plane_cleanup_fb (struct drm_plane *plane , struct
       drm_plane_state *old_state );

note the void bestie — she does not return a value in the signature, we'll get to that little plot twist in a sec 👀

---

🦋 ARGUMENTS 🦋

• plane — the cursor plane. that's her. main character. 💅
• old_state — contains the state to clean up. the filler episode state you're about to throw away. 🗑️

---

💖 DESCRIPTION 💖

okay so what does she actually do? two things, and they're both exactly what the name promises:

• Unmaps all cursor bo mappings 🔥
• Unpins the cursor surface 📌➡️🚫

that's it. that's the function. she unmaps and she unpins and she leaves. iconic behaviour honestly.

and then — and this is the part where I need you to just go with it — it says:

Returns 0 on success 😭

yes bestie, even though the return type is void. that's what the page says, so that's what I'm telling you. don't @ me, I don't write the kernel docs, I just vibe with them. 🙈

---

👑 SEE ALSO 👑

• Kernel file: ./drivers/gpu/drm/vmwgfx/vmwgfx_cursor_plane.c — go read the source, it's giving lore ⭐
• vmw_send_define_cursor_cmd(9)
• vmw_cursor_mob_unmap(9)
• vmw_cursor_mob_map(9)
• vmw_cursor_plane_prepare_fb(9)
• vmw_cursor_plane_atomic_check(9)

the whole cursor plane friend group, fr fr. go say hi to all of them. 🌈

---

mwah 💋 that's the page. shipped from ./drivers/gpu/drm/vmwgfx, dated October 2026, in the Kernel API Manual — the vmw_cursor_plane_cleanup_fb(9) entry, now with 100% more sparkle and 0% fewer facts. bye bestie, go unpin something 🧚💜