STRUCT VKMS_CONFIG_PLANE(9)

📦 version 7.3.1, in nixpkgs unstable

🦋 struct vkms_config_plane(9) 🦋

okay so bestie, we're in the Kernel API Manual and this is the page for struct vkms_config_plane(9) — aka the little config struct that keeps track of a VKMS plane before it becomes a whole real plane. it's giving "backstage pass" energy, fr fr. let's get into it 💅

🌸 NAME 🌸

struct vkms_config_plane — and the original NAME line is literally just the struct name with a dash and no blurb, so we're not gonna invent one. iconic minimalism, honestly. ✨

✨ SYNOPSIS ✨

struct vkms_config_plane {
    struct list_head link;
    struct vkms_config *config;
    enum drm_plane_type type;
    struct xarray possible_crtcs;
    bool default_pipeline;
    struct vkms_plane *plane;
 };

💅 Members 💅

  • link — the link to the other planes in vkms_config. it's how this plane hangs out with its plane friends in the list 💖
  • config — the vkms_config that this plane belongs to. its home base, its main character config, if you will.
  • type — the type of the plane. heads up: the creator of the configuration needs to ensure that at least one primary plane is present. like, that's a you problem, not a struct problem. don't forget it 🫶
  • possible_crtcs — an array of CRTCs that can be used with this plane. it's the plane's approved CRTC roster 🌈
  • default_pipeline — okay so this field is right there in the struct, but the manpage itself does not give it a member description. not me noticing the missing blurb 😭 it's in the synopsis, and that's the whole story on this page.
  • plane — internal usage. this pointer should never be considered as valid. it can be used to store a temporary reference to a VKMS plane during device creation. it is not managed by the configuration and must be managed by other means. so like... don't trust it, don't adopt it, don't expect the config to take it to soccer practice. periodt 💀
bestie warning: plane is internal-use-only and never valid to just casually rely on. temporary reference during device creation, that's it. managing it is somebody else's job, no cap.

🦋 SEE ALSO 🦋

and that's the whole vibe check, bestie 🎀 this page came from the ./drivers/gpu/drm/vkms corner of the kernel, dated October 2026, and it's living under the Kernel API Manual umbrella. go forth and configure your planes responsibly 💜✨

📦 where this page comes from