From: Emil Velikov <emil.velikov@collabora.com>
Date: Fri, 15 May 2020 09:50:45 +0000 (+0100)
Subject: drm/doc: add WARNING for drm_device::struct_mutex
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=e33f4234263da26154be0b1e5ffc7a2c5e52c3e3;p=linux.git

drm/doc: add WARNING for drm_device::struct_mutex

The mutex should be used, only by legacy drivers. Add a big warning to
deter people from using it.

Suggested-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
Link: https://patchwork.freedesktop.org/patch/msgid/20200515095118.2743122-6-emil.l.velikov@gmail.com
---

diff --git a/include/drm/drm_device.h b/include/drm/drm_device.h
index a55874db9dd44..0988351d743c4 100644
--- a/include/drm/drm_device.h
+++ b/include/drm/drm_device.h
@@ -146,6 +146,9 @@ struct drm_device {
 	 * @struct_mutex:
 	 *
 	 * Lock for others (not &drm_minor.master and &drm_file.is_master)
+	 *
+	 * WARNING:
+	 * Only drivers annotated with DRIVER_LEGACY should be using this.
 	 */
 	struct mutex struct_mutex;