[linux-2.6-block.git] / drivers / gpu / drm / drm_mode_object.c

/*
 * 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 <linux/export.h>
#include <linux/uaccess.h>

#include <drm/drm_atomic.h>
#include <drm/drm_drv.h>
#include <drm/drm_device.h>
#include <drm/drm_file.h>
#include <drm/drm_mode_object.h>
#include <drm/drm_print.h>

#include "drm_crtc_internal.h"

/*
 * Internal function to assign a slot in the object idr and optionally
 * register the object into the idr.
 */
int __drm_mode_object_add(struct drm_device *dev, struct drm_mode_object *obj,
			  uint32_t obj_type, bool register_obj,
			  void (*obj_free_cb)(struct kref *kref))
{
	int ret;

	WARN_ON(!dev->driver->load && dev->registered && !obj_free_cb);

	mutex_lock(&dev->mode_config.idr_mutex);
	ret = idr_alloc(&dev->mode_config.object_idr, register_obj ? obj : NULL,
			1, 0, GFP_KERNEL);
	if (ret >= 0) {
		/*
		 * Set up the object linking under the protection of the idr
		 * lock so that other users can't see inconsistent state.
		 */
		obj->id = ret;
		obj->type = obj_type;
		if (obj_free_cb) {
			obj->free_cb = obj_free_cb;
			kref_init(&obj->refcount);
		}
	}
	mutex_unlock(&dev->mode_config.idr_mutex);

	return ret < 0 ? ret : 0;
}

/**
 * drm_mode_object_add - allocate a new modeset identifier
 * @dev: DRM device
 * @obj: object pointer, used to generate unique ID
 * @obj_type: object type
 *
 * Create a unique identifier based on @ptr in @dev's identifier space.  Used
 * for tracking modes, CRTCs and connectors.
 *
 * Returns:
 * Zero on success, error code on failure.
 */
int drm_mode_object_add(struct drm_device *dev,
			struct drm_mode_object *obj, uint32_t obj_type)
{
	return __drm_mode_object_add(dev, obj, obj_type, true, NULL);
}

void drm_mode_object_register(struct drm_device *dev,
			      struct drm_mode_object *obj)
{
	mutex_lock(&dev->mode_config.idr_mutex);
	idr_replace(&dev->mode_config.object_idr, obj, obj->id);
	mutex_unlock(&dev->mode_config.idr_mutex);
}

/**
 * drm_mode_object_unregister - free a modeset identifer
 * @dev: DRM device
 * @object: object to free
 *
 * Free @id from @dev's unique identifier pool.
 * This function can be called multiple times, and guards against
 * multiple removals.
 * These modeset identifiers are _not_ reference counted. Hence don't use this
 * for reference counted modeset objects like framebuffers.
 */
void drm_mode_object_unregister(struct drm_device *dev,
				struct drm_mode_object *object)
{
	WARN_ON(!dev->driver->load && dev->registered && !object->free_cb);

	mutex_lock(&dev->mode_config.idr_mutex);
	if (object->id) {
		idr_remove(&dev->mode_config.object_idr, object->id);
		object->id = 0;
	}
	mutex_unlock(&dev->mode_config.idr_mutex);
}

/**
 * drm_mode_object_lease_required - check types which must be leased to be used
 * @type: type of object
 *
 * Returns whether the provided type of drm_mode_object must
 * be owned or leased to be used by a process.
 */
bool drm_mode_object_lease_required(uint32_t type)
{
	switch(type) {
	case DRM_MODE_OBJECT_CRTC:
	case DRM_MODE_OBJECT_CONNECTOR:
	case DRM_MODE_OBJECT_PLANE:
		return true;
	default:
		return false;
	}
}

struct drm_mode_object *__drm_mode_object_find(struct drm_device *dev,
					       struct drm_file *file_priv,
					       uint32_t id, uint32_t type)
{
	struct drm_mode_object *obj = NULL;

	mutex_lock(&dev->mode_config.idr_mutex);
	obj = idr_find(&dev->mode_config.object_idr, id);
	if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
		obj = NULL;
	if (obj && obj->id != id)
		obj = NULL;

	if (obj && drm_mode_object_lease_required(obj->type) &&
	    !_drm_lease_held(file_priv, obj->id))
		obj = NULL;

	if (obj && obj->free_cb) {
		if (!kref_get_unless_zero(&obj->refcount))
			obj = NULL;
	}
	mutex_unlock(&dev->mode_config.idr_mutex);

	return obj;
}

/**
 * drm_mode_object_find - look up a drm object with static lifetime
 * @dev: drm device
 * @file_priv: drm file
 * @id: id of the mode object
 * @type: type of the mode object
 *
 * This function is used to look up a modeset object. It will acquire a
 * reference for reference counted objects. This reference must be dropped again
 * by callind drm_mode_object_put().
 */
struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
		struct drm_file *file_priv,
		uint32_t id, uint32_t type)
{
	struct drm_mode_object *obj = NULL;

	obj = __drm_mode_object_find(dev, file_priv, id, type);
	return obj;
}
EXPORT_SYMBOL(drm_mode_object_find);

/**
 * drm_mode_object_put - release a mode object reference
 * @obj: DRM mode object
 *
 * This function decrements the object's refcount if it is a refcounted modeset
 * object. It is a no-op on any other object. This is used to drop references
 * acquired with drm_mode_object_get().
 */
void drm_mode_object_put(struct drm_mode_object *obj)
{
	if (obj->free_cb) {
		DRM_DEBUG("OBJ ID: %d (%d)\n", obj->id, kref_read(&obj->refcount));
		kref_put(&obj->refcount, obj->free_cb);
	}
}
EXPORT_SYMBOL(drm_mode_object_put);

/**
 * drm_mode_object_get - acquire a mode object reference
 * @obj: DRM mode object
 *
 * This function increments the object's refcount if it is a refcounted modeset
 * object. It is a no-op on any other object. References should be dropped again
 * by calling drm_mode_object_put().
 */
void drm_mode_object_get(struct drm_mode_object *obj)
{
	if (obj->free_cb) {
		DRM_DEBUG("OBJ ID: %d (%d)\n", obj->id, kref_read(&obj->refcount));
		kref_get(&obj->refcount);
	}
}
EXPORT_SYMBOL(drm_mode_object_get);

/**
 * drm_object_attach_property - attach a property to a modeset object
 * @obj: drm modeset object
 * @property: property to attach
 * @init_val: initial value of the property
 *
 * This attaches the given property to the modeset object with the given initial
 * value. Currently this function cannot fail since the properties are stored in
 * a statically sized array.
 *
 * Note that all properties must be attached before the object itself is
 * registered and accessible from userspace.
 */
void drm_object_attach_property(struct drm_mode_object *obj,
				struct drm_property *property,
				uint64_t init_val)
{
	int count = obj->properties->count;
	struct drm_device *dev = property->dev;


	if (obj->type == DRM_MODE_OBJECT_CONNECTOR) {
		struct drm_connector *connector = obj_to_connector(obj);

		WARN_ON(!dev->driver->load &&
			connector->registration_state == DRM_CONNECTOR_REGISTERED);
	} else {
		WARN_ON(!dev->driver->load && dev->registered);
	}

	if (count == DRM_OBJECT_MAX_PROPERTY) {
		WARN(1, "Failed to attach object property (type: 0x%x). Please "
			"increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
			"you see this message on the same object type.\n",
			obj->type);
		return;
	}

	obj->properties->properties[count] = property;
	obj->properties->values[count] = init_val;
	obj->properties->count++;
}
EXPORT_SYMBOL(drm_object_attach_property);

/**
 * drm_object_property_set_value - set the value of a property
 * @obj: drm mode object to set property value for
 * @property: property to set
 * @val: value the property should be set to
 *
 * This function sets a given property on a given object. This function only
 * changes the software state of the property, it does not call into the
 * driver's ->set_property callback.
 *
 * Note that atomic drivers should not have any need to call this, the core will
 * ensure consistency of values reported back to userspace through the
 * appropriate ->atomic_get_property callback. Only legacy drivers should call
 * this function to update the tracked value (after clamping and other
 * restrictions have been applied).
 *
 * Returns:
 * Zero on success, error code on failure.
 */
int drm_object_property_set_value(struct drm_mode_object *obj,
				  struct drm_property *property, uint64_t val)
{
	int i;

	WARN_ON(drm_drv_uses_atomic_modeset(property->dev) &&
		!(property->flags & DRM_MODE_PROP_IMMUTABLE));

	for (i = 0; i < obj->properties->count; i++) {
		if (obj->properties->properties[i] == property) {
			obj->properties->values[i] = val;
			return 0;
		}
	}

	return -EINVAL;
}
EXPORT_SYMBOL(drm_object_property_set_value);

static int __drm_object_property_get_value(struct drm_mode_object *obj,
					   struct drm_property *property,
					   uint64_t *val)
{
	int i;

	/* read-only properties bypass atomic mechanism and still store
	 * their value in obj->properties->values[].. mostly to avoid
	 * having to deal w/ EDID and similar props in atomic paths:
	 */
	if (drm_drv_uses_atomic_modeset(property->dev) &&
			!(property->flags & DRM_MODE_PROP_IMMUTABLE))
		return drm_atomic_get_property(obj, property, val);

	for (i = 0; i < obj->properties->count; i++) {
		if (obj->properties->properties[i] == property) {
			*val = obj->properties->values[i];
			return 0;
		}

	}

	return -EINVAL;
}

