drm_atomic_h...rimary_plane(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

πŸŽ€ NAME πŸŽ€

okay so welcome to the Kernel API Manual bestie πŸ’– today's main character is drm_atomic_helper_check_crtc_primary_plane β€” and her whole job is checking CRTC state for the primary plane. that's it. that's the gig. πŸ‘‘


✨ SYNOPSIS ✨

int drm_atomic_helper_check_crtc_primary_plane (struct drm_crtc_state
*crtc_state );

like yes she's a function, yes she returns an int, no she's not complicated 🫢


🫢 ARGUMENTS 🫢

  • crtc_state β€” the CRTC state you want her to check, that's literally it, hand it over and let her cook πŸ“

πŸ’– DESCRIPTION πŸ’–

so what she does is she checks that a CRTC has at least one primary plane attached to it β€” which, fun fact, is a whole actual requirement on some hardware 😭 like some hardware simply will not function without it, no cap.

but here's the thing, and this is the important part bestie: this only involves the CRTC side of the test. that's all she does. she is not out here checking everything for you πŸ™ˆ

so if you actually want to test if the primary plane is visible, or if it can be updated without the CRTC being enabled, you gotta use drm_atomic_helper_check_plane_state in the plane's atomic check instead. different function, different vibe, iykyk πŸ’…


🌸 RETURN 🌸

  • 0 if a primary plane is attached to the CRTC πŸŽ‰ (slay)
  • an error code otherwise πŸ’€ (not slay, but at least you know)

πŸ¦‹ SEE ALSO πŸ¦‹

okay this list is LONG but every single one of them showed up so we're listing every single one of them, no skipping, we don't do that here ✨

yeah that's all of them. every single reference. we ate that list and left no crumbs πŸ”₯


and that's the whole page bestie!! 🧚 this little gem lives over in ./drivers/gpu/drm, dated October 2026, and it goes by the very dramatic name drm_atomic_h...rimary_plane(9) β€” yes the abbreviation is doing the most, no we don't know why, but she's iconic for it πŸ’œ mwah, bye!! πŸŽ€

πŸ“¦ where this page comes from