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 a55874db9dd446d896476c3f0d429fc24ad6abe0..0988351d743c446454a7bfb4e1a35158afabb955 100644 (file)
--- 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;