/**
 * drm_object_property_get_value - retrieve the value of a property
 * @obj: drm mode object to get property value from
 * @property: property to retrieve
 * @val: storage for the property value
 *
 * This function retrieves the softare state of the given property for the given
 * property. Since there is no driver callback to retrieve the current property
 * value this might be out of sync with the hardware, depending upon the driver
 * and property.
 *
 * Atomic drivers should never call this function directly, the core will read
 * out property values through the various ->atomic_get_property callbacks.
 *
 * Returns:
 * Zero on success, error code on failure.
 */
int drm_object_property_get_value(struct drm_mode_object *obj,
				  struct drm_property *property, uint64_t *val)
{
	WARN_ON(drm_drv_uses_atomic_modeset(property->dev));

	return __drm_object_property_get_value(obj, property, val);
}
EXPORT_SYMBOL(drm_object_property_get_value);

/* helper for getconnector and getproperties ioctls */
int drm_mode_object_get_properties(struct drm_mode_object *obj, bool atomic,
				   uint32_t __user *prop_ptr,
				   uint64_t __user *prop_values,
				   uint32_t *arg_count_props)
{
	int i, ret, count;

	for (i = 0, count = 0; i < obj->properties->count; i++) {
		struct drm_property *prop = obj->properties->properties[i];
		uint64_t val;

		if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
			continue;

		if (*arg_count_props > count) {
			ret = __drm_object_property_get_value(obj, prop, &val);
			if (ret)
				return ret;

			if (put_user(prop->base.id, prop_ptr + count))
				return -EFAULT;

			if (put_user(val, prop_values + count))
				return -EFAULT;
		}

		count++;
	}
	*arg_count_props = count;

	return 0;
}

/**
 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
 * @dev: DRM device
 * @data: ioctl data
 * @file_priv: DRM file info
 *
 * This function retrieves the current value for an object's property. Compared
 * to the connector specific ioctl this one is extended to also work on crtc and
 * plane objects.
 *
 * Called by the user via ioctl.
 *
 * Returns:
 * Zero on success, negative errno on failure.
 */
int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
				      struct drm_file *file_priv)
{
	struct drm_mode_obj_get_properties *arg = data;
	struct drm_mode_object *obj;
	struct drm_modeset_acquire_ctx ctx;
	int ret = 0;

	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		return -EOPNOTSUPP;

	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);

	obj = drm_mode_object_find(dev, file_priv, arg->obj_id, arg->obj_type);
	if (!obj) {
		ret = -ENOENT;
		goto out;
	}
	if (!obj->properties) {
		ret = -EINVAL;
		goto out_unref;
	}

	ret = drm_mode_object_get_properties(obj, file_priv->atomic,
			(uint32_t __user *)(unsigned long)(arg->props_ptr),
			(uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
			&arg->count_props);

out_unref:
	drm_mode_object_put(obj);
out:
	DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
	return ret;
}

struct drm_property *drm_mode_obj_find_prop_id(struct drm_mode_object *obj,
					       uint32_t prop_id)
{
	int i;

	for (i = 0; i < obj->properties->count; i++)
		if (obj->properties->properties[i]->base.id == prop_id)
			return obj->properties->properties[i];

	return NULL;
}

static int set_property_legacy(struct drm_mode_object *obj,
			       struct drm_property *prop,
			       uint64_t prop_value)
{
	struct drm_device *dev = prop->dev;
	struct drm_mode_object *ref;
	struct drm_modeset_acquire_ctx ctx;
	int ret = -EINVAL;

	if (!drm_property_change_valid_get(prop, prop_value, &ref))
		return -EINVAL;

	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
	switch (obj->type) {
	case DRM_MODE_OBJECT_CONNECTOR:
		ret = drm_connector_set_obj_prop(obj, prop, prop_value);
		break;
	case DRM_MODE_OBJECT_CRTC:
		ret = drm_mode_crtc_set_obj_prop(obj, prop, prop_value);
		break;
	case DRM_MODE_OBJECT_PLANE:
		ret = drm_mode_plane_set_obj_prop(obj_to_plane(obj),
						  prop, prop_value);
		break;
	}
	drm_property_change_valid_put(prop, ref);
	DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);

	return ret;
}

static int set_property_atomic(struct drm_mode_object *obj,
			       struct drm_file *file_priv,
			       struct drm_property *prop,
			       uint64_t prop_value)
{
	struct drm_device *dev = prop->dev;
	struct drm_atomic_state *state;
	struct drm_modeset_acquire_ctx ctx;
	int ret;

	state = drm_atomic_state_alloc(dev);
	if (!state)
		return -ENOMEM;

	drm_modeset_acquire_init(&ctx, 0);
	state->acquire_ctx = &ctx;

retry:
	if (prop == state->dev->mode_config.dpms_property) {
		if (obj->type != DRM_MODE_OBJECT_CONNECTOR) {
			ret = -EINVAL;
			goto out;
		}

		ret = drm_atomic_connector_commit_dpms(state,
						       obj_to_connector(obj),
						       prop_value);
	} else {
		ret = drm_atomic_set_property(state, file_priv, obj, prop, prop_value);
		if (ret)
			goto out;
		ret = drm_atomic_commit(state);
	}
out:
	if (ret == -EDEADLK) {
		drm_atomic_state_clear(state);
		drm_modeset_backoff(&ctx);
		goto retry;
	}

	drm_atomic_state_put(state);

	drm_modeset_drop_locks(&ctx);
	drm_modeset_acquire_fini(&ctx);

	return ret;
}

