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