drmm_universal_plane_alloc(9)

🦋 drmm_universal_plane_alloc(9) 🦋

okay so hiii bestie 🫶 — this is the Kernel API Manual page for drmm_universal_plane_alloc(9). it's giving “allocate and initialize an universal plane object,” and the cleanup situation is honestly iconic. let's get into it. 💅

---

💖 NAME 💖

drmm_universal_plane_alloc — allocate and initialize an universal plane object ✨

🌸 SYNOPSIS 🌸

drmm_universal_plane_alloc (dev , type , member , possible_crtcs , funcs
, formats , format_count , format_modifiers , plane_type , name , ... );

✨ ARGUMENTS ✨

• dev — DRM device 🖥️
• type — the type of the struct which contains struct drm_plane
• member — the name of the drm_plane within type
• possible_crtcs — bitmask of possible CRTCs
• funcs — callbacks for the new plane
• formats — array of supported formats (DRM_FORMAT_ — yes, exactly like that on the page, bestie 😭
• format_count — number of elements in formats
• format_modifiers — array of struct drm_format modifiers terminated by DRM_FORMAT_MOD_INVALID
• plane_type — type of plane (overlay, primary, cursor)
• name — printf style format string for the plane name, or NULL for default name
• ... — variable arguments

🌈 DESCRIPTION 🌈

this one allocates and initializes a plane object of type type. cleanup is automatically handled through registering drm_plane_cleanup with drmm_add_action — so you don't have to manually do the goodbye dance, bestie. 💅

🚨 drm_plane_funcs.destroy must be NULL. like, hard requirement. no cap.

drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set format_modifiers to NULL. when that happens, the plane will advertise the linear modifier. ✨

👑 RETURN 👑

pointer to new plane, or ERR_PTR on failure. that's the whole tea. if it works you get a plane; if not, error pointer. 💀

🎀 SEE ALSO 🎀

kernel file: ./include/drm/drm_plane.h — and the whole reference squad is:

• struct drm_plane_state(9)
• struct drm_plane_funcs(9)
• enum drm_plane_type(9)
• struct drm_plane(9)
• drm_universal_plane_alloc(9)
• drm_plane_index(9)
• drm_plane_mask(9)
• drm_plane_find(9)
• drm_for_each_plane_mask(9)
• drm_for_each_legacy_plane(9)
• drm_for_each_plane(9)

---

and that's the page, bestie 🫶 — source ./include/drm, dated October 2026, and it's all about drmm_universal_plane_alloc(9). periodt. 💅✨