xref: /openbmc/linux/drivers/gpu/drm/drm_property.c (revision 8cb68c83)
159e71ee7SDaniel Vetter /*
259e71ee7SDaniel Vetter  * Copyright (c) 2016 Intel Corporation
359e71ee7SDaniel Vetter  *
459e71ee7SDaniel Vetter  * Permission to use, copy, modify, distribute, and sell this software and its
559e71ee7SDaniel Vetter  * documentation for any purpose is hereby granted without fee, provided that
659e71ee7SDaniel Vetter  * the above copyright notice appear in all copies and that both that copyright
759e71ee7SDaniel Vetter  * notice and this permission notice appear in supporting documentation, and
859e71ee7SDaniel Vetter  * that the name of the copyright holders not be used in advertising or
959e71ee7SDaniel Vetter  * publicity pertaining to distribution of the software without specific,
1059e71ee7SDaniel Vetter  * written prior permission.  The copyright holders make no representations
1159e71ee7SDaniel Vetter  * about the suitability of this software for any purpose.  It is provided "as
1259e71ee7SDaniel Vetter  * is" without express or implied warranty.
1359e71ee7SDaniel Vetter  *
1459e71ee7SDaniel Vetter  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1559e71ee7SDaniel Vetter  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1659e71ee7SDaniel Vetter  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1759e71ee7SDaniel Vetter  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1859e71ee7SDaniel Vetter  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1959e71ee7SDaniel Vetter  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
2059e71ee7SDaniel Vetter  * OF THIS SOFTWARE.
2159e71ee7SDaniel Vetter  */
2259e71ee7SDaniel Vetter 
2359e71ee7SDaniel Vetter #include <linux/export.h>
2459e71ee7SDaniel Vetter #include <drm/drmP.h>
2559e71ee7SDaniel Vetter #include <drm/drm_property.h>
2659e71ee7SDaniel Vetter 
2759e71ee7SDaniel Vetter #include "drm_crtc_internal.h"
2859e71ee7SDaniel Vetter 
29c8458c7eSDaniel Vetter /**
30c8458c7eSDaniel Vetter  * DOC: overview
31c8458c7eSDaniel Vetter  *
32c8458c7eSDaniel Vetter  * Properties as represented by &drm_property are used to extend the modeset
33c8458c7eSDaniel Vetter  * interface exposed to userspace. For the atomic modeset IOCTL properties are
34c8458c7eSDaniel Vetter  * even the only way to transport metadata about the desired new modeset
35c8458c7eSDaniel Vetter  * configuration from userspace to the kernel. Properties have a well-defined
36c8458c7eSDaniel Vetter  * value range, which is enforced by the drm core. See the documentation of the
37ea0dd85aSDaniel Vetter  * flags member of &struct drm_property for an overview of the different
38c8458c7eSDaniel Vetter  * property types and ranges.
39c8458c7eSDaniel Vetter  *
40c8458c7eSDaniel Vetter  * Properties don't store the current value directly, but need to be
41c8458c7eSDaniel Vetter  * instatiated by attaching them to a &drm_mode_object with
42c8458c7eSDaniel Vetter  * drm_object_attach_property().
43c8458c7eSDaniel Vetter  *
44c8458c7eSDaniel Vetter  * Property values are only 64bit. To support bigger piles of data (like gamma
45d574528aSDaniel Vetter  * tables, color correction matrices or large structures) a property can instead
46d574528aSDaniel Vetter  * point at a &drm_property_blob with that additional data.
47c8458c7eSDaniel Vetter  *
48c8458c7eSDaniel Vetter  * Properties are defined by their symbolic name, userspace must keep a
49c8458c7eSDaniel Vetter  * per-object mapping from those names to the property ID used in the atomic
50c8458c7eSDaniel Vetter  * IOCTL and in the get/set property IOCTL.
51c8458c7eSDaniel Vetter  */
52c8458c7eSDaniel Vetter 
5359e71ee7SDaniel Vetter static bool drm_property_type_valid(struct drm_property *property)
5459e71ee7SDaniel Vetter {
5559e71ee7SDaniel Vetter 	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
5659e71ee7SDaniel Vetter 		return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
5759e71ee7SDaniel Vetter 	return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
5859e71ee7SDaniel Vetter }
5959e71ee7SDaniel Vetter 
6059e71ee7SDaniel Vetter /**
6159e71ee7SDaniel Vetter  * drm_property_create - create a new property type
6259e71ee7SDaniel Vetter  * @dev: drm device
6359e71ee7SDaniel Vetter  * @flags: flags specifying the property type
6459e71ee7SDaniel Vetter  * @name: name of the property
6559e71ee7SDaniel Vetter  * @num_values: number of pre-defined values
6659e71ee7SDaniel Vetter  *
6759e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
686a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
696a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
706a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
7159e71ee7SDaniel Vetter  *
7259e71ee7SDaniel Vetter  * Returns:
7359e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
7459e71ee7SDaniel Vetter  */
7559e71ee7SDaniel Vetter struct drm_property *drm_property_create(struct drm_device *dev, int flags,
7659e71ee7SDaniel Vetter 					 const char *name, int num_values)
7759e71ee7SDaniel Vetter {
7859e71ee7SDaniel Vetter 	struct drm_property *property = NULL;
7959e71ee7SDaniel Vetter 	int ret;
8059e71ee7SDaniel Vetter 
8159e71ee7SDaniel Vetter 	property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
8259e71ee7SDaniel Vetter 	if (!property)
8359e71ee7SDaniel Vetter 		return NULL;
8459e71ee7SDaniel Vetter 
8559e71ee7SDaniel Vetter 	property->dev = dev;
8659e71ee7SDaniel Vetter 
8759e71ee7SDaniel Vetter 	if (num_values) {
8859e71ee7SDaniel Vetter 		property->values = kcalloc(num_values, sizeof(uint64_t),
8959e71ee7SDaniel Vetter 					   GFP_KERNEL);
9059e71ee7SDaniel Vetter 		if (!property->values)
9159e71ee7SDaniel Vetter 			goto fail;
9259e71ee7SDaniel Vetter 	}
9359e71ee7SDaniel Vetter 
942135ea7aSThierry Reding 	ret = drm_mode_object_add(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
9559e71ee7SDaniel Vetter 	if (ret)
9659e71ee7SDaniel Vetter 		goto fail;
9759e71ee7SDaniel Vetter 
9859e71ee7SDaniel Vetter 	property->flags = flags;
9959e71ee7SDaniel Vetter 	property->num_values = num_values;
10059e71ee7SDaniel Vetter 	INIT_LIST_HEAD(&property->enum_list);
10159e71ee7SDaniel Vetter 
10259e71ee7SDaniel Vetter 	if (name) {
10359e71ee7SDaniel Vetter 		strncpy(property->name, name, DRM_PROP_NAME_LEN);
10459e71ee7SDaniel Vetter 		property->name[DRM_PROP_NAME_LEN-1] = '\0';
10559e71ee7SDaniel Vetter 	}
10659e71ee7SDaniel Vetter 
10759e71ee7SDaniel Vetter 	list_add_tail(&property->head, &dev->mode_config.property_list);
10859e71ee7SDaniel Vetter 
10959e71ee7SDaniel Vetter 	WARN_ON(!drm_property_type_valid(property));
11059e71ee7SDaniel Vetter 
11159e71ee7SDaniel Vetter 	return property;
11259e71ee7SDaniel Vetter fail:
11359e71ee7SDaniel Vetter 	kfree(property->values);
11459e71ee7SDaniel Vetter 	kfree(property);
11559e71ee7SDaniel Vetter 	return NULL;
11659e71ee7SDaniel Vetter }
11759e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create);
11859e71ee7SDaniel Vetter 
11959e71ee7SDaniel Vetter /**
12059e71ee7SDaniel Vetter  * drm_property_create_enum - create a new enumeration property type
12159e71ee7SDaniel Vetter  * @dev: drm device
12259e71ee7SDaniel Vetter  * @flags: flags specifying the property type
12359e71ee7SDaniel Vetter  * @name: name of the property
12459e71ee7SDaniel Vetter  * @props: enumeration lists with property values
12559e71ee7SDaniel Vetter  * @num_values: number of pre-defined values
12659e71ee7SDaniel Vetter  *
12759e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
1286a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
1296a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
1306a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
13159e71ee7SDaniel Vetter  *
13259e71ee7SDaniel Vetter  * Userspace is only allowed to set one of the predefined values for enumeration
13359e71ee7SDaniel Vetter  * properties.
13459e71ee7SDaniel Vetter  *
13559e71ee7SDaniel Vetter  * Returns:
13659e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
13759e71ee7SDaniel Vetter  */
13859e71ee7SDaniel Vetter struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
13959e71ee7SDaniel Vetter 					 const char *name,
14059e71ee7SDaniel Vetter 					 const struct drm_prop_enum_list *props,
14159e71ee7SDaniel Vetter 					 int num_values)
14259e71ee7SDaniel Vetter {
14359e71ee7SDaniel Vetter 	struct drm_property *property;
14459e71ee7SDaniel Vetter 	int i, ret;
14559e71ee7SDaniel Vetter 
14659e71ee7SDaniel Vetter 	flags |= DRM_MODE_PROP_ENUM;
14759e71ee7SDaniel Vetter 
14859e71ee7SDaniel Vetter 	property = drm_property_create(dev, flags, name, num_values);
14959e71ee7SDaniel Vetter 	if (!property)
15059e71ee7SDaniel Vetter 		return NULL;
15159e71ee7SDaniel Vetter 
15259e71ee7SDaniel Vetter 	for (i = 0; i < num_values; i++) {
15359e71ee7SDaniel Vetter 		ret = drm_property_add_enum(property, i,
15459e71ee7SDaniel Vetter 				      props[i].type,
15559e71ee7SDaniel Vetter 				      props[i].name);
15659e71ee7SDaniel Vetter 		if (ret) {
15759e71ee7SDaniel Vetter 			drm_property_destroy(dev, property);
15859e71ee7SDaniel Vetter 			return NULL;
15959e71ee7SDaniel Vetter 		}
16059e71ee7SDaniel Vetter 	}
16159e71ee7SDaniel Vetter 
16259e71ee7SDaniel Vetter 	return property;
16359e71ee7SDaniel Vetter }
16459e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_enum);
16559e71ee7SDaniel Vetter 
16659e71ee7SDaniel Vetter /**
16759e71ee7SDaniel Vetter  * drm_property_create_bitmask - create a new bitmask property type
16859e71ee7SDaniel Vetter  * @dev: drm device
16959e71ee7SDaniel Vetter  * @flags: flags specifying the property type
17059e71ee7SDaniel Vetter  * @name: name of the property
17159e71ee7SDaniel Vetter  * @props: enumeration lists with property bitflags
17259e71ee7SDaniel Vetter  * @num_props: size of the @props array
17359e71ee7SDaniel Vetter  * @supported_bits: bitmask of all supported enumeration values
17459e71ee7SDaniel Vetter  *
17559e71ee7SDaniel Vetter  * This creates a new bitmask drm property which can then be attached to a drm
1766a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
1776a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
1786a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
17959e71ee7SDaniel Vetter  *
18059e71ee7SDaniel Vetter  * Compared to plain enumeration properties userspace is allowed to set any
18159e71ee7SDaniel Vetter  * or'ed together combination of the predefined property bitflag values
18259e71ee7SDaniel Vetter  *
18359e71ee7SDaniel Vetter  * Returns:
18459e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
18559e71ee7SDaniel Vetter  */
18659e71ee7SDaniel Vetter struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
18759e71ee7SDaniel Vetter 					 int flags, const char *name,
18859e71ee7SDaniel Vetter 					 const struct drm_prop_enum_list *props,
18959e71ee7SDaniel Vetter 					 int num_props,
19059e71ee7SDaniel Vetter 					 uint64_t supported_bits)
19159e71ee7SDaniel Vetter {
19259e71ee7SDaniel Vetter 	struct drm_property *property;
19359e71ee7SDaniel Vetter 	int i, ret, index = 0;
19459e71ee7SDaniel Vetter 	int num_values = hweight64(supported_bits);
19559e71ee7SDaniel Vetter 
19659e71ee7SDaniel Vetter 	flags |= DRM_MODE_PROP_BITMASK;
19759e71ee7SDaniel Vetter 
19859e71ee7SDaniel Vetter 	property = drm_property_create(dev, flags, name, num_values);
19959e71ee7SDaniel Vetter 	if (!property)
20059e71ee7SDaniel Vetter 		return NULL;
20159e71ee7SDaniel Vetter 	for (i = 0; i < num_props; i++) {
20259e71ee7SDaniel Vetter 		if (!(supported_bits & (1ULL << props[i].type)))
20359e71ee7SDaniel Vetter 			continue;
20459e71ee7SDaniel Vetter 
20559e71ee7SDaniel Vetter 		if (WARN_ON(index >= num_values)) {
20659e71ee7SDaniel Vetter 			drm_property_destroy(dev, property);
20759e71ee7SDaniel Vetter 			return NULL;
20859e71ee7SDaniel Vetter 		}
20959e71ee7SDaniel Vetter 
21059e71ee7SDaniel Vetter 		ret = drm_property_add_enum(property, index++,
21159e71ee7SDaniel Vetter 				      props[i].type,
21259e71ee7SDaniel Vetter 				      props[i].name);
21359e71ee7SDaniel Vetter 		if (ret) {
21459e71ee7SDaniel Vetter 			drm_property_destroy(dev, property);
21559e71ee7SDaniel Vetter 			return NULL;
21659e71ee7SDaniel Vetter 		}
21759e71ee7SDaniel Vetter 	}
21859e71ee7SDaniel Vetter 
21959e71ee7SDaniel Vetter 	return property;
22059e71ee7SDaniel Vetter }
22159e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_bitmask);
22259e71ee7SDaniel Vetter 
22359e71ee7SDaniel Vetter static struct drm_property *property_create_range(struct drm_device *dev,
22459e71ee7SDaniel Vetter 					 int flags, const char *name,
22559e71ee7SDaniel Vetter 					 uint64_t min, uint64_t max)
22659e71ee7SDaniel Vetter {
22759e71ee7SDaniel Vetter 	struct drm_property *property;
22859e71ee7SDaniel Vetter 
22959e71ee7SDaniel Vetter 	property = drm_property_create(dev, flags, name, 2);
23059e71ee7SDaniel Vetter 	if (!property)
23159e71ee7SDaniel Vetter 		return NULL;
23259e71ee7SDaniel Vetter 
23359e71ee7SDaniel Vetter 	property->values[0] = min;
23459e71ee7SDaniel Vetter 	property->values[1] = max;
23559e71ee7SDaniel Vetter 
23659e71ee7SDaniel Vetter 	return property;
23759e71ee7SDaniel Vetter }
23859e71ee7SDaniel Vetter 
23959e71ee7SDaniel Vetter /**
24059e71ee7SDaniel Vetter  * drm_property_create_range - create a new unsigned ranged property type
24159e71ee7SDaniel Vetter  * @dev: drm device
24259e71ee7SDaniel Vetter  * @flags: flags specifying the property type
24359e71ee7SDaniel Vetter  * @name: name of the property
24459e71ee7SDaniel Vetter  * @min: minimum value of the property
24559e71ee7SDaniel Vetter  * @max: maximum value of the property
24659e71ee7SDaniel Vetter  *
24759e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
2486a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
2496a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
2506a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
25159e71ee7SDaniel Vetter  *
25259e71ee7SDaniel Vetter  * Userspace is allowed to set any unsigned integer value in the (min, max)
25359e71ee7SDaniel Vetter  * range inclusive.
25459e71ee7SDaniel Vetter  *
25559e71ee7SDaniel Vetter  * Returns:
25659e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
25759e71ee7SDaniel Vetter  */
25859e71ee7SDaniel Vetter struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
25959e71ee7SDaniel Vetter 					 const char *name,
26059e71ee7SDaniel Vetter 					 uint64_t min, uint64_t max)
26159e71ee7SDaniel Vetter {
26259e71ee7SDaniel Vetter 	return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
26359e71ee7SDaniel Vetter 			name, min, max);
26459e71ee7SDaniel Vetter }
26559e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_range);
26659e71ee7SDaniel Vetter 
26759e71ee7SDaniel Vetter /**
26859e71ee7SDaniel Vetter  * drm_property_create_signed_range - create a new signed ranged property type
26959e71ee7SDaniel Vetter  * @dev: drm device
27059e71ee7SDaniel Vetter  * @flags: flags specifying the property type
27159e71ee7SDaniel Vetter  * @name: name of the property
27259e71ee7SDaniel Vetter  * @min: minimum value of the property
27359e71ee7SDaniel Vetter  * @max: maximum value of the property
27459e71ee7SDaniel Vetter  *
27559e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
2766a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
2776a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
2786a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
27959e71ee7SDaniel Vetter  *
28059e71ee7SDaniel Vetter  * Userspace is allowed to set any signed integer value in the (min, max)
28159e71ee7SDaniel Vetter  * range inclusive.
28259e71ee7SDaniel Vetter  *
28359e71ee7SDaniel Vetter  * Returns:
28459e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
28559e71ee7SDaniel Vetter  */
28659e71ee7SDaniel Vetter struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
28759e71ee7SDaniel Vetter 					 int flags, const char *name,
28859e71ee7SDaniel Vetter 					 int64_t min, int64_t max)
28959e71ee7SDaniel Vetter {
29059e71ee7SDaniel Vetter 	return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
29159e71ee7SDaniel Vetter 			name, I642U64(min), I642U64(max));
29259e71ee7SDaniel Vetter }
29359e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_signed_range);
29459e71ee7SDaniel Vetter 
29559e71ee7SDaniel Vetter /**
29659e71ee7SDaniel Vetter  * drm_property_create_object - create a new object property type
29759e71ee7SDaniel Vetter  * @dev: drm device
29859e71ee7SDaniel Vetter  * @flags: flags specifying the property type
29959e71ee7SDaniel Vetter  * @name: name of the property
30059e71ee7SDaniel Vetter  * @type: object type from DRM_MODE_OBJECT_* defines
30159e71ee7SDaniel Vetter  *
30259e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
3036a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
3046a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
3056a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
30659e71ee7SDaniel Vetter  *
30759e71ee7SDaniel Vetter  * Userspace is only allowed to set this to any property value of the given
30859e71ee7SDaniel Vetter  * @type. Only useful for atomic properties, which is enforced.
30959e71ee7SDaniel Vetter  *
31059e71ee7SDaniel Vetter  * Returns:
31159e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
31259e71ee7SDaniel Vetter  */
31359e71ee7SDaniel Vetter struct drm_property *drm_property_create_object(struct drm_device *dev,
314c8458c7eSDaniel Vetter 						int flags, const char *name,
315c8458c7eSDaniel Vetter 						uint32_t type)
31659e71ee7SDaniel Vetter {
31759e71ee7SDaniel Vetter 	struct drm_property *property;
31859e71ee7SDaniel Vetter 
31959e71ee7SDaniel Vetter 	flags |= DRM_MODE_PROP_OBJECT;
32059e71ee7SDaniel Vetter 
32159e71ee7SDaniel Vetter 	if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
32259e71ee7SDaniel Vetter 		return NULL;
32359e71ee7SDaniel Vetter 
32459e71ee7SDaniel Vetter 	property = drm_property_create(dev, flags, name, 1);
32559e71ee7SDaniel Vetter 	if (!property)
32659e71ee7SDaniel Vetter 		return NULL;
32759e71ee7SDaniel Vetter 
32859e71ee7SDaniel Vetter 	property->values[0] = type;
32959e71ee7SDaniel Vetter 
33059e71ee7SDaniel Vetter 	return property;
33159e71ee7SDaniel Vetter }
33259e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_object);
33359e71ee7SDaniel Vetter 
33459e71ee7SDaniel Vetter /**
33559e71ee7SDaniel Vetter  * drm_property_create_bool - create a new boolean property type
33659e71ee7SDaniel Vetter  * @dev: drm device
33759e71ee7SDaniel Vetter  * @flags: flags specifying the property type
33859e71ee7SDaniel Vetter  * @name: name of the property
33959e71ee7SDaniel Vetter  *
34059e71ee7SDaniel Vetter  * This creates a new generic drm property which can then be attached to a drm
3416a8a66edSDaniel Vetter  * object with drm_object_attach_property(). The returned property object must
3426a8a66edSDaniel Vetter  * be freed with drm_property_destroy(), which is done automatically when
3436a8a66edSDaniel Vetter  * calling drm_mode_config_cleanup().
34459e71ee7SDaniel Vetter  *
34559e71ee7SDaniel Vetter  * This is implemented as a ranged property with only {0, 1} as valid values.
34659e71ee7SDaniel Vetter  *
34759e71ee7SDaniel Vetter  * Returns:
34859e71ee7SDaniel Vetter  * A pointer to the newly created property on success, NULL on failure.
34959e71ee7SDaniel Vetter  */
35059e71ee7SDaniel Vetter struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
35159e71ee7SDaniel Vetter 					      const char *name)
35259e71ee7SDaniel Vetter {
35359e71ee7SDaniel Vetter 	return drm_property_create_range(dev, flags, name, 0, 1);
35459e71ee7SDaniel Vetter }
35559e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_bool);
35659e71ee7SDaniel Vetter 
35759e71ee7SDaniel Vetter /**
35859e71ee7SDaniel Vetter  * drm_property_add_enum - add a possible value to an enumeration property
35959e71ee7SDaniel Vetter  * @property: enumeration property to change
36059e71ee7SDaniel Vetter  * @index: index of the new enumeration
36159e71ee7SDaniel Vetter  * @value: value of the new enumeration
36259e71ee7SDaniel Vetter  * @name: symbolic name of the new enumeration
36359e71ee7SDaniel Vetter  *
36459e71ee7SDaniel Vetter  * This functions adds enumerations to a property.
36559e71ee7SDaniel Vetter  *
36659e71ee7SDaniel Vetter  * It's use is deprecated, drivers should use one of the more specific helpers
36759e71ee7SDaniel Vetter  * to directly create the property with all enumerations already attached.
36859e71ee7SDaniel Vetter  *
36959e71ee7SDaniel Vetter  * Returns:
37059e71ee7SDaniel Vetter  * Zero on success, error code on failure.
37159e71ee7SDaniel Vetter  */
37259e71ee7SDaniel Vetter int drm_property_add_enum(struct drm_property *property, int index,
37359e71ee7SDaniel Vetter 			  uint64_t value, const char *name)
37459e71ee7SDaniel Vetter {
37559e71ee7SDaniel Vetter 	struct drm_property_enum *prop_enum;
37659e71ee7SDaniel Vetter 
37759e71ee7SDaniel Vetter 	if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
37859e71ee7SDaniel Vetter 			drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
37959e71ee7SDaniel Vetter 		return -EINVAL;
38059e71ee7SDaniel Vetter 
38159e71ee7SDaniel Vetter 	/*
38259e71ee7SDaniel Vetter 	 * Bitmask enum properties have the additional constraint of values
38359e71ee7SDaniel Vetter 	 * from 0 to 63
38459e71ee7SDaniel Vetter 	 */
38559e71ee7SDaniel Vetter 	if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
38659e71ee7SDaniel Vetter 			(value > 63))
38759e71ee7SDaniel Vetter 		return -EINVAL;
38859e71ee7SDaniel Vetter 
38959e71ee7SDaniel Vetter 	if (!list_empty(&property->enum_list)) {
39059e71ee7SDaniel Vetter 		list_for_each_entry(prop_enum, &property->enum_list, head) {
39159e71ee7SDaniel Vetter 			if (prop_enum->value == value) {
39259e71ee7SDaniel Vetter 				strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
39359e71ee7SDaniel Vetter 				prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
39459e71ee7SDaniel Vetter 				return 0;
39559e71ee7SDaniel Vetter 			}
39659e71ee7SDaniel Vetter 		}
39759e71ee7SDaniel Vetter 	}
39859e71ee7SDaniel Vetter 
39959e71ee7SDaniel Vetter 	prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
40059e71ee7SDaniel Vetter 	if (!prop_enum)
40159e71ee7SDaniel Vetter 		return -ENOMEM;
40259e71ee7SDaniel Vetter 
40359e71ee7SDaniel Vetter 	strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
40459e71ee7SDaniel Vetter 	prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
40559e71ee7SDaniel Vetter 	prop_enum->value = value;
40659e71ee7SDaniel Vetter 
40759e71ee7SDaniel Vetter 	property->values[index] = value;
40859e71ee7SDaniel Vetter 	list_add_tail(&prop_enum->head, &property->enum_list);
40959e71ee7SDaniel Vetter 	return 0;
41059e71ee7SDaniel Vetter }
41159e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_add_enum);
41259e71ee7SDaniel Vetter 
41359e71ee7SDaniel Vetter /**
41459e71ee7SDaniel Vetter  * drm_property_destroy - destroy a drm property
41559e71ee7SDaniel Vetter  * @dev: drm device
41659e71ee7SDaniel Vetter  * @property: property to destry
41759e71ee7SDaniel Vetter  *
41859e71ee7SDaniel Vetter  * This function frees a property including any attached resources like
41959e71ee7SDaniel Vetter  * enumeration values.
42059e71ee7SDaniel Vetter  */
42159e71ee7SDaniel Vetter void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
42259e71ee7SDaniel Vetter {
42359e71ee7SDaniel Vetter 	struct drm_property_enum *prop_enum, *pt;
42459e71ee7SDaniel Vetter 
42559e71ee7SDaniel Vetter 	list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
42659e71ee7SDaniel Vetter 		list_del(&prop_enum->head);
42759e71ee7SDaniel Vetter 		kfree(prop_enum);
42859e71ee7SDaniel Vetter 	}
42959e71ee7SDaniel Vetter 
43059e71ee7SDaniel Vetter 	if (property->num_values)
43159e71ee7SDaniel Vetter 		kfree(property->values);
43259e71ee7SDaniel Vetter 	drm_mode_object_unregister(dev, &property->base);
43359e71ee7SDaniel Vetter 	list_del(&property->head);
43459e71ee7SDaniel Vetter 	kfree(property);
43559e71ee7SDaniel Vetter }
43659e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_destroy);
43759e71ee7SDaniel Vetter 
43859e71ee7SDaniel Vetter int drm_mode_getproperty_ioctl(struct drm_device *dev,
43959e71ee7SDaniel Vetter 			       void *data, struct drm_file *file_priv)
44059e71ee7SDaniel Vetter {
44159e71ee7SDaniel Vetter 	struct drm_mode_get_property *out_resp = data;
44259e71ee7SDaniel Vetter 	struct drm_property *property;
44359e71ee7SDaniel Vetter 	int enum_count = 0;
44459e71ee7SDaniel Vetter 	int value_count = 0;
445eb8eb02eSDaniel Vetter 	int i, copied;
44659e71ee7SDaniel Vetter 	struct drm_property_enum *prop_enum;
44759e71ee7SDaniel Vetter 	struct drm_mode_property_enum __user *enum_ptr;
44859e71ee7SDaniel Vetter 	uint64_t __user *values_ptr;
44959e71ee7SDaniel Vetter 
45059e71ee7SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
45159e71ee7SDaniel Vetter 		return -EINVAL;
45259e71ee7SDaniel Vetter 
45359e71ee7SDaniel Vetter 	property = drm_property_find(dev, out_resp->prop_id);
454eb8eb02eSDaniel Vetter 	if (!property)
455eb8eb02eSDaniel Vetter 		return -ENOENT;
45659e71ee7SDaniel Vetter 
45759e71ee7SDaniel Vetter 	strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
45859e71ee7SDaniel Vetter 	out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
45959e71ee7SDaniel Vetter 	out_resp->flags = property->flags;
46059e71ee7SDaniel Vetter 
461eb8eb02eSDaniel Vetter 	value_count = property->num_values;
462eb8eb02eSDaniel Vetter 	values_ptr = u64_to_user_ptr(out_resp->values_ptr);
463eb8eb02eSDaniel Vetter 
46459e71ee7SDaniel Vetter 	for (i = 0; i < value_count; i++) {
465eb8eb02eSDaniel Vetter 		if (i < out_resp->count_values &&
466eb8eb02eSDaniel Vetter 		    put_user(property->values[i], values_ptr + i)) {
467eb8eb02eSDaniel Vetter 			return -EFAULT;
46859e71ee7SDaniel Vetter 		}
46959e71ee7SDaniel Vetter 	}
47059e71ee7SDaniel Vetter 	out_resp->count_values = value_count;
47159e71ee7SDaniel Vetter 
472eb8eb02eSDaniel Vetter 	copied = 0;
473eb8eb02eSDaniel Vetter 	enum_ptr = u64_to_user_ptr(out_resp->enum_blob_ptr);
474eb8eb02eSDaniel Vetter 
47559e71ee7SDaniel Vetter 	if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
47659e71ee7SDaniel Vetter 	    drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
47759e71ee7SDaniel Vetter 		list_for_each_entry(prop_enum, &property->enum_list, head) {
478eb8eb02eSDaniel Vetter 			enum_count++;
4798cb68c83SDaniel Vetter 			if (out_resp->count_enum_blobs < enum_count)
480eb8eb02eSDaniel Vetter 				continue;
48159e71ee7SDaniel Vetter 
482eb8eb02eSDaniel Vetter 			if (copy_to_user(&enum_ptr[copied].value,
483eb8eb02eSDaniel Vetter 					 &prop_enum->value, sizeof(uint64_t)))
484eb8eb02eSDaniel Vetter 				return -EFAULT;
48559e71ee7SDaniel Vetter 
48659e71ee7SDaniel Vetter 			if (copy_to_user(&enum_ptr[copied].name,
487eb8eb02eSDaniel Vetter 					 &prop_enum->name, DRM_PROP_NAME_LEN))
488eb8eb02eSDaniel Vetter 				return -EFAULT;
48959e71ee7SDaniel Vetter 			copied++;
49059e71ee7SDaniel Vetter 		}
49159e71ee7SDaniel Vetter 		out_resp->count_enum_blobs = enum_count;
49259e71ee7SDaniel Vetter 	}
49359e71ee7SDaniel Vetter 
49459e71ee7SDaniel Vetter 	/*
49559e71ee7SDaniel Vetter 	 * NOTE: The idea seems to have been to use this to read all the blob
49659e71ee7SDaniel Vetter 	 * property values. But nothing ever added them to the corresponding
49759e71ee7SDaniel Vetter 	 * list, userspace always used the special-purpose get_blob ioctl to
49859e71ee7SDaniel Vetter 	 * read the value for a blob property. It also doesn't make a lot of
49959e71ee7SDaniel Vetter 	 * sense to return values here when everything else is just metadata for
50059e71ee7SDaniel Vetter 	 * the property itself.
50159e71ee7SDaniel Vetter 	 */
50259e71ee7SDaniel Vetter 	if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
50359e71ee7SDaniel Vetter 		out_resp->count_enum_blobs = 0;
504eb8eb02eSDaniel Vetter 
505eb8eb02eSDaniel Vetter 	return 0;
50659e71ee7SDaniel Vetter }
50759e71ee7SDaniel Vetter 
50859e71ee7SDaniel Vetter static void drm_property_free_blob(struct kref *kref)
50959e71ee7SDaniel Vetter {
51059e71ee7SDaniel Vetter 	struct drm_property_blob *blob =
51159e71ee7SDaniel Vetter 		container_of(kref, struct drm_property_blob, base.refcount);
51259e71ee7SDaniel Vetter 
51359e71ee7SDaniel Vetter 	mutex_lock(&blob->dev->mode_config.blob_lock);
51459e71ee7SDaniel Vetter 	list_del(&blob->head_global);
51559e71ee7SDaniel Vetter 	mutex_unlock(&blob->dev->mode_config.blob_lock);
51659e71ee7SDaniel Vetter 
51759e71ee7SDaniel Vetter 	drm_mode_object_unregister(blob->dev, &blob->base);
51859e71ee7SDaniel Vetter 
51959e71ee7SDaniel Vetter 	kfree(blob);
52059e71ee7SDaniel Vetter }
52159e71ee7SDaniel Vetter 
52259e71ee7SDaniel Vetter /**
52359e71ee7SDaniel Vetter  * drm_property_create_blob - Create new blob property
52459e71ee7SDaniel Vetter  * @dev: DRM device to create property for
52559e71ee7SDaniel Vetter  * @length: Length to allocate for blob data
52659e71ee7SDaniel Vetter  * @data: If specified, copies data into blob
52759e71ee7SDaniel Vetter  *
528c8458c7eSDaniel Vetter  * Creates a new blob property for a specified DRM device, optionally
529c8458c7eSDaniel Vetter  * copying data. Note that blob properties are meant to be invariant, hence the
530c8458c7eSDaniel Vetter  * data must be filled out before the blob is used as the value of any property.
531c8458c7eSDaniel Vetter  *
53259e71ee7SDaniel Vetter  * Returns:
53359e71ee7SDaniel Vetter  * New blob property with a single reference on success, or an ERR_PTR
53459e71ee7SDaniel Vetter  * value on failure.
53559e71ee7SDaniel Vetter  */
53659e71ee7SDaniel Vetter struct drm_property_blob *
53759e71ee7SDaniel Vetter drm_property_create_blob(struct drm_device *dev, size_t length,
53859e71ee7SDaniel Vetter 			 const void *data)
53959e71ee7SDaniel Vetter {
54059e71ee7SDaniel Vetter 	struct drm_property_blob *blob;
54159e71ee7SDaniel Vetter 	int ret;
54259e71ee7SDaniel Vetter 
54359e71ee7SDaniel Vetter 	if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
54459e71ee7SDaniel Vetter 		return ERR_PTR(-EINVAL);
54559e71ee7SDaniel Vetter 
54659e71ee7SDaniel Vetter 	blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
54759e71ee7SDaniel Vetter 	if (!blob)
54859e71ee7SDaniel Vetter 		return ERR_PTR(-ENOMEM);
54959e71ee7SDaniel Vetter 
55059e71ee7SDaniel Vetter 	/* This must be explicitly initialised, so we can safely call list_del
55159e71ee7SDaniel Vetter 	 * on it in the removal handler, even if it isn't in a file list. */
55259e71ee7SDaniel Vetter 	INIT_LIST_HEAD(&blob->head_file);
55359e71ee7SDaniel Vetter 	blob->length = length;
55459e71ee7SDaniel Vetter 	blob->dev = dev;
55559e71ee7SDaniel Vetter 
55659e71ee7SDaniel Vetter 	if (data)
55759e71ee7SDaniel Vetter 		memcpy(blob->data, data, length);
55859e71ee7SDaniel Vetter 
5592135ea7aSThierry Reding 	ret = __drm_mode_object_add(dev, &blob->base, DRM_MODE_OBJECT_BLOB,
56059e71ee7SDaniel Vetter 				    true, drm_property_free_blob);
56159e71ee7SDaniel Vetter 	if (ret) {
56259e71ee7SDaniel Vetter 		kfree(blob);
56359e71ee7SDaniel Vetter 		return ERR_PTR(-EINVAL);
56459e71ee7SDaniel Vetter 	}
56559e71ee7SDaniel Vetter 
56659e71ee7SDaniel Vetter 	mutex_lock(&dev->mode_config.blob_lock);
56759e71ee7SDaniel Vetter 	list_add_tail(&blob->head_global,
56859e71ee7SDaniel Vetter 	              &dev->mode_config.property_blob_list);
56959e71ee7SDaniel Vetter 	mutex_unlock(&dev->mode_config.blob_lock);
57059e71ee7SDaniel Vetter 
57159e71ee7SDaniel Vetter 	return blob;
57259e71ee7SDaniel Vetter }
57359e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_blob);
57459e71ee7SDaniel Vetter 
57559e71ee7SDaniel Vetter /**
5766472e509SThierry Reding  * drm_property_blob_put - release a blob property reference
5776472e509SThierry Reding  * @blob: DRM blob property
57859e71ee7SDaniel Vetter  *
5796472e509SThierry Reding  * Releases a reference to a blob property. May free the object.
58059e71ee7SDaniel Vetter  */
5816472e509SThierry Reding void drm_property_blob_put(struct drm_property_blob *blob)
58259e71ee7SDaniel Vetter {
58359e71ee7SDaniel Vetter 	if (!blob)
58459e71ee7SDaniel Vetter 		return;
58559e71ee7SDaniel Vetter 
586020a218fSThierry Reding 	drm_mode_object_put(&blob->base);
58759e71ee7SDaniel Vetter }
5886472e509SThierry Reding EXPORT_SYMBOL(drm_property_blob_put);
58959e71ee7SDaniel Vetter 
59059e71ee7SDaniel Vetter void drm_property_destroy_user_blobs(struct drm_device *dev,
59159e71ee7SDaniel Vetter 				     struct drm_file *file_priv)
59259e71ee7SDaniel Vetter {
59359e71ee7SDaniel Vetter 	struct drm_property_blob *blob, *bt;
59459e71ee7SDaniel Vetter 
59559e71ee7SDaniel Vetter 	/*
59659e71ee7SDaniel Vetter 	 * When the file gets released that means no one else can access the
59759e71ee7SDaniel Vetter 	 * blob list any more, so no need to grab dev->blob_lock.
59859e71ee7SDaniel Vetter 	 */
59959e71ee7SDaniel Vetter 	list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
60059e71ee7SDaniel Vetter 		list_del_init(&blob->head_file);
6016472e509SThierry Reding 		drm_property_blob_put(blob);
60259e71ee7SDaniel Vetter 	}
60359e71ee7SDaniel Vetter }
60459e71ee7SDaniel Vetter 
60559e71ee7SDaniel Vetter /**
6066472e509SThierry Reding  * drm_property_blob_get - acquire blob property reference
6076472e509SThierry Reding  * @blob: DRM blob property
608c8458c7eSDaniel Vetter  *
6096472e509SThierry Reding  * Acquires a reference to an existing blob property. Returns @blob, which
610c8458c7eSDaniel Vetter  * allows this to be used as a shorthand in assignments.
61159e71ee7SDaniel Vetter  */
6126472e509SThierry Reding struct drm_property_blob *drm_property_blob_get(struct drm_property_blob *blob)
61359e71ee7SDaniel Vetter {
614020a218fSThierry Reding 	drm_mode_object_get(&blob->base);
61559e71ee7SDaniel Vetter 	return blob;
61659e71ee7SDaniel Vetter }
6176472e509SThierry Reding EXPORT_SYMBOL(drm_property_blob_get);
61859e71ee7SDaniel Vetter 
61959e71ee7SDaniel Vetter /**
62059e71ee7SDaniel Vetter  * drm_property_lookup_blob - look up a blob property and take a reference
62159e71ee7SDaniel Vetter  * @dev: drm device
62259e71ee7SDaniel Vetter  * @id: id of the blob property
62359e71ee7SDaniel Vetter  *
62459e71ee7SDaniel Vetter  * If successful, this takes an additional reference to the blob property.
62559e71ee7SDaniel Vetter  * callers need to make sure to eventually unreference the returned property
6266472e509SThierry Reding  * again, using drm_property_blob_put().
627c8458c7eSDaniel Vetter  *
628c8458c7eSDaniel Vetter  * Return:
629c8458c7eSDaniel Vetter  * NULL on failure, pointer to the blob on success.
63059e71ee7SDaniel Vetter  */
63159e71ee7SDaniel Vetter struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
63259e71ee7SDaniel Vetter 					           uint32_t id)
63359e71ee7SDaniel Vetter {
63459e71ee7SDaniel Vetter 	struct drm_mode_object *obj;
63559e71ee7SDaniel Vetter 	struct drm_property_blob *blob = NULL;
63659e71ee7SDaniel Vetter 
63759e71ee7SDaniel Vetter 	obj = __drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
63859e71ee7SDaniel Vetter 	if (obj)
63959e71ee7SDaniel Vetter 		blob = obj_to_blob(obj);
64059e71ee7SDaniel Vetter 	return blob;
64159e71ee7SDaniel Vetter }
64259e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_lookup_blob);
64359e71ee7SDaniel Vetter 
64459e71ee7SDaniel Vetter /**
645c8458c7eSDaniel Vetter  * drm_property_replace_global_blob - replace existing blob property
64659e71ee7SDaniel Vetter  * @dev: drm device
64759e71ee7SDaniel Vetter  * @replace: location of blob property pointer to be replaced
64859e71ee7SDaniel Vetter  * @length: length of data for new blob, or 0 for no data
64959e71ee7SDaniel Vetter  * @data: content for new blob, or NULL for no data
65059e71ee7SDaniel Vetter  * @obj_holds_id: optional object for property holding blob ID
65159e71ee7SDaniel Vetter  * @prop_holds_id: optional property holding blob ID
65259e71ee7SDaniel Vetter  * @return 0 on success or error on failure
65359e71ee7SDaniel Vetter  *
654c8458c7eSDaniel Vetter  * This function will replace a global property in the blob list, optionally
655c8458c7eSDaniel Vetter  * updating a property which holds the ID of that property.
65659e71ee7SDaniel Vetter  *
65759e71ee7SDaniel Vetter  * If length is 0 or data is NULL, no new blob will be created, and the holding
65859e71ee7SDaniel Vetter  * property, if specified, will be set to 0.
65959e71ee7SDaniel Vetter  *
66059e71ee7SDaniel Vetter  * Access to the replace pointer is assumed to be protected by the caller, e.g.
66159e71ee7SDaniel Vetter  * by holding the relevant modesetting object lock for its parent.
66259e71ee7SDaniel Vetter  *
66359e71ee7SDaniel Vetter  * For example, a drm_connector has a 'PATH' property, which contains the ID
66459e71ee7SDaniel Vetter  * of a blob property with the value of the MST path information. Calling this
66559e71ee7SDaniel Vetter  * function with replace pointing to the connector's path_blob_ptr, length and
66659e71ee7SDaniel Vetter  * data set for the new path information, obj_holds_id set to the connector's
66759e71ee7SDaniel Vetter  * base object, and prop_holds_id set to the path property name, will perform
66859e71ee7SDaniel Vetter  * a completely atomic update. The access to path_blob_ptr is protected by the
66959e71ee7SDaniel Vetter  * caller holding a lock on the connector.
67059e71ee7SDaniel Vetter  */
67159e71ee7SDaniel Vetter int drm_property_replace_global_blob(struct drm_device *dev,
67259e71ee7SDaniel Vetter 				     struct drm_property_blob **replace,
67359e71ee7SDaniel Vetter 				     size_t length,
67459e71ee7SDaniel Vetter 				     const void *data,
67559e71ee7SDaniel Vetter 				     struct drm_mode_object *obj_holds_id,
67659e71ee7SDaniel Vetter 				     struct drm_property *prop_holds_id)
67759e71ee7SDaniel Vetter {
67859e71ee7SDaniel Vetter 	struct drm_property_blob *new_blob = NULL;
67959e71ee7SDaniel Vetter 	struct drm_property_blob *old_blob = NULL;
68059e71ee7SDaniel Vetter 	int ret;
68159e71ee7SDaniel Vetter 
68259e71ee7SDaniel Vetter 	WARN_ON(replace == NULL);
68359e71ee7SDaniel Vetter 
68459e71ee7SDaniel Vetter 	old_blob = *replace;
68559e71ee7SDaniel Vetter 
68659e71ee7SDaniel Vetter 	if (length && data) {
68759e71ee7SDaniel Vetter 		new_blob = drm_property_create_blob(dev, length, data);
68859e71ee7SDaniel Vetter 		if (IS_ERR(new_blob))
68959e71ee7SDaniel Vetter 			return PTR_ERR(new_blob);
69059e71ee7SDaniel Vetter 	}
69159e71ee7SDaniel Vetter 
69259e71ee7SDaniel Vetter 	if (obj_holds_id) {
69359e71ee7SDaniel Vetter 		ret = drm_object_property_set_value(obj_holds_id,
69459e71ee7SDaniel Vetter 						    prop_holds_id,
69559e71ee7SDaniel Vetter 						    new_blob ?
69659e71ee7SDaniel Vetter 						        new_blob->base.id : 0);
69759e71ee7SDaniel Vetter 		if (ret != 0)
69859e71ee7SDaniel Vetter 			goto err_created;
69959e71ee7SDaniel Vetter 	}
70059e71ee7SDaniel Vetter 
7016472e509SThierry Reding 	drm_property_blob_put(old_blob);
70259e71ee7SDaniel Vetter 	*replace = new_blob;
70359e71ee7SDaniel Vetter 
70459e71ee7SDaniel Vetter 	return 0;
70559e71ee7SDaniel Vetter 
70659e71ee7SDaniel Vetter err_created:
7076472e509SThierry Reding 	drm_property_blob_put(new_blob);
70859e71ee7SDaniel Vetter 	return ret;
70959e71ee7SDaniel Vetter }
71059e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_replace_global_blob);
71159e71ee7SDaniel Vetter 
71259e71ee7SDaniel Vetter int drm_mode_getblob_ioctl(struct drm_device *dev,
71359e71ee7SDaniel Vetter 			   void *data, struct drm_file *file_priv)
71459e71ee7SDaniel Vetter {
71559e71ee7SDaniel Vetter 	struct drm_mode_get_blob *out_resp = data;
71659e71ee7SDaniel Vetter 	struct drm_property_blob *blob;
71759e71ee7SDaniel Vetter 	int ret = 0;
71859e71ee7SDaniel Vetter 
71959e71ee7SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
72059e71ee7SDaniel Vetter 		return -EINVAL;
72159e71ee7SDaniel Vetter 
72259e71ee7SDaniel Vetter 	blob = drm_property_lookup_blob(dev, out_resp->blob_id);
72359e71ee7SDaniel Vetter 	if (!blob)
72459e71ee7SDaniel Vetter 		return -ENOENT;
72559e71ee7SDaniel Vetter 
72659e71ee7SDaniel Vetter 	if (out_resp->length == blob->length) {
72775df6247SChris Wilson 		if (copy_to_user(u64_to_user_ptr(out_resp->data),
72875df6247SChris Wilson 				 blob->data,
72975df6247SChris Wilson 				 blob->length)) {
73059e71ee7SDaniel Vetter 			ret = -EFAULT;
73159e71ee7SDaniel Vetter 			goto unref;
73259e71ee7SDaniel Vetter 		}
73359e71ee7SDaniel Vetter 	}
73459e71ee7SDaniel Vetter 	out_resp->length = blob->length;
73559e71ee7SDaniel Vetter unref:
7366472e509SThierry Reding 	drm_property_blob_put(blob);
73759e71ee7SDaniel Vetter 
73859e71ee7SDaniel Vetter 	return ret;
73959e71ee7SDaniel Vetter }
74059e71ee7SDaniel Vetter 
74159e71ee7SDaniel Vetter int drm_mode_createblob_ioctl(struct drm_device *dev,
74259e71ee7SDaniel Vetter 			      void *data, struct drm_file *file_priv)
74359e71ee7SDaniel Vetter {
74459e71ee7SDaniel Vetter 	struct drm_mode_create_blob *out_resp = data;
74559e71ee7SDaniel Vetter 	struct drm_property_blob *blob;
74659e71ee7SDaniel Vetter 	int ret = 0;
74759e71ee7SDaniel Vetter 
74859e71ee7SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
74959e71ee7SDaniel Vetter 		return -EINVAL;
75059e71ee7SDaniel Vetter 
75159e71ee7SDaniel Vetter 	blob = drm_property_create_blob(dev, out_resp->length, NULL);
75259e71ee7SDaniel Vetter 	if (IS_ERR(blob))
75359e71ee7SDaniel Vetter 		return PTR_ERR(blob);
75459e71ee7SDaniel Vetter 
75575df6247SChris Wilson 	if (copy_from_user(blob->data,
75675df6247SChris Wilson 			   u64_to_user_ptr(out_resp->data),
75775df6247SChris Wilson 			   out_resp->length)) {
75859e71ee7SDaniel Vetter 		ret = -EFAULT;
75959e71ee7SDaniel Vetter 		goto out_blob;
76059e71ee7SDaniel Vetter 	}
76159e71ee7SDaniel Vetter 
76259e71ee7SDaniel Vetter 	/* Dropping the lock between create_blob and our access here is safe
76359e71ee7SDaniel Vetter 	 * as only the same file_priv can remove the blob; at this point, it is
76459e71ee7SDaniel Vetter 	 * not associated with any file_priv. */
76559e71ee7SDaniel Vetter 	mutex_lock(&dev->mode_config.blob_lock);
76659e71ee7SDaniel Vetter 	out_resp->blob_id = blob->base.id;
76759e71ee7SDaniel Vetter 	list_add_tail(&blob->head_file, &file_priv->blobs);
76859e71ee7SDaniel Vetter 	mutex_unlock(&dev->mode_config.blob_lock);
76959e71ee7SDaniel Vetter 
77059e71ee7SDaniel Vetter 	return 0;
77159e71ee7SDaniel Vetter 
77259e71ee7SDaniel Vetter out_blob:
7736472e509SThierry Reding 	drm_property_blob_put(blob);
77459e71ee7SDaniel Vetter 	return ret;
77559e71ee7SDaniel Vetter }
77659e71ee7SDaniel Vetter 
77759e71ee7SDaniel Vetter int drm_mode_destroyblob_ioctl(struct drm_device *dev,
77859e71ee7SDaniel Vetter 			       void *data, struct drm_file *file_priv)
77959e71ee7SDaniel Vetter {
78059e71ee7SDaniel Vetter 	struct drm_mode_destroy_blob *out_resp = data;
78159e71ee7SDaniel Vetter 	struct drm_property_blob *blob = NULL, *bt;
78259e71ee7SDaniel Vetter 	bool found = false;
78359e71ee7SDaniel Vetter 	int ret = 0;
78459e71ee7SDaniel Vetter 
78559e71ee7SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
78659e71ee7SDaniel Vetter 		return -EINVAL;
78759e71ee7SDaniel Vetter 
78859e71ee7SDaniel Vetter 	blob = drm_property_lookup_blob(dev, out_resp->blob_id);
78959e71ee7SDaniel Vetter 	if (!blob)
79059e71ee7SDaniel Vetter 		return -ENOENT;
79159e71ee7SDaniel Vetter 
79259e71ee7SDaniel Vetter 	mutex_lock(&dev->mode_config.blob_lock);
79359e71ee7SDaniel Vetter 	/* Ensure the property was actually created by this user. */
79459e71ee7SDaniel Vetter 	list_for_each_entry(bt, &file_priv->blobs, head_file) {
79559e71ee7SDaniel Vetter 		if (bt == blob) {
79659e71ee7SDaniel Vetter 			found = true;
79759e71ee7SDaniel Vetter 			break;
79859e71ee7SDaniel Vetter 		}
79959e71ee7SDaniel Vetter 	}
80059e71ee7SDaniel Vetter 
80159e71ee7SDaniel Vetter 	if (!found) {
80259e71ee7SDaniel Vetter 		ret = -EPERM;
80359e71ee7SDaniel Vetter 		goto err;
80459e71ee7SDaniel Vetter 	}
80559e71ee7SDaniel Vetter 
80659e71ee7SDaniel Vetter 	/* We must drop head_file here, because we may not be the last
80759e71ee7SDaniel Vetter 	 * reference on the blob. */
80859e71ee7SDaniel Vetter 	list_del_init(&blob->head_file);
80959e71ee7SDaniel Vetter 	mutex_unlock(&dev->mode_config.blob_lock);
81059e71ee7SDaniel Vetter 
81159e71ee7SDaniel Vetter 	/* One reference from lookup, and one from the filp. */
8126472e509SThierry Reding 	drm_property_blob_put(blob);
8136472e509SThierry Reding 	drm_property_blob_put(blob);
81459e71ee7SDaniel Vetter 
81559e71ee7SDaniel Vetter 	return 0;
81659e71ee7SDaniel Vetter 
81759e71ee7SDaniel Vetter err:
81859e71ee7SDaniel Vetter 	mutex_unlock(&dev->mode_config.blob_lock);
8196472e509SThierry Reding 	drm_property_blob_put(blob);
82059e71ee7SDaniel Vetter 
82159e71ee7SDaniel Vetter 	return ret;
82259e71ee7SDaniel Vetter }
82359e71ee7SDaniel Vetter 
82459e71ee7SDaniel Vetter /* Some properties could refer to dynamic refcnt'd objects, or things that
82559e71ee7SDaniel Vetter  * need special locking to handle lifetime issues (ie. to ensure the prop
82659e71ee7SDaniel Vetter  * value doesn't become invalid part way through the property update due to
82759e71ee7SDaniel Vetter  * race).  The value returned by reference via 'obj' should be passed back
82859e71ee7SDaniel Vetter  * to drm_property_change_valid_put() after the property is set (and the
82959e71ee7SDaniel Vetter  * object to which the property is attached has a chance to take it's own
83059e71ee7SDaniel Vetter  * reference).
83159e71ee7SDaniel Vetter  */
83259e71ee7SDaniel Vetter bool drm_property_change_valid_get(struct drm_property *property,
83359e71ee7SDaniel Vetter 				   uint64_t value, struct drm_mode_object **ref)
83459e71ee7SDaniel Vetter {
83559e71ee7SDaniel Vetter 	int i;
83659e71ee7SDaniel Vetter 
83759e71ee7SDaniel Vetter 	if (property->flags & DRM_MODE_PROP_IMMUTABLE)
83859e71ee7SDaniel Vetter 		return false;
83959e71ee7SDaniel Vetter 
84059e71ee7SDaniel Vetter 	*ref = NULL;
84159e71ee7SDaniel Vetter 
84259e71ee7SDaniel Vetter 	if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
84359e71ee7SDaniel Vetter 		if (value < property->values[0] || value > property->values[1])
84459e71ee7SDaniel Vetter 			return false;
84559e71ee7SDaniel Vetter 		return true;
84659e71ee7SDaniel Vetter 	} else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
84759e71ee7SDaniel Vetter 		int64_t svalue = U642I64(value);
84859e71ee7SDaniel Vetter 
84959e71ee7SDaniel Vetter 		if (svalue < U642I64(property->values[0]) ||
85059e71ee7SDaniel Vetter 				svalue > U642I64(property->values[1]))
85159e71ee7SDaniel Vetter 			return false;
85259e71ee7SDaniel Vetter 		return true;
85359e71ee7SDaniel Vetter 	} else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
85459e71ee7SDaniel Vetter 		uint64_t valid_mask = 0;
85559e71ee7SDaniel Vetter 
85659e71ee7SDaniel Vetter 		for (i = 0; i < property->num_values; i++)
85759e71ee7SDaniel Vetter 			valid_mask |= (1ULL << property->values[i]);
85859e71ee7SDaniel Vetter 		return !(value & ~valid_mask);
85930c06570SMaarten Lankhorst 	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
86030c06570SMaarten Lankhorst 		struct drm_property_blob *blob;
86130c06570SMaarten Lankhorst 
86230c06570SMaarten Lankhorst 		if (value == 0)
86330c06570SMaarten Lankhorst 			return true;
86430c06570SMaarten Lankhorst 
86530c06570SMaarten Lankhorst 		blob = drm_property_lookup_blob(property->dev, value);
86630c06570SMaarten Lankhorst 		if (blob) {
86730c06570SMaarten Lankhorst 			*ref = &blob->base;
86830c06570SMaarten Lankhorst 			return true;
86930c06570SMaarten Lankhorst 		} else {
87030c06570SMaarten Lankhorst 			return false;
87130c06570SMaarten Lankhorst 		}
87230c06570SMaarten Lankhorst 	} else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
87359e71ee7SDaniel Vetter 		/* a zero value for an object property translates to null: */
87459e71ee7SDaniel Vetter 		if (value == 0)
87559e71ee7SDaniel Vetter 			return true;
87659e71ee7SDaniel Vetter 
87759e71ee7SDaniel Vetter 		*ref = __drm_mode_object_find(property->dev, value,
87859e71ee7SDaniel Vetter 					      property->values[0]);
87959e71ee7SDaniel Vetter 		return *ref != NULL;
88059e71ee7SDaniel Vetter 	}
88159e71ee7SDaniel Vetter 
88259e71ee7SDaniel Vetter 	for (i = 0; i < property->num_values; i++)
88359e71ee7SDaniel Vetter 		if (property->values[i] == value)
88459e71ee7SDaniel Vetter 			return true;
88559e71ee7SDaniel Vetter 	return false;
88659e71ee7SDaniel Vetter }
88759e71ee7SDaniel Vetter 
88859e71ee7SDaniel Vetter void drm_property_change_valid_put(struct drm_property *property,
88959e71ee7SDaniel Vetter 		struct drm_mode_object *ref)
89059e71ee7SDaniel Vetter {
89159e71ee7SDaniel Vetter 	if (!ref)
89259e71ee7SDaniel Vetter 		return;
89359e71ee7SDaniel Vetter 
89430c06570SMaarten Lankhorst 	if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
895020a218fSThierry Reding 		drm_mode_object_put(ref);
89630c06570SMaarten Lankhorst 	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
8976472e509SThierry Reding 		drm_property_blob_put(obj_to_blob(ref));
89859e71ee7SDaniel Vetter }
899