1 /* $NetBSD: drm_mode_config.c,v 1.5 2021/12/19 12:32:01 riastradh Exp $ */ 2 3 /* 4 * Copyright (c) 2016 Intel Corporation 5 * 6 * Permission to use, copy, modify, distribute, and sell this software and its 7 * documentation for any purpose is hereby granted without fee, provided that 8 * the above copyright notice appear in all copies and that both that copyright 9 * notice and this permission notice appear in supporting documentation, and 10 * that the name of the copyright holders not be used in advertising or 11 * publicity pertaining to distribution of the software without specific, 12 * written prior permission. The copyright holders make no representations 13 * about the suitability of this software for any purpose. It is provided "as 14 * is" without express or implied warranty. 15 * 16 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 18 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 19 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 20 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 21 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 22 * OF THIS SOFTWARE. 23 */ 24 25 #include <sys/cdefs.h> 26 __KERNEL_RCSID(0, "$NetBSD: drm_mode_config.c,v 1.5 2021/12/19 12:32:01 riastradh Exp $"); 27 28 #include <linux/uaccess.h> 29 30 #include <drm/drm_drv.h> 31 #include <drm/drm_encoder.h> 32 #include <drm/drm_file.h> 33 #include <drm/drm_mode_config.h> 34 #include <drm/drm_print.h> 35 #include <linux/dma-resv.h> 36 37 #include "drm_crtc_internal.h" 38 #include "drm_internal.h" 39 40 #include <linux/nbsd-namespace.h> 41 42 int drm_modeset_register_all(struct drm_device *dev) 43 { 44 int ret; 45 46 ret = drm_plane_register_all(dev); 47 if (ret) 48 goto err_plane; 49 50 ret = drm_crtc_register_all(dev); 51 if (ret) 52 goto err_crtc; 53 54 ret = drm_encoder_register_all(dev); 55 if (ret) 56 goto err_encoder; 57 58 ret = drm_connector_register_all(dev); 59 if (ret) 60 goto err_connector; 61 62 return 0; 63 64 err_connector: 65 drm_encoder_unregister_all(dev); 66 err_encoder: 67 drm_crtc_unregister_all(dev); 68 err_crtc: 69 drm_plane_unregister_all(dev); 70 err_plane: 71 return ret; 72 } 73 74 void drm_modeset_unregister_all(struct drm_device *dev) 75 { 76 drm_connector_unregister_all(dev); 77 drm_encoder_unregister_all(dev); 78 drm_crtc_unregister_all(dev); 79 drm_plane_unregister_all(dev); 80 } 81 82 /** 83 * drm_mode_getresources - get graphics configuration 84 * @dev: drm device for the ioctl 85 * @data: data pointer for the ioctl 86 * @file_priv: drm file for the ioctl call 87 * 88 * Construct a set of configuration description structures and return 89 * them to the user, including CRTC, connector and framebuffer configuration. 90 * 91 * Called by the user via ioctl. 92 * 93 * Returns: 94 * Zero on success, negative errno on failure. 95 */ 96 int drm_mode_getresources(struct drm_device *dev, void *data, 97 struct drm_file *file_priv) 98 { 99 struct drm_mode_card_res *card_res = data; 100 struct drm_framebuffer *fb; 101 struct drm_connector *connector; 102 struct drm_crtc *crtc; 103 struct drm_encoder *encoder; 104 int count, ret = 0; 105 uint32_t __user *fb_id; 106 uint32_t __user *crtc_id; 107 uint32_t __user *connector_id; 108 uint32_t __user *encoder_id; 109 struct drm_connector_list_iter conn_iter; 110 111 if (!drm_core_check_feature(dev, DRIVER_MODESET)) 112 return -EOPNOTSUPP; 113 114 mutex_lock(&file_priv->fbs_lock); 115 count = 0; 116 fb_id = u64_to_user_ptr(card_res->fb_id_ptr); 117 list_for_each_entry(fb, &file_priv->fbs, filp_head) { 118 if (count < card_res->count_fbs && 119 put_user(fb->base.id, fb_id + count)) { 120 mutex_unlock(&file_priv->fbs_lock); 121 return -EFAULT; 122 } 123 count++; 124 } 125 card_res->count_fbs = count; 126 mutex_unlock(&file_priv->fbs_lock); 127 128 card_res->max_height = dev->mode_config.max_height; 129 card_res->min_height = dev->mode_config.min_height; 130 card_res->max_width = dev->mode_config.max_width; 131 card_res->min_width = dev->mode_config.min_width; 132 133 count = 0; 134 crtc_id = u64_to_user_ptr(card_res->crtc_id_ptr); 135 drm_for_each_crtc(crtc, dev) { 136 if (drm_lease_held(file_priv, crtc->base.id)) { 137 if (count < card_res->count_crtcs && 138 put_user(crtc->base.id, crtc_id + count)) 139 return -EFAULT; 140 count++; 141 } 142 } 143 card_res->count_crtcs = count; 144 145 count = 0; 146 encoder_id = u64_to_user_ptr(card_res->encoder_id_ptr); 147 drm_for_each_encoder(encoder, dev) { 148 if (count < card_res->count_encoders && 149 put_user(encoder->base.id, encoder_id + count)) 150 return -EFAULT; 151 count++; 152 } 153 card_res->count_encoders = count; 154 155 drm_connector_list_iter_begin(dev, &conn_iter); 156 count = 0; 157 connector_id = u64_to_user_ptr(card_res->connector_id_ptr); 158 drm_for_each_connector_iter(connector, &conn_iter) { 159 /* only expose writeback connectors if userspace understands them */ 160 if (!file_priv->writeback_connectors && 161 (connector->connector_type == DRM_MODE_CONNECTOR_WRITEBACK)) 162 continue; 163 164 if (drm_lease_held(file_priv, connector->base.id)) { 165 if (count < card_res->count_connectors && 166 put_user(connector->base.id, connector_id + count)) { 167 drm_connector_list_iter_end(&conn_iter); 168 return -EFAULT; 169 } 170 count++; 171 } 172 } 173 card_res->count_connectors = count; 174 drm_connector_list_iter_end(&conn_iter); 175 176 return ret; 177 } 178 179 /** 180 * drm_mode_config_reset - call ->reset callbacks 181 * @dev: drm device 182 * 183 * This functions calls all the crtc's, encoder's and connector's ->reset 184 * callback. Drivers can use this in e.g. their driver load or resume code to 185 * reset hardware and software state. 186 */ 187 void drm_mode_config_reset(struct drm_device *dev) 188 { 189 struct drm_crtc *crtc; 190 struct drm_plane *plane; 191 struct drm_encoder *encoder; 192 struct drm_connector *connector; 193 struct drm_connector_list_iter conn_iter; 194 195 drm_for_each_plane(plane, dev) 196 if (plane->funcs->reset) 197 plane->funcs->reset(plane); 198 199 drm_for_each_crtc(crtc, dev) 200 if (crtc->funcs->reset) 201 crtc->funcs->reset(crtc); 202 203 drm_for_each_encoder(encoder, dev) 204 if (encoder->funcs->reset) 205 encoder->funcs->reset(encoder); 206 207 drm_connector_list_iter_begin(dev, &conn_iter); 208 drm_for_each_connector_iter(connector, &conn_iter) 209 if (connector->funcs->reset) 210 connector->funcs->reset(connector); 211 drm_connector_list_iter_end(&conn_iter); 212 } 213 EXPORT_SYMBOL(drm_mode_config_reset); 214 215 /* 216 * Global properties 217 */ 218 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = { 219 { DRM_PLANE_TYPE_OVERLAY, "Overlay" }, 220 { DRM_PLANE_TYPE_PRIMARY, "Primary" }, 221 { DRM_PLANE_TYPE_CURSOR, "Cursor" }, 222 }; 223 224 static int drm_mode_create_standard_properties(struct drm_device *dev) 225 { 226 struct drm_property *prop; 227 int ret; 228 229 ret = drm_connector_create_standard_properties(dev); 230 if (ret) 231 return ret; 232 233 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE, 234 "type", drm_plane_type_enum_list, 235 ARRAY_SIZE(drm_plane_type_enum_list)); 236 if (!prop) 237 return -ENOMEM; 238 dev->mode_config.plane_type_property = prop; 239 240 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 241 "SRC_X", 0, UINT_MAX); 242 if (!prop) 243 return -ENOMEM; 244 dev->mode_config.prop_src_x = prop; 245 246 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 247 "SRC_Y", 0, UINT_MAX); 248 if (!prop) 249 return -ENOMEM; 250 dev->mode_config.prop_src_y = prop; 251 252 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 253 "SRC_W", 0, UINT_MAX); 254 if (!prop) 255 return -ENOMEM; 256 dev->mode_config.prop_src_w = prop; 257 258 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 259 "SRC_H", 0, UINT_MAX); 260 if (!prop) 261 return -ENOMEM; 262 dev->mode_config.prop_src_h = prop; 263 264 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC, 265 "CRTC_X", INT_MIN, INT_MAX); 266 if (!prop) 267 return -ENOMEM; 268 dev->mode_config.prop_crtc_x = prop; 269 270 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC, 271 "CRTC_Y", INT_MIN, INT_MAX); 272 if (!prop) 273 return -ENOMEM; 274 dev->mode_config.prop_crtc_y = prop; 275 276 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 277 "CRTC_W", 0, INT_MAX); 278 if (!prop) 279 return -ENOMEM; 280 dev->mode_config.prop_crtc_w = prop; 281 282 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 283 "CRTC_H", 0, INT_MAX); 284 if (!prop) 285 return -ENOMEM; 286 dev->mode_config.prop_crtc_h = prop; 287 288 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC, 289 "FB_ID", DRM_MODE_OBJECT_FB); 290 if (!prop) 291 return -ENOMEM; 292 dev->mode_config.prop_fb_id = prop; 293 294 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC, 295 "IN_FENCE_FD", -1, INT_MAX); 296 if (!prop) 297 return -ENOMEM; 298 dev->mode_config.prop_in_fence_fd = prop; 299 300 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC, 301 "OUT_FENCE_PTR", 0, U64_MAX); 302 if (!prop) 303 return -ENOMEM; 304 dev->mode_config.prop_out_fence_ptr = prop; 305 306 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC, 307 "CRTC_ID", DRM_MODE_OBJECT_CRTC); 308 if (!prop) 309 return -ENOMEM; 310 dev->mode_config.prop_crtc_id = prop; 311 312 prop = drm_property_create(dev, 313 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB, 314 "FB_DAMAGE_CLIPS", 0); 315 if (!prop) 316 return -ENOMEM; 317 dev->mode_config.prop_fb_damage_clips = prop; 318 319 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC, 320 "ACTIVE"); 321 if (!prop) 322 return -ENOMEM; 323 dev->mode_config.prop_active = prop; 324 325 prop = drm_property_create(dev, 326 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB, 327 "MODE_ID", 0); 328 if (!prop) 329 return -ENOMEM; 330 dev->mode_config.prop_mode_id = prop; 331 332 prop = drm_property_create_bool(dev, 0, 333 "VRR_ENABLED"); 334 if (!prop) 335 return -ENOMEM; 336 dev->mode_config.prop_vrr_enabled = prop; 337 338 prop = drm_property_create(dev, 339 DRM_MODE_PROP_BLOB, 340 "DEGAMMA_LUT", 0); 341 if (!prop) 342 return -ENOMEM; 343 dev->mode_config.degamma_lut_property = prop; 344 345 prop = drm_property_create_range(dev, 346 DRM_MODE_PROP_IMMUTABLE, 347 "DEGAMMA_LUT_SIZE", 0, UINT_MAX); 348 if (!prop) 349 return -ENOMEM; 350 dev->mode_config.degamma_lut_size_property = prop; 351 352 prop = drm_property_create(dev, 353 DRM_MODE_PROP_BLOB, 354 "CTM", 0); 355 if (!prop) 356 return -ENOMEM; 357 dev->mode_config.ctm_property = prop; 358 359 prop = drm_property_create(dev, 360 DRM_MODE_PROP_BLOB, 361 "GAMMA_LUT", 0); 362 if (!prop) 363 return -ENOMEM; 364 dev->mode_config.gamma_lut_property = prop; 365 366 prop = drm_property_create_range(dev, 367 DRM_MODE_PROP_IMMUTABLE, 368 "GAMMA_LUT_SIZE", 0, UINT_MAX); 369 if (!prop) 370 return -ENOMEM; 371 dev->mode_config.gamma_lut_size_property = prop; 372 373 prop = drm_property_create(dev, 374 DRM_MODE_PROP_IMMUTABLE | DRM_MODE_PROP_BLOB, 375 "IN_FORMATS", 0); 376 if (!prop) 377 return -ENOMEM; 378 dev->mode_config.modifiers_property = prop; 379 380 return 0; 381 } 382 383 /** 384 * drm_mode_config_init - initialize DRM mode_configuration structure 385 * @dev: DRM device 386 * 387 * Initialize @dev's mode_config structure, used for tracking the graphics 388 * configuration of @dev. 389 * 390 * Since this initializes the modeset locks, no locking is possible. Which is no 391 * problem, since this should happen single threaded at init time. It is the 392 * driver's problem to ensure this guarantee. 393 * 394 */ 395 void drm_mode_config_init(struct drm_device *dev) 396 { 397 mutex_init(&dev->mode_config.mutex); 398 drm_modeset_lock_init(&dev->mode_config.connection_mutex); 399 mutex_init(&dev->mode_config.idr_mutex); 400 mutex_init(&dev->mode_config.fb_lock); 401 mutex_init(&dev->mode_config.blob_lock); 402 INIT_LIST_HEAD(&dev->mode_config.fb_list); 403 INIT_LIST_HEAD(&dev->mode_config.crtc_list); 404 INIT_LIST_HEAD(&dev->mode_config.connector_list); 405 INIT_LIST_HEAD(&dev->mode_config.encoder_list); 406 INIT_LIST_HEAD(&dev->mode_config.property_list); 407 INIT_LIST_HEAD(&dev->mode_config.property_blob_list); 408 INIT_LIST_HEAD(&dev->mode_config.plane_list); 409 INIT_LIST_HEAD(&dev->mode_config.privobj_list); 410 idr_init(&dev->mode_config.object_idr); 411 idr_init(&dev->mode_config.tile_idr); 412 ida_init(&dev->mode_config.connector_ida); 413 spin_lock_init(&dev->mode_config.connector_list_lock); 414 415 init_llist_head(&dev->mode_config.connector_free_list); 416 INIT_WORK(&dev->mode_config.connector_free_work, drm_connector_free_work_fn); 417 418 drm_mode_create_standard_properties(dev); 419 420 /* Just to be sure */ 421 dev->mode_config.num_fb = 0; 422 dev->mode_config.num_connector = 0; 423 dev->mode_config.num_crtc = 0; 424 dev->mode_config.num_encoder = 0; 425 dev->mode_config.num_total_plane = 0; 426 427 if (IS_ENABLED(CONFIG_LOCKDEP)) { 428 struct drm_modeset_acquire_ctx modeset_ctx; 429 struct ww_acquire_ctx resv_ctx; 430 struct dma_resv resv; 431 int ret; 432 433 dma_resv_init(&resv); 434 435 drm_modeset_acquire_init(&modeset_ctx, 0); 436 ret = drm_modeset_lock(&dev->mode_config.connection_mutex, 437 &modeset_ctx); 438 if (ret == -EDEADLK) 439 ret = drm_modeset_backoff(&modeset_ctx); 440 441 ww_acquire_init(&resv_ctx, &reservation_ww_class); 442 ret = dma_resv_lock(&resv, &resv_ctx); 443 if (ret == -EDEADLK) 444 dma_resv_lock_slow(&resv, &resv_ctx); 445 446 dma_resv_unlock(&resv); 447 ww_acquire_fini(&resv_ctx); 448 449 drm_modeset_drop_locks(&modeset_ctx); 450 drm_modeset_acquire_fini(&modeset_ctx); 451 dma_resv_fini(&resv); 452 } 453 } 454 EXPORT_SYMBOL(drm_mode_config_init); 455 456 /** 457 * drm_mode_config_cleanup - free up DRM mode_config info 458 * @dev: DRM device 459 * 460 * Free up all the connectors and CRTCs associated with this DRM device, then 461 * free up the framebuffers and associated buffer objects. 462 * 463 * Note that since this /should/ happen single-threaded at driver/device 464 * teardown time, no locking is required. It's the driver's job to ensure that 465 * this guarantee actually holds true. 466 */ 467 void drm_mode_config_cleanup(struct drm_device *dev) 468 { 469 struct drm_connector *connector; 470 struct drm_connector_list_iter conn_iter; 471 struct drm_crtc *crtc, *ct; 472 struct drm_encoder *encoder, *enct; 473 struct drm_framebuffer *fb, *fbt; 474 struct drm_property *property, *pt; 475 struct drm_property_blob *blob, *bt; 476 struct drm_plane *plane, *plt; 477 478 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list, 479 head) { 480 encoder->funcs->destroy(encoder); 481 } 482 483 drm_connector_list_iter_begin(dev, &conn_iter); 484 drm_for_each_connector_iter(connector, &conn_iter) { 485 /* drm_connector_list_iter holds an full reference to the 486 * current connector itself, which means it is inherently safe 487 * against unreferencing the current connector - but not against 488 * deleting it right away. */ 489 drm_connector_put(connector); 490 } 491 drm_connector_list_iter_end(&conn_iter); 492 /* connector_iter drops references in a work item. */ 493 flush_work(&dev->mode_config.connector_free_work); 494 if (WARN_ON(!list_empty(&dev->mode_config.connector_list))) { 495 drm_connector_list_iter_begin(dev, &conn_iter); 496 drm_for_each_connector_iter(connector, &conn_iter) 497 DRM_ERROR("connector %s leaked!\n", connector->name); 498 drm_connector_list_iter_end(&conn_iter); 499 } 500 501 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list, 502 head) { 503 drm_property_destroy(dev, property); 504 } 505 506 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list, 507 head) { 508 plane->funcs->destroy(plane); 509 } 510 511 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) { 512 crtc->funcs->destroy(crtc); 513 } 514 515 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list, 516 head_global) { 517 drm_property_blob_put(blob); 518 } 519 520 /* 521 * Single-threaded teardown context, so it's not required to grab the 522 * fb_lock to protect against concurrent fb_list access. Contrary, it 523 * would actually deadlock with the drm_framebuffer_cleanup function. 524 * 525 * Also, if there are any framebuffers left, that's a driver leak now, 526 * so politely WARN about this. 527 */ 528 WARN_ON(!list_empty(&dev->mode_config.fb_list)); 529 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) { 530 struct drm_printer p = drm_debug_printer("[leaked fb]"); 531 drm_printf(&p, "framebuffer[%u]:\n", fb->base.id); 532 drm_framebuffer_print_info(&p, 1, fb); 533 drm_framebuffer_free(&fb->base.refcount); 534 } 535 536 spin_lock_destroy(&dev->mode_config.connector_list_lock); 537 ida_destroy(&dev->mode_config.connector_ida); 538 idr_destroy(&dev->mode_config.tile_idr); 539 idr_destroy(&dev->mode_config.object_idr); 540 mutex_destroy(&dev->mode_config.blob_lock); 541 mutex_destroy(&dev->mode_config.fb_lock); 542 mutex_destroy(&dev->mode_config.idr_mutex); 543 drm_modeset_lock_fini(&dev->mode_config.connection_mutex); 544 mutex_destroy(&dev->mode_config.mutex); 545 } 546 EXPORT_SYMBOL(drm_mode_config_cleanup); 547