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>
57 static inline int64_t U642I64(uint64_t val)
59 return (int64_t)*((int64_t *)&val);
61 static inline uint64_t I642U64(int64_t val)
63 return (uint64_t)*((uint64_t *)&val);
67 * Rotation property bits. DRM_ROTATE_<degrees> rotates the image by the
68 * specified amount in degrees in counter clockwise direction. DRM_REFLECT_X and
69 * DRM_REFLECT_Y reflects the image along the specified axis prior to rotation
71 #define DRM_ROTATE_0 BIT(0)
72 #define DRM_ROTATE_90 BIT(1)
73 #define DRM_ROTATE_180 BIT(2)
74 #define DRM_ROTATE_270 BIT(3)
75 #define DRM_ROTATE_MASK (DRM_ROTATE_0 | DRM_ROTATE_90 | \
76 DRM_ROTATE_180 | DRM_ROTATE_270)
77 #define DRM_REFLECT_X BIT(4)
78 #define DRM_REFLECT_Y BIT(5)
79 #define DRM_REFLECT_MASK (DRM_REFLECT_X | DRM_REFLECT_Y)
81 /* data corresponds to displayid vend/prod/serial */
82 struct drm_tile_group {
84 struct drm_device *dev;
91 struct drm_pending_vblank_event;
94 struct drm_atomic_state;
96 struct drm_crtc_helper_funcs;
97 struct drm_encoder_helper_funcs;
98 struct drm_plane_helper_funcs;
101 * struct drm_crtc_state - mutable CRTC state
102 * @crtc: backpointer to the CRTC
103 * @enable: whether the CRTC should be enabled, gates all other state
104 * @active: whether the CRTC is actively displaying (used for DPMS)
105 * @planes_changed: planes on this crtc are updated
106 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
107 * @active_changed: crtc_state->active has been toggled.
108 * @connectors_changed: connectors to this crtc have been updated
109 * @zpos_changed: zpos values of planes on this crtc have been updated
110 * @color_mgmt_changed: color management properties have changed (degamma or
111 * gamma LUT or CSC matrix)
112 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
113 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors
114 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders
115 * @last_vblank_count: for helpers and drivers to capture the vblank of the
116 * update to ensure framebuffer cleanup isn't done too early
117 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
118 * @mode: current mode timings
119 * @mode_blob: &drm_property_blob for @mode
120 * @degamma_lut: Lookup table for converting framebuffer pixel data
121 * before apply the conversion matrix
122 * @ctm: Transformation matrix
123 * @gamma_lut: Lookup table for converting pixel data after the
125 * @event: optional pointer to a DRM event to signal upon completion of the
127 * @state: backpointer to global drm_atomic_state
129 * Note that the distinction between @enable and @active is rather subtile:
130 * Flipping @active while @enable is set without changing anything else may
131 * never return in a failure from the ->atomic_check callback. Userspace assumes
132 * that a DPMS On will always succeed. In other words: @enable controls resource
133 * assignment, @active controls the actual hardware state.
135 struct drm_crtc_state {
136 struct drm_crtc *crtc;
141 /* computed state bits used by helpers and drivers */
142 bool planes_changed : 1;
143 bool mode_changed : 1;
144 bool active_changed : 1;
145 bool connectors_changed : 1;
146 bool zpos_changed : 1;
147 bool color_mgmt_changed : 1;
149 /* attached planes bitmask:
150 * WARNING: transitional helpers do not maintain plane_mask so
151 * drivers not converted over to atomic helpers should not rely
152 * on plane_mask being accurate!
159 /* last_vblank_count: for vblank waits before cleanup */
160 u32 last_vblank_count;
162 /* adjusted_mode: for use by helpers and drivers */
163 struct drm_display_mode adjusted_mode;
165 struct drm_display_mode mode;
167 /* blob property to expose current mode to atomic userspace */
168 struct drm_property_blob *mode_blob;
170 /* blob property to expose color management to userspace */
171 struct drm_property_blob *degamma_lut;
172 struct drm_property_blob *ctm;
173 struct drm_property_blob *gamma_lut;
175 struct drm_pending_vblank_event *event;
177 struct drm_atomic_state *state;
181 * struct drm_crtc_funcs - control CRTCs for a given device
183 * The drm_crtc_funcs structure is the central CRTC management structure
184 * in the DRM. Each CRTC controls one or more connectors (note that the name
185 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
186 * connectors, not just CRTs).
188 * Each driver is responsible for filling out this structure at startup time,
189 * in addition to providing other modesetting features, like i2c and DDC
192 struct drm_crtc_funcs {
196 * Reset CRTC hardware and software state to off. This function isn't
197 * called by the core directly, only through drm_mode_config_reset().
198 * It's not a helper hook only for historical reasons.
200 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
201 * atomic state using this hook.
203 void (*reset)(struct drm_crtc *crtc);
208 * Update the cursor image. The cursor position is relative to the CRTC
209 * and can be partially or fully outside of the visible area.
211 * Note that contrary to all other KMS functions the legacy cursor entry
212 * points don't take a framebuffer object, but instead take directly a
213 * raw buffer object id from the driver's buffer manager (which is
214 * either GEM or TTM for current drivers).
216 * This entry point is deprecated, drivers should instead implement
217 * universal plane support and register a proper cursor plane using
218 * drm_crtc_init_with_planes().
220 * This callback is optional
224 * 0 on success or a negative error code on failure.
226 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
227 uint32_t handle, uint32_t width, uint32_t height);
232 * Update the cursor image, including hotspot information. The hotspot
233 * must not affect the cursor position in CRTC coordinates, but is only
234 * meant as a hint for virtualized display hardware to coordinate the
235 * guests and hosts cursor position. The cursor hotspot is relative to
236 * the cursor image. Otherwise this works exactly like @cursor_set.
238 * This entry point is deprecated, drivers should instead implement
239 * universal plane support and register a proper cursor plane using
240 * drm_crtc_init_with_planes().
242 * This callback is optional.
246 * 0 on success or a negative error code on failure.
248 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
249 uint32_t handle, uint32_t width, uint32_t height,
250 int32_t hot_x, int32_t hot_y);
255 * Update the cursor position. The cursor does not need to be visible
256 * when this hook is called.
258 * This entry point is deprecated, drivers should instead implement
259 * universal plane support and register a proper cursor plane using
260 * drm_crtc_init_with_planes().
262 * This callback is optional.
266 * 0 on success or a negative error code on failure.
268 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
273 * Set gamma on the CRTC.
275 * This callback is optional.
279 * Drivers that support gamma tables and also fbdev emulation through
280 * the provided helper library need to take care to fill out the gamma
281 * hooks for both. Currently there's a bit an unfortunate duplication
282 * going on, which should eventually be unified to just one set of
285 int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
291 * Clean up plane resources. This is only called at driver unload time
292 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
295 void (*destroy)(struct drm_crtc *crtc);
300 * This is the main legacy entry point to change the modeset state on a
301 * CRTC. All the details of the desired configuration are passed in a
302 * struct &drm_mode_set - see there for details.
304 * Drivers implementing atomic modeset should use
305 * drm_atomic_helper_set_config() to implement this hook.
309 * 0 on success or a negative error code on failure.
311 int (*set_config)(struct drm_mode_set *set);
316 * Legacy entry point to schedule a flip to the given framebuffer.
318 * Page flipping is a synchronization mechanism that replaces the frame
319 * buffer being scanned out by the CRTC with a new frame buffer during
320 * vertical blanking, avoiding tearing (except when requested otherwise
321 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
322 * requests a page flip the DRM core verifies that the new frame buffer
323 * is large enough to be scanned out by the CRTC in the currently
324 * configured mode and then calls the CRTC ->page_flip() operation with a
325 * pointer to the new frame buffer.
327 * The driver must wait for any pending rendering to the new framebuffer
328 * to complete before executing the flip. It should also wait for any
329 * pending rendering from other drivers if the underlying buffer is a
332 * An application can request to be notified when the page flip has
333 * completed. The drm core will supply a struct &drm_event in the event
334 * parameter in this case. This can be handled by the
335 * drm_crtc_send_vblank_event() function, which the driver should call on
336 * the provided event upon completion of the flip. Note that if
337 * the driver supports vblank signalling and timestamping the vblank
338 * counters and timestamps must agree with the ones returned from page
339 * flip events. With the current vblank helper infrastructure this can
340 * be achieved by holding a vblank reference while the page flip is
341 * pending, acquired through drm_crtc_vblank_get() and released with
342 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
343 * counter and timestamp tracking though, e.g. if they have accurate
344 * timestamp registers in hardware.
346 * This callback is optional.
350 * Very early versions of the KMS ABI mandated that the driver must
351 * block (but not reject) any rendering to the old framebuffer until the
352 * flip operation has completed and the old framebuffer is no longer
353 * visible. This requirement has been lifted, and userspace is instead
354 * expected to request delivery of an event and wait with recycling old
355 * buffers until such has been received.
359 * 0 on success or a negative error code on failure. Note that if a
360 * ->page_flip() operation is already pending the callback should return
361 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
362 * or just runtime disabled through DPMS respectively the new atomic
363 * "ACTIVE" state) should result in an -EINVAL error code. Note that
364 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
366 int (*page_flip)(struct drm_crtc *crtc,
367 struct drm_framebuffer *fb,
368 struct drm_pending_vblank_event *event,
374 * Same as @page_flip but with an additional parameter specifying the
375 * absolute target vertical blank period (as reported by
376 * drm_crtc_vblank_count()) when the flip should take effect.
378 * Note that the core code calls drm_crtc_vblank_get before this entry
379 * point, and will call drm_crtc_vblank_put if this entry point returns
380 * any non-0 error code. It's the driver's responsibility to call
381 * drm_crtc_vblank_put after this entry point returns 0, typically when
382 * the flip completes.
384 int (*page_flip_target)(struct drm_crtc *crtc,
385 struct drm_framebuffer *fb,
386 struct drm_pending_vblank_event *event,
387 uint32_t flags, uint32_t target);
392 * This is the legacy entry point to update a property attached to the
395 * Drivers implementing atomic modeset should use
396 * drm_atomic_helper_crtc_set_property() to implement this hook.
398 * This callback is optional if the driver does not support any legacy
399 * driver-private properties.
403 * 0 on success or a negative error code on failure.
405 int (*set_property)(struct drm_crtc *crtc,
406 struct drm_property *property, uint64_t val);
409 * @atomic_duplicate_state:
411 * Duplicate the current atomic state for this CRTC and return it.
412 * The core and helpers gurantee that any atomic state duplicated with
413 * this hook and still owned by the caller (i.e. not transferred to the
414 * driver by calling ->atomic_commit() from struct
415 * &drm_mode_config_funcs) will be cleaned up by calling the
416 * @atomic_destroy_state hook in this structure.
418 * Atomic drivers which don't subclass struct &drm_crtc should use
419 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
420 * state structure to extend it with driver-private state should use
421 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
422 * duplicated in a consistent fashion across drivers.
424 * It is an error to call this hook before crtc->state has been
425 * initialized correctly.
429 * If the duplicate state references refcounted resources this hook must
430 * acquire a reference for each of them. The driver must release these
431 * references again in @atomic_destroy_state.
435 * Duplicated atomic state or NULL when the allocation failed.
437 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
440 * @atomic_destroy_state:
442 * Destroy a state duplicated with @atomic_duplicate_state and release
443 * or unreference all resources it references
445 void (*atomic_destroy_state)(struct drm_crtc *crtc,
446 struct drm_crtc_state *state);
449 * @atomic_set_property:
451 * Decode a driver-private property value and store the decoded value
452 * into the passed-in state structure. Since the atomic core decodes all
453 * standardized properties (even for extensions beyond the core set of
454 * properties which might not be implemented by all drivers) this
455 * requires drivers to subclass the state structure.
457 * Such driver-private properties should really only be implemented for
458 * truly hardware/vendor specific state. Instead it is preferred to
459 * standardize atomic extension and decode the properties used to expose
460 * such an extension in the core.
462 * Do not call this function directly, use
463 * drm_atomic_crtc_set_property() instead.
465 * This callback is optional if the driver does not support any
466 * driver-private atomic properties.
470 * This function is called in the state assembly phase of atomic
471 * modesets, which can be aborted for any reason (including on
472 * userspace's request to just check whether a configuration would be
473 * possible). Drivers MUST NOT touch any persistent state (hardware or
474 * software) or data structures except the passed in @state parameter.
476 * Also since userspace controls in which order properties are set this
477 * function must not do any input validation (since the state update is
478 * incomplete and hence likely inconsistent). Instead any such input
479 * validation must be done in the various atomic_check callbacks.
483 * 0 if the property has been found, -EINVAL if the property isn't
484 * implemented by the driver (which should never happen, the core only
485 * asks for properties attached to this CRTC). No other validation is
486 * allowed by the driver. The core already checks that the property
487 * value is within the range (integer, valid enum value, ...) the driver
488 * set when registering the property.
490 int (*atomic_set_property)(struct drm_crtc *crtc,
491 struct drm_crtc_state *state,
492 struct drm_property *property,
495 * @atomic_get_property:
497 * Reads out the decoded driver-private property. This is used to
498 * implement the GETCRTC IOCTL.
500 * Do not call this function directly, use
501 * drm_atomic_crtc_get_property() instead.
503 * This callback is optional if the driver does not support any
504 * driver-private atomic properties.
508 * 0 on success, -EINVAL if the property isn't implemented by the
509 * driver (which should never happen, the core only asks for
510 * properties attached to this CRTC).
512 int (*atomic_get_property)(struct drm_crtc *crtc,
513 const struct drm_crtc_state *state,
514 struct drm_property *property,
520 * This optional hook can be used to register additional userspace
521 * interfaces attached to the crtc like debugfs interfaces.
522 * It is called late in the driver load sequence from drm_dev_register().
523 * Everything added from this callback should be unregistered in
524 * the early_unregister callback.
528 * 0 on success, or a negative error code on failure.
530 int (*late_register)(struct drm_crtc *crtc);
535 * This optional hook should be used to unregister the additional
536 * userspace interfaces attached to the crtc from
537 * late_unregister(). It is called from drm_dev_unregister(),
538 * early in the driver unload sequence to disable userspace access
539 * before data structures are torndown.
541 void (*early_unregister)(struct drm_crtc *crtc);
545 * struct drm_crtc - central CRTC control structure
546 * @dev: parent DRM device
547 * @port: OF node used by drm_of_find_possible_crtcs()
548 * @head: list management
549 * @name: human readable name, can be overwritten by the driver
550 * @mutex: per-CRTC locking
551 * @base: base KMS object for ID tracking etc.
552 * @primary: primary plane for this CRTC
553 * @cursor: cursor plane for this CRTC
554 * @cursor_x: current x position of the cursor, used for universal cursor planes
555 * @cursor_y: current y position of the cursor, used for universal cursor planes
556 * @enabled: is this CRTC enabled?
557 * @mode: current mode timings
558 * @hwmode: mode timings as programmed to hw regs
559 * @x: x position on screen
560 * @y: y position on screen
561 * @funcs: CRTC control functions
562 * @gamma_size: size of gamma ramp
563 * @gamma_store: gamma ramp values
564 * @helper_private: mid-layer private data
565 * @properties: property tracking for this CRTC
567 * Each CRTC may have one or more connectors associated with it. This structure
568 * allows the CRTC to be controlled.
571 struct drm_device *dev;
572 struct device_node *port;
573 struct list_head head;
580 * This provides a read lock for the overall crtc state (mode, dpms
581 * state, ...) and a write lock for everything which can be update
582 * without a full modeset (fb, cursor data, crtc properties ...). Full
583 * modeset also need to grab dev->mode_config.connection_mutex.
585 struct drm_modeset_lock mutex;
587 struct drm_mode_object base;
589 /* primary and cursor planes for CRTC */
590 struct drm_plane *primary;
591 struct drm_plane *cursor;
594 * @index: Position inside the mode_config.list, can be used as an array
595 * index. It is invariant over the lifetime of the CRTC.
599 /* position of cursor plane on crtc */
605 /* Requested mode from modesetting. */
606 struct drm_display_mode mode;
608 /* Programmed mode in hw, after adjustments for encoders,
609 * crtc, panel scaling etc. Needed for timestamping etc.
611 struct drm_display_mode hwmode;
614 const struct drm_crtc_funcs *funcs;
616 /* Legacy FB CRTC gamma size for reporting to userspace */
618 uint16_t *gamma_store;
620 /* if you are using the helper */
621 const struct drm_crtc_helper_funcs *helper_private;
623 struct drm_object_properties properties;
628 * Current atomic state for this CRTC.
630 struct drm_crtc_state *state;
635 * List of &drm_crtc_commit structures tracking pending commits.
636 * Protected by @commit_lock. This list doesn't hold its own full
637 * reference, but burrows it from the ongoing commit. Commit entries
638 * must be removed from this list once the commit is fully completed,
639 * but before it's correspoding &drm_atomic_state gets destroyed.
641 struct list_head commit_list;
646 * Spinlock to protect @commit_list.
648 spinlock_t commit_lock;
653 * Per-CRTC implicit acquire context used by atomic drivers for legacy
654 * IOCTLs, so that atomic drivers can get at the locking acquire
657 struct drm_modeset_acquire_ctx *acquire_ctx;
661 * struct drm_mode_set - new values for a CRTC config change
662 * @fb: framebuffer to use for new config
663 * @crtc: CRTC whose configuration we're about to change
664 * @mode: mode timings to use
665 * @x: position of this CRTC relative to @fb
666 * @y: position of this CRTC relative to @fb
667 * @connectors: array of connectors to drive with this CRTC if possible
668 * @num_connectors: size of @connectors array
670 * Represents a single crtc the connectors that it drives with what mode
671 * and from which framebuffer it scans out from.
673 * This is used to set modes.
675 struct drm_mode_set {
676 struct drm_framebuffer *fb;
677 struct drm_crtc *crtc;
678 struct drm_display_mode *mode;
683 struct drm_connector **connectors;
684 size_t num_connectors;
688 * struct drm_mode_config_funcs - basic driver provided mode setting functions
690 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
693 struct drm_mode_config_funcs {
697 * Create a new framebuffer object. The core does basic checks on the
698 * requested metadata, but most of that is left to the driver. See
699 * struct &drm_mode_fb_cmd2 for details.
701 * If the parameters are deemed valid and the backing storage objects in
702 * the underlying memory manager all exist, then the driver allocates
703 * a new &drm_framebuffer structure, subclassed to contain
704 * driver-specific information (like the internal native buffer object
705 * references). It also needs to fill out all relevant metadata, which
706 * should be done by calling drm_helper_mode_fill_fb_struct().
708 * The initialization is finalized by calling drm_framebuffer_init(),
709 * which registers the framebuffer and makes it accessible to other
714 * A new framebuffer with an initial reference count of 1 or a negative
715 * error code encoded with ERR_PTR().
717 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
718 struct drm_file *file_priv,
719 const struct drm_mode_fb_cmd2 *mode_cmd);
722 * @output_poll_changed:
724 * Callback used by helpers to inform the driver of output configuration
727 * Drivers implementing fbdev emulation with the helpers can call
728 * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
729 * helper of output changes.
733 * Except that there's no vtable for device-level helper callbacks
734 * there's no reason this is a core function.
736 void (*output_poll_changed)(struct drm_device *dev);
741 * This is the only hook to validate an atomic modeset update. This
742 * function must reject any modeset and state changes which the hardware
743 * or driver doesn't support. This includes but is of course not limited
746 * - Checking that the modes, framebuffers, scaling and placement
747 * requirements and so on are within the limits of the hardware.
749 * - Checking that any hidden shared resources are not oversubscribed.
750 * This can be shared PLLs, shared lanes, overall memory bandwidth,
751 * display fifo space (where shared between planes or maybe even
754 * - Checking that virtualized resources exported to userspace are not
755 * oversubscribed. For various reasons it can make sense to expose
756 * more planes, crtcs or encoders than which are physically there. One
757 * example is dual-pipe operations (which generally should be hidden
758 * from userspace if when lockstepped in hardware, exposed otherwise),
759 * where a plane might need 1 hardware plane (if it's just on one
760 * pipe), 2 hardware planes (when it spans both pipes) or maybe even
761 * shared a hardware plane with a 2nd plane (if there's a compatible
762 * plane requested on the area handled by the other pipe).
764 * - Check that any transitional state is possible and that if
765 * requested, the update can indeed be done in the vblank period
766 * without temporarily disabling some functions.
768 * - Check any other constraints the driver or hardware might have.
770 * - This callback also needs to correctly fill out the &drm_crtc_state
771 * in this update to make sure that drm_atomic_crtc_needs_modeset()
772 * reflects the nature of the possible update and returns true if and
773 * only if the update cannot be applied without tearing within one
774 * vblank on that CRTC. The core uses that information to reject
775 * updates which require a full modeset (i.e. blanking the screen, or
776 * at least pausing updates for a substantial amount of time) if
777 * userspace has disallowed that in its request.
779 * - The driver also does not need to repeat basic input validation
780 * like done for the corresponding legacy entry points. The core does
781 * that before calling this hook.
783 * See the documentation of @atomic_commit for an exhaustive list of
784 * error conditions which don't have to be checked at the
785 * ->atomic_check() stage?
787 * See the documentation for struct &drm_atomic_state for how exactly
788 * an atomic modeset update is described.
790 * Drivers using the atomic helpers can implement this hook using
791 * drm_atomic_helper_check(), or one of the exported sub-functions of
796 * 0 on success or one of the below negative error codes:
798 * - -EINVAL, if any of the above constraints are violated.
800 * - -EDEADLK, when returned from an attempt to acquire an additional
801 * &drm_modeset_lock through drm_modeset_lock().
803 * - -ENOMEM, if allocating additional state sub-structures failed due
806 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
807 * This can either be due to a pending signal, or because the driver
808 * needs to completely bail out to recover from an exceptional
809 * situation like a GPU hang. From a userspace point all errors are
812 int (*atomic_check)(struct drm_device *dev,
813 struct drm_atomic_state *state);
818 * This is the only hook to commit an atomic modeset update. The core
819 * guarantees that @atomic_check has been called successfully before
820 * calling this function, and that nothing has been changed in the
823 * See the documentation for struct &drm_atomic_state for how exactly
824 * an atomic modeset update is described.
826 * Drivers using the atomic helpers can implement this hook using
827 * drm_atomic_helper_commit(), or one of the exported sub-functions of
830 * Nonblocking commits (as indicated with the nonblock parameter) must
831 * do any preparatory work which might result in an unsuccessful commit
832 * in the context of this callback. The only exceptions are hardware
833 * errors resulting in -EIO. But even in that case the driver must
834 * ensure that the display pipe is at least running, to avoid
835 * compositors crashing when pageflips don't work. Anything else,
836 * specifically committing the update to the hardware, should be done
837 * without blocking the caller. For updates which do not require a
838 * modeset this must be guaranteed.
840 * The driver must wait for any pending rendering to the new
841 * framebuffers to complete before executing the flip. It should also
842 * wait for any pending rendering from other drivers if the underlying
843 * buffer is a shared dma-buf. Nonblocking commits must not wait for
844 * rendering in the context of this callback.
846 * An application can request to be notified when the atomic commit has
847 * completed. These events are per-CRTC and can be distinguished by the
848 * CRTC index supplied in &drm_event to userspace.
850 * The drm core will supply a struct &drm_event in the event
851 * member of each CRTC's &drm_crtc_state structure. This can be handled by the
852 * drm_crtc_send_vblank_event() function, which the driver should call on
853 * the provided event upon completion of the atomic commit. Note that if
854 * the driver supports vblank signalling and timestamping the vblank
855 * counters and timestamps must agree with the ones returned from page
856 * flip events. With the current vblank helper infrastructure this can
857 * be achieved by holding a vblank reference while the page flip is
858 * pending, acquired through drm_crtc_vblank_get() and released with
859 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
860 * counter and timestamp tracking though, e.g. if they have accurate
861 * timestamp registers in hardware.
865 * Drivers are not allowed to shut down any display pipe successfully
866 * enabled through an atomic commit on their own. Doing so can result in
867 * compositors crashing if a page flip is suddenly rejected because the
872 * 0 on success or one of the below negative error codes:
874 * - -EBUSY, if a nonblocking updated is requested and there is
875 * an earlier updated pending. Drivers are allowed to support a queue
876 * of outstanding updates, but currently no driver supports that.
877 * Note that drivers must wait for preceding updates to complete if a
878 * synchronous update is requested, they are not allowed to fail the
879 * commit in that case.
881 * - -ENOMEM, if the driver failed to allocate memory. Specifically
882 * this can happen when trying to pin framebuffers, which must only
883 * be done when committing the state.
885 * - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
886 * that the driver has run out of vram, iommu space or similar GPU
887 * address space needed for framebuffer.
889 * - -EIO, if the hardware completely died.
891 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
892 * This can either be due to a pending signal, or because the driver
893 * needs to completely bail out to recover from an exceptional
894 * situation like a GPU hang. From a userspace point of view all errors are
897 * This list is exhaustive. Specifically this hook is not allowed to
898 * return -EINVAL (any invalid requests should be caught in
899 * @atomic_check) or -EDEADLK (this function must not acquire
900 * additional modeset locks).
902 int (*atomic_commit)(struct drm_device *dev,
903 struct drm_atomic_state *state,
907 * @atomic_state_alloc:
909 * This optional hook can be used by drivers that want to subclass struct
910 * &drm_atomic_state to be able to track their own driver-private global
911 * state easily. If this hook is implemented, drivers must also
912 * implement @atomic_state_clear and @atomic_state_free.
916 * A new &drm_atomic_state on success or NULL on failure.
918 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
921 * @atomic_state_clear:
923 * This hook must clear any driver private state duplicated into the
924 * passed-in &drm_atomic_state. This hook is called when the caller
925 * encountered a &drm_modeset_lock deadlock and needs to drop all
926 * already acquired locks as part of the deadlock avoidance dance
927 * implemented in drm_modeset_lock_backoff().
929 * Any duplicated state must be invalidated since a concurrent atomic
930 * update might change it, and the drm atomic interfaces always apply
931 * updates as relative changes to the current state.
933 * Drivers that implement this must call drm_atomic_state_default_clear()
934 * to clear common state.
936 void (*atomic_state_clear)(struct drm_atomic_state *state);
939 * @atomic_state_free:
941 * This hook needs driver private resources and the &drm_atomic_state
942 * itself. Note that the core first calls drm_atomic_state_clear() to
943 * avoid code duplicate between the clear and free hooks.
945 * Drivers that implement this must call drm_atomic_state_default_free()
946 * to release common resources.
948 void (*atomic_state_free)(struct drm_atomic_state *state);
952 * struct drm_mode_config - Mode configuration control structure
953 * @mutex: mutex protecting KMS related lists and structures
954 * @connection_mutex: ww mutex protecting connector state and routing
955 * @acquire_ctx: global implicit acquire context used by atomic drivers for
957 * @fb_lock: mutex to protect fb state and lists
958 * @num_fb: number of fbs available
959 * @fb_list: list of framebuffers available
960 * @num_encoder: number of encoders on this device
961 * @encoder_list: list of encoder objects
962 * @num_overlay_plane: number of overlay planes on this device
963 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
964 * @plane_list: list of plane objects
965 * @num_crtc: number of CRTCs on this device
966 * @crtc_list: list of CRTC objects
967 * @property_list: list of property objects
968 * @min_width: minimum pixel width on this device
969 * @min_height: minimum pixel height on this device
970 * @max_width: maximum pixel width on this device
971 * @max_height: maximum pixel height on this device
972 * @funcs: core driver provided mode setting functions
973 * @fb_base: base address of the framebuffer
974 * @poll_enabled: track polling support for this device
975 * @poll_running: track polling status for this device
976 * @delayed_event: track delayed poll uevent deliver for this device
977 * @output_poll_work: delayed work for polling in process context
978 * @property_blob_list: list of all the blob property objects
979 * @blob_lock: mutex for blob property allocation and management
980 * @*_property: core property tracking
981 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
982 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
983 * @cursor_width: hint to userspace for max cursor width
984 * @cursor_height: hint to userspace for max cursor height
985 * @helper_private: mid-layer private data
987 * Core mode resource tracking structure. All CRTC, encoders, and connectors
988 * enumerated by the driver are added here, as are global properties. Some
989 * global restrictions are also here, e.g. dimension restrictions.
991 struct drm_mode_config {
992 struct mutex mutex; /* protects configuration (mode lists etc.) */
993 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
994 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
999 * Mutex for KMS ID allocation and management. Protects both @crtc_idr
1002 struct mutex idr_mutex;
1007 * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
1008 * connector, modes - just makes life easier to have only one.
1010 struct idr crtc_idr;
1015 * Use this idr for allocating new IDs for tiled sinks like use in some
1016 * high-res DP MST screens.
1018 struct idr tile_idr;
1020 struct mutex fb_lock; /* proctects global and per-file fb lists */
1022 struct list_head fb_list;
1025 * @num_connector: Number of connectors on this device.
1029 * @connector_ida: ID allocator for connector indices.
1031 struct ida connector_ida;
1033 * @connector_list: List of connector objects.
1035 struct list_head connector_list;
1037 struct list_head encoder_list;
1040 * Track # of overlay planes separately from # of total planes. By
1041 * default we only advertise overlay planes to userspace; if userspace
1042 * sets the "universal plane" capability bit, we'll go ahead and
1043 * expose all planes.
1045 int num_overlay_plane;
1046 int num_total_plane;
1047 struct list_head plane_list;
1050 struct list_head crtc_list;
1052 struct list_head property_list;
1054 int min_width, min_height;
1055 int max_width, max_height;
1056 const struct drm_mode_config_funcs *funcs;
1057 resource_size_t fb_base;
1059 /* output poll support */
1063 struct delayed_work output_poll_work;
1065 struct mutex blob_lock;
1067 /* pointers to standard properties */
1068 struct list_head property_blob_list;
1070 * @edid_property: Default connector property to hold the EDID of the
1071 * currently connected sink, if any.
1073 struct drm_property *edid_property;
1075 * @dpms_property: Default connector property to control the
1076 * connector's DPMS state.
1078 struct drm_property *dpms_property;
1080 * @path_property: Default connector property to hold the DP MST path
1083 struct drm_property *path_property;
1085 * @tile_property: Default connector property to store the tile
1086 * position of a tiled screen, for sinks which need to be driven with
1089 struct drm_property *tile_property;
1091 * @plane_type_property: Default plane property to differentiate
1092 * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
1094 struct drm_property *plane_type_property;
1096 * @rotation_property: Optional property for planes or CRTCs to specifiy
1099 struct drm_property *rotation_property;
1101 * @prop_src_x: Default atomic plane property for the plane source
1102 * position in the connected &drm_framebuffer.
1104 struct drm_property *prop_src_x;
1106 * @prop_src_y: Default atomic plane property for the plane source
1107 * position in the connected &drm_framebuffer.
1109 struct drm_property *prop_src_y;
1111 * @prop_src_w: Default atomic plane property for the plane source
1112 * position in the connected &drm_framebuffer.
1114 struct drm_property *prop_src_w;
1116 * @prop_src_h: Default atomic plane property for the plane source
1117 * position in the connected &drm_framebuffer.
1119 struct drm_property *prop_src_h;
1121 * @prop_crtc_x: Default atomic plane property for the plane destination
1122 * position in the &drm_crtc is is being shown on.
1124 struct drm_property *prop_crtc_x;
1126 * @prop_crtc_y: Default atomic plane property for the plane destination
1127 * position in the &drm_crtc is is being shown on.
1129 struct drm_property *prop_crtc_y;
1131 * @prop_crtc_w: Default atomic plane property for the plane destination
1132 * position in the &drm_crtc is is being shown on.
1134 struct drm_property *prop_crtc_w;
1136 * @prop_crtc_h: Default atomic plane property for the plane destination
1137 * position in the &drm_crtc is is being shown on.
1139 struct drm_property *prop_crtc_h;
1141 * @prop_fb_id: Default atomic plane property to specify the
1144 struct drm_property *prop_fb_id;
1146 * @prop_crtc_id: Default atomic plane property to specify the
1149 struct drm_property *prop_crtc_id;
1151 * @prop_active: Default atomic CRTC property to control the active
1152 * state, which is the simplified implementation for DPMS in atomic
1155 struct drm_property *prop_active;
1157 * @prop_mode_id: Default atomic CRTC property to set the mode for a
1158 * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
1159 * connectors must be of and active must be set to disabled, too.
1161 struct drm_property *prop_mode_id;
1164 * @dvi_i_subconnector_property: Optional DVI-I property to
1165 * differentiate between analog or digital mode.
1167 struct drm_property *dvi_i_subconnector_property;
1169 * @dvi_i_select_subconnector_property: Optional DVI-I property to
1170 * select between analog or digital mode.
1172 struct drm_property *dvi_i_select_subconnector_property;
1175 * @tv_subconnector_property: Optional TV property to differentiate
1176 * between different TV connector types.
1178 struct drm_property *tv_subconnector_property;
1180 * @tv_select_subconnector_property: Optional TV property to select
1181 * between different TV connector types.
1183 struct drm_property *tv_select_subconnector_property;
1185 * @tv_mode_property: Optional TV property to select
1186 * the output TV mode.
1188 struct drm_property *tv_mode_property;
1190 * @tv_left_margin_property: Optional TV property to set the left
1193 struct drm_property *tv_left_margin_property;
1195 * @tv_right_margin_property: Optional TV property to set the right
1198 struct drm_property *tv_right_margin_property;
1200 * @tv_top_margin_property: Optional TV property to set the right
1203 struct drm_property *tv_top_margin_property;
1205 * @tv_bottom_margin_property: Optional TV property to set the right
1208 struct drm_property *tv_bottom_margin_property;
1210 * @tv_brightness_property: Optional TV property to set the
1213 struct drm_property *tv_brightness_property;
1215 * @tv_contrast_property: Optional TV property to set the
1218 struct drm_property *tv_contrast_property;
1220 * @tv_flicker_reduction_property: Optional TV property to control the
1221 * flicker reduction mode.
1223 struct drm_property *tv_flicker_reduction_property;
1225 * @tv_overscan_property: Optional TV property to control the overscan
1228 struct drm_property *tv_overscan_property;
1230 * @tv_saturation_property: Optional TV property to set the
1233 struct drm_property *tv_saturation_property;
1235 * @tv_hue_property: Optional TV property to set the hue.
1237 struct drm_property *tv_hue_property;
1240 * @scaling_mode_property: Optional connector property to control the
1241 * upscaling, mostly used for built-in panels.
1243 struct drm_property *scaling_mode_property;
1245 * @aspect_ratio_property: Optional connector property to control the
1246 * HDMI infoframe aspect ratio setting.
1248 struct drm_property *aspect_ratio_property;
1250 * @degamma_lut_property: Optional CRTC property to set the LUT used to
1251 * convert the framebuffer's colors to linear gamma.
1253 struct drm_property *degamma_lut_property;
1255 * @degamma_lut_size_property: Optional CRTC property for the size of
1256 * the degamma LUT as supported by the driver (read-only).
1258 struct drm_property *degamma_lut_size_property;
1260 * @ctm_property: Optional CRTC property to set the
1261 * matrix used to convert colors after the lookup in the
1264 struct drm_property *ctm_property;
1266 * @gamma_lut_property: Optional CRTC property to set the LUT used to
1267 * convert the colors, after the CTM matrix, to the gamma space of the
1270 struct drm_property *gamma_lut_property;
1272 * @gamma_lut_size_property: Optional CRTC property for the size of the
1273 * gamma LUT as supported by the driver (read-only).
1275 struct drm_property *gamma_lut_size_property;
1278 * @suggested_x_property: Optional connector property with a hint for
1279 * the position of the output on the host's screen.
1281 struct drm_property *suggested_x_property;
1283 * @suggested_y_property: Optional connector property with a hint for
1284 * the position of the output on the host's screen.
1286 struct drm_property *suggested_y_property;
1288 /* dumb ioctl parameters */
1289 uint32_t preferred_depth, prefer_shadow;
1292 * @async_page_flip: Does this device support async flips on the primary
1295 bool async_page_flip;
1298 * @allow_fb_modifiers:
1300 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
1302 bool allow_fb_modifiers;
1305 uint32_t cursor_width, cursor_height;
1307 struct drm_mode_config_helper_funcs *helper_private;
1310 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1312 extern __printf(6, 7)
1313 int drm_crtc_init_with_planes(struct drm_device *dev,
1314 struct drm_crtc *crtc,
1315 struct drm_plane *primary,
1316 struct drm_plane *cursor,
1317 const struct drm_crtc_funcs *funcs,
1318 const char *name, ...);
1319 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1322 * drm_crtc_index - find the index of a registered CRTC
1323 * @crtc: CRTC to find index for
1325 * Given a registered CRTC, return the index of that CRTC within a DRM
1326 * device's list of CRTCs.
1328 static inline unsigned int drm_crtc_index(struct drm_crtc *crtc)
1334 * drm_crtc_mask - find the mask of a registered CRTC
1335 * @crtc: CRTC to find mask for
1337 * Given a registered CRTC, return the mask bit of that CRTC for an
1338 * encoder's possible_crtcs field.
1340 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1342 return 1 << drm_crtc_index(crtc);
1345 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1346 int *hdisplay, int *vdisplay);
1347 extern int drm_crtc_force_disable(struct drm_crtc *crtc);
1348 extern int drm_crtc_force_disable_all(struct drm_device *dev);
1350 extern void drm_mode_config_init(struct drm_device *dev);
1351 extern void drm_mode_config_reset(struct drm_device *dev);
1352 extern void drm_mode_config_cleanup(struct drm_device *dev);
1354 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1357 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1359 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1361 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1363 extern void drm_mode_put_tile_group(struct drm_device *dev,
1364 struct drm_tile_group *tg);
1366 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1367 unsigned int supported_rotations);
1368 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1369 unsigned int supported_rotations);
1370 extern void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
1371 uint degamma_lut_size,
1373 uint gamma_lut_size);
1375 int drm_plane_create_zpos_property(struct drm_plane *plane,
1377 unsigned int min, unsigned int max);
1379 int drm_plane_create_zpos_immutable_property(struct drm_plane *plane,
1383 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1386 struct drm_mode_object *mo;
1387 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1388 return mo ? obj_to_crtc(mo) : NULL;
1392 * Extract a degamma/gamma LUT value provided by user and round it to the
1393 * precision supported by the hardware.
1395 static inline uint32_t drm_color_lut_extract(uint32_t user_input,
1396 uint32_t bit_precision)
1398 uint32_t val = user_input;
1399 uint32_t max = 0xffff >> (16 - bit_precision);
1401 /* Round only if we're not using full precision. */
1402 if (bit_precision < 16) {
1403 val += 1UL << (16 - bit_precision - 1);
1404 val >>= 16 - bit_precision;
1407 return clamp_val(val, 0, max);
1410 #define drm_for_each_crtc(crtc, dev) \
1411 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1414 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1417 * The connector hotadd/remove code currently grabs both locks when
1418 * updating lists. Hence readers need only hold either of them to be
1419 * safe and the check amounts to
1421 * WARN_ON(not_holding(A) && not_holding(B)).
1423 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1424 !drm_modeset_is_locked(&mode_config->connection_mutex));
1427 #endif /* __DRM_CRTC_H__ */