int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
				    struct drm_file *file_priv)
{
	struct drm_mode_obj_set_property *arg = data;
	struct drm_mode_object *arg_obj;
	struct drm_property *property;
	int ret = -EINVAL;

	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		return -EOPNOTSUPP;

	arg_obj = drm_mode_object_find(dev, file_priv, arg->obj_id, arg->obj_type);
	if (!arg_obj)
		return -ENOENT;

	if (!arg_obj->properties)
		goto out_unref;

	property = drm_mode_obj_find_prop_id(arg_obj, arg->prop_id);
	if (!property)
		goto out_unref;

	if (drm_drv_uses_atomic_modeset(property->dev))
		ret = set_property_atomic(arg_obj, file_priv, property, arg->value);
	else
		ret = set_property_legacy(arg_obj, property, arg->value);

out_unref:
	drm_mode_object_put(arg_obj);
	return ret;
}
Commit	Line	Data
949619f3 DV	1	/*
	2	* Copyright (c) 2016 Intel Corporation
	3	*
	4	* Permission to use, copy, modify, distribute, and sell this software and its
	5	* documentation for any purpose is hereby granted without fee, provided that
	6	* the above copyright notice appear in all copies and that both that copyright
	7	* notice and this permission notice appear in supporting documentation, and
	8	* that the name of the copyright holders not be used in advertising or
	9	* publicity pertaining to distribution of the software without specific,
	10	* written prior permission. The copyright holders make no representations
	11	* about the suitability of this software for any purpose. It is provided "as
	12	* is" without express or implied warranty.
	13	*
	14	* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
	15	* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
	16	* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
	17	* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
	18	* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
	19	* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
	20	* OF THIS SOFTWARE.
	21	*/
	22
	23	#include <linux/export.h>
0500c04e SR	24	#include <linux/uaccess.h>
0500c04e SR	25
0bfd4a01	26	#include <drm/drm_atomic.h>
0500c04e SR	27	#include <drm/drm_drv.h>
	28	#include <drm/drm_device.h>
	29	#include <drm/drm_file.h>
	30	#include <drm/drm_mode_object.h>
	31	#include <drm/drm_print.h>
949619f3 DV	32
	33	#include "drm_crtc_internal.h"
	34
	35	/*
	36	* Internal function to assign a slot in the object idr and optionally
	37	* register the object into the idr.
	38	*/
2135ea7a TR	39	int __drm_mode_object_add(struct drm_device dev, struct drm_mode_object obj,
	40	uint32_t obj_type, bool register_obj,
	41	void (obj_free_cb)(struct kref kref))
949619f3 DV	42	{
	43	int ret;
	44
e0f32f78	45	WARN_ON(!dev->driver->load && dev->registered && !obj_free_cb);
4f5368b5	46
949619f3	47	mutex_lock(&dev->mode_config.idr_mutex);
b5f06893	48	ret = idr_alloc(&dev->mode_config.object_idr, register_obj ? obj : NULL,
bbc97f95	49	1, 0, GFP_KERNEL);
949619f3 DV	50	if (ret >= 0) {
	51	/*
	52	* Set up the object linking under the protection of the idr
	53	* lock so that other users can't see inconsistent state.
	54	*/
	55	obj->id = ret;
	56	obj->type = obj_type;
	57	if (obj_free_cb) {
	58	obj->free_cb = obj_free_cb;
	59	kref_init(&obj->refcount);
	60	}
	61	}
	62	mutex_unlock(&dev->mode_config.idr_mutex);
	63
	64	return ret < 0 ? ret : 0;
	65	}
	66
	67	/**
2135ea7a	68	* drm_mode_object_add - allocate a new modeset identifier
949619f3 DV	69	* @dev: DRM device
	70	* @obj: object pointer, used to generate unique ID
	71	* @obj_type: object type
	72	*
	73	* Create a unique identifier based on @ptr in @dev's identifier space. Used
2135ea7a	74	* for tracking modes, CRTCs and connectors.
949619f3 DV	75	*
	76	* Returns:
	77	* Zero on success, error code on failure.
	78	*/
