drm: Extract drm_mode_config.[hc]
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Mon, 14 Nov 2016 11:58:23 +0000 (12:58 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 15 Nov 2016 14:23:29 +0000 (15:23 +0100)
And shuffle the kernel-doc structure a bit since drm_crtc.[hc] now
only contains CRTC-related functions and structures.

v2:
- rebase onto drm-misc
- don't forget to move drm_mode_config_cleanup.
- move 2 internal decls under the right heading (Chris)

Reviewed-by: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Documentation/gpu/drm-kms.rst
drivers/gpu/drm/Makefile
drivers/gpu/drm/drm_crtc.c
drivers/gpu/drm/drm_crtc_internal.h
drivers/gpu/drm/drm_mode_config.c [new file with mode: 0644]
include/drm/drm_crtc.h
include/drm/drm_mode_config.h [new file with mode: 0644]

index 4edfb6d912501d9e4019d2edb11c6cefafabc2ef..a8ff2c87c0e9bed0e700b10ff5cf9f5e9dcc19b6 100644 (file)
@@ -15,25 +15,24 @@ be setup by initializing the following fields.
 -  struct drm_mode_config_funcs \*funcs;
    Mode setting functions.
 
-Modeset Base Object Abstraction
-===============================
+Mode Configuration
 
-.. kernel-doc:: include/drm/drm_mode_object.h
-   :internal:
+KMS Core Structures and Functions
+=================================
 
-.. kernel-doc:: drivers/gpu/drm/drm_mode_object.c
+.. kernel-doc:: drivers/gpu/drm/drm_mode_config.c
    :export:
 
-KMS Data Structures
-===================
-
-.. kernel-doc:: include/drm/drm_crtc.h
+.. kernel-doc:: include/drm/drm_mode_config.h
    :internal:
 
-KMS API Functions
-=================
+Modeset Base Object Abstraction
+===============================
 
-.. kernel-doc:: drivers/gpu/drm/drm_crtc.c
+.. kernel-doc:: include/drm/drm_mode_object.h
+   :internal:
+
+.. kernel-doc:: drivers/gpu/drm/drm_mode_object.c
    :export:
 
 Atomic Mode Setting Function Reference
@@ -45,6 +44,15 @@ Atomic Mode Setting Function Reference
 .. kernel-doc:: include/drm/drm_atomic.h
    :internal:
 
+CRTC Abstraction
+================
+
+.. kernel-doc:: drivers/gpu/drm/drm_crtc.c
+   :export:
+
+.. kernel-doc:: include/drm/drm_crtc.h
+   :internal:
+
 Frame Buffer Abstraction
 ========================
 
index adcfc8f922e36651512dd17aec57fb6d5ac2a551..883f3e75cfbc4b7f2bffaa391b84b996a3ab5410 100644 (file)
@@ -16,7 +16,7 @@ drm-y       :=        drm_auth.o drm_bufs.o drm_cache.o \
                drm_framebuffer.o drm_connector.o drm_blend.o \
                drm_encoder.o drm_mode_object.o drm_property.o \
                drm_plane.o drm_color_mgmt.o drm_print.o \
-               drm_dumb_buffers.o
+               drm_dumb_buffers.o drm_mode_config.o
 
 drm-$(CONFIG_COMPAT) += drm_ioc32.o
 drm-$(CONFIG_DRM_GEM_CMA_HELPER) += drm_gem_cma_helper.o
index b0827634af18b99bd16c24cfa83fa496a889e38c..239b64c85098a744531ce567ff1b0722c6c432f4 100644 (file)
 #include "drm_crtc_internal.h"
 #include "drm_internal.h"
 
-/*
- * Global properties
- */
-static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
-       { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
-       { DRM_PLANE_TYPE_PRIMARY, "Primary" },
-       { DRM_PLANE_TYPE_CURSOR, "Cursor" },
-};
-
-/*
- * Optional properties
- */
 /**
  * drm_crtc_force_disable - Forcibly turn off a CRTC
  * @crtc: CRTC to turn off
@@ -114,7 +102,7 @@ static unsigned int drm_num_crtcs(struct drm_device *dev)
        return num;
 }
 
-static int drm_crtc_register_all(struct drm_device *dev)
+int drm_crtc_register_all(struct drm_device *dev)
 {
        struct drm_crtc *crtc;
        int ret = 0;
@@ -133,7 +121,7 @@ static int drm_crtc_register_all(struct drm_device *dev)
        return 0;
 }
 
-static void drm_crtc_unregister_all(struct drm_device *dev)
+void drm_crtc_unregister_all(struct drm_device *dev)
 {
        struct drm_crtc *crtc;
 
@@ -285,301 +273,6 @@ void drm_crtc_cleanup(struct drm_crtc *crtc)
 }
 EXPORT_SYMBOL(drm_crtc_cleanup);
 
-int drm_modeset_register_all(struct drm_device *dev)
-{
-       int ret;
-
-       ret = drm_plane_register_all(dev);
-       if (ret)
-               goto err_plane;
-
-       ret = drm_crtc_register_all(dev);
-       if  (ret)
-               goto err_crtc;
-
-       ret = drm_encoder_register_all(dev);
-       if (ret)
-               goto err_encoder;
-
-       ret = drm_connector_register_all(dev);
-       if (ret)
-               goto err_connector;
-
-       return 0;
-
-err_connector:
-       drm_encoder_unregister_all(dev);
-err_encoder:
-       drm_crtc_unregister_all(dev);
-err_crtc:
-       drm_plane_unregister_all(dev);
-err_plane:
-       return ret;
-}
-
-void drm_modeset_unregister_all(struct drm_device *dev)
-{
-       drm_connector_unregister_all(dev);
-       drm_encoder_unregister_all(dev);
-       drm_crtc_unregister_all(dev);
-       drm_plane_unregister_all(dev);
-}
-
-static int drm_mode_create_standard_properties(struct drm_device *dev)
-{
-       struct drm_property *prop;
-       int ret;
-
-       ret = drm_connector_create_standard_properties(dev);
-       if (ret)
-               return ret;
-
-       prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
-                                       "type", drm_plane_type_enum_list,
-                                       ARRAY_SIZE(drm_plane_type_enum_list));
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.plane_type_property = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "SRC_X", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_src_x = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "SRC_Y", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_src_y = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "SRC_W", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_src_w = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "SRC_H", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_src_h = prop;
-
-       prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "CRTC_X", INT_MIN, INT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_crtc_x = prop;
-
-       prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "CRTC_Y", INT_MIN, INT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_crtc_y = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "CRTC_W", 0, INT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_crtc_w = prop;
-
-       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
-                       "CRTC_H", 0, INT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_crtc_h = prop;
-
-       prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
-                       "FB_ID", DRM_MODE_OBJECT_FB);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_fb_id = prop;
-
-       prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
-                       "CRTC_ID", DRM_MODE_OBJECT_CRTC);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_crtc_id = prop;
-
-       prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
-                       "ACTIVE");
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_active = prop;
-
-       prop = drm_property_create(dev,
-                       DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
-                       "MODE_ID", 0);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.prop_mode_id = prop;
-
-       prop = drm_property_create(dev,
-                       DRM_MODE_PROP_BLOB,
-                       "DEGAMMA_LUT", 0);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.degamma_lut_property = prop;
-
-       prop = drm_property_create_range(dev,
-                       DRM_MODE_PROP_IMMUTABLE,
-                       "DEGAMMA_LUT_SIZE", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.degamma_lut_size_property = prop;
-
-       prop = drm_property_create(dev,
-                       DRM_MODE_PROP_BLOB,
-                       "CTM", 0);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.ctm_property = prop;
-
-       prop = drm_property_create(dev,
-                       DRM_MODE_PROP_BLOB,
-                       "GAMMA_LUT", 0);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.gamma_lut_property = prop;
-
-       prop = drm_property_create_range(dev,
-                       DRM_MODE_PROP_IMMUTABLE,
-                       "GAMMA_LUT_SIZE", 0, UINT_MAX);
-       if (!prop)
-               return -ENOMEM;
-       dev->mode_config.gamma_lut_size_property = prop;
-
-       return 0;
-}
-
-/**
- * drm_mode_getresources - get graphics configuration
- * @dev: drm device for the ioctl
- * @data: data pointer for the ioctl
- * @file_priv: drm file for the ioctl call
- *
- * Construct a set of configuration description structures and return
- * them to the user, including CRTC, connector and framebuffer configuration.
- *
- * Called by the user via ioctl.
- *
- * Returns:
- * Zero on success, negative errno on failure.
- */
-int drm_mode_getresources(struct drm_device *dev, void *data,
-                         struct drm_file *file_priv)
-{
-       struct drm_mode_card_res *card_res = data;
-       struct list_head *lh;
-       struct drm_framebuffer *fb;
-       struct drm_connector *connector;
-       struct drm_crtc *crtc;
-       struct drm_encoder *encoder;
-       int ret = 0;
-       int connector_count = 0;
-       int crtc_count = 0;
-       int fb_count = 0;
-       int encoder_count = 0;
-       int copied = 0;
-       uint32_t __user *fb_id;
-       uint32_t __user *crtc_id;
-       uint32_t __user *connector_id;
-       uint32_t __user *encoder_id;
-
-       if (!drm_core_check_feature(dev, DRIVER_MODESET))
-               return -EINVAL;
-
-
-       mutex_lock(&file_priv->fbs_lock);
-       /*
-        * For the non-control nodes we need to limit the list of resources
-        * by IDs in the group list for this node
-        */
-       list_for_each(lh, &file_priv->fbs)
-               fb_count++;
-
-       /* handle this in 4 parts */
-       /* FBs */
-       if (card_res->count_fbs >= fb_count) {
-               copied = 0;
-               fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
-               list_for_each_entry(fb, &file_priv->fbs, filp_head) {
-                       if (put_user(fb->base.id, fb_id + copied)) {
-                               mutex_unlock(&file_priv->fbs_lock);
-                               return -EFAULT;
-                       }
-                       copied++;
-               }
-       }
-       card_res->count_fbs = fb_count;
-       mutex_unlock(&file_priv->fbs_lock);
-
-       /* mode_config.mutex protects the connector list against e.g. DP MST
-        * connector hot-adding. CRTC/Plane lists are invariant. */
-       mutex_lock(&dev->mode_config.mutex);
-       drm_for_each_crtc(crtc, dev)
-               crtc_count++;
-
-       drm_for_each_connector(connector, dev)
-               connector_count++;
-
-       drm_for_each_encoder(encoder, dev)
-               encoder_count++;
-
-       card_res->max_height = dev->mode_config.max_height;
-       card_res->min_height = dev->mode_config.min_height;
-       card_res->max_width = dev->mode_config.max_width;
-       card_res->min_width = dev->mode_config.min_width;
-
-       /* CRTCs */
-       if (card_res->count_crtcs >= crtc_count) {
-               copied = 0;
-               crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
-               drm_for_each_crtc(crtc, dev) {
-                       if (put_user(crtc->base.id, crtc_id + copied)) {
-                               ret = -EFAULT;
-                               goto out;
-                       }
-                       copied++;
-               }
-       }
-       card_res->count_crtcs = crtc_count;
-
-       /* Encoders */
-       if (card_res->count_encoders >= encoder_count) {
-               copied = 0;
-               encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
-               drm_for_each_encoder(encoder, dev) {
-                       if (put_user(encoder->base.id, encoder_id +
-                                    copied)) {
-                               ret = -EFAULT;
-                               goto out;
-                       }
-                       copied++;
-               }
-       }
-       card_res->count_encoders = encoder_count;
-
-       /* Connectors */
-       if (card_res->count_connectors >= connector_count) {
-               copied = 0;
-               connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
-               drm_for_each_connector(connector, dev) {
-                       if (put_user(connector->base.id,
-                                    connector_id + copied)) {
-                               ret = -EFAULT;
-                               goto out;
-                       }
-                       copied++;
-               }
-       }
-       card_res->count_connectors = connector_count;
-
-out:
-       mutex_unlock(&dev->mode_config.mutex);
-       return ret;
-}
-
 /**
  * drm_mode_getcrtc - get CRTC configuration
  * @dev: drm device for the ioctl
@@ -933,157 +626,6 @@ int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
        return ret;
 }
 
-/**
- * drm_mode_config_reset - call ->reset callbacks
- * @dev: drm device
- *
- * This functions calls all the crtc's, encoder's and connector's ->reset
- * callback. Drivers can use this in e.g. their driver load or resume code to
- * reset hardware and software state.
- */
-void drm_mode_config_reset(struct drm_device *dev)
-{
-       struct drm_crtc *crtc;
-       struct drm_plane *plane;
-       struct drm_encoder *encoder;
-       struct drm_connector *connector;
-
-       drm_for_each_plane(plane, dev)
-               if (plane->funcs->reset)
-                       plane->funcs->reset(plane);
-
-       drm_for_each_crtc(crtc, dev)
-               if (crtc->funcs->reset)
-                       crtc->funcs->reset(crtc);
-
-       drm_for_each_encoder(encoder, dev)
-               if (encoder->funcs->reset)
-                       encoder->funcs->reset(encoder);
-
-       mutex_lock(&dev->mode_config.mutex);
-       drm_for_each_connector(connector, dev)
-               if (connector->funcs->reset)
-                       connector->funcs->reset(connector);
-       mutex_unlock(&dev->mode_config.mutex);
-}
-EXPORT_SYMBOL(drm_mode_config_reset);
-
-/**
- * drm_mode_config_init - initialize DRM mode_configuration structure
- * @dev: DRM device
- *
- * Initialize @dev's mode_config structure, used for tracking the graphics
- * configuration of @dev.
- *
- * Since this initializes the modeset locks, no locking is possible. Which is no
- * problem, since this should happen single threaded at init time. It is the
- * driver's problem to ensure this guarantee.
- *
- */
-void drm_mode_config_init(struct drm_device *dev)
-{
-       mutex_init(&dev->mode_config.mutex);
-       drm_modeset_lock_init(&dev->mode_config.connection_mutex);
-       mutex_init(&dev->mode_config.idr_mutex);
-       mutex_init(&dev->mode_config.fb_lock);
-       mutex_init(&dev->mode_config.blob_lock);
-       INIT_LIST_HEAD(&dev->mode_config.fb_list);
-       INIT_LIST_HEAD(&dev->mode_config.crtc_list);
-       INIT_LIST_HEAD(&dev->mode_config.connector_list);
-       INIT_LIST_HEAD(&dev->mode_config.encoder_list);
-       INIT_LIST_HEAD(&dev->mode_config.property_list);
-       INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
-       INIT_LIST_HEAD(&dev->mode_config.plane_list);
-       idr_init(&dev->mode_config.crtc_idr);
-       idr_init(&dev->mode_config.tile_idr);
-       ida_init(&dev->mode_config.connector_ida);
-
-       drm_modeset_lock_all(dev);
-       drm_mode_create_standard_properties(dev);
-       drm_modeset_unlock_all(dev);
-
-       /* Just to be sure */
-       dev->mode_config.num_fb = 0;
-       dev->mode_config.num_connector = 0;
-       dev->mode_config.num_crtc = 0;
-       dev->mode_config.num_encoder = 0;
-       dev->mode_config.num_overlay_plane = 0;
-       dev->mode_config.num_total_plane = 0;
-}
-EXPORT_SYMBOL(drm_mode_config_init);
-
-/**
- * drm_mode_config_cleanup - free up DRM mode_config info
- * @dev: DRM device
- *
- * Free up all the connectors and CRTCs associated with this DRM device, then
- * free up the framebuffers and associated buffer objects.
- *
- * Note that since this /should/ happen single-threaded at driver/device
- * teardown time, no locking is required. It's the driver's job to ensure that
- * this guarantee actually holds true.
- *
- * FIXME: cleanup any dangling user buffer objects too
- */
-void drm_mode_config_cleanup(struct drm_device *dev)
-{
-       struct drm_connector *connector, *ot;
-       struct drm_crtc *crtc, *ct;
-       struct drm_encoder *encoder, *enct;
-       struct drm_framebuffer *fb, *fbt;
-       struct drm_property *property, *pt;
-       struct drm_property_blob *blob, *bt;
-       struct drm_plane *plane, *plt;
-
-       list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
-                                head) {
-               encoder->funcs->destroy(encoder);
-       }
-
-       list_for_each_entry_safe(connector, ot,
-                                &dev->mode_config.connector_list, head) {
-               connector->funcs->destroy(connector);
-       }
-
-       list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
-                                head) {
-               drm_property_destroy(dev, property);
-       }
-
-       list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
-                                head) {
-               plane->funcs->destroy(plane);
-       }
-
-       list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
-               crtc->funcs->destroy(crtc);
-       }
-
-       list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
-                                head_global) {
-               drm_property_unreference_blob(blob);
-       }
-
-       /*
-        * Single-threaded teardown context, so it's not required to grab the
-        * fb_lock to protect against concurrent fb_list access. Contrary, it
-        * would actually deadlock with the drm_framebuffer_cleanup function.
-        *
-        * Also, if there are any framebuffers left, that's a driver leak now,
-        * so politely WARN about this.
-        */
-       WARN_ON(!list_empty(&dev->mode_config.fb_list));
-       list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
-               drm_framebuffer_free(&fb->base.refcount);
-       }
-
-       ida_destroy(&dev->mode_config.connector_ida);
-       idr_destroy(&dev->mode_config.tile_idr);
-       idr_destroy(&dev->mode_config.crtc_idr);
-       drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
-}
-EXPORT_SYMBOL(drm_mode_config_cleanup);
-
 /**
  * DOC: Tile group
  *
index 64bb3eb7f8069ffa5787ba227d032239e3743e87..f78d5aaf7e911e3257e1ce0f407dbb8a081bbae1 100644 (file)
@@ -40,19 +40,26 @@ int drm_crtc_check_viewport(const struct drm_crtc *crtc,
                            int x, int y,
                            const struct drm_display_mode *mode,
                            const struct drm_framebuffer *fb);
-
-void drm_fb_release(struct drm_file *file_priv);
+int drm_crtc_register_all(struct drm_device *dev);
+void drm_crtc_unregister_all(struct drm_device *dev);
 
 /* IOCTLs */
