2 * Copyright (C) 2014 Intel Corporation
4 * DRM universal plane helper functions
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:
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
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
26 #include <linux/list.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>
34 #define SUBPIXEL_MASK 0xffff
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
49 * Drivers are highly recommended to implement proper support for primary
50 * planes, and newly merged drivers must not rely upon these transitional
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.
59 * Again drivers are strongly urged to switch to the new interfaces.
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
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.
71 static int get_connectors_for_crtc(struct drm_crtc *crtc,
72 struct drm_connector **connector_list,
75 struct drm_device *dev = crtc->dev;
76 struct drm_connector *connector;
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
84 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
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;
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
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
117 * Zero if update appears valid, error code on failure
119 int drm_plane_helper_check_state(struct drm_plane_state *state,
120 const struct drm_rect *clip,
124 bool can_update_disabled)
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;
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;
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;
144 state->visible = false;
148 /* crtc should only be NULL when disabling (i.e., !fb) */
149 if (WARN_ON(!crtc)) {
150 state->visible = false;
154 if (!crtc->enabled && !can_update_disabled) {
155 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
159 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
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);
171 state->visible = drm_rect_clip_scaled(src, dst, clip, hscale, vscale);
173 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
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.
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);
194 EXPORT_SYMBOL(drm_plane_helper_check_state);
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
212 * @visible: output parameter indicating whether plane is still visible after
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
221 * Zero if update appears valid, error code on failure
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,
233 bool can_update_disabled,
236 struct drm_plane_state state = {
242 .src_w = drm_rect_width(src),
243 .src_h = drm_rect_height(src),
246 .crtc_w = drm_rect_width(dst),
247 .crtc_h = drm_rect_height(dst),
248 .rotation = rotation,
252 ret = drm_plane_helper_check_state(&state, clip,
253 min_scale, max_scale,
255 can_update_disabled);
261 *visible = state.visible;
265 EXPORT_SYMBOL(drm_plane_helper_check_update);
268 * drm_primary_helper_update() - Helper for primary plane update
269 * @plane: plane object to update
270 * @crtc: owning CRTC of owning plane
271 * @fb: framebuffer to flip onto plane
272 * @crtc_x: x offset of primary plane on crtc
273 * @crtc_y: y offset of primary plane on crtc
274 * @crtc_w: width of primary plane rectangle on crtc
275 * @crtc_h: height of primary plane rectangle on crtc
276 * @src_x: x offset of @fb for panning
277 * @src_y: y offset of @fb for panning
278 * @src_w: width of source rectangle in @fb
279 * @src_h: height of source rectangle in @fb
281 * Provides a default plane update handler for primary planes. This is handler
282 * is called in response to a userspace SetPlane operation on the plane with a
283 * non-NULL framebuffer. We call the driver's modeset handler to update the
286 * SetPlane() on a primary plane of a disabled CRTC is not supported, and will
289 * Note that we make some assumptions about hardware limitations that may not be
290 * true for all hardware --
292 * 1. Primary plane cannot be repositioned.
293 * 2. Primary plane cannot be scaled.
294 * 3. Primary plane must cover the entire CRTC.
295 * 4. Subpixel positioning is not supported.
297 * Drivers for hardware that don't have these restrictions can provide their
298 * own implementation rather than using this helper.
301 * Zero on success, error code on failure
303 int drm_primary_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
304 struct drm_framebuffer *fb,
305 int crtc_x, int crtc_y,
306 unsigned int crtc_w, unsigned int crtc_h,
307 uint32_t src_x, uint32_t src_y,
308 uint32_t src_w, uint32_t src_h)
310 struct drm_mode_set set = {
317 struct drm_rect src = {
323 struct drm_rect dest = {
326 .x2 = crtc_x + crtc_w,
327 .y2 = crtc_y + crtc_h,
329 const struct drm_rect clip = {
330 .x2 = crtc->mode.hdisplay,
331 .y2 = crtc->mode.vdisplay,
333 struct drm_connector **connector_list;
334 int num_connectors, ret;
337 ret = drm_plane_helper_check_update(plane, crtc, fb,
340 DRM_PLANE_HELPER_NO_SCALING,
341 DRM_PLANE_HELPER_NO_SCALING,
342 false, false, &visible);
348 * Primary plane isn't visible. Note that unless a driver
349 * provides their own disable function, this will just
350 * wind up returning -EINVAL to userspace.
352 return plane->funcs->disable_plane(plane);
354 /* Find current connectors for CRTC */
355 num_connectors = get_connectors_for_crtc(crtc, NULL, 0);
356 BUG_ON(num_connectors == 0);
357 connector_list = kzalloc(num_connectors * sizeof(*connector_list),
361 get_connectors_for_crtc(crtc, connector_list, num_connectors);
363 set.connectors = connector_list;
364 set.num_connectors = num_connectors;
367 * We call set_config() directly here rather than using
368 * drm_mode_set_config_internal. We're reprogramming the same
369 * connectors that were already in use, so we shouldn't need the extra
370 * cross-CRTC fb refcounting to accomodate stealing connectors.
371 * drm_mode_setplane() already handles the basic refcounting for the
372 * framebuffers involved in this operation.
374 ret = crtc->funcs->set_config(&set);
376 kfree(connector_list);
379 EXPORT_SYMBOL(drm_primary_helper_update);
382 * drm_primary_helper_disable() - Helper for primary plane disable
383 * @plane: plane to disable
385 * Provides a default plane disable handler for primary planes. This is handler
386 * is called in response to a userspace SetPlane operation on the plane with a
387 * NULL framebuffer parameter. It unconditionally fails the disable call with
388 * -EINVAL the only way to disable the primary plane without driver support is
389 * to disable the entier CRTC. Which does not match the plane ->disable hook.
391 * Note that some hardware may be able to disable the primary plane without
392 * disabling the whole CRTC. Drivers for such hardware should provide their
393 * own disable handler that disables just the primary plane (and they'll likely
394 * need to provide their own update handler as well to properly re-enable a
395 * disabled primary plane).
398 * Unconditionally returns -EINVAL.
400 int drm_primary_helper_disable(struct drm_plane *plane)
404 EXPORT_SYMBOL(drm_primary_helper_disable);
407 * drm_primary_helper_destroy() - Helper for primary plane destruction
408 * @plane: plane to destroy
410 * Provides a default plane destroy handler for primary planes. This handler
411 * is called during CRTC destruction. We disable the primary plane, remove
412 * it from the DRM plane list, and deallocate the plane structure.
414 void drm_primary_helper_destroy(struct drm_plane *plane)
416 drm_plane_cleanup(plane);
419 EXPORT_SYMBOL(drm_primary_helper_destroy);
421 const struct drm_plane_funcs drm_primary_helper_funcs = {
422 .update_plane = drm_primary_helper_update,
423 .disable_plane = drm_primary_helper_disable,
424 .destroy = drm_primary_helper_destroy,
426 EXPORT_SYMBOL(drm_primary_helper_funcs);
428 int drm_plane_helper_commit(struct drm_plane *plane,
429 struct drm_plane_state *plane_state,
430 struct drm_framebuffer *old_fb)
432 const struct drm_plane_helper_funcs *plane_funcs;
433 struct drm_crtc *crtc[2];
434 const struct drm_crtc_helper_funcs *crtc_funcs[2];
437 plane_funcs = plane->helper_private;
439 /* Since this is a transitional helper we can't assume that plane->state
440 * is always valid. Hence we need to use plane->crtc instead of
441 * plane->state->crtc as the old crtc. */
442 crtc[0] = plane->crtc;
443 crtc[1] = crtc[0] != plane_state->crtc ? plane_state->crtc : NULL;
445 for (i = 0; i < 2; i++)
446 crtc_funcs[i] = crtc[i] ? crtc[i]->helper_private : NULL;
448 if (plane_funcs->atomic_check) {
449 ret = plane_funcs->atomic_check(plane, plane_state);
454 if (plane_funcs->prepare_fb && plane_state->fb &&
455 plane_state->fb != old_fb) {
456 ret = plane_funcs->prepare_fb(plane,
462 /* Point of no return, commit sw state. */
463 swap(plane->state, plane_state);
465 for (i = 0; i < 2; i++) {
466 if (crtc_funcs[i] && crtc_funcs[i]->atomic_begin)
467 crtc_funcs[i]->atomic_begin(crtc[i], crtc[i]->state);
471 * Drivers may optionally implement the ->atomic_disable callback, so
472 * special-case that here.
474 if (drm_atomic_plane_disabling(plane, plane_state) &&
475 plane_funcs->atomic_disable)
476 plane_funcs->atomic_disable(plane, plane_state);
478 plane_funcs->atomic_update(plane, plane_state);
480 for (i = 0; i < 2; i++) {
481 if (crtc_funcs[i] && crtc_funcs[i]->atomic_flush)
482 crtc_funcs[i]->atomic_flush(crtc[i], crtc[i]->state);
486 * If we only moved the plane and didn't change fb's, there's no need to
489 if (plane->state->fb == old_fb)
492 for (i = 0; i < 2; i++) {
496 if (crtc[i]->cursor == plane)
499 /* There's no other way to figure out whether the crtc is running. */
500 ret = drm_crtc_vblank_get(crtc[i]);
502 drm_crtc_wait_one_vblank(crtc[i]);
503 drm_crtc_vblank_put(crtc[i]);
509 if (plane_funcs->cleanup_fb)
510 plane_funcs->cleanup_fb(plane, plane_state);
513 if (plane->funcs->atomic_destroy_state)
514 plane->funcs->atomic_destroy_state(plane, plane_state);
516 drm_atomic_helper_plane_destroy_state(plane, plane_state);
523 * drm_plane_helper_update() - Transitional helper for plane update
524 * @plane: plane object to update
525 * @crtc: owning CRTC of owning plane
526 * @fb: framebuffer to flip onto plane
527 * @crtc_x: x offset of primary plane on crtc
528 * @crtc_y: y offset of primary plane on crtc
529 * @crtc_w: width of primary plane rectangle on crtc
530 * @crtc_h: height of primary plane rectangle on crtc
531 * @src_x: x offset of @fb for panning
532 * @src_y: y offset of @fb for panning
533 * @src_w: width of source rectangle in @fb
534 * @src_h: height of source rectangle in @fb
536 * Provides a default plane update handler using the atomic plane update
537 * functions. It is fully left to the driver to check plane constraints and
538 * handle corner-cases like a fully occluded or otherwise invisible plane.
540 * This is useful for piecewise transitioning of a driver to the atomic helpers.
543 * Zero on success, error code on failure
545 int drm_plane_helper_update(struct drm_plane *plane, struct drm_crtc *crtc,
546 struct drm_framebuffer *fb,
547 int crtc_x, int crtc_y,
548 unsigned int crtc_w, unsigned int crtc_h,
549 uint32_t src_x, uint32_t src_y,
550 uint32_t src_w, uint32_t src_h)
552 struct drm_plane_state *plane_state;
554 if (plane->funcs->atomic_duplicate_state)
555 plane_state = plane->funcs->atomic_duplicate_state(plane);
558 drm_atomic_helper_plane_reset(plane);
560 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
564 plane_state->plane = plane;
566 plane_state->crtc = crtc;
567 drm_atomic_set_fb_for_plane(plane_state, fb);
568 plane_state->crtc_x = crtc_x;
569 plane_state->crtc_y = crtc_y;
570 plane_state->crtc_h = crtc_h;
571 plane_state->crtc_w = crtc_w;
572 plane_state->src_x = src_x;
573 plane_state->src_y = src_y;
574 plane_state->src_h = src_h;
575 plane_state->src_w = src_w;
577 return drm_plane_helper_commit(plane, plane_state, plane->fb);
579 EXPORT_SYMBOL(drm_plane_helper_update);
582 * drm_plane_helper_disable() - Transitional helper for plane disable
583 * @plane: plane to disable
585 * Provides a default plane disable handler using the atomic plane update
586 * functions. It is fully left to the driver to check plane constraints and
587 * handle corner-cases like a fully occluded or otherwise invisible plane.
589 * This is useful for piecewise transitioning of a driver to the atomic helpers.
592 * Zero on success, error code on failure
594 int drm_plane_helper_disable(struct drm_plane *plane)
596 struct drm_plane_state *plane_state;
598 /* crtc helpers love to call disable functions for already disabled hw
599 * functions. So cope with that. */
603 if (plane->funcs->atomic_duplicate_state)
604 plane_state = plane->funcs->atomic_duplicate_state(plane);
607 drm_atomic_helper_plane_reset(plane);
609 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
613 plane_state->plane = plane;
615 plane_state->crtc = NULL;
616 drm_atomic_set_fb_for_plane(plane_state, NULL);
618 return drm_plane_helper_commit(plane, plane_state, plane->fb);
620 EXPORT_SYMBOL(drm_plane_helper_disable);