2135ea7a	79	int drm_mode_object_add(struct drm_device *dev,
949619f3 DV	80	struct drm_mode_object *obj, uint32_t obj_type)
949619f3 DV	81	{
2135ea7a	82	return __drm_mode_object_add(dev, obj, obj_type, true, NULL);
949619f3 DV	83	}
	84
	85	void drm_mode_object_register(struct drm_device *dev,
	86	struct drm_mode_object *obj)
	87	{
	88	mutex_lock(&dev->mode_config.idr_mutex);
b5f06893	89	idr_replace(&dev->mode_config.object_idr, obj, obj->id);
949619f3 DV	90	mutex_unlock(&dev->mode_config.idr_mutex);
	91	}
	92
	93	/**
	94	* drm_mode_object_unregister - free a modeset identifer
	95	* @dev: DRM device
	96	* @object: object to free
	97	*
	98	* Free @id from @dev's unique identifier pool.
	99	* This function can be called multiple times, and guards against
	100	* multiple removals.
	101	* These modeset identifiers are _not_ reference counted. Hence don't use this
	102	* for reference counted modeset objects like framebuffers.
	103	*/
	104	void drm_mode_object_unregister(struct drm_device *dev,
a2511a55	105	struct drm_mode_object *object)
949619f3	106	{
e0f32f78	107	WARN_ON(!dev->driver->load && dev->registered && !object->free_cb);
4f5368b5	108
949619f3 DV	109	mutex_lock(&dev->mode_config.idr_mutex);
949619f3 DV	110	if (object->id) {
b5f06893	111	idr_remove(&dev->mode_config.object_idr, object->id);
949619f3 DV	112	object->id = 0;
	113	}
	114	mutex_unlock(&dev->mode_config.idr_mutex);
	115	}
	116
7de440db	117	/**
e9d2871f	118	* drm_mode_object_lease_required - check types which must be leased to be used
7de440db KP	119	* @type: type of object
	120	*
	121	* Returns whether the provided type of drm_mode_object must
	122	* be owned or leased to be used by a process.
	123	*/
62884cd3	124	bool drm_mode_object_lease_required(uint32_t type)
7de440db KP	125	{
	126	switch(type) {
	127	case DRM_MODE_OBJECT_CRTC:
	128	case DRM_MODE_OBJECT_CONNECTOR:
	129	case DRM_MODE_OBJECT_PLANE:
	130	return true;
	131	default:
	132	return false;
	133	}
	134	}
	135
949619f3	136	struct drm_mode_object __drm_mode_object_find(struct drm_device dev,
418da172	137	struct drm_file *file_priv,
949619f3 DV	138	uint32_t id, uint32_t type)
	139	{
	140	struct drm_mode_object *obj = NULL;
	141
	142	mutex_lock(&dev->mode_config.idr_mutex);
b5f06893	143	obj = idr_find(&dev->mode_config.object_idr, id);
949619f3 DV	144	if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
	145	obj = NULL;
	146	if (obj && obj->id != id)
	147	obj = NULL;
	148
62884cd3 KP	149	if (obj && drm_mode_object_lease_required(obj->type) &&
62884cd3 KP	150	!_drm_lease_held(file_priv, obj->id))
7de440db KP	151	obj = NULL;
7de440db KP	152
949619f3 DV	153	if (obj && obj->free_cb) {
	154	if (!kref_get_unless_zero(&obj->refcount))
	155	obj = NULL;
	156	}
	157	mutex_unlock(&dev->mode_config.idr_mutex);
	158
	159	return obj;
	160	}
	161
	162	/**
	163	* drm_mode_object_find - look up a drm object with static lifetime
e7e62c7e	164	* @dev: drm device
418da172	165	* @file_priv: drm file
949619f3 DV	166	* @id: id of the mode object
	167	* @type: type of the mode object
	168	*
	169	* This function is used to look up a modeset object. It will acquire a
	170	* reference for reference counted objects. This reference must be dropped again
020a218f	171	* by callind drm_mode_object_put().
949619f3 DV	172	*/
949619f3 DV	173	struct drm_mode_object drm_mode_object_find(struct drm_device dev,
418da172	174	struct drm_file *file_priv,
949619f3 DV	175	uint32_t id, uint32_t type)
	176	{
	177	struct drm_mode_object *obj = NULL;
	178
418da172	179	obj = __drm_mode_object_find(dev, file_priv, id, type);
949619f3 DV	180	return obj;
	181	}
	182	EXPORT_SYMBOL(drm_mode_object_find);
	183
	184	/**
020a218f TR	185	* drm_mode_object_put - release a mode object reference
020a218f TR	186	* @obj: DRM mode object
949619f3	187	*
a2511a55	188	* This function decrements the object's refcount if it is a refcounted modeset
949619f3	189	* object. It is a no-op on any other object. This is used to drop references
020a218f	190	* acquired with drm_mode_object_get().
949619f3	191	*/
020a218f	192	void drm_mode_object_put(struct drm_mode_object *obj)
949619f3 DV	193	{
949619f3 DV	194	if (obj->free_cb) {
2c935bc5	195	DRM_DEBUG("OBJ ID: %d (%d)\n", obj->id, kref_read(&obj->refcount));
949619f3 DV	196	kref_put(&obj->refcount, obj->free_cb);
	197	}
	198	}
