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>
31 #include <linux/idr.h>
33 #include <linux/hdmi.h>
34 #include <linux/media-bus-format.h>
35 #include <uapi/drm/drm_mode.h>
36 #include <uapi/drm/drm_fourcc.h>
37 #include <drm/drm_modeset_lock.h>
38 #include <drm/drm_rect.h>
39 #include <drm/drm_mode_object.h>
40 #include <drm/drm_framebuffer.h>
41 #include <drm/drm_modes.h>
42 #include <drm/drm_connector.h>
43 #include <drm/drm_encoder.h>
44 #include <drm/drm_property.h>
45 #include <drm/drm_bridge.h>
46 #include <drm/drm_edid.h>
47 #include <drm/drm_plane.h>
48 #include <drm/drm_blend.h>
58 static inline int64_t U642I64(uint64_t val)
60 return (int64_t)*((int64_t *)&val);
62 static inline uint64_t I642U64(int64_t val)
64 return (uint64_t)*((uint64_t *)&val);
67 /* data corresponds to displayid vend/prod/serial */
68 struct drm_tile_group {
70 struct drm_device *dev;
77 struct drm_pending_vblank_event;
80 struct drm_atomic_state;
82 struct drm_crtc_helper_funcs;
83 struct drm_encoder_helper_funcs;
84 struct drm_plane_helper_funcs;
87 * struct drm_crtc_state - mutable CRTC state
88 * @crtc: backpointer to the CRTC
89 * @enable: whether the CRTC should be enabled, gates all other state
90 * @active: whether the CRTC is actively displaying (used for DPMS)
91 * @planes_changed: planes on this crtc are updated
92 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
93 * @active_changed: crtc_state->active has been toggled.
94 * @connectors_changed: connectors to this crtc have been updated
95 * @zpos_changed: zpos values of planes on this crtc have been updated
96 * @color_mgmt_changed: color management properties have changed (degamma or
97 * gamma LUT or CSC matrix)
98 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
99 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors
100 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders
101 * @last_vblank_count: for helpers and drivers to capture the vblank of the
102 * update to ensure framebuffer cleanup isn't done too early
103 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
104 * @mode: current mode timings
105 * @mode_blob: &drm_property_blob for @mode
106 * @degamma_lut: Lookup table for converting framebuffer pixel data
107 * before apply the conversion matrix
108 * @ctm: Transformation matrix
109 * @gamma_lut: Lookup table for converting pixel data after the
111 * @event: optional pointer to a DRM event to signal upon completion of the
113 * @state: backpointer to global drm_atomic_state
115 * Note that the distinction between @enable and @active is rather subtile:
116 * Flipping @active while @enable is set without changing anything else may
117 * never return in a failure from the ->atomic_check callback. Userspace assumes
118 * that a DPMS On will always succeed. In other words: @enable controls resource
119 * assignment, @active controls the actual hardware state.
121 struct drm_crtc_state {
122 struct drm_crtc *crtc;
127 /* computed state bits used by helpers and drivers */
128 bool planes_changed : 1;
129 bool mode_changed : 1;
130 bool active_changed : 1;
131 bool connectors_changed : 1;
132 bool zpos_changed : 1;
133 bool color_mgmt_changed : 1;
135 /* attached planes bitmask:
136 * WARNING: transitional helpers do not maintain plane_mask so
137 * drivers not converted over to atomic helpers should not rely
138 * on plane_mask being accurate!
145 /* last_vblank_count: for vblank waits before cleanup */
146 u32 last_vblank_count;
148 /* adjusted_mode: for use by helpers and drivers */
149 struct drm_display_mode adjusted_mode;
151 struct drm_display_mode mode;
153 /* blob property to expose current mode to atomic userspace */
154 struct drm_property_blob *mode_blob;
156 /* blob property to expose color management to userspace */
157 struct drm_property_blob *degamma_lut;
158 struct drm_property_blob *ctm;
159 struct drm_property_blob *gamma_lut;
161 struct drm_pending_vblank_event *event;
163 struct drm_atomic_state *state;
167 * struct drm_crtc_funcs - control CRTCs for a given device
169 * The drm_crtc_funcs structure is the central CRTC management structure
170 * in the DRM. Each CRTC controls one or more connectors (note that the name
171 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
172 * connectors, not just CRTs).
174 * Each driver is responsible for filling out this structure at startup time,
175 * in addition to providing other modesetting features, like i2c and DDC
178 struct drm_crtc_funcs {
182 * Reset CRTC hardware and software state to off. This function isn't
183 * called by the core directly, only through drm_mode_config_reset().
184 * It's not a helper hook only for historical reasons.
186 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
187 * atomic state using this hook.
189 void (*reset)(struct drm_crtc *crtc);
194 * Update the cursor image. The cursor position is relative to the CRTC
195 * and can be partially or fully outside of the visible area.
197 * Note that contrary to all other KMS functions the legacy cursor entry
198 * points don't take a framebuffer object, but instead take directly a
199 * raw buffer object id from the driver's buffer manager (which is
200 * either GEM or TTM for current drivers).
202 * This entry point is deprecated, drivers should instead implement
203 * universal plane support and register a proper cursor plane using
204 * drm_crtc_init_with_planes().
206 * This callback is optional
210 * 0 on success or a negative error code on failure.
212 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
213 uint32_t handle, uint32_t width, uint32_t height);
218 * Update the cursor image, including hotspot information. The hotspot
219 * must not affect the cursor position in CRTC coordinates, but is only
220 * meant as a hint for virtualized display hardware to coordinate the
221 * guests and hosts cursor position. The cursor hotspot is relative to
222 * the cursor image. Otherwise this works exactly like @cursor_set.
224 * This entry point is deprecated, drivers should instead implement
225 * universal plane support and register a proper cursor plane using
226 * drm_crtc_init_with_planes().
228 * This callback is optional.
232 * 0 on success or a negative error code on failure.
234 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
235 uint32_t handle, uint32_t width, uint32_t height,
236 int32_t hot_x, int32_t hot_y);
241 * Update the cursor position. The cursor does not need to be visible
242 * when this hook is called.
244 * This entry point is deprecated, drivers should instead implement
245 * universal plane support and register a proper cursor plane using
246 * drm_crtc_init_with_planes().
248 * This callback is optional.
252 * 0 on success or a negative error code on failure.
254 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
259 * Set gamma on the CRTC.
261 * This callback is optional.
265 * Drivers that support gamma tables and also fbdev emulation through
266 * the provided helper library need to take care to fill out the gamma
267 * hooks for both. Currently there's a bit an unfortunate duplication
268 * going on, which should eventually be unified to just one set of
271 int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
277 * Clean up plane resources. This is only called at driver unload time
278 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
281 void (*destroy)(struct drm_crtc *crtc);
286 * This is the main legacy entry point to change the modeset state on a
287 * CRTC. All the details of the desired configuration are passed in a
288 * struct &drm_mode_set - see there for details.
290 * Drivers implementing atomic modeset should use
291 * drm_atomic_helper_set_config() to implement this hook.
295 * 0 on success or a negative error code on failure.
297 int (*set_config)(struct drm_mode_set *set);
302 * Legacy entry point to schedule a flip to the given framebuffer.
304 * Page flipping is a synchronization mechanism that replaces the frame
305 * buffer being scanned out by the CRTC with a new frame buffer during
306 * vertical blanking, avoiding tearing (except when requested otherwise
307 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
308 * requests a page flip the DRM core verifies that the new frame buffer
309 * is large enough to be scanned out by the CRTC in the currently
310 * configured mode and then calls the CRTC ->page_flip() operation with a
311 * pointer to the new frame buffer.
313 * The driver must wait for any pending rendering to the new framebuffer
314 * to complete before executing the flip. It should also wait for any
315 * pending rendering from other drivers if the underlying buffer is a
318 * An application can request to be notified when the page flip has
319 * completed. The drm core will supply a struct &drm_event in the event
320 * parameter in this case. This can be handled by the
321 * drm_crtc_send_vblank_event() function, which the driver should call on
322 * the provided event upon completion of the flip. Note that if
323 * the driver supports vblank signalling and timestamping the vblank
324 * counters and timestamps must agree with the ones returned from page
325 * flip events. With the current vblank helper infrastructure this can
326 * be achieved by holding a vblank reference while the page flip is
327 * pending, acquired through drm_crtc_vblank_get() and released with
328 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
329 * counter and timestamp tracking though, e.g. if they have accurate
330 * timestamp registers in hardware.
332 * This callback is optional.
336 * Very early versions of the KMS ABI mandated that the driver must
337 * block (but not reject) any rendering to the old framebuffer until the
338 * flip operation has completed and the old framebuffer is no longer
339 * visible. This requirement has been lifted, and userspace is instead
340 * expected to request delivery of an event and wait with recycling old
341 * buffers until such has been received.
345 * 0 on success or a negative error code on failure. Note that if a
346 * ->page_flip() operation is already pending the callback should return
347 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
348 * or just runtime disabled through DPMS respectively the new atomic
349 * "ACTIVE" state) should result in an -EINVAL error code. Note that
350 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
352 int (*page_flip)(struct drm_crtc *crtc,
353 struct drm_framebuffer *fb,
354 struct drm_pending_vblank_event *event,
360 * Same as @page_flip but with an additional parameter specifying the
361 * absolute target vertical blank period (as reported by
362 * drm_crtc_vblank_count()) when the flip should take effect.
364 * Note that the core code calls drm_crtc_vblank_get before this entry
365 * point, and will call drm_crtc_vblank_put if this entry point returns
366 * any non-0 error code. It's the driver's responsibility to call
367 * drm_crtc_vblank_put after this entry point returns 0, typically when
368 * the flip completes.
370 int (*page_flip_target)(struct drm_crtc *crtc,
371 struct drm_framebuffer *fb,
372 struct drm_pending_vblank_event *event,
373 uint32_t flags, uint32_t target);
378 * This is the legacy entry point to update a property attached to the
381 * Drivers implementing atomic modeset should use
382 * drm_atomic_helper_crtc_set_property() to implement this hook.
384 * This callback is optional if the driver does not support any legacy
385 * driver-private properties.
389 * 0 on success or a negative error code on failure.
391 int (*set_property)(struct drm_crtc *crtc,
392 struct drm_property *property, uint64_t val);
395 * @atomic_duplicate_state:
397 * Duplicate the current atomic state for this CRTC and return it.
398 * The core and helpers gurantee that any atomic state duplicated with
399 * this hook and still owned by the caller (i.e. not transferred to the
400 * driver by calling ->atomic_commit() from struct
401 * &drm_mode_config_funcs) will be cleaned up by calling the
402 * @atomic_destroy_state hook in this structure.
404 * Atomic drivers which don't subclass struct &drm_crtc should use
405 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
406 * state structure to extend it with driver-private state should use
407 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
408 * duplicated in a consistent fashion across drivers.
410 * It is an error to call this hook before crtc->state has been
411 * initialized correctly.
415 * If the duplicate state references refcounted resources this hook must
416 * acquire a reference for each of them. The driver must release these
417 * references again in @atomic_destroy_state.
421 * Duplicated atomic state or NULL when the allocation failed.
423 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
426 * @atomic_destroy_state:
428 * Destroy a state duplicated with @atomic_duplicate_state and release
429 * or unreference all resources it references
431 void (*atomic_destroy_state)(struct drm_crtc *crtc,
432 struct drm_crtc_state *state);
435 * @atomic_set_property:
437 * Decode a driver-private property value and store the decoded value
438 * into the passed-in state structure. Since the atomic core decodes all
439 * standardized properties (even for extensions beyond the core set of
440 * properties which might not be implemented by all drivers) this
441 * requires drivers to subclass the state structure.
443 * Such driver-private properties should really only be implemented for
444 * truly hardware/vendor specific state. Instead it is preferred to
445 * standardize atomic extension and decode the properties used to expose
446 * such an extension in the core.
448 * Do not call this function directly, use
449 * drm_atomic_crtc_set_property() instead.
451 * This callback is optional if the driver does not support any
452 * driver-private atomic properties.
456 * This function is called in the state assembly phase of atomic
457 * modesets, which can be aborted for any reason (including on
458 * userspace's request to just check whether a configuration would be
459 * possible). Drivers MUST NOT touch any persistent state (hardware or
460 * software) or data structures except the passed in @state parameter.
462 * Also since userspace controls in which order properties are set this
463 * function must not do any input validation (since the state update is
464 * incomplete and hence likely inconsistent). Instead any such input
465 * validation must be done in the various atomic_check callbacks.
469 * 0 if the property has been found, -EINVAL if the property isn't
470 * implemented by the driver (which should never happen, the core only
471 * asks for properties attached to this CRTC). No other validation is
472 * allowed by the driver. The core already checks that the property
473 * value is within the range (integer, valid enum value, ...) the driver
474 * set when registering the property.
476 int (*atomic_set_property)(struct drm_crtc *crtc,
477 struct drm_crtc_state *state,
478 struct drm_property *property,
481 * @atomic_get_property:
483 * Reads out the decoded driver-private property. This is used to
484 * implement the GETCRTC IOCTL.
486 * Do not call this function directly, use
487 * drm_atomic_crtc_get_property() instead.
489 * This callback is optional if the driver does not support any
490 * driver-private atomic properties.
494 * 0 on success, -EINVAL if the property isn't implemented by the
495 * driver (which should never happen, the core only asks for
496 * properties attached to this CRTC).
498 int (*atomic_get_property)(struct drm_crtc *crtc,
499 const struct drm_crtc_state *state,
500 struct drm_property *property,
506 * This optional hook can be used to register additional userspace
507 * interfaces attached to the crtc like debugfs interfaces.
508 * It is called late in the driver load sequence from drm_dev_register().
509 * Everything added from this callback should be unregistered in
510 * the early_unregister callback.
514 * 0 on success, or a negative error code on failure.
516 int (*late_register)(struct drm_crtc *crtc);
521 * This optional hook should be used to unregister the additional
522 * userspace interfaces attached to the crtc from
523 * late_unregister(). It is called from drm_dev_unregister(),
524 * early in the driver unload sequence to disable userspace access
525 * before data structures are torndown.
527 void (*early_unregister)(struct drm_crtc *crtc);
531 * struct drm_crtc - central CRTC control structure
532 * @dev: parent DRM device
533 * @port: OF node used by drm_of_find_possible_crtcs()
534 * @head: list management
535 * @name: human readable name, can be overwritten by the driver
536 * @mutex: per-CRTC locking
537 * @base: base KMS object for ID tracking etc.
538 * @primary: primary plane for this CRTC
539 * @cursor: cursor plane for this CRTC
540 * @cursor_x: current x position of the cursor, used for universal cursor planes
541 * @cursor_y: current y position of the cursor, used for universal cursor planes
542 * @enabled: is this CRTC enabled?
543 * @mode: current mode timings
544 * @hwmode: mode timings as programmed to hw regs
545 * @x: x position on screen
546 * @y: y position on screen
547 * @funcs: CRTC control functions
548 * @gamma_size: size of gamma ramp
549 * @gamma_store: gamma ramp values
550 * @helper_private: mid-layer private data
551 * @properties: property tracking for this CRTC
553 * Each CRTC may have one or more connectors associated with it. This structure
554 * allows the CRTC to be controlled.
557 struct drm_device *dev;
558 struct device_node *port;
559 struct list_head head;
566 * This provides a read lock for the overall crtc state (mode, dpms
567 * state, ...) and a write lock for everything which can be update
568 * without a full modeset (fb, cursor data, crtc properties ...). Full
569 * modeset also need to grab dev->mode_config.connection_mutex.
571 struct drm_modeset_lock mutex;
573 struct drm_mode_object base;
575 /* primary and cursor planes for CRTC */
576 struct drm_plane *primary;
577 struct drm_plane *cursor;
580 * @index: Position inside the mode_config.list, can be used as an array
581 * index. It is invariant over the lifetime of the CRTC.
585 /* position of cursor plane on crtc */
591 /* Requested mode from modesetting. */
592 struct drm_display_mode mode;
594 /* Programmed mode in hw, after adjustments for encoders,
595 * crtc, panel scaling etc. Needed for timestamping etc.
597 struct drm_display_mode hwmode;
600 const struct drm_crtc_funcs *funcs;
602 /* Legacy FB CRTC gamma size for reporting to userspace */
604 uint16_t *gamma_store;
606 /* if you are using the helper */
607 const struct drm_crtc_helper_funcs *helper_private;
609 struct drm_object_properties properties;
614 * Current atomic state for this CRTC.
616 struct drm_crtc_state *state;
621 * List of &drm_crtc_commit structures tracking pending commits.
622 * Protected by @commit_lock. This list doesn't hold its own full
623 * reference, but burrows it from the ongoing commit. Commit entries
624 * must be removed from this list once the commit is fully completed,
625 * but before it's correspoding &drm_atomic_state gets destroyed.
627 struct list_head commit_list;
632 * Spinlock to protect @commit_list.
634 spinlock_t commit_lock;
639 * Per-CRTC implicit acquire context used by atomic drivers for legacy
640 * IOCTLs, so that atomic drivers can get at the locking acquire
643 struct drm_modeset_acquire_ctx *acquire_ctx;
647 * struct drm_mode_set - new values for a CRTC config change
648 * @fb: framebuffer to use for new config
649 * @crtc: CRTC whose configuration we're about to change
650 * @mode: mode timings to use
651 * @x: position of this CRTC relative to @fb
652 * @y: position of this CRTC relative to @fb
653 * @connectors: array of connectors to drive with this CRTC if possible
654 * @num_connectors: size of @connectors array
656 * Represents a single crtc the connectors that it drives with what mode
657 * and from which framebuffer it scans out from.
659 * This is used to set modes.
661 struct drm_mode_set {
662 struct drm_framebuffer *fb;
663 struct drm_crtc *crtc;
664 struct drm_display_mode *mode;
669 struct drm_connector **connectors;
670 size_t num_connectors;
674 * struct drm_mode_config_funcs - basic driver provided mode setting functions
676 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
679 struct drm_mode_config_funcs {
683 * Create a new framebuffer object. The core does basic checks on the
684 * requested metadata, but most of that is left to the driver. See
685 * struct &drm_mode_fb_cmd2 for details.
687 * If the parameters are deemed valid and the backing storage objects in
688 * the underlying memory manager all exist, then the driver allocates
689 * a new &drm_framebuffer structure, subclassed to contain
690 * driver-specific information (like the internal native buffer object
691 * references). It also needs to fill out all relevant metadata, which
692 * should be done by calling drm_helper_mode_fill_fb_struct().
694 * The initialization is finalized by calling drm_framebuffer_init(),
695 * which registers the framebuffer and makes it accessible to other
700 * A new framebuffer with an initial reference count of 1 or a negative
701 * error code encoded with ERR_PTR().
703 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
704 struct drm_file *file_priv,
705 const struct drm_mode_fb_cmd2 *mode_cmd);
708 * @output_poll_changed:
710 * Callback used by helpers to inform the driver of output configuration
713 * Drivers implementing fbdev emulation with the helpers can call
714 * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
715 * helper of output changes.
719 * Except that there's no vtable for device-level helper callbacks
720 * there's no reason this is a core function.
722 void (*output_poll_changed)(struct drm_device *dev);
727 * This is the only hook to validate an atomic modeset update. This
728 * function must reject any modeset and state changes which the hardware
729 * or driver doesn't support. This includes but is of course not limited
732 * - Checking that the modes, framebuffers, scaling and placement
733 * requirements and so on are within the limits of the hardware.
735 * - Checking that any hidden shared resources are not oversubscribed.
736 * This can be shared PLLs, shared lanes, overall memory bandwidth,
737 * display fifo space (where shared between planes or maybe even
740 * - Checking that virtualized resources exported to userspace are not
741 * oversubscribed. For various reasons it can make sense to expose
742 * more planes, crtcs or encoders than which are physically there. One
743 * example is dual-pipe operations (which generally should be hidden
744 * from userspace if when lockstepped in hardware, exposed otherwise),
745 * where a plane might need 1 hardware plane (if it's just on one
746 * pipe), 2 hardware planes (when it spans both pipes) or maybe even
747 * shared a hardware plane with a 2nd plane (if there's a compatible
748 * plane requested on the area handled by the other pipe).
750 * - Check that any transitional state is possible and that if
751 * requested, the update can indeed be done in the vblank period
752 * without temporarily disabling some functions.
754 * - Check any other constraints the driver or hardware might have.
756 * - This callback also needs to correctly fill out the &drm_crtc_state
757 * in this update to make sure that drm_atomic_crtc_needs_modeset()
758 * reflects the nature of the possible update and returns true if and
759 * only if the update cannot be applied without tearing within one
760 * vblank on that CRTC. The core uses that information to reject
761 * updates which require a full modeset (i.e. blanking the screen, or
762 * at least pausing updates for a substantial amount of time) if
763 * userspace has disallowed that in its request.
765 * - The driver also does not need to repeat basic input validation
766 * like done for the corresponding legacy entry points. The core does
767 * that before calling this hook.
769 * See the documentation of @atomic_commit for an exhaustive list of
770 * error conditions which don't have to be checked at the
771 * ->atomic_check() stage?
773 * See the documentation for struct &drm_atomic_state for how exactly
774 * an atomic modeset update is described.
776 * Drivers using the atomic helpers can implement this hook using
777 * drm_atomic_helper_check(), or one of the exported sub-functions of
782 * 0 on success or one of the below negative error codes:
784 * - -EINVAL, if any of the above constraints are violated.
786 * - -EDEADLK, when returned from an attempt to acquire an additional
787 * &drm_modeset_lock through drm_modeset_lock().
789 * - -ENOMEM, if allocating additional state sub-structures failed due
792 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
793 * This can either be due to a pending signal, or because the driver
794 * needs to completely bail out to recover from an exceptional
795 * situation like a GPU hang. From a userspace point all errors are
798 int (*atomic_check)(struct drm_device *dev,
799 struct drm_atomic_state *state);
804 * This is the only hook to commit an atomic modeset update. The core
805 * guarantees that @atomic_check has been called successfully before
806 * calling this function, and that nothing has been changed in the
809 * See the documentation for struct &drm_atomic_state for how exactly
810 * an atomic modeset update is described.
812 * Drivers using the atomic helpers can implement this hook using
813 * drm_atomic_helper_commit(), or one of the exported sub-functions of
816 * Nonblocking commits (as indicated with the nonblock parameter) must
817 * do any preparatory work which might result in an unsuccessful commit
818 * in the context of this callback. The only exceptions are hardware
819 * errors resulting in -EIO. But even in that case the driver must
820 * ensure that the display pipe is at least running, to avoid
821 * compositors crashing when pageflips don't work. Anything else,
822 * specifically committing the update to the hardware, should be done
823 * without blocking the caller. For updates which do not require a
824 * modeset this must be guaranteed.
826 * The driver must wait for any pending rendering to the new
827 * framebuffers to complete before executing the flip. It should also
828 * wait for any pending rendering from other drivers if the underlying
829 * buffer is a shared dma-buf. Nonblocking commits must not wait for
830 * rendering in the context of this callback.
832 * An application can request to be notified when the atomic commit has
833 * completed. These events are per-CRTC and can be distinguished by the
834 * CRTC index supplied in &drm_event to userspace.
836 * The drm core will supply a struct &drm_event in the event
837 * member of each CRTC's &drm_crtc_state structure. This can be handled by the
838 * drm_crtc_send_vblank_event() function, which the driver should call on
839 * the provided event upon completion of the atomic commit. Note that if
840 * the driver supports vblank signalling and timestamping the vblank
841 * counters and timestamps must agree with the ones returned from page
842 * flip events. With the current vblank helper infrastructure this can
843 * be achieved by holding a vblank reference while the page flip is
844 * pending, acquired through drm_crtc_vblank_get() and released with
845 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
846 * counter and timestamp tracking though, e.g. if they have accurate
847 * timestamp registers in hardware.
851 * Drivers are not allowed to shut down any display pipe successfully
852 * enabled through an atomic commit on their own. Doing so can result in
853 * compositors crashing if a page flip is suddenly rejected because the
858 * 0 on success or one of the below negative error codes:
860 * - -EBUSY, if a nonblocking updated is requested and there is
861 * an earlier updated pending. Drivers are allowed to support a queue
862 * of outstanding updates, but currently no driver supports that.
863 * Note that drivers must wait for preceding updates to complete if a
864 * synchronous update is requested, they are not allowed to fail the
865 * commit in that case.
867 * - -ENOMEM, if the driver failed to allocate memory. Specifically
868 * this can happen when trying to pin framebuffers, which must only
869 * be done when committing the state.
871 * - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
872 * that the driver has run out of vram, iommu space or similar GPU
873 * address space needed for framebuffer.
875 * - -EIO, if the hardware completely died.
877 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
878 * This can either be due to a pending signal, or because the driver
879 * needs to completely bail out to recover from an exceptional
880 * situation like a GPU hang. From a userspace point of view all errors are
883 * This list is exhaustive. Specifically this hook is not allowed to
884 * return -EINVAL (any invalid requests should be caught in
885 * @atomic_check) or -EDEADLK (this function must not acquire
886 * additional modeset locks).
888 int (*atomic_commit)(struct drm_device *dev,
889 struct drm_atomic_state *state,
893 * @atomic_state_alloc:
895 * This optional hook can be used by drivers that want to subclass struct
896 * &drm_atomic_state to be able to track their own driver-private global
897 * state easily. If this hook is implemented, drivers must also
898 * implement @atomic_state_clear and @atomic_state_free.
902 * A new &drm_atomic_state on success or NULL on failure.
904 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
907 * @atomic_state_clear:
909 * This hook must clear any driver private state duplicated into the
910 * passed-in &drm_atomic_state. This hook is called when the caller
911 * encountered a &drm_modeset_lock deadlock and needs to drop all
912 * already acquired locks as part of the deadlock avoidance dance
913 * implemented in drm_modeset_lock_backoff().
915 * Any duplicated state must be invalidated since a concurrent atomic
916 * update might change it, and the drm atomic interfaces always apply
917 * updates as relative changes to the current state.
919 * Drivers that implement this must call drm_atomic_state_default_clear()
920 * to clear common state.
922 void (*atomic_state_clear)(struct drm_atomic_state *state);
925 * @atomic_state_free:
927 * This hook needs driver private resources and the &drm_atomic_state
928 * itself. Note that the core first calls drm_atomic_state_clear() to
929 * avoid code duplicate between the clear and free hooks.
931 * Drivers that implement this must call drm_atomic_state_default_free()
932 * to release common resources.
934 void (*atomic_state_free)(struct drm_atomic_state *state);
938 * struct drm_mode_config - Mode configuration control structure
939 * @mutex: mutex protecting KMS related lists and structures
940 * @connection_mutex: ww mutex protecting connector state and routing
941 * @acquire_ctx: global implicit acquire context used by atomic drivers for
943 * @fb_lock: mutex to protect fb state and lists
944 * @num_fb: number of fbs available
945 * @fb_list: list of framebuffers available
946 * @num_encoder: number of encoders on this device
947 * @encoder_list: list of encoder objects
948 * @num_overlay_plane: number of overlay planes on this device
949 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
950 * @plane_list: list of plane objects
951 * @num_crtc: number of CRTCs on this device
952 * @crtc_list: list of CRTC objects
953 * @property_list: list of property objects
954 * @min_width: minimum pixel width on this device
955 * @min_height: minimum pixel height on this device
956 * @max_width: maximum pixel width on this device
957 * @max_height: maximum pixel height on this device
958 * @funcs: core driver provided mode setting functions
959 * @fb_base: base address of the framebuffer
960 * @poll_enabled: track polling support for this device
961 * @poll_running: track polling status for this device
962 * @delayed_event: track delayed poll uevent deliver for this device
963 * @output_poll_work: delayed work for polling in process context
964 * @property_blob_list: list of all the blob property objects
965 * @blob_lock: mutex for blob property allocation and management
966 * @*_property: core property tracking
967 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
968 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
969 * @cursor_width: hint to userspace for max cursor width
970 * @cursor_height: hint to userspace for max cursor height
971 * @helper_private: mid-layer private data
973 * Core mode resource tracking structure. All CRTC, encoders, and connectors
974 * enumerated by the driver are added here, as are global properties. Some
975 * global restrictions are also here, e.g. dimension restrictions.
977 struct drm_mode_config {
978 struct mutex mutex; /* protects configuration (mode lists etc.) */
979 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
980 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
985 * Mutex for KMS ID allocation and management. Protects both @crtc_idr
988 struct mutex idr_mutex;
993 * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
994 * connector, modes - just makes life easier to have only one.
1001 * Use this idr for allocating new IDs for tiled sinks like use in some
1002 * high-res DP MST screens.
1004 struct idr tile_idr;
1006 struct mutex fb_lock; /* proctects global and per-file fb lists */
1008 struct list_head fb_list;
1011 * @num_connector: Number of connectors on this device.
1015 * @connector_ida: ID allocator for connector indices.
1017 struct ida connector_ida;
1019 * @connector_list: List of connector objects.
1021 struct list_head connector_list;
1023 struct list_head encoder_list;
1026 * Track # of overlay planes separately from # of total planes. By
1027 * default we only advertise overlay planes to userspace; if userspace
1028 * sets the "universal plane" capability bit, we'll go ahead and
1029 * expose all planes.
1031 int num_overlay_plane;
1032 int num_total_plane;
1033 struct list_head plane_list;
1036 struct list_head crtc_list;
1038 struct list_head property_list;
1040 int min_width, min_height;
1041 int max_width, max_height;
1042 const struct drm_mode_config_funcs *funcs;
1043 resource_size_t fb_base;
1045 /* output poll support */
1049 struct delayed_work output_poll_work;
1051 struct mutex blob_lock;
1053 /* pointers to standard properties */
1054 struct list_head property_blob_list;
1056 * @edid_property: Default connector property to hold the EDID of the
1057 * currently connected sink, if any.
1059 struct drm_property *edid_property;
1061 * @dpms_property: Default connector property to control the
1062 * connector's DPMS state.
1064 struct drm_property *dpms_property;
1066 * @path_property: Default connector property to hold the DP MST path
1069 struct drm_property *path_property;
1071 * @tile_property: Default connector property to store the tile
1072 * position of a tiled screen, for sinks which need to be driven with
1075 struct drm_property *tile_property;
1077 * @plane_type_property: Default plane property to differentiate
1078 * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
1080 struct drm_property *plane_type_property;
1082 * @rotation_property: Optional property for planes or CRTCs to specifiy
1085 struct drm_property *rotation_property;
1087 * @prop_src_x: Default atomic plane property for the plane source
1088 * position in the connected &drm_framebuffer.
1090 struct drm_property *prop_src_x;
1092 * @prop_src_y: Default atomic plane property for the plane source
1093 * position in the connected &drm_framebuffer.
1095 struct drm_property *prop_src_y;
1097 * @prop_src_w: Default atomic plane property for the plane source
1098 * position in the connected &drm_framebuffer.
1100 struct drm_property *prop_src_w;
1102 * @prop_src_h: Default atomic plane property for the plane source
1103 * position in the connected &drm_framebuffer.
1105 struct drm_property *prop_src_h;
1107 * @prop_crtc_x: Default atomic plane property for the plane destination
1108 * position in the &drm_crtc is is being shown on.
1110 struct drm_property *prop_crtc_x;
1112 * @prop_crtc_y: Default atomic plane property for the plane destination
1113 * position in the &drm_crtc is is being shown on.
1115 struct drm_property *prop_crtc_y;
1117 * @prop_crtc_w: Default atomic plane property for the plane destination
1118 * position in the &drm_crtc is is being shown on.
1120 struct drm_property *prop_crtc_w;
1122 * @prop_crtc_h: Default atomic plane property for the plane destination
1123 * position in the &drm_crtc is is being shown on.
1125 struct drm_property *prop_crtc_h;
1127 * @prop_fb_id: Default atomic plane property to specify the
1130 struct drm_property *prop_fb_id;
1132 * @prop_crtc_id: Default atomic plane property to specify the
1135 struct drm_property *prop_crtc_id;
1137 * @prop_active: Default atomic CRTC property to control the active
1138 * state, which is the simplified implementation for DPMS in atomic
1141 struct drm_property *prop_active;
1143 * @prop_mode_id: Default atomic CRTC property to set the mode for a
1144 * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
1145 * connectors must be of and active must be set to disabled, too.
1147 struct drm_property *prop_mode_id;
1150 * @dvi_i_subconnector_property: Optional DVI-I property to
1151 * differentiate between analog or digital mode.
1153 struct drm_property *dvi_i_subconnector_property;
1155 * @dvi_i_select_subconnector_property: Optional DVI-I property to
1156 * select between analog or digital mode.
1158 struct drm_property *dvi_i_select_subconnector_property;
1161 * @tv_subconnector_property: Optional TV property to differentiate
1162 * between different TV connector types.
1164 struct drm_property *tv_subconnector_property;
1166 * @tv_select_subconnector_property: Optional TV property to select
1167 * between different TV connector types.
1169 struct drm_property *tv_select_subconnector_property;
1171 * @tv_mode_property: Optional TV property to select
1172 * the output TV mode.
1174 struct drm_property *tv_mode_property;
1176 * @tv_left_margin_property: Optional TV property to set the left
1179 struct drm_property *tv_left_margin_property;
1181 * @tv_right_margin_property: Optional TV property to set the right
1184 struct drm_property *tv_right_margin_property;
1186 * @tv_top_margin_property: Optional TV property to set the right
1189 struct drm_property *tv_top_margin_property;
1191 * @tv_bottom_margin_property: Optional TV property to set the right
1194 struct drm_property *tv_bottom_margin_property;
1196 * @tv_brightness_property: Optional TV property to set the
1199 struct drm_property *tv_brightness_property;
1201 * @tv_contrast_property: Optional TV property to set the
1204 struct drm_property *tv_contrast_property;
1206 * @tv_flicker_reduction_property: Optional TV property to control the
1207 * flicker reduction mode.
1209 struct drm_property *tv_flicker_reduction_property;
1211 * @tv_overscan_property: Optional TV property to control the overscan
1214 struct drm_property *tv_overscan_property;
1216 * @tv_saturation_property: Optional TV property to set the
1219 struct drm_property *tv_saturation_property;
1221 * @tv_hue_property: Optional TV property to set the hue.
1223 struct drm_property *tv_hue_property;
1226 * @scaling_mode_property: Optional connector property to control the
1227 * upscaling, mostly used for built-in panels.
1229 struct drm_property *scaling_mode_property;
1231 * @aspect_ratio_property: Optional connector property to control the
1232 * HDMI infoframe aspect ratio setting.
1234 struct drm_property *aspect_ratio_property;
1236 * @degamma_lut_property: Optional CRTC property to set the LUT used to
1237 * convert the framebuffer's colors to linear gamma.
1239 struct drm_property *degamma_lut_property;
1241 * @degamma_lut_size_property: Optional CRTC property for the size of
1242 * the degamma LUT as supported by the driver (read-only).
1244 struct drm_property *degamma_lut_size_property;
1246 * @ctm_property: Optional CRTC property to set the
1247 * matrix used to convert colors after the lookup in the
1250 struct drm_property *ctm_property;
1252 * @gamma_lut_property: Optional CRTC property to set the LUT used to
1253 * convert the colors, after the CTM matrix, to the gamma space of the
1256 struct drm_property *gamma_lut_property;
1258 * @gamma_lut_size_property: Optional CRTC property for the size of the
1259 * gamma LUT as supported by the driver (read-only).
1261 struct drm_property *gamma_lut_size_property;
1264 * @suggested_x_property: Optional connector property with a hint for
1265 * the position of the output on the host's screen.
1267 struct drm_property *suggested_x_property;
1269 * @suggested_y_property: Optional connector property with a hint for
1270 * the position of the output on the host's screen.
1272 struct drm_property *suggested_y_property;
1274 /* dumb ioctl parameters */
1275 uint32_t preferred_depth, prefer_shadow;
1278 * @async_page_flip: Does this device support async flips on the primary
1281 bool async_page_flip;
1284 * @allow_fb_modifiers:
1286 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
1288 bool allow_fb_modifiers;
1291 uint32_t cursor_width, cursor_height;
1293 struct drm_mode_config_helper_funcs *helper_private;
1296 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1298 extern __printf(6, 7)
1299 int drm_crtc_init_with_planes(struct drm_device *dev,
1300 struct drm_crtc *crtc,
1301 struct drm_plane *primary,
1302 struct drm_plane *cursor,
1303 const struct drm_crtc_funcs *funcs,
1304 const char *name, ...);
1305 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1308 * drm_crtc_index - find the index of a registered CRTC
1309 * @crtc: CRTC to find index for
1311 * Given a registered CRTC, return the index of that CRTC within a DRM
1312 * device's list of CRTCs.
1314 static inline unsigned int drm_crtc_index(struct drm_crtc *crtc)
1320 * drm_crtc_mask - find the mask of a registered CRTC
1321 * @crtc: CRTC to find mask for
1323 * Given a registered CRTC, return the mask bit of that CRTC for an
1324 * encoder's possible_crtcs field.
1326 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1328 return 1 << drm_crtc_index(crtc);
1331 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1332 int *hdisplay, int *vdisplay);
1333 extern int drm_crtc_force_disable(struct drm_crtc *crtc);
1334 extern int drm_crtc_force_disable_all(struct drm_device *dev);
1336 extern void drm_mode_config_init(struct drm_device *dev);
1337 extern void drm_mode_config_reset(struct drm_device *dev);
1338 extern void drm_mode_config_cleanup(struct drm_device *dev);
1340 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1343 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1345 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1347 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1349 extern void drm_mode_put_tile_group(struct drm_device *dev,
1350 struct drm_tile_group *tg);
1352 extern void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
1353 uint degamma_lut_size,
1355 uint gamma_lut_size);
1358 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1361 struct drm_mode_object *mo;
1362 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1363 return mo ? obj_to_crtc(mo) : NULL;
1367 * Extract a degamma/gamma LUT value provided by user and round it to the
1368 * precision supported by the hardware.
1370 static inline uint32_t drm_color_lut_extract(uint32_t user_input,
1371 uint32_t bit_precision)
1373 uint32_t val = user_input;
1374 uint32_t max = 0xffff >> (16 - bit_precision);
1376 /* Round only if we're not using full precision. */
1377 if (bit_precision < 16) {
1378 val += 1UL << (16 - bit_precision - 1);
1379 val >>= 16 - bit_precision;
1382 return clamp_val(val, 0, max);
1385 #define drm_for_each_crtc(crtc, dev) \
1386 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1389 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1392 * The connector hotadd/remove code currently grabs both locks when
1393 * updating lists. Hence readers need only hold either of them to be
1394 * safe and the check amounts to
1396 * WARN_ON(not_holding(A) && not_holding(B)).
1398 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1399 !drm_modeset_is_locked(&mode_config->connection_mutex));
1402 #endif /* __DRM_CRTC_H__ */