drm: Updated documentation regarding atomic_check

Commit Message

Stanislav Lisovskiy Feb. 18, 2019, 8:41 a.m. UTC

According to documentation, currently atomic_check hook
can't return -ERANGE and -ENOSPC, which is wrong as in
reality it does(from drm_atomic_plane_check). This caused
some issues and wrong assumptions in some IGT test cases
(see fdo#109225).
Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=109225
Signed-off-by: Stanislav Lisovskiy <[e-mail]>
---
 include/drm/drm_mode_config.h | 4 ++++
 1 file changed, 4 insertions(+)

Patch

diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
index 1e6cb885994d..b817dadf8544 100644
--- a/include/drm/drm_mode_config.h
+++ b/include/drm/drm_mode_config.h
@@ -187,11 +187,15 @@  struct drm_mode_config_funcs {
 	 *  - -ENOMEM, if allocating additional state sub-structures failed due
 	 *    to lack of memory.
 	 *
+	 *  - -ENOSPC, if plane source coordinates are outside of the framebuffer.
+	 *
 	 *  - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
 	 *    This can either be due to a pending signal, or because the driver
 	 *    needs to completely bail out to recover from an exceptional
 	 *    situation like a GPU hang. From a userspace point all errors are
 	 *    treated equally.
+	 *
+	 *  - -ERANGE, if plane coordinates are bigger than INT_MAX.
 	 */
 	int (*atomic_check)(struct drm_device *dev,
 			    struct drm_atomic_state *state);