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 815ebbb5b4SVille Syrjälä if (WARN_ON(strlen(name) >= DRM_PROP_NAME_LEN)) 825ebbb5b4SVille Syrjälä return NULL; 835ebbb5b4SVille Syrjälä 8459e71ee7SDaniel Vetter property = kzalloc(sizeof(struct drm_property), GFP_KERNEL); 8559e71ee7SDaniel Vetter if (!property) 8659e71ee7SDaniel Vetter return NULL; 8759e71ee7SDaniel Vetter 8859e71ee7SDaniel Vetter property->dev = dev; 8959e71ee7SDaniel Vetter 9059e71ee7SDaniel Vetter if (num_values) { 9159e71ee7SDaniel Vetter property->values = kcalloc(num_values, sizeof(uint64_t), 9259e71ee7SDaniel Vetter GFP_KERNEL); 9359e71ee7SDaniel Vetter if (!property->values) 9459e71ee7SDaniel Vetter goto fail; 9559e71ee7SDaniel Vetter } 9659e71ee7SDaniel Vetter 972135ea7aSThierry Reding ret = drm_mode_object_add(dev, &property->base, DRM_MODE_OBJECT_PROPERTY); 9859e71ee7SDaniel Vetter if (ret) 9959e71ee7SDaniel Vetter goto fail; 10059e71ee7SDaniel Vetter 10159e71ee7SDaniel Vetter property->flags = flags; 10259e71ee7SDaniel Vetter property->num_values = num_values; 10359e71ee7SDaniel Vetter INIT_LIST_HEAD(&property->enum_list); 10459e71ee7SDaniel Vetter 10559e71ee7SDaniel Vetter strncpy(property->name, name, DRM_PROP_NAME_LEN); 10659e71ee7SDaniel Vetter property->name[DRM_PROP_NAME_LEN-1] = '\0'; 10759e71ee7SDaniel Vetter 10859e71ee7SDaniel Vetter list_add_tail(&property->head, &dev->mode_config.property_list); 10959e71ee7SDaniel Vetter 11059e71ee7SDaniel Vetter WARN_ON(!drm_property_type_valid(property)); 11159e71ee7SDaniel Vetter 11259e71ee7SDaniel Vetter return property; 11359e71ee7SDaniel Vetter fail: 11459e71ee7SDaniel Vetter kfree(property->values); 11559e71ee7SDaniel Vetter kfree(property); 11659e71ee7SDaniel Vetter return NULL; 11759e71ee7SDaniel Vetter } 11859e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create); 11959e71ee7SDaniel Vetter 12059e71ee7SDaniel Vetter /** 12159e71ee7SDaniel Vetter * drm_property_create_enum - create a new enumeration property type 12259e71ee7SDaniel Vetter * @dev: drm device 12359e71ee7SDaniel Vetter * @flags: flags specifying the property type 12459e71ee7SDaniel Vetter * @name: name of the property 12559e71ee7SDaniel Vetter * @props: enumeration lists with property values 12659e71ee7SDaniel Vetter * @num_values: number of pre-defined values 12759e71ee7SDaniel Vetter * 12859e71ee7SDaniel Vetter * This creates a new generic drm property which can then be attached to a drm 1296a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 1306a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 1316a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 13259e71ee7SDaniel Vetter * 13359e71ee7SDaniel Vetter * Userspace is only allowed to set one of the predefined values for enumeration 13459e71ee7SDaniel Vetter * properties. 13559e71ee7SDaniel Vetter * 13659e71ee7SDaniel Vetter * Returns: 13759e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 13859e71ee7SDaniel Vetter */ 13959e71ee7SDaniel Vetter struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags, 14059e71ee7SDaniel Vetter const char *name, 14159e71ee7SDaniel Vetter const struct drm_prop_enum_list *props, 14259e71ee7SDaniel Vetter int num_values) 14359e71ee7SDaniel Vetter { 14459e71ee7SDaniel Vetter struct drm_property *property; 14559e71ee7SDaniel Vetter int i, ret; 14659e71ee7SDaniel Vetter 14759e71ee7SDaniel Vetter flags |= DRM_MODE_PROP_ENUM; 14859e71ee7SDaniel Vetter 14959e71ee7SDaniel Vetter property = drm_property_create(dev, flags, name, num_values); 15059e71ee7SDaniel Vetter if (!property) 15159e71ee7SDaniel Vetter return NULL; 15259e71ee7SDaniel Vetter 15359e71ee7SDaniel Vetter for (i = 0; i < num_values; i++) { 15459e71ee7SDaniel Vetter ret = drm_property_add_enum(property, i, 15559e71ee7SDaniel Vetter props[i].type, 15659e71ee7SDaniel Vetter props[i].name); 15759e71ee7SDaniel Vetter if (ret) { 15859e71ee7SDaniel Vetter drm_property_destroy(dev, property); 15959e71ee7SDaniel Vetter return NULL; 16059e71ee7SDaniel Vetter } 16159e71ee7SDaniel Vetter } 16259e71ee7SDaniel Vetter 16359e71ee7SDaniel Vetter return property; 16459e71ee7SDaniel Vetter } 16559e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_enum); 16659e71ee7SDaniel Vetter 16759e71ee7SDaniel Vetter /** 16859e71ee7SDaniel Vetter * drm_property_create_bitmask - create a new bitmask property type 16959e71ee7SDaniel Vetter * @dev: drm device 17059e71ee7SDaniel Vetter * @flags: flags specifying the property type 17159e71ee7SDaniel Vetter * @name: name of the property 17259e71ee7SDaniel Vetter * @props: enumeration lists with property bitflags 17359e71ee7SDaniel Vetter * @num_props: size of the @props array 17459e71ee7SDaniel Vetter * @supported_bits: bitmask of all supported enumeration values 17559e71ee7SDaniel Vetter * 17659e71ee7SDaniel Vetter * This creates a new bitmask drm property which can then be attached to a drm 1776a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 1786a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 1796a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 18059e71ee7SDaniel Vetter * 18159e71ee7SDaniel Vetter * Compared to plain enumeration properties userspace is allowed to set any 18259e71ee7SDaniel Vetter * or'ed together combination of the predefined property bitflag values 18359e71ee7SDaniel Vetter * 18459e71ee7SDaniel Vetter * Returns: 18559e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 18659e71ee7SDaniel Vetter */ 18759e71ee7SDaniel Vetter struct drm_property *drm_property_create_bitmask(struct drm_device *dev, 18859e71ee7SDaniel Vetter int flags, const char *name, 18959e71ee7SDaniel Vetter const struct drm_prop_enum_list *props, 19059e71ee7SDaniel Vetter int num_props, 19159e71ee7SDaniel Vetter uint64_t supported_bits) 19259e71ee7SDaniel Vetter { 19359e71ee7SDaniel Vetter struct drm_property *property; 19459e71ee7SDaniel Vetter int i, ret, index = 0; 19559e71ee7SDaniel Vetter int num_values = hweight64(supported_bits); 19659e71ee7SDaniel Vetter 19759e71ee7SDaniel Vetter flags |= DRM_MODE_PROP_BITMASK; 19859e71ee7SDaniel Vetter 19959e71ee7SDaniel Vetter property = drm_property_create(dev, flags, name, num_values); 20059e71ee7SDaniel Vetter if (!property) 20159e71ee7SDaniel Vetter return NULL; 20259e71ee7SDaniel Vetter for (i = 0; i < num_props; i++) { 20359e71ee7SDaniel Vetter if (!(supported_bits & (1ULL << props[i].type))) 20459e71ee7SDaniel Vetter continue; 20559e71ee7SDaniel Vetter 20659e71ee7SDaniel Vetter if (WARN_ON(index >= num_values)) { 20759e71ee7SDaniel Vetter drm_property_destroy(dev, property); 20859e71ee7SDaniel Vetter return NULL; 20959e71ee7SDaniel Vetter } 21059e71ee7SDaniel Vetter 21159e71ee7SDaniel Vetter ret = drm_property_add_enum(property, index++, 21259e71ee7SDaniel Vetter props[i].type, 21359e71ee7SDaniel Vetter props[i].name); 21459e71ee7SDaniel Vetter if (ret) { 21559e71ee7SDaniel Vetter drm_property_destroy(dev, property); 21659e71ee7SDaniel Vetter return NULL; 21759e71ee7SDaniel Vetter } 21859e71ee7SDaniel Vetter } 21959e71ee7SDaniel Vetter 22059e71ee7SDaniel Vetter return property; 22159e71ee7SDaniel Vetter } 22259e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_bitmask); 22359e71ee7SDaniel Vetter 22459e71ee7SDaniel Vetter static struct drm_property *property_create_range(struct drm_device *dev, 22559e71ee7SDaniel Vetter int flags, const char *name, 22659e71ee7SDaniel Vetter uint64_t min, uint64_t max) 22759e71ee7SDaniel Vetter { 22859e71ee7SDaniel Vetter struct drm_property *property; 22959e71ee7SDaniel Vetter 23059e71ee7SDaniel Vetter property = drm_property_create(dev, flags, name, 2); 23159e71ee7SDaniel Vetter if (!property) 23259e71ee7SDaniel Vetter return NULL; 23359e71ee7SDaniel Vetter 23459e71ee7SDaniel Vetter property->values[0] = min; 23559e71ee7SDaniel Vetter property->values[1] = max; 23659e71ee7SDaniel Vetter 23759e71ee7SDaniel Vetter return property; 23859e71ee7SDaniel Vetter } 23959e71ee7SDaniel Vetter 24059e71ee7SDaniel Vetter /** 24159e71ee7SDaniel Vetter * drm_property_create_range - create a new unsigned ranged property type 24259e71ee7SDaniel Vetter * @dev: drm device 24359e71ee7SDaniel Vetter * @flags: flags specifying the property type 24459e71ee7SDaniel Vetter * @name: name of the property 24559e71ee7SDaniel Vetter * @min: minimum value of the property 24659e71ee7SDaniel Vetter * @max: maximum value of the property 24759e71ee7SDaniel Vetter * 24859e71ee7SDaniel Vetter * This creates a new generic drm property which can then be attached to a drm 2496a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 2506a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 2516a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 25259e71ee7SDaniel Vetter * 25359e71ee7SDaniel Vetter * Userspace is allowed to set any unsigned integer value in the (min, max) 25459e71ee7SDaniel Vetter * range inclusive. 25559e71ee7SDaniel Vetter * 25659e71ee7SDaniel Vetter * Returns: 25759e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 25859e71ee7SDaniel Vetter */ 25959e71ee7SDaniel Vetter struct drm_property *drm_property_create_range(struct drm_device *dev, int flags, 26059e71ee7SDaniel Vetter const char *name, 26159e71ee7SDaniel Vetter uint64_t min, uint64_t max) 26259e71ee7SDaniel Vetter { 26359e71ee7SDaniel Vetter return property_create_range(dev, DRM_MODE_PROP_RANGE | flags, 26459e71ee7SDaniel Vetter name, min, max); 26559e71ee7SDaniel Vetter } 26659e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_range); 26759e71ee7SDaniel Vetter 26859e71ee7SDaniel Vetter /** 26959e71ee7SDaniel Vetter * drm_property_create_signed_range - create a new signed ranged property type 27059e71ee7SDaniel Vetter * @dev: drm device 27159e71ee7SDaniel Vetter * @flags: flags specifying the property type 27259e71ee7SDaniel Vetter * @name: name of the property 27359e71ee7SDaniel Vetter * @min: minimum value of the property 27459e71ee7SDaniel Vetter * @max: maximum value of the property 27559e71ee7SDaniel Vetter * 27659e71ee7SDaniel Vetter * This creates a new generic drm property which can then be attached to a drm 2776a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 2786a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 2796a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 28059e71ee7SDaniel Vetter * 28159e71ee7SDaniel Vetter * Userspace is allowed to set any signed integer value in the (min, max) 28259e71ee7SDaniel Vetter * range inclusive. 28359e71ee7SDaniel Vetter * 28459e71ee7SDaniel Vetter * Returns: 28559e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 28659e71ee7SDaniel Vetter */ 28759e71ee7SDaniel Vetter struct drm_property *drm_property_create_signed_range(struct drm_device *dev, 28859e71ee7SDaniel Vetter int flags, const char *name, 28959e71ee7SDaniel Vetter int64_t min, int64_t max) 29059e71ee7SDaniel Vetter { 29159e71ee7SDaniel Vetter return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags, 29259e71ee7SDaniel Vetter name, I642U64(min), I642U64(max)); 29359e71ee7SDaniel Vetter } 29459e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_signed_range); 29559e71ee7SDaniel Vetter 29659e71ee7SDaniel Vetter /** 29759e71ee7SDaniel Vetter * drm_property_create_object - create a new object property type 29859e71ee7SDaniel Vetter * @dev: drm device 29959e71ee7SDaniel Vetter * @flags: flags specifying the property type 30059e71ee7SDaniel Vetter * @name: name of the property 30159e71ee7SDaniel Vetter * @type: object type from DRM_MODE_OBJECT_* defines 30259e71ee7SDaniel Vetter * 30359e71ee7SDaniel Vetter * This creates a new generic drm property which can then be attached to a drm 3046a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 3056a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 3066a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 30759e71ee7SDaniel Vetter * 30859e71ee7SDaniel Vetter * Userspace is only allowed to set this to any property value of the given 30959e71ee7SDaniel Vetter * @type. Only useful for atomic properties, which is enforced. 31059e71ee7SDaniel Vetter * 31159e71ee7SDaniel Vetter * Returns: 31259e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 31359e71ee7SDaniel Vetter */ 31459e71ee7SDaniel Vetter struct drm_property *drm_property_create_object(struct drm_device *dev, 315c8458c7eSDaniel Vetter int flags, const char *name, 316c8458c7eSDaniel Vetter uint32_t type) 31759e71ee7SDaniel Vetter { 31859e71ee7SDaniel Vetter struct drm_property *property; 31959e71ee7SDaniel Vetter 32059e71ee7SDaniel Vetter flags |= DRM_MODE_PROP_OBJECT; 32159e71ee7SDaniel Vetter 32259e71ee7SDaniel Vetter if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC))) 32359e71ee7SDaniel Vetter return NULL; 32459e71ee7SDaniel Vetter 32559e71ee7SDaniel Vetter property = drm_property_create(dev, flags, name, 1); 32659e71ee7SDaniel Vetter if (!property) 32759e71ee7SDaniel Vetter return NULL; 32859e71ee7SDaniel Vetter 32959e71ee7SDaniel Vetter property->values[0] = type; 33059e71ee7SDaniel Vetter 33159e71ee7SDaniel Vetter return property; 33259e71ee7SDaniel Vetter } 33359e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_object); 33459e71ee7SDaniel Vetter 33559e71ee7SDaniel Vetter /** 33659e71ee7SDaniel Vetter * drm_property_create_bool - create a new boolean property type 33759e71ee7SDaniel Vetter * @dev: drm device 33859e71ee7SDaniel Vetter * @flags: flags specifying the property type 33959e71ee7SDaniel Vetter * @name: name of the property 34059e71ee7SDaniel Vetter * 34159e71ee7SDaniel Vetter * This creates a new generic drm property which can then be attached to a drm 3426a8a66edSDaniel Vetter * object with drm_object_attach_property(). The returned property object must 3436a8a66edSDaniel Vetter * be freed with drm_property_destroy(), which is done automatically when 3446a8a66edSDaniel Vetter * calling drm_mode_config_cleanup(). 34559e71ee7SDaniel Vetter * 34659e71ee7SDaniel Vetter * This is implemented as a ranged property with only {0, 1} as valid values. 34759e71ee7SDaniel Vetter * 34859e71ee7SDaniel Vetter * Returns: 34959e71ee7SDaniel Vetter * A pointer to the newly created property on success, NULL on failure. 35059e71ee7SDaniel Vetter */ 35159e71ee7SDaniel Vetter struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags, 35259e71ee7SDaniel Vetter const char *name) 35359e71ee7SDaniel Vetter { 35459e71ee7SDaniel Vetter return drm_property_create_range(dev, flags, name, 0, 1); 35559e71ee7SDaniel Vetter } 35659e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_bool); 35759e71ee7SDaniel Vetter 35859e71ee7SDaniel Vetter /** 35959e71ee7SDaniel Vetter * drm_property_add_enum - add a possible value to an enumeration property 36059e71ee7SDaniel Vetter * @property: enumeration property to change 36159e71ee7SDaniel Vetter * @index: index of the new enumeration 36259e71ee7SDaniel Vetter * @value: value of the new enumeration 36359e71ee7SDaniel Vetter * @name: symbolic name of the new enumeration 36459e71ee7SDaniel Vetter * 36559e71ee7SDaniel Vetter * This functions adds enumerations to a property. 36659e71ee7SDaniel Vetter * 36759e71ee7SDaniel Vetter * It's use is deprecated, drivers should use one of the more specific helpers 36859e71ee7SDaniel Vetter * to directly create the property with all enumerations already attached. 36959e71ee7SDaniel Vetter * 37059e71ee7SDaniel Vetter * Returns: 37159e71ee7SDaniel Vetter * Zero on success, error code on failure. 37259e71ee7SDaniel Vetter */ 37359e71ee7SDaniel Vetter int drm_property_add_enum(struct drm_property *property, int index, 37459e71ee7SDaniel Vetter uint64_t value, const char *name) 37559e71ee7SDaniel Vetter { 37659e71ee7SDaniel Vetter struct drm_property_enum *prop_enum; 37759e71ee7SDaniel Vetter 3785ebbb5b4SVille Syrjälä if (WARN_ON(strlen(name) >= DRM_PROP_NAME_LEN)) 3795ebbb5b4SVille Syrjälä return -EINVAL; 3805ebbb5b4SVille Syrjälä 38159e71ee7SDaniel Vetter if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) || 38259e71ee7SDaniel Vetter drm_property_type_is(property, DRM_MODE_PROP_BITMASK))) 38359e71ee7SDaniel Vetter return -EINVAL; 38459e71ee7SDaniel Vetter 38559e71ee7SDaniel Vetter /* 38659e71ee7SDaniel Vetter * Bitmask enum properties have the additional constraint of values 38759e71ee7SDaniel Vetter * from 0 to 63 38859e71ee7SDaniel Vetter */ 38959e71ee7SDaniel Vetter if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) && 39059e71ee7SDaniel Vetter (value > 63)) 39159e71ee7SDaniel Vetter return -EINVAL; 39259e71ee7SDaniel Vetter 39359e71ee7SDaniel Vetter if (!list_empty(&property->enum_list)) { 39459e71ee7SDaniel Vetter list_for_each_entry(prop_enum, &property->enum_list, head) { 39559e71ee7SDaniel Vetter if (prop_enum->value == value) { 39659e71ee7SDaniel Vetter strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN); 39759e71ee7SDaniel Vetter prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0'; 39859e71ee7SDaniel Vetter return 0; 39959e71ee7SDaniel Vetter } 40059e71ee7SDaniel Vetter } 40159e71ee7SDaniel Vetter } 40259e71ee7SDaniel Vetter 40359e71ee7SDaniel Vetter prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL); 40459e71ee7SDaniel Vetter if (!prop_enum) 40559e71ee7SDaniel Vetter return -ENOMEM; 40659e71ee7SDaniel Vetter 40759e71ee7SDaniel Vetter strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN); 40859e71ee7SDaniel Vetter prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0'; 40959e71ee7SDaniel Vetter prop_enum->value = value; 41059e71ee7SDaniel Vetter 41159e71ee7SDaniel Vetter property->values[index] = value; 41259e71ee7SDaniel Vetter list_add_tail(&prop_enum->head, &property->enum_list); 41359e71ee7SDaniel Vetter return 0; 41459e71ee7SDaniel Vetter } 41559e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_add_enum); 41659e71ee7SDaniel Vetter 41759e71ee7SDaniel Vetter /** 41859e71ee7SDaniel Vetter * drm_property_destroy - destroy a drm property 41959e71ee7SDaniel Vetter * @dev: drm device 42059e71ee7SDaniel Vetter * @property: property to destry 42159e71ee7SDaniel Vetter * 42259e71ee7SDaniel Vetter * This function frees a property including any attached resources like 42359e71ee7SDaniel Vetter * enumeration values. 42459e71ee7SDaniel Vetter */ 42559e71ee7SDaniel Vetter void drm_property_destroy(struct drm_device *dev, struct drm_property *property) 42659e71ee7SDaniel Vetter { 42759e71ee7SDaniel Vetter struct drm_property_enum *prop_enum, *pt; 42859e71ee7SDaniel Vetter 42959e71ee7SDaniel Vetter list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) { 43059e71ee7SDaniel Vetter list_del(&prop_enum->head); 43159e71ee7SDaniel Vetter kfree(prop_enum); 43259e71ee7SDaniel Vetter } 43359e71ee7SDaniel Vetter 43459e71ee7SDaniel Vetter if (property->num_values) 43559e71ee7SDaniel Vetter kfree(property->values); 43659e71ee7SDaniel Vetter drm_mode_object_unregister(dev, &property->base); 43759e71ee7SDaniel Vetter list_del(&property->head); 43859e71ee7SDaniel Vetter kfree(property); 43959e71ee7SDaniel Vetter } 44059e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_destroy); 44159e71ee7SDaniel Vetter 44259e71ee7SDaniel Vetter int drm_mode_getproperty_ioctl(struct drm_device *dev, 44359e71ee7SDaniel Vetter void *data, struct drm_file *file_priv) 44459e71ee7SDaniel Vetter { 44559e71ee7SDaniel Vetter struct drm_mode_get_property *out_resp = data; 44659e71ee7SDaniel Vetter struct drm_property *property; 44759e71ee7SDaniel Vetter int enum_count = 0; 44859e71ee7SDaniel Vetter int value_count = 0; 449eb8eb02eSDaniel Vetter int i, copied; 45059e71ee7SDaniel Vetter struct drm_property_enum *prop_enum; 45159e71ee7SDaniel Vetter struct drm_mode_property_enum __user *enum_ptr; 45259e71ee7SDaniel Vetter uint64_t __user *values_ptr; 45359e71ee7SDaniel Vetter 45459e71ee7SDaniel Vetter if (!drm_core_check_feature(dev, DRIVER_MODESET)) 45559e71ee7SDaniel Vetter return -EINVAL; 45659e71ee7SDaniel Vetter 457418da172SKeith Packard property = drm_property_find(dev, file_priv, out_resp->prop_id); 458eb8eb02eSDaniel Vetter if (!property) 459eb8eb02eSDaniel Vetter return -ENOENT; 46059e71ee7SDaniel Vetter 46159e71ee7SDaniel Vetter strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN); 46259e71ee7SDaniel Vetter out_resp->name[DRM_PROP_NAME_LEN-1] = 0; 46359e71ee7SDaniel Vetter out_resp->flags = property->flags; 46459e71ee7SDaniel Vetter 465eb8eb02eSDaniel Vetter value_count = property->num_values; 466eb8eb02eSDaniel Vetter values_ptr = u64_to_user_ptr(out_resp->values_ptr); 467eb8eb02eSDaniel Vetter 46859e71ee7SDaniel Vetter for (i = 0; i < value_count; i++) { 469eb8eb02eSDaniel Vetter if (i < out_resp->count_values && 470eb8eb02eSDaniel Vetter put_user(property->values[i], values_ptr + i)) { 471eb8eb02eSDaniel Vetter return -EFAULT; 47259e71ee7SDaniel Vetter } 47359e71ee7SDaniel Vetter } 47459e71ee7SDaniel Vetter out_resp->count_values = value_count; 47559e71ee7SDaniel Vetter 476eb8eb02eSDaniel Vetter copied = 0; 477eb8eb02eSDaniel Vetter enum_ptr = u64_to_user_ptr(out_resp->enum_blob_ptr); 478eb8eb02eSDaniel Vetter 47959e71ee7SDaniel Vetter if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) || 48059e71ee7SDaniel Vetter drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) { 48159e71ee7SDaniel Vetter list_for_each_entry(prop_enum, &property->enum_list, head) { 482eb8eb02eSDaniel Vetter enum_count++; 4838cb68c83SDaniel Vetter if (out_resp->count_enum_blobs < enum_count) 484eb8eb02eSDaniel Vetter continue; 48559e71ee7SDaniel Vetter 486eb8eb02eSDaniel Vetter if (copy_to_user(&enum_ptr[copied].value, 487eb8eb02eSDaniel Vetter &prop_enum->value, sizeof(uint64_t))) 488eb8eb02eSDaniel Vetter return -EFAULT; 48959e71ee7SDaniel Vetter 49059e71ee7SDaniel Vetter if (copy_to_user(&enum_ptr[copied].name, 491eb8eb02eSDaniel Vetter &prop_enum->name, DRM_PROP_NAME_LEN)) 492eb8eb02eSDaniel Vetter return -EFAULT; 49359e71ee7SDaniel Vetter copied++; 49459e71ee7SDaniel Vetter } 49559e71ee7SDaniel Vetter out_resp->count_enum_blobs = enum_count; 49659e71ee7SDaniel Vetter } 49759e71ee7SDaniel Vetter 49859e71ee7SDaniel Vetter /* 49959e71ee7SDaniel Vetter * NOTE: The idea seems to have been to use this to read all the blob 50059e71ee7SDaniel Vetter * property values. But nothing ever added them to the corresponding 50159e71ee7SDaniel Vetter * list, userspace always used the special-purpose get_blob ioctl to 50259e71ee7SDaniel Vetter * read the value for a blob property. It also doesn't make a lot of 50359e71ee7SDaniel Vetter * sense to return values here when everything else is just metadata for 50459e71ee7SDaniel Vetter * the property itself. 50559e71ee7SDaniel Vetter */ 50659e71ee7SDaniel Vetter if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) 50759e71ee7SDaniel Vetter out_resp->count_enum_blobs = 0; 508eb8eb02eSDaniel Vetter 509eb8eb02eSDaniel Vetter return 0; 51059e71ee7SDaniel Vetter } 51159e71ee7SDaniel Vetter 51259e71ee7SDaniel Vetter static void drm_property_free_blob(struct kref *kref) 51359e71ee7SDaniel Vetter { 51459e71ee7SDaniel Vetter struct drm_property_blob *blob = 51559e71ee7SDaniel Vetter container_of(kref, struct drm_property_blob, base.refcount); 51659e71ee7SDaniel Vetter 51759e71ee7SDaniel Vetter mutex_lock(&blob->dev->mode_config.blob_lock); 51859e71ee7SDaniel Vetter list_del(&blob->head_global); 51959e71ee7SDaniel Vetter mutex_unlock(&blob->dev->mode_config.blob_lock); 52059e71ee7SDaniel Vetter 52159e71ee7SDaniel Vetter drm_mode_object_unregister(blob->dev, &blob->base); 52259e71ee7SDaniel Vetter 52359e71ee7SDaniel Vetter kfree(blob); 52459e71ee7SDaniel Vetter } 52559e71ee7SDaniel Vetter 52659e71ee7SDaniel Vetter /** 52759e71ee7SDaniel Vetter * drm_property_create_blob - Create new blob property 52859e71ee7SDaniel Vetter * @dev: DRM device to create property for 52959e71ee7SDaniel Vetter * @length: Length to allocate for blob data 53059e71ee7SDaniel Vetter * @data: If specified, copies data into blob 53159e71ee7SDaniel Vetter * 532c8458c7eSDaniel Vetter * Creates a new blob property for a specified DRM device, optionally 533c8458c7eSDaniel Vetter * copying data. Note that blob properties are meant to be invariant, hence the 534c8458c7eSDaniel Vetter * data must be filled out before the blob is used as the value of any property. 535c8458c7eSDaniel Vetter * 53659e71ee7SDaniel Vetter * Returns: 53759e71ee7SDaniel Vetter * New blob property with a single reference on success, or an ERR_PTR 53859e71ee7SDaniel Vetter * value on failure. 53959e71ee7SDaniel Vetter */ 54059e71ee7SDaniel Vetter struct drm_property_blob * 54159e71ee7SDaniel Vetter drm_property_create_blob(struct drm_device *dev, size_t length, 54259e71ee7SDaniel Vetter const void *data) 54359e71ee7SDaniel Vetter { 54459e71ee7SDaniel Vetter struct drm_property_blob *blob; 54559e71ee7SDaniel Vetter int ret; 54659e71ee7SDaniel Vetter 54759e71ee7SDaniel Vetter if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob)) 54859e71ee7SDaniel Vetter return ERR_PTR(-EINVAL); 54959e71ee7SDaniel Vetter 55059e71ee7SDaniel Vetter blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL); 55159e71ee7SDaniel Vetter if (!blob) 55259e71ee7SDaniel Vetter return ERR_PTR(-ENOMEM); 55359e71ee7SDaniel Vetter 55459e71ee7SDaniel Vetter /* This must be explicitly initialised, so we can safely call list_del 55559e71ee7SDaniel Vetter * on it in the removal handler, even if it isn't in a file list. */ 55659e71ee7SDaniel Vetter INIT_LIST_HEAD(&blob->head_file); 55759e71ee7SDaniel Vetter blob->length = length; 55859e71ee7SDaniel Vetter blob->dev = dev; 55959e71ee7SDaniel Vetter 56059e71ee7SDaniel Vetter if (data) 56159e71ee7SDaniel Vetter memcpy(blob->data, data, length); 56259e71ee7SDaniel Vetter 5632135ea7aSThierry Reding ret = __drm_mode_object_add(dev, &blob->base, DRM_MODE_OBJECT_BLOB, 56459e71ee7SDaniel Vetter true, drm_property_free_blob); 56559e71ee7SDaniel Vetter if (ret) { 56659e71ee7SDaniel Vetter kfree(blob); 56759e71ee7SDaniel Vetter return ERR_PTR(-EINVAL); 56859e71ee7SDaniel Vetter } 56959e71ee7SDaniel Vetter 57059e71ee7SDaniel Vetter mutex_lock(&dev->mode_config.blob_lock); 57159e71ee7SDaniel Vetter list_add_tail(&blob->head_global, 57259e71ee7SDaniel Vetter &dev->mode_config.property_blob_list); 57359e71ee7SDaniel Vetter mutex_unlock(&dev->mode_config.blob_lock); 57459e71ee7SDaniel Vetter 57559e71ee7SDaniel Vetter return blob; 57659e71ee7SDaniel Vetter } 57759e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_create_blob); 57859e71ee7SDaniel Vetter 57959e71ee7SDaniel Vetter /** 5806472e509SThierry Reding * drm_property_blob_put - release a blob property reference 5816472e509SThierry Reding * @blob: DRM blob property 58259e71ee7SDaniel Vetter * 5836472e509SThierry Reding * Releases a reference to a blob property. May free the object. 58459e71ee7SDaniel Vetter */ 5856472e509SThierry Reding void drm_property_blob_put(struct drm_property_blob *blob) 58659e71ee7SDaniel Vetter { 58759e71ee7SDaniel Vetter if (!blob) 58859e71ee7SDaniel Vetter return; 58959e71ee7SDaniel Vetter 590020a218fSThierry Reding drm_mode_object_put(&blob->base); 59159e71ee7SDaniel Vetter } 5926472e509SThierry Reding EXPORT_SYMBOL(drm_property_blob_put); 59359e71ee7SDaniel Vetter 59459e71ee7SDaniel Vetter void drm_property_destroy_user_blobs(struct drm_device *dev, 59559e71ee7SDaniel Vetter struct drm_file *file_priv) 59659e71ee7SDaniel Vetter { 59759e71ee7SDaniel Vetter struct drm_property_blob *blob, *bt; 59859e71ee7SDaniel Vetter 59959e71ee7SDaniel Vetter /* 60059e71ee7SDaniel Vetter * When the file gets released that means no one else can access the 60159e71ee7SDaniel Vetter * blob list any more, so no need to grab dev->blob_lock. 60259e71ee7SDaniel Vetter */ 60359e71ee7SDaniel Vetter list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) { 60459e71ee7SDaniel Vetter list_del_init(&blob->head_file); 6056472e509SThierry Reding drm_property_blob_put(blob); 60659e71ee7SDaniel Vetter } 60759e71ee7SDaniel Vetter } 60859e71ee7SDaniel Vetter 60959e71ee7SDaniel Vetter /** 6106472e509SThierry Reding * drm_property_blob_get - acquire blob property reference 6116472e509SThierry Reding * @blob: DRM blob property 612c8458c7eSDaniel Vetter * 6136472e509SThierry Reding * Acquires a reference to an existing blob property. Returns @blob, which 614c8458c7eSDaniel Vetter * allows this to be used as a shorthand in assignments. 61559e71ee7SDaniel Vetter */ 6166472e509SThierry Reding struct drm_property_blob *drm_property_blob_get(struct drm_property_blob *blob) 61759e71ee7SDaniel Vetter { 618020a218fSThierry Reding drm_mode_object_get(&blob->base); 61959e71ee7SDaniel Vetter return blob; 62059e71ee7SDaniel Vetter } 6216472e509SThierry Reding EXPORT_SYMBOL(drm_property_blob_get); 62259e71ee7SDaniel Vetter 62359e71ee7SDaniel Vetter /** 62459e71ee7SDaniel Vetter * drm_property_lookup_blob - look up a blob property and take a reference 62559e71ee7SDaniel Vetter * @dev: drm device 62659e71ee7SDaniel Vetter * @id: id of the blob property 62759e71ee7SDaniel Vetter * 62859e71ee7SDaniel Vetter * If successful, this takes an additional reference to the blob property. 62959e71ee7SDaniel Vetter * callers need to make sure to eventually unreference the returned property 6306472e509SThierry Reding * again, using drm_property_blob_put(). 631c8458c7eSDaniel Vetter * 632c8458c7eSDaniel Vetter * Return: 633c8458c7eSDaniel Vetter * NULL on failure, pointer to the blob on success. 63459e71ee7SDaniel Vetter */ 63559e71ee7SDaniel Vetter struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev, 63659e71ee7SDaniel Vetter uint32_t id) 63759e71ee7SDaniel Vetter { 63859e71ee7SDaniel Vetter struct drm_mode_object *obj; 63959e71ee7SDaniel Vetter struct drm_property_blob *blob = NULL; 64059e71ee7SDaniel Vetter 641418da172SKeith Packard obj = __drm_mode_object_find(dev, NULL, id, DRM_MODE_OBJECT_BLOB); 64259e71ee7SDaniel Vetter if (obj) 64359e71ee7SDaniel Vetter blob = obj_to_blob(obj); 64459e71ee7SDaniel Vetter return blob; 64559e71ee7SDaniel Vetter } 64659e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_lookup_blob); 64759e71ee7SDaniel Vetter 64859e71ee7SDaniel Vetter /** 649c8458c7eSDaniel Vetter * drm_property_replace_global_blob - replace existing blob property 65059e71ee7SDaniel Vetter * @dev: drm device 65159e71ee7SDaniel Vetter * @replace: location of blob property pointer to be replaced 65259e71ee7SDaniel Vetter * @length: length of data for new blob, or 0 for no data 65359e71ee7SDaniel Vetter * @data: content for new blob, or NULL for no data 65459e71ee7SDaniel Vetter * @obj_holds_id: optional object for property holding blob ID 65559e71ee7SDaniel Vetter * @prop_holds_id: optional property holding blob ID 65659e71ee7SDaniel Vetter * @return 0 on success or error on failure 65759e71ee7SDaniel Vetter * 658c8458c7eSDaniel Vetter * This function will replace a global property in the blob list, optionally 659c8458c7eSDaniel Vetter * updating a property which holds the ID of that property. 66059e71ee7SDaniel Vetter * 66159e71ee7SDaniel Vetter * If length is 0 or data is NULL, no new blob will be created, and the holding 66259e71ee7SDaniel Vetter * property, if specified, will be set to 0. 66359e71ee7SDaniel Vetter * 66459e71ee7SDaniel Vetter * Access to the replace pointer is assumed to be protected by the caller, e.g. 66559e71ee7SDaniel Vetter * by holding the relevant modesetting object lock for its parent. 66659e71ee7SDaniel Vetter * 66759e71ee7SDaniel Vetter * For example, a drm_connector has a 'PATH' property, which contains the ID 66859e71ee7SDaniel Vetter * of a blob property with the value of the MST path information. Calling this 66959e71ee7SDaniel Vetter * function with replace pointing to the connector's path_blob_ptr, length and 67059e71ee7SDaniel Vetter * data set for the new path information, obj_holds_id set to the connector's 67159e71ee7SDaniel Vetter * base object, and prop_holds_id set to the path property name, will perform 67259e71ee7SDaniel Vetter * a completely atomic update. The access to path_blob_ptr is protected by the 67359e71ee7SDaniel Vetter * caller holding a lock on the connector. 67459e71ee7SDaniel Vetter */ 67559e71ee7SDaniel Vetter int drm_property_replace_global_blob(struct drm_device *dev, 67659e71ee7SDaniel Vetter struct drm_property_blob **replace, 67759e71ee7SDaniel Vetter size_t length, 67859e71ee7SDaniel Vetter const void *data, 67959e71ee7SDaniel Vetter struct drm_mode_object *obj_holds_id, 68059e71ee7SDaniel Vetter struct drm_property *prop_holds_id) 68159e71ee7SDaniel Vetter { 68259e71ee7SDaniel Vetter struct drm_property_blob *new_blob = NULL; 68359e71ee7SDaniel Vetter struct drm_property_blob *old_blob = NULL; 68459e71ee7SDaniel Vetter int ret; 68559e71ee7SDaniel Vetter 68659e71ee7SDaniel Vetter WARN_ON(replace == NULL); 68759e71ee7SDaniel Vetter 68859e71ee7SDaniel Vetter old_blob = *replace; 68959e71ee7SDaniel Vetter 69059e71ee7SDaniel Vetter if (length && data) { 69159e71ee7SDaniel Vetter new_blob = drm_property_create_blob(dev, length, data); 69259e71ee7SDaniel Vetter if (IS_ERR(new_blob)) 69359e71ee7SDaniel Vetter return PTR_ERR(new_blob); 69459e71ee7SDaniel Vetter } 69559e71ee7SDaniel Vetter 69659e71ee7SDaniel Vetter if (obj_holds_id) { 69759e71ee7SDaniel Vetter ret = drm_object_property_set_value(obj_holds_id, 69859e71ee7SDaniel Vetter prop_holds_id, 69959e71ee7SDaniel Vetter new_blob ? 70059e71ee7SDaniel Vetter new_blob->base.id : 0); 70159e71ee7SDaniel Vetter if (ret != 0) 70259e71ee7SDaniel Vetter goto err_created; 70359e71ee7SDaniel Vetter } 70459e71ee7SDaniel Vetter 7056472e509SThierry Reding drm_property_blob_put(old_blob); 70659e71ee7SDaniel Vetter *replace = new_blob; 70759e71ee7SDaniel Vetter 70859e71ee7SDaniel Vetter return 0; 70959e71ee7SDaniel Vetter 71059e71ee7SDaniel Vetter err_created: 7116472e509SThierry Reding drm_property_blob_put(new_blob); 71259e71ee7SDaniel Vetter return ret; 71359e71ee7SDaniel Vetter } 71459e71ee7SDaniel Vetter EXPORT_SYMBOL(drm_property_replace_global_blob); 71559e71ee7SDaniel Vetter 7165f057ffdSPeter Rosin /** 7175f057ffdSPeter Rosin * drm_property_replace_blob - replace a blob property 7185f057ffdSPeter Rosin * @blob: a pointer to the member blob to be replaced 7195f057ffdSPeter Rosin * @new_blob: the new blob to replace with 7205f057ffdSPeter Rosin * 7215f057ffdSPeter Rosin * Return: true if the blob was in fact replaced. 7225f057ffdSPeter Rosin */ 7235f057ffdSPeter Rosin bool drm_property_replace_blob(struct drm_property_blob **blob, 7245f057ffdSPeter Rosin struct drm_property_blob *new_blob) 7255f057ffdSPeter Rosin { 7265f057ffdSPeter Rosin struct drm_property_blob *old_blob = *blob; 7275f057ffdSPeter Rosin 7285f057ffdSPeter Rosin if (old_blob == new_blob) 7295f057ffdSPeter Rosin return false; 7305f057ffdSPeter Rosin 7315f057ffdSPeter Rosin drm_property_blob_put(old_blob); 7325f057ffdSPeter Rosin if (new_blob) 7335f057ffdSPeter Rosin drm_property_blob_get(new_blob); 7345f057ffdSPeter Rosin *blob = new_blob; 7355f057ffdSPeter Rosin return true; 7365f057ffdSPeter Rosin } 7375f057ffdSPeter Rosin EXPORT_SYMBOL(drm_property_replace_blob); 7385f057ffdSPeter Rosin 73959e71ee7SDaniel Vetter int drm_mode_getblob_ioctl(struct drm_device *dev, 74059e71ee7SDaniel Vetter void *data, struct drm_file *file_priv) 74159e71ee7SDaniel Vetter { 74259e71ee7SDaniel Vetter struct drm_mode_get_blob *out_resp = data; 74359e71ee7SDaniel Vetter struct drm_property_blob *blob; 74459e71ee7SDaniel Vetter int ret = 0; 74559e71ee7SDaniel Vetter 74659e71ee7SDaniel Vetter if (!drm_core_check_feature(dev, DRIVER_MODESET)) 74759e71ee7SDaniel Vetter return -EINVAL; 74859e71ee7SDaniel Vetter 74959e71ee7SDaniel Vetter blob = drm_property_lookup_blob(dev, out_resp->blob_id); 75059e71ee7SDaniel Vetter if (!blob) 75159e71ee7SDaniel Vetter return -ENOENT; 75259e71ee7SDaniel Vetter 75359e71ee7SDaniel Vetter if (out_resp->length == blob->length) { 75475df6247SChris Wilson if (copy_to_user(u64_to_user_ptr(out_resp->data), 75575df6247SChris Wilson blob->data, 75675df6247SChris Wilson blob->length)) { 75759e71ee7SDaniel Vetter ret = -EFAULT; 75859e71ee7SDaniel Vetter goto unref; 75959e71ee7SDaniel Vetter } 76059e71ee7SDaniel Vetter } 76159e71ee7SDaniel Vetter out_resp->length = blob->length; 76259e71ee7SDaniel Vetter unref: 7636472e509SThierry Reding drm_property_blob_put(blob); 76459e71ee7SDaniel Vetter 76559e71ee7SDaniel Vetter return ret; 76659e71ee7SDaniel Vetter } 76759e71ee7SDaniel Vetter 76859e71ee7SDaniel Vetter int drm_mode_createblob_ioctl(struct drm_device *dev, 76959e71ee7SDaniel Vetter void *data, struct drm_file *file_priv) 77059e71ee7SDaniel Vetter { 77159e71ee7SDaniel Vetter struct drm_mode_create_blob *out_resp = data; 77259e71ee7SDaniel Vetter struct drm_property_blob *blob; 77359e71ee7SDaniel Vetter int ret = 0; 77459e71ee7SDaniel Vetter 77559e71ee7SDaniel Vetter if (!drm_core_check_feature(dev, DRIVER_MODESET)) 77659e71ee7SDaniel Vetter return -EINVAL; 77759e71ee7SDaniel Vetter 77859e71ee7SDaniel Vetter blob = drm_property_create_blob(dev, out_resp->length, NULL); 77959e71ee7SDaniel Vetter if (IS_ERR(blob)) 78059e71ee7SDaniel Vetter return PTR_ERR(blob); 78159e71ee7SDaniel Vetter 78275df6247SChris Wilson if (copy_from_user(blob->data, 78375df6247SChris Wilson u64_to_user_ptr(out_resp->data), 78475df6247SChris Wilson out_resp->length)) { 78559e71ee7SDaniel Vetter ret = -EFAULT; 78659e71ee7SDaniel Vetter goto out_blob; 78759e71ee7SDaniel Vetter } 78859e71ee7SDaniel Vetter 78959e71ee7SDaniel Vetter /* Dropping the lock between create_blob and our access here is safe 79059e71ee7SDaniel Vetter * as only the same file_priv can remove the blob; at this point, it is 79159e71ee7SDaniel Vetter * not associated with any file_priv. */ 79259e71ee7SDaniel Vetter mutex_lock(&dev->mode_config.blob_lock); 79359e71ee7SDaniel Vetter out_resp->blob_id = blob->base.id; 79459e71ee7SDaniel Vetter list_add_tail(&blob->head_file, &file_priv->blobs); 79559e71ee7SDaniel Vetter mutex_unlock(&dev->mode_config.blob_lock); 79659e71ee7SDaniel Vetter 79759e71ee7SDaniel Vetter return 0; 79859e71ee7SDaniel Vetter 79959e71ee7SDaniel Vetter out_blob: 8006472e509SThierry Reding drm_property_blob_put(blob); 80159e71ee7SDaniel Vetter return ret; 80259e71ee7SDaniel Vetter } 80359e71ee7SDaniel Vetter 80459e71ee7SDaniel Vetter int drm_mode_destroyblob_ioctl(struct drm_device *dev, 80559e71ee7SDaniel Vetter void *data, struct drm_file *file_priv) 80659e71ee7SDaniel Vetter { 80759e71ee7SDaniel Vetter struct drm_mode_destroy_blob *out_resp = data; 80859e71ee7SDaniel Vetter struct drm_property_blob *blob = NULL, *bt; 80959e71ee7SDaniel Vetter bool found = false; 81059e71ee7SDaniel Vetter int ret = 0; 81159e71ee7SDaniel Vetter 81259e71ee7SDaniel Vetter if (!drm_core_check_feature(dev, DRIVER_MODESET)) 81359e71ee7SDaniel Vetter return -EINVAL; 81459e71ee7SDaniel Vetter 81559e71ee7SDaniel Vetter blob = drm_property_lookup_blob(dev, out_resp->blob_id); 81659e71ee7SDaniel Vetter if (!blob) 81759e71ee7SDaniel Vetter return -ENOENT; 81859e71ee7SDaniel Vetter 81959e71ee7SDaniel Vetter mutex_lock(&dev->mode_config.blob_lock); 82059e71ee7SDaniel Vetter /* Ensure the property was actually created by this user. */ 82159e71ee7SDaniel Vetter list_for_each_entry(bt, &file_priv->blobs, head_file) { 82259e71ee7SDaniel Vetter if (bt == blob) { 82359e71ee7SDaniel Vetter found = true; 82459e71ee7SDaniel Vetter break; 82559e71ee7SDaniel Vetter } 82659e71ee7SDaniel Vetter } 82759e71ee7SDaniel Vetter 82859e71ee7SDaniel Vetter if (!found) { 82959e71ee7SDaniel Vetter ret = -EPERM; 83059e71ee7SDaniel Vetter goto err; 83159e71ee7SDaniel Vetter } 83259e71ee7SDaniel Vetter 83359e71ee7SDaniel Vetter /* We must drop head_file here, because we may not be the last 83459e71ee7SDaniel Vetter * reference on the blob. */ 83559e71ee7SDaniel Vetter list_del_init(&blob->head_file); 83659e71ee7SDaniel Vetter mutex_unlock(&dev->mode_config.blob_lock); 83759e71ee7SDaniel Vetter 83859e71ee7SDaniel Vetter /* One reference from lookup, and one from the filp. */ 8396472e509SThierry Reding drm_property_blob_put(blob); 8406472e509SThierry Reding drm_property_blob_put(blob); 84159e71ee7SDaniel Vetter 84259e71ee7SDaniel Vetter return 0; 84359e71ee7SDaniel Vetter 84459e71ee7SDaniel Vetter err: 84559e71ee7SDaniel Vetter mutex_unlock(&dev->mode_config.blob_lock); 8466472e509SThierry Reding drm_property_blob_put(blob); 84759e71ee7SDaniel Vetter 84859e71ee7SDaniel Vetter return ret; 84959e71ee7SDaniel Vetter } 85059e71ee7SDaniel Vetter 85159e71ee7SDaniel Vetter /* Some properties could refer to dynamic refcnt'd objects, or things that 85259e71ee7SDaniel Vetter * need special locking to handle lifetime issues (ie. to ensure the prop 85359e71ee7SDaniel Vetter * value doesn't become invalid part way through the property update due to 85459e71ee7SDaniel Vetter * race). The value returned by reference via 'obj' should be passed back 85559e71ee7SDaniel Vetter * to drm_property_change_valid_put() after the property is set (and the 85659e71ee7SDaniel Vetter * object to which the property is attached has a chance to take it's own 85759e71ee7SDaniel Vetter * reference). 85859e71ee7SDaniel Vetter */ 85959e71ee7SDaniel Vetter bool drm_property_change_valid_get(struct drm_property *property, 86059e71ee7SDaniel Vetter uint64_t value, struct drm_mode_object **ref) 86159e71ee7SDaniel Vetter { 86259e71ee7SDaniel Vetter int i; 86359e71ee7SDaniel Vetter 86459e71ee7SDaniel Vetter if (property->flags & DRM_MODE_PROP_IMMUTABLE) 86559e71ee7SDaniel Vetter return false; 86659e71ee7SDaniel Vetter 86759e71ee7SDaniel Vetter *ref = NULL; 86859e71ee7SDaniel Vetter 86959e71ee7SDaniel Vetter if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) { 87059e71ee7SDaniel Vetter if (value < property->values[0] || value > property->values[1]) 87159e71ee7SDaniel Vetter return false; 87259e71ee7SDaniel Vetter return true; 87359e71ee7SDaniel Vetter } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) { 87459e71ee7SDaniel Vetter int64_t svalue = U642I64(value); 87559e71ee7SDaniel Vetter 87659e71ee7SDaniel Vetter if (svalue < U642I64(property->values[0]) || 87759e71ee7SDaniel Vetter svalue > U642I64(property->values[1])) 87859e71ee7SDaniel Vetter return false; 87959e71ee7SDaniel Vetter return true; 88059e71ee7SDaniel Vetter } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) { 88159e71ee7SDaniel Vetter uint64_t valid_mask = 0; 88259e71ee7SDaniel Vetter 88359e71ee7SDaniel Vetter for (i = 0; i < property->num_values; i++) 88459e71ee7SDaniel Vetter valid_mask |= (1ULL << property->values[i]); 88559e71ee7SDaniel Vetter return !(value & ~valid_mask); 88630c06570SMaarten Lankhorst } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) { 88730c06570SMaarten Lankhorst struct drm_property_blob *blob; 88830c06570SMaarten Lankhorst 88930c06570SMaarten Lankhorst if (value == 0) 89030c06570SMaarten Lankhorst return true; 89130c06570SMaarten Lankhorst 89230c06570SMaarten Lankhorst blob = drm_property_lookup_blob(property->dev, value); 89330c06570SMaarten Lankhorst if (blob) { 89430c06570SMaarten Lankhorst *ref = &blob->base; 89530c06570SMaarten Lankhorst return true; 89630c06570SMaarten Lankhorst } else { 89730c06570SMaarten Lankhorst return false; 89830c06570SMaarten Lankhorst } 89930c06570SMaarten Lankhorst } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) { 90059e71ee7SDaniel Vetter /* a zero value for an object property translates to null: */ 90159e71ee7SDaniel Vetter if (value == 0) 90259e71ee7SDaniel Vetter return true; 90359e71ee7SDaniel Vetter 904418da172SKeith Packard *ref = __drm_mode_object_find(property->dev, NULL, value, 90559e71ee7SDaniel Vetter property->values[0]); 90659e71ee7SDaniel Vetter return *ref != NULL; 90759e71ee7SDaniel Vetter } 90859e71ee7SDaniel Vetter 90959e71ee7SDaniel Vetter for (i = 0; i < property->num_values; i++) 91059e71ee7SDaniel Vetter if (property->values[i] == value) 91159e71ee7SDaniel Vetter return true; 91259e71ee7SDaniel Vetter return false; 91359e71ee7SDaniel Vetter } 91459e71ee7SDaniel Vetter 91559e71ee7SDaniel Vetter void drm_property_change_valid_put(struct drm_property *property, 91659e71ee7SDaniel Vetter struct drm_mode_object *ref) 91759e71ee7SDaniel Vetter { 91859e71ee7SDaniel Vetter if (!ref) 91959e71ee7SDaniel Vetter return; 92059e71ee7SDaniel Vetter 92130c06570SMaarten Lankhorst if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) { 922020a218fSThierry Reding drm_mode_object_put(ref); 92330c06570SMaarten Lankhorst } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) 9246472e509SThierry Reding drm_property_blob_put(obj_to_blob(ref)); 92559e71ee7SDaniel Vetter } 926