1 /* 2 * Copyright (C) 2014 Intel Corporation 3 * 4 * DRM universal plane helper functions 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the "Software"), 8 * to deal in the Software without restriction, including without limitation 9 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 10 * and/or sell copies of the Software, and to permit persons to whom the 11 * Software is furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice (including the next 14 * paragraph) shall be included in all copies or substantial portions of the 15 * Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 * SOFTWARE. 24 */ 25 26 #include <linux/list.h> 27 #include <drm/drmP.h> 28 #include <drm/drm_plane_helper.h> 29 #include <drm/drm_rect.h> 30 #include <drm/drm_atomic.h> 31 #include <drm/drm_crtc_helper.h> 32 #include <drm/drm_atomic_helper.h> 33 34 #define SUBPIXEL_MASK 0xffff 35 36 /** 37 * DOC: overview 38 * 39 * This helper library has two parts. The first part has support to implement 40 * primary plane support on top of the normal CRTC configuration interface. 41 * Since the legacy ->set_config interface ties the primary plane together with 42 * the CRTC state this does not allow userspace to disable the primary plane 43 * itself. To avoid too much duplicated code use 44 * drm_plane_helper_check_update() which can be used to enforce the same 45 * restrictions as primary planes had thus. The default primary plane only 46 * expose XRBG8888 and ARGB8888 as valid pixel formats for the attached 47 * framebuffer. 48 * 49 * Drivers are highly recommended to implement proper support for primary 50 * planes, and newly merged drivers must not rely upon these transitional 51 * helpers. 52 * 53 * The second part also implements transitional helpers which allow drivers to 54 * gradually switch to the atomic helper infrastructure for plane updates. Once 55 * that switch is complete drivers shouldn't use these any longer, instead using 56 * the proper legacy implementations for update and disable plane hooks provided 57 * by the atomic helpers. 58 * 59 * Again drivers are strongly urged to switch to the new interfaces. 60 * 61 * The plane helpers share the function table structures with other helpers, 62 * specifically also the atomic helpers. See struct &drm_plane_helper_funcs for 63 * the details. 64 */ 65 66 /* 67 * This is the minimal list of formats that seem to be safe for modeset use 68 * with all current DRM drivers. Most hardware can actually support more 69 * formats than this and drivers may specify a more accurate list when 70 * creating the primary plane. However drivers that still call 71 * drm_plane_init() will use this minimal format list as the default. 72 */ 73 static const uint32_t safe_modeset_formats[] = { 74 DRM_FORMAT_XRGB8888, 75 DRM_FORMAT_ARGB8888, 76 }; 77 78 /* 79 * Returns the connectors currently associated with a CRTC. This function 80 * should be called twice: once with a NULL connector list to retrieve 81 * the list size, and once with the properly allocated list to be filled in. 82 */ 83 static int get_connectors_for_crtc(struct drm_crtc *crtc, 84 struct drm_connector **connector_list, 85 int num_connectors) 86 { 87 struct drm_device *dev = crtc->dev; 88 struct drm_connector *connector; 89 int count = 0; 90 91 /* 92 * Note: Once we change the plane hooks to more fine-grained locking we 93 * need to grab the connection_mutex here to be able to make these 94 * checks. 95 */ 96 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex)); 97 98 drm_for_each_connector(connector, dev) { 99 if (connector->encoder && connector->encoder->crtc == crtc) { 100 if (connector_list != NULL && count < num_connectors) 101 *(connector_list++) = connector; 102 103 count++; 104 } 105 } 106 107 return count; 108 } 109 110 /** 111 * drm_plane_helper_check_update() - Check plane update for validity 112 * @plane: plane object to update 113 * @crtc: owning CRTC of owning plane 114 * @fb: framebuffer to flip onto plane 115 * @src: source coordinates in 16.16 fixed point 116 * @dest: integer destination coordinates 117 * @clip: integer clipping coordinates 118 * @rotation: plane rotation 119 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point 120 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point 121 * @can_position: is it legal to position the plane such that it 122 * doesn't cover the entire crtc? This will generally 123 * only be false for primary planes. 124 * @can_update_disabled: can the plane be updated while the crtc 125 * is disabled? 126 * @visible: output parameter indicating whether plane is still visible after 127 * clipping 128 * 129 * Checks that a desired plane update is valid. Drivers that provide 130 * their own plane handling rather than helper-provided implementations may 131 * still wish to call this function to avoid duplication of error checking 132 * code. 133 * 134 * RETURNS: 135 * Zero if update appears valid, error code on failure 136 */ 137 int drm_plane_helper_check_update(struct drm_plane *plane, 138 struct drm_crtc *crtc, 139 struct drm_framebuffer *fb, 140 struct drm_rect *src, 141 struct drm_rect *dest, 142 const struct drm_rect *clip, 143 unsigned int rotation, 144 int min_scale, 145 int max_scale, 146 bool can_position, 147 bool can_update_disabled, 148 bool *visible) 149 { 150 int hscale, vscale; 151 152 if (!fb) { 153 *visible = false; 154 return 0; 155 } 156 157 /* crtc should only be NULL when disabling (i.e., !fb) */ 158 if (WARN_ON(!crtc)) { 159 *visible = false; 160 return 0; 161 } 162 163 if (!crtc->enabled && !can_update_disabled) { 164 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n"); 165 return -EINVAL; 166 } 167 168 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation); 169 170 /* Check scaling */ 171 hscale = drm_rect_calc_hscale(src, dest, min_scale, max_scale); 172 vscale = drm_rect_calc_vscale(src, dest, min_scale, max_scale); 173 if (hscale < 0 || vscale < 0) { 174 DRM_DEBUG_KMS("Invalid scaling of plane\n"); 175 drm_rect_debug_print("src: ", src, true); 176 drm_rect_debug_print("dst: ", dest, false); 177 return -ERANGE; 178 } 179 180 *visible = drm_rect_clip_scaled(src, dest, clip, hscale, vscale); 181 182 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation); 183 184 if (!*visible) 185 /* 186 * Plane isn't visible; some drivers can handle this 187 * so we just return success here. Drivers that can't 188 * (including those that use the primary plane helper's 189 * update function) will return an error from their 190 * update_plane handler. 191 */ 192 return 0; 193 194 if (!can_position && !drm_rect_equals(dest, clip)) { 195 DRM_DEBUG_KMS("Plane must cover entire CRTC\n"); 196 drm_rect_debug_print("dst: ", dest, false); 197 drm_rect_debug_print("clip: ", clip, false); 198 return -EINVAL; 199 } 200 201 return 0; 202 } 203 EXPORT_SYMBOL(drm_plane_helper_check_update); 204 205 /** 206 * drm_primary_helper_update() - Helper for primary plane update 207 * @plane: plane object to update 208 * @crtc: owning CRTC of owning plane 209 * @fb: framebuffer to flip onto plane 210 * @crtc_x: x offset of primary plane on crtc 211 * @crtc_y: y offset of primary plane on crtc 212 * @crtc_w: width of primary plane rectangle on crtc 213 * @crtc_h: height of primary plane rectangle on crtc 214 * @src_x: x offset of @fb for panning 215 * @src_y: y offset of @fb for panning 216 * @src_w: width of source rectangle in @fb 217 * @src_h: height of source rectangle in @fb 218 * 219 * Provides a default plane update handler for primary planes. This is handler 220 * is called in response to a userspace SetPlane operation on the plane with a 221 * non-NULL framebuffer. We call the driver's modeset handler to update the 222 * framebuffer. 223 * 224 * SetPlane() on a primary plane of a disabled CRTC is not supported, and will 225 * return an error. 226 * 227 * Note that we make some assumptions about hardware limitations that may not be 228 * true for all hardware -- 229 * 230 * 1. Primary plane cannot be repositioned. 231 * 2. Primary plane cannot be scaled. 232 * 3. Primary plane must cover the entire CRTC. 233 * 4. Subpixel positioning is not supported. 234 * 235 * Drivers for hardware that don't have these restrictions can provide their 236 * own implementation rather than using this helper. 237 * 238 * RETURNS: 239 * Zero on success, error code on failure 240 */ 241 int drm_primary_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, 242 struct drm_framebuffer *fb, 243 int crtc_x, int crtc_y, 244 unsigned int crtc_w, unsigned int crtc_h, 245 uint32_t src_x, uint32_t src_y, 246 uint32_t src_w, uint32_t src_h) 247 { 248 struct drm_mode_set set = { 249 .crtc = crtc, 250 .fb = fb, 251 .mode = &crtc->mode, 252 .x = src_x >> 16, 253 .y = src_y >> 16, 254 }; 255 struct drm_rect src = { 256 .x1 = src_x, 257 .y1 = src_y, 258 .x2 = src_x + src_w, 259 .y2 = src_y + src_h, 260 }; 261 struct drm_rect dest = { 262 .x1 = crtc_x, 263 .y1 = crtc_y, 264 .x2 = crtc_x + crtc_w, 265 .y2 = crtc_y + crtc_h, 266 }; 267 const struct drm_rect clip = { 268 .x2 = crtc->mode.hdisplay, 269 .y2 = crtc->mode.vdisplay, 270 }; 271 struct drm_connector **connector_list; 272 int num_connectors, ret; 273 bool visible; 274 275 ret = drm_plane_helper_check_update(plane, crtc, fb, 276 &src, &dest, &clip, 277 BIT(DRM_ROTATE_0), 278 DRM_PLANE_HELPER_NO_SCALING, 279 DRM_PLANE_HELPER_NO_SCALING, 280 false, false, &visible); 281 if (ret) 282 return ret; 283 284 if (!visible) 285 /* 286 * Primary plane isn't visible. Note that unless a driver 287 * provides their own disable function, this will just 288 * wind up returning -EINVAL to userspace. 289 */ 290 return plane->funcs->disable_plane(plane); 291 292 /* Find current connectors for CRTC */ 293 num_connectors = get_connectors_for_crtc(crtc, NULL, 0); 294 BUG_ON(num_connectors == 0); 295 connector_list = kzalloc(num_connectors * sizeof(*connector_list), 296 GFP_KERNEL); 297 if (!connector_list) 298 return -ENOMEM; 299 get_connectors_for_crtc(crtc, connector_list, num_connectors); 300 301 set.connectors = connector_list; 302 set.num_connectors = num_connectors; 303 304 /* 305 * We call set_config() directly here rather than using 306 * drm_mode_set_config_internal. We're reprogramming the same 307 * connectors that were already in use, so we shouldn't need the extra 308 * cross-CRTC fb refcounting to accomodate stealing connectors. 309 * drm_mode_setplane() already handles the basic refcounting for the 310 * framebuffers involved in this operation. 311 */ 312 ret = crtc->funcs->set_config(&set); 313 314 kfree(connector_list); 315 return ret; 316 } 317 EXPORT_SYMBOL(drm_primary_helper_update); 318 319 /** 320 * drm_primary_helper_disable() - Helper for primary plane disable 321 * @plane: plane to disable 322 * 323 * Provides a default plane disable handler for primary planes. This is handler 324 * is called in response to a userspace SetPlane operation on the plane with a 325 * NULL framebuffer parameter. It unconditionally fails the disable call with 326 * -EINVAL the only way to disable the primary plane without driver support is 327 * to disable the entier CRTC. Which does not match the plane ->disable hook. 328 * 329 * Note that some hardware may be able to disable the primary plane without 330 * disabling the whole CRTC. Drivers for such hardware should provide their 331 * own disable handler that disables just the primary plane (and they'll likely 332 * need to provide their own update handler as well to properly re-enable a 333 * disabled primary plane). 334 * 335 * RETURNS: 336 * Unconditionally returns -EINVAL. 337 */ 338 int drm_primary_helper_disable(struct drm_plane *plane) 339 { 340 return -EINVAL; 341 } 342 EXPORT_SYMBOL(drm_primary_helper_disable); 343 344 /** 345 * drm_primary_helper_destroy() - Helper for primary plane destruction 346 * @plane: plane to destroy 347 * 348 * Provides a default plane destroy handler for primary planes. This handler 349 * is called during CRTC destruction. We disable the primary plane, remove 350 * it from the DRM plane list, and deallocate the plane structure. 351 */ 352 void drm_primary_helper_destroy(struct drm_plane *plane) 353 { 354 drm_plane_cleanup(plane); 355 kfree(plane); 356 } 357 EXPORT_SYMBOL(drm_primary_helper_destroy); 358 359 const struct drm_plane_funcs drm_primary_helper_funcs = { 360 .update_plane = drm_primary_helper_update, 361 .disable_plane = drm_primary_helper_disable, 362 .destroy = drm_primary_helper_destroy, 363 }; 364 EXPORT_SYMBOL(drm_primary_helper_funcs); 365 366 static struct drm_plane *create_primary_plane(struct drm_device *dev) 367 { 368 struct drm_plane *primary; 369 int ret; 370 371 primary = kzalloc(sizeof(*primary), GFP_KERNEL); 372 if (primary == NULL) { 373 DRM_DEBUG_KMS("Failed to allocate primary plane\n"); 374 return NULL; 375 } 376 377 /* 378 * Remove the format_default field from drm_plane when dropping 379 * this helper. 380 */ 381 primary->format_default = true; 382 383 /* possible_crtc's will be filled in later by crtc_init */ 384 ret = drm_universal_plane_init(dev, primary, 0, 385 &drm_primary_helper_funcs, 386 safe_modeset_formats, 387 ARRAY_SIZE(safe_modeset_formats), 388 DRM_PLANE_TYPE_PRIMARY, NULL); 389 if (ret) { 390 kfree(primary); 391 primary = NULL; 392 } 393 394 return primary; 395 } 396 397 /** 398 * drm_crtc_init - Legacy CRTC initialization function 399 * @dev: DRM device 400 * @crtc: CRTC object to init 401 * @funcs: callbacks for the new CRTC 402 * 403 * Initialize a CRTC object with a default helper-provided primary plane and no 404 * cursor plane. 405 * 406 * Returns: 407 * Zero on success, error code on failure. 408 */ 409 int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc, 410 const struct drm_crtc_funcs *funcs) 411 { 412 struct drm_plane *primary; 413 414 primary = create_primary_plane(dev); 415 return drm_crtc_init_with_planes(dev, crtc, primary, NULL, funcs, 416 NULL); 417 } 418 EXPORT_SYMBOL(drm_crtc_init); 419 420 int drm_plane_helper_commit(struct drm_plane *plane, 421 struct drm_plane_state *plane_state, 422 struct drm_framebuffer *old_fb) 423 { 424 const struct drm_plane_helper_funcs *plane_funcs; 425 struct drm_crtc *crtc[2]; 426 const struct drm_crtc_helper_funcs *crtc_funcs[2]; 427 int i, ret = 0; 428 429 plane_funcs = plane->helper_private; 430 431 /* Since this is a transitional helper we can't assume that plane->state 432 * is always valid. Hence we need to use plane->crtc instead of 433 * plane->state->crtc as the old crtc. */ 434 crtc[0] = plane->crtc; 435 crtc[1] = crtc[0] != plane_state->crtc ? plane_state->crtc : NULL; 436 437 for (i = 0; i < 2; i++) 438 crtc_funcs[i] = crtc[i] ? crtc[i]->helper_private : NULL; 439 440 if (plane_funcs->atomic_check) { 441 ret = plane_funcs->atomic_check(plane, plane_state); 442 if (ret) 443 goto out; 444 } 445 446 if (plane_funcs->prepare_fb && plane_state->fb && 447 plane_state->fb != old_fb) { 448 ret = plane_funcs->prepare_fb(plane, 449 plane_state); 450 if (ret) 451 goto out; 452 } 453 454 /* Point of no return, commit sw state. */ 455 swap(plane->state, plane_state); 456 457 for (i = 0; i < 2; i++) { 458 if (crtc_funcs[i] && crtc_funcs[i]->atomic_begin) 459 crtc_funcs[i]->atomic_begin(crtc[i], crtc[i]->state); 460 } 461 462 /* 463 * Drivers may optionally implement the ->atomic_disable callback, so 464 * special-case that here. 465 */ 466 if (drm_atomic_plane_disabling(plane, plane_state) && 467 plane_funcs->atomic_disable) 468 plane_funcs->atomic_disable(plane, plane_state); 469 else 470 plane_funcs->atomic_update(plane, plane_state); 471 472 for (i = 0; i < 2; i++) { 473 if (crtc_funcs[i] && crtc_funcs[i]->atomic_flush) 474 crtc_funcs[i]->atomic_flush(crtc[i], crtc[i]->state); 475 } 476 477 /* 478 * If we only moved the plane and didn't change fb's, there's no need to 479 * wait for vblank. 480 */ 481 if (plane->state->fb == old_fb) 482 goto out; 483 484 for (i = 0; i < 2; i++) { 485 if (!crtc[i]) 486 continue; 487 488 if (crtc[i]->cursor == plane) 489 continue; 490 491 /* There's no other way to figure out whether the crtc is running. */ 492 ret = drm_crtc_vblank_get(crtc[i]); 493 if (ret == 0) { 494 drm_crtc_wait_one_vblank(crtc[i]); 495 drm_crtc_vblank_put(crtc[i]); 496 } 497 498 ret = 0; 499 } 500 501 if (plane_funcs->cleanup_fb) 502 plane_funcs->cleanup_fb(plane, plane_state); 503 out: 504 if (plane_state) { 505 if (plane->funcs->atomic_destroy_state) 506 plane->funcs->atomic_destroy_state(plane, plane_state); 507 else 508 drm_atomic_helper_plane_destroy_state(plane, plane_state); 509 } 510 511 return ret; 512 } 513 514 /** 515 * drm_plane_helper_update() - Transitional helper for plane update 516 * @plane: plane object to update 517 * @crtc: owning CRTC of owning plane 518 * @fb: framebuffer to flip onto plane 519 * @crtc_x: x offset of primary plane on crtc 520 * @crtc_y: y offset of primary plane on crtc 521 * @crtc_w: width of primary plane rectangle on crtc 522 * @crtc_h: height of primary plane rectangle on crtc 523 * @src_x: x offset of @fb for panning 524 * @src_y: y offset of @fb for panning 525 * @src_w: width of source rectangle in @fb 526 * @src_h: height of source rectangle in @fb 527 * 528 * Provides a default plane update handler using the atomic plane update 529 * functions. It is fully left to the driver to check plane constraints and 530 * handle corner-cases like a fully occluded or otherwise invisible plane. 531 * 532 * This is useful for piecewise transitioning of a driver to the atomic helpers. 533 * 534 * RETURNS: 535 * Zero on success, error code on failure 536 */ 537 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, 538 struct drm_framebuffer *fb, 539 int crtc_x, int crtc_y, 540 unsigned int crtc_w, unsigned int crtc_h, 541 uint32_t src_x, uint32_t src_y, 542 uint32_t src_w, uint32_t src_h) 543 { 544 struct drm_plane_state *plane_state; 545 546 if (plane->funcs->atomic_duplicate_state) 547 plane_state = plane->funcs->atomic_duplicate_state(plane); 548 else { 549 if (!plane->state) 550 drm_atomic_helper_plane_reset(plane); 551 552 plane_state = drm_atomic_helper_plane_duplicate_state(plane); 553 } 554 if (!plane_state) 555 return -ENOMEM; 556 plane_state->plane = plane; 557 558 plane_state->crtc = crtc; 559 drm_atomic_set_fb_for_plane(plane_state, fb); 560 plane_state->crtc_x = crtc_x; 561 plane_state->crtc_y = crtc_y; 562 plane_state->crtc_h = crtc_h; 563 plane_state->crtc_w = crtc_w; 564 plane_state->src_x = src_x; 565 plane_state->src_y = src_y; 566 plane_state->src_h = src_h; 567 plane_state->src_w = src_w; 568 569 return drm_plane_helper_commit(plane, plane_state, plane->fb); 570 } 571 EXPORT_SYMBOL(drm_plane_helper_update); 572 573 /** 574 * drm_plane_helper_disable() - Transitional helper for plane disable 575 * @plane: plane to disable 576 * 577 * Provides a default plane disable handler using the atomic plane update 578 * functions. It is fully left to the driver to check plane constraints and 579 * handle corner-cases like a fully occluded or otherwise invisible plane. 580 * 581 * This is useful for piecewise transitioning of a driver to the atomic helpers. 582 * 583 * RETURNS: 584 * Zero on success, error code on failure 585 */ 586 int drm_plane_helper_disable(struct drm_plane *plane) 587 { 588 struct drm_plane_state *plane_state; 589 590 /* crtc helpers love to call disable functions for already disabled hw 591 * functions. So cope with that. */ 592 if (!plane->crtc) 593 return 0; 594 595 if (plane->funcs->atomic_duplicate_state) 596 plane_state = plane->funcs->atomic_duplicate_state(plane); 597 else { 598 if (!plane->state) 599 drm_atomic_helper_plane_reset(plane); 600 601 plane_state = drm_atomic_helper_plane_duplicate_state(plane); 602 } 603 if (!plane_state) 604 return -ENOMEM; 605 plane_state->plane = plane; 606 607 plane_state->crtc = NULL; 608 drm_atomic_set_fb_for_plane(plane_state, NULL); 609 610 return drm_plane_helper_commit(plane, plane_state, plane->fb); 611 } 612 EXPORT_SYMBOL(drm_plane_helper_disable); 613