-int drm_mode_getresources(struct drm_device *dev,
-                         void *data, struct drm_file *file_priv);
 int drm_mode_getcrtc(struct drm_device *dev,
                     void *data, struct drm_file *file_priv);
 int drm_mode_setcrtc(struct drm_device *dev,
                     void *data, struct drm_file *file_priv);
 
-/* drm_dumb_buffers.c */
+
+/* drm_mode_config.c */
+int drm_modeset_register_all(struct drm_device *dev);
+void drm_modeset_unregister_all(struct drm_device *dev);
 
+/* IOCTLs */
+int drm_mode_getresources(struct drm_device *dev,
+                         void *data, struct drm_file *file_priv);
+
+
+/* drm_dumb_buffers.c */
 /* IOCTLs */
 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
                               void *data, struct drm_file *file_priv);
@@ -149,6 +156,8 @@ void drm_framebuffer_free(struct kref *kref);
 int drm_framebuffer_check_src_coords(uint32_t src_x, uint32_t src_y,
                                     uint32_t src_w, uint32_t src_h,
                                     const struct drm_framebuffer *fb);
+void drm_fb_release(struct drm_file *file_priv);
+
 
 /* IOCTL */
 int drm_mode_addfb(struct drm_device *dev,
@@ -168,9 +177,6 @@ int drm_atomic_get_property(struct drm_mode_object *obj,
 int drm_mode_atomic_ioctl(struct drm_device *dev,
                          void *data, struct drm_file *file_priv);
 
-int drm_modeset_register_all(struct drm_device *dev);
-void drm_modeset_unregister_all(struct drm_device *dev);
-
 
 /* drm_plane.c */
 int drm_plane_register_all(struct drm_device *dev);
diff --git a/drivers/gpu/drm/drm_mode_config.c b/drivers/gpu/drm/drm_mode_config.c
new file mode 100644 (file)
index 0000000..6f80886
--- /dev/null
@@ -0,0 +1,482 @@
+/*
+ * Copyright (c) 2016 Intel Corporation
+ *
+ * Permission to use, copy, modify, distribute, and sell this software and its
+ * documentation for any purpose is hereby granted without fee, provided that
+ * the above copyright notice appear in all copies and that both that copyright
+ * notice and this permission notice appear in supporting documentation, and
+ * that the name of the copyright holders not be used in advertising or
+ * publicity pertaining to distribution of the software without specific,
+ * written prior permission.  The copyright holders make no representations
+ * about the suitability of this software for any purpose.  It is provided "as
+ * is" without express or implied warranty.
+ *
+ * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+ * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+ * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+ * OF THIS SOFTWARE.
+ */
+
+#include <drm/drm_mode_config.h>
+#include <drm/drmP.h>
+
+#include "drm_crtc_internal.h"
+#include "drm_internal.h"
+
+int drm_modeset_register_all(struct drm_device *dev)
+{
+       int ret;
+
+       ret = drm_plane_register_all(dev);
+       if (ret)
+               goto err_plane;
+
+       ret = drm_crtc_register_all(dev);
+       if  (ret)
+               goto err_crtc;
+
+       ret = drm_encoder_register_all(dev);
+       if (ret)
+               goto err_encoder;
+
+       ret = drm_connector_register_all(dev);
+       if (ret)
+               goto err_connector;
+
+       return 0;
+
+err_connector:
+       drm_encoder_unregister_all(dev);
+err_encoder:
+       drm_crtc_unregister_all(dev);
+err_crtc:
+       drm_plane_unregister_all(dev);
+err_plane:
+       return ret;
+}
+
+void drm_modeset_unregister_all(struct drm_device *dev)
+{
+       drm_connector_unregister_all(dev);
+       drm_encoder_unregister_all(dev);
+       drm_crtc_unregister_all(dev);
+       drm_plane_unregister_all(dev);
+}
+
+/**
+ * drm_mode_getresources - get graphics configuration
+ * @dev: drm device for the ioctl
+ * @data: data pointer for the ioctl
+ * @file_priv: drm file for the ioctl call
+ *
+ * Construct a set of configuration description structures and return
+ * them to the user, including CRTC, connector and framebuffer configuration.
+ *
+ * Called by the user via ioctl.
+ *
+ * Returns:
+ * Zero on success, negative errno on failure.
+ */
+int drm_mode_getresources(struct drm_device *dev, void *data,
+                         struct drm_file *file_priv)
+{
+       struct drm_mode_card_res *card_res = data;
+       struct list_head *lh;
+       struct drm_framebuffer *fb;
+       struct drm_connector *connector;
+       struct drm_crtc *crtc;
+       struct drm_encoder *encoder;
+       int ret = 0;
+       int connector_count = 0;
+       int crtc_count = 0;
+       int fb_count = 0;
+       int encoder_count = 0;
+       int copied = 0;
+       uint32_t __user *fb_id;
+       uint32_t __user *crtc_id;
+       uint32_t __user *connector_id;
+       uint32_t __user *encoder_id;
+
+       if (!drm_core_check_feature(dev, DRIVER_MODESET))
+               return -EINVAL;
+
+
+       mutex_lock(&file_priv->fbs_lock);
+       /*
+        * For the non-control nodes we need to limit the list of resources
+        * by IDs in the group list for this node
+        */
+       list_for_each(lh, &file_priv->fbs)
+               fb_count++;
+
+       /* handle this in 4 parts */
+       /* FBs */
+       if (card_res->count_fbs >= fb_count) {
+               copied = 0;
+               fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
+               list_for_each_entry(fb, &file_priv->fbs, filp_head) {
+                       if (put_user(fb->base.id, fb_id + copied)) {
+                               mutex_unlock(&file_priv->fbs_lock);
+                               return -EFAULT;
+                       }
+                       copied++;
+               }
+       }
+       card_res->count_fbs = fb_count;
+       mutex_unlock(&file_priv->fbs_lock);
+
+       /* mode_config.mutex protects the connector list against e.g. DP MST
+        * connector hot-adding. CRTC/Plane lists are invariant. */
+       mutex_lock(&dev->mode_config.mutex);
+       drm_for_each_crtc(crtc, dev)
+               crtc_count++;
+
+       drm_for_each_connector(connector, dev)
+               connector_count++;
+
+       drm_for_each_encoder(encoder, dev)
+               encoder_count++;
+
+       card_res->max_height = dev->mode_config.max_height;
+       card_res->min_height = dev->mode_config.min_height;
+       card_res->max_width = dev->mode_config.max_width;
+       card_res->min_width = dev->mode_config.min_width;
+
+       /* CRTCs */
+       if (card_res->count_crtcs >= crtc_count) {
+               copied = 0;
+               crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
+               drm_for_each_crtc(crtc, dev) {
+                       if (put_user(crtc->base.id, crtc_id + copied)) {
+                               ret = -EFAULT;
+                               goto out;
+                       }
+                       copied++;
+               }
+       }
+       card_res->count_crtcs = crtc_count;
+
+       /* Encoders */
+       if (card_res->count_encoders >= encoder_count) {
+               copied = 0;
+               encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
+               drm_for_each_encoder(encoder, dev) {
+                       if (put_user(encoder->base.id, encoder_id +
+                                    copied)) {
+                               ret = -EFAULT;
+                               goto out;
+                       }
+                       copied++;
+               }
+       }
+       card_res->count_encoders = encoder_count;
+
+       /* Connectors */
+       if (card_res->count_connectors >= connector_count) {
+               copied = 0;
+               connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
+               drm_for_each_connector(connector, dev) {
+                       if (put_user(connector->base.id,
+                                    connector_id + copied)) {
+                               ret = -EFAULT;
+                               goto out;
+                       }
+                       copied++;
+               }
+       }
+       card_res->count_connectors = connector_count;
+
+out:
+       mutex_unlock(&dev->mode_config.mutex);
+       return ret;
+}
+
+/**
+ * drm_mode_config_reset - call ->reset callbacks
+ * @dev: drm device
+ *
+ * This functions calls all the crtc's, encoder's and connector's ->reset
+ * callback. Drivers can use this in e.g. their driver load or resume code to
+ * reset hardware and software state.
+ */
+void drm_mode_config_reset(struct drm_device *dev)
+{
+       struct drm_crtc *crtc;
+       struct drm_plane *plane;
+       struct drm_encoder *encoder;
+       struct drm_connector *connector;
+
+       drm_for_each_plane(plane, dev)
+               if (plane->funcs->reset)
+                       plane->funcs->reset(plane);
+
+       drm_for_each_crtc(crtc, dev)
+               if (crtc->funcs->reset)
+                       crtc->funcs->reset(crtc);
+
+       drm_for_each_encoder(encoder, dev)
+               if (encoder->funcs->reset)
+                       encoder->funcs->reset(encoder);
+
+       mutex_lock(&dev->mode_config.mutex);
+       drm_for_each_connector(connector, dev)
+               if (connector->funcs->reset)
+                       connector->funcs->reset(connector);
+       mutex_unlock(&dev->mode_config.mutex);
+}
+EXPORT_SYMBOL(drm_mode_config_reset);
+
+/*
+ * Global properties
+ */
+static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
+       { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
+       { DRM_PLANE_TYPE_PRIMARY, "Primary" },
+       { DRM_PLANE_TYPE_CURSOR, "Cursor" },
+};
+
+static int drm_mode_create_standard_properties(struct drm_device *dev)
+{
+       struct drm_property *prop;
+       int ret;
+
+       ret = drm_connector_create_standard_properties(dev);
+       if (ret)
+               return ret;
+
+       prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
+                                       "type", drm_plane_type_enum_list,
+                                       ARRAY_SIZE(drm_plane_type_enum_list));
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.plane_type_property = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "SRC_X", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_src_x = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "SRC_Y", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_src_y = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "SRC_W", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_src_w = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "SRC_H", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_src_h = prop;
+
+       prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "CRTC_X", INT_MIN, INT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_crtc_x = prop;
+
+       prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "CRTC_Y", INT_MIN, INT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_crtc_y = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "CRTC_W", 0, INT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_crtc_w = prop;
+
+       prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
+                       "CRTC_H", 0, INT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_crtc_h = prop;
+
+       prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
+                       "FB_ID", DRM_MODE_OBJECT_FB);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_fb_id = prop;
+
+       prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
+                       "CRTC_ID", DRM_MODE_OBJECT_CRTC);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_crtc_id = prop;
+
+       prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
+                       "ACTIVE");
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_active = prop;
+
+       prop = drm_property_create(dev,
+                       DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
+                       "MODE_ID", 0);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.prop_mode_id = prop;
+
+       prop = drm_property_create(dev,
+                       DRM_MODE_PROP_BLOB,
+                       "DEGAMMA_LUT", 0);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.degamma_lut_property = prop;
+
+       prop = drm_property_create_range(dev,
+                       DRM_MODE_PROP_IMMUTABLE,
+                       "DEGAMMA_LUT_SIZE", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.degamma_lut_size_property = prop;
+
+       prop = drm_property_create(dev,
+                       DRM_MODE_PROP_BLOB,
+                       "CTM", 0);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.ctm_property = prop;
+
+       prop = drm_property_create(dev,
+                       DRM_MODE_PROP_BLOB,
+                       "GAMMA_LUT", 0);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.gamma_lut_property = prop;
+
+       prop = drm_property_create_range(dev,
+                       DRM_MODE_PROP_IMMUTABLE,
+                       "GAMMA_LUT_SIZE", 0, UINT_MAX);
+       if (!prop)
+               return -ENOMEM;
+       dev->mode_config.gamma_lut_size_property = prop;
+
+       return 0;
+}
+
+/**
+ * drm_mode_config_init - initialize DRM mode_configuration structure
+ * @dev: DRM device
+ *
+ * Initialize @dev's mode_config structure, used for tracking the graphics
+ * configuration of @dev.
+ *
+ * Since this initializes the modeset locks, no locking is possible. Which is no
+ * problem, since this should happen single threaded at init time. It is the
+ * driver's problem to ensure this guarantee.
+ *
+ */
+void drm_mode_config_init(struct drm_device *dev)
+{
+       mutex_init(&dev->mode_config.mutex);
+       drm_modeset_lock_init(&dev->mode_config.connection_mutex);
+       mutex_init(&dev->mode_config.idr_mutex);
+       mutex_init(&dev->mode_config.fb_lock);
+       mutex_init(&dev->mode_config.blob_lock);
+       INIT_LIST_HEAD(&dev->mode_config.fb_list);
+       INIT_LIST_HEAD(&dev->mode_config.crtc_list);
+       INIT_LIST_HEAD(&dev->mode_config.connector_list);
+       INIT_LIST_HEAD(&dev->mode_config.encoder_list);
+       INIT_LIST_HEAD(&dev->mode_config.property_list);
+       INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
+       INIT_LIST_HEAD(&dev->mode_config.plane_list);
+       idr_init(&dev->mode_config.crtc_idr);
+       idr_init(&dev->mode_config.tile_idr);
+       ida_init(&dev->mode_config.connector_ida);
+
+       drm_modeset_lock_all(dev);
+       drm_mode_create_standard_properties(dev);
+       drm_modeset_unlock_all(dev);
+
+       /* Just to be sure */
+       dev->mode_config.num_fb = 0;
+       dev->mode_config.num_connector = 0;
+       dev->mode_config.num_crtc = 0;
+       dev->mode_config.num_encoder = 0;
+       dev->mode_config.num_overlay_plane = 0;
+       dev->mode_config.num_total_plane = 0;
+}
+EXPORT_SYMBOL(drm_mode_config_init);
+
+/**
+ * drm_mode_config_cleanup - free up DRM mode_config info
+ * @dev: DRM device
+ *
+ * Free up all the connectors and CRTCs associated with this DRM device, then
+ * free up the framebuffers and associated buffer objects.
+ *
+ * Note that since this /should/ happen single-threaded at driver/device
+ * teardown time, no locking is required. It's the driver's job to ensure that
+ * this guarantee actually holds true.
+ *
+ * FIXME: cleanup any dangling user buffer objects too
+ */
+void drm_mode_config_cleanup(struct drm_device *dev)
+{
+       struct drm_connector *connector, *ot;
+       struct drm_crtc *crtc, *ct;
+       struct drm_encoder *encoder, *enct;
+       struct drm_framebuffer *fb, *fbt;
+       struct drm_property *property, *pt;
+       struct drm_property_blob *blob, *bt;
+       struct drm_plane *plane, *plt;
+
+       list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
+                                head) {
+               encoder->funcs->destroy(encoder);
+       }
+
+       list_for_each_entry_safe(connector, ot,
+                                &dev->mode_config.connector_list, head) {
+               connector->funcs->destroy(connector);
+       }
+
+       list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
+                                head) {
+               drm_property_destroy(dev, property);
+       }
+
+       list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
+                                head) {
+               plane->funcs->destroy(plane);
+       }
+
+       list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
+               crtc->funcs->destroy(crtc);
+       }
+
+       list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
+                                head_global) {
+               drm_property_unreference_blob(blob);
+       }
+
+       /*
+        * Single-threaded teardown context, so it's not required to grab the
+        * fb_lock to protect against concurrent fb_list access. Contrary, it
+        * would actually deadlock with the drm_framebuffer_cleanup function.
+        *
+        * Also, if there are any framebuffers left, that's a driver leak now,
+        * so politely WARN about this.
+        */
+       WARN_ON(!list_empty(&dev->mode_config.fb_list));
+       list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
+               drm_framebuffer_free(&fb->base.refcount);
+       }
+
+       ida_destroy(&dev->mode_config.connector_ida);
+       idr_destroy(&dev->mode_config.tile_idr);
+       idr_destroy(&dev->mode_config.crtc_idr);
+       drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
+}
+EXPORT_SYMBOL(drm_mode_config_cleanup);
index 8cca2a895981a1e0d23198a82b05d120e95d98df..98de488a95a5cab6a94281be029a65293b577dd9 100644 (file)
@@ -28,7 +28,6 @@
 #include <linux/i2c.h>
 #include <linux/spinlock.h>
 #include <linux/types.h>
