projects/linux·blob master · refs

1044 lines · 32.8 KiB

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