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 * Returns the connectors currently associated with a CRTC. This function 68 * should be called twice: once with a NULL connector list to retrieve 69 * the list size, and once with the properly allocated list to be filled in. 70 */ 71 static int get_connectors_for_crtc(struct drm_crtc *crtc, 72 struct drm_connector **connector_list, 73 int num_connectors) 74 { 75 struct drm_device *dev = crtc->dev; 76 struct drm_connector *connector; 77 int count = 0; 78 79 /* 80 * Note: Once we change the plane hooks to more fine-grained locking we 81 * need to grab the connection_mutex here to be able to make these 82 * checks. 83 */ 84 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex)); 85 86 drm_for_each_connector(connector, dev) { 87 if (connector->encoder && connector->encoder->crtc == crtc) { 88 if (connector_list != NULL && count < num_connectors) 89 *(connector_list++) = connector; 90 91 count++; 92 } 93 } 94 95 return count; 96 } 97 98 /** 99 * drm_plane_helper_check_state() - Check plane state for validity 100 * @state: plane state to check 101 * @clip: integer clipping coordinates 102 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point 103 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point 104 * @can_position: is it legal to position the plane such that it 105 * doesn't cover the entire crtc? This will generally 106 * only be false for primary planes. 107 * @can_update_disabled: can the plane be updated while the crtc 108 * is disabled? 109 * 110 * Checks that a desired plane update is valid, and updates various 111 * bits of derived state (clipped coordinates etc.). Drivers that provide 112 * their own plane handling rather than helper-provided implementations may 113 * still wish to call this function to avoid duplication of error checking 114 * code. 115 * 116 * RETURNS: 117 * Zero if update appears valid, error code on failure 118 */ 119 int drm_plane_helper_check_state(struct drm_plane_state *state, 120 const struct drm_rect *clip, 121 int min_scale, 122 int max_scale, 123 bool can_position, 124 bool can_update_disabled) 125 { 126 struct drm_crtc *crtc = state->crtc; 127 struct drm_framebuffer *fb = state->fb; 128 struct drm_rect *src = &state->src; 129 struct drm_rect *dst = &state->dst; 130 unsigned int rotation = state->rotation; 131 int hscale, vscale; 132 133 src->x1 = state->src_x; 134 src->y1 = state->src_y; 135 src->x2 = state->src_x + state->src_w; 136 src->y2 = state->src_y + state->src_h; 137 138 dst->x1 = state->crtc_x; 139 dst->y1 = state->crtc_y; 140 dst->x2 = state->crtc_x + state->crtc_w; 141 dst->y2 = state->crtc_y + state->crtc_h; 142 143 if (!fb) { 144 state->visible = false; 145 return 0; 146 } 147 148 /* crtc should only be NULL when disabling (i.e., !fb) */ 149 if (WARN_ON(!crtc)) { 150 state->visible = false; 151 return 0; 152 } 153 154 if (!crtc->enabled && !can_update_disabled) { 155 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n"); 156 return -EINVAL; 157 } 158 159 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation); 160 161 /* Check scaling */ 162 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale); 163 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale); 164 if (hscale < 0 || vscale < 0) { 165 DRM_DEBUG_KMS("Invalid scaling of plane\n"); 166 drm_rect_debug_print("src: ", &state->src, true); 167 drm_rect_debug_print("dst: ", &state->dst, false); 168 return -ERANGE; 169 } 170 171 state->visible = drm_rect_clip_scaled(src, dst, clip, hscale, vscale); 172 173 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation); 174 175 if (!state->visible) 176 /* 177 * Plane isn't visible; some drivers can handle this 178 * so we just return success here. Drivers that can't 179 * (including those that use the primary plane helper's 180 * update function) will return an error from their 181 * update_plane handler. 182 */ 183 return 0; 184 185 if (!can_position && !drm_rect_equals(dst, clip)) { 186 DRM_DEBUG_KMS("Plane must cover entire CRTC\n"); 187 drm_rect_debug_print("dst: ", dst, false); 188 drm_rect_debug_print("clip: ", clip, false); 189 return -EINVAL; 190 } 191 192 return 0; 193 } 194 EXPORT_SYMBOL(drm_plane_helper_check_state); 195 196 /** 197 * drm_plane_helper_check_update() - Check plane update for validity 198 * @plane: plane object to update 199 * @crtc: owning CRTC of owning plane 200 * @fb: framebuffer to flip onto plane 201 * @src: source coordinates in 16.16 fixed point 202 * @dst: integer destination coordinates 203 * @clip: integer clipping coordinates 204 * @rotation: plane rotation 205 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point 206 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point 207 * @can_position: is it legal to position the plane such that it 208 * doesn't cover the entire crtc? This will generally 209 * only be false for primary planes. 210 * @can_update_disabled: can the plane be updated while the crtc 211 * is disabled? 212 * @visible: output parameter indicating whether plane is still visible after 213 * clipping 214 * 215 * Checks that a desired plane update is valid. Drivers that provide 216 * their own plane handling rather than helper-provided implementations may 217 * still wish to call this function to avoid duplication of error checking 218 * code. 219 * 220 * RETURNS: 221 * Zero if update appears valid, error code on failure 222 */ 223 int drm_plane_helper_check_update(struct drm_plane *plane, 224 struct drm_crtc *crtc, 225 struct drm_framebuffer *fb, 226 struct drm_rect *src, 227 struct drm_rect *dst, 228 const struct drm_rect *clip, 229 unsigned int rotation, 230 int min_scale, 231 int max_scale, 232 bool can_position, 233 bool can_update_disabled, 234 bool *visible) 235 { 236 struct drm_plane_state state = { 237 .plane = plane, 238 .crtc = crtc, 239 .fb = fb, 240 .src_x = src->x1, 241 .src_y = src->y1, 242 .src_w = drm_rect_width(src), 243 .src_h = drm_rect_height(src), 244 .crtc_x = dst->x1, 245 .crtc_y = dst->y1, 246 .crtc_w = drm_rect_width(dst), 247 .crtc_h = drm_rect_height(dst), 248 .rotation = rotation, 249 .visible = *visible, 250 }; 251 int ret; 252 253 ret = drm_plane_helper_check_state(&state, clip, 254 min_scale, max_scale, 255 can_position, 256 can_update_disabled); 257 if (ret) 258 return ret; 259 260 *src = state.src; 261 *dst = state.dst; 262 *visible = state.visible; 263 264 return 0; 265 } 266 EXPORT_SYMBOL(drm_plane_helper_check_update); 267 268 /** 269 * drm_primary_helper_update() - Helper for primary plane update 270 * @plane: plane object to update 271 * @crtc: owning CRTC of owning plane 272 * @fb: framebuffer to flip onto plane 273 * @crtc_x: x offset of primary plane on crtc 274 * @crtc_y: y offset of primary plane on crtc 275 * @crtc_w: width of primary plane rectangle on crtc 276 * @crtc_h: height of primary plane rectangle on crtc 277 * @src_x: x offset of @fb for panning 278 * @src_y: y offset of @fb for panning 279 * @src_w: width of source rectangle in @fb 280 * @src_h: height of source rectangle in @fb 281 * 282 * Provides a default plane update handler for primary planes. This is handler 283 * is called in response to a userspace SetPlane operation on the plane with a 284 * non-NULL framebuffer. We call the driver's modeset handler to update the 285 * framebuffer. 286 * 287 * SetPlane() on a primary plane of a disabled CRTC is not supported, and will 288 * return an error. 289 * 290 * Note that we make some assumptions about hardware limitations that may not be 291 * true for all hardware -- 292 * 293 * 1. Primary plane cannot be repositioned. 294 * 2. Primary plane cannot be scaled. 295 * 3. Primary plane must cover the entire CRTC. 296 * 4. Subpixel positioning is not supported. 297 * 298 * Drivers for hardware that don't have these restrictions can provide their 299 * own implementation rather than using this helper. 300 * 301 * RETURNS: 302 * Zero on success, error code on failure 303 */ 304 int drm_primary_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, 305 struct drm_framebuffer *fb, 306 int crtc_x, int crtc_y, 307 unsigned int crtc_w, unsigned int crtc_h, 308 uint32_t src_x, uint32_t src_y, 309 uint32_t src_w, uint32_t src_h) 310 { 311 struct drm_mode_set set = { 312 .crtc = crtc, 313 .fb = fb, 314 .mode = &crtc->mode, 315 .x = src_x >> 16, 316 .y = src_y >> 16, 317 }; 318 struct drm_rect src = { 319 .x1 = src_x, 320 .y1 = src_y, 321 .x2 = src_x + src_w, 322 .y2 = src_y + src_h, 323 }; 324 struct drm_rect dest = { 325 .x1 = crtc_x, 326 .y1 = crtc_y, 327 .x2 = crtc_x + crtc_w, 328 .y2 = crtc_y + crtc_h, 329 }; 330 const struct drm_rect clip = { 331 .x2 = crtc->mode.hdisplay, 332 .y2 = crtc->mode.vdisplay, 333 }; 334 struct drm_connector **connector_list; 335 int num_connectors, ret; 336 bool visible; 337 338 ret = drm_plane_helper_check_update(plane, crtc, fb, 339 &src, &dest, &clip, 340 DRM_ROTATE_0, 341 DRM_PLANE_HELPER_NO_SCALING, 342 DRM_PLANE_HELPER_NO_SCALING, 343 false, false, &visible); 344 if (ret) 345 return ret; 346 347 if (!visible) 348 /* 349 * Primary plane isn't visible. Note that unless a driver 350 * provides their own disable function, this will just 351 * wind up returning -EINVAL to userspace. 352 */ 353 return plane->funcs->disable_plane(plane); 354 355 /* Find current connectors for CRTC */ 356 num_connectors = get_connectors_for_crtc(crtc, NULL, 0); 357 BUG_ON(num_connectors == 0); 358 connector_list = kzalloc(num_connectors * sizeof(*connector_list), 359 GFP_KERNEL); 360 if (!connector_list) 361 return -ENOMEM; 362 get_connectors_for_crtc(crtc, connector_list, num_connectors); 363 364 set.connectors = connector_list; 365 set.num_connectors = num_connectors; 366 367 /* 368 * We call set_config() directly here rather than using 369 * drm_mode_set_config_internal. We're reprogramming the same 370 * connectors that were already in use, so we shouldn't need the extra 371 * cross-CRTC fb refcounting to accomodate stealing connectors. 372 * drm_mode_setplane() already handles the basic refcounting for the 373 * framebuffers involved in this operation. 374 */ 375 ret = crtc->funcs->set_config(&set); 376 377 kfree(connector_list); 378 return ret; 379 } 380 EXPORT_SYMBOL(drm_primary_helper_update); 381 382 /** 383 * drm_primary_helper_disable() - Helper for primary plane disable 384 * @plane: plane to disable 385 * 386 * Provides a default plane disable handler for primary planes. This is handler 387 * is called in response to a userspace SetPlane operation on the plane with a 388 * NULL framebuffer parameter. It unconditionally fails the disable call with 389 * -EINVAL the only way to disable the primary plane without driver support is 390 * to disable the entier CRTC. Which does not match the plane ->disable hook. 391 * 392 * Note that some hardware may be able to disable the primary plane without 393 * disabling the whole CRTC. Drivers for such hardware should provide their 394 * own disable handler that disables just the primary plane (and they'll likely 395 * need to provide their own update handler as well to properly re-enable a 396 * disabled primary plane). 397 * 398 * RETURNS: 399 * Unconditionally returns -EINVAL. 400 */ 401 int drm_primary_helper_disable(struct drm_plane *plane) 402 { 403 return -EINVAL; 404 } 405 EXPORT_SYMBOL(drm_primary_helper_disable); 406 407 /** 408 * drm_primary_helper_destroy() - Helper for primary plane destruction 409 * @plane: plane to destroy 410 * 411 * Provides a default plane destroy handler for primary planes. This handler 412 * is called during CRTC destruction. We disable the primary plane, remove 413 * it from the DRM plane list, and deallocate the plane structure. 414 */ 415 void drm_primary_helper_destroy(struct drm_plane *plane) 416 { 417 drm_plane_cleanup(plane); 418 kfree(plane); 419 } 420 EXPORT_SYMBOL(drm_primary_helper_destroy); 421 422 const struct drm_plane_funcs drm_primary_helper_funcs = { 423 .update_plane = drm_primary_helper_update, 424 .disable_plane = drm_primary_helper_disable, 425 .destroy = drm_primary_helper_destroy, 426 }; 427 EXPORT_SYMBOL(drm_primary_helper_funcs); 428 429 int drm_plane_helper_commit(struct drm_plane *plane, 430 struct drm_plane_state *plane_state, 431 struct drm_framebuffer *old_fb) 432 { 433 const struct drm_plane_helper_funcs *plane_funcs; 434 struct drm_crtc *crtc[2]; 435 const struct drm_crtc_helper_funcs *crtc_funcs[2]; 436 int i, ret = 0; 437 438 plane_funcs = plane->helper_private; 439 440 /* Since this is a transitional helper we can't assume that plane->state 441 * is always valid. Hence we need to use plane->crtc instead of 442 * plane->state->crtc as the old crtc. */ 443 crtc[0] = plane->crtc; 444 crtc[1] = crtc[0] != plane_state->crtc ? plane_state->crtc : NULL; 445 446 for (i = 0; i < 2; i++) 447 crtc_funcs[i] = crtc[i] ? crtc[i]->helper_private : NULL; 448 449 if (plane_funcs->atomic_check) { 450 ret = plane_funcs->atomic_check(plane, plane_state); 451 if (ret) 452 goto out; 453 } 454 455 if (plane_funcs->prepare_fb && plane_state->fb && 456 plane_state->fb != old_fb) { 457 ret = plane_funcs->prepare_fb(plane, 458 plane_state); 459 if (ret) 460 goto out; 461 } 462 463 /* Point of no return, commit sw state. */ 464 swap(plane->state, plane_state); 465 466 for (i = 0; i < 2; i++) { 467 if (crtc_funcs[i] && crtc_funcs[i]->atomic_begin) 468 crtc_funcs[i]->atomic_begin(crtc[i], crtc[i]->state); 469 } 470 471 /* 472 * Drivers may optionally implement the ->atomic_disable callback, so 473 * special-case that here. 474 */ 475 if (drm_atomic_plane_disabling(plane, plane_state) && 476 plane_funcs->atomic_disable) 477 plane_funcs->atomic_disable(plane, plane_state); 478 else 479 plane_funcs->atomic_update(plane, plane_state); 480 481 for (i = 0; i < 2; i++) { 482 if (crtc_funcs[i] && crtc_funcs[i]->atomic_flush) 483 crtc_funcs[i]->atomic_flush(crtc[i], crtc[i]->state); 484 } 485 486 /* 487 * If we only moved the plane and didn't change fb's, there's no need to 488 * wait for vblank. 489 */ 490 if (plane->state->fb == old_fb) 491 goto out; 492 493 for (i = 0; i < 2; i++) { 494 if (!crtc[i]) 495 continue; 496 497 if (crtc[i]->cursor == plane) 498 continue; 499 500 /* There's no other way to figure out whether the crtc is running. */ 501 ret = drm_crtc_vblank_get(crtc[i]); 502 if (ret == 0) { 503 drm_crtc_wait_one_vblank(crtc[i]); 504 drm_crtc_vblank_put(crtc[i]); 505 } 506 507 ret = 0; 508 } 509 510 if (plane_funcs->cleanup_fb) 511 plane_funcs->cleanup_fb(plane, plane_state); 512 out: 513 if (plane_state) { 514 if (plane->funcs->atomic_destroy_state) 515 plane->funcs->atomic_destroy_state(plane, plane_state); 516 else 517 drm_atomic_helper_plane_destroy_state(plane, plane_state); 518 } 519 520 return ret; 521 } 522 523 /** 524 * drm_plane_helper_update() - Transitional helper for plane update 525 * @plane: plane object to update 526 * @crtc: owning CRTC of owning plane 527 * @fb: framebuffer to flip onto plane 528 * @crtc_x: x offset of primary plane on crtc 529 * @crtc_y: y offset of primary plane on crtc 530 * @crtc_w: width of primary plane rectangle on crtc 531 * @crtc_h: height of primary plane rectangle on crtc 532 * @src_x: x offset of @fb for panning 533 * @src_y: y offset of @fb for panning 534 * @src_w: width of source rectangle in @fb 535 * @src_h: height of source rectangle in @fb 536 * 537 * Provides a default plane update handler using the atomic plane update 538 * functions. It is fully left to the driver to check plane constraints and 539 * handle corner-cases like a fully occluded or otherwise invisible plane. 540 * 541 * This is useful for piecewise transitioning of a driver to the atomic helpers. 542 * 543 * RETURNS: 544 * Zero on success, error code on failure 545 */ 546 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc, 547 struct drm_framebuffer *fb, 548 int crtc_x, int crtc_y, 549 unsigned int crtc_w, unsigned int crtc_h, 550 uint32_t src_x, uint32_t src_y, 551 uint32_t src_w, uint32_t src_h) 552 { 553 struct drm_plane_state *plane_state; 554 555 if (plane->funcs->atomic_duplicate_state) 556 plane_state = plane->funcs->atomic_duplicate_state(plane); 557 else { 558 if (!plane->state) 559 drm_atomic_helper_plane_reset(plane); 560 561 plane_state = drm_atomic_helper_plane_duplicate_state(plane); 562 } 563 if (!plane_state) 564 return -ENOMEM; 565 plane_state->plane = plane; 566 567 plane_state->crtc = crtc; 568 drm_atomic_set_fb_for_plane(plane_state, fb); 569 plane_state->crtc_x = crtc_x; 570 plane_state->crtc_y = crtc_y; 571 plane_state->crtc_h = crtc_h; 572 plane_state->crtc_w = crtc_w; 573 plane_state->src_x = src_x; 574 plane_state->src_y = src_y; 575 plane_state->src_h = src_h; 576 plane_state->src_w = src_w; 577 578 return drm_plane_helper_commit(plane, plane_state, plane->fb); 579 } 580 EXPORT_SYMBOL(drm_plane_helper_update); 581 582 /** 583 * drm_plane_helper_disable() - Transitional helper for plane disable 584 * @plane: plane to disable 585 * 586 * Provides a default plane disable handler using the atomic plane update 587 * functions. It is fully left to the driver to check plane constraints and 588 * handle corner-cases like a fully occluded or otherwise invisible plane. 589 * 590 * This is useful for piecewise transitioning of a driver to the atomic helpers. 591 * 592 * RETURNS: 593 * Zero on success, error code on failure 594 */ 595 int drm_plane_helper_disable(struct drm_plane *plane) 596 { 597 struct drm_plane_state *plane_state; 598 599 /* crtc helpers love to call disable functions for already disabled hw 600 * functions. So cope with that. */ 601 if (!plane->crtc) 602 return 0; 603 604 if (plane->funcs->atomic_duplicate_state) 605 plane_state = plane->funcs->atomic_duplicate_state(plane); 606 else { 607 if (!plane->state) 608 drm_atomic_helper_plane_reset(plane); 609 610 plane_state = drm_atomic_helper_plane_duplicate_state(plane); 611 } 612 if (!plane_state) 613 return -ENOMEM; 614 plane_state->plane = plane; 615 616 plane_state->crtc = NULL; 617 drm_atomic_set_fb_for_plane(plane_state, NULL); 618 619 return drm_plane_helper_commit(plane, plane_state, plane->fb); 620 } 621 EXPORT_SYMBOL(drm_plane_helper_disable); 622