-#include <linux/idr.h>
 #include <linux/fb.h>
 #include <linux/hdmi.h>
 #include <linux/media-bus-format.h>
@@ -48,6 +47,7 @@
 #include <drm/drm_blend.h>
 #include <drm/drm_color_mgmt.h>
 #include <drm/drm_debugfs_crc.h>
+#include <drm/drm_mode_config.h>
 
 struct drm_device;
 struct drm_mode_set;
@@ -768,616 +768,6 @@ struct drm_mode_set {
        size_t num_connectors;
 };
 
-/**
- * struct drm_mode_config_funcs - basic driver provided mode setting functions
- *
- * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
- * involve drivers.
- */
-struct drm_mode_config_funcs {
-       /**
-        * @fb_create:
-        *
-        * Create a new framebuffer object. The core does basic checks on the
-        * requested metadata, but most of that is left to the driver. See
-        * struct &drm_mode_fb_cmd2 for details.
-        *
-        * If the parameters are deemed valid and the backing storage objects in
-        * the underlying memory manager all exist, then the driver allocates
-        * a new &drm_framebuffer structure, subclassed to contain
-        * driver-specific information (like the internal native buffer object
-        * references). It also needs to fill out all relevant metadata, which
-        * should be done by calling drm_helper_mode_fill_fb_struct().
-        *
-        * The initialization is finalized by calling drm_framebuffer_init(),
-        * which registers the framebuffer and makes it accessible to other
-        * threads.
-        *
-        * RETURNS:
-        *
-        * A new framebuffer with an initial reference count of 1 or a negative
-        * error code encoded with ERR_PTR().
-        */
-       struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
-                                            struct drm_file *file_priv,
-                                            const struct drm_mode_fb_cmd2 *mode_cmd);
-
-       /**
-        * @output_poll_changed:
-        *
-        * Callback used by helpers to inform the driver of output configuration
-        * changes.
-        *
-        * Drivers implementing fbdev emulation with the helpers can call
-        * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
-        * helper of output changes.
-        *
-        * FIXME:
-        *
-        * Except that there's no vtable for device-level helper callbacks
-        * there's no reason this is a core function.
-        */
-       void (*output_poll_changed)(struct drm_device *dev);
-
-       /**
-        * @atomic_check:
-        *
-        * This is the only hook to validate an atomic modeset update. This
-        * function must reject any modeset and state changes which the hardware
-        * or driver doesn't support. This includes but is of course not limited
-        * to:
-        *
-        *  - Checking that the modes, framebuffers, scaling and placement
-        *    requirements and so on are within the limits of the hardware.
-        *
-        *  - Checking that any hidden shared resources are not oversubscribed.
-        *    This can be shared PLLs, shared lanes, overall memory bandwidth,
-        *    display fifo space (where shared between planes or maybe even
-        *    CRTCs).
-        *
-        *  - Checking that virtualized resources exported to userspace are not
-        *    oversubscribed. For various reasons it can make sense to expose
-        *    more planes, crtcs or encoders than which are physically there. One
-        *    example is dual-pipe operations (which generally should be hidden
-        *    from userspace if when lockstepped in hardware, exposed otherwise),
-        *    where a plane might need 1 hardware plane (if it's just on one
-        *    pipe), 2 hardware planes (when it spans both pipes) or maybe even
-        *    shared a hardware plane with a 2nd plane (if there's a compatible
-        *    plane requested on the area handled by the other pipe).
-        *
-        *  - Check that any transitional state is possible and that if
-        *    requested, the update can indeed be done in the vblank period
-        *    without temporarily disabling some functions.
-        *
-        *  - Check any other constraints the driver or hardware might have.
-        *
-        *  - This callback also needs to correctly fill out the &drm_crtc_state
-        *    in this update to make sure that drm_atomic_crtc_needs_modeset()
-        *    reflects the nature of the possible update and returns true if and
-        *    only if the update cannot be applied without tearing within one
-        *    vblank on that CRTC. The core uses that information to reject
-        *    updates which require a full modeset (i.e. blanking the screen, or
-        *    at least pausing updates for a substantial amount of time) if
-        *    userspace has disallowed that in its request.
-        *
-        *  - The driver also does not need to repeat basic input validation
-        *    like done for the corresponding legacy entry points. The core does
-        *    that before calling this hook.
-        *
-        * See the documentation of @atomic_commit for an exhaustive list of
-        * error conditions which don't have to be checked at the
-        * ->atomic_check() stage?
-        *
-        * See the documentation for struct &drm_atomic_state for how exactly
-        * an atomic modeset update is described.
-        *
-        * Drivers using the atomic helpers can implement this hook using
-        * drm_atomic_helper_check(), or one of the exported sub-functions of
-        * it.
-        *
-        * RETURNS:
-        *
-        * 0 on success or one of the below negative error codes:
-        *
-        *  - -EINVAL, if any of the above constraints are violated.
-        *
-        *  - -EDEADLK, when returned from an attempt to acquire an additional
-        *    &drm_modeset_lock through drm_modeset_lock().
-        *
-        *  - -ENOMEM, if allocating additional state sub-structures failed due
-        *    to lack of memory.
-        *
-        *  - -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.
-        */
-       int (*atomic_check)(struct drm_device *dev,
-                           struct drm_atomic_state *state);
-
-       /**
-        * @atomic_commit:
-        *
-        * This is the only hook to commit an atomic modeset update. The core
-        * guarantees that @atomic_check has been called successfully before
-        * calling this function, and that nothing has been changed in the
-        * interim.
-        *
-        * See the documentation for struct &drm_atomic_state for how exactly
-        * an atomic modeset update is described.
-        *
-        * Drivers using the atomic helpers can implement this hook using
-        * drm_atomic_helper_commit(), or one of the exported sub-functions of
-        * it.
-        *
-        * Nonblocking commits (as indicated with the nonblock parameter) must
-        * do any preparatory work which might result in an unsuccessful commit
-        * in the context of this callback. The only exceptions are hardware
-        * errors resulting in -EIO. But even in that case the driver must
-        * ensure that the display pipe is at least running, to avoid
-        * compositors crashing when pageflips don't work. Anything else,
-        * specifically committing the update to the hardware, should be done
-        * without blocking the caller. For updates which do not require a
-        * modeset this must be guaranteed.
-        *
-        * The driver must wait for any pending rendering to the new
-        * framebuffers to complete before executing the flip. It should also
-        * wait for any pending rendering from other drivers if the underlying
-        * buffer is a shared dma-buf. Nonblocking commits must not wait for
-        * rendering in the context of this callback.
-        *
-        * An application can request to be notified when the atomic commit has
-        * completed. These events are per-CRTC and can be distinguished by the
-        * CRTC index supplied in &drm_event to userspace.
-        *
-        * The drm core will supply a struct &drm_event in the event
-        * member of each CRTC's &drm_crtc_state structure. See the
-        * documentation for &drm_crtc_state for more details about the precise
-        * semantics of this event.
-        *
-        * NOTE:
-        *
-        * Drivers are not allowed to shut down any display pipe successfully
-        * enabled through an atomic commit on their own. Doing so can result in
-        * compositors crashing if a page flip is suddenly rejected because the
-        * pipe is off.
-        *
-        * RETURNS:
-        *
-        * 0 on success or one of the below negative error codes:
-        *
-        *  - -EBUSY, if a nonblocking updated is requested and there is
-        *    an earlier updated pending. Drivers are allowed to support a queue
-        *    of outstanding updates, but currently no driver supports that.
-        *    Note that drivers must wait for preceding updates to complete if a
-        *    synchronous update is requested, they are not allowed to fail the
-        *    commit in that case.
-        *
-        *  - -ENOMEM, if the driver failed to allocate memory. Specifically
-        *    this can happen when trying to pin framebuffers, which must only
-        *    be done when committing the state.
-        *
-        *  - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
-        *    that the driver has run out of vram, iommu space or similar GPU
-        *    address space needed for framebuffer.
-        *
-        *  - -EIO, if the hardware completely died.
-        *
-        *  - -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 of view all errors are
-        *    treated equally.
-        *
-        * This list is exhaustive. Specifically this hook is not allowed to
-        * return -EINVAL (any invalid requests should be caught in
-        * @atomic_check) or -EDEADLK (this function must not acquire
-        * additional modeset locks).
-        */
-       int (*atomic_commit)(struct drm_device *dev,
-                            struct drm_atomic_state *state,
-                            bool nonblock);
-
-       /**
-        * @atomic_state_alloc:
-        *
-        * This optional hook can be used by drivers that want to subclass struct
-        * &drm_atomic_state to be able to track their own driver-private global
-        * state easily. If this hook is implemented, drivers must also
-        * implement @atomic_state_clear and @atomic_state_free.
-        *
-        * RETURNS:
-        *
-        * A new &drm_atomic_state on success or NULL on failure.
-        */
-       struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
-
-       /**
-        * @atomic_state_clear:
-        *
-        * This hook must clear any driver private state duplicated into the
-        * passed-in &drm_atomic_state. This hook is called when the caller
-        * encountered a &drm_modeset_lock deadlock and needs to drop all
-        * already acquired locks as part of the deadlock avoidance dance
-        * implemented in drm_modeset_lock_backoff().
-        *
-        * Any duplicated state must be invalidated since a concurrent atomic
-        * update might change it, and the drm atomic interfaces always apply
-        * updates as relative changes to the current state.
-        *
-        * Drivers that implement this must call drm_atomic_state_default_clear()
-        * to clear common state.
-        */
-       void (*atomic_state_clear)(struct drm_atomic_state *state);
-
-       /**
-        * @atomic_state_free:
-        *
-        * This hook needs driver private resources and the &drm_atomic_state
-        * itself. Note that the core first calls drm_atomic_state_clear() to
-        * avoid code duplicate between the clear and free hooks.
-        *
-        * Drivers that implement this must call drm_atomic_state_default_free()
-        * to release common resources.
-        */
-       void (*atomic_state_free)(struct drm_atomic_state *state);
-};
-
-/**
- * struct drm_mode_config - Mode configuration control structure
- * @mutex: mutex protecting KMS related lists and structures
- * @connection_mutex: ww mutex protecting connector state and routing
- * @acquire_ctx: global implicit acquire context used by atomic drivers for
- *     legacy IOCTLs
- * @fb_lock: mutex to protect fb state and lists
- * @num_fb: number of fbs available
- * @fb_list: list of framebuffers available
- * @num_encoder: number of encoders on this device
- * @encoder_list: list of encoder objects
- * @num_overlay_plane: number of overlay planes on this device
- * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
- * @plane_list: list of plane objects
- * @num_crtc: number of CRTCs on this device
- * @crtc_list: list of CRTC objects
- * @property_list: list of property objects
- * @min_width: minimum pixel width on this device
- * @min_height: minimum pixel height on this device
- * @max_width: maximum pixel width on this device
- * @max_height: maximum pixel height on this device
- * @funcs: core driver provided mode setting functions
- * @fb_base: base address of the framebuffer
- * @poll_enabled: track polling support for this device
- * @poll_running: track polling status for this device
- * @delayed_event: track delayed poll uevent deliver for this device
- * @output_poll_work: delayed work for polling in process context
- * @property_blob_list: list of all the blob property objects
- * @blob_lock: mutex for blob property allocation and management
- * @*_property: core property tracking
- * @preferred_depth: preferred RBG pixel depth, used by fb helpers
- * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
- * @cursor_width: hint to userspace for max cursor width
- * @cursor_height: hint to userspace for max cursor height
- * @helper_private: mid-layer private data
- *
- * Core mode resource tracking structure.  All CRTC, encoders, and connectors
- * enumerated by the driver are added here, as are global properties.  Some
- * global restrictions are also here, e.g. dimension restrictions.
- */
-struct drm_mode_config {
-       struct mutex mutex; /* protects configuration (mode lists etc.) */
-       struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
-       struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
-
-       /**
-        * @idr_mutex:
-        *
-        * Mutex for KMS ID allocation and management. Protects both @crtc_idr
-        * and @tile_idr.
-        */
-       struct mutex idr_mutex;
-
-       /**
-        * @crtc_idr:
-        *
-        * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
-        * connector, modes - just makes life easier to have only one.
-        */
-       struct idr crtc_idr;
-
-       /**
-        * @tile_idr:
-        *
-        * Use this idr for allocating new IDs for tiled sinks like use in some
-        * high-res DP MST screens.
-        */
-       struct idr tile_idr;
-
-       struct mutex fb_lock; /* proctects global and per-file fb lists */
-       int num_fb;
-       struct list_head fb_list;
-
-       /**
-        * @num_connector: Number of connectors on this device.
-        */
-       int num_connector;
-       /**
-        * @connector_ida: ID allocator for connector indices.
-        */
-       struct ida connector_ida;
-       /**
-        * @connector_list: List of connector objects.
-        */
-       struct list_head connector_list;
-       int num_encoder;
-       struct list_head encoder_list;
-
-       /*
-        * Track # of overlay planes separately from # of total planes.  By
-        * default we only advertise overlay planes to userspace; if userspace
-        * sets the "universal plane" capability bit, we'll go ahead and
-        * expose all planes.
-        */
-       int num_overlay_plane;
-       int num_total_plane;
-       struct list_head plane_list;
-
-       int num_crtc;
-       struct list_head crtc_list;
-
-       struct list_head property_list;
-
-       int min_width, min_height;
-       int max_width, max_height;
-       const struct drm_mode_config_funcs *funcs;
-       resource_size_t fb_base;
-
-       /* output poll support */
-       bool poll_enabled;
-       bool poll_running;
-       bool delayed_event;
-       struct delayed_work output_poll_work;
-
-       struct mutex blob_lock;
-
-       /* pointers to standard properties */
-       struct list_head property_blob_list;
-       /**
-        * @edid_property: Default connector property to hold the EDID of the
-        * currently connected sink, if any.
-        */
-       struct drm_property *edid_property;
-       /**
-        * @dpms_property: Default connector property to control the
-        * connector's DPMS state.
-        */
-       struct drm_property *dpms_property;
-       /**
-        * @path_property: Default connector property to hold the DP MST path
-        * for the port.
-        */
-       struct drm_property *path_property;
-       /**
-        * @tile_property: Default connector property to store the tile
-        * position of a tiled screen, for sinks which need to be driven with
-        * multiple CRTCs.
-        */
-       struct drm_property *tile_property;
-       /**
-        * @plane_type_property: Default plane property to differentiate
-        * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
-        */
-       struct drm_property *plane_type_property;
-       /**
-        * @prop_src_x: Default atomic plane property for the plane source
-        * position in the connected &drm_framebuffer.
-        */
-       struct drm_property *prop_src_x;
-       /**
-        * @prop_src_y: Default atomic plane property for the plane source
-        * position in the connected &drm_framebuffer.
-        */
-       struct drm_property *prop_src_y;
-       /**
-        * @prop_src_w: Default atomic plane property for the plane source
-        * position in the connected &drm_framebuffer.
-        */
-       struct drm_property *prop_src_w;
-       /**
-        * @prop_src_h: Default atomic plane property for the plane source
-        * position in the connected &drm_framebuffer.
-        */
-       struct drm_property *prop_src_h;
-       /**
-        * @prop_crtc_x: Default atomic plane property for the plane destination
-        * position in the &drm_crtc is is being shown on.
-        */
-       struct drm_property *prop_crtc_x;
-       /**
-        * @prop_crtc_y: Default atomic plane property for the plane destination
-        * position in the &drm_crtc is is being shown on.
-        */
-       struct drm_property *prop_crtc_y;
-       /**
-        * @prop_crtc_w: Default atomic plane property for the plane destination
-        * position in the &drm_crtc is is being shown on.
-        */
-       struct drm_property *prop_crtc_w;
-       /**
-        * @prop_crtc_h: Default atomic plane property for the plane destination
-        * position in the &drm_crtc is is being shown on.
-        */
-       struct drm_property *prop_crtc_h;
-       /**
-        * @prop_fb_id: Default atomic plane property to specify the
-        * &drm_framebuffer.
-        */
-       struct drm_property *prop_fb_id;
-       /**
-        * @prop_crtc_id: Default atomic plane property to specify the
-        * &drm_crtc.
-        */
-       struct drm_property *prop_crtc_id;
-       /**
-        * @prop_active: Default atomic CRTC property to control the active
-        * state, which is the simplified implementation for DPMS in atomic
-        * drivers.
-        */
-       struct drm_property *prop_active;
-       /**
-        * @prop_mode_id: Default atomic CRTC property to set the mode for a
-        * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
-        * connectors must be of and active must be set to disabled, too.
-        */
-       struct drm_property *prop_mode_id;
-
-       /**
-        * @dvi_i_subconnector_property: Optional DVI-I property to
-        * differentiate between analog or digital mode.
-        */
-       struct drm_property *dvi_i_subconnector_property;
-       /**
-        * @dvi_i_select_subconnector_property: Optional DVI-I property to
-        * select between analog or digital mode.
-        */
-       struct drm_property *dvi_i_select_subconnector_property;
-
-       /**
-        * @tv_subconnector_property: Optional TV property to differentiate
-        * between different TV connector types.
-        */
-       struct drm_property *tv_subconnector_property;
-       /**
-        * @tv_select_subconnector_property: Optional TV property to select
-        * between different TV connector types.
-        */
-       struct drm_property *tv_select_subconnector_property;
-       /**
-        * @tv_mode_property: Optional TV property to select
-        * the output TV mode.
-        */
-       struct drm_property *tv_mode_property;
-       /**
-        * @tv_left_margin_property: Optional TV property to set the left
-        * margin.
-        */
-       struct drm_property *tv_left_margin_property;
-       /**
-        * @tv_right_margin_property: Optional TV property to set the right
-        * margin.
-        */
-       struct drm_property *tv_right_margin_property;
-       /**
-        * @tv_top_margin_property: Optional TV property to set the right
-        * margin.
-        */
-       struct drm_property *tv_top_margin_property;
-       /**
-        * @tv_bottom_margin_property: Optional TV property to set the right
-        * margin.
-        */
-       struct drm_property *tv_bottom_margin_property;
-       /**
-        * @tv_brightness_property: Optional TV property to set the
-        * brightness.
-        */
-       struct drm_property *tv_brightness_property;
-       /**
-        * @tv_contrast_property: Optional TV property to set the
-        * contrast.
-        */
-       struct drm_property *tv_contrast_property;
-       /**
-        * @tv_flicker_reduction_property: Optional TV property to control the
-        * flicker reduction mode.
-        */
-       struct drm_property *tv_flicker_reduction_property;
-       /**
-        * @tv_overscan_property: Optional TV property to control the overscan
-        * setting.
-        */
-       struct drm_property *tv_overscan_property;
-       /**
-        * @tv_saturation_property: Optional TV property to set the
-        * saturation.
-        */
-       struct drm_property *tv_saturation_property;
-       /**
-        * @tv_hue_property: Optional TV property to set the hue.
-        */
-       struct drm_property *tv_hue_property;
-
-       /**
-        * @scaling_mode_property: Optional connector property to control the
-        * upscaling, mostly used for built-in panels.
-        */
-       struct drm_property *scaling_mode_property;
-       /**
-        * @aspect_ratio_property: Optional connector property to control the
-        * HDMI infoframe aspect ratio setting.
-        */
-       struct drm_property *aspect_ratio_property;
-       /**
-        * @degamma_lut_property: Optional CRTC property to set the LUT used to
-        * convert the framebuffer's colors to linear gamma.
-        */
-       struct drm_property *degamma_lut_property;
-       /**
-        * @degamma_lut_size_property: Optional CRTC property for the size of
-        * the degamma LUT as supported by the driver (read-only).
-        */
-       struct drm_property *degamma_lut_size_property;
-       /**
-        * @ctm_property: Optional CRTC property to set the
-        * matrix used to convert colors after the lookup in the
-        * degamma LUT.
-        */
-       struct drm_property *ctm_property;
-       /**
-        * @gamma_lut_property: Optional CRTC property to set the LUT used to
-        * convert the colors, after the CTM matrix, to the gamma space of the
-        * connected screen.
-        */
-       struct drm_property *gamma_lut_property;
-       /**
-        * @gamma_lut_size_property: Optional CRTC property for the size of the
-        * gamma LUT as supported by the driver (read-only).
-        */
-       struct drm_property *gamma_lut_size_property;
-
-       /**
-        * @suggested_x_property: Optional connector property with a hint for
-        * the position of the output on the host's screen.
-        */
-       struct drm_property *suggested_x_property;
-       /**
-        * @suggested_y_property: Optional connector property with a hint for
-        * the position of the output on the host's screen.
-        */
-       struct drm_property *suggested_y_property;
-
-       /* dumb ioctl parameters */
-       uint32_t preferred_depth, prefer_shadow;
-
-       /**
-        * @async_page_flip: Does this device support async flips on the primary
-        * plane?
-        */
-       bool async_page_flip;
-
-       /**
-        * @allow_fb_modifiers:
-        *
-        * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
-        */
-       bool allow_fb_modifiers;
-
-       /* cursor size */
-       uint32_t cursor_width, cursor_height;
-
-       struct drm_mode_config_helper_funcs *helper_private;
-};
-
 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
 
 extern __printf(6, 7)