020a218f	199	EXPORT_SYMBOL(drm_mode_object_put);
949619f3 DV	200
949619f3 DV	201	/**
020a218f TR	202	* drm_mode_object_get - acquire a mode object reference
020a218f TR	203	* @obj: DRM mode object
949619f3	204	*
a2511a55	205	* This function increments the object's refcount if it is a refcounted modeset
949619f3	206	* object. It is a no-op on any other object. References should be dropped again
020a218f	207	* by calling drm_mode_object_put().
949619f3	208	*/
020a218f	209	void drm_mode_object_get(struct drm_mode_object *obj)
949619f3 DV	210	{
949619f3 DV	211	if (obj->free_cb) {
2c935bc5	212	DRM_DEBUG("OBJ ID: %d (%d)\n", obj->id, kref_read(&obj->refcount));
949619f3 DV	213	kref_get(&obj->refcount);
	214	}
	215	}
020a218f	216	EXPORT_SYMBOL(drm_mode_object_get);
949619f3 DV	217
	218	/**
	219	* drm_object_attach_property - attach a property to a modeset object
	220	* @obj: drm modeset object
	221	* @property: property to attach
	222	* @init_val: initial value of the property
	223	*
	224	* This attaches the given property to the modeset object with the given initial
	225	* value. Currently this function cannot fail since the properties are stored in
	226	* a statically sized array.
ab4e6933 DV	227	*
	228	* Note that all properties must be attached before the object itself is
	229	* registered and accessible from userspace.
949619f3 DV	230	*/
	231	void drm_object_attach_property(struct drm_mode_object *obj,
	232	struct drm_property *property,
	233	uint64_t init_val)
	234	{
	235	int count = obj->properties->count;
ab4e6933 DV	236	struct drm_device *dev = property->dev;
	237
	238
	239	if (obj->type == DRM_MODE_OBJECT_CONNECTOR) {
	240	struct drm_connector *connector = obj_to_connector(obj);
	241
	242	WARN_ON(!dev->driver->load &&
	243	connector->registration_state == DRM_CONNECTOR_REGISTERED);
	244	} else {
	245	WARN_ON(!dev->driver->load && dev->registered);
	246	}
949619f3 DV	247
	248	if (count == DRM_OBJECT_MAX_PROPERTY) {
	249	WARN(1, "Failed to attach object property (type: 0x%x). Please "
	250	"increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
	251	"you see this message on the same object type.\n",
	252	obj->type);
	253	return;
	254	}
	255
	256	obj->properties->properties[count] = property;
	257	obj->properties->values[count] = init_val;
	258	obj->properties->count++;
949619f3 DV	259	}
	260	EXPORT_SYMBOL(drm_object_attach_property);
	261
	262	/**
	263	* drm_object_property_set_value - set the value of a property
	264	* @obj: drm mode object to set property value for
	265	* @property: property to set
	266	* @val: value the property should be set to
	267	*
a2511a55	268	* This function sets a given property on a given object. This function only
949619f3 DV	269	* changes the software state of the property, it does not call into the
	270	* driver's ->set_property callback.
	271	*
a2511a55 DV	272	* Note that atomic drivers should not have any need to call this, the core will
	273	* ensure consistency of values reported back to userspace through the
	274	* appropriate ->atomic_get_property callback. Only legacy drivers should call
	275	* this function to update the tracked value (after clamping and other
	276	* restrictions have been applied).
	277	*
949619f3 DV	278	* Returns:
	279	* Zero on success, error code on failure.
	280	*/
	281	int drm_object_property_set_value(struct drm_mode_object *obj,
	282	struct drm_property *property, uint64_t val)
	283	{
	284	int i;
	285
4a97a3da DV	286	WARN_ON(drm_drv_uses_atomic_modeset(property->dev) &&
	287	!(property->flags & DRM_MODE_PROP_IMMUTABLE));
	288
949619f3 DV	289	for (i = 0; i < obj->properties->count; i++) {
	290	if (obj->properties->properties[i] == property) {
	291	obj->properties->values[i] = val;
	292	return 0;
	293	}
	294	}
	295
	296	return -EINVAL;
	297	}
	298	EXPORT_SYMBOL(drm_object_property_set_value);
	299
8a50b9bd VS	300	static int __drm_object_property_get_value(struct drm_mode_object *obj,
	301	struct drm_property *property,
	302	uint64_t *val)
