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 * 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.
73 static const uint32_t safe_modeset_formats
[] = {
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.
83 static int get_connectors_for_crtc(struct drm_crtc
*crtc
,
84 struct drm_connector
**connector_list
,
87 struct drm_device
*dev
= crtc
->dev
;
88 struct drm_connector
*connector
;
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
96 WARN_ON(!drm_modeset_is_locked(&dev
->mode_config
.connection_mutex
));
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
;
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
126 * @visible: output parameter indicating whether plane is still visible after
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
135 * Zero if update appears valid, error code on failure
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
,
147 bool can_update_disabled
,
157 /* crtc should only be NULL when disabling (i.e., !fb) */
158 if (WARN_ON(!crtc
)) {
163 if (!crtc
->enabled
&& !can_update_disabled
) {
164 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
168 drm_rect_rotate(src
, fb
->width
<< 16, fb
->height
<< 16, rotation
);
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);
180 *visible
= drm_rect_clip_scaled(src
, dest
, clip
, hscale
, vscale
);
182 drm_rect_rotate_inv(src
, fb
->width
<< 16, fb
->height
<< 16, rotation
);
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.
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);
203 EXPORT_SYMBOL(drm_plane_helper_check_update
);
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
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
224 * SetPlane() on a primary plane of a disabled CRTC is not supported, and will
227 * Note that we make some assumptions about hardware limitations that may not be
228 * true for all hardware --
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.
235 * Drivers for hardware that don't have these restrictions can provide their
236 * own implementation rather than using this helper.
239 * Zero on success, error code on failure
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
)
248 struct drm_mode_set set
= {
255 struct drm_rect src
= {
261 struct drm_rect dest
= {
264 .x2
= crtc_x
+ crtc_w
,
265 .y2
= crtc_y
+ crtc_h
,
267 const struct drm_rect clip
= {
268 .x2
= crtc
->mode
.hdisplay
,
269 .y2
= crtc
->mode
.vdisplay
,
271 struct drm_connector
**connector_list
;
272 int num_connectors
, ret
;
275 ret
= drm_plane_helper_check_update(plane
, crtc
, fb
,
278 DRM_PLANE_HELPER_NO_SCALING
,
279 DRM_PLANE_HELPER_NO_SCALING
,
280 false, false, &visible
);
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.
290 return plane
->funcs
->disable_plane(plane
);
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
),
299 get_connectors_for_crtc(crtc
, connector_list
, num_connectors
);
301 set
.connectors
= connector_list
;
302 set
.num_connectors
= num_connectors
;
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.
312 ret
= crtc
->funcs
->set_config(&set
);
314 kfree(connector_list
);
317 EXPORT_SYMBOL(drm_primary_helper_update
);
320 * drm_primary_helper_disable() - Helper for primary plane disable
321 * @plane: plane to disable
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.
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).
336 * Unconditionally returns -EINVAL.
338 int drm_primary_helper_disable(struct drm_plane
*plane
)
342 EXPORT_SYMBOL(drm_primary_helper_disable
);
345 * drm_primary_helper_destroy() - Helper for primary plane destruction
346 * @plane: plane to destroy
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.
352 void drm_primary_helper_destroy(struct drm_plane
*plane
)
354 drm_plane_cleanup(plane
);
357 EXPORT_SYMBOL(drm_primary_helper_destroy
);
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
,
364 EXPORT_SYMBOL(drm_primary_helper_funcs
);
366 static struct drm_plane
*create_primary_plane(struct drm_device
*dev
)
368 struct drm_plane
*primary
;
371 primary
= kzalloc(sizeof(*primary
), GFP_KERNEL
);
372 if (primary
== NULL
) {
373 DRM_DEBUG_KMS("Failed to allocate primary plane\n");
378 * Remove the format_default field from drm_plane when dropping
381 primary
->format_default
= true;
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
);
398 * drm_crtc_init - Legacy CRTC initialization function
400 * @crtc: CRTC object to init
401 * @funcs: callbacks for the new CRTC
403 * Initialize a CRTC object with a default helper-provided primary plane and no
407 * Zero on success, error code on failure.
409 int drm_crtc_init(struct drm_device
*dev
, struct drm_crtc
*crtc
,
410 const struct drm_crtc_funcs
*funcs
)
412 struct drm_plane
*primary
;
414 primary
= create_primary_plane(dev
);
415 return drm_crtc_init_with_planes(dev
, crtc
, primary
, NULL
, funcs
,
418 EXPORT_SYMBOL(drm_crtc_init
);
420 int drm_plane_helper_commit(struct drm_plane
*plane
,
421 struct drm_plane_state
*plane_state
,
422 struct drm_framebuffer
*old_fb
)
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];
429 plane_funcs
= plane
->helper_private
;
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
;
437 for (i
= 0; i
< 2; i
++)
438 crtc_funcs
[i
] = crtc
[i
] ? crtc
[i
]->helper_private
: NULL
;
440 if (plane_funcs
->atomic_check
) {
441 ret
= plane_funcs
->atomic_check(plane
, plane_state
);
446 if (plane_funcs
->prepare_fb
&& plane_state
->fb
&&
447 plane_state
->fb
!= old_fb
) {
448 ret
= plane_funcs
->prepare_fb(plane
,
454 /* Point of no return, commit sw state. */
455 swap(plane
->state
, plane_state
);
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
);
463 * Drivers may optionally implement the ->atomic_disable callback, so
464 * special-case that here.
466 if (drm_atomic_plane_disabling(plane
, plane_state
) &&
467 plane_funcs
->atomic_disable
)
468 plane_funcs
->atomic_disable(plane
, plane_state
);
470 plane_funcs
->atomic_update(plane
, plane_state
);
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
);
478 * If we only moved the plane and didn't change fb's, there's no need to
481 if (plane
->state
->fb
== old_fb
)
484 for (i
= 0; i
< 2; i
++) {
488 if (crtc
[i
]->cursor
== plane
)
491 /* There's no other way to figure out whether the crtc is running. */
492 ret
= drm_crtc_vblank_get(crtc
[i
]);
494 drm_crtc_wait_one_vblank(crtc
[i
]);
495 drm_crtc_vblank_put(crtc
[i
]);
501 if (plane_funcs
->cleanup_fb
)
502 plane_funcs
->cleanup_fb(plane
, plane_state
);
505 if (plane
->funcs
->atomic_destroy_state
)
506 plane
->funcs
->atomic_destroy_state(plane
, plane_state
);
508 drm_atomic_helper_plane_destroy_state(plane
, plane_state
);
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
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.
532 * This is useful for piecewise transitioning of a driver to the atomic helpers.
535 * Zero on success, error code on failure
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
)
544 struct drm_plane_state
*plane_state
;
546 if (plane
->funcs
->atomic_duplicate_state
)
547 plane_state
= plane
->funcs
->atomic_duplicate_state(plane
);
550 drm_atomic_helper_plane_reset(plane
);
552 plane_state
= drm_atomic_helper_plane_duplicate_state(plane
);
556 plane_state
->plane
= plane
;
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
;
569 return drm_plane_helper_commit(plane
, plane_state
, plane
->fb
);
571 EXPORT_SYMBOL(drm_plane_helper_update
);
574 * drm_plane_helper_disable() - Transitional helper for plane disable
575 * @plane: plane to disable
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.
581 * This is useful for piecewise transitioning of a driver to the atomic helpers.
584 * Zero on success, error code on failure
586 int drm_plane_helper_disable(struct drm_plane
*plane
)
588 struct drm_plane_state
*plane_state
;
590 /* crtc helpers love to call disable functions for already disabled hw
591 * functions. So cope with that. */
595 if (plane
->funcs
->atomic_duplicate_state
)
596 plane_state
= plane
->funcs
->atomic_duplicate_state(plane
);
599 drm_atomic_helper_plane_reset(plane
);
601 plane_state
= drm_atomic_helper_plane_duplicate_state(plane
);
605 plane_state
->plane
= plane
;
607 plane_state
->crtc
= NULL
;
608 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
610 return drm_plane_helper_commit(plane
, plane_state
, plane
->fb
);
612 EXPORT_SYMBOL(drm_plane_helper_disable
);