@@ -1418,10 +808,6 @@ extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
 extern int drm_crtc_force_disable(struct drm_crtc *crtc);
 extern int drm_crtc_force_disable_all(struct drm_device *dev);
 
-extern void drm_mode_config_init(struct drm_device *dev);
-extern void drm_mode_config_reset(struct drm_device *dev);
-extern void drm_mode_config_cleanup(struct drm_device *dev);
-
 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
 
 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
new file mode 100644 (file)
index 0000000..5d11b25
--- /dev/null
@@ -0,0 +1,652 @@
+/*
+ * Copyright (c) 2016 Intel Corporation
+ *
+ * Permission to use, copy, modify, distribute, and sell this software and its
+ * documentation for any purpose is hereby granted without fee, provided that
+ * the above copyright notice appear in all copies and that both that copyright
+ * notice and this permission notice appear in supporting documentation, and
+ * that the name of the copyright holders not be used in advertising or
+ * publicity pertaining to distribution of the software without specific,
+ * written prior permission.  The copyright holders make no representations
+ * about the suitability of this software for any purpose.  It is provided "as
+ * is" without express or implied warranty.
+ *
+ * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+ * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+ * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+ * OF THIS SOFTWARE.
+ */
+
+#ifndef __DRM_MODE_CONFIG_H__
+#define __DRM_MODE_CONFIG_H__
+
+#include <linux/mutex.h>
+#include <linux/types.h>
+#include <linux/idr.h>
+#include <linux/workqueue.h>
+
+#include <drm/drm_modeset_lock.h>
+
+struct drm_file;
+struct drm_device;
+struct drm_atomic_state;
+struct drm_mode_fb_cmd2;
+
+/**
+ * struct drm_mode_config_funcs - basic driver provided mode setting functions
+ *
+ * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
+ * involve drivers.
+ */
+struct drm_mode_config_funcs {
+       /**
+        * @fb_create:
+        *
+        * Create a new framebuffer object. The core does basic checks on the
+        * requested metadata, but most of that is left to the driver. See
+        * struct &drm_mode_fb_cmd2 for details.
+        *
+        * If the parameters are deemed valid and the backing storage objects in
+        * the underlying memory manager all exist, then the driver allocates
+        * a new &drm_framebuffer structure, subclassed to contain
+        * driver-specific information (like the internal native buffer object
+        * references). It also needs to fill out all relevant metadata, which
+        * should be done by calling drm_helper_mode_fill_fb_struct().
+        *
+        * The initialization is finalized by calling drm_framebuffer_init(),
+        * which registers the framebuffer and makes it accessible to other
+        * threads.
+        *
+        * RETURNS:
+        *
+        * A new framebuffer with an initial reference count of 1 or a negative
+        * error code encoded with ERR_PTR().
+        */
+       struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
+                                            struct drm_file *file_priv,
+                                            const struct drm_mode_fb_cmd2 *mode_cmd);
+
+       /**
+        * @output_poll_changed:
+        *
+        * Callback used by helpers to inform the driver of output configuration
+        * changes.
+        *
+        * Drivers implementing fbdev emulation with the helpers can call
+        * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
+        * helper of output changes.
+        *
+        * FIXME:
+        *
+        * Except that there's no vtable for device-level helper callbacks
+        * there's no reason this is a core function.
+        */
+       void (*output_poll_changed)(struct drm_device *dev);
+
+       /**
+        * @atomic_check:
+        *
+        * This is the only hook to validate an atomic modeset update. This
+        * function must reject any modeset and state changes which the hardware
+        * or driver doesn't support. This includes but is of course not limited
+        * to:
+        *
+        *  - Checking that the modes, framebuffers, scaling and placement
+        *    requirements and so on are within the limits of the hardware.
+        *
+        *  - Checking that any hidden shared resources are not oversubscribed.
+        *    This can be shared PLLs, shared lanes, overall memory bandwidth,
+        *    display fifo space (where shared between planes or maybe even
+        *    CRTCs).
+        *
+        *  - Checking that virtualized resources exported to userspace are not
+        *    oversubscribed. For various reasons it can make sense to expose
+        *    more planes, crtcs or encoders than which are physically there. One
+        *    example is dual-pipe operations (which generally should be hidden
+        *    from userspace if when lockstepped in hardware, exposed otherwise),
+        *    where a plane might need 1 hardware plane (if it's just on one
+        *    pipe), 2 hardware planes (when it spans both pipes) or maybe even
+        *    shared a hardware plane with a 2nd plane (if there's a compatible
+        *    plane requested on the area handled by the other pipe).
+        *
+        *  - Check that any transitional state is possible and that if
+        *    requested, the update can indeed be done in the vblank period
+        *    without temporarily disabling some functions.
+        *
+        *  - Check any other constraints the driver or hardware might have.
+        *
+        *  - This callback also needs to correctly fill out the &drm_crtc_state
+        *    in this update to make sure that drm_atomic_crtc_needs_modeset()
+        *    reflects the nature of the possible update and returns true if and
+        *    only if the update cannot be applied without tearing within one
+        *    vblank on that CRTC. The core uses that information to reject
+        *    updates which require a full modeset (i.e. blanking the screen, or
+        *    at least pausing updates for a substantial amount of time) if
+        *    userspace has disallowed that in its request.
+        *
+        *  - The driver also does not need to repeat basic input validation
+        *    like done for the corresponding legacy entry points. The core does
+        *    that before calling this hook.
+        *
+        * See the documentation of @atomic_commit for an exhaustive list of
+        * error conditions which don't have to be checked at the
+        * ->atomic_check() stage?
+        *
+        * See the documentation for struct &drm_atomic_state for how exactly
+        * an atomic modeset update is described.
+        *
+        * Drivers using the atomic helpers can implement this hook using
+        * drm_atomic_helper_check(), or one of the exported sub-functions of
+        * it.
+        *
+        * RETURNS:
+        *
+        * 0 on success or one of the below negative error codes:
+        *
+        *  - -EINVAL, if any of the above constraints are violated.
+        *
+        *  - -EDEADLK, when returned from an attempt to acquire an additional
+        *    &drm_modeset_lock through drm_modeset_lock().
+        *
+        *  - -ENOMEM, if allocating additional state sub-structures failed due
+        *    to lack of memory.
+        *
+        *  - -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.
+        */
+       int (*atomic_check)(struct drm_device *dev,
+                           struct drm_atomic_state *state);
+
+       /**
+        * @atomic_commit:
+        *
+        * This is the only hook to commit an atomic modeset update. The core
+        * guarantees that @atomic_check has been called successfully before
+        * calling this function, and that nothing has been changed in the
+        * interim.
+        *
+        * See the documentation for struct &drm_atomic_state for how exactly
+        * an atomic modeset update is described.
+        *
+        * Drivers using the atomic helpers can implement this hook using
+        * drm_atomic_helper_commit(), or one of the exported sub-functions of
+        * it.
+        *
+        * Nonblocking commits (as indicated with the nonblock parameter) must
+        * do any preparatory work which might result in an unsuccessful commit
+        * in the context of this callback. The only exceptions are hardware
+        * errors resulting in -EIO. But even in that case the driver must
+        * ensure that the display pipe is at least running, to avoid
+        * compositors crashing when pageflips don't work. Anything else,
+        * specifically committing the update to the hardware, should be done
+        * without blocking the caller. For updates which do not require a
+        * modeset this must be guaranteed.
+        *
+        * The driver must wait for any pending rendering to the new
+        * framebuffers to complete before executing the flip. It should also
+        * wait for any pending rendering from other drivers if the underlying
+        * buffer is a shared dma-buf. Nonblocking commits must not wait for
+        * rendering in the context of this callback.
+        *
+        * An application can request to be notified when the atomic commit has
+        * completed. These events are per-CRTC and can be distinguished by the
+        * CRTC index supplied in &drm_event to userspace.
+        *
+        * The drm core will supply a struct &drm_event in the event
+        * member of each CRTC's &drm_crtc_state structure. See the
+        * documentation for &drm_crtc_state for more details about the precise
+        * semantics of this event.
+        *
+        * NOTE:
+        *
+        * Drivers are not allowed to shut down any display pipe successfully
+        * enabled through an atomic commit on their own. Doing so can result in
+        * compositors crashing if a page flip is suddenly rejected because the
+        * pipe is off.
+        *
+        * RETURNS:
+        *
+        * 0 on success or one of the below negative error codes:
+        *
+        *  - -EBUSY, if a nonblocking updated is requested and there is
+        *    an earlier updated pending. Drivers are allowed to support a queue
+        *    of outstanding updates, but currently no driver supports that.
+        *    Note that drivers must wait for preceding updates to complete if a
+        *    synchronous update is requested, they are not allowed to fail the
+        *    commit in that case.
+        *
+        *  - -ENOMEM, if the driver failed to allocate memory. Specifically
+        *    this can happen when trying to pin framebuffers, which must only
+        *    be done when committing the state.
+        *
+        *  - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
+        *    that the driver has run out of vram, iommu space or similar GPU
+        *    address space needed for framebuffer.
+        *
+        *  - -EIO, if the hardware completely died.
+        *
+        *  - -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 of view all errors are
+        *    treated equally.
+        *
+        * This list is exhaustive. Specifically this hook is not allowed to
+        * return -EINVAL (any invalid requests should be caught in
+        * @atomic_check) or -EDEADLK (this function must not acquire
+        * additional modeset locks).
+        */
+       int (*atomic_commit)(struct drm_device *dev,
+                            struct drm_atomic_state *state,
+                            bool nonblock);
+
+       /**
+        * @atomic_state_alloc:
+        *
+        * This optional hook can be used by drivers that want to subclass struct
+        * &drm_atomic_state to be able to track their own driver-private global
+        * state easily. If this hook is implemented, drivers must also
+        * implement @atomic_state_clear and @atomic_state_free.
+        *
+        * RETURNS:
+        *
+        * A new &drm_atomic_state on success or NULL on failure.
+        */
+       struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
+
+       /**
+        * @atomic_state_clear:
+        *
+        * This hook must clear any driver private state duplicated into the
+        * passed-in &drm_atomic_state. This hook is called when the caller
+        * encountered a &drm_modeset_lock deadlock and needs to drop all
+        * already acquired locks as part of the deadlock avoidance dance
+        * implemented in drm_modeset_lock_backoff().
+        *
+        * Any duplicated state must be invalidated since a concurrent atomic
+        * update might change it, and the drm atomic interfaces always apply
+        * updates as relative changes to the current state.
+        *
+        * Drivers that implement this must call drm_atomic_state_default_clear()
+        * to clear common state.
+        */
+       void (*atomic_state_clear)(struct drm_atomic_state *state);
+
+       /**
+        * @atomic_state_free:
+        *
+        * This hook needs driver private resources and the &drm_atomic_state
+        * itself. Note that the core first calls drm_atomic_state_clear() to
+        * avoid code duplicate between the clear and free hooks.
+        *
+        * Drivers that implement this must call drm_atomic_state_default_free()
+        * to release common resources.
+        */
+       void (*atomic_state_free)(struct drm_atomic_state *state);
+};
+
+/**
+ * struct drm_mode_config - Mode configuration control structure
+ * @mutex: mutex protecting KMS related lists and structures
+ * @connection_mutex: ww mutex protecting connector state and routing
+ * @acquire_ctx: global implicit acquire context used by atomic drivers for
+ *     legacy IOCTLs
+ * @fb_lock: mutex to protect fb state and lists
+ * @num_fb: number of fbs available
+ * @fb_list: list of framebuffers available
+ * @num_encoder: number of encoders on this device
+ * @encoder_list: list of encoder objects
+ * @num_overlay_plane: number of overlay planes on this device
+ * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
+ * @plane_list: list of plane objects
+ * @num_crtc: number of CRTCs on this device
+ * @crtc_list: list of CRTC objects
+ * @property_list: list of property objects
+ * @min_width: minimum pixel width on this device
+ * @min_height: minimum pixel height on this device
+ * @max_width: maximum pixel width on this device
+ * @max_height: maximum pixel height on this device
+ * @funcs: core driver provided mode setting functions
+ * @fb_base: base address of the framebuffer
+ * @poll_enabled: track polling support for this device
+ * @poll_running: track polling status for this device
+ * @delayed_event: track delayed poll uevent deliver for this device
+ * @output_poll_work: delayed work for polling in process context
+ * @property_blob_list: list of all the blob property objects
+ * @blob_lock: mutex for blob property allocation and management
+ * @*_property: core property tracking
+ * @preferred_depth: preferred RBG pixel depth, used by fb helpers
+ * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
+ * @cursor_width: hint to userspace for max cursor width
+ * @cursor_height: hint to userspace for max cursor height
+ * @helper_private: mid-layer private data
+ *
+ * Core mode resource tracking structure.  All CRTC, encoders, and connectors
+ * enumerated by the driver are added here, as are global properties.  Some
+ * global restrictions are also here, e.g. dimension restrictions.
+ */
+struct drm_mode_config {
+       struct mutex mutex; /* protects configuration (mode lists etc.) */
+       struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
+       struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
+
+       /**
+        * @idr_mutex:
+        *
+        * Mutex for KMS ID allocation and management. Protects both @crtc_idr
+        * and @tile_idr.
+        */
+       struct mutex idr_mutex;
+
+       /**
+        * @crtc_idr:
+        *
+        * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
+        * connector, modes - just makes life easier to have only one.
+        */
+       struct idr crtc_idr;
+
+       /**
+        * @tile_idr:
+        *
+        * Use this idr for allocating new IDs for tiled sinks like use in some
+        * high-res DP MST screens.
+        */
+       struct idr tile_idr;
+
+       struct mutex fb_lock; /* proctects global and per-file fb lists */
+       int num_fb;
+       struct list_head fb_list;
+
+       /**
+        * @num_connector: Number of connectors on this device.
+        */
+       int num_connector;
+       /**
+        * @connector_ida: ID allocator for connector indices.
+        */
+       struct ida connector_ida;
+       /**
+        * @connector_list: List of connector objects.
+        */
+       struct list_head connector_list;
+       int num_encoder;
+       struct list_head encoder_list;
+
+       /*
+        * Track # of overlay planes separately from # of total planes.  By
+        * default we only advertise overlay planes to userspace; if userspace
+        * sets the "universal plane" capability bit, we'll go ahead and
+        * expose all planes.
+        */
+       int num_overlay_plane;
+       int num_total_plane;
+       struct list_head plane_list;
+
+       int num_crtc;
+       struct list_head crtc_list;
+
+       struct list_head property_list;
+
+       int min_width, min_height;
+       int max_width, max_height;
+       const struct drm_mode_config_funcs *funcs;
+       resource_size_t fb_base;
+
+       /* output poll support */
+       bool poll_enabled;
+       bool poll_running;
+       bool delayed_event;
+       struct delayed_work output_poll_work;
+
+       struct mutex blob_lock;
+
+       /* pointers to standard properties */
+       struct list_head property_blob_list;
+       /**
+        * @edid_property: Default connector property to hold the EDID of the
+        * currently connected sink, if any.
+        */
+       struct drm_property *edid_property;
+       /**
+        * @dpms_property: Default connector property to control the
+        * connector's DPMS state.
+        */
+       struct drm_property *dpms_property;
+       /**
+        * @path_property: Default connector property to hold the DP MST path
+        * for the port.
+        */
+       struct drm_property *path_property;
+       /**
+        * @tile_property: Default connector property to store the tile
+        * position of a tiled screen, for sinks which need to be driven with
+        * multiple CRTCs.
+        */
+       struct drm_property *tile_property;
+       /**
+        * @plane_type_property: Default plane property to differentiate
+        * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
+        */
+       struct drm_property *plane_type_property;
+       /**
+        * @prop_src_x: Default atomic plane property for the plane source
+        * position in the connected &drm_framebuffer.
+        */
+       struct drm_property *prop_src_x;
+       /**
+        * @prop_src_y: Default atomic plane property for the plane source
+        * position in the connected &drm_framebuffer.
+        */
+       struct drm_property *prop_src_y;
+       /**
+        * @prop_src_w: Default atomic plane property for the plane source
+        * position in the connected &drm_framebuffer.
+        */
+       struct drm_property *prop_src_w;
+       /**
+        * @prop_src_h: Default atomic plane property for the plane source
+        * position in the connected &drm_framebuffer.
+        */
+       struct drm_property *prop_src_h;
+       /**
+        * @prop_crtc_x: Default atomic plane property for the plane destination
+        * position in the &drm_crtc is is being shown on.
+        */
+       struct drm_property *prop_crtc_x;
+       /**
+        * @prop_crtc_y: Default atomic plane property for the plane destination
+        * position in the &drm_crtc is is being shown on.
+        */
+       struct drm_property *prop_crtc_y;
+       /**
+        * @prop_crtc_w: Default atomic plane property for the plane destination
+        * position in the &drm_crtc is is being shown on.
+        */
+       struct drm_property *prop_crtc_w;
+       /**
+        * @prop_crtc_h: Default atomic plane property for the plane destination
+        * position in the &drm_crtc is is being shown on.
+        */
+       struct drm_property *prop_crtc_h;
+       /**
+        * @prop_fb_id: Default atomic plane property to specify the
+        * &drm_framebuffer.
+        */
+       struct drm_property *prop_fb_id;
+       /**
+        * @prop_crtc_id: Default atomic plane property to specify the
+        * &drm_crtc.
+        */
+       struct drm_property *prop_crtc_id;
+       /**
+        * @prop_active: Default atomic CRTC property to control the active
+        * state, which is the simplified implementation for DPMS in atomic
+        * drivers.
+        */
+       struct drm_property *prop_active;
+       /**
+        * @prop_mode_id: Default atomic CRTC property to set the mode for a
+        * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
+        * connectors must be of and active must be set to disabled, too.
+        */
+       struct drm_property *prop_mode_id;
+
+       /**
+        * @dvi_i_subconnector_property: Optional DVI-I property to
+        * differentiate between analog or digital mode.
+        */
+       struct drm_property *dvi_i_subconnector_property;
+       /**
+        * @dvi_i_select_subconnector_property: Optional DVI-I property to
+        * select between analog or digital mode.
+        */
+       struct drm_property *dvi_i_select_subconnector_property;
+
+       /**
+        * @tv_subconnector_property: Optional TV property to differentiate
+        * between different TV connector types.
+        */
+       struct drm_property *tv_subconnector_property;
+       /**
+        * @tv_select_subconnector_property: Optional TV property to select
+        * between different TV connector types.
+        */
+       struct drm_property *tv_select_subconnector_property;
+       /**
+        * @tv_mode_property: Optional TV property to select
+        * the output TV mode.
+        */
+       struct drm_property *tv_mode_property;
+       /**
+        * @tv_left_margin_property: Optional TV property to set the left
+        * margin.
+        */
+       struct drm_property *tv_left_margin_property;
+       /**
+        * @tv_right_margin_property: Optional TV property to set the right
+        * margin.
+        */
+       struct drm_property *tv_right_margin_property;
+       /**
+        * @tv_top_margin_property: Optional TV property to set the right
+        * margin.
+        */
+       struct drm_property *tv_top_margin_property;
+       /**
+        * @tv_bottom_margin_property: Optional TV property to set the right
+        * margin.
+        */
+       struct drm_property *tv_bottom_margin_property;
+       /**
+        * @tv_brightness_property: Optional TV property to set the
+        * brightness.
+        */
+       struct drm_property *tv_brightness_property;
+       /**
+        * @tv_contrast_property: Optional TV property to set the
+        * contrast.
+        */
+       struct drm_property *tv_contrast_property;
+       /**
+        * @tv_flicker_reduction_property: Optional TV property to control the
+        * flicker reduction mode.
+        */
+       struct drm_property *tv_flicker_reduction_property;
+       /**
+        * @tv_overscan_property: Optional TV property to control the overscan
+        * setting.
+        */
+       struct drm_property *tv_overscan_property;
+       /**
+        * @tv_saturation_property: Optional TV property to set the
+        * saturation.
+        */
+       struct drm_property *tv_saturation_property;
+       /**
+        * @tv_hue_property: Optional TV property to set the hue.
+        */
+       struct drm_property *tv_hue_property;
+
+       /**
+        * @scaling_mode_property: Optional connector property to control the
+        * upscaling, mostly used for built-in panels.
+        */
+       struct drm_property *scaling_mode_property;
+       /**
+        * @aspect_ratio_property: Optional connector property to control the
+        * HDMI infoframe aspect ratio setting.
+        */
+       struct drm_property *aspect_ratio_property;
+       /**
+        * @degamma_lut_property: Optional CRTC property to set the LUT used to
+        * convert the framebuffer's colors to linear gamma.
+        */
+       struct drm_property *degamma_lut_property;
+       /**
+        * @degamma_lut_size_property: Optional CRTC property for the size of
+        * the degamma LUT as supported by the driver (read-only).
+        */
+       struct drm_property *degamma_lut_size_property;
+       /**
+        * @ctm_property: Optional CRTC property to set the
+        * matrix used to convert colors after the lookup in the
+        * degamma LUT.
+        */
+       struct drm_property *ctm_property;
+       /**
+        * @gamma_lut_property: Optional CRTC property to set the LUT used to
+        * convert the colors, after the CTM matrix, to the gamma space of the
+        * connected screen.
+        */
+       struct drm_property *gamma_lut_property;
+       /**
+        * @gamma_lut_size_property: Optional CRTC property for the size of the
+        * gamma LUT as supported by the driver (read-only).
+        */
+       struct drm_property *gamma_lut_size_property;
+
+       /**
+        * @suggested_x_property: Optional connector property with a hint for
+        * the position of the output on the host's screen.
+        */
+       struct drm_property *suggested_x_property;
+       /**
+        * @suggested_y_property: Optional connector property with a hint for
+        * the position of the output on the host's screen.
+        */
+       struct drm_property *suggested_y_property;
+
+       /* dumb ioctl parameters */
+       uint32_t preferred_depth, prefer_shadow;
+
+       /**
+        * @async_page_flip: Does this device support async flips on the primary
+        * plane?
+        */
+       bool async_page_flip;
+
+       /**
+        * @allow_fb_modifiers:
+        *
+        * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
+        */
+       bool allow_fb_modifiers;
+
+       /* cursor size */
+       uint32_t cursor_width, cursor_height;
+
+       struct drm_mode_config_helper_funcs *helper_private;
+};
+
+void drm_mode_config_init(struct drm_device *dev);
+void drm_mode_config_reset(struct drm_device *dev);
+void drm_mode_config_cleanup(struct drm_device *dev);
+
+#endif