[PATCH 1/3] drm: Update the DRM_IOCTL_MODE_CURSOR documentation

[Thomas Hellstrom]

Document that DRM_IOCTL_MODE_CURSOR needs to be called in order to
guarantee that the cursor bo contents is updated to the screen.
This was agreed upon on the DRI mailing list.

Signed-off-by: Thomas Hellstrom <thellstrom at vmware.com>
---
 include/drm/drm_mode.h |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/include/drm/drm_mode.h b/include/drm/drm_mode.h
index d30bedf..9006b93 100644
--- a/include/drm/drm_mode.h
+++ b/include/drm/drm_mode.h
@@ -291,6 +291,11 @@ struct drm_mode_mode_cmd {
  *    crtc
  *    x
  *    y
+ *
+ * The DRM_IOCTL_MODE_CURSOR ioctl needs to be called with the CURSOR_BO flag
+ * in order to guarantee that the cursor image is updated. The implementation
+ * is free to either update the cursor image when the bo contents change, or
+ * when the DRM_IOCTL_MODE_CURSOR ioctl is called.
  */
 struct drm_mode_cursor {
 	__u32 flags;
-- 
1.7.4.4