drm: Add drm_any_plane_has_format()

[mirror_ubuntu-jammy-kernel.git] / include / drm / drm_mode_config.h

diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
index d643d268693ee85e78874a3e3fd41de87b530bd3..5dbeabdbaf91f774c53c35588132835753e66827 100644 (file)
--- a/include/drm/drm_mode_config.h
+++ b/include/drm/drm_mode_config.h
@@ -52,6 +52,12 @@ struct drm_mode_config_funcs {
         * requested metadata, but most of that is left to the driver. See
         * &struct drm_mode_fb_cmd2 for details.
         *
+        * To validate the pixel format and modifier drivers can use
+        * drm_any_plane_has_format() to make sure at least one plane supports
+        * the requested values. Note that the driver must first determine the
+        * actual modifier used if the request doesn't have it specified,
+        * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0.
+        *
         * If the parameters are deemed valid and the backing storage objects in
         * the underlying memory manager all exist, then the driver allocates
         * a new &drm_framebuffer structure, subclassed to contain