18c2ecf20Sopenharmony_ci/*
28c2ecf20Sopenharmony_ci * Copyright (c) 2016 Intel Corporation
38c2ecf20Sopenharmony_ci *
48c2ecf20Sopenharmony_ci * Permission to use, copy, modify, distribute, and sell this software and its
58c2ecf20Sopenharmony_ci * documentation for any purpose is hereby granted without fee, provided that
68c2ecf20Sopenharmony_ci * the above copyright notice appear in all copies and that both that copyright
78c2ecf20Sopenharmony_ci * notice and this permission notice appear in supporting documentation, and
88c2ecf20Sopenharmony_ci * that the name of the copyright holders not be used in advertising or
98c2ecf20Sopenharmony_ci * publicity pertaining to distribution of the software without specific,
108c2ecf20Sopenharmony_ci * written prior permission.  The copyright holders make no representations
118c2ecf20Sopenharmony_ci * about the suitability of this software for any purpose.  It is provided "as
128c2ecf20Sopenharmony_ci * is" without express or implied warranty.
138c2ecf20Sopenharmony_ci *
148c2ecf20Sopenharmony_ci * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
158c2ecf20Sopenharmony_ci * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
168c2ecf20Sopenharmony_ci * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
178c2ecf20Sopenharmony_ci * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
188c2ecf20Sopenharmony_ci * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
198c2ecf20Sopenharmony_ci * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
208c2ecf20Sopenharmony_ci * OF THIS SOFTWARE.
218c2ecf20Sopenharmony_ci */
228c2ecf20Sopenharmony_ci
238c2ecf20Sopenharmony_ci#include <linux/export.h>
248c2ecf20Sopenharmony_ci#include <linux/uaccess.h>
258c2ecf20Sopenharmony_ci
268c2ecf20Sopenharmony_ci#include <drm/drm_crtc.h>
278c2ecf20Sopenharmony_ci#include <drm/drm_drv.h>
288c2ecf20Sopenharmony_ci#include <drm/drm_file.h>
298c2ecf20Sopenharmony_ci#include <drm/drm_framebuffer.h>
308c2ecf20Sopenharmony_ci#include <drm/drm_property.h>
318c2ecf20Sopenharmony_ci
328c2ecf20Sopenharmony_ci#include "drm_crtc_internal.h"
338c2ecf20Sopenharmony_ci
348c2ecf20Sopenharmony_ci/**
358c2ecf20Sopenharmony_ci * DOC: overview
368c2ecf20Sopenharmony_ci *
378c2ecf20Sopenharmony_ci * Properties as represented by &drm_property are used to extend the modeset
388c2ecf20Sopenharmony_ci * interface exposed to userspace. For the atomic modeset IOCTL properties are
398c2ecf20Sopenharmony_ci * even the only way to transport metadata about the desired new modeset
408c2ecf20Sopenharmony_ci * configuration from userspace to the kernel. Properties have a well-defined
418c2ecf20Sopenharmony_ci * value range, which is enforced by the drm core. See the documentation of the
428c2ecf20Sopenharmony_ci * flags member of &struct drm_property for an overview of the different
438c2ecf20Sopenharmony_ci * property types and ranges.
448c2ecf20Sopenharmony_ci *
458c2ecf20Sopenharmony_ci * Properties don't store the current value directly, but need to be
468c2ecf20Sopenharmony_ci * instatiated by attaching them to a &drm_mode_object with
478c2ecf20Sopenharmony_ci * drm_object_attach_property().
488c2ecf20Sopenharmony_ci *
498c2ecf20Sopenharmony_ci * Property values are only 64bit. To support bigger piles of data (like gamma
508c2ecf20Sopenharmony_ci * tables, color correction matrices or large structures) a property can instead
518c2ecf20Sopenharmony_ci * point at a &drm_property_blob with that additional data.
528c2ecf20Sopenharmony_ci *
538c2ecf20Sopenharmony_ci * Properties are defined by their symbolic name, userspace must keep a
548c2ecf20Sopenharmony_ci * per-object mapping from those names to the property ID used in the atomic
558c2ecf20Sopenharmony_ci * IOCTL and in the get/set property IOCTL.
568c2ecf20Sopenharmony_ci */
578c2ecf20Sopenharmony_ci
588c2ecf20Sopenharmony_cistatic bool drm_property_flags_valid(u32 flags)
598c2ecf20Sopenharmony_ci{
608c2ecf20Sopenharmony_ci	u32 legacy_type = flags & DRM_MODE_PROP_LEGACY_TYPE;
618c2ecf20Sopenharmony_ci	u32 ext_type = flags & DRM_MODE_PROP_EXTENDED_TYPE;
628c2ecf20Sopenharmony_ci
638c2ecf20Sopenharmony_ci	/* Reject undefined/deprecated flags */
648c2ecf20Sopenharmony_ci	if (flags & ~(DRM_MODE_PROP_LEGACY_TYPE |
658c2ecf20Sopenharmony_ci		      DRM_MODE_PROP_EXTENDED_TYPE |
668c2ecf20Sopenharmony_ci		      DRM_MODE_PROP_IMMUTABLE |
678c2ecf20Sopenharmony_ci		      DRM_MODE_PROP_ATOMIC))
688c2ecf20Sopenharmony_ci		return false;
698c2ecf20Sopenharmony_ci
708c2ecf20Sopenharmony_ci	/* We want either a legacy type or an extended type, but not both */
718c2ecf20Sopenharmony_ci	if (!legacy_type == !ext_type)
728c2ecf20Sopenharmony_ci		return false;
738c2ecf20Sopenharmony_ci
748c2ecf20Sopenharmony_ci	/* Only one legacy type at a time please */
758c2ecf20Sopenharmony_ci	if (legacy_type && !is_power_of_2(legacy_type))
768c2ecf20Sopenharmony_ci		return false;
778c2ecf20Sopenharmony_ci
788c2ecf20Sopenharmony_ci	return true;
798c2ecf20Sopenharmony_ci}
808c2ecf20Sopenharmony_ci
818c2ecf20Sopenharmony_ci/**
828c2ecf20Sopenharmony_ci * drm_property_create - create a new property type
838c2ecf20Sopenharmony_ci * @dev: drm device
848c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
858c2ecf20Sopenharmony_ci * @name: name of the property
868c2ecf20Sopenharmony_ci * @num_values: number of pre-defined values
878c2ecf20Sopenharmony_ci *
888c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
898c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
908c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
918c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
928c2ecf20Sopenharmony_ci *
938c2ecf20Sopenharmony_ci * Returns:
948c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
958c2ecf20Sopenharmony_ci */
968c2ecf20Sopenharmony_cistruct drm_property *drm_property_create(struct drm_device *dev,
978c2ecf20Sopenharmony_ci					 u32 flags, const char *name,
988c2ecf20Sopenharmony_ci					 int num_values)
998c2ecf20Sopenharmony_ci{
1008c2ecf20Sopenharmony_ci	struct drm_property *property = NULL;
1018c2ecf20Sopenharmony_ci	int ret;
1028c2ecf20Sopenharmony_ci
1038c2ecf20Sopenharmony_ci	if (WARN_ON(!drm_property_flags_valid(flags)))
1048c2ecf20Sopenharmony_ci		return NULL;
1058c2ecf20Sopenharmony_ci
1068c2ecf20Sopenharmony_ci	if (WARN_ON(strlen(name) >= DRM_PROP_NAME_LEN))
1078c2ecf20Sopenharmony_ci		return NULL;
1088c2ecf20Sopenharmony_ci
1098c2ecf20Sopenharmony_ci	property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
1108c2ecf20Sopenharmony_ci	if (!property)
1118c2ecf20Sopenharmony_ci		return NULL;
1128c2ecf20Sopenharmony_ci
1138c2ecf20Sopenharmony_ci	property->dev = dev;
1148c2ecf20Sopenharmony_ci
1158c2ecf20Sopenharmony_ci	if (num_values) {
1168c2ecf20Sopenharmony_ci		property->values = kcalloc(num_values, sizeof(uint64_t),
1178c2ecf20Sopenharmony_ci					   GFP_KERNEL);
1188c2ecf20Sopenharmony_ci		if (!property->values)
1198c2ecf20Sopenharmony_ci			goto fail;
1208c2ecf20Sopenharmony_ci	}
1218c2ecf20Sopenharmony_ci
1228c2ecf20Sopenharmony_ci	ret = drm_mode_object_add(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
1238c2ecf20Sopenharmony_ci	if (ret)
1248c2ecf20Sopenharmony_ci		goto fail;
1258c2ecf20Sopenharmony_ci
1268c2ecf20Sopenharmony_ci	property->flags = flags;
1278c2ecf20Sopenharmony_ci	property->num_values = num_values;
1288c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&property->enum_list);
1298c2ecf20Sopenharmony_ci
1308c2ecf20Sopenharmony_ci	strncpy(property->name, name, DRM_PROP_NAME_LEN);
1318c2ecf20Sopenharmony_ci	property->name[DRM_PROP_NAME_LEN-1] = '\0';
1328c2ecf20Sopenharmony_ci
1338c2ecf20Sopenharmony_ci	list_add_tail(&property->head, &dev->mode_config.property_list);
1348c2ecf20Sopenharmony_ci
1358c2ecf20Sopenharmony_ci	return property;
1368c2ecf20Sopenharmony_cifail:
1378c2ecf20Sopenharmony_ci	kfree(property->values);
1388c2ecf20Sopenharmony_ci	kfree(property);
1398c2ecf20Sopenharmony_ci	return NULL;
1408c2ecf20Sopenharmony_ci}
1418c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create);
1428c2ecf20Sopenharmony_ci
1438c2ecf20Sopenharmony_ci/**
1448c2ecf20Sopenharmony_ci * drm_property_create_enum - create a new enumeration property type
1458c2ecf20Sopenharmony_ci * @dev: drm device
1468c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
1478c2ecf20Sopenharmony_ci * @name: name of the property
1488c2ecf20Sopenharmony_ci * @props: enumeration lists with property values
1498c2ecf20Sopenharmony_ci * @num_values: number of pre-defined values
1508c2ecf20Sopenharmony_ci *
1518c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
1528c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
1538c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
1548c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
1558c2ecf20Sopenharmony_ci *
1568c2ecf20Sopenharmony_ci * Userspace is only allowed to set one of the predefined values for enumeration
1578c2ecf20Sopenharmony_ci * properties.
1588c2ecf20Sopenharmony_ci *
1598c2ecf20Sopenharmony_ci * Returns:
1608c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
1618c2ecf20Sopenharmony_ci */
1628c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_enum(struct drm_device *dev,
1638c2ecf20Sopenharmony_ci					      u32 flags, const char *name,
1648c2ecf20Sopenharmony_ci					      const struct drm_prop_enum_list *props,
1658c2ecf20Sopenharmony_ci					      int num_values)
1668c2ecf20Sopenharmony_ci{
1678c2ecf20Sopenharmony_ci	struct drm_property *property;
1688c2ecf20Sopenharmony_ci	int i, ret;
1698c2ecf20Sopenharmony_ci
1708c2ecf20Sopenharmony_ci	flags |= DRM_MODE_PROP_ENUM;
1718c2ecf20Sopenharmony_ci
1728c2ecf20Sopenharmony_ci	property = drm_property_create(dev, flags, name, num_values);
1738c2ecf20Sopenharmony_ci	if (!property)
1748c2ecf20Sopenharmony_ci		return NULL;
1758c2ecf20Sopenharmony_ci
1768c2ecf20Sopenharmony_ci	for (i = 0; i < num_values; i++) {
1778c2ecf20Sopenharmony_ci		ret = drm_property_add_enum(property,
1788c2ecf20Sopenharmony_ci					    props[i].type,
1798c2ecf20Sopenharmony_ci					    props[i].name);
1808c2ecf20Sopenharmony_ci		if (ret) {
1818c2ecf20Sopenharmony_ci			drm_property_destroy(dev, property);
1828c2ecf20Sopenharmony_ci			return NULL;
1838c2ecf20Sopenharmony_ci		}
1848c2ecf20Sopenharmony_ci	}
1858c2ecf20Sopenharmony_ci
1868c2ecf20Sopenharmony_ci	return property;
1878c2ecf20Sopenharmony_ci}
1888c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_enum);
1898c2ecf20Sopenharmony_ci
1908c2ecf20Sopenharmony_ci/**
1918c2ecf20Sopenharmony_ci * drm_property_create_bitmask - create a new bitmask property type
1928c2ecf20Sopenharmony_ci * @dev: drm device
1938c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
1948c2ecf20Sopenharmony_ci * @name: name of the property
1958c2ecf20Sopenharmony_ci * @props: enumeration lists with property bitflags
1968c2ecf20Sopenharmony_ci * @num_props: size of the @props array
1978c2ecf20Sopenharmony_ci * @supported_bits: bitmask of all supported enumeration values
1988c2ecf20Sopenharmony_ci *
1998c2ecf20Sopenharmony_ci * This creates a new bitmask drm property which can then be attached to a drm
2008c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
2018c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
2028c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
2038c2ecf20Sopenharmony_ci *
2048c2ecf20Sopenharmony_ci * Compared to plain enumeration properties userspace is allowed to set any
2058c2ecf20Sopenharmony_ci * or'ed together combination of the predefined property bitflag values
2068c2ecf20Sopenharmony_ci *
2078c2ecf20Sopenharmony_ci * Returns:
2088c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
2098c2ecf20Sopenharmony_ci */
2108c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_bitmask(struct drm_device *dev,
2118c2ecf20Sopenharmony_ci						 u32 flags, const char *name,
2128c2ecf20Sopenharmony_ci						 const struct drm_prop_enum_list *props,
2138c2ecf20Sopenharmony_ci						 int num_props,
2148c2ecf20Sopenharmony_ci						 uint64_t supported_bits)
2158c2ecf20Sopenharmony_ci{
2168c2ecf20Sopenharmony_ci	struct drm_property *property;
2178c2ecf20Sopenharmony_ci	int i, ret;
2188c2ecf20Sopenharmony_ci	int num_values = hweight64(supported_bits);
2198c2ecf20Sopenharmony_ci
2208c2ecf20Sopenharmony_ci	flags |= DRM_MODE_PROP_BITMASK;
2218c2ecf20Sopenharmony_ci
2228c2ecf20Sopenharmony_ci	property = drm_property_create(dev, flags, name, num_values);
2238c2ecf20Sopenharmony_ci	if (!property)
2248c2ecf20Sopenharmony_ci		return NULL;
2258c2ecf20Sopenharmony_ci	for (i = 0; i < num_props; i++) {
2268c2ecf20Sopenharmony_ci		if (!(supported_bits & (1ULL << props[i].type)))
2278c2ecf20Sopenharmony_ci			continue;
2288c2ecf20Sopenharmony_ci
2298c2ecf20Sopenharmony_ci		ret = drm_property_add_enum(property,
2308c2ecf20Sopenharmony_ci					    props[i].type,
2318c2ecf20Sopenharmony_ci					    props[i].name);
2328c2ecf20Sopenharmony_ci		if (ret) {
2338c2ecf20Sopenharmony_ci			drm_property_destroy(dev, property);
2348c2ecf20Sopenharmony_ci			return NULL;
2358c2ecf20Sopenharmony_ci		}
2368c2ecf20Sopenharmony_ci	}
2378c2ecf20Sopenharmony_ci
2388c2ecf20Sopenharmony_ci	return property;
2398c2ecf20Sopenharmony_ci}
2408c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_bitmask);
2418c2ecf20Sopenharmony_ci
2428c2ecf20Sopenharmony_cistatic struct drm_property *property_create_range(struct drm_device *dev,
2438c2ecf20Sopenharmony_ci						  u32 flags, const char *name,
2448c2ecf20Sopenharmony_ci						  uint64_t min, uint64_t max)
2458c2ecf20Sopenharmony_ci{
2468c2ecf20Sopenharmony_ci	struct drm_property *property;
2478c2ecf20Sopenharmony_ci
2488c2ecf20Sopenharmony_ci	property = drm_property_create(dev, flags, name, 2);
2498c2ecf20Sopenharmony_ci	if (!property)
2508c2ecf20Sopenharmony_ci		return NULL;
2518c2ecf20Sopenharmony_ci
2528c2ecf20Sopenharmony_ci	property->values[0] = min;
2538c2ecf20Sopenharmony_ci	property->values[1] = max;
2548c2ecf20Sopenharmony_ci
2558c2ecf20Sopenharmony_ci	return property;
2568c2ecf20Sopenharmony_ci}
2578c2ecf20Sopenharmony_ci
2588c2ecf20Sopenharmony_ci/**
2598c2ecf20Sopenharmony_ci * drm_property_create_range - create a new unsigned ranged property type
2608c2ecf20Sopenharmony_ci * @dev: drm device
2618c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
2628c2ecf20Sopenharmony_ci * @name: name of the property
2638c2ecf20Sopenharmony_ci * @min: minimum value of the property
2648c2ecf20Sopenharmony_ci * @max: maximum value of the property
2658c2ecf20Sopenharmony_ci *
2668c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
2678c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
2688c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
2698c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
2708c2ecf20Sopenharmony_ci *
2718c2ecf20Sopenharmony_ci * Userspace is allowed to set any unsigned integer value in the (min, max)
2728c2ecf20Sopenharmony_ci * range inclusive.
2738c2ecf20Sopenharmony_ci *
2748c2ecf20Sopenharmony_ci * Returns:
2758c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
2768c2ecf20Sopenharmony_ci */
2778c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_range(struct drm_device *dev,
2788c2ecf20Sopenharmony_ci					       u32 flags, const char *name,
2798c2ecf20Sopenharmony_ci					       uint64_t min, uint64_t max)
2808c2ecf20Sopenharmony_ci{
2818c2ecf20Sopenharmony_ci	return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
2828c2ecf20Sopenharmony_ci			name, min, max);
2838c2ecf20Sopenharmony_ci}
2848c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_range);
2858c2ecf20Sopenharmony_ci
2868c2ecf20Sopenharmony_ci/**
2878c2ecf20Sopenharmony_ci * drm_property_create_signed_range - create a new signed ranged property type
2888c2ecf20Sopenharmony_ci * @dev: drm device
2898c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
2908c2ecf20Sopenharmony_ci * @name: name of the property
2918c2ecf20Sopenharmony_ci * @min: minimum value of the property
2928c2ecf20Sopenharmony_ci * @max: maximum value of the property
2938c2ecf20Sopenharmony_ci *
2948c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
2958c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
2968c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
2978c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
2988c2ecf20Sopenharmony_ci *
2998c2ecf20Sopenharmony_ci * Userspace is allowed to set any signed integer value in the (min, max)
3008c2ecf20Sopenharmony_ci * range inclusive.
3018c2ecf20Sopenharmony_ci *
3028c2ecf20Sopenharmony_ci * Returns:
3038c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
3048c2ecf20Sopenharmony_ci */
3058c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3068c2ecf20Sopenharmony_ci						      u32 flags, const char *name,
3078c2ecf20Sopenharmony_ci						      int64_t min, int64_t max)
3088c2ecf20Sopenharmony_ci{
3098c2ecf20Sopenharmony_ci	return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3108c2ecf20Sopenharmony_ci			name, I642U64(min), I642U64(max));
3118c2ecf20Sopenharmony_ci}
3128c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_signed_range);
3138c2ecf20Sopenharmony_ci
3148c2ecf20Sopenharmony_ci/**
3158c2ecf20Sopenharmony_ci * drm_property_create_object - create a new object property type
3168c2ecf20Sopenharmony_ci * @dev: drm device
3178c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
3188c2ecf20Sopenharmony_ci * @name: name of the property
3198c2ecf20Sopenharmony_ci * @type: object type from DRM_MODE_OBJECT_* defines
3208c2ecf20Sopenharmony_ci *
3218c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
3228c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
3238c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
3248c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
3258c2ecf20Sopenharmony_ci *
3268c2ecf20Sopenharmony_ci * Userspace is only allowed to set this to any property value of the given
3278c2ecf20Sopenharmony_ci * @type. Only useful for atomic properties, which is enforced.
3288c2ecf20Sopenharmony_ci *
3298c2ecf20Sopenharmony_ci * Returns:
3308c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
3318c2ecf20Sopenharmony_ci */
3328c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_object(struct drm_device *dev,
3338c2ecf20Sopenharmony_ci						u32 flags, const char *name,
3348c2ecf20Sopenharmony_ci						uint32_t type)
3358c2ecf20Sopenharmony_ci{
3368c2ecf20Sopenharmony_ci	struct drm_property *property;
3378c2ecf20Sopenharmony_ci
3388c2ecf20Sopenharmony_ci	flags |= DRM_MODE_PROP_OBJECT;
3398c2ecf20Sopenharmony_ci
3408c2ecf20Sopenharmony_ci	if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3418c2ecf20Sopenharmony_ci		return NULL;
3428c2ecf20Sopenharmony_ci
3438c2ecf20Sopenharmony_ci	property = drm_property_create(dev, flags, name, 1);
3448c2ecf20Sopenharmony_ci	if (!property)
3458c2ecf20Sopenharmony_ci		return NULL;
3468c2ecf20Sopenharmony_ci
3478c2ecf20Sopenharmony_ci	property->values[0] = type;
3488c2ecf20Sopenharmony_ci
3498c2ecf20Sopenharmony_ci	return property;
3508c2ecf20Sopenharmony_ci}
3518c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_object);
3528c2ecf20Sopenharmony_ci
3538c2ecf20Sopenharmony_ci/**
3548c2ecf20Sopenharmony_ci * drm_property_create_bool - create a new boolean property type
3558c2ecf20Sopenharmony_ci * @dev: drm device
3568c2ecf20Sopenharmony_ci * @flags: flags specifying the property type
3578c2ecf20Sopenharmony_ci * @name: name of the property
3588c2ecf20Sopenharmony_ci *
3598c2ecf20Sopenharmony_ci * This creates a new generic drm property which can then be attached to a drm
3608c2ecf20Sopenharmony_ci * object with drm_object_attach_property(). The returned property object must
3618c2ecf20Sopenharmony_ci * be freed with drm_property_destroy(), which is done automatically when
3628c2ecf20Sopenharmony_ci * calling drm_mode_config_cleanup().
3638c2ecf20Sopenharmony_ci *
3648c2ecf20Sopenharmony_ci * This is implemented as a ranged property with only {0, 1} as valid values.
3658c2ecf20Sopenharmony_ci *
3668c2ecf20Sopenharmony_ci * Returns:
3678c2ecf20Sopenharmony_ci * A pointer to the newly created property on success, NULL on failure.
3688c2ecf20Sopenharmony_ci */
3698c2ecf20Sopenharmony_cistruct drm_property *drm_property_create_bool(struct drm_device *dev,
3708c2ecf20Sopenharmony_ci					      u32 flags, const char *name)
3718c2ecf20Sopenharmony_ci{
3728c2ecf20Sopenharmony_ci	return drm_property_create_range(dev, flags, name, 0, 1);
3738c2ecf20Sopenharmony_ci}
3748c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_bool);
3758c2ecf20Sopenharmony_ci
3768c2ecf20Sopenharmony_ci/**
3778c2ecf20Sopenharmony_ci * drm_property_add_enum - add a possible value to an enumeration property
3788c2ecf20Sopenharmony_ci * @property: enumeration property to change
3798c2ecf20Sopenharmony_ci * @value: value of the new enumeration
3808c2ecf20Sopenharmony_ci * @name: symbolic name of the new enumeration
3818c2ecf20Sopenharmony_ci *
3828c2ecf20Sopenharmony_ci * This functions adds enumerations to a property.
3838c2ecf20Sopenharmony_ci *
3848c2ecf20Sopenharmony_ci * It's use is deprecated, drivers should use one of the more specific helpers
3858c2ecf20Sopenharmony_ci * to directly create the property with all enumerations already attached.
3868c2ecf20Sopenharmony_ci *
3878c2ecf20Sopenharmony_ci * Returns:
3888c2ecf20Sopenharmony_ci * Zero on success, error code on failure.
3898c2ecf20Sopenharmony_ci */
3908c2ecf20Sopenharmony_ciint drm_property_add_enum(struct drm_property *property,
3918c2ecf20Sopenharmony_ci			  uint64_t value, const char *name)
3928c2ecf20Sopenharmony_ci{
3938c2ecf20Sopenharmony_ci	struct drm_property_enum *prop_enum;
3948c2ecf20Sopenharmony_ci	int index = 0;
3958c2ecf20Sopenharmony_ci
3968c2ecf20Sopenharmony_ci	if (WARN_ON(strlen(name) >= DRM_PROP_NAME_LEN))
3978c2ecf20Sopenharmony_ci		return -EINVAL;
3988c2ecf20Sopenharmony_ci
3998c2ecf20Sopenharmony_ci	if (WARN_ON(!drm_property_type_is(property, DRM_MODE_PROP_ENUM) &&
4008c2ecf20Sopenharmony_ci		    !drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4018c2ecf20Sopenharmony_ci		return -EINVAL;
4028c2ecf20Sopenharmony_ci
4038c2ecf20Sopenharmony_ci	/*
4048c2ecf20Sopenharmony_ci	 * Bitmask enum properties have the additional constraint of values
4058c2ecf20Sopenharmony_ci	 * from 0 to 63
4068c2ecf20Sopenharmony_ci	 */
4078c2ecf20Sopenharmony_ci	if (WARN_ON(drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4088c2ecf20Sopenharmony_ci		    value > 63))
4098c2ecf20Sopenharmony_ci		return -EINVAL;
4108c2ecf20Sopenharmony_ci
4118c2ecf20Sopenharmony_ci	list_for_each_entry(prop_enum, &property->enum_list, head) {
4128c2ecf20Sopenharmony_ci		if (WARN_ON(prop_enum->value == value))
4138c2ecf20Sopenharmony_ci			return -EINVAL;
4148c2ecf20Sopenharmony_ci		index++;
4158c2ecf20Sopenharmony_ci	}
4168c2ecf20Sopenharmony_ci
4178c2ecf20Sopenharmony_ci	if (WARN_ON(index >= property->num_values))
4188c2ecf20Sopenharmony_ci		return -EINVAL;
4198c2ecf20Sopenharmony_ci
4208c2ecf20Sopenharmony_ci	prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4218c2ecf20Sopenharmony_ci	if (!prop_enum)
4228c2ecf20Sopenharmony_ci		return -ENOMEM;
4238c2ecf20Sopenharmony_ci
4248c2ecf20Sopenharmony_ci	strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4258c2ecf20Sopenharmony_ci	prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4268c2ecf20Sopenharmony_ci	prop_enum->value = value;
4278c2ecf20Sopenharmony_ci
4288c2ecf20Sopenharmony_ci	property->values[index] = value;
4298c2ecf20Sopenharmony_ci	list_add_tail(&prop_enum->head, &property->enum_list);
4308c2ecf20Sopenharmony_ci	return 0;
4318c2ecf20Sopenharmony_ci}
4328c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_add_enum);
4338c2ecf20Sopenharmony_ci
4348c2ecf20Sopenharmony_ci/**
4358c2ecf20Sopenharmony_ci * drm_property_destroy - destroy a drm property
4368c2ecf20Sopenharmony_ci * @dev: drm device
4378c2ecf20Sopenharmony_ci * @property: property to destry
4388c2ecf20Sopenharmony_ci *
4398c2ecf20Sopenharmony_ci * This function frees a property including any attached resources like
4408c2ecf20Sopenharmony_ci * enumeration values.
4418c2ecf20Sopenharmony_ci */
4428c2ecf20Sopenharmony_civoid drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4438c2ecf20Sopenharmony_ci{
4448c2ecf20Sopenharmony_ci	struct drm_property_enum *prop_enum, *pt;
4458c2ecf20Sopenharmony_ci
4468c2ecf20Sopenharmony_ci	list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4478c2ecf20Sopenharmony_ci		list_del(&prop_enum->head);
4488c2ecf20Sopenharmony_ci		kfree(prop_enum);
4498c2ecf20Sopenharmony_ci	}
4508c2ecf20Sopenharmony_ci
4518c2ecf20Sopenharmony_ci	if (property->num_values)
4528c2ecf20Sopenharmony_ci		kfree(property->values);
4538c2ecf20Sopenharmony_ci	drm_mode_object_unregister(dev, &property->base);
4548c2ecf20Sopenharmony_ci	list_del(&property->head);
4558c2ecf20Sopenharmony_ci	kfree(property);
4568c2ecf20Sopenharmony_ci}
4578c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_destroy);
4588c2ecf20Sopenharmony_ci
4598c2ecf20Sopenharmony_ciint drm_mode_getproperty_ioctl(struct drm_device *dev,
4608c2ecf20Sopenharmony_ci			       void *data, struct drm_file *file_priv)
4618c2ecf20Sopenharmony_ci{
4628c2ecf20Sopenharmony_ci	struct drm_mode_get_property *out_resp = data;
4638c2ecf20Sopenharmony_ci	struct drm_property *property;
4648c2ecf20Sopenharmony_ci	int enum_count = 0;
4658c2ecf20Sopenharmony_ci	int value_count = 0;
4668c2ecf20Sopenharmony_ci	int i, copied;
4678c2ecf20Sopenharmony_ci	struct drm_property_enum *prop_enum;
4688c2ecf20Sopenharmony_ci	struct drm_mode_property_enum __user *enum_ptr;
4698c2ecf20Sopenharmony_ci	uint64_t __user *values_ptr;
4708c2ecf20Sopenharmony_ci
4718c2ecf20Sopenharmony_ci	if (!drm_core_check_feature(dev, DRIVER_MODESET))
4728c2ecf20Sopenharmony_ci		return -EOPNOTSUPP;
4738c2ecf20Sopenharmony_ci
4748c2ecf20Sopenharmony_ci	property = drm_property_find(dev, file_priv, out_resp->prop_id);
4758c2ecf20Sopenharmony_ci	if (!property)
4768c2ecf20Sopenharmony_ci		return -ENOENT;
4778c2ecf20Sopenharmony_ci
4788c2ecf20Sopenharmony_ci	strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4798c2ecf20Sopenharmony_ci	out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4808c2ecf20Sopenharmony_ci	out_resp->flags = property->flags;
4818c2ecf20Sopenharmony_ci
4828c2ecf20Sopenharmony_ci	value_count = property->num_values;
4838c2ecf20Sopenharmony_ci	values_ptr = u64_to_user_ptr(out_resp->values_ptr);
4848c2ecf20Sopenharmony_ci
4858c2ecf20Sopenharmony_ci	for (i = 0; i < value_count; i++) {
4868c2ecf20Sopenharmony_ci		if (i < out_resp->count_values &&
4878c2ecf20Sopenharmony_ci		    put_user(property->values[i], values_ptr + i)) {
4888c2ecf20Sopenharmony_ci			return -EFAULT;
4898c2ecf20Sopenharmony_ci		}
4908c2ecf20Sopenharmony_ci	}
4918c2ecf20Sopenharmony_ci	out_resp->count_values = value_count;
4928c2ecf20Sopenharmony_ci
4938c2ecf20Sopenharmony_ci	copied = 0;
4948c2ecf20Sopenharmony_ci	enum_ptr = u64_to_user_ptr(out_resp->enum_blob_ptr);
4958c2ecf20Sopenharmony_ci
4968c2ecf20Sopenharmony_ci	if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4978c2ecf20Sopenharmony_ci	    drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4988c2ecf20Sopenharmony_ci		list_for_each_entry(prop_enum, &property->enum_list, head) {
4998c2ecf20Sopenharmony_ci			enum_count++;
5008c2ecf20Sopenharmony_ci			if (out_resp->count_enum_blobs < enum_count)
5018c2ecf20Sopenharmony_ci				continue;
5028c2ecf20Sopenharmony_ci
5038c2ecf20Sopenharmony_ci			if (copy_to_user(&enum_ptr[copied].value,
5048c2ecf20Sopenharmony_ci					 &prop_enum->value, sizeof(uint64_t)))
5058c2ecf20Sopenharmony_ci				return -EFAULT;
5068c2ecf20Sopenharmony_ci
5078c2ecf20Sopenharmony_ci			if (copy_to_user(&enum_ptr[copied].name,
5088c2ecf20Sopenharmony_ci					 &prop_enum->name, DRM_PROP_NAME_LEN))
5098c2ecf20Sopenharmony_ci				return -EFAULT;
5108c2ecf20Sopenharmony_ci			copied++;
5118c2ecf20Sopenharmony_ci		}
5128c2ecf20Sopenharmony_ci		out_resp->count_enum_blobs = enum_count;
5138c2ecf20Sopenharmony_ci	}
5148c2ecf20Sopenharmony_ci
5158c2ecf20Sopenharmony_ci	/*
5168c2ecf20Sopenharmony_ci	 * NOTE: The idea seems to have been to use this to read all the blob
5178c2ecf20Sopenharmony_ci	 * property values. But nothing ever added them to the corresponding
5188c2ecf20Sopenharmony_ci	 * list, userspace always used the special-purpose get_blob ioctl to
5198c2ecf20Sopenharmony_ci	 * read the value for a blob property. It also doesn't make a lot of
5208c2ecf20Sopenharmony_ci	 * sense to return values here when everything else is just metadata for
5218c2ecf20Sopenharmony_ci	 * the property itself.
5228c2ecf20Sopenharmony_ci	 */
5238c2ecf20Sopenharmony_ci	if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
5248c2ecf20Sopenharmony_ci		out_resp->count_enum_blobs = 0;
5258c2ecf20Sopenharmony_ci
5268c2ecf20Sopenharmony_ci	return 0;
5278c2ecf20Sopenharmony_ci}
5288c2ecf20Sopenharmony_ci
5298c2ecf20Sopenharmony_cistatic void drm_property_free_blob(struct kref *kref)
5308c2ecf20Sopenharmony_ci{
5318c2ecf20Sopenharmony_ci	struct drm_property_blob *blob =
5328c2ecf20Sopenharmony_ci		container_of(kref, struct drm_property_blob, base.refcount);
5338c2ecf20Sopenharmony_ci
5348c2ecf20Sopenharmony_ci	mutex_lock(&blob->dev->mode_config.blob_lock);
5358c2ecf20Sopenharmony_ci	list_del(&blob->head_global);
5368c2ecf20Sopenharmony_ci	mutex_unlock(&blob->dev->mode_config.blob_lock);
5378c2ecf20Sopenharmony_ci
5388c2ecf20Sopenharmony_ci	drm_mode_object_unregister(blob->dev, &blob->base);
5398c2ecf20Sopenharmony_ci
5408c2ecf20Sopenharmony_ci	kvfree(blob);
5418c2ecf20Sopenharmony_ci}
5428c2ecf20Sopenharmony_ci
5438c2ecf20Sopenharmony_ci/**
5448c2ecf20Sopenharmony_ci * drm_property_create_blob - Create new blob property
5458c2ecf20Sopenharmony_ci * @dev: DRM device to create property for
5468c2ecf20Sopenharmony_ci * @length: Length to allocate for blob data
5478c2ecf20Sopenharmony_ci * @data: If specified, copies data into blob
5488c2ecf20Sopenharmony_ci *
5498c2ecf20Sopenharmony_ci * Creates a new blob property for a specified DRM device, optionally
5508c2ecf20Sopenharmony_ci * copying data. Note that blob properties are meant to be invariant, hence the
5518c2ecf20Sopenharmony_ci * data must be filled out before the blob is used as the value of any property.
5528c2ecf20Sopenharmony_ci *
5538c2ecf20Sopenharmony_ci * Returns:
5548c2ecf20Sopenharmony_ci * New blob property with a single reference on success, or an ERR_PTR
5558c2ecf20Sopenharmony_ci * value on failure.
5568c2ecf20Sopenharmony_ci */
5578c2ecf20Sopenharmony_cistruct drm_property_blob *
5588c2ecf20Sopenharmony_cidrm_property_create_blob(struct drm_device *dev, size_t length,
5598c2ecf20Sopenharmony_ci			 const void *data)
5608c2ecf20Sopenharmony_ci{
5618c2ecf20Sopenharmony_ci	struct drm_property_blob *blob;
5628c2ecf20Sopenharmony_ci	int ret;
5638c2ecf20Sopenharmony_ci
5648c2ecf20Sopenharmony_ci	if (!length || length > INT_MAX - sizeof(struct drm_property_blob))
5658c2ecf20Sopenharmony_ci		return ERR_PTR(-EINVAL);
5668c2ecf20Sopenharmony_ci
5678c2ecf20Sopenharmony_ci	blob = kvzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
5688c2ecf20Sopenharmony_ci	if (!blob)
5698c2ecf20Sopenharmony_ci		return ERR_PTR(-ENOMEM);
5708c2ecf20Sopenharmony_ci
5718c2ecf20Sopenharmony_ci	/* This must be explicitly initialised, so we can safely call list_del
5728c2ecf20Sopenharmony_ci	 * on it in the removal handler, even if it isn't in a file list. */
5738c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&blob->head_file);
5748c2ecf20Sopenharmony_ci	blob->data = (void *)blob + sizeof(*blob);
5758c2ecf20Sopenharmony_ci	blob->length = length;
5768c2ecf20Sopenharmony_ci	blob->dev = dev;
5778c2ecf20Sopenharmony_ci
5788c2ecf20Sopenharmony_ci	if (data)
5798c2ecf20Sopenharmony_ci		memcpy(blob->data, data, length);
5808c2ecf20Sopenharmony_ci
5818c2ecf20Sopenharmony_ci	ret = __drm_mode_object_add(dev, &blob->base, DRM_MODE_OBJECT_BLOB,
5828c2ecf20Sopenharmony_ci				    true, drm_property_free_blob);
5838c2ecf20Sopenharmony_ci	if (ret) {
5848c2ecf20Sopenharmony_ci		kvfree(blob);
5858c2ecf20Sopenharmony_ci		return ERR_PTR(-EINVAL);
5868c2ecf20Sopenharmony_ci	}
5878c2ecf20Sopenharmony_ci
5888c2ecf20Sopenharmony_ci	mutex_lock(&dev->mode_config.blob_lock);
5898c2ecf20Sopenharmony_ci	list_add_tail(&blob->head_global,
5908c2ecf20Sopenharmony_ci	              &dev->mode_config.property_blob_list);
5918c2ecf20Sopenharmony_ci	mutex_unlock(&dev->mode_config.blob_lock);
5928c2ecf20Sopenharmony_ci
5938c2ecf20Sopenharmony_ci	return blob;
5948c2ecf20Sopenharmony_ci}
5958c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_create_blob);
5968c2ecf20Sopenharmony_ci
5978c2ecf20Sopenharmony_ci/**
5988c2ecf20Sopenharmony_ci * drm_property_blob_put - release a blob property reference
5998c2ecf20Sopenharmony_ci * @blob: DRM blob property
6008c2ecf20Sopenharmony_ci *
6018c2ecf20Sopenharmony_ci * Releases a reference to a blob property. May free the object.
6028c2ecf20Sopenharmony_ci */
6038c2ecf20Sopenharmony_civoid drm_property_blob_put(struct drm_property_blob *blob)
6048c2ecf20Sopenharmony_ci{
6058c2ecf20Sopenharmony_ci	if (!blob)
6068c2ecf20Sopenharmony_ci		return;
6078c2ecf20Sopenharmony_ci
6088c2ecf20Sopenharmony_ci	drm_mode_object_put(&blob->base);
6098c2ecf20Sopenharmony_ci}
6108c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_blob_put);
6118c2ecf20Sopenharmony_ci
6128c2ecf20Sopenharmony_civoid drm_property_destroy_user_blobs(struct drm_device *dev,
6138c2ecf20Sopenharmony_ci				     struct drm_file *file_priv)
6148c2ecf20Sopenharmony_ci{
6158c2ecf20Sopenharmony_ci	struct drm_property_blob *blob, *bt;
6168c2ecf20Sopenharmony_ci
6178c2ecf20Sopenharmony_ci	/*
6188c2ecf20Sopenharmony_ci	 * When the file gets released that means no one else can access the
6198c2ecf20Sopenharmony_ci	 * blob list any more, so no need to grab dev->blob_lock.
6208c2ecf20Sopenharmony_ci	 */
6218c2ecf20Sopenharmony_ci	list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
6228c2ecf20Sopenharmony_ci		list_del_init(&blob->head_file);
6238c2ecf20Sopenharmony_ci		drm_property_blob_put(blob);
6248c2ecf20Sopenharmony_ci	}
6258c2ecf20Sopenharmony_ci}
6268c2ecf20Sopenharmony_ci
6278c2ecf20Sopenharmony_ci/**
6288c2ecf20Sopenharmony_ci * drm_property_blob_get - acquire blob property reference
6298c2ecf20Sopenharmony_ci * @blob: DRM blob property
6308c2ecf20Sopenharmony_ci *
6318c2ecf20Sopenharmony_ci * Acquires a reference to an existing blob property. Returns @blob, which
6328c2ecf20Sopenharmony_ci * allows this to be used as a shorthand in assignments.
6338c2ecf20Sopenharmony_ci */
6348c2ecf20Sopenharmony_cistruct drm_property_blob *drm_property_blob_get(struct drm_property_blob *blob)
6358c2ecf20Sopenharmony_ci{
6368c2ecf20Sopenharmony_ci	drm_mode_object_get(&blob->base);
6378c2ecf20Sopenharmony_ci	return blob;
6388c2ecf20Sopenharmony_ci}
6398c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_blob_get);
6408c2ecf20Sopenharmony_ci
6418c2ecf20Sopenharmony_ci/**
6428c2ecf20Sopenharmony_ci * drm_property_lookup_blob - look up a blob property and take a reference
6438c2ecf20Sopenharmony_ci * @dev: drm device
6448c2ecf20Sopenharmony_ci * @id: id of the blob property
6458c2ecf20Sopenharmony_ci *
6468c2ecf20Sopenharmony_ci * If successful, this takes an additional reference to the blob property.
6478c2ecf20Sopenharmony_ci * callers need to make sure to eventually unreference the returned property
6488c2ecf20Sopenharmony_ci * again, using drm_property_blob_put().
6498c2ecf20Sopenharmony_ci *
6508c2ecf20Sopenharmony_ci * Return:
6518c2ecf20Sopenharmony_ci * NULL on failure, pointer to the blob on success.
6528c2ecf20Sopenharmony_ci */
6538c2ecf20Sopenharmony_cistruct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
6548c2ecf20Sopenharmony_ci					           uint32_t id)
6558c2ecf20Sopenharmony_ci{
6568c2ecf20Sopenharmony_ci	struct drm_mode_object *obj;
6578c2ecf20Sopenharmony_ci	struct drm_property_blob *blob = NULL;
6588c2ecf20Sopenharmony_ci
6598c2ecf20Sopenharmony_ci	obj = __drm_mode_object_find(dev, NULL, id, DRM_MODE_OBJECT_BLOB);
6608c2ecf20Sopenharmony_ci	if (obj)
6618c2ecf20Sopenharmony_ci		blob = obj_to_blob(obj);
6628c2ecf20Sopenharmony_ci	return blob;
6638c2ecf20Sopenharmony_ci}
6648c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_lookup_blob);
6658c2ecf20Sopenharmony_ci
6668c2ecf20Sopenharmony_ci/**
6678c2ecf20Sopenharmony_ci * drm_property_replace_global_blob - replace existing blob property
6688c2ecf20Sopenharmony_ci * @dev: drm device
6698c2ecf20Sopenharmony_ci * @replace: location of blob property pointer to be replaced
6708c2ecf20Sopenharmony_ci * @length: length of data for new blob, or 0 for no data
6718c2ecf20Sopenharmony_ci * @data: content for new blob, or NULL for no data
6728c2ecf20Sopenharmony_ci * @obj_holds_id: optional object for property holding blob ID
6738c2ecf20Sopenharmony_ci * @prop_holds_id: optional property holding blob ID
6748c2ecf20Sopenharmony_ci * @return 0 on success or error on failure
6758c2ecf20Sopenharmony_ci *
6768c2ecf20Sopenharmony_ci * This function will replace a global property in the blob list, optionally
6778c2ecf20Sopenharmony_ci * updating a property which holds the ID of that property.
6788c2ecf20Sopenharmony_ci *
6798c2ecf20Sopenharmony_ci * If length is 0 or data is NULL, no new blob will be created, and the holding
6808c2ecf20Sopenharmony_ci * property, if specified, will be set to 0.
6818c2ecf20Sopenharmony_ci *
6828c2ecf20Sopenharmony_ci * Access to the replace pointer is assumed to be protected by the caller, e.g.
6838c2ecf20Sopenharmony_ci * by holding the relevant modesetting object lock for its parent.
6848c2ecf20Sopenharmony_ci *
6858c2ecf20Sopenharmony_ci * For example, a drm_connector has a 'PATH' property, which contains the ID
6868c2ecf20Sopenharmony_ci * of a blob property with the value of the MST path information. Calling this
6878c2ecf20Sopenharmony_ci * function with replace pointing to the connector's path_blob_ptr, length and
6888c2ecf20Sopenharmony_ci * data set for the new path information, obj_holds_id set to the connector's
6898c2ecf20Sopenharmony_ci * base object, and prop_holds_id set to the path property name, will perform
6908c2ecf20Sopenharmony_ci * a completely atomic update. The access to path_blob_ptr is protected by the
6918c2ecf20Sopenharmony_ci * caller holding a lock on the connector.
6928c2ecf20Sopenharmony_ci */
6938c2ecf20Sopenharmony_ciint drm_property_replace_global_blob(struct drm_device *dev,
6948c2ecf20Sopenharmony_ci				     struct drm_property_blob **replace,
6958c2ecf20Sopenharmony_ci				     size_t length,
6968c2ecf20Sopenharmony_ci				     const void *data,
6978c2ecf20Sopenharmony_ci				     struct drm_mode_object *obj_holds_id,
6988c2ecf20Sopenharmony_ci				     struct drm_property *prop_holds_id)
6998c2ecf20Sopenharmony_ci{
7008c2ecf20Sopenharmony_ci	struct drm_property_blob *new_blob = NULL;
7018c2ecf20Sopenharmony_ci	struct drm_property_blob *old_blob = NULL;
7028c2ecf20Sopenharmony_ci	int ret;
7038c2ecf20Sopenharmony_ci
7048c2ecf20Sopenharmony_ci	WARN_ON(replace == NULL);
7058c2ecf20Sopenharmony_ci
7068c2ecf20Sopenharmony_ci	old_blob = *replace;
7078c2ecf20Sopenharmony_ci
7088c2ecf20Sopenharmony_ci	if (length && data) {
7098c2ecf20Sopenharmony_ci		new_blob = drm_property_create_blob(dev, length, data);
7108c2ecf20Sopenharmony_ci		if (IS_ERR(new_blob))
7118c2ecf20Sopenharmony_ci			return PTR_ERR(new_blob);
7128c2ecf20Sopenharmony_ci	}
7138c2ecf20Sopenharmony_ci
7148c2ecf20Sopenharmony_ci	if (obj_holds_id) {
7158c2ecf20Sopenharmony_ci		ret = drm_object_property_set_value(obj_holds_id,
7168c2ecf20Sopenharmony_ci						    prop_holds_id,
7178c2ecf20Sopenharmony_ci						    new_blob ?
7188c2ecf20Sopenharmony_ci						        new_blob->base.id : 0);
7198c2ecf20Sopenharmony_ci		if (ret != 0)
7208c2ecf20Sopenharmony_ci			goto err_created;
7218c2ecf20Sopenharmony_ci	}
7228c2ecf20Sopenharmony_ci
7238c2ecf20Sopenharmony_ci	drm_property_blob_put(old_blob);
7248c2ecf20Sopenharmony_ci	*replace = new_blob;
7258c2ecf20Sopenharmony_ci
7268c2ecf20Sopenharmony_ci	return 0;
7278c2ecf20Sopenharmony_ci
7288c2ecf20Sopenharmony_cierr_created:
7298c2ecf20Sopenharmony_ci	drm_property_blob_put(new_blob);
7308c2ecf20Sopenharmony_ci	return ret;
7318c2ecf20Sopenharmony_ci}
7328c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_replace_global_blob);
7338c2ecf20Sopenharmony_ci
7348c2ecf20Sopenharmony_ci/**
7358c2ecf20Sopenharmony_ci * drm_property_replace_blob - replace a blob property
7368c2ecf20Sopenharmony_ci * @blob: a pointer to the member blob to be replaced
7378c2ecf20Sopenharmony_ci * @new_blob: the new blob to replace with
7388c2ecf20Sopenharmony_ci *
7398c2ecf20Sopenharmony_ci * Return: true if the blob was in fact replaced.
7408c2ecf20Sopenharmony_ci */
7418c2ecf20Sopenharmony_cibool drm_property_replace_blob(struct drm_property_blob **blob,
7428c2ecf20Sopenharmony_ci			       struct drm_property_blob *new_blob)
7438c2ecf20Sopenharmony_ci{
7448c2ecf20Sopenharmony_ci	struct drm_property_blob *old_blob = *blob;
7458c2ecf20Sopenharmony_ci
7468c2ecf20Sopenharmony_ci	if (old_blob == new_blob)
7478c2ecf20Sopenharmony_ci		return false;
7488c2ecf20Sopenharmony_ci
7498c2ecf20Sopenharmony_ci	drm_property_blob_put(old_blob);
7508c2ecf20Sopenharmony_ci	if (new_blob)
7518c2ecf20Sopenharmony_ci		drm_property_blob_get(new_blob);
7528c2ecf20Sopenharmony_ci	*blob = new_blob;
7538c2ecf20Sopenharmony_ci	return true;
7548c2ecf20Sopenharmony_ci}
7558c2ecf20Sopenharmony_ciEXPORT_SYMBOL(drm_property_replace_blob);
7568c2ecf20Sopenharmony_ci
7578c2ecf20Sopenharmony_ciint drm_mode_getblob_ioctl(struct drm_device *dev,
7588c2ecf20Sopenharmony_ci			   void *data, struct drm_file *file_priv)
7598c2ecf20Sopenharmony_ci{
7608c2ecf20Sopenharmony_ci	struct drm_mode_get_blob *out_resp = data;
7618c2ecf20Sopenharmony_ci	struct drm_property_blob *blob;
7628c2ecf20Sopenharmony_ci	int ret = 0;
7638c2ecf20Sopenharmony_ci
7648c2ecf20Sopenharmony_ci	if (!drm_core_check_feature(dev, DRIVER_MODESET))
7658c2ecf20Sopenharmony_ci		return -EOPNOTSUPP;
7668c2ecf20Sopenharmony_ci
7678c2ecf20Sopenharmony_ci	blob = drm_property_lookup_blob(dev, out_resp->blob_id);
7688c2ecf20Sopenharmony_ci	if (!blob)
7698c2ecf20Sopenharmony_ci		return -ENOENT;
7708c2ecf20Sopenharmony_ci
7718c2ecf20Sopenharmony_ci	if (out_resp->length == blob->length) {
7728c2ecf20Sopenharmony_ci		if (copy_to_user(u64_to_user_ptr(out_resp->data),
7738c2ecf20Sopenharmony_ci				 blob->data,
7748c2ecf20Sopenharmony_ci				 blob->length)) {
7758c2ecf20Sopenharmony_ci			ret = -EFAULT;
7768c2ecf20Sopenharmony_ci			goto unref;
7778c2ecf20Sopenharmony_ci		}
7788c2ecf20Sopenharmony_ci	}
7798c2ecf20Sopenharmony_ci	out_resp->length = blob->length;
7808c2ecf20Sopenharmony_ciunref:
7818c2ecf20Sopenharmony_ci	drm_property_blob_put(blob);
7828c2ecf20Sopenharmony_ci
7838c2ecf20Sopenharmony_ci	return ret;
7848c2ecf20Sopenharmony_ci}
7858c2ecf20Sopenharmony_ci
7868c2ecf20Sopenharmony_ciint drm_mode_createblob_ioctl(struct drm_device *dev,
7878c2ecf20Sopenharmony_ci			      void *data, struct drm_file *file_priv)
7888c2ecf20Sopenharmony_ci{
7898c2ecf20Sopenharmony_ci	struct drm_mode_create_blob *out_resp = data;
7908c2ecf20Sopenharmony_ci	struct drm_property_blob *blob;
7918c2ecf20Sopenharmony_ci	int ret = 0;
7928c2ecf20Sopenharmony_ci
7938c2ecf20Sopenharmony_ci	if (!drm_core_check_feature(dev, DRIVER_MODESET))
7948c2ecf20Sopenharmony_ci		return -EOPNOTSUPP;
7958c2ecf20Sopenharmony_ci
7968c2ecf20Sopenharmony_ci	blob = drm_property_create_blob(dev, out_resp->length, NULL);
7978c2ecf20Sopenharmony_ci	if (IS_ERR(blob))
7988c2ecf20Sopenharmony_ci		return PTR_ERR(blob);
7998c2ecf20Sopenharmony_ci
8008c2ecf20Sopenharmony_ci	if (copy_from_user(blob->data,
8018c2ecf20Sopenharmony_ci			   u64_to_user_ptr(out_resp->data),
8028c2ecf20Sopenharmony_ci			   out_resp->length)) {
8038c2ecf20Sopenharmony_ci		ret = -EFAULT;
8048c2ecf20Sopenharmony_ci		goto out_blob;
8058c2ecf20Sopenharmony_ci	}
8068c2ecf20Sopenharmony_ci
8078c2ecf20Sopenharmony_ci	/* Dropping the lock between create_blob and our access here is safe
8088c2ecf20Sopenharmony_ci	 * as only the same file_priv can remove the blob; at this point, it is
8098c2ecf20Sopenharmony_ci	 * not associated with any file_priv. */
8108c2ecf20Sopenharmony_ci	mutex_lock(&dev->mode_config.blob_lock);
8118c2ecf20Sopenharmony_ci	out_resp->blob_id = blob->base.id;
8128c2ecf20Sopenharmony_ci	list_add_tail(&blob->head_file, &file_priv->blobs);
8138c2ecf20Sopenharmony_ci	mutex_unlock(&dev->mode_config.blob_lock);
8148c2ecf20Sopenharmony_ci
8158c2ecf20Sopenharmony_ci	return 0;
8168c2ecf20Sopenharmony_ci
8178c2ecf20Sopenharmony_ciout_blob:
8188c2ecf20Sopenharmony_ci	drm_property_blob_put(blob);
8198c2ecf20Sopenharmony_ci	return ret;
8208c2ecf20Sopenharmony_ci}
8218c2ecf20Sopenharmony_ci
8228c2ecf20Sopenharmony_ciint drm_mode_destroyblob_ioctl(struct drm_device *dev,
8238c2ecf20Sopenharmony_ci			       void *data, struct drm_file *file_priv)
8248c2ecf20Sopenharmony_ci{
8258c2ecf20Sopenharmony_ci	struct drm_mode_destroy_blob *out_resp = data;
8268c2ecf20Sopenharmony_ci	struct drm_property_blob *blob = NULL, *bt;
8278c2ecf20Sopenharmony_ci	bool found = false;
8288c2ecf20Sopenharmony_ci	int ret = 0;
8298c2ecf20Sopenharmony_ci
8308c2ecf20Sopenharmony_ci	if (!drm_core_check_feature(dev, DRIVER_MODESET))
8318c2ecf20Sopenharmony_ci		return -EOPNOTSUPP;
8328c2ecf20Sopenharmony_ci
8338c2ecf20Sopenharmony_ci	blob = drm_property_lookup_blob(dev, out_resp->blob_id);
8348c2ecf20Sopenharmony_ci	if (!blob)
8358c2ecf20Sopenharmony_ci		return -ENOENT;
8368c2ecf20Sopenharmony_ci
8378c2ecf20Sopenharmony_ci	mutex_lock(&dev->mode_config.blob_lock);
8388c2ecf20Sopenharmony_ci	/* Ensure the property was actually created by this user. */
8398c2ecf20Sopenharmony_ci	list_for_each_entry(bt, &file_priv->blobs, head_file) {
8408c2ecf20Sopenharmony_ci		if (bt == blob) {
8418c2ecf20Sopenharmony_ci			found = true;
8428c2ecf20Sopenharmony_ci			break;
8438c2ecf20Sopenharmony_ci		}
8448c2ecf20Sopenharmony_ci	}
8458c2ecf20Sopenharmony_ci
8468c2ecf20Sopenharmony_ci	if (!found) {
8478c2ecf20Sopenharmony_ci		ret = -EPERM;
8488c2ecf20Sopenharmony_ci		goto err;
8498c2ecf20Sopenharmony_ci	}
8508c2ecf20Sopenharmony_ci
8518c2ecf20Sopenharmony_ci	/* We must drop head_file here, because we may not be the last
8528c2ecf20Sopenharmony_ci	 * reference on the blob. */
8538c2ecf20Sopenharmony_ci	list_del_init(&blob->head_file);
8548c2ecf20Sopenharmony_ci	mutex_unlock(&dev->mode_config.blob_lock);
8558c2ecf20Sopenharmony_ci
8568c2ecf20Sopenharmony_ci	/* One reference from lookup, and one from the filp. */
8578c2ecf20Sopenharmony_ci	drm_property_blob_put(blob);
8588c2ecf20Sopenharmony_ci	drm_property_blob_put(blob);
8598c2ecf20Sopenharmony_ci
8608c2ecf20Sopenharmony_ci	return 0;
8618c2ecf20Sopenharmony_ci
8628c2ecf20Sopenharmony_cierr:
8638c2ecf20Sopenharmony_ci	mutex_unlock(&dev->mode_config.blob_lock);
8648c2ecf20Sopenharmony_ci	drm_property_blob_put(blob);
8658c2ecf20Sopenharmony_ci
8668c2ecf20Sopenharmony_ci	return ret;
8678c2ecf20Sopenharmony_ci}
8688c2ecf20Sopenharmony_ci
8698c2ecf20Sopenharmony_ci/* Some properties could refer to dynamic refcnt'd objects, or things that
8708c2ecf20Sopenharmony_ci * need special locking to handle lifetime issues (ie. to ensure the prop
8718c2ecf20Sopenharmony_ci * value doesn't become invalid part way through the property update due to
8728c2ecf20Sopenharmony_ci * race).  The value returned by reference via 'obj' should be passed back
8738c2ecf20Sopenharmony_ci * to drm_property_change_valid_put() after the property is set (and the
8748c2ecf20Sopenharmony_ci * object to which the property is attached has a chance to take its own
8758c2ecf20Sopenharmony_ci * reference).
8768c2ecf20Sopenharmony_ci */
8778c2ecf20Sopenharmony_cibool drm_property_change_valid_get(struct drm_property *property,
8788c2ecf20Sopenharmony_ci				   uint64_t value, struct drm_mode_object **ref)
8798c2ecf20Sopenharmony_ci{
8808c2ecf20Sopenharmony_ci	int i;
8818c2ecf20Sopenharmony_ci
8828c2ecf20Sopenharmony_ci	if (property->flags & DRM_MODE_PROP_IMMUTABLE)
8838c2ecf20Sopenharmony_ci		return false;
8848c2ecf20Sopenharmony_ci
8858c2ecf20Sopenharmony_ci	*ref = NULL;
8868c2ecf20Sopenharmony_ci
8878c2ecf20Sopenharmony_ci	if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
8888c2ecf20Sopenharmony_ci		if (value < property->values[0] || value > property->values[1])
8898c2ecf20Sopenharmony_ci			return false;
8908c2ecf20Sopenharmony_ci		return true;
8918c2ecf20Sopenharmony_ci	} else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
8928c2ecf20Sopenharmony_ci		int64_t svalue = U642I64(value);
8938c2ecf20Sopenharmony_ci
8948c2ecf20Sopenharmony_ci		if (svalue < U642I64(property->values[0]) ||
8958c2ecf20Sopenharmony_ci				svalue > U642I64(property->values[1]))
8968c2ecf20Sopenharmony_ci			return false;
8978c2ecf20Sopenharmony_ci		return true;
8988c2ecf20Sopenharmony_ci	} else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
8998c2ecf20Sopenharmony_ci		uint64_t valid_mask = 0;
9008c2ecf20Sopenharmony_ci
9018c2ecf20Sopenharmony_ci		for (i = 0; i < property->num_values; i++)
9028c2ecf20Sopenharmony_ci			valid_mask |= (1ULL << property->values[i]);
9038c2ecf20Sopenharmony_ci		return !(value & ~valid_mask);
9048c2ecf20Sopenharmony_ci	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
9058c2ecf20Sopenharmony_ci		struct drm_property_blob *blob;
9068c2ecf20Sopenharmony_ci
9078c2ecf20Sopenharmony_ci		if (value == 0)
9088c2ecf20Sopenharmony_ci			return true;
9098c2ecf20Sopenharmony_ci
9108c2ecf20Sopenharmony_ci		blob = drm_property_lookup_blob(property->dev, value);
9118c2ecf20Sopenharmony_ci		if (blob) {
9128c2ecf20Sopenharmony_ci			*ref = &blob->base;
9138c2ecf20Sopenharmony_ci			return true;
9148c2ecf20Sopenharmony_ci		} else {
9158c2ecf20Sopenharmony_ci			return false;
9168c2ecf20Sopenharmony_ci		}
9178c2ecf20Sopenharmony_ci	} else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
9188c2ecf20Sopenharmony_ci		/* a zero value for an object property translates to null: */
9198c2ecf20Sopenharmony_ci		if (value == 0)
9208c2ecf20Sopenharmony_ci			return true;
9218c2ecf20Sopenharmony_ci
9228c2ecf20Sopenharmony_ci		*ref = __drm_mode_object_find(property->dev, NULL, value,
9238c2ecf20Sopenharmony_ci					      property->values[0]);
9248c2ecf20Sopenharmony_ci		return *ref != NULL;
9258c2ecf20Sopenharmony_ci	}
9268c2ecf20Sopenharmony_ci
9278c2ecf20Sopenharmony_ci	for (i = 0; i < property->num_values; i++)
9288c2ecf20Sopenharmony_ci		if (property->values[i] == value)
9298c2ecf20Sopenharmony_ci			return true;
9308c2ecf20Sopenharmony_ci	return false;
9318c2ecf20Sopenharmony_ci}
9328c2ecf20Sopenharmony_ci
9338c2ecf20Sopenharmony_civoid drm_property_change_valid_put(struct drm_property *property,
9348c2ecf20Sopenharmony_ci		struct drm_mode_object *ref)
9358c2ecf20Sopenharmony_ci{
9368c2ecf20Sopenharmony_ci	if (!ref)
9378c2ecf20Sopenharmony_ci		return;
9388c2ecf20Sopenharmony_ci
9398c2ecf20Sopenharmony_ci	if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
9408c2ecf20Sopenharmony_ci		drm_mode_object_put(ref);
9418c2ecf20Sopenharmony_ci	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
9428c2ecf20Sopenharmony_ci		drm_property_blob_put(obj_to_blob(ref));
9438c2ecf20Sopenharmony_ci}
944