Merge tag 'linux-watchdog-5.5-rc1' of git://www.linux-watchdog.org/linux-watchdog

[linux.git] / include / drm / drm_plane.h

diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
index cd5903ad33f7e379a9f8a5df5f9541e4bcdcc2f5..3f396d94afe407abd1bb0690bcb06fc7ebeffa3a 100644 (file)
--- a/include/drm/drm_plane.h
+++ b/include/drm/drm_plane.h
@@ -140,10 +140,11 @@ struct drm_plane_state {
         * @zpos:
         * Priority of the given plane on crtc (optional).
         *
-        * Note that multiple active planes on the same crtc can have an
-        * identical zpos value. The rule to solving the conflict is to compare
-        * the plane object IDs; the plane with a higher ID must be stacked on
-        * top of a plane with a lower ID.
+        * User-space may set mutable zpos properties so that multiple active
+        * planes on the same CRTC have identical zpos values. This is a
+        * user-space bug, but drivers can solve the conflict by comparing the
+        * plane object IDs; the plane with a higher ID is stacked on top of a
+        * plane with a lower ID.
         *
         * See drm_plane_create_zpos_property() and
         * drm_plane_create_zpos_immutable_property() for more details.
@@ -183,8 +184,26 @@ struct drm_plane_state {
         */
        struct drm_property_blob *fb_damage_clips;
 
-       /** @src: clipped source coordinates of the plane (in 16.16) */
-       /** @dst: clipped destination coordinates of the plane */
+       /**
+        * @src:
+        *
+        * source coordinates of the plane (in 16.16).
+        *
+        * When using drm_atomic_helper_check_plane_state(),
+        * the coordinates are clipped, but the driver may choose
+        * to use unclipped coordinates instead when the hardware
+        * performs the clipping automatically.
+        */
+       /**
+        * @dst:
+        *
+        * clipped destination coordinates of the plane.
+        *
+        * When using drm_atomic_helper_check_plane_state(),
+        * the coordinates are clipped, but the driver may choose
+        * to use unclipped coordinates instead when the hardware
+        * performs the clipping automatically.
+        */
        struct drm_rect src, dst;
 
        /**