949619f3 DV	303	{
	304	int i;
	305
	306	/* read-only properties bypass atomic mechanism and still store
	307	* their value in obj->properties->values[].. mostly to avoid
	308	* having to deal w/ EDID and similar props in atomic paths:
	309	*/
0bfd4a01	310	if (drm_drv_uses_atomic_modeset(property->dev) &&
949619f3 DV	311	!(property->flags & DRM_MODE_PROP_IMMUTABLE))
	312	return drm_atomic_get_property(obj, property, val);
	313
	314	for (i = 0; i < obj->properties->count; i++) {
	315	if (obj->properties->properties[i] == property) {
	316	*val = obj->properties->values[i];
	317	return 0;
	318	}
	319
	320	}
	321
	322	return -EINVAL;
	323	}
4a97a3da DV	324
	325	/**
	326	* drm_object_property_get_value - retrieve the value of a property
	327	* @obj: drm mode object to get property value from
	328	* @property: property to retrieve
	329	* @val: storage for the property value
	330	*
	331	* This function retrieves the softare state of the given property for the given
	332	* property. Since there is no driver callback to retrieve the current property
	333	* value this might be out of sync with the hardware, depending upon the driver
	334	* and property.
	335	*
	336	* Atomic drivers should never call this function directly, the core will read
	337	* out property values through the various ->atomic_get_property callbacks.
	338	*
	339	* Returns:
	340	* Zero on success, error code on failure.
	341	*/
	342	int drm_object_property_get_value(struct drm_mode_object *obj,
	343	struct drm_property property, uint64_t val)
	344	{
	345	WARN_ON(drm_drv_uses_atomic_modeset(property->dev));
	346
	347	return __drm_object_property_get_value(obj, property, val);
	348	}
