drm/plane: Extend damage tracking kernel-doc
authorJavier Martinez Canillas <javierm@redhat.com>
Thu, 23 Nov 2023 22:13:03 +0000 (23:13 +0100)
committerJavier Martinez Canillas <javierm@redhat.com>
Fri, 24 Nov 2023 14:15:29 +0000 (15:15 +0100)
commit017bdf8fa20175b9cccbc746122256432a599845
tree9f3214c07bc28aa30f3955740136cad4904f8d49
parentb83b2a80d662cc8ba9d78db64fb70fbb5a481d9c
drm/plane: Extend damage tracking kernel-doc

The "Damage Tracking Properties" section in the documentation doesn't have
info about the two type of damage handling: frame damage vs buffer damage.

Add it to the section and mention that helpers only support frame damage,
and how drivers handling buffer damage can indicate that the damage clips
should be ignored.

Also add references to further documentation about the two damage types.

Suggested-by: Simon Ser <contact@emersion.fr>
Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
Reviewed-by: Simon Ser <contact@emersion.fr>
Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>
Reviewed-by: Zack Rusin <zackr@vmware.com>
Acked-by: Sima Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20231123221315.3579454-5-javierm@redhat.com
drivers/gpu/drm/drm_plane.c