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