Loading...
1/*
2 * Copyright (c) 2016 Intel Corporation
3 *
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
13 *
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20 * OF THIS SOFTWARE.
21 */
22
23#ifndef __DRM_PLANE_H__
24#define __DRM_PLANE_H__
25
26#include <linux/list.h>
27#include <linux/ctype.h>
28#include <drm/drm_mode_object.h>
29#include <drm/drm_color_mgmt.h>
30#include <drm/drm_rect.h>
31#include <drm/drm_modeset_lock.h>
32#include <drm/drm_util.h>
33
34struct drm_crtc;
35struct drm_printer;
36struct drm_modeset_acquire_ctx;
37
38enum drm_scaling_filter {
39 DRM_SCALING_FILTER_DEFAULT,
40 DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
41};
42
43/**
44 * struct drm_plane_state - mutable plane state
45 *
46 * Please note that the destination coordinates @crtc_x, @crtc_y, @crtc_h and
47 * @crtc_w and the source coordinates @src_x, @src_y, @src_h and @src_w are the
48 * raw coordinates provided by userspace. Drivers should use
49 * drm_atomic_helper_check_plane_state() and only use the derived rectangles in
50 * @src and @dst to program the hardware.
51 */
52struct drm_plane_state {
53 /** @plane: backpointer to the plane */
54 struct drm_plane *plane;
55
56 /**
57 * @crtc:
58 *
59 * Currently bound CRTC, NULL if disabled. Do not this write directly,
60 * use drm_atomic_set_crtc_for_plane()
61 */
62 struct drm_crtc *crtc;
63
64 /**
65 * @fb:
66 *
67 * Currently bound framebuffer. Do not write this directly, use
68 * drm_atomic_set_fb_for_plane()
69 */
70 struct drm_framebuffer *fb;
71
72 /**
73 * @fence:
74 *
75 * Optional fence to wait for before scanning out @fb. The core atomic
76 * code will set this when userspace is using explicit fencing. Do not
77 * write this field directly for a driver's implicit fence.
78 *
79 * Drivers should store any implicit fence in this from their
80 * &drm_plane_helper_funcs.prepare_fb callback. See drm_gem_plane_helper_prepare_fb()
81 * and drm_gem_simple_display_pipe_prepare_fb() for suitable helpers.
82 */
83 struct dma_fence *fence;
84
85 /**
86 * @crtc_x:
87 *
88 * Left position of visible portion of plane on crtc, signed dest
89 * location allows it to be partially off screen.
90 */
91
92 int32_t crtc_x;
93 /**
94 * @crtc_y:
95 *
96 * Upper position of visible portion of plane on crtc, signed dest
97 * location allows it to be partially off screen.
98 */
99 int32_t crtc_y;
100
101 /** @crtc_w: width of visible portion of plane on crtc */
102 /** @crtc_h: height of visible portion of plane on crtc */
103 uint32_t crtc_w, crtc_h;
104
105 /**
106 * @src_x: left position of visible portion of plane within plane (in
107 * 16.16 fixed point).
108 */
109 uint32_t src_x;
110 /**
111 * @src_y: upper position of visible portion of plane within plane (in
112 * 16.16 fixed point).
113 */
114 uint32_t src_y;
115 /** @src_w: width of visible portion of plane (in 16.16) */
116 /** @src_h: height of visible portion of plane (in 16.16) */
117 uint32_t src_h, src_w;
118
119 /**
120 * @alpha:
121 * Opacity of the plane with 0 as completely transparent and 0xffff as
122 * completely opaque. See drm_plane_create_alpha_property() for more
123 * details.
124 */
125 u16 alpha;
126
127 /**
128 * @pixel_blend_mode:
129 * The alpha blending equation selection, describing how the pixels from
130 * the current plane are composited with the background. Value can be
131 * one of DRM_MODE_BLEND_*
132 */
133 uint16_t pixel_blend_mode;
134
135 /**
136 * @rotation:
137 * Rotation of the plane. See drm_plane_create_rotation_property() for
138 * more details.
139 */
140 unsigned int rotation;
141
142 /**
143 * @zpos:
144 * Priority of the given plane on crtc (optional).
145 *
146 * User-space may set mutable zpos properties so that multiple active
147 * planes on the same CRTC have identical zpos values. This is a
148 * user-space bug, but drivers can solve the conflict by comparing the
149 * plane object IDs; the plane with a higher ID is stacked on top of a
150 * plane with a lower ID.
151 *
152 * See drm_plane_create_zpos_property() and
153 * drm_plane_create_zpos_immutable_property() for more details.
154 */
155 unsigned int zpos;
156
157 /**
158 * @normalized_zpos:
159 * Normalized value of zpos: unique, range from 0 to N-1 where N is the
160 * number of active planes for given crtc. Note that the driver must set
161 * &drm_mode_config.normalize_zpos or call drm_atomic_normalize_zpos() to
162 * update this before it can be trusted.
163 */
164 unsigned int normalized_zpos;
165
166 /**
167 * @color_encoding:
168 *
169 * Color encoding for non RGB formats
170 */
171 enum drm_color_encoding color_encoding;
172
173 /**
174 * @color_range:
175 *
176 * Color range for non RGB formats
177 */
178 enum drm_color_range color_range;
179
180 /**
181 * @fb_damage_clips:
182 *
183 * Blob representing damage (area in plane framebuffer that changed
184 * since last plane update) as an array of &drm_mode_rect in framebuffer
185 * coodinates of the attached framebuffer. Note that unlike plane src,
186 * damage clips are not in 16.16 fixed point.
187 *
188 * See drm_plane_get_damage_clips() and
189 * drm_plane_get_damage_clips_count() for accessing these.
190 */
191 struct drm_property_blob *fb_damage_clips;
192
193 /**
194 * @src:
195 *
196 * source coordinates of the plane (in 16.16).
197 *
198 * When using drm_atomic_helper_check_plane_state(),
199 * the coordinates are clipped, but the driver may choose
200 * to use unclipped coordinates instead when the hardware
201 * performs the clipping automatically.
202 */
203 /**
204 * @dst:
205 *
206 * clipped destination coordinates of the plane.
207 *
208 * When using drm_atomic_helper_check_plane_state(),
209 * the coordinates are clipped, but the driver may choose
210 * to use unclipped coordinates instead when the hardware
211 * performs the clipping automatically.
212 */
213 struct drm_rect src, dst;
214
215 /**
216 * @visible:
217 *
218 * Visibility of the plane. This can be false even if fb!=NULL and
219 * crtc!=NULL, due to clipping.
220 */
221 bool visible;
222
223 /**
224 * @scaling_filter:
225 *
226 * Scaling filter to be applied
227 */
228 enum drm_scaling_filter scaling_filter;
229
230 /**
231 * @commit: Tracks the pending commit to prevent use-after-free conditions,
232 * and for async plane updates.
233 *
234 * May be NULL.
235 */
236 struct drm_crtc_commit *commit;
237
238 /** @state: backpointer to global drm_atomic_state */
239 struct drm_atomic_state *state;
240};
241
242static inline struct drm_rect
243drm_plane_state_src(const struct drm_plane_state *state)
244{
245 struct drm_rect src = {
246 .x1 = state->src_x,
247 .y1 = state->src_y,
248 .x2 = state->src_x + state->src_w,
249 .y2 = state->src_y + state->src_h,
250 };
251 return src;
252}
253
254static inline struct drm_rect
255drm_plane_state_dest(const struct drm_plane_state *state)
256{
257 struct drm_rect dest = {
258 .x1 = state->crtc_x,
259 .y1 = state->crtc_y,
260 .x2 = state->crtc_x + state->crtc_w,
261 .y2 = state->crtc_y + state->crtc_h,
262 };
263 return dest;
264}
265
266/**
267 * struct drm_plane_funcs - driver plane control functions
268 */
269struct drm_plane_funcs {
270 /**
271 * @update_plane:
272 *
273 * This is the legacy entry point to enable and configure the plane for
274 * the given CRTC and framebuffer. It is never called to disable the
275 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
276 *
277 * The source rectangle in frame buffer memory coordinates is given by
278 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
279 * values). Devices that don't support subpixel plane coordinates can
280 * ignore the fractional part.
281 *
282 * The destination rectangle in CRTC coordinates is given by the
283 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
284 * Devices scale the source rectangle to the destination rectangle. If
285 * scaling is not supported, and the source rectangle size doesn't match
286 * the destination rectangle size, the driver must return a
287 * -<errorname>EINVAL</errorname> error.
288 *
289 * Drivers implementing atomic modeset should use
290 * drm_atomic_helper_update_plane() to implement this hook.
291 *
292 * RETURNS:
293 *
294 * 0 on success or a negative error code on failure.
295 */
296 int (*update_plane)(struct drm_plane *plane,
297 struct drm_crtc *crtc, struct drm_framebuffer *fb,
298 int crtc_x, int crtc_y,
299 unsigned int crtc_w, unsigned int crtc_h,
300 uint32_t src_x, uint32_t src_y,
301 uint32_t src_w, uint32_t src_h,
302 struct drm_modeset_acquire_ctx *ctx);
303
304 /**
305 * @disable_plane:
306 *
307 * This is the legacy entry point to disable the plane. The DRM core
308 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call
309 * with the frame buffer ID set to 0. Disabled planes must not be
310 * processed by the CRTC.
311 *
312 * Drivers implementing atomic modeset should use
313 * drm_atomic_helper_disable_plane() to implement this hook.
314 *
315 * RETURNS:
316 *
317 * 0 on success or a negative error code on failure.
318 */
319 int (*disable_plane)(struct drm_plane *plane,
320 struct drm_modeset_acquire_ctx *ctx);
321
322 /**
323 * @destroy:
324 *
325 * Clean up plane resources. This is only called at driver unload time
326 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
327 * in DRM.
328 */
329 void (*destroy)(struct drm_plane *plane);
330
331 /**
332 * @reset:
333 *
334 * Reset plane hardware and software state to off. This function isn't
335 * called by the core directly, only through drm_mode_config_reset().
336 * It's not a helper hook only for historical reasons.
337 *
338 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
339 * atomic state using this hook.
340 */
341 void (*reset)(struct drm_plane *plane);
342
343 /**
344 * @set_property:
345 *
346 * This is the legacy entry point to update a property attached to the
347 * plane.
348 *
349 * This callback is optional if the driver does not support any legacy
350 * driver-private properties. For atomic drivers it is not used because
351 * property handling is done entirely in the DRM core.
352 *
353 * RETURNS:
354 *
355 * 0 on success or a negative error code on failure.
356 */
357 int (*set_property)(struct drm_plane *plane,
358 struct drm_property *property, uint64_t val);
359
360 /**
361 * @atomic_duplicate_state:
362 *
363 * Duplicate the current atomic state for this plane and return it.
364 * The core and helpers guarantee that any atomic state duplicated with
365 * this hook and still owned by the caller (i.e. not transferred to the
366 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
367 * cleaned up by calling the @atomic_destroy_state hook in this
368 * structure.
369 *
370 * This callback is mandatory for atomic drivers.
371 *
372 * Atomic drivers which don't subclass &struct drm_plane_state should use
373 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
374 * state structure to extend it with driver-private state should use
375 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
376 * duplicated in a consistent fashion across drivers.
377 *
378 * It is an error to call this hook before &drm_plane.state has been
379 * initialized correctly.
380 *
381 * NOTE:
382 *
383 * If the duplicate state references refcounted resources this hook must
384 * acquire a reference for each of them. The driver must release these
385 * references again in @atomic_destroy_state.
386 *
387 * RETURNS:
388 *
389 * Duplicated atomic state or NULL when the allocation failed.
390 */
391 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
392
393 /**
394 * @atomic_destroy_state:
395 *
396 * Destroy a state duplicated with @atomic_duplicate_state and release
397 * or unreference all resources it references
398 *
399 * This callback is mandatory for atomic drivers.
400 */
401 void (*atomic_destroy_state)(struct drm_plane *plane,
402 struct drm_plane_state *state);
403
404 /**
405 * @atomic_set_property:
406 *
407 * Decode a driver-private property value and store the decoded value
408 * into the passed-in state structure. Since the atomic core decodes all
409 * standardized properties (even for extensions beyond the core set of
410 * properties which might not be implemented by all drivers) this
411 * requires drivers to subclass the state structure.
412 *
413 * Such driver-private properties should really only be implemented for
414 * truly hardware/vendor specific state. Instead it is preferred to
415 * standardize atomic extension and decode the properties used to expose
416 * such an extension in the core.
417 *
418 * Do not call this function directly, use
419 * drm_atomic_plane_set_property() instead.
420 *
421 * This callback is optional if the driver does not support any
422 * driver-private atomic properties.
423 *
424 * NOTE:
425 *
426 * This function is called in the state assembly phase of atomic
427 * modesets, which can be aborted for any reason (including on
428 * userspace's request to just check whether a configuration would be
429 * possible). Drivers MUST NOT touch any persistent state (hardware or
430 * software) or data structures except the passed in @state parameter.
431 *
432 * Also since userspace controls in which order properties are set this
433 * function must not do any input validation (since the state update is
434 * incomplete and hence likely inconsistent). Instead any such input
435 * validation must be done in the various atomic_check callbacks.
436 *
437 * RETURNS:
438 *
439 * 0 if the property has been found, -EINVAL if the property isn't
440 * implemented by the driver (which shouldn't ever happen, the core only
441 * asks for properties attached to this plane). No other validation is
442 * allowed by the driver. The core already checks that the property
443 * value is within the range (integer, valid enum value, ...) the driver
444 * set when registering the property.
445 */
446 int (*atomic_set_property)(struct drm_plane *plane,
447 struct drm_plane_state *state,
448 struct drm_property *property,
449 uint64_t val);
450
451 /**
452 * @atomic_get_property:
453 *
454 * Reads out the decoded driver-private property. This is used to
455 * implement the GETPLANE IOCTL.
456 *
457 * Do not call this function directly, use
458 * drm_atomic_plane_get_property() instead.
459 *
460 * This callback is optional if the driver does not support any
461 * driver-private atomic properties.
462 *
463 * RETURNS:
464 *
465 * 0 on success, -EINVAL if the property isn't implemented by the
466 * driver (which should never happen, the core only asks for
467 * properties attached to this plane).
468 */
469 int (*atomic_get_property)(struct drm_plane *plane,
470 const struct drm_plane_state *state,
471 struct drm_property *property,
472 uint64_t *val);
473 /**
474 * @late_register:
475 *
476 * This optional hook can be used to register additional userspace
477 * interfaces attached to the plane like debugfs interfaces.
478 * It is called late in the driver load sequence from drm_dev_register().
479 * Everything added from this callback should be unregistered in
480 * the early_unregister callback.
481 *
482 * Returns:
483 *
484 * 0 on success, or a negative error code on failure.
485 */
486 int (*late_register)(struct drm_plane *plane);
487
488 /**
489 * @early_unregister:
490 *
491 * This optional hook should be used to unregister the additional
492 * userspace interfaces attached to the plane from
493 * @late_register. It is called from drm_dev_unregister(),
494 * early in the driver unload sequence to disable userspace access
495 * before data structures are torndown.
496 */
497 void (*early_unregister)(struct drm_plane *plane);
498
499 /**
500 * @atomic_print_state:
501 *
502 * If driver subclasses &struct drm_plane_state, it should implement
503 * this optional hook for printing additional driver specific state.
504 *
505 * Do not call this directly, use drm_atomic_plane_print_state()
506 * instead.
507 */
508 void (*atomic_print_state)(struct drm_printer *p,
509 const struct drm_plane_state *state);
510
511 /**
512 * @format_mod_supported:
513 *
514 * This optional hook is used for the DRM to determine if the given
515 * format/modifier combination is valid for the plane. This allows the
516 * DRM to generate the correct format bitmask (which formats apply to
517 * which modifier), and to validate modifiers at atomic_check time.
518 *
519 * If not present, then any modifier in the plane's modifier
520 * list is allowed with any of the plane's formats.
521 *
522 * Returns:
523 *
524 * True if the given modifier is valid for that format on the plane.
525 * False otherwise.
526 */
527 bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format,
528 uint64_t modifier);
529};
530
531/**
532 * enum drm_plane_type - uapi plane type enumeration
533 *
534 * For historical reasons not all planes are made the same. This enumeration is
535 * used to tell the different types of planes apart to implement the different
536 * uapi semantics for them. For userspace which is universal plane aware and
537 * which is using that atomic IOCTL there's no difference between these planes
538 * (beyong what the driver and hardware can support of course).
539 *
540 * For compatibility with legacy userspace, only overlay planes are made
541 * available to userspace by default. Userspace clients may set the
542 * &DRM_CLIENT_CAP_UNIVERSAL_PLANES client capability bit to indicate that they
543 * wish to receive a universal plane list containing all plane types. See also
544 * drm_for_each_legacy_plane().
545 *
546 * In addition to setting each plane's type, drivers need to setup the
547 * &drm_crtc.primary and optionally &drm_crtc.cursor pointers for legacy
548 * IOCTLs. See drm_crtc_init_with_planes().
549 *
550 * WARNING: The values of this enum is UABI since they're exposed in the "type"
551 * property.
552 */
553enum drm_plane_type {
554 /**
555 * @DRM_PLANE_TYPE_OVERLAY:
556 *
557 * Overlay planes represent all non-primary, non-cursor planes. Some
558 * drivers refer to these types of planes as "sprites" internally.
559 */
560 DRM_PLANE_TYPE_OVERLAY,
561
562 /**
563 * @DRM_PLANE_TYPE_PRIMARY:
564 *
565 * A primary plane attached to a CRTC is the most likely to be able to
566 * light up the CRTC when no scaling/cropping is used and the plane
567 * covers the whole CRTC.
568 */
569 DRM_PLANE_TYPE_PRIMARY,
570
571 /**
572 * @DRM_PLANE_TYPE_CURSOR:
573 *
574 * A cursor plane attached to a CRTC is more likely to be able to be
575 * enabled when no scaling/cropping is used and the framebuffer has the
576 * size indicated by &drm_mode_config.cursor_width and
577 * &drm_mode_config.cursor_height. Additionally, if the driver doesn't
578 * support modifiers, the framebuffer should have a linear layout.
579 */
580 DRM_PLANE_TYPE_CURSOR,
581};
582
583
584/**
585 * struct drm_plane - central DRM plane control structure
586 *
587 * Planes represent the scanout hardware of a display block. They receive their
588 * input data from a &drm_framebuffer and feed it to a &drm_crtc. Planes control
589 * the color conversion, see `Plane Composition Properties`_ for more details,
590 * and are also involved in the color conversion of input pixels, see `Color
591 * Management Properties`_ for details on that.
592 */
593struct drm_plane {
594 /** @dev: DRM device this plane belongs to */
595 struct drm_device *dev;
596
597 /**
598 * @head:
599 *
600 * List of all planes on @dev, linked from &drm_mode_config.plane_list.
601 * Invariant over the lifetime of @dev and therefore does not need
602 * locking.
603 */
604 struct list_head head;
605
606 /** @name: human readable name, can be overwritten by the driver */
607 char *name;
608
609 /**
610 * @mutex:
611 *
612 * Protects modeset plane state, together with the &drm_crtc.mutex of
613 * CRTC this plane is linked to (when active, getting activated or
614 * getting disabled).
615 *
616 * For atomic drivers specifically this protects @state.
617 */
618 struct drm_modeset_lock mutex;
619
620 /** @base: base mode object */
621 struct drm_mode_object base;
622
623 /**
624 * @possible_crtcs: pipes this plane can be bound to constructed from
625 * drm_crtc_mask()
626 */
627 uint32_t possible_crtcs;
628 /** @format_types: array of formats supported by this plane */
629 uint32_t *format_types;
630 /** @format_count: Size of the array pointed at by @format_types. */
631 unsigned int format_count;
632 /**
633 * @format_default: driver hasn't supplied supported formats for the
634 * plane. Used by the non-atomic driver compatibility wrapper only.
635 */
636 bool format_default;
637
638 /** @modifiers: array of modifiers supported by this plane */
639 uint64_t *modifiers;
640 /** @modifier_count: Size of the array pointed at by @modifier_count. */
641 unsigned int modifier_count;
642
643 /**
644 * @crtc:
645 *
646 * Currently bound CRTC, only meaningful for non-atomic drivers. For
647 * atomic drivers this is forced to be NULL, atomic drivers should
648 * instead check &drm_plane_state.crtc.
649 */
650 struct drm_crtc *crtc;
651
652 /**
653 * @fb:
654 *
655 * Currently bound framebuffer, only meaningful for non-atomic drivers.
656 * For atomic drivers this is forced to be NULL, atomic drivers should
657 * instead check &drm_plane_state.fb.
658 */
659 struct drm_framebuffer *fb;
660
661 /**
662 * @old_fb:
663 *
664 * Temporary tracking of the old fb while a modeset is ongoing. Only
665 * used by non-atomic drivers, forced to be NULL for atomic drivers.
666 */
667 struct drm_framebuffer *old_fb;
668
669 /** @funcs: plane control functions */
670 const struct drm_plane_funcs *funcs;
671
672 /** @properties: property tracking for this plane */
673 struct drm_object_properties properties;
674
675 /** @type: Type of plane, see &enum drm_plane_type for details. */
676 enum drm_plane_type type;
677
678 /**
679 * @index: Position inside the mode_config.list, can be used as an array
680 * index. It is invariant over the lifetime of the plane.
681 */
682 unsigned index;
683
684 /** @helper_private: mid-layer private data */
685 const struct drm_plane_helper_funcs *helper_private;
686
687 /**
688 * @state:
689 *
690 * Current atomic state for this plane.
691 *
692 * This is protected by @mutex. Note that nonblocking atomic commits
693 * access the current plane state without taking locks. Either by going
694 * through the &struct drm_atomic_state pointers, see
695 * for_each_oldnew_plane_in_state(), for_each_old_plane_in_state() and
696 * for_each_new_plane_in_state(). Or through careful ordering of atomic
697 * commit operations as implemented in the atomic helpers, see
698 * &struct drm_crtc_commit.
699 */
700 struct drm_plane_state *state;
701
702 /**
703 * @alpha_property:
704 * Optional alpha property for this plane. See
705 * drm_plane_create_alpha_property().
706 */
707 struct drm_property *alpha_property;
708 /**
709 * @zpos_property:
710 * Optional zpos property for this plane. See
711 * drm_plane_create_zpos_property().
712 */
713 struct drm_property *zpos_property;
714 /**
715 * @rotation_property:
716 * Optional rotation property for this plane. See
717 * drm_plane_create_rotation_property().
718 */
719 struct drm_property *rotation_property;
720 /**
721 * @blend_mode_property:
722 * Optional "pixel blend mode" enum property for this plane.
723 * Blend mode property represents the alpha blending equation selection,
724 * describing how the pixels from the current plane are composited with
725 * the background.
726 */
727 struct drm_property *blend_mode_property;
728
729 /**
730 * @color_encoding_property:
731 *
732 * Optional "COLOR_ENCODING" enum property for specifying
733 * color encoding for non RGB formats.
734 * See drm_plane_create_color_properties().
735 */
736 struct drm_property *color_encoding_property;
737 /**
738 * @color_range_property:
739 *
740 * Optional "COLOR_RANGE" enum property for specifying
741 * color range for non RGB formats.
742 * See drm_plane_create_color_properties().
743 */
744 struct drm_property *color_range_property;
745
746 /**
747 * @scaling_filter_property: property to apply a particular filter while
748 * scaling.
749 */
750 struct drm_property *scaling_filter_property;
751};
752
753#define obj_to_plane(x) container_of(x, struct drm_plane, base)
754
755__printf(9, 10)
756int drm_universal_plane_init(struct drm_device *dev,
757 struct drm_plane *plane,
758 uint32_t possible_crtcs,
759 const struct drm_plane_funcs *funcs,
760 const uint32_t *formats,
761 unsigned int format_count,
762 const uint64_t *format_modifiers,
763 enum drm_plane_type type,
764 const char *name, ...);
765void drm_plane_cleanup(struct drm_plane *plane);
766
767__printf(10, 11)
768void *__drmm_universal_plane_alloc(struct drm_device *dev,
769 size_t size, size_t offset,
770 uint32_t possible_crtcs,
771 const struct drm_plane_funcs *funcs,
772 const uint32_t *formats,
773 unsigned int format_count,
774 const uint64_t *format_modifiers,
775 enum drm_plane_type plane_type,
776 const char *name, ...);
777
778/**
779 * drmm_universal_plane_alloc - Allocate and initialize an universal plane object
780 * @dev: DRM device
781 * @type: the type of the struct which contains struct &drm_plane
782 * @member: the name of the &drm_plane within @type
783 * @possible_crtcs: bitmask of possible CRTCs
784 * @funcs: callbacks for the new plane
785 * @formats: array of supported formats (DRM_FORMAT\_\*)
786 * @format_count: number of elements in @formats
787 * @format_modifiers: array of struct drm_format modifiers terminated by
788 * DRM_FORMAT_MOD_INVALID
789 * @plane_type: type of plane (overlay, primary, cursor)
790 * @name: printf style format string for the plane name, or NULL for default name
791 *
792 * Allocates and initializes a plane object of type @type. Cleanup is
793 * automatically handled through registering drm_plane_cleanup() with
794 * drmm_add_action().
795 *
796 * The @drm_plane_funcs.destroy hook must be NULL.
797 *
798 * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set
799 * @format_modifiers to NULL. The plane will advertise the linear modifier.
800 *
801 * Returns:
802 * Pointer to new plane, or ERR_PTR on failure.
803 */
804#define drmm_universal_plane_alloc(dev, type, member, possible_crtcs, funcs, formats, \
805 format_count, format_modifiers, plane_type, name, ...) \
806 ((type *)__drmm_universal_plane_alloc(dev, sizeof(type), \
807 offsetof(type, member), \
808 possible_crtcs, funcs, formats, \
809 format_count, format_modifiers, \
810 plane_type, name, ##__VA_ARGS__))
811
812__printf(10, 11)
813void *__drm_universal_plane_alloc(struct drm_device *dev,
814 size_t size, size_t offset,
815 uint32_t possible_crtcs,
816 const struct drm_plane_funcs *funcs,
817 const uint32_t *formats,
818 unsigned int format_count,
819 const uint64_t *format_modifiers,
820 enum drm_plane_type plane_type,
821 const char *name, ...);
822
823/**
824 * drm_universal_plane_alloc() - Allocate and initialize an universal plane object
825 * @dev: DRM device
826 * @type: the type of the struct which contains struct &drm_plane
827 * @member: the name of the &drm_plane within @type
828 * @possible_crtcs: bitmask of possible CRTCs
829 * @funcs: callbacks for the new plane
830 * @formats: array of supported formats (DRM_FORMAT\_\*)
831 * @format_count: number of elements in @formats
832 * @format_modifiers: array of struct drm_format modifiers terminated by
833 * DRM_FORMAT_MOD_INVALID
834 * @plane_type: type of plane (overlay, primary, cursor)
835 * @name: printf style format string for the plane name, or NULL for default name
836 *
837 * Allocates and initializes a plane object of type @type. The caller
838 * is responsible for releasing the allocated memory with kfree().
839 *
840 * Drivers are encouraged to use drmm_universal_plane_alloc() instead.
841 *
842 * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set
843 * @format_modifiers to NULL. The plane will advertise the linear modifier.
844 *
845 * Returns:
846 * Pointer to new plane, or ERR_PTR on failure.
847 */
848#define drm_universal_plane_alloc(dev, type, member, possible_crtcs, funcs, formats, \
849 format_count, format_modifiers, plane_type, name, ...) \
850 ((type *)__drm_universal_plane_alloc(dev, sizeof(type), \
851 offsetof(type, member), \
852 possible_crtcs, funcs, formats, \
853 format_count, format_modifiers, \
854 plane_type, name, ##__VA_ARGS__))
855
856/**
857 * drm_plane_index - find the index of a registered plane
858 * @plane: plane to find index for
859 *
860 * Given a registered plane, return the index of that plane within a DRM
861 * device's list of planes.
862 */
863static inline unsigned int drm_plane_index(const struct drm_plane *plane)
864{
865 return plane->index;
866}
867
868/**
869 * drm_plane_mask - find the mask of a registered plane
870 * @plane: plane to find mask for
871 */
872static inline u32 drm_plane_mask(const struct drm_plane *plane)
873{
874 return 1 << drm_plane_index(plane);
875}
876
877struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
878void drm_plane_force_disable(struct drm_plane *plane);
879
880int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
881 struct drm_property *property,
882 uint64_t value);
883
884/**
885 * drm_plane_find - find a &drm_plane
886 * @dev: DRM device
887 * @file_priv: drm file to check for lease against.
888 * @id: plane id
889 *
890 * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
891 * drm_mode_object_find().
892 */
893static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
894 struct drm_file *file_priv,
895 uint32_t id)
896{
897 struct drm_mode_object *mo;
898 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_PLANE);
899 return mo ? obj_to_plane(mo) : NULL;
900}
901
902/**
903 * drm_for_each_plane_mask - iterate over planes specified by bitmask
904 * @plane: the loop cursor
905 * @dev: the DRM device
906 * @plane_mask: bitmask of plane indices
907 *
908 * Iterate over all planes specified by bitmask.
909 */
910#define drm_for_each_plane_mask(plane, dev, plane_mask) \
911 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
912 for_each_if ((plane_mask) & drm_plane_mask(plane))
913
914/**
915 * drm_for_each_legacy_plane - iterate over all planes for legacy userspace
916 * @plane: the loop cursor
917 * @dev: the DRM device
918 *
919 * Iterate over all legacy planes of @dev, excluding primary and cursor planes.
920 * This is useful for implementing userspace apis when userspace is not
921 * universal plane aware. See also &enum drm_plane_type.
922 */
923#define drm_for_each_legacy_plane(plane, dev) \
924 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
925 for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
926
927/**
928 * drm_for_each_plane - iterate over all planes
929 * @plane: the loop cursor
930 * @dev: the DRM device
931 *
932 * Iterate over all planes of @dev, include primary and cursor planes.
933 */
934#define drm_for_each_plane(plane, dev) \
935 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
936
937bool drm_any_plane_has_format(struct drm_device *dev,
938 u32 format, u64 modifier);
939
940void drm_plane_enable_fb_damage_clips(struct drm_plane *plane);
941unsigned int
942drm_plane_get_damage_clips_count(const struct drm_plane_state *state);
943struct drm_mode_rect *
944drm_plane_get_damage_clips(const struct drm_plane_state *state);
945
946int drm_plane_create_scaling_filter_property(struct drm_plane *plane,
947 unsigned int supported_filters);
948
949#endif
1/*
2 * Copyright (c) 2016 Intel Corporation
3 *
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
13 *
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20 * OF THIS SOFTWARE.
21 */
22
23#ifndef __DRM_PLANE_H__
24#define __DRM_PLANE_H__
25
26#include <linux/list.h>
27#include <linux/ctype.h>
28#include <drm/drm_mode_object.h>
29#include <drm/drm_color_mgmt.h>
30#include <drm/drm_rect.h>
31#include <drm/drm_modeset_lock.h>
32#include <drm/drm_util.h>
33
34struct drm_crtc;
35struct drm_printer;
36struct drm_modeset_acquire_ctx;
37
38enum drm_scaling_filter {
39 DRM_SCALING_FILTER_DEFAULT,
40 DRM_SCALING_FILTER_NEAREST_NEIGHBOR,
41};
42
43/**
44 * struct drm_plane_state - mutable plane state
45 *
46 * Please note that the destination coordinates @crtc_x, @crtc_y, @crtc_h and
47 * @crtc_w and the source coordinates @src_x, @src_y, @src_h and @src_w are the
48 * raw coordinates provided by userspace. Drivers should use
49 * drm_atomic_helper_check_plane_state() and only use the derived rectangles in
50 * @src and @dst to program the hardware.
51 */
52struct drm_plane_state {
53 /** @plane: backpointer to the plane */
54 struct drm_plane *plane;
55
56 /**
57 * @crtc:
58 *
59 * Currently bound CRTC, NULL if disabled. Do not write this directly,
60 * use drm_atomic_set_crtc_for_plane()
61 */
62 struct drm_crtc *crtc;
63
64 /**
65 * @fb:
66 *
67 * Currently bound framebuffer. Do not write this directly, use
68 * drm_atomic_set_fb_for_plane()
69 */
70 struct drm_framebuffer *fb;
71
72 /**
73 * @fence:
74 *
75 * Optional fence to wait for before scanning out @fb. The core atomic
76 * code will set this when userspace is using explicit fencing. Do not
77 * write this field directly for a driver's implicit fence.
78 *
79 * Drivers should store any implicit fence in this from their
80 * &drm_plane_helper_funcs.prepare_fb callback. See
81 * drm_gem_plane_helper_prepare_fb() for a suitable helper.
82 */
83 struct dma_fence *fence;
84
85 /**
86 * @crtc_x:
87 *
88 * Left position of visible portion of plane on crtc, signed dest
89 * location allows it to be partially off screen.
90 */
91
92 int32_t crtc_x;
93 /**
94 * @crtc_y:
95 *
96 * Upper position of visible portion of plane on crtc, signed dest
97 * location allows it to be partially off screen.
98 */
99 int32_t crtc_y;
100
101 /** @crtc_w: width of visible portion of plane on crtc */
102 /** @crtc_h: height of visible portion of plane on crtc */
103 uint32_t crtc_w, crtc_h;
104
105 /**
106 * @src_x: left position of visible portion of plane within plane (in
107 * 16.16 fixed point).
108 */
109 uint32_t src_x;
110 /**
111 * @src_y: upper position of visible portion of plane within plane (in
112 * 16.16 fixed point).
113 */
114 uint32_t src_y;
115 /** @src_w: width of visible portion of plane (in 16.16) */
116 /** @src_h: height of visible portion of plane (in 16.16) */
117 uint32_t src_h, src_w;
118
119 /** @hotspot_x: x offset to mouse cursor hotspot */
120 /** @hotspot_y: y offset to mouse cursor hotspot */
121 int32_t hotspot_x, hotspot_y;
122
123 /**
124 * @alpha:
125 * Opacity of the plane with 0 as completely transparent and 0xffff as
126 * completely opaque. See drm_plane_create_alpha_property() for more
127 * details.
128 */
129 u16 alpha;
130
131 /**
132 * @pixel_blend_mode:
133 * The alpha blending equation selection, describing how the pixels from
134 * the current plane are composited with the background. Value can be
135 * one of DRM_MODE_BLEND_*
136 */
137 uint16_t pixel_blend_mode;
138
139 /**
140 * @rotation:
141 * Rotation of the plane. See drm_plane_create_rotation_property() for
142 * more details.
143 */
144 unsigned int rotation;
145
146 /**
147 * @zpos:
148 * Priority of the given plane on crtc (optional).
149 *
150 * User-space may set mutable zpos properties so that multiple active
151 * planes on the same CRTC have identical zpos values. This is a
152 * user-space bug, but drivers can solve the conflict by comparing the
153 * plane object IDs; the plane with a higher ID is stacked on top of a
154 * plane with a lower ID.
155 *
156 * See drm_plane_create_zpos_property() and
157 * drm_plane_create_zpos_immutable_property() for more details.
158 */
159 unsigned int zpos;
160
161 /**
162 * @normalized_zpos:
163 * Normalized value of zpos: unique, range from 0 to N-1 where N is the
164 * number of active planes for given crtc. Note that the driver must set
165 * &drm_mode_config.normalize_zpos or call drm_atomic_normalize_zpos() to
166 * update this before it can be trusted.
167 */
168 unsigned int normalized_zpos;
169
170 /**
171 * @color_encoding:
172 *
173 * Color encoding for non RGB formats
174 */
175 enum drm_color_encoding color_encoding;
176
177 /**
178 * @color_range:
179 *
180 * Color range for non RGB formats
181 */
182 enum drm_color_range color_range;
183
184 /**
185 * @fb_damage_clips:
186 *
187 * Blob representing damage (area in plane framebuffer that changed
188 * since last plane update) as an array of &drm_mode_rect in framebuffer
189 * coodinates of the attached framebuffer. Note that unlike plane src,
190 * damage clips are not in 16.16 fixed point.
191 *
192 * See drm_plane_get_damage_clips() and
193 * drm_plane_get_damage_clips_count() for accessing these.
194 */
195 struct drm_property_blob *fb_damage_clips;
196
197 /**
198 * @ignore_damage_clips:
199 *
200 * Set by drivers to indicate the drm_atomic_helper_damage_iter_init()
201 * helper that the @fb_damage_clips blob property should be ignored.
202 *
203 * See :ref:`damage_tracking_properties` for more information.
204 */
205 bool ignore_damage_clips;
206
207 /**
208 * @src:
209 *
210 * source coordinates of the plane (in 16.16).
211 *
212 * When using drm_atomic_helper_check_plane_state(),
213 * the coordinates are clipped, but the driver may choose
214 * to use unclipped coordinates instead when the hardware
215 * performs the clipping automatically.
216 */
217 /**
218 * @dst:
219 *
220 * clipped destination coordinates of the plane.
221 *
222 * When using drm_atomic_helper_check_plane_state(),
223 * the coordinates are clipped, but the driver may choose
224 * to use unclipped coordinates instead when the hardware
225 * performs the clipping automatically.
226 */
227 struct drm_rect src, dst;
228
229 /**
230 * @visible:
231 *
232 * Visibility of the plane. This can be false even if fb!=NULL and
233 * crtc!=NULL, due to clipping.
234 */
235 bool visible;
236
237 /**
238 * @scaling_filter:
239 *
240 * Scaling filter to be applied
241 */
242 enum drm_scaling_filter scaling_filter;
243
244 /**
245 * @commit: Tracks the pending commit to prevent use-after-free conditions,
246 * and for async plane updates.
247 *
248 * May be NULL.
249 */
250 struct drm_crtc_commit *commit;
251
252 /** @state: backpointer to global drm_atomic_state */
253 struct drm_atomic_state *state;
254
255 /**
256 * @color_mgmt_changed: Color management properties have changed. Used
257 * by the atomic helpers and drivers to steer the atomic commit control
258 * flow.
259 */
260 bool color_mgmt_changed : 1;
261};
262
263static inline struct drm_rect
264drm_plane_state_src(const struct drm_plane_state *state)
265{
266 struct drm_rect src = {
267 .x1 = state->src_x,
268 .y1 = state->src_y,
269 .x2 = state->src_x + state->src_w,
270 .y2 = state->src_y + state->src_h,
271 };
272 return src;
273}
274
275static inline struct drm_rect
276drm_plane_state_dest(const struct drm_plane_state *state)
277{
278 struct drm_rect dest = {
279 .x1 = state->crtc_x,
280 .y1 = state->crtc_y,
281 .x2 = state->crtc_x + state->crtc_w,
282 .y2 = state->crtc_y + state->crtc_h,
283 };
284 return dest;
285}
286
287/**
288 * struct drm_plane_funcs - driver plane control functions
289 */
290struct drm_plane_funcs {
291 /**
292 * @update_plane:
293 *
294 * This is the legacy entry point to enable and configure the plane for
295 * the given CRTC and framebuffer. It is never called to disable the
296 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
297 *
298 * The source rectangle in frame buffer memory coordinates is given by
299 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
300 * values). Devices that don't support subpixel plane coordinates can
301 * ignore the fractional part.
302 *
303 * The destination rectangle in CRTC coordinates is given by the
304 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
305 * Devices scale the source rectangle to the destination rectangle. If
306 * scaling is not supported, and the source rectangle size doesn't match
307 * the destination rectangle size, the driver must return a
308 * -<errorname>EINVAL</errorname> error.
309 *
310 * Drivers implementing atomic modeset should use
311 * drm_atomic_helper_update_plane() to implement this hook.
312 *
313 * RETURNS:
314 *
315 * 0 on success or a negative error code on failure.
316 */
317 int (*update_plane)(struct drm_plane *plane,
318 struct drm_crtc *crtc, struct drm_framebuffer *fb,
319 int crtc_x, int crtc_y,
320 unsigned int crtc_w, unsigned int crtc_h,
321 uint32_t src_x, uint32_t src_y,
322 uint32_t src_w, uint32_t src_h,
323 struct drm_modeset_acquire_ctx *ctx);
324
325 /**
326 * @disable_plane:
327 *
328 * This is the legacy entry point to disable the plane. The DRM core
329 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call
330 * with the frame buffer ID set to 0. Disabled planes must not be
331 * processed by the CRTC.
332 *
333 * Drivers implementing atomic modeset should use
334 * drm_atomic_helper_disable_plane() to implement this hook.
335 *
336 * RETURNS:
337 *
338 * 0 on success or a negative error code on failure.
339 */
340 int (*disable_plane)(struct drm_plane *plane,
341 struct drm_modeset_acquire_ctx *ctx);
342
343 /**
344 * @destroy:
345 *
346 * Clean up plane resources. This is only called at driver unload time
347 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
348 * in DRM.
349 */
350 void (*destroy)(struct drm_plane *plane);
351
352 /**
353 * @reset:
354 *
355 * Reset plane hardware and software state to off. This function isn't
356 * called by the core directly, only through drm_mode_config_reset().
357 * It's not a helper hook only for historical reasons.
358 *
359 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
360 * atomic state using this hook.
361 */
362 void (*reset)(struct drm_plane *plane);
363
364 /**
365 * @set_property:
366 *
367 * This is the legacy entry point to update a property attached to the
368 * plane.
369 *
370 * This callback is optional if the driver does not support any legacy
371 * driver-private properties. For atomic drivers it is not used because
372 * property handling is done entirely in the DRM core.
373 *
374 * RETURNS:
375 *
376 * 0 on success or a negative error code on failure.
377 */
378 int (*set_property)(struct drm_plane *plane,
379 struct drm_property *property, uint64_t val);
380
381 /**
382 * @atomic_duplicate_state:
383 *
384 * Duplicate the current atomic state for this plane and return it.
385 * The core and helpers guarantee that any atomic state duplicated with
386 * this hook and still owned by the caller (i.e. not transferred to the
387 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
388 * cleaned up by calling the @atomic_destroy_state hook in this
389 * structure.
390 *
391 * This callback is mandatory for atomic drivers.
392 *
393 * Atomic drivers which don't subclass &struct drm_plane_state should use
394 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
395 * state structure to extend it with driver-private state should use
396 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
397 * duplicated in a consistent fashion across drivers.
398 *
399 * It is an error to call this hook before &drm_plane.state has been
400 * initialized correctly.
401 *
402 * NOTE:
403 *
404 * If the duplicate state references refcounted resources this hook must
405 * acquire a reference for each of them. The driver must release these
406 * references again in @atomic_destroy_state.
407 *
408 * RETURNS:
409 *
410 * Duplicated atomic state or NULL when the allocation failed.
411 */
412 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
413
414 /**
415 * @atomic_destroy_state:
416 *
417 * Destroy a state duplicated with @atomic_duplicate_state and release
418 * or unreference all resources it references
419 *
420 * This callback is mandatory for atomic drivers.
421 */
422 void (*atomic_destroy_state)(struct drm_plane *plane,
423 struct drm_plane_state *state);
424
425 /**
426 * @atomic_set_property:
427 *
428 * Decode a driver-private property value and store the decoded value
429 * into the passed-in state structure. Since the atomic core decodes all
430 * standardized properties (even for extensions beyond the core set of
431 * properties which might not be implemented by all drivers) this
432 * requires drivers to subclass the state structure.
433 *
434 * Such driver-private properties should really only be implemented for
435 * truly hardware/vendor specific state. Instead it is preferred to
436 * standardize atomic extension and decode the properties used to expose
437 * such an extension in the core.
438 *
439 * Do not call this function directly, use
440 * drm_atomic_plane_set_property() instead.
441 *
442 * This callback is optional if the driver does not support any
443 * driver-private atomic properties.
444 *
445 * NOTE:
446 *
447 * This function is called in the state assembly phase of atomic
448 * modesets, which can be aborted for any reason (including on
449 * userspace's request to just check whether a configuration would be
450 * possible). Drivers MUST NOT touch any persistent state (hardware or
451 * software) or data structures except the passed in @state parameter.
452 *
453 * Also since userspace controls in which order properties are set this
454 * function must not do any input validation (since the state update is
455 * incomplete and hence likely inconsistent). Instead any such input
456 * validation must be done in the various atomic_check callbacks.
457 *
458 * RETURNS:
459 *
460 * 0 if the property has been found, -EINVAL if the property isn't
461 * implemented by the driver (which shouldn't ever happen, the core only
462 * asks for properties attached to this plane). No other validation is
463 * allowed by the driver. The core already checks that the property
464 * value is within the range (integer, valid enum value, ...) the driver
465 * set when registering the property.
466 */
467 int (*atomic_set_property)(struct drm_plane *plane,
468 struct drm_plane_state *state,
469 struct drm_property *property,
470 uint64_t val);
471
472 /**
473 * @atomic_get_property:
474 *
475 * Reads out the decoded driver-private property. This is used to
476 * implement the GETPLANE IOCTL.
477 *
478 * Do not call this function directly, use
479 * drm_atomic_plane_get_property() instead.
480 *
481 * This callback is optional if the driver does not support any
482 * driver-private atomic properties.
483 *
484 * RETURNS:
485 *
486 * 0 on success, -EINVAL if the property isn't implemented by the
487 * driver (which should never happen, the core only asks for
488 * properties attached to this plane).
489 */
490 int (*atomic_get_property)(struct drm_plane *plane,
491 const struct drm_plane_state *state,
492 struct drm_property *property,
493 uint64_t *val);
494 /**
495 * @late_register:
496 *
497 * This optional hook can be used to register additional userspace
498 * interfaces attached to the plane like debugfs interfaces.
499 * It is called late in the driver load sequence from drm_dev_register().
500 * Everything added from this callback should be unregistered in
501 * the early_unregister callback.
502 *
503 * Returns:
504 *
505 * 0 on success, or a negative error code on failure.
506 */
507 int (*late_register)(struct drm_plane *plane);
508
509 /**
510 * @early_unregister:
511 *
512 * This optional hook should be used to unregister the additional
513 * userspace interfaces attached to the plane from
514 * @late_register. It is called from drm_dev_unregister(),
515 * early in the driver unload sequence to disable userspace access
516 * before data structures are torndown.
517 */
518 void (*early_unregister)(struct drm_plane *plane);
519
520 /**
521 * @atomic_print_state:
522 *
523 * If driver subclasses &struct drm_plane_state, it should implement
524 * this optional hook for printing additional driver specific state.
525 *
526 * Do not call this directly, use drm_atomic_plane_print_state()
527 * instead.
528 */
529 void (*atomic_print_state)(struct drm_printer *p,
530 const struct drm_plane_state *state);
531
532 /**
533 * @format_mod_supported:
534 *
535 * This optional hook is used for the DRM to determine if the given
536 * format/modifier combination is valid for the plane. This allows the
537 * DRM to generate the correct format bitmask (which formats apply to
538 * which modifier), and to validate modifiers at atomic_check time.
539 *
540 * If not present, then any modifier in the plane's modifier
541 * list is allowed with any of the plane's formats.
542 *
543 * Returns:
544 *
545 * True if the given modifier is valid for that format on the plane.
546 * False otherwise.
547 */
548 bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format,
549 uint64_t modifier);
550};
551
552/**
553 * enum drm_plane_type - uapi plane type enumeration
554 *
555 * For historical reasons not all planes are made the same. This enumeration is
556 * used to tell the different types of planes apart to implement the different
557 * uapi semantics for them. For userspace which is universal plane aware and
558 * which is using that atomic IOCTL there's no difference between these planes
559 * (beyong what the driver and hardware can support of course).
560 *
561 * For compatibility with legacy userspace, only overlay planes are made
562 * available to userspace by default. Userspace clients may set the
563 * &DRM_CLIENT_CAP_UNIVERSAL_PLANES client capability bit to indicate that they
564 * wish to receive a universal plane list containing all plane types. See also
565 * drm_for_each_legacy_plane().
566 *
567 * In addition to setting each plane's type, drivers need to setup the
568 * &drm_crtc.primary and optionally &drm_crtc.cursor pointers for legacy
569 * IOCTLs. See drm_crtc_init_with_planes().
570 *
571 * WARNING: The values of this enum is UABI since they're exposed in the "type"
572 * property.
573 */
574enum drm_plane_type {
575 /**
576 * @DRM_PLANE_TYPE_OVERLAY:
577 *
578 * Overlay planes represent all non-primary, non-cursor planes. Some
579 * drivers refer to these types of planes as "sprites" internally.
580 */
581 DRM_PLANE_TYPE_OVERLAY,
582
583 /**
584 * @DRM_PLANE_TYPE_PRIMARY:
585 *
586 * A primary plane attached to a CRTC is the most likely to be able to
587 * light up the CRTC when no scaling/cropping is used and the plane
588 * covers the whole CRTC.
589 */
590 DRM_PLANE_TYPE_PRIMARY,
591
592 /**
593 * @DRM_PLANE_TYPE_CURSOR:
594 *
595 * A cursor plane attached to a CRTC is more likely to be able to be
596 * enabled when no scaling/cropping is used and the framebuffer has the
597 * size indicated by &drm_mode_config.cursor_width and
598 * &drm_mode_config.cursor_height. Additionally, if the driver doesn't
599 * support modifiers, the framebuffer should have a linear layout.
600 */
601 DRM_PLANE_TYPE_CURSOR,
602};
603
604
605/**
606 * struct drm_plane - central DRM plane control structure
607 *
608 * Planes represent the scanout hardware of a display block. They receive their
609 * input data from a &drm_framebuffer and feed it to a &drm_crtc. Planes control
610 * the color conversion, see `Plane Composition Properties`_ for more details,
611 * and are also involved in the color conversion of input pixels, see `Color
612 * Management Properties`_ for details on that.
613 */
614struct drm_plane {
615 /** @dev: DRM device this plane belongs to */
616 struct drm_device *dev;
617
618 /**
619 * @head:
620 *
621 * List of all planes on @dev, linked from &drm_mode_config.plane_list.
622 * Invariant over the lifetime of @dev and therefore does not need
623 * locking.
624 */
625 struct list_head head;
626
627 /** @name: human readable name, can be overwritten by the driver */
628 char *name;
629
630 /**
631 * @mutex:
632 *
633 * Protects modeset plane state, together with the &drm_crtc.mutex of
634 * CRTC this plane is linked to (when active, getting activated or
635 * getting disabled).
636 *
637 * For atomic drivers specifically this protects @state.
638 */
639 struct drm_modeset_lock mutex;
640
641 /** @base: base mode object */
642 struct drm_mode_object base;
643
644 /**
645 * @possible_crtcs: pipes this plane can be bound to constructed from
646 * drm_crtc_mask()
647 */
648 uint32_t possible_crtcs;
649 /** @format_types: array of formats supported by this plane */
650 uint32_t *format_types;
651 /** @format_count: Size of the array pointed at by @format_types. */
652 unsigned int format_count;
653 /**
654 * @format_default: driver hasn't supplied supported formats for the
655 * plane. Used by the non-atomic driver compatibility wrapper only.
656 */
657 bool format_default;
658
659 /** @modifiers: array of modifiers supported by this plane */
660 uint64_t *modifiers;
661 /** @modifier_count: Size of the array pointed at by @modifier_count. */
662 unsigned int modifier_count;
663
664 /**
665 * @crtc:
666 *
667 * Currently bound CRTC, only meaningful for non-atomic drivers. For
668 * atomic drivers this is forced to be NULL, atomic drivers should
669 * instead check &drm_plane_state.crtc.
670 */
671 struct drm_crtc *crtc;
672
673 /**
674 * @fb:
675 *
676 * Currently bound framebuffer, only meaningful for non-atomic drivers.
677 * For atomic drivers this is forced to be NULL, atomic drivers should
678 * instead check &drm_plane_state.fb.
679 */
680 struct drm_framebuffer *fb;
681
682 /**
683 * @old_fb:
684 *
685 * Temporary tracking of the old fb while a modeset is ongoing. Only
686 * used by non-atomic drivers, forced to be NULL for atomic drivers.
687 */
688 struct drm_framebuffer *old_fb;
689
690 /** @funcs: plane control functions */
691 const struct drm_plane_funcs *funcs;
692
693 /** @properties: property tracking for this plane */
694 struct drm_object_properties properties;
695
696 /** @type: Type of plane, see &enum drm_plane_type for details. */
697 enum drm_plane_type type;
698
699 /**
700 * @index: Position inside the mode_config.list, can be used as an array
701 * index. It is invariant over the lifetime of the plane.
702 */
703 unsigned index;
704
705 /** @helper_private: mid-layer private data */
706 const struct drm_plane_helper_funcs *helper_private;
707
708 /**
709 * @state:
710 *
711 * Current atomic state for this plane.
712 *
713 * This is protected by @mutex. Note that nonblocking atomic commits
714 * access the current plane state without taking locks. Either by going
715 * through the &struct drm_atomic_state pointers, see
716 * for_each_oldnew_plane_in_state(), for_each_old_plane_in_state() and
717 * for_each_new_plane_in_state(). Or through careful ordering of atomic
718 * commit operations as implemented in the atomic helpers, see
719 * &struct drm_crtc_commit.
720 */
721 struct drm_plane_state *state;
722
723 /**
724 * @alpha_property:
725 * Optional alpha property for this plane. See
726 * drm_plane_create_alpha_property().
727 */
728 struct drm_property *alpha_property;
729 /**
730 * @zpos_property:
731 * Optional zpos property for this plane. See
732 * drm_plane_create_zpos_property().
733 */
734 struct drm_property *zpos_property;
735 /**
736 * @rotation_property:
737 * Optional rotation property for this plane. See
738 * drm_plane_create_rotation_property().
739 */
740 struct drm_property *rotation_property;
741 /**
742 * @blend_mode_property:
743 * Optional "pixel blend mode" enum property for this plane.
744 * Blend mode property represents the alpha blending equation selection,
745 * describing how the pixels from the current plane are composited with
746 * the background.
747 */
748 struct drm_property *blend_mode_property;
749
750 /**
751 * @color_encoding_property:
752 *
753 * Optional "COLOR_ENCODING" enum property for specifying
754 * color encoding for non RGB formats.
755 * See drm_plane_create_color_properties().
756 */
757 struct drm_property *color_encoding_property;
758 /**
759 * @color_range_property:
760 *
761 * Optional "COLOR_RANGE" enum property for specifying
762 * color range for non RGB formats.
763 * See drm_plane_create_color_properties().
764 */
765 struct drm_property *color_range_property;
766
767 /**
768 * @scaling_filter_property: property to apply a particular filter while
769 * scaling.
770 */
771 struct drm_property *scaling_filter_property;
772
773 /**
774 * @hotspot_x_property: property to set mouse hotspot x offset.
775 */
776 struct drm_property *hotspot_x_property;
777
778 /**
779 * @hotspot_y_property: property to set mouse hotspot y offset.
780 */
781 struct drm_property *hotspot_y_property;
782};
783
784#define obj_to_plane(x) container_of(x, struct drm_plane, base)
785
786__printf(9, 10)
787int drm_universal_plane_init(struct drm_device *dev,
788 struct drm_plane *plane,
789 uint32_t possible_crtcs,
790 const struct drm_plane_funcs *funcs,
791 const uint32_t *formats,
792 unsigned int format_count,
793 const uint64_t *format_modifiers,
794 enum drm_plane_type type,
795 const char *name, ...);
796void drm_plane_cleanup(struct drm_plane *plane);
797
798__printf(10, 11)
799void *__drmm_universal_plane_alloc(struct drm_device *dev,
800 size_t size, size_t offset,
801 uint32_t possible_crtcs,
802 const struct drm_plane_funcs *funcs,
803 const uint32_t *formats,
804 unsigned int format_count,
805 const uint64_t *format_modifiers,
806 enum drm_plane_type plane_type,
807 const char *name, ...);
808
809/**
810 * drmm_universal_plane_alloc - Allocate and initialize an universal plane object
811 * @dev: DRM device
812 * @type: the type of the struct which contains struct &drm_plane
813 * @member: the name of the &drm_plane within @type
814 * @possible_crtcs: bitmask of possible CRTCs
815 * @funcs: callbacks for the new plane
816 * @formats: array of supported formats (DRM_FORMAT\_\*)
817 * @format_count: number of elements in @formats
818 * @format_modifiers: array of struct drm_format modifiers terminated by
819 * DRM_FORMAT_MOD_INVALID
820 * @plane_type: type of plane (overlay, primary, cursor)
821 * @name: printf style format string for the plane name, or NULL for default name
822 *
823 * Allocates and initializes a plane object of type @type. Cleanup is
824 * automatically handled through registering drm_plane_cleanup() with
825 * drmm_add_action().
826 *
827 * The @drm_plane_funcs.destroy hook must be NULL.
828 *
829 * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set
830 * @format_modifiers to NULL. The plane will advertise the linear modifier.
831 *
832 * Returns:
833 * Pointer to new plane, or ERR_PTR on failure.
834 */
835#define drmm_universal_plane_alloc(dev, type, member, possible_crtcs, funcs, formats, \
836 format_count, format_modifiers, plane_type, name, ...) \
837 ((type *)__drmm_universal_plane_alloc(dev, sizeof(type), \
838 offsetof(type, member), \
839 possible_crtcs, funcs, formats, \
840 format_count, format_modifiers, \
841 plane_type, name, ##__VA_ARGS__))
842
843__printf(10, 11)
844void *__drm_universal_plane_alloc(struct drm_device *dev,
845 size_t size, size_t offset,
846 uint32_t possible_crtcs,
847 const struct drm_plane_funcs *funcs,
848 const uint32_t *formats,
849 unsigned int format_count,
850 const uint64_t *format_modifiers,
851 enum drm_plane_type plane_type,
852 const char *name, ...);
853
854/**
855 * drm_universal_plane_alloc() - Allocate and initialize an universal plane object
856 * @dev: DRM device
857 * @type: the type of the struct which contains struct &drm_plane
858 * @member: the name of the &drm_plane within @type
859 * @possible_crtcs: bitmask of possible CRTCs
860 * @funcs: callbacks for the new plane
861 * @formats: array of supported formats (DRM_FORMAT\_\*)
862 * @format_count: number of elements in @formats
863 * @format_modifiers: array of struct drm_format modifiers terminated by
864 * DRM_FORMAT_MOD_INVALID
865 * @plane_type: type of plane (overlay, primary, cursor)
866 * @name: printf style format string for the plane name, or NULL for default name
867 *
868 * Allocates and initializes a plane object of type @type. The caller
869 * is responsible for releasing the allocated memory with kfree().
870 *
871 * Drivers are encouraged to use drmm_universal_plane_alloc() instead.
872 *
873 * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set
874 * @format_modifiers to NULL. The plane will advertise the linear modifier.
875 *
876 * Returns:
877 * Pointer to new plane, or ERR_PTR on failure.
878 */
879#define drm_universal_plane_alloc(dev, type, member, possible_crtcs, funcs, formats, \
880 format_count, format_modifiers, plane_type, name, ...) \
881 ((type *)__drm_universal_plane_alloc(dev, sizeof(type), \
882 offsetof(type, member), \
883 possible_crtcs, funcs, formats, \
884 format_count, format_modifiers, \
885 plane_type, name, ##__VA_ARGS__))
886
887/**
888 * drm_plane_index - find the index of a registered plane
889 * @plane: plane to find index for
890 *
891 * Given a registered plane, return the index of that plane within a DRM
892 * device's list of planes.
893 */
894static inline unsigned int drm_plane_index(const struct drm_plane *plane)
895{
896 return plane->index;
897}
898
899/**
900 * drm_plane_mask - find the mask of a registered plane
901 * @plane: plane to find mask for
902 */
903static inline u32 drm_plane_mask(const struct drm_plane *plane)
904{
905 return 1 << drm_plane_index(plane);
906}
907
908struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
909void drm_plane_force_disable(struct drm_plane *plane);
910
911int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
912 struct drm_property *property,
913 uint64_t value);
914
915/**
916 * drm_plane_find - find a &drm_plane
917 * @dev: DRM device
918 * @file_priv: drm file to check for lease against.
919 * @id: plane id
920 *
921 * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
922 * drm_mode_object_find().
923 */
924static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
925 struct drm_file *file_priv,
926 uint32_t id)
927{
928 struct drm_mode_object *mo;
929 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_PLANE);
930 return mo ? obj_to_plane(mo) : NULL;
931}
932
933/**
934 * drm_for_each_plane_mask - iterate over planes specified by bitmask
935 * @plane: the loop cursor
936 * @dev: the DRM device
937 * @plane_mask: bitmask of plane indices
938 *
939 * Iterate over all planes specified by bitmask.
940 */
941#define drm_for_each_plane_mask(plane, dev, plane_mask) \
942 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
943 for_each_if ((plane_mask) & drm_plane_mask(plane))
944
945/**
946 * drm_for_each_legacy_plane - iterate over all planes for legacy userspace
947 * @plane: the loop cursor
948 * @dev: the DRM device
949 *
950 * Iterate over all legacy planes of @dev, excluding primary and cursor planes.
951 * This is useful for implementing userspace apis when userspace is not
952 * universal plane aware. See also &enum drm_plane_type.
953 */
954#define drm_for_each_legacy_plane(plane, dev) \
955 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
956 for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
957
958/**
959 * drm_for_each_plane - iterate over all planes
960 * @plane: the loop cursor
961 * @dev: the DRM device
962 *
963 * Iterate over all planes of @dev, include primary and cursor planes.
964 */
965#define drm_for_each_plane(plane, dev) \
966 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
967
968bool drm_any_plane_has_format(struct drm_device *dev,
969 u32 format, u64 modifier);
970
971void drm_plane_enable_fb_damage_clips(struct drm_plane *plane);
972unsigned int
973drm_plane_get_damage_clips_count(const struct drm_plane_state *state);
974struct drm_mode_rect *
975drm_plane_get_damage_clips(const struct drm_plane_state *state);
976
977int drm_plane_create_scaling_filter_property(struct drm_plane *plane,
978 unsigned int supported_filters);
979
980#endif