949619f3 DV	349	EXPORT_SYMBOL(drm_object_property_get_value);
	350
	351	/* helper for getconnector and getproperties ioctls */
	352	int drm_mode_object_get_properties(struct drm_mode_object *obj, bool atomic,
	353	uint32_t __user *prop_ptr,
	354	uint64_t __user *prop_values,
	355	uint32_t *arg_count_props)
	356	{
f094d881	357	int i, ret, count;
949619f3	358
f094d881 DV	359	for (i = 0, count = 0; i < obj->properties->count; i++) {
	360	struct drm_property *prop = obj->properties->properties[i];
	361	uint64_t val;
949619f3	362
f094d881 DV	363	if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
f094d881 DV	364	continue;
949619f3	365
f094d881	366	if (*arg_count_props > count) {
4a97a3da	367	ret = __drm_object_property_get_value(obj, prop, &val);
949619f3 DV	368	if (ret)
	369	return ret;
	370
f094d881	371	if (put_user(prop->base.id, prop_ptr + count))
949619f3 DV	372	return -EFAULT;
949619f3 DV	373
f094d881	374	if (put_user(val, prop_values + count))
949619f3	375	return -EFAULT;
949619f3	376	}
f094d881 DV	377
f094d881 DV	378	count++;
949619f3	379	}
f094d881	380	*arg_count_props = count;
949619f3 DV	381
	382	return 0;
	383	}
	384
	385	/**
	386	* drm_mode_obj_get_properties_ioctl - get the current value of a object's property
	387	* @dev: DRM device
	388	* @data: ioctl data
	389	* @file_priv: DRM file info
	390	*
	391	* This function retrieves the current value for an object's property. Compared
	392	* to the connector specific ioctl this one is extended to also work on crtc and
	393	* plane objects.
	394	*
	395	* Called by the user via ioctl.
	396	*
	397	* Returns:
	398	* Zero on success, negative errno on failure.
	399	*/
	400	int drm_mode_obj_get_properties_ioctl(struct drm_device dev, void data,
	401	struct drm_file *file_priv)
	402	{
	403	struct drm_mode_obj_get_properties *arg = data;
	404	struct drm_mode_object *obj;
9bcaa3fe	405	struct drm_modeset_acquire_ctx ctx;
949619f3 DV	406	int ret = 0;
	407
	408	if (!drm_core_check_feature(dev, DRIVER_MODESET))
69fdf420	409	return -EOPNOTSUPP;
949619f3	410
9bcaa3fe	411	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
949619f3	412
418da172	413	obj = drm_mode_object_find(dev, file_priv, arg->obj_id, arg->obj_type);
949619f3 DV	414	if (!obj) {
	415	ret = -ENOENT;
	416	goto out;
	417	}
	418	if (!obj->properties) {
	419	ret = -EINVAL;
	420	goto out_unref;
	421	}
	422
	423	ret = drm_mode_object_get_properties(obj, file_priv->atomic,
	424	(uint32_t __user *)(unsigned long)(arg->props_ptr),
	425	(uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
	426	&arg->count_props);
	427
	428	out_unref:
020a218f	429	drm_mode_object_put(obj);
949619f3	430	out:
77ef3857	431	DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
949619f3 DV	432	return ret;
	433	}
	434
f92f053b ML	435	struct drm_property drm_mode_obj_find_prop_id(struct drm_mode_object obj,
	436	uint32_t prop_id)
	437	{
	438	int i;
	439
	440	for (i = 0; i < obj->properties->count; i++)
	441	if (obj->properties->properties[i]->base.id == prop_id)
	442	return obj->properties->properties[i];
	443
	444	return NULL;
	445	}
	446
144a7999 DV	447	static int set_property_legacy(struct drm_mode_object *obj,
	448	struct drm_property *prop,
	449	uint64_t prop_value)
	450	{
	451	struct drm_device *dev = prop->dev;
	452	struct drm_mode_object *ref;
9bcaa3fe	453	struct drm_modeset_acquire_ctx ctx;
144a7999 DV	454	int ret = -EINVAL;
	455
	456	if (!drm_property_change_valid_get(prop, prop_value, &ref))
	457	return -EINVAL;
	458
9bcaa3fe	459	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
144a7999 DV	460	switch (obj->type) {
144a7999 DV	461	case DRM_MODE_OBJECT_CONNECTOR:
97e14fbe	462	ret = drm_connector_set_obj_prop(obj, prop, prop_value);
144a7999 DV	463	break;
	464	case DRM_MODE_OBJECT_CRTC:
	465	ret = drm_mode_crtc_set_obj_prop(obj, prop, prop_value);
	466	break;
	467	case DRM_MODE_OBJECT_PLANE:
	468	ret = drm_mode_plane_set_obj_prop(obj_to_plane(obj),
	469	prop, prop_value);
	470	break;
	471	}
	472	drm_property_change_valid_put(prop, ref);
77ef3857	473	DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
144a7999 DV	474
	475	return ret;
	476	}
	477
	478	static int set_property_atomic(struct drm_mode_object *obj,
36e4523a	479	struct drm_file *file_priv,
144a7999 DV	480	struct drm_property *prop,
	481	uint64_t prop_value)
	482	{
	483	struct drm_device *dev = prop->dev;
	484	struct drm_atomic_state *state;
	485	struct drm_modeset_acquire_ctx ctx;
	486	int ret;
	487
144a7999 DV	488	state = drm_atomic_state_alloc(dev);
	489	if (!state)
	490	return -ENOMEM;
227ad6d9 CW	491
227ad6d9 CW	492	drm_modeset_acquire_init(&ctx, 0);
144a7999	493	state->acquire_ctx = &ctx;
227ad6d9	494
144a7999 DV	495	retry:
	496	if (prop == state->dev->mode_config.dpms_property) {
	497	if (obj->type != DRM_MODE_OBJECT_CONNECTOR) {
	498	ret = -EINVAL;
	499	goto out;
	500	}
	501
	502	ret = drm_atomic_connector_commit_dpms(state,
	503	obj_to_connector(obj),
	504	prop_value);
	505	} else {
36e4523a	506	ret = drm_atomic_set_property(state, file_priv, obj, prop, prop_value);
144a7999 DV	507	if (ret)
	508	goto out;
	509	ret = drm_atomic_commit(state);
	510	}
	511	out:
	512	if (ret == -EDEADLK) {
	513	drm_atomic_state_clear(state);
	514	drm_modeset_backoff(&ctx);
	515	goto retry;
	516	}
	517
	518	drm_atomic_state_put(state);
	519
	520	drm_modeset_drop_locks(&ctx);
	521	drm_modeset_acquire_fini(&ctx);
	522
	523	return ret;
	524	}
	525
949619f3 DV	526	int drm_mode_obj_set_property_ioctl(struct drm_device dev, void data,
	527	struct drm_file *file_priv)
	528	{
	529	struct drm_mode_obj_set_property *arg = data;
	530	struct drm_mode_object *arg_obj;
949619f3	531	struct drm_property *property;
f92f053b	532	int ret = -EINVAL;
949619f3 DV	533
949619f3 DV	534	if (!drm_core_check_feature(dev, DRIVER_MODESET))
69fdf420	535	return -EOPNOTSUPP;
949619f3	536
418da172	537	arg_obj = drm_mode_object_find(dev, file_priv, arg->obj_id, arg->obj_type);
144a7999 DV	538	if (!arg_obj)
144a7999 DV	539	return -ENOENT;
949619f3	540
f92f053b	541	if (!arg_obj->properties)
949619f3 DV	542	goto out_unref;
949619f3 DV	543
f92f053b ML	544	property = drm_mode_obj_find_prop_id(arg_obj, arg->prop_id);
f92f053b ML	545	if (!property)
949619f3	546	goto out_unref;
949619f3	547
144a7999	548	if (drm_drv_uses_atomic_modeset(property->dev))
36e4523a	549	ret = set_property_atomic(arg_obj, file_priv, property, arg->value);
144a7999 DV	550	else
144a7999 DV	551	ret = set_property_legacy(arg_obj, property, arg->value);
949619f3 DV	552
949619f3 DV	553	out_unref:
020a218f	554	drm_mode_object_put(arg_obj);
949619f3 DV	555	return ret;
949619f3 DV	556	}