2 * Copyright © 2006 Keith Packard
3 * Copyright © 2007-2008 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
5 * Jesse Barnes <jesse.barnes@intel.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
25 #ifndef __DRM_CRTC_H__
26 #define __DRM_CRTC_H__
28 #include <linux/i2c.h>
29 #include <linux/spinlock.h>
30 #include <linux/types.h>
32 #include <linux/hdmi.h>
33 #include <linux/media-bus-format.h>
34 #include <uapi/drm/drm_mode.h>
35 #include <uapi/drm/drm_fourcc.h>
36 #include <drm/drm_modeset_lock.h>
37 #include <drm/drm_rect.h>
38 #include <drm/drm_mode_object.h>
39 #include <drm/drm_framebuffer.h>
40 #include <drm/drm_modes.h>
41 #include <drm/drm_connector.h>
42 #include <drm/drm_device.h>
43 #include <drm/drm_property.h>
44 #include <drm/drm_bridge.h>
45 #include <drm/drm_edid.h>
46 #include <drm/drm_plane.h>
47 #include <drm/drm_blend.h>
48 #include <drm/drm_color_mgmt.h>
49 #include <drm/drm_debugfs_crc.h>
50 #include <drm/drm_mode_config.h>
57 struct drm_self_refresh_data;
62 static inline int64_t U642I64(uint64_t val)
64 return (int64_t)*((int64_t *)&val);
66 static inline uint64_t I642U64(int64_t val)
68 return (uint64_t)*((uint64_t *)&val);
72 struct drm_pending_vblank_event;
75 struct drm_atomic_state;
77 struct drm_crtc_helper_funcs;
78 struct drm_plane_helper_funcs;
81 * struct drm_crtc_state - mutable CRTC state
83 * Note that the distinction between @enable and @active is rather subtle:
84 * Flipping @active while @enable is set without changing anything else may
85 * never return in a failure from the &drm_mode_config_funcs.atomic_check
86 * callback. Userspace assumes that a DPMS On will always succeed. In other
87 * words: @enable controls resource assignment, @active controls the actual
90 * The three booleans active_changed, connectors_changed and mode_changed are
91 * intended to indicate whether a full modeset is needed, rather than strictly
92 * describing what has changed in a commit. See also:
93 * drm_atomic_crtc_needs_modeset()
95 * WARNING: Transitional helpers (like drm_helper_crtc_mode_set() or
96 * drm_helper_crtc_mode_set_base()) do not maintain many of the derived control
97 * state like @plane_mask so drivers not converted over to atomic helpers should
98 * not rely on these being accurate!
100 struct drm_crtc_state {
101 /** @crtc: backpointer to the CRTC */
102 struct drm_crtc *crtc;
105 * @enable: Whether the CRTC should be enabled, gates all other state.
106 * This controls reservations of shared resources. Actual hardware state
107 * is controlled by @active.
112 * @active: Whether the CRTC is actively displaying (used for DPMS).
113 * Implies that @enable is set. The driver must not release any shared
114 * resources if @active is set to false but @enable still true, because
115 * userspace expects that a DPMS ON always succeeds.
117 * Hence drivers must not consult @active in their various
118 * &drm_mode_config_funcs.atomic_check callback to reject an atomic
119 * commit. They can consult it to aid in the computation of derived
120 * hardware state, since even in the DPMS OFF state the display hardware
121 * should be as much powered down as when the CRTC is completely
122 * disabled through setting @enable to false.
127 * @planes_changed: Planes on this crtc are updated. Used by the atomic
128 * helpers and drivers to steer the atomic commit control flow.
130 bool planes_changed : 1;
133 * @mode_changed: @mode or @enable has been changed. Used by the atomic
134 * helpers and drivers to steer the atomic commit control flow. See also
135 * drm_atomic_crtc_needs_modeset().
137 * Drivers are supposed to set this for any CRTC state changes that
138 * require a full modeset. They can also reset it to false if e.g. a
139 * @mode change can be done without a full modeset by only changing
142 bool mode_changed : 1;
145 * @active_changed: @active has been toggled. Used by the atomic
146 * helpers and drivers to steer the atomic commit control flow. See also
147 * drm_atomic_crtc_needs_modeset().
149 bool active_changed : 1;
152 * @connectors_changed: Connectors to this crtc have been updated,
153 * either in their state or routing. Used by the atomic
154 * helpers and drivers to steer the atomic commit control flow. See also
155 * drm_atomic_crtc_needs_modeset().
157 * Drivers are supposed to set this as-needed from their own atomic
158 * check code, e.g. from &drm_encoder_helper_funcs.atomic_check
160 bool connectors_changed : 1;
162 * @zpos_changed: zpos values of planes on this crtc have been updated.
163 * Used by the atomic helpers and drivers to steer the atomic commit
166 bool zpos_changed : 1;
168 * @color_mgmt_changed: Color management properties have changed
169 * (@gamma_lut, @degamma_lut or @ctm). Used by the atomic helpers and
170 * drivers to steer the atomic commit control flow.
172 bool color_mgmt_changed : 1;
177 * Reflects the ability of a CRTC to send VBLANK events. This state
178 * usually depends on the pipeline configuration. If set to true, DRM
179 * atomic helpers will send out a fake VBLANK event during display
180 * updates after all hardware changes have been committed. This is
181 * implemented in drm_atomic_helper_fake_vblank().
183 * One usage is for drivers and/or hardware without support for VBLANK
184 * interrupts. Such drivers typically do not initialize vblanking
185 * (i.e., call drm_vblank_init() with the number of CRTCs). For CRTCs
186 * without initialized vblanking, this field is set to true in
187 * drm_atomic_helper_check_modeset(), and a fake VBLANK event will be
188 * send out on each update of the display pipeline by
189 * drm_atomic_helper_fake_vblank().
191 * Another usage is CRTCs feeding a writeback connector operating in
192 * oneshot mode. In this case the fake VBLANK event is only generated
193 * when a job is queued to the writeback connector, and we want the
194 * core to fake VBLANK events when this part of the pipeline hasn't
195 * changed but others had or when the CRTC and connectors are being
198 * __drm_atomic_helper_crtc_duplicate_state() will not reset the value
199 * from the current state, the CRTC driver is then responsible for
200 * updating this field when needed.
202 * Note that the combination of &drm_crtc_state.event == NULL and
203 * &drm_crtc_state.no_blank == true is valid and usually used when the
204 * writeback connector attached to the CRTC has a new job queued. In
205 * this case the driver will send the VBLANK event on its own when the
206 * writeback job is complete.
211 * @plane_mask: Bitmask of drm_plane_mask(plane) of planes attached to
217 * @connector_mask: Bitmask of drm_connector_mask(connector) of
218 * connectors attached to this CRTC.
223 * @encoder_mask: Bitmask of drm_encoder_mask(encoder) of encoders
224 * attached to this CRTC.
231 * Internal display timings which can be used by the driver to handle
232 * differences between the mode requested by userspace in @mode and what
233 * is actually programmed into the hardware.
235 * For drivers using &drm_bridge, this stores hardware display timings
236 * used between the CRTC and the first bridge. For other drivers, the
237 * meaning of the adjusted_mode field is purely driver implementation
238 * defined information, and will usually be used to store the hardware
239 * display timings used between the CRTC and encoder blocks.
241 struct drm_display_mode adjusted_mode;
246 * Display timings requested by userspace. The driver should try to
247 * match the refresh rate as close as possible (but note that it's
248 * undefined what exactly is close enough, e.g. some of the HDMI modes
249 * only differ in less than 1% of the refresh rate). The active width
250 * and height as observed by userspace for positioning planes must match
253 * For external connectors where the sink isn't fixed (like with a
254 * built-in panel), this mode here should match the physical mode on the
255 * wire to the last details (i.e. including sync polarities and
258 struct drm_display_mode mode;
261 * @mode_blob: &drm_property_blob for @mode, for exposing the mode to
264 struct drm_property_blob *mode_blob;
269 * Lookup table for converting framebuffer pixel data before apply the
270 * color conversion matrix @ctm. See drm_crtc_enable_color_mgmt(). The
271 * blob (if not NULL) is an array of &struct drm_color_lut.
273 struct drm_property_blob *degamma_lut;
278 * Color transformation matrix. See drm_crtc_enable_color_mgmt(). The
279 * blob (if not NULL) is a &struct drm_color_ctm.
281 struct drm_property_blob *ctm;
286 * Lookup table for converting pixel data after the color conversion
287 * matrix @ctm. See drm_crtc_enable_color_mgmt(). The blob (if not
288 * NULL) is an array of &struct drm_color_lut.
290 struct drm_property_blob *gamma_lut;
295 * Target vertical blank period when a page flip
296 * should take effect.
303 * This is set when DRM_MODE_PAGE_FLIP_ASYNC is set in the legacy
304 * PAGE_FLIP IOCTL. It's not wired up for the atomic IOCTL itself yet.
311 * Indicates if variable refresh rate should be enabled for the CRTC.
312 * Support for the requested vrr state will depend on driver and
313 * hardware capabiltiy - lacking support is not treated as failure.
318 * @self_refresh_active:
320 * Used by the self refresh helpers to denote when a self refresh
321 * transition is occurring. This will be set on enable/disable callbacks
322 * when self refresh is being enabled or disabled. In some cases, it may
323 * not be desirable to fully shut off the crtc during self refresh.
324 * CRTC's can inspect this flag and determine the best course of action.
326 bool self_refresh_active;
331 * Optional pointer to a DRM event to signal upon completion of the
332 * state update. The driver must send out the event when the atomic
333 * commit operation completes. There are two cases:
335 * - The event is for a CRTC which is being disabled through this
336 * atomic commit. In that case the event can be send out any time
337 * after the hardware has stopped scanning out the current
338 * framebuffers. It should contain the timestamp and counter for the
339 * last vblank before the display pipeline was shut off. The simplest
340 * way to achieve that is calling drm_crtc_send_vblank_event()
341 * somewhen after drm_crtc_vblank_off() has been called.
343 * - For a CRTC which is enabled at the end of the commit (even when it
344 * undergoes an full modeset) the vblank timestamp and counter must
345 * be for the vblank right before the first frame that scans out the
346 * new set of buffers. Again the event can only be sent out after the
347 * hardware has stopped scanning out the old buffers.
349 * - Events for disabled CRTCs are not allowed, and drivers can ignore
352 * For very simple hardware without VBLANK interrupt, enabling
353 * &struct drm_crtc_state.no_vblank makes DRM's atomic commit helpers
354 * send a fake VBLANK event at the end of the display update after all
355 * hardware changes have been applied. See
356 * drm_atomic_helper_fake_vblank().
358 * For more complex hardware this
359 * can be handled by the drm_crtc_send_vblank_event() function,
360 * which the driver should call on the provided event upon completion of
361 * the atomic commit. Note that if the driver supports vblank signalling
362 * and timestamping the vblank counters and timestamps must agree with
363 * the ones returned from page flip events. With the current vblank
364 * helper infrastructure this can be achieved by holding a vblank
365 * reference while the page flip is pending, acquired through
366 * drm_crtc_vblank_get() and released with drm_crtc_vblank_put().
367 * Drivers are free to implement their own vblank counter and timestamp
368 * tracking though, e.g. if they have accurate timestamp registers in
371 * For hardware which supports some means to synchronize vblank
372 * interrupt delivery with committing display state there's also
373 * drm_crtc_arm_vblank_event(). See the documentation of that function
374 * for a detailed discussion of the constraints it needs to be used
377 * If the device can't notify of flip completion in a race-free way
378 * at all, then the event should be armed just after the page flip is
379 * committed. In the worst case the driver will send the event to
380 * userspace one frame too late. This doesn't allow for a real atomic
381 * update, but it should avoid tearing.
383 struct drm_pending_vblank_event *event;
388 * This tracks how the commit for this update proceeds through the
389 * various phases. This is never cleared, except when we destroy the
390 * state, so that subsequent commits can synchronize with previous ones.
392 struct drm_crtc_commit *commit;
394 /** @state: backpointer to global drm_atomic_state */
395 struct drm_atomic_state *state;
399 * struct drm_crtc_funcs - control CRTCs for a given device
401 * The drm_crtc_funcs structure is the central CRTC management structure
402 * in the DRM. Each CRTC controls one or more connectors (note that the name
403 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
404 * connectors, not just CRTs).
406 * Each driver is responsible for filling out this structure at startup time,
407 * in addition to providing other modesetting features, like i2c and DDC
410 struct drm_crtc_funcs {
414 * Reset CRTC hardware and software state to off. This function isn't
415 * called by the core directly, only through drm_mode_config_reset().
416 * It's not a helper hook only for historical reasons.
418 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
419 * atomic state using this hook.
421 void (*reset)(struct drm_crtc *crtc);
426 * Update the cursor image. The cursor position is relative to the CRTC
427 * and can be partially or fully outside of the visible area.
429 * Note that contrary to all other KMS functions the legacy cursor entry
430 * points don't take a framebuffer object, but instead take directly a
431 * raw buffer object id from the driver's buffer manager (which is
432 * either GEM or TTM for current drivers).
434 * This entry point is deprecated, drivers should instead implement
435 * universal plane support and register a proper cursor plane using
436 * drm_crtc_init_with_planes().
438 * This callback is optional
442 * 0 on success or a negative error code on failure.
444 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
445 uint32_t handle, uint32_t width, uint32_t height);
450 * Update the cursor image, including hotspot information. The hotspot
451 * must not affect the cursor position in CRTC coordinates, but is only
452 * meant as a hint for virtualized display hardware to coordinate the
453 * guests and hosts cursor position. The cursor hotspot is relative to
454 * the cursor image. Otherwise this works exactly like @cursor_set.
456 * This entry point is deprecated, drivers should instead implement
457 * universal plane support and register a proper cursor plane using
458 * drm_crtc_init_with_planes().
460 * This callback is optional.
464 * 0 on success or a negative error code on failure.
466 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
467 uint32_t handle, uint32_t width, uint32_t height,
468 int32_t hot_x, int32_t hot_y);
473 * Update the cursor position. The cursor does not need to be visible
474 * when this hook is called.
476 * This entry point is deprecated, drivers should instead implement
477 * universal plane support and register a proper cursor plane using
478 * drm_crtc_init_with_planes().
480 * This callback is optional.
484 * 0 on success or a negative error code on failure.
486 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
491 * Set gamma on the CRTC.
493 * This callback is optional.
495 * Atomic drivers who want to support gamma tables should implement the
496 * atomic color management support, enabled by calling
497 * drm_crtc_enable_color_mgmt(), which then supports the legacy gamma
498 * interface through the drm_atomic_helper_legacy_gamma_set()
499 * compatibility implementation.
501 int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
503 struct drm_modeset_acquire_ctx *ctx);
508 * Clean up CRTC resources. This is only called at driver unload time
509 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
512 void (*destroy)(struct drm_crtc *crtc);
517 * This is the main legacy entry point to change the modeset state on a
518 * CRTC. All the details of the desired configuration are passed in a
519 * &struct drm_mode_set - see there for details.
521 * Drivers implementing atomic modeset should use
522 * drm_atomic_helper_set_config() to implement this hook.
526 * 0 on success or a negative error code on failure.
528 int (*set_config)(struct drm_mode_set *set,
529 struct drm_modeset_acquire_ctx *ctx);
534 * Legacy entry point to schedule a flip to the given framebuffer.
536 * Page flipping is a synchronization mechanism that replaces the frame
537 * buffer being scanned out by the CRTC with a new frame buffer during
538 * vertical blanking, avoiding tearing (except when requested otherwise
539 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
540 * requests a page flip the DRM core verifies that the new frame buffer
541 * is large enough to be scanned out by the CRTC in the currently
542 * configured mode and then calls this hook with a pointer to the new
545 * The driver must wait for any pending rendering to the new framebuffer
546 * to complete before executing the flip. It should also wait for any
547 * pending rendering from other drivers if the underlying buffer is a
550 * An application can request to be notified when the page flip has
551 * completed. The drm core will supply a &struct drm_event in the event
552 * parameter in this case. This can be handled by the
553 * drm_crtc_send_vblank_event() function, which the driver should call on
554 * the provided event upon completion of the flip. Note that if
555 * the driver supports vblank signalling and timestamping the vblank
556 * counters and timestamps must agree with the ones returned from page
557 * flip events. With the current vblank helper infrastructure this can
558 * be achieved by holding a vblank reference while the page flip is
559 * pending, acquired through drm_crtc_vblank_get() and released with
560 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
561 * counter and timestamp tracking though, e.g. if they have accurate
562 * timestamp registers in hardware.
564 * This callback is optional.
568 * Very early versions of the KMS ABI mandated that the driver must
569 * block (but not reject) any rendering to the old framebuffer until the
570 * flip operation has completed and the old framebuffer is no longer
571 * visible. This requirement has been lifted, and userspace is instead
572 * expected to request delivery of an event and wait with recycling old
573 * buffers until such has been received.
577 * 0 on success or a negative error code on failure. Note that if a
578 * page flip operation is already pending the callback should return
579 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
580 * or just runtime disabled through DPMS respectively the new atomic
581 * "ACTIVE" state) should result in an -EINVAL error code. Note that
582 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
584 int (*page_flip)(struct drm_crtc *crtc,
585 struct drm_framebuffer *fb,
586 struct drm_pending_vblank_event *event,
588 struct drm_modeset_acquire_ctx *ctx);
593 * Same as @page_flip but with an additional parameter specifying the
594 * absolute target vertical blank period (as reported by
595 * drm_crtc_vblank_count()) when the flip should take effect.
597 * Note that the core code calls drm_crtc_vblank_get before this entry
598 * point, and will call drm_crtc_vblank_put if this entry point returns
599 * any non-0 error code. It's the driver's responsibility to call
600 * drm_crtc_vblank_put after this entry point returns 0, typically when
601 * the flip completes.
603 int (*page_flip_target)(struct drm_crtc *crtc,
604 struct drm_framebuffer *fb,
605 struct drm_pending_vblank_event *event,
606 uint32_t flags, uint32_t target,
607 struct drm_modeset_acquire_ctx *ctx);
612 * This is the legacy entry point to update a property attached to the
615 * This callback is optional if the driver does not support any legacy
616 * driver-private properties. For atomic drivers it is not used because
617 * property handling is done entirely in the DRM core.
621 * 0 on success or a negative error code on failure.
623 int (*set_property)(struct drm_crtc *crtc,
624 struct drm_property *property, uint64_t val);
627 * @atomic_duplicate_state:
629 * Duplicate the current atomic state for this CRTC and return it.
630 * The core and helpers guarantee that any atomic state duplicated with
631 * this hook and still owned by the caller (i.e. not transferred to the
632 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
633 * cleaned up by calling the @atomic_destroy_state hook in this
636 * This callback is mandatory for atomic drivers.
638 * Atomic drivers which don't subclass &struct drm_crtc_state should use
639 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
640 * state structure to extend it with driver-private state should use
641 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
642 * duplicated in a consistent fashion across drivers.
644 * It is an error to call this hook before &drm_crtc.state has been
645 * initialized correctly.
649 * If the duplicate state references refcounted resources this hook must
650 * acquire a reference for each of them. The driver must release these
651 * references again in @atomic_destroy_state.
655 * Duplicated atomic state or NULL when the allocation failed.
657 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
660 * @atomic_destroy_state:
662 * Destroy a state duplicated with @atomic_duplicate_state and release
663 * or unreference all resources it references
665 * This callback is mandatory for atomic drivers.
667 void (*atomic_destroy_state)(struct drm_crtc *crtc,
668 struct drm_crtc_state *state);
671 * @atomic_set_property:
673 * Decode a driver-private property value and store the decoded value
674 * into the passed-in state structure. Since the atomic core decodes all
675 * standardized properties (even for extensions beyond the core set of
676 * properties which might not be implemented by all drivers) this
677 * requires drivers to subclass the state structure.
679 * Such driver-private properties should really only be implemented for
680 * truly hardware/vendor specific state. Instead it is preferred to
681 * standardize atomic extension and decode the properties used to expose
682 * such an extension in the core.
684 * Do not call this function directly, use
685 * drm_atomic_crtc_set_property() instead.
687 * This callback is optional if the driver does not support any
688 * driver-private atomic properties.
692 * This function is called in the state assembly phase of atomic
693 * modesets, which can be aborted for any reason (including on
694 * userspace's request to just check whether a configuration would be
695 * possible). Drivers MUST NOT touch any persistent state (hardware or
696 * software) or data structures except the passed in @state parameter.
698 * Also since userspace controls in which order properties are set this
699 * function must not do any input validation (since the state update is
700 * incomplete and hence likely inconsistent). Instead any such input
701 * validation must be done in the various atomic_check callbacks.
705 * 0 if the property has been found, -EINVAL if the property isn't
706 * implemented by the driver (which should never happen, the core only
707 * asks for properties attached to this CRTC). No other validation is
708 * allowed by the driver. The core already checks that the property
709 * value is within the range (integer, valid enum value, ...) the driver
710 * set when registering the property.
712 int (*atomic_set_property)(struct drm_crtc *crtc,
713 struct drm_crtc_state *state,
714 struct drm_property *property,
717 * @atomic_get_property:
719 * Reads out the decoded driver-private property. This is used to
720 * implement the GETCRTC IOCTL.
722 * Do not call this function directly, use
723 * drm_atomic_crtc_get_property() instead.
725 * This callback is optional if the driver does not support any
726 * driver-private atomic properties.
730 * 0 on success, -EINVAL if the property isn't implemented by the
731 * driver (which should never happen, the core only asks for
732 * properties attached to this CRTC).
734 int (*atomic_get_property)(struct drm_crtc *crtc,
735 const struct drm_crtc_state *state,
736 struct drm_property *property,
742 * This optional hook can be used to register additional userspace
743 * interfaces attached to the crtc like debugfs interfaces.
744 * It is called late in the driver load sequence from drm_dev_register().
745 * Everything added from this callback should be unregistered in
746 * the early_unregister callback.
750 * 0 on success, or a negative error code on failure.
752 int (*late_register)(struct drm_crtc *crtc);
757 * This optional hook should be used to unregister the additional
758 * userspace interfaces attached to the crtc from
759 * @late_register. It is called from drm_dev_unregister(),
760 * early in the driver unload sequence to disable userspace access
761 * before data structures are torndown.
763 void (*early_unregister)(struct drm_crtc *crtc);
768 * Changes the source of CRC checksums of frames at the request of
769 * userspace, typically for testing purposes. The sources available are
770 * specific of each driver and a %NULL value indicates that CRC
771 * generation is to be switched off.
773 * When CRC generation is enabled, the driver should call
774 * drm_crtc_add_crc_entry() at each frame, providing any information
775 * that characterizes the frame contents in the crcN arguments, as
776 * provided from the configured source. Drivers must accept an "auto"
777 * source name that will select a default source for this CRTC.
779 * This may trigger an atomic modeset commit if necessary, to enable CRC
782 * Note that "auto" can depend upon the current modeset configuration,
783 * e.g. it could pick an encoder or output specific CRC sampling point.
785 * This callback is optional if the driver does not support any CRC
786 * generation functionality.
790 * 0 on success or a negative error code on failure.
792 int (*set_crc_source)(struct drm_crtc *crtc, const char *source);
795 * @verify_crc_source:
797 * verifies the source of CRC checksums of frames before setting the
798 * source for CRC and during crc open. Source parameter can be NULL
799 * while disabling crc source.
801 * This callback is optional if the driver does not support any CRC
802 * generation functionality.
806 * 0 on success or a negative error code on failure.
808 int (*verify_crc_source)(struct drm_crtc *crtc, const char *source,
813 * Driver callback for getting a list of all the available sources for
814 * CRC generation. This callback depends upon verify_crc_source, So
815 * verify_crc_source callback should be implemented before implementing
816 * this. Driver can pass full list of available crc sources, this
817 * callback does the verification on each crc-source before passing it
820 * This callback is optional if the driver does not support exporting of
821 * possible CRC sources list.
825 * a constant character pointer to the list of all the available CRC
826 * sources. On failure driver should return NULL. count should be
827 * updated with number of sources in list. if zero we don't process any
828 * source from the list.
830 const char *const *(*get_crc_sources)(struct drm_crtc *crtc,
834 * @atomic_print_state:
836 * If driver subclasses &struct drm_crtc_state, it should implement
837 * this optional hook for printing additional driver specific state.
839 * Do not call this directly, use drm_atomic_crtc_print_state()
842 void (*atomic_print_state)(struct drm_printer *p,
843 const struct drm_crtc_state *state);
846 * @get_vblank_counter:
848 * Driver callback for fetching a raw hardware vblank counter for the
849 * CRTC. It's meant to be used by new drivers as the replacement of
850 * &drm_driver.get_vblank_counter hook.
852 * This callback is optional. If a device doesn't have a hardware
853 * counter, the driver can simply leave the hook as NULL. The DRM core
854 * will account for missed vblank events while interrupts where disabled
855 * based on system timestamps.
857 * Wraparound handling and loss of events due to modesetting is dealt
858 * with in the DRM core code, as long as drivers call
859 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
862 * See also &drm_device.vblank_disable_immediate and
863 * &drm_device.max_vblank_count.
867 * Raw vblank counter value.
869 u32 (*get_vblank_counter)(struct drm_crtc *crtc);
874 * Enable vblank interrupts for the CRTC. It's meant to be used by
875 * new drivers as the replacement of &drm_driver.enable_vblank hook.
879 * Zero on success, appropriate errno if the vblank interrupt cannot
882 int (*enable_vblank)(struct drm_crtc *crtc);
887 * Disable vblank interrupts for the CRTC. It's meant to be used by
888 * new drivers as the replacement of &drm_driver.disable_vblank hook.
890 void (*disable_vblank)(struct drm_crtc *crtc);
894 * struct drm_crtc - central CRTC control structure
896 * Each CRTC may have one or more connectors associated with it. This structure
897 * allows the CRTC to be controlled.
900 /** @dev: parent DRM device */
901 struct drm_device *dev;
902 /** @port: OF node used by drm_of_find_possible_crtcs(). */
903 struct device_node *port;
907 * List of all CRTCs on @dev, linked from &drm_mode_config.crtc_list.
908 * Invariant over the lifetime of @dev and therefore does not need
911 struct list_head head;
913 /** @name: human readable name, can be overwritten by the driver */
919 * This provides a read lock for the overall CRTC state (mode, dpms
920 * state, ...) and a write lock for everything which can be update
921 * without a full modeset (fb, cursor data, CRTC properties ...). A full
922 * modeset also need to grab &drm_mode_config.connection_mutex.
924 * For atomic drivers specifically this protects @state.
926 struct drm_modeset_lock mutex;
928 /** @base: base KMS object for ID tracking etc. */
929 struct drm_mode_object base;
933 * Primary plane for this CRTC. Note that this is only
934 * relevant for legacy IOCTL, it specifies the plane implicitly used by
935 * the SETCRTC and PAGE_FLIP IOCTLs. It does not have any significance
938 struct drm_plane *primary;
942 * Cursor plane for this CRTC. Note that this is only relevant for
943 * legacy IOCTL, it specifies the plane implicitly used by the SETCURSOR
944 * and SETCURSOR2 IOCTLs. It does not have any significance
947 struct drm_plane *cursor;
950 * @index: Position inside the mode_config.list, can be used as an array
951 * index. It is invariant over the lifetime of the CRTC.
956 * @cursor_x: Current x position of the cursor, used for universal
957 * cursor planes because the SETCURSOR IOCTL only can update the
958 * framebuffer without supplying the coordinates. Drivers should not use
959 * this directly, atomic drivers should look at &drm_plane_state.crtc_x
960 * of the cursor plane instead.
964 * @cursor_y: Current y position of the cursor, used for universal
965 * cursor planes because the SETCURSOR IOCTL only can update the
966 * framebuffer without supplying the coordinates. Drivers should not use
967 * this directly, atomic drivers should look at &drm_plane_state.crtc_y
968 * of the cursor plane instead.
975 * Is this CRTC enabled? Should only be used by legacy drivers, atomic
976 * drivers should instead consult &drm_crtc_state.enable and
977 * &drm_crtc_state.active. Atomic drivers can update this by calling
978 * drm_atomic_helper_update_legacy_modeset_state().
985 * Current mode timings. Should only be used by legacy drivers, atomic
986 * drivers should instead consult &drm_crtc_state.mode. Atomic drivers
987 * can update this by calling
988 * drm_atomic_helper_update_legacy_modeset_state().
990 struct drm_display_mode mode;
995 * Programmed mode in hw, after adjustments for encoders, crtc, panel
996 * scaling etc. Should only be used by legacy drivers, for high
997 * precision vblank timestamps in
998 * drm_calc_vbltimestamp_from_scanoutpos().
1000 * Note that atomic drivers should not use this, but instead use
1001 * &drm_crtc_state.adjusted_mode. And for high-precision timestamps
1002 * drm_calc_vbltimestamp_from_scanoutpos() used &drm_vblank_crtc.hwmode,
1003 * which is filled out by calling drm_calc_timestamping_constants().
1005 struct drm_display_mode hwmode;
1009 * x position on screen. Should only be used by legacy drivers, atomic
1010 * drivers should look at &drm_plane_state.crtc_x of the primary plane
1011 * instead. Updated by calling
1012 * drm_atomic_helper_update_legacy_modeset_state().
1017 * y position on screen. Should only be used by legacy drivers, atomic
1018 * drivers should look at &drm_plane_state.crtc_y of the primary plane
1019 * instead. Updated by calling
1020 * drm_atomic_helper_update_legacy_modeset_state().
1024 /** @funcs: CRTC control functions */
1025 const struct drm_crtc_funcs *funcs;
1028 * @gamma_size: Size of legacy gamma ramp reported to userspace. Set up
1029 * by calling drm_mode_crtc_set_gamma_size().
1031 uint32_t gamma_size;
1034 * @gamma_store: Gamma ramp values used by the legacy SETGAMMA and
1035 * GETGAMMA IOCTls. Set up by calling drm_mode_crtc_set_gamma_size().
1037 uint16_t *gamma_store;
1039 /** @helper_private: mid-layer private data */
1040 const struct drm_crtc_helper_funcs *helper_private;
1042 /** @properties: property tracking for this CRTC */
1043 struct drm_object_properties properties;
1048 * Current atomic state for this CRTC.
1050 * This is protected by @mutex. Note that nonblocking atomic commits
1051 * access the current CRTC state without taking locks. Either by going
1052 * through the &struct drm_atomic_state pointers, see
1053 * for_each_oldnew_crtc_in_state(), for_each_old_crtc_in_state() and
1054 * for_each_new_crtc_in_state(). Or through careful ordering of atomic
1055 * commit operations as implemented in the atomic helpers, see
1056 * &struct drm_crtc_commit.
1058 struct drm_crtc_state *state;
1063 * List of &drm_crtc_commit structures tracking pending commits.
1064 * Protected by @commit_lock. This list holds its own full reference,
1065 * as does the ongoing commit.
1067 * "Note that the commit for a state change is also tracked in
1068 * &drm_crtc_state.commit. For accessing the immediately preceding
1069 * commit in an atomic update it is recommended to just use that
1070 * pointer in the old CRTC state, since accessing that doesn't need
1071 * any locking or list-walking. @commit_list should only be used to
1072 * stall for framebuffer cleanup that's signalled through
1073 * &drm_crtc_commit.cleanup_done."
1075 struct list_head commit_list;
1080 * Spinlock to protect @commit_list.
1082 spinlock_t commit_lock;
1084 #ifdef CONFIG_DEBUG_FS
1088 * Debugfs directory for this CRTC.
1090 struct dentry *debugfs_entry;
1096 * Configuration settings of CRC capture.
1098 struct drm_crtc_crc crc;
1103 * timeline context used for fence operations.
1105 unsigned int fence_context;
1110 * spinlock to protect the fences in the fence_context.
1112 spinlock_t fence_lock;
1116 * Seqno variable used as monotonic counter for the fences
1117 * created on the CRTC's timeline.
1119 unsigned long fence_seqno;
1124 * The name of the CRTC's fence timeline.
1126 char timeline_name[32];
1129 * @self_refresh_data: Holds the state for the self refresh helpers
1131 * Initialized via drm_self_refresh_helper_init().
1133 struct drm_self_refresh_data *self_refresh_data;
1137 * struct drm_mode_set - new values for a CRTC config change
1138 * @fb: framebuffer to use for new config
1139 * @crtc: CRTC whose configuration we're about to change
1140 * @mode: mode timings to use
1141 * @x: position of this CRTC relative to @fb
1142 * @y: position of this CRTC relative to @fb
1143 * @connectors: array of connectors to drive with this CRTC if possible
1144 * @num_connectors: size of @connectors array
1146 * This represents a modeset configuration for the legacy SETCRTC ioctl and is
1147 * also used internally. Atomic drivers instead use &drm_atomic_state.
1149 struct drm_mode_set {
1150 struct drm_framebuffer *fb;
1151 struct drm_crtc *crtc;
1152 struct drm_display_mode *mode;
1157 struct drm_connector **connectors;
1158 size_t num_connectors;
1161 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1164 int drm_crtc_init_with_planes(struct drm_device *dev,
1165 struct drm_crtc *crtc,
1166 struct drm_plane *primary,
1167 struct drm_plane *cursor,
1168 const struct drm_crtc_funcs *funcs,
1169 const char *name, ...);
1170 void drm_crtc_cleanup(struct drm_crtc *crtc);
1173 * drm_crtc_index - find the index of a registered CRTC
1174 * @crtc: CRTC to find index for
1176 * Given a registered CRTC, return the index of that CRTC within a DRM
1177 * device's list of CRTCs.
1179 static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc)
1185 * drm_crtc_mask - find the mask of a registered CRTC
1186 * @crtc: CRTC to find mask for
1188 * Given a registered CRTC, return the mask bit of that CRTC for the
1189 * &drm_encoder.possible_crtcs and &drm_plane.possible_crtcs fields.
1191 static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc)
1193 return 1 << drm_crtc_index(crtc);
1196 int drm_mode_set_config_internal(struct drm_mode_set *set);
1197 struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx);
1200 * drm_crtc_find - look up a CRTC object from its ID
1202 * @file_priv: drm file to check for lease against.
1203 * @id: &drm_mode_object ID
1205 * This can be used to look up a CRTC from its userspace ID. Only used by
1206 * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS
1207 * userspace interface should be done using &drm_property.
1209 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1210 struct drm_file *file_priv,
1213 struct drm_mode_object *mo;
1214 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CRTC);
1215 return mo ? obj_to_crtc(mo) : NULL;
1219 * drm_for_each_crtc - iterate over all CRTCs
1220 * @crtc: a &struct drm_crtc as the loop cursor
1221 * @dev: the &struct drm_device
1223 * Iterate over all CRTCs of @dev.
1225 #define drm_for_each_crtc(crtc, dev) \
1226 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1228 #endif /* __DRM_CRTC_H__ */