include/drm/drm_crtc.h

3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
67  * struct drm_crtc_state - mutable CRTC state
78  * describing what has changed in a commit. See also:
114 	 * @mode_changed: @mode or @enable has been changed. Used by the atomic
120 	 * @mode change can be done without a full modeset by only changing
126 	 * @active_changed: @active has been toggled. Used by the atomic
138 	 * Drivers are supposed to set this as-needed from their own atomic
173 	 * oneshot mode. In this case the fake VBLANK event is only generated
185 	 * writeback connector attached to the CRTC has a new job queued. In
213 	 * differences between the mode requested by userspace in @mode and what
225 	 * @mode:
235 	 * built-in panel), this mode here should match the physical mode on the
239 	struct drm_display_mode mode;  member
242 	 * @mode_blob: &drm_property_blob for @mode, for exposing the mode to
288 	 * This is set when DRM_MODE_PAGE_FLIP_ASYNC is set in the legacy
298 	 * hardware capabiltiy - lacking support is not treated as failure.
327 	 *  - The event is for a CRTC which is being disabled through this
329 	 *    after the hardware has stopped scanning out the current
333 	 *    somewhen after drm_crtc_vblank_off() has been called.
335 	 *  - For a CRTC which is enabled at the end of the commit (even when it
339 	 *    hardware has stopped scanning out the old buffers.
341 	 *  - Events for disabled CRTCs are not allowed, and drivers can ignore
369 	 * If the device can't notify of flip completion in a race-free way
391  * struct drm_crtc_funcs - control CRTCs for a given device
421 	 * Note that contrary to all other KMS functions the legacy cursor entry
489 	 * drm_crtc_enable_color_mgmt(), which then supports the legacy gamma
509 	 * This is the main legacy entry point to change the modeset state on a
511 	 * &struct drm_mode_set - see there for details.
526 	 * Legacy entry point to schedule a flip to the given framebuffer.
534 	 * configured mode and then calls this hook with a pointer to the new
540 	 * shared dma-buf.
542 	 * An application can request to be notified when the page flip has
562 	 * flip operation has completed and the old framebuffer is no longer
563 	 * visible. This requirement has been lifted, and userspace is instead
565 	 * buffers until such has been received.
571 	 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
573 	 * "ACTIVE" state) should result in an -EINVAL error code. Note that
591 	 * any non-0 error code. It's the driver's responsibility to call
604 	 * This is the legacy entry point to update a property attached to the
607 	 * This callback is optional if the driver does not support any legacy
608 	 * driver-private properties. For atomic drivers it is not used because
632 	 * state structure to extend it with driver-private state should use
636 	 * It is an error to call this hook before &drm_crtc.state has been
665 	 * Decode a driver-private property value and store the decoded value
666 	 * into the passed-in state structure. Since the atomic core decodes all
671 	 * Such driver-private properties should really only be implemented for
680 	 * driver-private atomic properties.
697 	 * 0 if the property has been found, -EINVAL if the property isn't
711 	 * Reads out the decoded driver-private property. This is used to
718 	 * driver-private atomic properties.
722 	 * 0 on success, -EINVAL if the property isn't implemented by the
809 	 * callback does the verification on each crc-source before passing it
912 	 *     need to apply some workarounds for gpu-specific vblank irq quirks
927  * struct drm_crtc - central CRTC control structure
952 	 * This provides a read lock for the overall CRTC state (mode, dpms
967 	 * relevant for legacy IOCTL, it specifies the plane implicitly used by
976 	 * legacy IOCTL, it specifies the plane implicitly used by the SETCURSOR
1008 	 * Is this CRTC enabled? Should only be used by legacy drivers, atomic
1016 	 * @mode:
1018 	 * Current mode timings. Should only be used by legacy drivers, atomic
1019 	 * drivers should instead consult &drm_crtc_state.mode. Atomic drivers
1023 	struct drm_display_mode mode;  member
1028 	 * Programmed mode in hw, after adjustments for encoders, crtc, panel
1029 	 * scaling etc. Should only be used by legacy drivers, for high
1034 	 * &drm_crtc_state.adjusted_mode. And for high-precision timestamps
1043 	 * x position on screen. Should only be used by legacy drivers, atomic
1051 	 * y position on screen. Should only be used by legacy drivers, atomic
1062 	 * @gamma_size: Size of legacy gamma ramp reported to userspace. Set up
1071 	 * @gamma_store: Gamma ramp values used by the legacy SETGAMMA and
1079 	/** @helper_private: mid-layer private data */
1117 	 * any locking or list-walking. @commit_list should only be used to
1181  * struct drm_mode_set - new values for a CRTC config change
1184  * @mode: mode timings to use
1190  * This represents a modeset configuration for the legacy SETCRTC ioctl and is
1196 	struct drm_display_mode *mode;  member
1234  * drmm_crtc_alloc_with_planes - Allocate and initialize a new CRTC object with
1259  * drm_crtc_index - find the index of a registered CRTC
1267 	return crtc->index;  in drm_crtc_index()
1271  * drm_crtc_mask - find the mask of a registered CRTC
1286  * drm_crtc_find - look up a CRTC object from its ID
1292  * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS
1305  * drm_for_each_crtc - iterate over all CRTCs
1312 	list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1315  * drm_for_each_crtc_reverse - iterate over all CRTCs in reverse order
1322 	list_for_each_entry_reverse(crtc, &(dev)->mode_config.crtc_list, head)