[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;

	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)
{
	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_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.
 */
void drm_object_attach_property(struct drm_mode_object *obj,
				struct drm_property *property,
				uint64_t init_val)
{
	int count = obj->properties->count;

	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;
	int ret = 0;

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

	drm_modeset_lock_all(dev);

	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_unlock_all(dev);
	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;
	int ret = -EINVAL;

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

	drm_modeset_lock_all(dev);
	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_unlock_all(dev);

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