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>
41 struct drm_framebuffer;
42 struct drm_object_properties;
48 struct drm_mode_object {
51 struct drm_object_properties *properties;
53 void (*free_cb)(struct kref *kref);
56 #define DRM_OBJECT_MAX_PROPERTY 24
57 struct drm_object_properties {
58 int count, atomic_count;
59 /* NOTE: if we ever start dynamically destroying properties (ie.
60 * not at drm_mode_config_cleanup() time), then we'd have to do
61 * a better job of detaching property from mode objects to avoid
62 * dangling property pointers:
64 struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
65 /* do not read/write values directly, but use drm_object_property_get_value()
66 * and drm_object_property_set_value():
68 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
71 static inline int64_t U642I64(uint64_t val)
73 return (int64_t)*((int64_t *)&val);
75 static inline uint64_t I642U64(int64_t val)
77 return (uint64_t)*((uint64_t *)&val);
81 * Rotation property bits. DRM_ROTATE_<degrees> rotates the image by the
82 * specified amount in degrees in counter clockwise direction. DRM_REFLECT_X and
83 * DRM_REFLECT_Y reflects the image along the specified axis prior to rotation
85 #define DRM_ROTATE_MASK 0x0f
86 #define DRM_ROTATE_0 0
87 #define DRM_ROTATE_90 1
88 #define DRM_ROTATE_180 2
89 #define DRM_ROTATE_270 3
90 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
91 #define DRM_REFLECT_X 4
92 #define DRM_REFLECT_Y 5
94 enum drm_connector_force {
95 DRM_FORCE_UNSPECIFIED,
97 DRM_FORCE_ON, /* force on analog part normally */
98 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
101 #include <drm/drm_modes.h>
103 enum drm_connector_status {
104 connector_status_connected = 1,
105 connector_status_disconnected = 2,
106 connector_status_unknown = 3,
109 enum subpixel_order {
111 SubPixelHorizontalRGB,
112 SubPixelHorizontalBGR,
118 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
119 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
120 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
122 #define DRM_BUS_FLAG_DE_LOW (1<<0)
123 #define DRM_BUS_FLAG_DE_HIGH (1<<1)
124 /* drive data on pos. edge */
125 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
126 /* drive data on neg. edge */
127 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
130 * Describes a given display (e.g. CRT or flat panel) and its limitations.
132 struct drm_display_info {
133 char name[DRM_DISPLAY_INFO_LEN];
136 unsigned int width_mm;
137 unsigned int height_mm;
139 /* Clock limits FIXME: storage format */
140 unsigned int min_vfreq, max_vfreq;
141 unsigned int min_hfreq, max_hfreq;
142 unsigned int pixel_clock;
145 enum subpixel_order subpixel_order;
148 const u32 *bus_formats;
149 unsigned int num_bus_formats;
152 /* Mask of supported hdmi deep color modes */
153 u8 edid_hdmi_dc_modes;
158 /* data corresponds to displayid vend/prod/serial */
159 struct drm_tile_group {
160 struct kref refcount;
161 struct drm_device *dev;
167 * struct drm_framebuffer_funcs - framebuffer hooks
169 struct drm_framebuffer_funcs {
173 * Clean up framebuffer resources, specifically also unreference the
174 * backing storage. The core guarantees to call this function for every
175 * framebuffer successfully created by ->fb_create() in
176 * &drm_mode_config_funcs. Drivers must also call
177 * drm_framebuffer_cleanup() to release DRM core resources for this
180 void (*destroy)(struct drm_framebuffer *framebuffer);
185 * Create a buffer handle in the driver-specific buffer manager (either
186 * GEM or TTM) valid for the passed-in struct &drm_file. This is used by
187 * the core to implement the GETFB IOCTL, which returns (for
188 * sufficiently priviledged user) also a native buffer handle. This can
189 * be used for seamless transitions between modesetting clients by
190 * copying the current screen contents to a private buffer and blending
191 * between that and the new contents.
193 * GEM based drivers should call drm_gem_handle_create() to create the
198 * 0 on success or a negative error code on failure.
200 int (*create_handle)(struct drm_framebuffer *fb,
201 struct drm_file *file_priv,
202 unsigned int *handle);
206 * Optional callback for the dirty fb IOCTL.
208 * Userspace can notify the driver via this callback that an area of the
209 * framebuffer has changed and should be flushed to the display
210 * hardware. This can also be used internally, e.g. by the fbdev
211 * emulation, though that's not the case currently.
213 * See documentation in drm_mode.h for the struct drm_mode_fb_dirty_cmd
214 * for more information as all the semantics and arguments have a one to
215 * one mapping on this function.
219 * 0 on success or a negative error code on failure.
221 int (*dirty)(struct drm_framebuffer *framebuffer,
222 struct drm_file *file_priv, unsigned flags,
223 unsigned color, struct drm_clip_rect *clips,
227 struct drm_framebuffer {
228 struct drm_device *dev;
230 * Note that the fb is refcounted for the benefit of driver internals,
231 * for example some hw, disabling a CRTC/plane is asynchronous, and
232 * scanout does not actually complete until the next vblank. So some
233 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
234 * should be deferred. In cases like this, the driver would like to
235 * hold a ref to the fb even though it has already been removed from
236 * userspace perspective.
237 * The refcount is stored inside the mode object.
240 * Place on the dev->mode_config.fb_list, access protected by
241 * dev->mode_config.fb_lock.
243 struct list_head head;
244 struct drm_mode_object base;
245 const struct drm_framebuffer_funcs *funcs;
246 unsigned int pitches[4];
247 unsigned int offsets[4];
248 uint64_t modifier[4];
251 /* depth can be 15 or 16 */
255 uint32_t pixel_format; /* fourcc format */
256 struct list_head filp_head;
259 struct drm_property_blob {
260 struct drm_mode_object base;
261 struct drm_device *dev;
262 struct list_head head_global;
263 struct list_head head_file;
265 unsigned char data[];
268 struct drm_property_enum {
270 struct list_head head;
271 char name[DRM_PROP_NAME_LEN];
274 struct drm_property {
275 struct list_head head;
276 struct drm_mode_object base;
278 char name[DRM_PROP_NAME_LEN];
281 struct drm_device *dev;
283 struct list_head enum_list;
287 struct drm_connector;
289 struct drm_pending_vblank_event;
292 struct drm_atomic_state;
294 struct drm_crtc_helper_funcs;
295 struct drm_encoder_helper_funcs;
296 struct drm_connector_helper_funcs;
297 struct drm_plane_helper_funcs;
300 * struct drm_crtc_state - mutable CRTC state
301 * @crtc: backpointer to the CRTC
302 * @enable: whether the CRTC should be enabled, gates all other state
303 * @active: whether the CRTC is actively displaying (used for DPMS)
304 * @planes_changed: planes on this crtc are updated
305 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
306 * @active_changed: crtc_state->active has been toggled.
307 * @connectors_changed: connectors to this crtc have been updated
308 * @color_mgmt_changed: color management properties have changed (degamma or
309 * gamma LUT or CSC matrix)
310 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
311 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors
312 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders
313 * @last_vblank_count: for helpers and drivers to capture the vblank of the
314 * update to ensure framebuffer cleanup isn't done too early
315 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
316 * @mode: current mode timings
317 * @degamma_lut: Lookup table for converting framebuffer pixel data
318 * before apply the conversion matrix
319 * @ctm: Transformation matrix
320 * @gamma_lut: Lookup table for converting pixel data after the
322 * @event: optional pointer to a DRM event to signal upon completion of the
324 * @state: backpointer to global drm_atomic_state
326 * Note that the distinction between @enable and @active is rather subtile:
327 * Flipping @active while @enable is set without changing anything else may
328 * never return in a failure from the ->atomic_check callback. Userspace assumes
329 * that a DPMS On will always succeed. In other words: @enable controls resource
330 * assignment, @active controls the actual hardware state.
332 struct drm_crtc_state {
333 struct drm_crtc *crtc;
338 /* computed state bits used by helpers and drivers */
339 bool planes_changed : 1;
340 bool mode_changed : 1;
341 bool active_changed : 1;
342 bool connectors_changed : 1;
343 bool color_mgmt_changed : 1;
345 /* attached planes bitmask:
346 * WARNING: transitional helpers do not maintain plane_mask so
347 * drivers not converted over to atomic helpers should not rely
348 * on plane_mask being accurate!
355 /* last_vblank_count: for vblank waits before cleanup */
356 u32 last_vblank_count;
358 /* adjusted_mode: for use by helpers and drivers */
359 struct drm_display_mode adjusted_mode;
361 struct drm_display_mode mode;
363 /* blob property to expose current mode to atomic userspace */
364 struct drm_property_blob *mode_blob;
366 /* blob property to expose color management to userspace */
367 struct drm_property_blob *degamma_lut;
368 struct drm_property_blob *ctm;
369 struct drm_property_blob *gamma_lut;
371 struct drm_pending_vblank_event *event;
373 struct drm_atomic_state *state;
377 * struct drm_crtc_funcs - control CRTCs for a given device
379 * The drm_crtc_funcs structure is the central CRTC management structure
380 * in the DRM. Each CRTC controls one or more connectors (note that the name
381 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
382 * connectors, not just CRTs).
384 * Each driver is responsible for filling out this structure at startup time,
385 * in addition to providing other modesetting features, like i2c and DDC
388 struct drm_crtc_funcs {
392 * Reset CRTC hardware and software state to off. This function isn't
393 * called by the core directly, only through drm_mode_config_reset().
394 * It's not a helper hook only for historical reasons.
396 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
397 * atomic state using this hook.
399 void (*reset)(struct drm_crtc *crtc);
404 * Update the cursor image. The cursor position is relative to the CRTC
405 * and can be partially or fully outside of the visible area.
407 * Note that contrary to all other KMS functions the legacy cursor entry
408 * points don't take a framebuffer object, but instead take directly a
409 * raw buffer object id from the driver's buffer manager (which is
410 * either GEM or TTM for current drivers).
412 * This entry point is deprecated, drivers should instead implement
413 * universal plane support and register a proper cursor plane using
414 * drm_crtc_init_with_planes().
416 * This callback is optional
420 * 0 on success or a negative error code on failure.
422 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
423 uint32_t handle, uint32_t width, uint32_t height);
428 * Update the cursor image, including hotspot information. The hotspot
429 * must not affect the cursor position in CRTC coordinates, but is only
430 * meant as a hint for virtualized display hardware to coordinate the
431 * guests and hosts cursor position. The cursor hotspot is relative to
432 * the cursor image. Otherwise this works exactly like @cursor_set.
434 * This entry point is deprecated, drivers should instead implement
435 * universal plane support and register a proper cursor plane using
436 * drm_crtc_init_with_planes().
438 * This callback is optional.
442 * 0 on success or a negative error code on failure.
444 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
445 uint32_t handle, uint32_t width, uint32_t height,
446 int32_t hot_x, int32_t hot_y);
451 * Update the cursor position. The cursor does not need to be visible
452 * when this hook is called.
454 * This entry point is deprecated, drivers should instead implement
455 * universal plane support and register a proper cursor plane using
456 * drm_crtc_init_with_planes().
458 * This callback is optional.
462 * 0 on success or a negative error code on failure.
464 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
469 * Set gamma on the CRTC.
471 * This callback is optional.
475 * Drivers that support gamma tables and also fbdev emulation through
476 * the provided helper library need to take care to fill out the gamma
477 * hooks for both. Currently there's a bit an unfortunate duplication
478 * going on, which should eventually be unified to just one set of
481 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
482 uint32_t start, uint32_t size);
487 * Clean up plane resources. This is only called at driver unload time
488 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
491 void (*destroy)(struct drm_crtc *crtc);
496 * This is the main legacy entry point to change the modeset state on a
497 * CRTC. All the details of the desired configuration are passed in a
498 * struct &drm_mode_set - see there for details.
500 * Drivers implementing atomic modeset should use
501 * drm_atomic_helper_set_config() to implement this hook.
505 * 0 on success or a negative error code on failure.
507 int (*set_config)(struct drm_mode_set *set);
512 * Legacy entry point to schedule a flip to the given framebuffer.
514 * Page flipping is a synchronization mechanism that replaces the frame
515 * buffer being scanned out by the CRTC with a new frame buffer during
516 * vertical blanking, avoiding tearing (except when requested otherwise
517 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
518 * requests a page flip the DRM core verifies that the new frame buffer
519 * is large enough to be scanned out by the CRTC in the currently
520 * configured mode and then calls the CRTC ->page_flip() operation with a
521 * pointer to the new frame buffer.
523 * The driver must wait for any pending rendering to the new framebuffer
524 * to complete before executing the flip. It should also wait for any
525 * pending rendering from other drivers if the underlying buffer is a
528 * An application can request to be notified when the page flip has
529 * completed. The drm core will supply a struct &drm_event in the event
530 * parameter in this case. This can be handled by the
531 * drm_crtc_send_vblank_event() function, which the driver should call on
532 * the provided event upon completion of the flip. Note that if
533 * the driver supports vblank signalling and timestamping the vblank
534 * counters and timestamps must agree with the ones returned from page
535 * flip events. With the current vblank helper infrastructure this can
536 * be achieved by holding a vblank reference while the page flip is
537 * pending, acquired through drm_crtc_vblank_get() and released with
538 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
539 * counter and timestamp tracking though, e.g. if they have accurate
540 * timestamp registers in hardware.
544 * Up to that point drivers need to manage events themselves and can use
545 * even->base.list freely for that. Specifically they need to ensure
546 * that they don't send out page flip (or vblank) events for which the
547 * corresponding drm file has been closed already. The drm core
548 * unfortunately does not (yet) take care of that. Therefore drivers
549 * currently must clean up and release pending events in their
550 * ->preclose driver function.
552 * This callback is optional.
556 * Very early versions of the KMS ABI mandated that the driver must
557 * block (but not reject) any rendering to the old framebuffer until the
558 * flip operation has completed and the old framebuffer is no longer
559 * visible. This requirement has been lifted, and userspace is instead
560 * expected to request delivery of an event and wait with recycling old
561 * buffers until such has been received.
565 * 0 on success or a negative error code on failure. Note that if a
566 * ->page_flip() operation is already pending the callback should return
567 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
568 * or just runtime disabled through DPMS respectively the new atomic
569 * "ACTIVE" state) should result in an -EINVAL error code. Note that
570 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
572 int (*page_flip)(struct drm_crtc *crtc,
573 struct drm_framebuffer *fb,
574 struct drm_pending_vblank_event *event,
580 * This is the legacy entry point to update a property attached to the
583 * Drivers implementing atomic modeset should use
584 * drm_atomic_helper_crtc_set_property() to implement this hook.
586 * This callback is optional if the driver does not support any legacy
587 * driver-private properties.
591 * 0 on success or a negative error code on failure.
593 int (*set_property)(struct drm_crtc *crtc,
594 struct drm_property *property, uint64_t val);
597 * @atomic_duplicate_state:
599 * Duplicate the current atomic state for this CRTC and return it.
600 * The core and helpers gurantee that any atomic state duplicated with
601 * this hook and still owned by the caller (i.e. not transferred to the
602 * driver by calling ->atomic_commit() from struct
603 * &drm_mode_config_funcs) will be cleaned up by calling the
604 * @atomic_destroy_state hook in this structure.
606 * Atomic drivers which don't subclass struct &drm_crtc should use
607 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
608 * state structure to extend it with driver-private state should use
609 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
610 * duplicated in a consistent fashion across drivers.
612 * It is an error to call this hook before crtc->state has been
613 * initialized correctly.
617 * If the duplicate state references refcounted resources this hook must
618 * acquire a reference for each of them. The driver must release these
619 * references again in @atomic_destroy_state.
623 * Duplicated atomic state or NULL when the allocation failed.
625 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
628 * @atomic_destroy_state:
630 * Destroy a state duplicated with @atomic_duplicate_state and release
631 * or unreference all resources it references
633 void (*atomic_destroy_state)(struct drm_crtc *crtc,
634 struct drm_crtc_state *state);
637 * @atomic_set_property:
639 * Decode a driver-private property value and store the decoded value
640 * into the passed-in state structure. Since the atomic core decodes all
641 * standardized properties (even for extensions beyond the core set of
642 * properties which might not be implemented by all drivers) this
643 * requires drivers to subclass the state structure.
645 * Such driver-private properties should really only be implemented for
646 * truly hardware/vendor specific state. Instead it is preferred to
647 * standardize atomic extension and decode the properties used to expose
648 * such an extension in the core.
650 * Do not call this function directly, use
651 * drm_atomic_crtc_set_property() instead.
653 * This callback is optional if the driver does not support any
654 * driver-private atomic properties.
658 * This function is called in the state assembly phase of atomic
659 * modesets, which can be aborted for any reason (including on
660 * userspace's request to just check whether a configuration would be
661 * possible). Drivers MUST NOT touch any persistent state (hardware or
662 * software) or data structures except the passed in @state parameter.
664 * Also since userspace controls in which order properties are set this
665 * function must not do any input validation (since the state update is
666 * incomplete and hence likely inconsistent). Instead any such input
667 * validation must be done in the various atomic_check callbacks.
671 * 0 if the property has been found, -EINVAL if the property isn't
672 * implemented by the driver (which should never happen, the core only
673 * asks for properties attached to this CRTC). No other validation is
674 * allowed by the driver. The core already checks that the property
675 * value is within the range (integer, valid enum value, ...) the driver
676 * set when registering the property.
678 int (*atomic_set_property)(struct drm_crtc *crtc,
679 struct drm_crtc_state *state,
680 struct drm_property *property,
683 * @atomic_get_property:
685 * Reads out the decoded driver-private property. This is used to
686 * implement the GETCRTC IOCTL.
688 * Do not call this function directly, use
689 * drm_atomic_crtc_get_property() instead.
691 * This callback is optional if the driver does not support any
692 * driver-private atomic properties.
696 * 0 on success, -EINVAL if the property isn't implemented by the
697 * driver (which should never happen, the core only asks for
698 * properties attached to this CRTC).
700 int (*atomic_get_property)(struct drm_crtc *crtc,
701 const struct drm_crtc_state *state,
702 struct drm_property *property,
707 * struct drm_crtc - central CRTC control structure
708 * @dev: parent DRM device
709 * @port: OF node used by drm_of_find_possible_crtcs()
710 * @head: list management
711 * @mutex: per-CRTC locking
712 * @base: base KMS object for ID tracking etc.
713 * @primary: primary plane for this CRTC
714 * @cursor: cursor plane for this CRTC
715 * @cursor_x: current x position of the cursor, used for universal cursor planes
716 * @cursor_y: current y position of the cursor, used for universal cursor planes
717 * @enabled: is this CRTC enabled?
718 * @mode: current mode timings
719 * @hwmode: mode timings as programmed to hw regs
720 * @x: x position on screen
721 * @y: y position on screen
722 * @funcs: CRTC control functions
723 * @gamma_size: size of gamma ramp
724 * @gamma_store: gamma ramp values
725 * @helper_private: mid-layer private data
726 * @properties: property tracking for this CRTC
727 * @state: current atomic state for this CRTC
728 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
731 * Each CRTC may have one or more connectors associated with it. This structure
732 * allows the CRTC to be controlled.
735 struct drm_device *dev;
736 struct device_node *port;
737 struct list_head head;
744 * This provides a read lock for the overall crtc state (mode, dpms
745 * state, ...) and a write lock for everything which can be update
746 * without a full modeset (fb, cursor data, ...)
748 struct drm_modeset_lock mutex;
750 struct drm_mode_object base;
752 /* primary and cursor planes for CRTC */
753 struct drm_plane *primary;
754 struct drm_plane *cursor;
756 /* position inside the mode_config.list, can be used as a [] idx */
759 /* position of cursor plane on crtc */
765 /* Requested mode from modesetting. */
766 struct drm_display_mode mode;
768 /* Programmed mode in hw, after adjustments for encoders,
769 * crtc, panel scaling etc. Needed for timestamping etc.
771 struct drm_display_mode hwmode;
774 const struct drm_crtc_funcs *funcs;
776 /* Legacy FB CRTC gamma size for reporting to userspace */
778 uint16_t *gamma_store;
780 /* if you are using the helper */
781 const struct drm_crtc_helper_funcs *helper_private;
783 struct drm_object_properties properties;
785 struct drm_crtc_state *state;
788 * For legacy crtc IOCTLs so that atomic drivers can get at the locking
791 struct drm_modeset_acquire_ctx *acquire_ctx;
795 * struct drm_connector_state - mutable connector state
796 * @connector: backpointer to the connector
797 * @crtc: CRTC to connect connector to, NULL if disabled
798 * @best_encoder: can be used by helpers and drivers to select the encoder
799 * @state: backpointer to global drm_atomic_state
801 struct drm_connector_state {
802 struct drm_connector *connector;
804 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
806 struct drm_encoder *best_encoder;
808 struct drm_atomic_state *state;
812 * struct drm_connector_funcs - control connectors on a given device
814 * Each CRTC may have one or more connectors attached to it. The functions
815 * below allow the core DRM code to control connectors, enumerate available modes,
818 struct drm_connector_funcs {
822 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
823 * is exposed as a standard property on the connector, but diverted to
824 * this callback in the drm core. Note that atomic drivers don't
825 * implement the 4 level DPMS support on the connector any more, but
826 * instead only have an on/off "ACTIVE" property on the CRTC object.
828 * Drivers implementing atomic modeset should use
829 * drm_atomic_helper_connector_dpms() to implement this hook.
833 * 0 on success or a negative error code on failure.
835 int (*dpms)(struct drm_connector *connector, int mode);
840 * Reset connector hardware and software state to off. This function isn't
841 * called by the core directly, only through drm_mode_config_reset().
842 * It's not a helper hook only for historical reasons.
844 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
845 * atomic state using this hook.
847 void (*reset)(struct drm_connector *connector);
852 * Check to see if anything is attached to the connector. The parameter
853 * force is set to false whilst polling, true when checking the
854 * connector due to a user request. force can be used by the driver to
855 * avoid expensive, destructive operations during automated probing.
859 * Note that this hook is only called by the probe helper. It's not in
860 * the helper library vtable purely for historical reasons. The only DRM
861 * core entry point to probe connector state is @fill_modes.
865 * drm_connector_status indicating the connector's status.
867 enum drm_connector_status (*detect)(struct drm_connector *connector,
873 * This function is called to update internal encoder state when the
874 * connector is forced to a certain state by userspace, either through
875 * the sysfs interfaces or on the kernel cmdline. In that case the
876 * @detect callback isn't called.
880 * Note that this hook is only called by the probe helper. It's not in
881 * the helper library vtable purely for historical reasons. The only DRM
882 * core entry point to probe connector state is @fill_modes.
884 void (*force)(struct drm_connector *connector);
889 * Entry point for output detection and basic mode validation. The
890 * driver should reprobe the output if needed (e.g. when hotplug
891 * handling is unreliable), add all detected modes to connector->modes
892 * and filter out any the device can't support in any configuration. It
893 * also needs to filter out any modes wider or higher than the
894 * parameters max_width and max_height indicate.
896 * The drivers must also prune any modes no longer valid from
897 * connector->modes. Furthermore it must update connector->status and
898 * connector->edid. If no EDID has been received for this output
899 * connector->edid must be NULL.
901 * Drivers using the probe helpers should use
902 * drm_helper_probe_single_connector_modes() or
903 * drm_helper_probe_single_connector_modes_nomerge() to implement this
908 * The number of modes detected and filled into connector->modes.
910 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
915 * This is the legacy entry point to update a property attached to the
918 * Drivers implementing atomic modeset should use
919 * drm_atomic_helper_connector_set_property() to implement this hook.
921 * This callback is optional if the driver does not support any legacy
922 * driver-private properties.
926 * 0 on success or a negative error code on failure.
928 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
934 * Clean up connector resources. This is called at driver unload time
935 * through drm_mode_config_cleanup(). It can also be called at runtime
936 * when a connector is being hot-unplugged for drivers that support
937 * connector hotplugging (e.g. DisplayPort MST).
939 void (*destroy)(struct drm_connector *connector);
942 * @atomic_duplicate_state:
944 * Duplicate the current atomic state for this connector and return it.
945 * The core and helpers gurantee that any atomic state duplicated with
946 * this hook and still owned by the caller (i.e. not transferred to the
947 * driver by calling ->atomic_commit() from struct
948 * &drm_mode_config_funcs) will be cleaned up by calling the
949 * @atomic_destroy_state hook in this structure.
951 * Atomic drivers which don't subclass struct &drm_connector_state should use
952 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
953 * state structure to extend it with driver-private state should use
954 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
955 * duplicated in a consistent fashion across drivers.
957 * It is an error to call this hook before connector->state has been
958 * initialized correctly.
962 * If the duplicate state references refcounted resources this hook must
963 * acquire a reference for each of them. The driver must release these
964 * references again in @atomic_destroy_state.
968 * Duplicated atomic state or NULL when the allocation failed.
970 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
973 * @atomic_destroy_state:
975 * Destroy a state duplicated with @atomic_duplicate_state and release
976 * or unreference all resources it references
978 void (*atomic_destroy_state)(struct drm_connector *connector,
979 struct drm_connector_state *state);
982 * @atomic_set_property:
984 * Decode a driver-private property value and store the decoded value
985 * into the passed-in state structure. Since the atomic core decodes all
986 * standardized properties (even for extensions beyond the core set of
987 * properties which might not be implemented by all drivers) this
988 * requires drivers to subclass the state structure.
990 * Such driver-private properties should really only be implemented for
991 * truly hardware/vendor specific state. Instead it is preferred to
992 * standardize atomic extension and decode the properties used to expose
993 * such an extension in the core.
995 * Do not call this function directly, use
996 * drm_atomic_connector_set_property() instead.
998 * This callback is optional if the driver does not support any
999 * driver-private atomic properties.
1003 * This function is called in the state assembly phase of atomic
1004 * modesets, which can be aborted for any reason (including on
1005 * userspace's request to just check whether a configuration would be
1006 * possible). Drivers MUST NOT touch any persistent state (hardware or
1007 * software) or data structures except the passed in @state parameter.
1009 * Also since userspace controls in which order properties are set this
1010 * function must not do any input validation (since the state update is
1011 * incomplete and hence likely inconsistent). Instead any such input
1012 * validation must be done in the various atomic_check callbacks.
1016 * 0 if the property has been found, -EINVAL if the property isn't
1017 * implemented by the driver (which shouldn't ever happen, the core only
1018 * asks for properties attached to this connector). No other validation
1019 * is allowed by the driver. The core already checks that the property
1020 * value is within the range (integer, valid enum value, ...) the driver
1021 * set when registering the property.
1023 int (*atomic_set_property)(struct drm_connector *connector,
1024 struct drm_connector_state *state,
1025 struct drm_property *property,
1029 * @atomic_get_property:
1031 * Reads out the decoded driver-private property. This is used to
1032 * implement the GETCONNECTOR IOCTL.
1034 * Do not call this function directly, use
1035 * drm_atomic_connector_get_property() instead.
1037 * This callback is optional if the driver does not support any
1038 * driver-private atomic properties.
1042 * 0 on success, -EINVAL if the property isn't implemented by the
1043 * driver (which shouldn't ever happen, the core only asks for
1044 * properties attached to this connector).
1046 int (*atomic_get_property)(struct drm_connector *connector,
1047 const struct drm_connector_state *state,
1048 struct drm_property *property,
1053 * struct drm_encoder_funcs - encoder controls
1055 * Encoders sit between CRTCs and connectors.
1057 struct drm_encoder_funcs {
1061 * Reset encoder hardware and software state to off. This function isn't
1062 * called by the core directly, only through drm_mode_config_reset().
1063 * It's not a helper hook only for historical reasons.
1065 void (*reset)(struct drm_encoder *encoder);
1070 * Clean up encoder resources. This is only called at driver unload time
1071 * through drm_mode_config_cleanup() since an encoder cannot be
1072 * hotplugged in DRM.
1074 void (*destroy)(struct drm_encoder *encoder);
1077 #define DRM_CONNECTOR_MAX_ENCODER 3
1080 * struct drm_encoder - central DRM encoder structure
1081 * @dev: parent DRM device
1082 * @head: list management
1083 * @base: base KMS object
1084 * @name: encoder name
1085 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
1086 * @possible_crtcs: bitmask of potential CRTC bindings
1087 * @possible_clones: bitmask of potential sibling encoders for cloning
1088 * @crtc: currently bound CRTC
1089 * @bridge: bridge associated to the encoder
1090 * @funcs: control functions
1091 * @helper_private: mid-layer private data
1093 * CRTCs drive pixels to encoders, which convert them into signals
1094 * appropriate for a given connector or set of connectors.
1096 struct drm_encoder {
1097 struct drm_device *dev;
1098 struct list_head head;
1100 struct drm_mode_object base;
1104 /* position inside the mode_config.list, can be used as a [] idx */
1107 uint32_t possible_crtcs;
1108 uint32_t possible_clones;
1110 struct drm_crtc *crtc;
1111 struct drm_bridge *bridge;
1112 const struct drm_encoder_funcs *funcs;
1113 const struct drm_encoder_helper_funcs *helper_private;
1116 /* should we poll this connector for connects and disconnects */
1117 /* hot plug detectable */
1118 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1119 /* poll for connections */
1120 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1121 /* can cleanly poll for disconnections without flickering the screen */
1122 /* DACs should rarely do this without a lot of testing */
1123 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1125 #define MAX_ELD_BYTES 128
1128 * struct drm_connector - central DRM connector control structure
1129 * @dev: parent DRM device
1130 * @kdev: kernel device for sysfs attributes
1131 * @attr: sysfs attributes
1132 * @head: list management
1133 * @base: base KMS object
1134 * @name: connector name
1135 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1136 * @connector_type_id: index into connector type enum
1137 * @interlace_allowed: can this connector handle interlaced modes?
1138 * @doublescan_allowed: can this connector handle doublescan?
1139 * @stereo_allowed: can this connector handle stereo modes?
1140 * @modes: modes available on this connector (from fill_modes() + user)
1141 * @status: one of the drm_connector_status enums (connected, not, or unknown)
1142 * @probed_modes: list of modes derived directly from the display
1143 * @display_info: information about attached display (e.g. from EDID)
1144 * @funcs: connector control functions
1145 * @edid_blob_ptr: DRM property containing EDID if present
1146 * @properties: property tracking for this connector
1147 * @path_blob_ptr: DRM blob property data for the DP MST path property
1148 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
1149 * @dpms: current dpms state
1150 * @helper_private: mid-layer private data
1151 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
1152 * @force: a %DRM_FORCE_<foo> state for forced mode sets
1153 * @override_edid: has the EDID been overwritten through debugfs for testing?
1154 * @encoder_ids: valid encoders for this connector
1155 * @encoder: encoder driving this connector, if any
1156 * @eld: EDID-like data, if present
1157 * @dvi_dual: dual link DVI, if found
1158 * @max_tmds_clock: max clock rate, if found
1159 * @latency_present: AV delay info from ELD, if found
1160 * @video_latency: video latency info from ELD, if found
1161 * @audio_latency: audio latency info from ELD, if found
1162 * @null_edid_counter: track sinks that give us all zeros for the EDID
1163 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
1164 * @edid_corrupt: indicates whether the last read EDID was corrupt
1165 * @debugfs_entry: debugfs directory for this connector
1166 * @state: current atomic state for this connector
1167 * @has_tile: is this connector connected to a tiled monitor
1168 * @tile_group: tile group for the connected monitor
1169 * @tile_is_single_monitor: whether the tile is one monitor housing
1170 * @num_h_tile: number of horizontal tiles in the tile group
1171 * @num_v_tile: number of vertical tiles in the tile group
1172 * @tile_h_loc: horizontal location of this tile
1173 * @tile_v_loc: vertical location of this tile
1174 * @tile_h_size: horizontal size of this tile.
1175 * @tile_v_size: vertical size of this tile.
1177 * Each connector may be connected to one or more CRTCs, or may be clonable by
1178 * another connector if they can share a CRTC. Each connector also has a specific
1179 * position in the broader display (referred to as a 'screen' though it could
1180 * span multiple monitors).
1182 struct drm_connector {
1183 struct drm_device *dev;
1184 struct device *kdev;
1185 struct device_attribute *attr;
1186 struct list_head head;
1188 struct drm_mode_object base;
1193 int connector_type_id;
1194 bool interlace_allowed;
1195 bool doublescan_allowed;
1196 bool stereo_allowed;
1197 struct list_head modes; /* list of modes on this connector */
1199 enum drm_connector_status status;
1201 /* these are modes added by probing with DDC or the BIOS */
1202 struct list_head probed_modes;
1204 struct drm_display_info display_info;
1205 const struct drm_connector_funcs *funcs;
1207 struct drm_property_blob *edid_blob_ptr;
1208 struct drm_object_properties properties;
1210 struct drm_property_blob *path_blob_ptr;
1212 struct drm_property_blob *tile_blob_ptr;
1214 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
1216 /* requested DPMS state */
1219 const struct drm_connector_helper_funcs *helper_private;
1221 /* forced on connector */
1222 struct drm_cmdline_mode cmdline_mode;
1223 enum drm_connector_force force;
1225 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
1226 struct drm_encoder *encoder; /* currently active encoder */
1229 uint8_t eld[MAX_ELD_BYTES];
1231 int max_tmds_clock; /* in MHz */
1232 bool latency_present[2];
1233 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
1234 int audio_latency[2];
1235 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
1236 unsigned bad_edid_counter;
1238 /* Flag for raw EDID header corruption - used in Displayport
1239 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
1243 struct dentry *debugfs_entry;
1245 struct drm_connector_state *state;
1247 /* DisplayID bits */
1249 struct drm_tile_group *tile_group;
1250 bool tile_is_single_monitor;
1252 uint8_t num_h_tile, num_v_tile;
1253 uint8_t tile_h_loc, tile_v_loc;
1254 uint16_t tile_h_size, tile_v_size;
1258 * struct drm_plane_state - mutable plane state
1259 * @plane: backpointer to the plane
1260 * @crtc: currently bound CRTC, NULL if disabled
1261 * @fb: currently bound framebuffer
1262 * @fence: optional fence to wait for before scanning out @fb
1263 * @crtc_x: left position of visible portion of plane on crtc
1264 * @crtc_y: upper position of visible portion of plane on crtc
1265 * @crtc_w: width of visible portion of plane on crtc
1266 * @crtc_h: height of visible portion of plane on crtc
1267 * @src_x: left position of visible portion of plane within
1269 * @src_y: upper position of visible portion of plane within
1271 * @src_w: width of visible portion of plane (in 16.16)
1272 * @src_h: height of visible portion of plane (in 16.16)
1273 * @state: backpointer to global drm_atomic_state
1275 struct drm_plane_state {
1276 struct drm_plane *plane;
1278 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
1279 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
1280 struct fence *fence;
1282 /* Signed dest location allows it to be partially off screen */
1283 int32_t crtc_x, crtc_y;
1284 uint32_t crtc_w, crtc_h;
1286 /* Source values are 16.16 fixed point */
1287 uint32_t src_x, src_y;
1288 uint32_t src_h, src_w;
1290 /* Plane rotation */
1291 unsigned int rotation;
1293 struct drm_atomic_state *state;
1298 * struct drm_plane_funcs - driver plane control functions
1300 struct drm_plane_funcs {
1304 * This is the legacy entry point to enable and configure the plane for
1305 * the given CRTC and framebuffer. It is never called to disable the
1306 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
1308 * The source rectangle in frame buffer memory coordinates is given by
1309 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
1310 * values). Devices that don't support subpixel plane coordinates can
1311 * ignore the fractional part.
1313 * The destination rectangle in CRTC coordinates is given by the
1314 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
1315 * Devices scale the source rectangle to the destination rectangle. If
1316 * scaling is not supported, and the source rectangle size doesn't match
1317 * the destination rectangle size, the driver must return a
1318 * -<errorname>EINVAL</errorname> error.
1320 * Drivers implementing atomic modeset should use
1321 * drm_atomic_helper_update_plane() to implement this hook.
1325 * 0 on success or a negative error code on failure.
1327 int (*update_plane)(struct drm_plane *plane,
1328 struct drm_crtc *crtc, struct drm_framebuffer *fb,
1329 int crtc_x, int crtc_y,
1330 unsigned int crtc_w, unsigned int crtc_h,
1331 uint32_t src_x, uint32_t src_y,
1332 uint32_t src_w, uint32_t src_h);
1337 * This is the legacy entry point to disable the plane. The DRM core
1338 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call
1339 * with the frame buffer ID set to 0. Disabled planes must not be
1340 * processed by the CRTC.
1342 * Drivers implementing atomic modeset should use
1343 * drm_atomic_helper_disable_plane() to implement this hook.
1347 * 0 on success or a negative error code on failure.
1349 int (*disable_plane)(struct drm_plane *plane);
1354 * Clean up plane resources. This is only called at driver unload time
1355 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
1358 void (*destroy)(struct drm_plane *plane);
1363 * Reset plane hardware and software state to off. This function isn't
1364 * called by the core directly, only through drm_mode_config_reset().
1365 * It's not a helper hook only for historical reasons.
1367 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
1368 * atomic state using this hook.
1370 void (*reset)(struct drm_plane *plane);
1375 * This is the legacy entry point to update a property attached to the
1378 * Drivers implementing atomic modeset should use
1379 * drm_atomic_helper_plane_set_property() to implement this hook.
1381 * This callback is optional if the driver does not support any legacy
1382 * driver-private properties.
1386 * 0 on success or a negative error code on failure.
1388 int (*set_property)(struct drm_plane *plane,
1389 struct drm_property *property, uint64_t val);
1392 * @atomic_duplicate_state:
1394 * Duplicate the current atomic state for this plane and return it.
1395 * The core and helpers gurantee that any atomic state duplicated with
1396 * this hook and still owned by the caller (i.e. not transferred to the
1397 * driver by calling ->atomic_commit() from struct
1398 * &drm_mode_config_funcs) will be cleaned up by calling the
1399 * @atomic_destroy_state hook in this structure.
1401 * Atomic drivers which don't subclass struct &drm_plane_state should use
1402 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
1403 * state structure to extend it with driver-private state should use
1404 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
1405 * duplicated in a consistent fashion across drivers.
1407 * It is an error to call this hook before plane->state has been
1408 * initialized correctly.
1412 * If the duplicate state references refcounted resources this hook must
1413 * acquire a reference for each of them. The driver must release these
1414 * references again in @atomic_destroy_state.
1418 * Duplicated atomic state or NULL when the allocation failed.
1420 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
1423 * @atomic_destroy_state:
1425 * Destroy a state duplicated with @atomic_duplicate_state and release
1426 * or unreference all resources it references
1428 void (*atomic_destroy_state)(struct drm_plane *plane,
1429 struct drm_plane_state *state);
1432 * @atomic_set_property:
1434 * Decode a driver-private property value and store the decoded value
1435 * into the passed-in state structure. Since the atomic core decodes all
1436 * standardized properties (even for extensions beyond the core set of
1437 * properties which might not be implemented by all drivers) this
1438 * requires drivers to subclass the state structure.
1440 * Such driver-private properties should really only be implemented for
1441 * truly hardware/vendor specific state. Instead it is preferred to
1442 * standardize atomic extension and decode the properties used to expose
1443 * such an extension in the core.
1445 * Do not call this function directly, use
1446 * drm_atomic_plane_set_property() instead.
1448 * This callback is optional if the driver does not support any
1449 * driver-private atomic properties.
1453 * This function is called in the state assembly phase of atomic
1454 * modesets, which can be aborted for any reason (including on
1455 * userspace's request to just check whether a configuration would be
1456 * possible). Drivers MUST NOT touch any persistent state (hardware or
1457 * software) or data structures except the passed in @state parameter.
1459 * Also since userspace controls in which order properties are set this
1460 * function must not do any input validation (since the state update is
1461 * incomplete and hence likely inconsistent). Instead any such input
1462 * validation must be done in the various atomic_check callbacks.
1466 * 0 if the property has been found, -EINVAL if the property isn't
1467 * implemented by the driver (which shouldn't ever happen, the core only
1468 * asks for properties attached to this plane). No other validation is
1469 * allowed by the driver. The core already checks that the property
1470 * value is within the range (integer, valid enum value, ...) the driver
1471 * set when registering the property.
1473 int (*atomic_set_property)(struct drm_plane *plane,
1474 struct drm_plane_state *state,
1475 struct drm_property *property,
1479 * @atomic_get_property:
1481 * Reads out the decoded driver-private property. This is used to
1482 * implement the GETPLANE IOCTL.
1484 * Do not call this function directly, use
1485 * drm_atomic_plane_get_property() instead.
1487 * This callback is optional if the driver does not support any
1488 * driver-private atomic properties.
1492 * 0 on success, -EINVAL if the property isn't implemented by the
1493 * driver (which should never happen, the core only asks for
1494 * properties attached to this plane).
1496 int (*atomic_get_property)(struct drm_plane *plane,
1497 const struct drm_plane_state *state,
1498 struct drm_property *property,
1502 enum drm_plane_type {
1503 DRM_PLANE_TYPE_OVERLAY,
1504 DRM_PLANE_TYPE_PRIMARY,
1505 DRM_PLANE_TYPE_CURSOR,
1510 * struct drm_plane - central DRM plane control structure
1511 * @dev: DRM device this plane belongs to
1512 * @head: for list management
1513 * @base: base mode object
1514 * @possible_crtcs: pipes this plane can be bound to
1515 * @format_types: array of formats supported by this plane
1516 * @format_count: number of formats supported
1517 * @format_default: driver hasn't supplied supported formats for the plane
1518 * @crtc: currently bound CRTC
1519 * @fb: currently bound fb
1520 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
1521 * drm_mode_set_config_internal() to implement correct refcounting.
1522 * @funcs: helper functions
1523 * @properties: property tracking for this plane
1524 * @type: type of plane (overlay, primary, cursor)
1525 * @state: current atomic state for this plane
1528 struct drm_device *dev;
1529 struct list_head head;
1533 struct drm_modeset_lock mutex;
1535 struct drm_mode_object base;
1537 uint32_t possible_crtcs;
1538 uint32_t *format_types;
1539 unsigned int format_count;
1540 bool format_default;
1542 struct drm_crtc *crtc;
1543 struct drm_framebuffer *fb;
1545 struct drm_framebuffer *old_fb;
1547 const struct drm_plane_funcs *funcs;
1549 struct drm_object_properties properties;
1551 enum drm_plane_type type;
1553 /* position inside the mode_config.list, can be used as a [] idx */
1556 const struct drm_plane_helper_funcs *helper_private;
1558 struct drm_plane_state *state;
1562 * struct drm_bridge_funcs - drm_bridge control functions
1563 * @attach: Called during drm_bridge_attach
1565 struct drm_bridge_funcs {
1566 int (*attach)(struct drm_bridge *bridge);
1571 * This callback is used to validate and adjust a mode. The paramater
1572 * mode is the display mode that should be fed to the next element in
1573 * the display chain, either the final &drm_connector or the next
1574 * &drm_bridge. The parameter adjusted_mode is the input mode the bridge
1575 * requires. It can be modified by this callback and does not need to
1578 * This is the only hook that allows a bridge to reject a modeset. If
1579 * this function passes all other callbacks must succeed for this
1584 * This function is called in the check phase of atomic modesets, which
1585 * can be aborted for any reason (including on userspace's request to
1586 * just check whether a configuration would be possible). Drivers MUST
1587 * NOT touch any persistent state (hardware or software) or data
1588 * structures except the passed in @state parameter.
1592 * True if an acceptable configuration is possible, false if the modeset
1593 * operation should be rejected.
1595 bool (*mode_fixup)(struct drm_bridge *bridge,
1596 const struct drm_display_mode *mode,
1597 struct drm_display_mode *adjusted_mode);
1601 * This callback should disable the bridge. It is called right before
1602 * the preceding element in the display pipe is disabled. If the
1603 * preceding element is a bridge this means it's called before that
1604 * bridge's ->disable() function. If the preceding element is a
1605 * &drm_encoder it's called right before the encoder's ->disable(),
1606 * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1608 * The bridge can assume that the display pipe (i.e. clocks and timing
1609 * signals) feeding it is still running when this callback is called.
1611 * The disable callback is optional.
1613 void (*disable)(struct drm_bridge *bridge);
1618 * This callback should disable the bridge. It is called right after
1619 * the preceding element in the display pipe is disabled. If the
1620 * preceding element is a bridge this means it's called after that
1621 * bridge's ->post_disable() function. If the preceding element is a
1622 * &drm_encoder it's called right after the encoder's ->disable(),
1623 * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1625 * The bridge must assume that the display pipe (i.e. clocks and timing
1626 * singals) feeding it is no longer running when this callback is
1629 * The post_disable callback is optional.
1631 void (*post_disable)(struct drm_bridge *bridge);
1636 * This callback should set the given mode on the bridge. It is called
1637 * after the ->mode_set() callback for the preceding element in the
1638 * display pipeline has been called already. The display pipe (i.e.
1639 * clocks and timing signals) is off when this function is called.
1641 void (*mode_set)(struct drm_bridge *bridge,
1642 struct drm_display_mode *mode,
1643 struct drm_display_mode *adjusted_mode);
1647 * This callback should enable the bridge. It is called right before
1648 * the preceding element in the display pipe is enabled. If the
1649 * preceding element is a bridge this means it's called before that
1650 * bridge's ->pre_enable() function. If the preceding element is a
1651 * &drm_encoder it's called right before the encoder's ->enable(),
1652 * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1654 * The display pipe (i.e. clocks and timing signals) feeding this bridge
1655 * will not yet be running when this callback is called. The bridge must
1656 * not enable the display link feeding the next bridge in the chain (if
1657 * there is one) when this callback is called.
1659 * The pre_enable callback is optional.
1661 void (*pre_enable)(struct drm_bridge *bridge);
1666 * This callback should enable the bridge. It is called right after
1667 * the preceding element in the display pipe is enabled. If the
1668 * preceding element is a bridge this means it's called after that
1669 * bridge's ->enable() function. If the preceding element is a
1670 * &drm_encoder it's called right after the encoder's ->enable(),
1671 * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1673 * The bridge can assume that the display pipe (i.e. clocks and timing
1674 * signals) feeding it is running when this callback is called. This
1675 * callback must enable the display link feeding the next bridge in the
1676 * chain if there is one.
1678 * The enable callback is optional.
1680 void (*enable)(struct drm_bridge *bridge);
1684 * struct drm_bridge - central DRM bridge control structure
1685 * @dev: DRM device this bridge belongs to
1686 * @encoder: encoder to which this bridge is connected
1687 * @next: the next bridge in the encoder chain
1688 * @of_node: device node pointer to the bridge
1689 * @list: to keep track of all added bridges
1690 * @funcs: control functions
1691 * @driver_private: pointer to the bridge driver's internal context
1694 struct drm_device *dev;
1695 struct drm_encoder *encoder;
1696 struct drm_bridge *next;
1698 struct device_node *of_node;
1700 struct list_head list;
1702 const struct drm_bridge_funcs *funcs;
1703 void *driver_private;
1706 struct __drm_planes_state {
1707 struct drm_plane *ptr;
1708 struct drm_plane_state *state;
1711 struct __drm_crtcs_state {
1712 struct drm_crtc *ptr;
1713 struct drm_crtc_state *state;
1716 struct __drm_connnectors_state {
1717 struct drm_connector *ptr;
1718 struct drm_connector_state *state;
1722 * struct drm_atomic_state - the global state object for atomic updates
1723 * @dev: parent DRM device
1724 * @allow_modeset: allow full modeset
1725 * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
1726 * @legacy_set_config: Disable conflicting encoders instead of failing with -EINVAL.
1727 * @planes: pointer to array of structures with per-plane data
1728 * @crtcs: pointer to array of CRTC pointers
1729 * @crtc_states: pointer to array of CRTC states pointers
1730 * @num_connector: size of the @connectors and @connector_states arrays
1731 * @connectors: pointer to array of structures with per-connector data
1732 * @acquire_ctx: acquire context for this atomic modeset state update
1734 struct drm_atomic_state {
1735 struct drm_device *dev;
1736 bool allow_modeset : 1;
1737 bool legacy_cursor_update : 1;
1738 bool legacy_set_config : 1;
1739 struct __drm_planes_state *planes;
1740 struct __drm_crtcs_state *crtcs;
1742 struct __drm_connnectors_state *connectors;
1744 struct drm_modeset_acquire_ctx *acquire_ctx;
1749 * struct drm_mode_set - new values for a CRTC config change
1750 * @fb: framebuffer to use for new config
1751 * @crtc: CRTC whose configuration we're about to change
1752 * @mode: mode timings to use
1753 * @x: position of this CRTC relative to @fb
1754 * @y: position of this CRTC relative to @fb
1755 * @connectors: array of connectors to drive with this CRTC if possible
1756 * @num_connectors: size of @connectors array
1758 * Represents a single crtc the connectors that it drives with what mode
1759 * and from which framebuffer it scans out from.
1761 * This is used to set modes.
1763 struct drm_mode_set {
1764 struct drm_framebuffer *fb;
1765 struct drm_crtc *crtc;
1766 struct drm_display_mode *mode;
1771 struct drm_connector **connectors;
1772 size_t num_connectors;
1776 * struct drm_mode_config_funcs - basic driver provided mode setting functions
1778 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
1781 struct drm_mode_config_funcs {
1785 * Create a new framebuffer object. The core does basic checks on the
1786 * requested metadata, but most of that is left to the driver. See
1787 * struct &drm_mode_fb_cmd2 for details.
1789 * If the parameters are deemed valid and the backing storage objects in
1790 * the underlying memory manager all exist, then the driver allocates
1791 * a new &drm_framebuffer structure, subclassed to contain
1792 * driver-specific information (like the internal native buffer object
1793 * references). It also needs to fill out all relevant metadata, which
1794 * should be done by calling drm_helper_mode_fill_fb_struct().
1796 * The initialization is finalized by calling drm_framebuffer_init(),
1797 * which registers the framebuffer and makes it accessible to other
1802 * A new framebuffer with an initial reference count of 1 or a negative
1803 * error code encoded with ERR_PTR().
1805 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
1806 struct drm_file *file_priv,
1807 const struct drm_mode_fb_cmd2 *mode_cmd);
1810 * @output_poll_changed:
1812 * Callback used by helpers to inform the driver of output configuration
1815 * Drivers implementing fbdev emulation with the helpers can call
1816 * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
1817 * helper of output changes.
1821 * Except that there's no vtable for device-level helper callbacks
1822 * there's no reason this is a core function.
1824 void (*output_poll_changed)(struct drm_device *dev);
1829 * This is the only hook to validate an atomic modeset update. This
1830 * function must reject any modeset and state changes which the hardware
1831 * or driver doesn't support. This includes but is of course not limited
1834 * - Checking that the modes, framebuffers, scaling and placement
1835 * requirements and so on are within the limits of the hardware.
1837 * - Checking that any hidden shared resources are not oversubscribed.
1838 * This can be shared PLLs, shared lanes, overall memory bandwidth,
1839 * display fifo space (where shared between planes or maybe even
1842 * - Checking that virtualized resources exported to userspace are not
1843 * oversubscribed. For various reasons it can make sense to expose
1844 * more planes, crtcs or encoders than which are physically there. One
1845 * example is dual-pipe operations (which generally should be hidden
1846 * from userspace if when lockstepped in hardware, exposed otherwise),
1847 * where a plane might need 1 hardware plane (if it's just on one
1848 * pipe), 2 hardware planes (when it spans both pipes) or maybe even
1849 * shared a hardware plane with a 2nd plane (if there's a compatible
1850 * plane requested on the area handled by the other pipe).
1852 * - Check that any transitional state is possible and that if
1853 * requested, the update can indeed be done in the vblank period
1854 * without temporarily disabling some functions.
1856 * - Check any other constraints the driver or hardware might have.
1858 * - This callback also needs to correctly fill out the &drm_crtc_state
1859 * in this update to make sure that drm_atomic_crtc_needs_modeset()
1860 * reflects the nature of the possible update and returns true if and
1861 * only if the update cannot be applied without tearing within one
1862 * vblank on that CRTC. The core uses that information to reject
1863 * updates which require a full modeset (i.e. blanking the screen, or
1864 * at least pausing updates for a substantial amount of time) if
1865 * userspace has disallowed that in its request.
1867 * - The driver also does not need to repeat basic input validation
1868 * like done for the corresponding legacy entry points. The core does
1869 * that before calling this hook.
1871 * See the documentation of @atomic_commit for an exhaustive list of
1872 * error conditions which don't have to be checked at the
1873 * ->atomic_check() stage?
1875 * See the documentation for struct &drm_atomic_state for how exactly
1876 * an atomic modeset update is described.
1878 * Drivers using the atomic helpers can implement this hook using
1879 * drm_atomic_helper_check(), or one of the exported sub-functions of
1884 * 0 on success or one of the below negative error codes:
1886 * - -EINVAL, if any of the above constraints are violated.
1888 * - -EDEADLK, when returned from an attempt to acquire an additional
1889 * &drm_modeset_lock through drm_modeset_lock().
1891 * - -ENOMEM, if allocating additional state sub-structures failed due
1892 * to lack of memory.
1894 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
1895 * This can either be due to a pending signal, or because the driver
1896 * needs to completely bail out to recover from an exceptional
1897 * situation like a GPU hang. From a userspace point all errors are
1900 int (*atomic_check)(struct drm_device *dev,
1901 struct drm_atomic_state *state);
1906 * This is the only hook to commit an atomic modeset update. The core
1907 * guarantees that @atomic_check has been called successfully before
1908 * calling this function, and that nothing has been changed in the
1911 * See the documentation for struct &drm_atomic_state for how exactly
1912 * an atomic modeset update is described.
1914 * Drivers using the atomic helpers can implement this hook using
1915 * drm_atomic_helper_commit(), or one of the exported sub-functions of
1918 * Nonblocking commits (as indicated with the nonblock parameter) must
1919 * do any preparatory work which might result in an unsuccessful commit
1920 * in the context of this callback. The only exceptions are hardware
1921 * errors resulting in -EIO. But even in that case the driver must
1922 * ensure that the display pipe is at least running, to avoid
1923 * compositors crashing when pageflips don't work. Anything else,
1924 * specifically committing the update to the hardware, should be done
1925 * without blocking the caller. For updates which do not require a
1926 * modeset this must be guaranteed.
1928 * The driver must wait for any pending rendering to the new
1929 * framebuffers to complete before executing the flip. It should also
1930 * wait for any pending rendering from other drivers if the underlying
1931 * buffer is a shared dma-buf. Nonblocking commits must not wait for
1932 * rendering in the context of this callback.
1934 * An application can request to be notified when the atomic commit has
1935 * completed. These events are per-CRTC and can be distinguished by the
1936 * CRTC index supplied in &drm_event to userspace.
1938 * The drm core will supply a struct &drm_event in the event
1939 * member of each CRTC's &drm_crtc_state structure. This can be handled by the
1940 * drm_crtc_send_vblank_event() function, which the driver should call on
1941 * the provided event upon completion of the atomic commit. Note that if
1942 * the driver supports vblank signalling and timestamping the vblank
1943 * counters and timestamps must agree with the ones returned from page
1944 * flip events. With the current vblank helper infrastructure this can
1945 * be achieved by holding a vblank reference while the page flip is
1946 * pending, acquired through drm_crtc_vblank_get() and released with
1947 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
1948 * counter and timestamp tracking though, e.g. if they have accurate
1949 * timestamp registers in hardware.
1953 * Drivers are not allowed to shut down any display pipe successfully
1954 * enabled through an atomic commit on their own. Doing so can result in
1955 * compositors crashing if a page flip is suddenly rejected because the
1960 * 0 on success or one of the below negative error codes:
1962 * - -EBUSY, if a nonblocking updated is requested and there is
1963 * an earlier updated pending. Drivers are allowed to support a queue
1964 * of outstanding updates, but currently no driver supports that.
1965 * Note that drivers must wait for preceding updates to complete if a
1966 * synchronous update is requested, they are not allowed to fail the
1967 * commit in that case.
1969 * - -ENOMEM, if the driver failed to allocate memory. Specifically
1970 * this can happen when trying to pin framebuffers, which must only
1971 * be done when committing the state.
1973 * - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
1974 * that the driver has run out of vram, iommu space or similar GPU
1975 * address space needed for framebuffer.
1977 * - -EIO, if the hardware completely died.
1979 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
1980 * This can either be due to a pending signal, or because the driver
1981 * needs to completely bail out to recover from an exceptional
1982 * situation like a GPU hang. From a userspace point of view all errors are
1985 * This list is exhaustive. Specifically this hook is not allowed to
1986 * return -EINVAL (any invalid requests should be caught in
1987 * @atomic_check) or -EDEADLK (this function must not acquire
1988 * additional modeset locks).
1990 int (*atomic_commit)(struct drm_device *dev,
1991 struct drm_atomic_state *state,
1995 * @atomic_state_alloc:
1997 * This optional hook can be used by drivers that want to subclass struct
1998 * &drm_atomic_state to be able to track their own driver-private global
1999 * state easily. If this hook is implemented, drivers must also
2000 * implement @atomic_state_clear and @atomic_state_free.
2004 * A new &drm_atomic_state on success or NULL on failure.
2006 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
2009 * @atomic_state_clear:
2011 * This hook must clear any driver private state duplicated into the
2012 * passed-in &drm_atomic_state. This hook is called when the caller
2013 * encountered a &drm_modeset_lock deadlock and needs to drop all
2014 * already acquired locks as part of the deadlock avoidance dance
2015 * implemented in drm_modeset_lock_backoff().
2017 * Any duplicated state must be invalidated since a concurrent atomic
2018 * update might change it, and the drm atomic interfaces always apply
2019 * updates as relative changes to the current state.
2021 * Drivers that implement this must call drm_atomic_state_default_clear()
2022 * to clear common state.
2024 void (*atomic_state_clear)(struct drm_atomic_state *state);
2027 * @atomic_state_free:
2029 * This hook needs driver private resources and the &drm_atomic_state
2030 * itself. Note that the core first calls drm_atomic_state_clear() to
2031 * avoid code duplicate between the clear and free hooks.
2033 * Drivers that implement this must call drm_atomic_state_default_free()
2034 * to release common resources.
2036 void (*atomic_state_free)(struct drm_atomic_state *state);
2040 * struct drm_mode_config - Mode configuration control structure
2041 * @mutex: mutex protecting KMS related lists and structures
2042 * @connection_mutex: ww mutex protecting connector state and routing
2043 * @acquire_ctx: global implicit acquire context used by atomic drivers for
2045 * @idr_mutex: mutex for KMS ID allocation and management
2046 * @crtc_idr: main KMS ID tracking object
2047 * @fb_lock: mutex to protect fb state and lists
2048 * @num_fb: number of fbs available
2049 * @fb_list: list of framebuffers available
2050 * @num_connector: number of connectors on this device
2051 * @connector_list: list of connector objects
2052 * @num_encoder: number of encoders on this device
2053 * @encoder_list: list of encoder objects
2054 * @num_overlay_plane: number of overlay planes on this device
2055 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
2056 * @plane_list: list of plane objects
2057 * @num_crtc: number of CRTCs on this device
2058 * @crtc_list: list of CRTC objects
2059 * @property_list: list of property objects
2060 * @min_width: minimum pixel width on this device
2061 * @min_height: minimum pixel height on this device
2062 * @max_width: maximum pixel width on this device
2063 * @max_height: maximum pixel height on this device
2064 * @funcs: core driver provided mode setting functions
2065 * @fb_base: base address of the framebuffer
2066 * @poll_enabled: track polling support for this device
2067 * @poll_running: track polling status for this device
2068 * @output_poll_work: delayed work for polling in process context
2069 * @property_blob_list: list of all the blob property objects
2070 * @blob_lock: mutex for blob property allocation and management
2071 * @*_property: core property tracking
2072 * @degamma_lut_property: LUT used to convert the framebuffer's colors to linear
2074 * @degamma_lut_size_property: size of the degamma LUT as supported by the
2075 * driver (read-only)
2076 * @ctm_property: Matrix used to convert colors after the lookup in the
2078 * @gamma_lut_property: LUT used to convert the colors, after the CSC matrix, to
2079 * the gamma space of the connected screen (read-only)
2080 * @gamma_lut_size_property: size of the gamma LUT as supported by the driver
2081 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
2082 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
2083 * @async_page_flip: does this device support async flips on the primary plane?
2084 * @cursor_width: hint to userspace for max cursor width
2085 * @cursor_height: hint to userspace for max cursor height
2087 * Core mode resource tracking structure. All CRTC, encoders, and connectors
2088 * enumerated by the driver are added here, as are global properties. Some
2089 * global restrictions are also here, e.g. dimension restrictions.
2091 struct drm_mode_config {
2092 struct mutex mutex; /* protects configuration (mode lists etc.) */
2093 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
2094 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
2095 struct mutex idr_mutex; /* for IDR management */
2096 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
2097 struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
2098 /* this is limited to one for now */
2100 struct mutex fb_lock; /* proctects global and per-file fb lists */
2102 struct list_head fb_list;
2105 struct ida connector_ida;
2106 struct list_head connector_list;
2108 struct list_head encoder_list;
2111 * Track # of overlay planes separately from # of total planes. By
2112 * default we only advertise overlay planes to userspace; if userspace
2113 * sets the "universal plane" capability bit, we'll go ahead and
2114 * expose all planes.
2116 int num_overlay_plane;
2117 int num_total_plane;
2118 struct list_head plane_list;
2121 struct list_head crtc_list;
2123 struct list_head property_list;
2125 int min_width, min_height;
2126 int max_width, max_height;
2127 const struct drm_mode_config_funcs *funcs;
2128 resource_size_t fb_base;
2130 /* output poll support */
2134 struct delayed_work output_poll_work;
2136 struct mutex blob_lock;
2138 /* pointers to standard properties */
2139 struct list_head property_blob_list;
2140 struct drm_property *edid_property;
2141 struct drm_property *dpms_property;
2142 struct drm_property *path_property;
2143 struct drm_property *tile_property;
2144 struct drm_property *plane_type_property;
2145 struct drm_property *rotation_property;
2146 struct drm_property *prop_src_x;
2147 struct drm_property *prop_src_y;
2148 struct drm_property *prop_src_w;
2149 struct drm_property *prop_src_h;
2150 struct drm_property *prop_crtc_x;
2151 struct drm_property *prop_crtc_y;
2152 struct drm_property *prop_crtc_w;
2153 struct drm_property *prop_crtc_h;
2154 struct drm_property *prop_fb_id;
2155 struct drm_property *prop_crtc_id;
2156 struct drm_property *prop_active;
2157 struct drm_property *prop_mode_id;
2159 /* DVI-I properties */
2160 struct drm_property *dvi_i_subconnector_property;
2161 struct drm_property *dvi_i_select_subconnector_property;
2164 struct drm_property *tv_subconnector_property;
2165 struct drm_property *tv_select_subconnector_property;
2166 struct drm_property *tv_mode_property;
2167 struct drm_property *tv_left_margin_property;
2168 struct drm_property *tv_right_margin_property;
2169 struct drm_property *tv_top_margin_property;
2170 struct drm_property *tv_bottom_margin_property;
2171 struct drm_property *tv_brightness_property;
2172 struct drm_property *tv_contrast_property;
2173 struct drm_property *tv_flicker_reduction_property;
2174 struct drm_property *tv_overscan_property;
2175 struct drm_property *tv_saturation_property;
2176 struct drm_property *tv_hue_property;
2178 /* Optional properties */
2179 struct drm_property *scaling_mode_property;
2180 struct drm_property *aspect_ratio_property;
2181 struct drm_property *dirty_info_property;
2183 /* Optional color correction properties */
2184 struct drm_property *degamma_lut_property;
2185 struct drm_property *degamma_lut_size_property;
2186 struct drm_property *ctm_property;
2187 struct drm_property *gamma_lut_property;
2188 struct drm_property *gamma_lut_size_property;
2190 /* properties for virtual machine layout */
2191 struct drm_property *suggested_x_property;
2192 struct drm_property *suggested_y_property;
2194 /* dumb ioctl parameters */
2195 uint32_t preferred_depth, prefer_shadow;
2197 /* whether async page flip is supported or not */
2198 bool async_page_flip;
2200 /* whether the driver supports fb modifiers */
2201 bool allow_fb_modifiers;
2204 uint32_t cursor_width, cursor_height;
2208 * drm_for_each_plane_mask - iterate over planes specified by bitmask
2209 * @plane: the loop cursor
2210 * @dev: the DRM device
2211 * @plane_mask: bitmask of plane indices
2213 * Iterate over all planes specified by bitmask.
2215 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
2216 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
2217 for_each_if ((plane_mask) & (1 << drm_plane_index(plane)))
2220 * drm_for_each_encoder_mask - iterate over encoders specified by bitmask
2221 * @encoder: the loop cursor
2222 * @dev: the DRM device
2223 * @encoder_mask: bitmask of encoder indices
2225 * Iterate over all encoders specified by bitmask.
2227 #define drm_for_each_encoder_mask(encoder, dev, encoder_mask) \
2228 list_for_each_entry((encoder), &(dev)->mode_config.encoder_list, head) \
2229 for_each_if ((encoder_mask) & (1 << drm_encoder_index(encoder)))
2231 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
2232 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
2233 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
2234 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
2235 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
2236 #define obj_to_property(x) container_of(x, struct drm_property, base)
2237 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
2238 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
2240 struct drm_prop_enum_list {
2245 extern __printf(6, 7)
2246 int drm_crtc_init_with_planes(struct drm_device *dev,
2247 struct drm_crtc *crtc,
2248 struct drm_plane *primary,
2249 struct drm_plane *cursor,
2250 const struct drm_crtc_funcs *funcs,
2251 const char *name, ...);
2252 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
2255 * drm_crtc_index - find the index of a registered CRTC
2256 * @crtc: CRTC to find index for
2258 * Given a registered CRTC, return the index of that CRTC within a DRM
2259 * device's list of CRTCs.
2261 static inline unsigned int drm_crtc_index(struct drm_crtc *crtc)
2267 * drm_crtc_mask - find the mask of a registered CRTC
2268 * @crtc: CRTC to find mask for
2270 * Given a registered CRTC, return the mask bit of that CRTC for an
2271 * encoder's possible_crtcs field.
2273 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
2275 return 1 << drm_crtc_index(crtc);
2278 extern void drm_connector_ida_init(void);
2279 extern void drm_connector_ida_destroy(void);
2280 extern int drm_connector_init(struct drm_device *dev,
2281 struct drm_connector *connector,
2282 const struct drm_connector_funcs *funcs,
2283 int connector_type);
2284 int drm_connector_register(struct drm_connector *connector);
2285 void drm_connector_unregister(struct drm_connector *connector);
2287 extern void drm_connector_cleanup(struct drm_connector *connector);
2288 static inline unsigned drm_connector_index(struct drm_connector *connector)
2290 return connector->connector_id;
2293 /* helpers to {un}register all connectors from sysfs for device */
2294 extern int drm_connector_register_all(struct drm_device *dev);
2295 extern void drm_connector_unregister_all(struct drm_device *dev);
2297 extern int drm_bridge_add(struct drm_bridge *bridge);
2298 extern void drm_bridge_remove(struct drm_bridge *bridge);
2299 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
2300 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
2302 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
2303 const struct drm_display_mode *mode,
2304 struct drm_display_mode *adjusted_mode);
2305 void drm_bridge_disable(struct drm_bridge *bridge);
2306 void drm_bridge_post_disable(struct drm_bridge *bridge);
2307 void drm_bridge_mode_set(struct drm_bridge *bridge,
2308 struct drm_display_mode *mode,
2309 struct drm_display_mode *adjusted_mode);
2310 void drm_bridge_pre_enable(struct drm_bridge *bridge);
2311 void drm_bridge_enable(struct drm_bridge *bridge);
2313 extern __printf(5, 6)
2314 int drm_encoder_init(struct drm_device *dev,
2315 struct drm_encoder *encoder,
2316 const struct drm_encoder_funcs *funcs,
2317 int encoder_type, const char *name, ...);
2320 * drm_encoder_index - find the index of a registered encoder
2321 * @encoder: encoder to find index for
2323 * Given a registered encoder, return the index of that encoder within a DRM
2324 * device's list of encoders.
2326 static inline unsigned int drm_encoder_index(struct drm_encoder *encoder)
2328 return encoder->index;
2332 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
2333 * @encoder: encoder to test
2334 * @crtc: crtc to test
2336 * Return false if @encoder can't be driven by @crtc, true otherwise.
2338 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
2339 struct drm_crtc *crtc)
2341 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
2344 extern __printf(8, 9)
2345 int drm_universal_plane_init(struct drm_device *dev,
2346 struct drm_plane *plane,
2347 unsigned long possible_crtcs,
2348 const struct drm_plane_funcs *funcs,
2349 const uint32_t *formats,
2350 unsigned int format_count,
2351 enum drm_plane_type type,
2352 const char *name, ...);
2353 extern int drm_plane_init(struct drm_device *dev,
2354 struct drm_plane *plane,
2355 unsigned long possible_crtcs,
2356 const struct drm_plane_funcs *funcs,
2357 const uint32_t *formats, unsigned int format_count,
2359 extern void drm_plane_cleanup(struct drm_plane *plane);
2362 * drm_plane_index - find the index of a registered plane
2363 * @plane: plane to find index for
2365 * Given a registered plane, return the index of that plane within a DRM
2366 * device's list of planes.
2368 static inline unsigned int drm_plane_index(struct drm_plane *plane)
2370 return plane->index;
2372 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
2373 extern void drm_plane_force_disable(struct drm_plane *plane);
2374 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
2376 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2377 int *hdisplay, int *vdisplay);
2378 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2380 const struct drm_display_mode *mode,
2381 const struct drm_framebuffer *fb);
2383 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
2385 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
2386 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
2387 extern const char *drm_get_dpms_name(int val);
2388 extern const char *drm_get_dvi_i_subconnector_name(int val);
2389 extern const char *drm_get_dvi_i_select_name(int val);
2390 extern const char *drm_get_tv_subconnector_name(int val);
2391 extern const char *drm_get_tv_select_name(int val);
2392 extern void drm_fb_release(struct drm_file *file_priv);
2393 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
2394 struct drm_file *file_priv);
2395 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
2396 extern struct edid *drm_get_edid(struct drm_connector *connector,
2397 struct i2c_adapter *adapter);
2398 extern struct edid *drm_get_edid_switcheroo(struct drm_connector *connector,
2399 struct i2c_adapter *adapter);
2400 extern struct edid *drm_edid_duplicate(const struct edid *edid);
2401 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
2402 extern void drm_mode_config_init(struct drm_device *dev);
2403 extern void drm_mode_config_reset(struct drm_device *dev);
2404 extern void drm_mode_config_cleanup(struct drm_device *dev);
2406 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
2408 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
2409 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
2410 const struct edid *edid);
2412 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
2414 unsigned int num_formats);
2416 static inline bool drm_property_type_is(struct drm_property *property,
2419 /* instanceof for props.. handles extended type vs original types: */
2420 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
2421 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
2422 return property->flags & type;
2425 static inline bool drm_property_type_valid(struct drm_property *property)
2427 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
2428 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
2429 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
2432 extern int drm_object_property_set_value(struct drm_mode_object *obj,
2433 struct drm_property *property,
2435 extern int drm_object_property_get_value(struct drm_mode_object *obj,
2436 struct drm_property *property,
2438 extern int drm_framebuffer_init(struct drm_device *dev,
2439 struct drm_framebuffer *fb,
2440 const struct drm_framebuffer_funcs *funcs);
2441 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
2443 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
2444 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
2445 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
2447 extern void drm_object_attach_property(struct drm_mode_object *obj,
2448 struct drm_property *property,
2450 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
2451 const char *name, int num_values);
2452 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
2454 const struct drm_prop_enum_list *props,
2456 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
2457 int flags, const char *name,
2458 const struct drm_prop_enum_list *props,
2460 uint64_t supported_bits);
2461 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
2463 uint64_t min, uint64_t max);
2464 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
2465 int flags, const char *name,
2466 int64_t min, int64_t max);
2467 struct drm_property *drm_property_create_object(struct drm_device *dev,
2468 int flags, const char *name, uint32_t type);
2469 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
2471 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
2474 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
2476 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
2477 void drm_property_unreference_blob(struct drm_property_blob *blob);
2478 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
2479 extern int drm_property_add_enum(struct drm_property *property, int index,
2480 uint64_t value, const char *name);
2481 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
2482 extern int drm_mode_create_tv_properties(struct drm_device *dev,
2483 unsigned int num_modes,
2484 const char * const modes[]);
2485 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
2486 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
2487 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
2488 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
2489 extern bool drm_property_change_valid_get(struct drm_property *property,
2490 uint64_t value, struct drm_mode_object **ref);
2491 extern void drm_property_change_valid_put(struct drm_property *property,
2492 struct drm_mode_object *ref);
2494 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
2495 struct drm_encoder *encoder);
2496 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
2498 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
2499 uint32_t id, uint32_t type);
2500 void drm_mode_object_reference(struct drm_mode_object *obj);
2501 void drm_mode_object_unreference(struct drm_mode_object *obj);
2504 extern int drm_mode_getresources(struct drm_device *dev,
2505 void *data, struct drm_file *file_priv);
2506 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
2507 struct drm_file *file_priv);
2508 extern int drm_mode_getcrtc(struct drm_device *dev,
2509 void *data, struct drm_file *file_priv);
2510 extern int drm_mode_getconnector(struct drm_device *dev,
2511 void *data, struct drm_file *file_priv);
2512 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
2513 extern int drm_mode_setcrtc(struct drm_device *dev,
2514 void *data, struct drm_file *file_priv);
2515 extern int drm_mode_getplane(struct drm_device *dev,
2516 void *data, struct drm_file *file_priv);
2517 extern int drm_mode_setplane(struct drm_device *dev,
2518 void *data, struct drm_file *file_priv);
2519 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
2520 void *data, struct drm_file *file_priv);
2521 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
2522 void *data, struct drm_file *file_priv);
2523 extern int drm_mode_addfb(struct drm_device *dev,
2524 void *data, struct drm_file *file_priv);
2525 extern int drm_mode_addfb2(struct drm_device *dev,
2526 void *data, struct drm_file *file_priv);
2527 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
2528 extern int drm_mode_rmfb(struct drm_device *dev,
2529 void *data, struct drm_file *file_priv);
2530 extern int drm_mode_getfb(struct drm_device *dev,
2531 void *data, struct drm_file *file_priv);
2532 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
2533 void *data, struct drm_file *file_priv);
2535 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
2536 void *data, struct drm_file *file_priv);
2537 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
2538 void *data, struct drm_file *file_priv);
2539 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
2540 void *data, struct drm_file *file_priv);
2541 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
2542 void *data, struct drm_file *file_priv);
2543 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
2544 void *data, struct drm_file *file_priv);
2545 extern int drm_mode_getencoder(struct drm_device *dev,
2546 void *data, struct drm_file *file_priv);
2547 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
2548 void *data, struct drm_file *file_priv);
2549 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
2550 void *data, struct drm_file *file_priv);
2551 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
2552 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
2553 extern bool drm_detect_hdmi_monitor(struct edid *edid);
2554 extern bool drm_detect_monitor_audio(struct edid *edid);
2555 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
2556 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
2557 void *data, struct drm_file *file_priv);
2558 extern int drm_add_modes_noedid(struct drm_connector *connector,
2559 int hdisplay, int vdisplay);
2560 extern void drm_set_preferred_mode(struct drm_connector *connector,
2561 int hpref, int vpref);
2563 extern int drm_edid_header_is_valid(const u8 *raw_edid);
2564 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
2565 bool *edid_corrupt);
2566 extern bool drm_edid_is_valid(struct edid *edid);
2567 extern void drm_edid_get_monitor_name(struct edid *edid, char *name,
2570 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2572 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2574 extern void drm_mode_put_tile_group(struct drm_device *dev,
2575 struct drm_tile_group *tg);
2576 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
2577 int hsize, int vsize, int fresh,
2580 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
2581 void *data, struct drm_file *file_priv);
2582 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
2583 void *data, struct drm_file *file_priv);
2584 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
2585 void *data, struct drm_file *file_priv);
2586 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
2587 struct drm_file *file_priv);
2588 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
2589 struct drm_file *file_priv);
2590 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
2591 struct drm_property *property,
2593 extern int drm_mode_atomic_ioctl(struct drm_device *dev,
2594 void *data, struct drm_file *file_priv);
2596 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
2598 extern int drm_format_num_planes(uint32_t format);
2599 extern int drm_format_plane_cpp(uint32_t format, int plane);
2600 extern int drm_format_horz_chroma_subsampling(uint32_t format);
2601 extern int drm_format_vert_chroma_subsampling(uint32_t format);
2602 extern int drm_format_plane_width(int width, uint32_t format, int plane);
2603 extern int drm_format_plane_height(int height, uint32_t format, int plane);
2604 extern const char *drm_get_format_name(uint32_t format);
2605 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
2606 unsigned int supported_rotations);
2607 extern unsigned int drm_rotation_simplify(unsigned int rotation,
2608 unsigned int supported_rotations);
2612 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
2615 struct drm_mode_object *mo;
2616 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
2617 return mo ? obj_to_plane(mo) : NULL;
2620 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
2623 struct drm_mode_object *mo;
2624 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
2625 return mo ? obj_to_crtc(mo) : NULL;
2628 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
2631 struct drm_mode_object *mo;
2632 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
2633 return mo ? obj_to_encoder(mo) : NULL;
2637 * drm_connector_lookup - lookup connector object
2639 * @id: connector object id
2641 * This function looks up the connector object specified by id
2642 * add takes a reference to it.
2644 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
2647 struct drm_mode_object *mo;
2648 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
2649 return mo ? obj_to_connector(mo) : NULL;
2652 static inline struct drm_property *drm_property_find(struct drm_device *dev,
2655 struct drm_mode_object *mo;
2656 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
2657 return mo ? obj_to_property(mo) : NULL;
2661 * Extract a degamma/gamma LUT value provided by user and round it to the
2662 * precision supported by the hardware.
2664 static inline uint32_t drm_color_lut_extract(uint32_t user_input,
2665 uint32_t bit_precision)
2667 uint32_t val = user_input;
2668 uint32_t max = 0xffff >> (16 - bit_precision);
2670 /* Round only if we're not using full precision. */
2671 if (bit_precision < 16) {
2672 val += 1UL << (16 - bit_precision - 1);
2673 val >>= 16 - bit_precision;
2676 return clamp_val(val, 0, max);
2680 * drm_framebuffer_reference - incr the fb refcnt
2683 * This functions increments the fb's refcount.
2685 static inline void drm_framebuffer_reference(struct drm_framebuffer *fb)
2687 drm_mode_object_reference(&fb->base);
2691 * drm_framebuffer_unreference - unref a framebuffer
2692 * @fb: framebuffer to unref
2694 * This functions decrements the fb's refcount and frees it if it drops to zero.
2696 static inline void drm_framebuffer_unreference(struct drm_framebuffer *fb)
2698 drm_mode_object_unreference(&fb->base);
2702 * drm_framebuffer_read_refcount - read the framebuffer reference count.
2705 * This functions returns the framebuffer's reference count.
2707 static inline uint32_t drm_framebuffer_read_refcount(struct drm_framebuffer *fb)
2709 return atomic_read(&fb->base.refcount.refcount);
2713 * drm_connector_reference - incr the connector refcnt
2714 * @connector: connector
2716 * This function increments the connector's refcount.
2718 static inline void drm_connector_reference(struct drm_connector *connector)
2720 drm_mode_object_reference(&connector->base);
2724 * drm_connector_unreference - unref a connector
2725 * @connector: connector to unref
2727 * This function decrements the connector's refcount and frees it if it drops to zero.
2729 static inline void drm_connector_unreference(struct drm_connector *connector)
2731 drm_mode_object_unreference(&connector->base);
2734 /* Plane list iterator for legacy (overlay only) planes. */
2735 #define drm_for_each_legacy_plane(plane, dev) \
2736 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
2737 for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
2739 #define drm_for_each_plane(plane, dev) \
2740 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
2742 #define drm_for_each_crtc(crtc, dev) \
2743 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
2746 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
2749 * The connector hotadd/remove code currently grabs both locks when
2750 * updating lists. Hence readers need only hold either of them to be
2751 * safe and the check amounts to
2753 * WARN_ON(not_holding(A) && not_holding(B)).
2755 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
2756 !drm_modeset_is_locked(&mode_config->connection_mutex));
2759 #define drm_for_each_connector(connector, dev) \
2760 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
2761 connector = list_first_entry(&(dev)->mode_config.connector_list, \
2762 struct drm_connector, head); \
2763 &connector->head != (&(dev)->mode_config.connector_list); \
2764 connector = list_next_entry(connector, head))
2766 #define drm_for_each_encoder(encoder, dev) \
2767 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
2769 #define drm_for_each_fb(fb, dev) \
2770 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
2771 fb = list_first_entry(&(dev)->mode_config.fb_list, \
2772 struct drm_framebuffer, head); \
2773 &fb->head != (&(dev)->mode_config.fb_list); \
2774 fb = list_next_entry(fb, head))
2776 #endif /* __DRM_CRTC_H__ */