2 * Copyright (c) 2016 Intel Corporation
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.
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
23 #ifndef __DRM_PLANE_H__
24 #define __DRM_PLANE_H__
26 #include <linux/list.h>
27 #include <linux/ctype.h>
28 #include <drm/drm_mode_object.h>
29 #include <drm/drm_color_mgmt.h>
33 struct drm_modeset_acquire_ctx;
36 * struct drm_plane_state - mutable plane state
38 * Please not that the destination coordinates @crtc_x, @crtc_y, @crtc_h and
39 * @crtc_w and the source coordinates @src_x, @src_y, @src_h and @src_w are the
40 * raw coordinates provided by userspace. Drivers should use
41 * drm_atomic_helper_check_plane_state() and only use the derived rectangles in
42 * @src and @dst to program the hardware.
44 struct drm_plane_state {
45 /** @plane: backpointer to the plane */
46 struct drm_plane *plane;
51 * Currently bound CRTC, NULL if disabled. Do not this write directly,
52 * use drm_atomic_set_crtc_for_plane()
54 struct drm_crtc *crtc;
59 * Currently bound framebuffer. Do not write this directly, use
60 * drm_atomic_set_fb_for_plane()
62 struct drm_framebuffer *fb;
67 * Optional fence to wait for before scanning out @fb. The core atomic
68 * code will set this when userspace is using explicit fencing. Do not
69 * write this directly for a driver's implicit fence, use
70 * drm_atomic_set_fence_for_plane() to ensure that an explicit fence is
73 * Drivers should store any implicit fence in this from their
74 * &drm_plane_helper_funcs.prepare_fb callback. See drm_gem_fb_prepare_fb()
75 * and drm_gem_fb_simple_display_pipe_prepare_fb() for suitable helpers.
77 struct dma_fence *fence;
82 * Left position of visible portion of plane on crtc, signed dest
83 * location allows it to be partially off screen.
90 * Upper position of visible portion of plane on crtc, signed dest
91 * location allows it to be partially off screen.
95 /** @crtc_w: width of visible portion of plane on crtc */
96 /** @crtc_h: height of visible portion of plane on crtc */
97 uint32_t crtc_w, crtc_h;
100 * @src_x: left position of visible portion of plane within plane (in
101 * 16.16 fixed point).
105 * @src_y: upper position of visible portion of plane within plane (in
106 * 16.16 fixed point).
109 /** @src_w: width of visible portion of plane (in 16.16) */
110 /** @src_h: height of visible portion of plane (in 16.16) */
111 uint32_t src_h, src_w;
115 * Opacity of the plane with 0 as completely transparent and 0xffff as
116 * completely opaque. See drm_plane_create_alpha_property() for more
123 * The alpha blending equation selection, describing how the pixels from
124 * the current plane are composited with the background. Value can be
125 * one of DRM_MODE_BLEND_*
127 uint16_t pixel_blend_mode;
131 * Rotation of the plane. See drm_plane_create_rotation_property() for
134 unsigned int rotation;
138 * Priority of the given plane on crtc (optional).
140 * Note that multiple active planes on the same crtc can have an
141 * identical zpos value. The rule to solving the conflict is to compare
142 * the plane object IDs; the plane with a higher ID must be stacked on
143 * top of a plane with a lower ID.
145 * See drm_plane_create_zpos_property() and
146 * drm_plane_create_zpos_immutable_property() for more details.
152 * Normalized value of zpos: unique, range from 0 to N-1 where N is the
153 * number of active planes for given crtc. Note that the driver must set
154 * &drm_mode_config.normalize_zpos or call drm_atomic_normalize_zpos() to
155 * update this before it can be trusted.
157 unsigned int normalized_zpos;
162 * Color encoding for non RGB formats
164 enum drm_color_encoding color_encoding;
169 * Color range for non RGB formats
171 enum drm_color_range color_range;
173 /** @src: clipped source coordinates of the plane (in 16.16) */
174 /** @dst: clipped destination coordinates of the plane */
175 struct drm_rect src, dst;
180 * Visibility of the plane. This can be false even if fb!=NULL and
181 * crtc!=NULL, due to clipping.
186 * @commit: Tracks the pending commit to prevent use-after-free conditions,
187 * and for async plane updates.
191 struct drm_crtc_commit *commit;
193 /** @state: backpointer to global drm_atomic_state */
194 struct drm_atomic_state *state;
197 static inline struct drm_rect
198 drm_plane_state_src(const struct drm_plane_state *state)
200 struct drm_rect src = {
203 .x2 = state->src_x + state->src_w,
204 .y2 = state->src_y + state->src_h,
209 static inline struct drm_rect
210 drm_plane_state_dest(const struct drm_plane_state *state)
212 struct drm_rect dest = {
215 .x2 = state->crtc_x + state->crtc_w,
216 .y2 = state->crtc_y + state->crtc_h,
222 * struct drm_plane_funcs - driver plane control functions
224 struct drm_plane_funcs {
228 * This is the legacy entry point to enable and configure the plane for
229 * the given CRTC and framebuffer. It is never called to disable the
230 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
232 * The source rectangle in frame buffer memory coordinates is given by
233 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
234 * values). Devices that don't support subpixel plane coordinates can
235 * ignore the fractional part.
237 * The destination rectangle in CRTC coordinates is given by the
238 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
239 * Devices scale the source rectangle to the destination rectangle. If
240 * scaling is not supported, and the source rectangle size doesn't match
241 * the destination rectangle size, the driver must return a
242 * -<errorname>EINVAL</errorname> error.
244 * Drivers implementing atomic modeset should use
245 * drm_atomic_helper_update_plane() to implement this hook.
249 * 0 on success or a negative error code on failure.
251 int (*update_plane)(struct drm_plane *plane,
252 struct drm_crtc *crtc, struct drm_framebuffer *fb,
253 int crtc_x, int crtc_y,
254 unsigned int crtc_w, unsigned int crtc_h,
255 uint32_t src_x, uint32_t src_y,
256 uint32_t src_w, uint32_t src_h,
257 struct drm_modeset_acquire_ctx *ctx);
262 * This is the legacy entry point to disable the plane. The DRM core
263 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call
264 * with the frame buffer ID set to 0. Disabled planes must not be
265 * processed by the CRTC.
267 * Drivers implementing atomic modeset should use
268 * drm_atomic_helper_disable_plane() to implement this hook.
272 * 0 on success or a negative error code on failure.
274 int (*disable_plane)(struct drm_plane *plane,
275 struct drm_modeset_acquire_ctx *ctx);
280 * Clean up plane resources. This is only called at driver unload time
281 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
284 void (*destroy)(struct drm_plane *plane);
289 * Reset plane hardware and software state to off. This function isn't
290 * called by the core directly, only through drm_mode_config_reset().
291 * It's not a helper hook only for historical reasons.
293 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
294 * atomic state using this hook.
296 void (*reset)(struct drm_plane *plane);
301 * This is the legacy entry point to update a property attached to the
304 * This callback is optional if the driver does not support any legacy
305 * driver-private properties. For atomic drivers it is not used because
306 * property handling is done entirely in the DRM core.
310 * 0 on success or a negative error code on failure.
312 int (*set_property)(struct drm_plane *plane,
313 struct drm_property *property, uint64_t val);
316 * @atomic_duplicate_state:
318 * Duplicate the current atomic state for this plane and return it.
319 * The core and helpers guarantee that any atomic state duplicated with
320 * this hook and still owned by the caller (i.e. not transferred to the
321 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
322 * cleaned up by calling the @atomic_destroy_state hook in this
325 * This callback is mandatory for atomic drivers.
327 * Atomic drivers which don't subclass &struct drm_plane_state should use
328 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
329 * state structure to extend it with driver-private state should use
330 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
331 * duplicated in a consistent fashion across drivers.
333 * It is an error to call this hook before &drm_plane.state has been
334 * initialized correctly.
338 * If the duplicate state references refcounted resources this hook must
339 * acquire a reference for each of them. The driver must release these
340 * references again in @atomic_destroy_state.
344 * Duplicated atomic state or NULL when the allocation failed.
346 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
349 * @atomic_destroy_state:
351 * Destroy a state duplicated with @atomic_duplicate_state and release
352 * or unreference all resources it references
354 * This callback is mandatory for atomic drivers.
356 void (*atomic_destroy_state)(struct drm_plane *plane,
357 struct drm_plane_state *state);
360 * @atomic_set_property:
362 * Decode a driver-private property value and store the decoded value
363 * into the passed-in state structure. Since the atomic core decodes all
364 * standardized properties (even for extensions beyond the core set of
365 * properties which might not be implemented by all drivers) this
366 * requires drivers to subclass the state structure.
368 * Such driver-private properties should really only be implemented for
369 * truly hardware/vendor specific state. Instead it is preferred to
370 * standardize atomic extension and decode the properties used to expose
371 * such an extension in the core.
373 * Do not call this function directly, use
374 * drm_atomic_plane_set_property() instead.
376 * This callback is optional if the driver does not support any
377 * driver-private atomic properties.
381 * This function is called in the state assembly phase of atomic
382 * modesets, which can be aborted for any reason (including on
383 * userspace's request to just check whether a configuration would be
384 * possible). Drivers MUST NOT touch any persistent state (hardware or
385 * software) or data structures except the passed in @state parameter.
387 * Also since userspace controls in which order properties are set this
388 * function must not do any input validation (since the state update is
389 * incomplete and hence likely inconsistent). Instead any such input
390 * validation must be done in the various atomic_check callbacks.
394 * 0 if the property has been found, -EINVAL if the property isn't
395 * implemented by the driver (which shouldn't ever happen, the core only
396 * asks for properties attached to this plane). No other validation is
397 * allowed by the driver. The core already checks that the property
398 * value is within the range (integer, valid enum value, ...) the driver
399 * set when registering the property.
401 int (*atomic_set_property)(struct drm_plane *plane,
402 struct drm_plane_state *state,
403 struct drm_property *property,
407 * @atomic_get_property:
409 * Reads out the decoded driver-private property. This is used to
410 * implement the GETPLANE IOCTL.
412 * Do not call this function directly, use
413 * drm_atomic_plane_get_property() instead.
415 * This callback is optional if the driver does not support any
416 * driver-private atomic properties.
420 * 0 on success, -EINVAL if the property isn't implemented by the
421 * driver (which should never happen, the core only asks for
422 * properties attached to this plane).
424 int (*atomic_get_property)(struct drm_plane *plane,
425 const struct drm_plane_state *state,
426 struct drm_property *property,
431 * This optional hook can be used to register additional userspace
432 * interfaces attached to the plane like debugfs interfaces.
433 * It is called late in the driver load sequence from drm_dev_register().
434 * Everything added from this callback should be unregistered in
435 * the early_unregister callback.
439 * 0 on success, or a negative error code on failure.
441 int (*late_register)(struct drm_plane *plane);
446 * This optional hook should be used to unregister the additional
447 * userspace interfaces attached to the plane from
448 * @late_register. It is called from drm_dev_unregister(),
449 * early in the driver unload sequence to disable userspace access
450 * before data structures are torndown.
452 void (*early_unregister)(struct drm_plane *plane);
455 * @atomic_print_state:
457 * If driver subclasses &struct drm_plane_state, it should implement
458 * this optional hook for printing additional driver specific state.
460 * Do not call this directly, use drm_atomic_plane_print_state()
463 void (*atomic_print_state)(struct drm_printer *p,
464 const struct drm_plane_state *state);
467 * @format_mod_supported:
469 * This optional hook is used for the DRM to determine if the given
470 * format/modifier combination is valid for the plane. This allows the
471 * DRM to generate the correct format bitmask (which formats apply to
472 * which modifier), and to valdiate modifiers at atomic_check time.
474 * If not present, then any modifier in the plane's modifier
475 * list is allowed with any of the plane's formats.
479 * True if the given modifier is valid for that format on the plane.
482 bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format,
487 * enum drm_plane_type - uapi plane type enumeration
489 * For historical reasons not all planes are made the same. This enumeration is
490 * used to tell the different types of planes apart to implement the different
491 * uapi semantics for them. For userspace which is universal plane aware and
492 * which is using that atomic IOCTL there's no difference between these planes
493 * (beyong what the driver and hardware can support of course).
495 * For compatibility with legacy userspace, only overlay planes are made
496 * available to userspace by default. Userspace clients may set the
497 * DRM_CLIENT_CAP_UNIVERSAL_PLANES client capability bit to indicate that they
498 * wish to receive a universal plane list containing all plane types. See also
499 * drm_for_each_legacy_plane().
501 * WARNING: The values of this enum is UABI since they're exposed in the "type"
504 enum drm_plane_type {
506 * @DRM_PLANE_TYPE_OVERLAY:
508 * Overlay planes represent all non-primary, non-cursor planes. Some
509 * drivers refer to these types of planes as "sprites" internally.
511 DRM_PLANE_TYPE_OVERLAY,
514 * @DRM_PLANE_TYPE_PRIMARY:
516 * Primary planes represent a "main" plane for a CRTC. Primary planes
517 * are the planes operated upon by CRTC modesetting and flipping
518 * operations described in the &drm_crtc_funcs.page_flip and
519 * &drm_crtc_funcs.set_config hooks.
521 DRM_PLANE_TYPE_PRIMARY,
524 * @DRM_PLANE_TYPE_CURSOR:
526 * Cursor planes represent a "cursor" plane for a CRTC. Cursor planes
527 * are the planes operated upon by the DRM_IOCTL_MODE_CURSOR and
528 * DRM_IOCTL_MODE_CURSOR2 IOCTLs.
530 DRM_PLANE_TYPE_CURSOR,
535 * struct drm_plane - central DRM plane control structure
537 * Planes represent the scanout hardware of a display block. They receive their
538 * input data from a &drm_framebuffer and feed it to a &drm_crtc. Planes control
539 * the color conversion, see `Plane Composition Properties`_ for more details,
540 * and are also involved in the color conversion of input pixels, see `Color
541 * Management Properties`_ for details on that.
544 /** @dev: DRM device this plane belongs to */
545 struct drm_device *dev;
550 * List of all planes on @dev, linked from &drm_mode_config.plane_list.
551 * Invariant over the lifetime of @dev and therefore does not need
554 struct list_head head;
556 /** @name: human readable name, can be overwritten by the driver */
562 * Protects modeset plane state, together with the &drm_crtc.mutex of
563 * CRTC this plane is linked to (when active, getting activated or
566 * For atomic drivers specifically this protects @state.
568 struct drm_modeset_lock mutex;
570 /** @base: base mode object */
571 struct drm_mode_object base;
574 * @possible_crtcs: pipes this plane can be bound to constructed from
577 uint32_t possible_crtcs;
578 /** @format_types: array of formats supported by this plane */
579 uint32_t *format_types;
580 /** @format_count: Size of the array pointed at by @format_types. */
581 unsigned int format_count;
583 * @format_default: driver hasn't supplied supported formats for the
584 * plane. Used by the drm_plane_init compatibility wrapper only.
588 /** @modifiers: array of modifiers supported by this plane */
590 /** @modifier_count: Size of the array pointed at by @modifier_count. */
591 unsigned int modifier_count;
596 * Currently bound CRTC, only meaningful for non-atomic drivers. For
597 * atomic drivers this is forced to be NULL, atomic drivers should
598 * instead check &drm_plane_state.crtc.
600 struct drm_crtc *crtc;
605 * Currently bound framebuffer, only meaningful for non-atomic drivers.
606 * For atomic drivers this is forced to be NULL, atomic drivers should
607 * instead check &drm_plane_state.fb.
609 struct drm_framebuffer *fb;
614 * Temporary tracking of the old fb while a modeset is ongoing. Only
615 * used by non-atomic drivers, forced to be NULL for atomic drivers.
617 struct drm_framebuffer *old_fb;
619 /** @funcs: plane control functions */
620 const struct drm_plane_funcs *funcs;
622 /** @properties: property tracking for this plane */
623 struct drm_object_properties properties;
625 /** @type: Type of plane, see &enum drm_plane_type for details. */
626 enum drm_plane_type type;
629 * @index: Position inside the mode_config.list, can be used as an array
630 * index. It is invariant over the lifetime of the plane.
634 /** @helper_private: mid-layer private data */
635 const struct drm_plane_helper_funcs *helper_private;
640 * Current atomic state for this plane.
642 * This is protected by @mutex. Note that nonblocking atomic commits
643 * access the current plane state without taking locks. Either by going
644 * through the &struct drm_atomic_state pointers, see
645 * for_each_oldnew_plane_in_state(), for_each_old_plane_in_state() and
646 * for_each_new_plane_in_state(). Or through careful ordering of atomic
647 * commit operations as implemented in the atomic helpers, see
648 * &struct drm_crtc_commit.
650 struct drm_plane_state *state;
654 * Optional alpha property for this plane. See
655 * drm_plane_create_alpha_property().
657 struct drm_property *alpha_property;
660 * Optional zpos property for this plane. See
661 * drm_plane_create_zpos_property().
663 struct drm_property *zpos_property;
665 * @rotation_property:
666 * Optional rotation property for this plane. See
667 * drm_plane_create_rotation_property().
669 struct drm_property *rotation_property;
671 * @blend_mode_property:
672 * Optional "pixel blend mode" enum property for this plane.
673 * Blend mode property represents the alpha blending equation selection,
674 * describing how the pixels from the current plane are composited with
677 struct drm_property *blend_mode_property;
680 * @color_encoding_property:
682 * Optional "COLOR_ENCODING" enum property for specifying
683 * color encoding for non RGB formats.
684 * See drm_plane_create_color_properties().
686 struct drm_property *color_encoding_property;
688 * @color_range_property:
690 * Optional "COLOR_RANGE" enum property for specifying
691 * color range for non RGB formats.
692 * See drm_plane_create_color_properties().
694 struct drm_property *color_range_property;
697 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
700 int drm_universal_plane_init(struct drm_device *dev,
701 struct drm_plane *plane,
702 uint32_t possible_crtcs,
703 const struct drm_plane_funcs *funcs,
704 const uint32_t *formats,
705 unsigned int format_count,
706 const uint64_t *format_modifiers,
707 enum drm_plane_type type,
708 const char *name, ...);
709 int drm_plane_init(struct drm_device *dev,
710 struct drm_plane *plane,
711 uint32_t possible_crtcs,
712 const struct drm_plane_funcs *funcs,
713 const uint32_t *formats, unsigned int format_count,
715 void drm_plane_cleanup(struct drm_plane *plane);
718 * drm_plane_index - find the index of a registered plane
719 * @plane: plane to find index for
721 * Given a registered plane, return the index of that plane within a DRM
722 * device's list of planes.
724 static inline unsigned int drm_plane_index(const struct drm_plane *plane)
730 * drm_plane_mask - find the mask of a registered plane
731 * @plane: plane to find mask for
733 static inline u32 drm_plane_mask(const struct drm_plane *plane)
735 return 1 << drm_plane_index(plane);
738 struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
739 void drm_plane_force_disable(struct drm_plane *plane);
741 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
742 struct drm_property *property,
746 * drm_plane_find - find a &drm_plane
748 * @file_priv: drm file to check for lease against.
751 * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
752 * drm_mode_object_find().
754 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
755 struct drm_file *file_priv,
758 struct drm_mode_object *mo;
759 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_PLANE);
760 return mo ? obj_to_plane(mo) : NULL;
764 * drm_for_each_plane_mask - iterate over planes specified by bitmask
765 * @plane: the loop cursor
766 * @dev: the DRM device
767 * @plane_mask: bitmask of plane indices
769 * Iterate over all planes specified by bitmask.
771 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
772 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
773 for_each_if ((plane_mask) & drm_plane_mask(plane))
776 * drm_for_each_legacy_plane - iterate over all planes for legacy userspace
777 * @plane: the loop cursor
778 * @dev: the DRM device
780 * Iterate over all legacy planes of @dev, excluding primary and cursor planes.
781 * This is useful for implementing userspace apis when userspace is not
782 * universal plane aware. See also &enum drm_plane_type.
784 #define drm_for_each_legacy_plane(plane, dev) \
785 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
786 for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
789 * drm_for_each_plane - iterate over all planes
790 * @plane: the loop cursor
791 * @dev: the DRM device
793 * Iterate over all planes of @dev, include primary and cursor planes.
795 #define drm_for_each_plane(plane, dev) \
796 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)