Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 28575f16 authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm: Extract drm_mode_config.[hc] 



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: default avatarChris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
parent 83113df5

Documentation/gpu/drm-kms.rst

+20 −12
Original line number Diff line number Diff line
@@ -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

========================

drivers/gpu/drm/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -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

drivers/gpu/drm/drm_crtc.c

+2 −460
Original line number Diff line number Diff line
@@ -45,18 +45,6 @@ 
#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

 *

drivers/gpu/drm/drm_crtc_internal.h

+14 −8
Original line number Diff line number Diff line
@@ -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);